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

Powers off a server hardware resource.

​
Syntax

Graceful power-off (default) 
Stop-OVServer
    [-InputObject] <Object>
    [-Async]
    [-ApplianceConnection <Object>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Forced power-off 
Stop-OVServer
    [-InputObject] <Object>
    -Force
    [-Async]
    [-ApplianceConnection <Object>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

​
Description

Stop-OVServer sends a power-off signal to the specified server hardware via the iLO management processor. The default behaviour is a graceful momentary press of the power button, which requests the OS to shut down cleanly. Use -Force to immediately cut power (press-and-hold) without waiting for the OS to shut down. The cmdlet accepts server hardware objects or server profile objects from the pipeline.
Using -Force immediately cuts power to the server without a graceful OS shutdown. This can result in data loss or file system corruption if the operating system is running.

​
Parameters

​
InputObject
Object
required
The server hardware or server profile object to power off. Accepts pipeline input. The Server alias is also accepted.
​
Force
Switch
Force an immediate power-off using a press-and-hold action. When specified, this parameter set is activated and the cmdlet requires confirmation.
​
Async
Switch
Return the async task object immediately without waiting for the operation to complete.
​
ApplianceConnection
Object
The appliance connection object or name. Defaults to the default connected session. Accepted from the pipeline by property name.
​
Confirm
Switch
Prompts for confirmation before powering off the server.

​
Examples

​
Graceful power-off

$server = Get-OVServer -Name "Encl1, bay 1"
Stop-OVServer -InputObject $server
Sends a graceful power-off signal to Encl1, bay 1 and waits for the operation to complete.

​
Power off using the pipeline

Get-OVServer -Name "Encl1, bay 1" | Stop-OVServer
Pipes the server object directly to Stop-OVServer.

​
Forced power-off

$server = Get-OVServer -Name "Encl1, bay 1"
Stop-OVServer -InputObject $server -Force
Cuts power immediately without waiting for the OS to shut down.

​
Power off all servers in an enclosure

$tasks = Get-OVServer -Name "Encl1*" | Stop-OVServer -Async -Confirm:$false
$tasks | Wait-OVTaskComplete
Powers off all servers in Encl1 without confirmation prompts, submitting each as an async task.

​
Output

HPEOneView.Appliance.TaskResource Returns an async task resource for the power-off operation.

Build docs developers (and LLMs) love

Get started for freeTalk to us