Stop HPOVServer - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Stop-HPOVServer

Power off Server Resource.

SYNTAX

Stop-HPOVServer [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Stop-HPOVServer [-InputObject] <Object>[ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Stop the power state of the server using the virtual power button. By default, the Cmdlet will request a "Momentary Press" request to initiate a server to shutdown.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases	Appliance
Required?	true
Position?	named
Default value	(${Global:ConnectedSessions} \| ? Default)
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	False

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

Aliases	None
Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	False

-Confirm <SwitchParameter>

Aliases	cf
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Force <SwitchParameter>

Use this parameter to request the "Press and Hold" virtual power button method, which will forcable power off a server without a graceful shutdown.

Aliases	None
Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	False

-InputObject <Object>

Aliases [-Server]

A Server hardware or Server Profile resource object.

Aliases	Server
Required?	true
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-WhatIf <SwitchParameter>

Aliases	wi
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]

Server Hardware Resource

HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]

Server Profile Resource

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Async task that tracks the power state change

System.Collections.ArrayList <HPOneView.Appliance.TaskResource>

Multiple Async tasks

Examples

-------------------------- EXAMPLE 1 --------------------------

Get-HPOVServer "Encl1, Bay 1" | Stop-HPOVServer | Wait-HPOVTaskComplete

Power off the specific server device by passing the Server Object via pipeline.

-------------------------- EXAMPLE 2 --------------------------

Get-HPOVServerProfile "MyWebServer 1" | Stop-HPOVServer | Wait-HPOVTaskComplete

Power off the specific server device by passing the Server Profile Object via pipeline.

-------------------------- EXAMPLE 3 --------------------------

Get-HPOVServer "Encl1, Bay 1" | Stop-HPOVServer -Force | Wait-HPOVTaskComplete

Power off the specific server device by passing the Server Object via pipeline, and forcably power off.

HPE OneView 4.00 Library