A P P E N D I X A - Server Management Commands Summary

A P P E N D I X A

Server Management Commands Summary

The service processor (SP) includes a suite of commands that enables management and monitoring of the server. This suite of commands is referred to as the server-management commands.

Note - This appendix provides an overview of the server-management command groups that are available on the SP. For a detailed description of the subcommands, arguments, and return codes for each command type, refer to the appendices in this guide, as described in TABLE A-1.

Using the `ssh` Protocol

You must use ssh to execute these commands on the service processor (SP). There are two ways to do this:

Use the interactive shell on the SP.

Preface each command with a set piece of text.

Interactive Shell on the SP

To use the interactive shell:

# ssh -l spipaddr spuser

Preface Text

Preface each command with the following text:

# ssh -l spipaddr spuser

Commands

The server-management commands take arguments, perform one or more actions, and display the result or text to the standard output device. Commands are grouped by similar function; each command has numerous subcommands supporting functions within that grouping.

Note - Every subcommand (except help) returns a return code upon completion. See Return Codes for a summary.

TABLE A-1 lists the server-management command groups.

TABLE A-1 Server-Management Commands
Command Group	Description
`access`	Allows the authorized user to manage and monitor access control and security features of the SP, such as users, groups, SSL, and so on. See Appendix B.
`diags`	Manages diagnostics tests that are included with your server. See Appendix C.
`inventory`	Allows the authorized user to monitor hardware and software inventory information. See Appendix D.
`ipmi`	Manages IPMI functions. See Appendix E.
`platform`	Allows the authorized user to manage and monitor platform activities, such as rebooting the platform operating system, gathering system status and so on. See Appendix F.
`sensor`	Reports or sets the value of an environmental sensor or control. See Appendix G.
`sp`	Allows the authorized user to manage and monitor the SP configurations, such as networking, external file system, SNMP, SMTP, SSL, event logs, and so on. See Appendix H.
`help`	Returns the following text: Available Commands: platform, access, sp, sensor, inventory, ipmi. Each of these commands includes a help option (--help).

Return Codes

Every subcommand returns one or more of the following return codes upon completion. Refer to the following appendices in this user guide for each subcommand and the corresponding return codes for that subcommand.

TABLE A-2 lists the return codes for the server-management commands.

TABLE A-2 Return Codes
Return Code	ID	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_InvalidArgument`	4	One or more arguments were incorrect or invalid.
`NWSE_NotFound`	5	Entity (user, service, file, path, or other) was not found.
`NWSE_NoPermission`	6	Not authorized to perform this operation.
`NWSE_MissingArgument`	7	Missing argument(s).
`NWSE_NoMemory`	8	Insufficient memory.
`NWSE_Busy`	9	Device or resource is busy.
`NWSE_NotImplemented`	10	Function not implemented.
`NWSE_RPCConnected`	11	RPC client already connected.
`NWSE_RPCConnRefused`	12	RPC connection refused.
`NWSE_NoRouteToHost`	13	No route to host (network down).
`NWSE_HostDown`	14	Host is down.
`NWSE_UnknownError`	15	Miscellaneous error not captured by other errors.
`NWSE_GatewayOffNet`	16	Gateway address is not on the network.
`NWSE_NetMaskIncorrect`	17	An inappropriate netmask was specified.
`NWSE_FileError`	18	File open, file missing, or a read or write error occurred.
`NWSE_Exist`	19	Entity (user, service, or other) already exists.
`NWSE_NotRecognized`	20	Request not understood.
`NWSE_NotMounted`	21	File system is not mounted.
`NWSE_InvalidOpForState`	22	Invalid operation for current state.
`NWSE_TimedOut`	23	Operation timed out.
`NWSE_ServiceNotAvailable`	24	Requested service is not available.
`NWSE_DeviceError`	25	Unable to read or write to the device.
`NWSE_LimitExceeded`	26	Limit has been exceeded.

Using the ssh Protocol

Interactive Shell on the SP

Preface Text

Commands

Return Codes

Using the `ssh` Protocol