Platform Set OS State Boot Subcommand

access: Administrators

This command serves as an alias for platform set os state reboot and only functions when the platform power state is off.

platform set os state boot [{-f|--forced}]
[{-b|--bios}] [{-q|--quiet}] [{-d|--device}]
[-W|--nowait]

Arguments Description

{-f | --forced} Results in a hard power off. This option is ignored.

[-b | --bios] Boot to BIOS setup instead of the OS. Cannot be used with -d.

[-d | --device] Causes the BIOS to first attempt to use the specified device as a boot device, before returning to the configured BIOS boot order. Currently, the only supported device argument is network. Specifying “–device network” will cause the BIOS to attempt a network boot via PXE. Cannot be used with the -b argument.

[-q | --quiet] Suppresses interative warning messages. No error messages are blocked.

[-q | --quiet] Suppresses interative warning messages. No error messages are blocked.

[-W | --nowait] If specified, the command returns immediately instead of waiting for the operation to complete.

Arguments	Description
{-f \| --forced}	Results in a hard power off. This option is ignored.
[-b \| --bios]	Boot to BIOS setup instead of the OS. Cannot be used with -d.
[-d \| --device]	Causes the BIOS to first attempt to use the specified device as a boot device, before returning to the configured BIOS boot order. Currently, the only supported device argument is network. Specifying “–device network” will cause the BIOS to attempt a network boot via PXE. Cannot be used with the -b argument.
[-q \| --quiet]	Suppresses interative warning messages. No error messages are blocked.
[-q \| --quiet]	Suppresses interative warning messages. No error messages are blocked.
[-W \| --nowait]	If specified, the command returns immediately instead of waiting for the operation to complete.

Return Codes

Following are the return values for this command:

Code	Numeric Code	Description
NWSE_Success	0	Command successfully completed.
NWSE_InvalidUsage	1	Invalid usage: bad parameter usage, conflicting options specified.
NWSE_RPCTimeout	2	Request was issued, but was not serviced by the server. RPC procedure timed out and the request may or may not have been serviced by the server.
NWSE_RPCNotConnected	3	Unable to connect to the RPC server.
NWSE_NoPermission	6	Not authorized to perform this operation.
NWSE_Busy	9	Device or resource is busy. Another platform set os state operation is in progress.
NWSE_InvalidOpForState	22	Invalid operation for current state. Force is required because the platform is in a transitional state (shutting down, booting, etc.) or the platform is already on.