Invoke-LXCOServerPowerAction
Use this cmdlet to perform a power action (such as power on or power off) on one or more managed servers.
Note
- You can perform power actions on a maximum of 25 devices at one time. This means that the number of servers in the groups specified GroupIDs parameter or the number of servers specified in ResourceIDs parameter cannot exceed 25 devices.
- You cannot pipe objects to this cmdlet.
Syntax
Invoke-LXCOServerPowerAction [-Connection LXCOConnection]
-Action String
-ResourcesIDs String[]
[CommonParameter]
Invoke-LXCOServerPowerAction [-Connection LXCOConnection]
-Action String
-GroupsIDs String[]
[CommonParameter]
Parameters
- -Connection LXCOConnection
- Specifies the connection to the Lenovo XClarity Orchestrator server. If no connection is specified, the result from the last Connect-LXCO cmdlet is used.
- Action String
- Power action to perform on the specified resources.
This can be one of the following values:
- PowerOn. Powers on the resource.
- PowerOffImmediately. Powers off the resource immediately.
- PowerOffNormally. Shuts down the operating system and powers off the resource.
- RestartImmediately. Restarts the resource immediately.
- RestartNormally. Shuts down the operating system and restarts the resource.
- RestartManagementController. Restarts the baseboard management controller.
- RestartToSystemSetup. Restarts the resource to BIOS/UEFI (F1) Setup. This is supported for non-ThinkServer servers that are supported without limitations.
- -ResourcesIDs String[]
- Specifies one or more server IDs, separated by a comma.
- -GroupsIDs String[]
- Specifies one or more device group IDs, separated by a comma.
- CommonParameters
- This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.
Results
- Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJobFullData
If the request was accepted the orchestrator server, this cmdlet returns an LXCOJobFullData object that contains the status of the operation that is associated with this request. If available, job logs are added to the root job and subtasks.
- Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage
If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.
Examples
The following example immediately powers off the specified servers.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck
$serverIDs = @(
"AAABBBCCCDDD-45D937C322664C62B238FEE679314F6F",
"EEEFFFDDD000-45D937C322664C62B238FEE679314F6F"
)
$result = Invoke-LXCOServerPowerAction -Action PowerOffImmediately -ResourcesIDs $serverIDs
$result | Format
Disconnect-LXCO
Give documentation feedback