# Platform Get OS State Subcommand

access: All users

Retrieves the current state of the platform operating system.

> platform get os state

Values for the current state include:

- Off
- On
- Communicating
- Diagnostics
- Sleeping
- BIOS booting
- BIOS setup
- OS booting
- OS shutting down

These states display in the help panel when you move your mouse over the platform operating system button. As the state changes, the image on the button also changes.

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.

Notes

- When the platform is in the Communicating state (in which the operating system is communicating with the Service Processor), if the platform drivers are uninstalled, the Service Processor remains in the Communicating state even though it can no longer communicate with the platform. Refer to platform set os state for a details about setting the state.

Related Topics

System Management Commands

Platform Command