Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HewlettPackard/POSH-HPEOneView/llms.txt

Use this file to discover all available pages before exploring further.

​
Synopsis

Initiates a restart of the HPE OneView appliance, disconnecting all active users and interrupting ongoing tasks.

​
Syntax

Restart-OVAppliance
    [-ApplianceConnection <Object>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

​
Description

Restart-OVAppliance sends a reboot request to the HPE OneView appliance. Because this operation has a high impact, the cmdlet uses SupportsShouldProcess with ConfirmImpact = High, so a confirmation prompt is displayed by default. To suppress the confirmation prompt and restart without interaction, use -Confirm:$false. To simulate the operation without executing it, use -WhatIf. The cmdlet accepts appliance connections from the pipeline, enabling restart of multiple appliances in sequence.
Restarting the appliance will immediately disconnect all active user sessions and interrupt any running tasks. The appliance will be unavailable for several minutes while it reboots. Ensure all critical operations have completed before issuing this command.

​
Parameters

​
ApplianceConnection
Object
Specifies the HPE OneView appliance connection(s) to restart. Accepts pipeline input. Defaults to the default connection from ${Global:ConnectedSessions}. Alias: Appliance.
​
WhatIf
Switch
Simulates the restart operation without actually sending the reboot request. Displays what would happen if the cmdlet ran.
​
Confirm
Switch
Controls the confirmation prompt. Use -Confirm:$false to suppress the prompt and restart without interaction.

​
Examples

Example 1: Restart the default appliance with confirmation prompt 
Restart-OVAppliance
Prompts the user to confirm before sending the reboot request to the default connected appliance. Example 2: Restart without a confirmation prompt 
Restart-OVAppliance -Confirm:$false
Restarts the appliance immediately without asking for confirmation. Use with caution in scripts. Example 3: Preview the restart operation without executing it 
Restart-OVAppliance -WhatIf
Shows what the cmdlet would do without actually restarting the appliance. Example 4: Restart a specific appliance by connection 
$Connection = Connect-OVMgmt -Hostname 'appliance.domain.com' -Credential $Creds
Restart-OVAppliance -ApplianceConnection $Connection -Confirm:$false
Restarts the specified appliance without a confirmation prompt.

​
Output

System.Collections.ArrayList An empty task collection. No task object is returned by the appliance for a reboot request; the cmdlet completes once the request is accepted.

Build docs developers (and LLMs) love

Get started for freeTalk to us