| Sun Fire V20z and Sun Fire V40z Servers--Server Management Guide
|
    |
Service Processor Commands
|
The sp command gets or sets the configuration values for the Service Processor (SP), generates or manages events and notices; or adds or modifies subscribers, event routes and email-notification groups for the SP event manager.
TABLE H-1 lists the groups of sp subcommands.
|
Note - Every command returns a return code upon completion.
|
TABLE H-1 Service Processor Subcommand Groups
|
Subcommand
|
Description
|
|
Date
|
Sets or retrieves the date and time on the SP RTC.
|
|
DNS
|
Displays or configures the DNS client configuration on the SP.
|
|
Events
|
Returns detailed information or clears an event.
|
|
Hostname
|
Displays or resets the host name or domain name of the SP.
|
|
IP
|
Sets, modifies or retrieves the SP network configuration.
|
|
JNET Address
|
Sets or retrieves the jnet address.
|
|
Locate Light
|
Sets the state or reads the value of the locatelight switch.
|
|
Logfile
|
Retrieves or configures the event log file.
|
|
Miscellaneous
|
Reads status for a component, retrieves the last port 80 postcode, restores settings to defaults, stores data in tar zipped format, or captures debug data.
|
|
Mount
|
Displays, creates, resets or deletes a mount point.
|
|
SMTP
|
Manages information about SMTP email delivery.
|
|
SNMP
|
Manages SNMP functions.
|
|
SSL
|
Manages SSL capabilities.
|
|
Update Flash
|
Sets the update flag to start the full flash update or copies the Value-Add file to the Value-Add component of the SP flash.
|
SP Date Subcommands
The subcommands in TABLE H-2 manage the date and time on the SP.
TABLE H-2 SP Date Subcommands
|
Subcommand
|
Description
|
|
sp get date
|
Retrieves the date and time from the SP RTC.
|
|
sp set date
|
Sets the date and time on the SP RTC.
|
SP Get Date Subcommand
Description: Retrieves the date and time from the SP RTC.
Format
Command format:
sp get date
Return Codes
TABLE H-3 lists the return codes for this subcommand.
TABLE H-3 Return Codes for Subcommand sp get date
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
SP Set Date Subcommand
Description: Sets the date and time on the SP RTC.
Format
Command format:
sp set date DATE_STRING
TABLE H-4 lists the argument for this subcommand.
TABLE H-4 Argument for Subcommand sp set date
|
Arguments
|
Description
|
|
DATE STRING
|
Specifies the date and time on the Service Processor RTC. The date string is a UTC date of the form YYYY-MM-DD HH:MM:SS.
|
You can use this command to initially set the platform RTC after the platform has lost CMOS backup power. If the platform is in the state in which the operating system (OS) is communicating with the SP, the platform time will override the SP time, which allows the platform and sp event times to be in sync in the event log.
Return Codes
TABLE H-5 lists the return codes for this command.
TABLE H-5 Return Codes for Subcommand sp set date
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_FileError
|
18
|
File open, file missing or a read or write error occurred.
|
SP DNS Subcommands
The subcommands in TABLE H-6 manage the DNS configuration on the SP.
TABLE H-6 SP DNS Subcommands
|
Subcommand
|
Description
|
|
sp disable dns
|
Disables the DNS configuration on the SP.
|
|
sp enable dns
|
Configures the DNS configuration on the SP.
|
|
sp get dns
|
Displays the current DNS configuration on the SP.
|
SP Disable DNS Subcommand
Description: Disables the DNS configuration on the SP.
sp disable dns
When the SP is configured to use Dynamic Host Control Protocol (DHCP), DHCP automatically configures DNS settings. Changes to the DNS settings in this configuration can be replaced with the DHCP client.
Return Codes
TABLE H-7 lists the return codes for this command:
TABLE H-7 Return Codes for Subcommand sp disable dns
|
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_NoPermission
|
6
|
Not authorized to perform this operation.
|
SP Enable DNS Subcommand
Description: Configures the DNS configuration on the SP.
Because applications do not see updated DNS resolver configurations (in /etc/resolv.conf) until they are restarted, this command restarts server processes that depend on DNS. This currently includes the sshd daemon and the Security Manager.
Format
Command format:
sp enable dns { -n | --nameserver} NAMESERVER IP... {-s | --searchdomain } SEARCH DOMAIN...
TABLE H-8 lists the arguments for this subcommand.
TABLE H-8 Arguments for Subcommand sp enable dns
|
Argument
|
Description
|
|
{ -n | --nameserver}
|
Displays the nameserver IP-addresses. If there is more than one, the addresses print on separate lines.
|
|
{-s | --searchdomain }
|
Displays the search domain(s). If there is more than one, the search domains print on separate lines.
|
Return Codes
TABLE H-9 lists the return codes for this subcommand.
TABLE H-9 Return Codes for Subcommand sp enable dns
|
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_NoPermission
|
6
|
Not authorized to perform this operation.
|
SP Get DNS Subcommand
Description: Displays the current DNS configuration on the SP.
Format
Command format:
sp get dns [{-n | --nameserver } | -s | --searchdomain } | {-H | --noheader }] [{-D | --delim <DELIMITER>}]
TABLE H-10 lists the arguments for this subcommand.
TABLE H-10 Arguments for Subcommand sp get dns
|
Argument
|
Description
|
|
{ -n | --nameserver }
|
Displays the name server(s). If there is more than one nameserver, they print on separate lines.
|
|
{ -s | --searchdomain }
|
Displays the searchdomain(s). If there is more than one searchdomain, they print on separate lines.
|
|
{ -H | --noheader }
|
Suppresses column headings.
|
|
[{-D | --delim <DELIMITER>}]
|
Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
Return Codes
TABLE H-11 lists the return codes for this subcommand.
TABLE H-11 Return Codes for Subcommand sp get dns
|
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.
|
SP Events Subcommands
The subcommands in TABLE H-12 manage events on the SP.
TABLE H-12 SP Events Subcommands
|
Subcommand
|
Description
|
|
sp delete event
|
Clears an existing event using the event ID.
|
|
sp get events
|
Returns detailed information about all active SP events.
|
SP Delete Event Subcommand
Description: Clears an existing event using the event ID.
Format
Command format:
sp delete event { EVENT ID | {-a | --all}} [-q | --quiet]
TABLE H-13 lists the arguments for this subcommand.
TABLE H-13 Arguments for Subcommand sp delete event
|
Argument
|
Description
|
|
EVENT ID
|
Specifies the existing event to clear. This argument is repeatable to clear multiple events at one time.
|
|
[-a | --all]
|
Removes all events.
|
|
[-q | --quiet]
|
If the event to delete is not found, this argument specifies that no error be returned.
|
Return Codes
TABLE H-14 lists the return codes for this subcommand.
TABLE H-14 Return Codes for Subcommand sp delete event
|
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_NotFound
|
5
|
Entity (user, service, file, path, etc.) was not found.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_InvalidOpForState
|
22
|
Invalid operation for current state.
|
SP Get Events Subcommand
Description: Returns detailed information about all active SP events. By default, event ID, last update, component, severity and a message are displayed.
Administrators can view detailed information about all the currently active system events and perform various actions related to each event.
You can view this information in the System Events table, which contains a row for each unique active system event, or using this command. For a list of all possible events, refer to the TABLE 3-4 in Chapter 3.
Format
Command format:
sp get events [ {-i | --id} <EVENT ID> ] [{-d | --detail} ][{ -v | --verbose}] [{-H | noheader}][{-D | --delim <DELIMITER>}]
TABLE H-15 lists the arguments for this subcommand.
TABLE H-15 Arguments for Subcommand sp get events
|
Argument
|
Description
|
|
{-i | --id}
|
Specifies to display only information about this event; otherwise information for all existing events returns.
|
|
{-d | --detail}
|
Specifies to display the history of either one or all events.
|
|
{ -v| --verbose}
|
Specifies to display all columns.
|
|
{ -H | --noheader }
|
Suppresses column headings.
|
|
{ -D | --delim }
|
Specifies to delimit columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
Return Codes
TABLE H-16 lists the return codes for this subcommand.
TABLE H-16 Return Codes for Subcommand sp get events
|
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) not found.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
SP Hostname Subcommands
The subcommands in TABLE H-17 manage the SP host and domain.
TABLE H-17 SP Hostname Subcommands
|
Subcommand
|
Description
|
|
sp get hostname
|
Displays the current host name and optionally the domain name of the SP.
|
|
sp set hostname
|
Resets the host name or domain name of the SP to the specified name.
|
SP Get Hostname Subcommand
Description: Displays the current host name and optionally the domain name of the SP. This name is used by many of the networking programs to identify the machine. It is also used to identify a logging subdirectory for event logs.
Format
Command format:
sp get hostname [-f | --fqdn]
TABLE H-18 lists the argument for this subcommand.
TABLE H-18 Argument for Subcommand sp get hostname
|
Argument
|
Description
|
|
[-f | --fqdn]
|
Causes the fully qualified hostname to display.
|
Return Codes
TABLE H-19 lists the return codes for this subcommand.
TABLE H-19 Return Codes for Subcommand sp get hostname
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
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.
|
SP Set Hostname Subcommand
Description: Resets the host name or domain name of the SP to the specified name. This name is used by many of the networking programs to identify the machine.
Format
Command format:
sp set hostname HOSTNAME
TABLE H-20 lists the argument for this subcommand.
TABLE H-20 Argument for Subcommand sp set hostname
|
Argument
|
Description
|
|
HOSTNAME
|
Specifies the name of the host to set.
|
Return Codes
TABLE H-21 lists the return codes for this subcommand.
TABLE H-21 Return Codes for Subcommand sp set hostname
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
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.
|
SP IP Subcommands
The subcommands in TABLE H-22 manage the SP network configuration.
TABLE H-22 SP IP Subcommands
|
Subcommand
|
Description
|
|
sp get ip
|
Retrieves the ethernet-based network configuration information for the SP.
|
|
sp set ip
|
Sets or modifies the SP network configuration.
|
SP Get IP Subcommand
Description: Retrieves the ethernet-based network-configuration information for the SP, including IP address, network mask and gateway. In addition, it indicates whether the SP is configured to use DHCP or a static IP address.
Format
Command format:
sp get ip [-H | noheader] [{-D | --delim <DELIMITER>}]
TABLE H-23 lists the arguments for this subcommand.
TABLE H-23 Arguments for Subcommand sp get ip
|
Argument
|
Description
|
|
{ -H | --noheader }
|
Suppresses column headings.
|
|
{ -D | --delim }
|
Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
Return Codes
TABLE H-24 lists the arguments for this subcommand.
TABLE H-24 Return Codes for Subcommand sp get ip
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
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.
|
SP Set IP Subcommand
Description: Sets or modifies the SP network configuration.
Format
Command format:
sp set ip dhcp [--nowait]
sp set ip static {-i | --ipaddress} IP_ADDRESS [{-n | --netmask} NETMASK] [{-g | --gateway} GATEWAY}] [-w | --nowait]
TABLE H-25 lists the arguments for this subcommand.
TABLE H-25 Arguments for Subcommand sp set ip
|
Argument
|
Description
|
|
{-i | --ipaddress}
|
Specifies the IP address you wish to set.
|
|
{-n | --netmask}
|
Specifies the netmask; the default value is 255.255.255.0.
|
|
{-g | --gateway}
|
Specifies the gateway; the default value is the existing gateway.
|
|
{-w | --nowait}
|
If you specify the -nowait option, loss of connectivity will occur some time after the command returns. If you do not specify the -nowait option, your connections to the SP will be lost before the command returns.
|
Return Codes
TABLE H-26 lists the return codes for this subcommand.
TABLE H-26 Return Codes for Subcommand sp set ip
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
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 network.
|
|
NWSE_NetMaskIncorrect
|
17
|
An inappropriate netmask was specified.
|
SP JNET Address Subcommands
The JNET address is used for communications between the SP and the platform. The subcommands in TABLE H-27 manage the SP JNET address.
TABLE H-27 SP JNET Subcommands
|
Subcommand
|
Description
|
|
sp get jnet
|
Retrieves the JNET address.
|
|
sp set jnet
|
Sets the JNET address.
|
SP Get JNET Subcommand
Description: Retrieves the IP address of the platform JNET driver.
Format
Command format:
sp get jnet [{-H | --noheader}] [{-D | --delim <DELIMITER>}]
TABLE H-28 lists the arguments for this subcommand.
TABLE H-28 Arguments for Subcommand sp get jnet
|
Argument
|
Description
|
|
{ -H | --noheader }
|
Suppresses column headings.
|
|
{ -D | --delim }
|
Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
Return Codes
TABLE H-29 lists the return codes for this subcommand.
TABLE H-29 Return Codes for Subcommand sp get jnet
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
NWSE_HostDown
|
14
|
Host is down.
|
SP Set JNET Subcommand
Description: Sets or modifies the SP and platform network addresses for JNET. Because of the firewall between these drivers, you must specify both addresses at the same time.
Both the SP and Platform JNET addresses must be on the same Class C subnet.
Format
Command format:
sp set jnet {-p | --platform} IP ADDRESS {-s | --sp} IP ADDRESS
TABLE H-30 lists the arguments for this subcommand.
TABLE H-30 Arguments for Subcommand sp set jnet
|
Argument
|
Description
|
|
{-p | --platform}
|
Specifies the IP address for the platform.
|
|
{-s | --sp}
|
Specifies the IP address for the SP.
|
|
Note - If you change the default addresses of JNET using this command and then re-install the platform operating system or reset the SP through the subcommand
sp reset to default-settings , you must re-issue the subcommand
sp set jnet to re-establish the JNET connection.
Otherwise, the connection will be out-of-sync (one address will be modified and one will be re-set to the default address.)
|
Return Codes
TABLE H-31 lists the return codes for this subcommand.
TABLE H-31 Return Codes for Subcommand sp set jnet
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
NWSE_HostDown
|
14
|
Host is down.
|
SP Locate Light Subcommands
The subcommands in TABLE H-32 manage the locatelight switch.
TABLE H-32 SP Locatelight Subcommands
|
Subcommand
|
Description
|
|
sp get locatelight
|
Reads the value of the locatelight switch (which represents the state of the front and rear panel identification lights).
|
|
sp set locatelight
|
Sets the state of the locatelight switch.
|
SP Get Locatelight Subcommand
Description: Reads the value of the locatelight switch (which represents the state of the front and rear panel identification lights). The possible states are blinking or off.
Format
Command format:
sp get locatelight
Return Codes
TABLE H-33 lists the return codes for this subcommand.
TABLE H-33 Return Codes for Subcommand sp get locatelight
|
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_NoPermission
|
6
|
Not authorized to perform this operation.
|
SP Set Locatelight Subcommand
Description: Sets the state of the locatelight switch (which describes the state of the front and rear panel identification lights).
Format
Command format:
sp set locatelight {blink | off}
Return Codes
TABLE H-34 lists the return codes for this subcommand.
TABLE H-34 Return Codes for Subcommand sp set locatelight
|
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_NoPermission
|
6
|
Not authorized to perform this operation.
|
SP Logfile Subcommands
The subcommands in TABLE H-35 manage the SP log files.
TABLE H-35 SP Logfile Subcommands
|
Subcommand
|
Description
|
|
sp get logfile
|
Retrieves the event-log file configuration.
|
|
sp set logfile
|
Configures the event log file that is the destination of all Event Manager events and notices.
|
SP Get Logfile Subcommand
Description: Retrieves the event log file configuration.
Format
Command format:
sp get logfile [-H | --noheader] [{-D | --delim <DELIMITER>}]
TABLE H-36 lists the arguments for this subcommand.
TABLE H-36 Arguments for Subcommand sp get logfile
|
Argument
|
Description
|
|
{ -H | --noheader }
|
Suppresses column headings.
|
|
{ -D | --delim }
|
Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
Return Codes
TABLE H-37 lists the return codes for this subcommand.
TABLE H-37 Return Codes for Subcommand sp get logfile
|
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_NoMemory
|
8
|
Insufficient memory.
|
SP Set Logfile Subcommand
Description: Configures the event log file that is the destination of all Event Manager events and notices.
Format
Command format:
sp set logfile [ {-f | --file} FILENAME] [ {-s | --size} SIZE]
You must specify the name of the file to which the Event Manager sends logs. When setting the log file using this command, specify only the name of the log file without the path. File names cannot contain the forward slash character (/), backward relative-path reference (..) or the less-than symbol (<).
TABLE H-38 lists the arguments for this subcommand.
TABLE H-38 Arguments for Subcommand sp set logfile
|
Argument
|
Description
|
|
{-f | --file}
|
Specifies the name of the file within the directory to which the Event Manager sends logs.
|
|
{-s | --size}
|
Specifies the size of the file in megabytes. A minimum size of 0.01 MB is required for this log file.
|
Return Codes
TABLE H-39 lists the arguments for this subcommand.
TABLE H-39 Return Codes for Subcommand sp set logfile
|
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_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
SP Miscellaneous Subcommands
The subcommands in TABLE H-40 manage miscellaneous SP functions.
TABLE H-40 Miscellaneous SP Subcommands
|
Subcommand
|
Description
|
|
sp create test events
|
Tests and validates different types of configurations you may be considering for the SP.
|
|
sp get port 80
|
Retrieves the last port 80 postcode from the PRS Port80 register.
|
|
sp get status
|
Returns the status of the overall system.
|
|
sp get tdulog
|
Captures data and stores it on the SP in compressed format.
|
|
sp load settings
|
Configures an SP with the same configuration as that of another Service Processor.
|
|
sp reboot
|
Restarts the SP.
|
|
sp reset
|
Restores selected settings of the SP to the default factory configuration.
|
SP Create Test Events Subcommand
Description: This command helps you test and validate different types of configurations that you might be considering for the SP (for example, configurations involving event forwarding, such SNMP, SMTP, log files or directory services).
Typically, you would have to wait for an event to be generated on the SP in order to validate that these configurations are working properly. However, using this command, you can generate test events that will be routed appropriately according to these configurations.
Format
Command format:
sp create test events
Return Codes
TABLE H-41 lists the return codes for this command.
TABLE H-41 Return Codes for Subcommand sp create test events
|
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_NoMemory
|
8
|
Insufficient memory.
|
SP Get Port 80 Subcommand
Description: Retrieves the last Port 80 post code from the PRS Port80 register. The register is written by platform BIOS during platform boot. This command is used to debug platform boot problems.
Format
Command format:
sp get port80 {-m | --monitor}
TABLE H-42 lists the arguments for this subcommand.
TABLE H-42 Arguments for Subcommand sp get port80
|
Argument
|
Description
|
|
{-m | --monitor}
|
Allows for continuous monitoring of the port 80 traffic.
|
You can also retrieve the last ten Port 80 post codes using the operator panel.
For more details about using the operator-panel menus, refer to the Sun Fire V20z Server User Guide (817-5248-xx).
See TABLE H-44 for a list of the Power On Self Test (POST) codes for the Phoenix BIOS.
See TABLE H-45 for a list of the boot block codes on Flash ROM.
Return Codes
TABLE H-43 lists the return codes for this subcommand.
TABLE H-43 Return Codes for Subcommand sp get port80
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_ServiceNotAvailable
|
24
|
Requested service is not available.
|
BIOS POST Codes
TABLE H-44 lists the POST codes for the Phoenix BIOS.
TABLE H-44 BIOS POST Codes
|
POST Code
|
Description
|
|
02
|
Verify real mode
|
|
03
|
Disable non-maskable interrupt (NMI)
|
|
04
|
Get CPU type
|
|
06
|
Initialize system hardware
|
|
07
|
Disable shadow and execute code from the ROM
|
|
08
|
Initialize chipset with initial POST values
|
|
09
|
Set IN POST flag
|
|
0A
|
Initialize CPU registers
|
|
0B
|
Enable CPU cache
|
|
0C
|
Initialize caches to initial POST values
|
|
0E
|
Initialize I/O component
|
|
0F
|
Initialize the local bus IDE
|
|
10
|
Initialize power management
|
|
11
|
Load alternate registers with initial POST values
|
|
12
|
Restore CPU control word during warm boot
|
|
13
|
Initialize PCI bus mastering devices
|
|
14
|
Initialize keyboard controller
|
|
16
|
BIOS ROM checksum
|
|
17
|
Initialize cache before memory autosize
|
|
18
|
8254 programmable interrupt timer initialization
|
|
1A
|
8237 DMA controller initialization
|
|
1C
|
Reset programmable interrupt controller
|
|
20
|
Test DRAM refresh
|
|
22
|
Test 8742 keyboard controller
|
|
24
|
Set ES segment register to 4GB
|
|
26
|
Enable gate A20 line
|
|
28
|
Autosize DRAM
|
|
29
|
Initialize POST memory manager
|
|
2A
|
Clear 512KB base RAM
|
|
2C
|
RAM failure on address line xxxx
|
|
2E
|
RAM failure on data bits xxxx of low byte of memory bus
|
|
2F
|
Enable cache before system BIOS shadow
|
|
30
|
RAM failure on data bits xxxx of high byte of memory bus
|
|
32
|
Test CPU bus clock frequency
|
|
33
|
Initialize Phoenix Dispatch Manager
|
|
36
|
Warm start shut down
|
|
38
|
Shadow system BIOS ROM
|
|
3A
|
Autosize cache
|
|
3C
|
Advanced configuration of chipset registers
|
|
3D
|
Load alternate registers with CMOS values
|
|
41
|
Initialize extended memory for RomPilot
|
|
42
|
Initialize interrupt vectors
|
|
45
|
POST device initialization
|
|
46
|
Check ROM copyright notice
|
|
47
|
Initialize I20 support
|
|
48
|
Check video configuration against CMOS
|
|
49
|
Initialize PCI bus and devices
|
|
4A
|
Initialize all video adapters in system
|
|
4B
|
QuietBoot start (optional)
|
|
4C
|
Shadow video BIOS ROM
|
|
4E
|
Display BIOS copyright notice
|
|
4F
|
Initialize MultiBoot
|
|
50
|
Display CPU type and speed
|
|
51
|
Initialize EISA board
|
|
52
|
Test keyboard
|
|
54
|
Set key click if enabled
|
|
55
|
Enable USB devices
|
|
58
|
Test for unexpected interrupts
|
|
59
|
Initialize POST display service
|
|
5A
|
Display prompt "Press F2 to enter SETUP"
|
|
5B
|
Disable CPU cache
|
|
5C
|
Test RAM between 512KB and 640KB
|
|
60
|
Test extended memory
|
|
62
|
Test extended memory address lines
|
|
64
|
Jump to UserPatch1
|
|
66
|
Configure advanced cache registers
|
|
67
|
Initialize Multi Processor APIC
|
|
68
|
Enable external and CPU caches
|
|
69
|
Setup system management mode (SMM) area
|
|
6A
|
Display external L2 cache size
|
|
6B
|
Load custom defaults (optional)
|
|
6C
|
Display shadow area message
|
|
6E
|
Display possible high address for UMB recovery
|
|
70
|
Display error messages
|
|
72
|
Check for configuration errors
|
|
76
|
Check for keyboard errors
|
|
7C
|
Set up hardware interrupt vectors
|
|
7D
|
Initialize Intelligent System Monitoring
|
|
7E
|
Initialize coprocessor if present
|
|
80
|
Disable onboard super I/O ports and IRQs
|
|
81
|
Late POST device initialization
|
|
82
|
Detect and install external RS232 ports
|
|
83
|
Configure non-MCD IDE controllers
|
|
84
|
Detect and install external parallel ports
|
|
85
|
Initialize PC compatible PnP ISA devices
|
|
86
|
Reinitialize onboard I/O ports
|
|
87
|
Configure motherboard configurable devices (optional)
|
|
88
|
Initialize BIOS data area
|
|
89
|
Enable non-maskable interrupts (NMIs)
|
|
8A
|
Initialize extended BIOS data area
|
|
8B
|
Test and initialize PS/2 mouse
|
|
8C
|
Initialize floppy controller
|
|
8F
|
Determine number of ATA drives (optional)
|
|
90
|
Initialize hard disk controllers
|
|
91
|
Initialize local bus hard disk controllers
|
|
92
|
Jump to UserPatch2
|
|
93
|
Build MPTABLE for multi processor boards
|
|
95
|
Install CD ROM for boot
|
|
96
|
Clear huge ES segment register
|
|
97
|
Fixup multi processor table
|
|
98
|
Search for option ROMs
|
|
99
|
Check for SMART drive (optional)
|
|
9A
|
Shadow option ROMs
|
|
9C
|
Set up power management
|
|
9D
|
Initialize security engine (optional)
|
|
9E
|
Enable hardware interrupts
|
|
9F
|
Determine number of ATA and SCSI drives
|
|
A0
|
Set time of day
|
|
A2
|
Check key lock
|
|
A4
|
Initialize typematic rate
|
|
A8
|
Erase F2 prompt
|
|
AA
|
Scan for F2 key stroke
|
|
AC
|
Enter setup
|
|
AE
|
Clear boot flag
|
|
B0
|
Check for errors
|
|
B1
|
Inform RomPilot about the end of POST
|
|
B2
|
POST done - prepare to boot operating system
|
|
B4
|
One short beep
|
|
B5
|
Terminate QuietBoot (optional)
|
|
B6
|
Check password
|
|
B7
|
Initialize ACPI BIOS
|
|
B9
|
Prepare boot
|
|
BA
|
Initialize DMI parameters
|
|
BB
|
Initialize PnP option ROMs
|
|
BC
|
Clear parity checkers
|
|
BD
|
Display multiboot menu
|
|
BE
|
Clear screen
|
|
BF
|
Check virus and backup reminders
|
|
C0
|
Try to boot with interrupt 19
|
|
C1
|
Initialize POST Error Manager (PEM)
|
|
C2
|
Initialize error logging
|
|
C3
|
Initialize error display function
|
|
C4
|
Initialize system error handler
|
|
C5
|
PnP dual CMOS (optional)
|
|
C6
|
Initialize notebook docking (optional)
|
|
C7
|
Initialize notebook docking late
|
|
C8
|
Force check (optional)
|
|
C9
|
Extended checksum (optional)
|
|
CA
|
Redirect Int 15h to enable remote keyboard
|
|
CB
|
Redirect Int 13 to Memory Technologies Devices such as ROM, RAM, PCMCIA and serial disk
|
|
CC
|
Redirect Int 10h to enable remote serial video
|
|
CD
|
Re-map I/O and memory for PCMCIA
|
|
CE
|
Initialize digitizer and display message
|
|
D2
|
Unknown interrupt
|
Boot Block Codes for Flash ROM
TABLE H-45 lists the boot block codes in Flash ROM.
TABLE H-45 Boot Block Codes in Flash ROM
|
Post Code
|
Description
|
|
E0
|
Initialize the chipset
|
|
E1
|
Initialize the bridge
|
|
E2
|
Initialize the CPU
|
|
E3
|
Initialize the system timer
|
|
E4
|
Initialize system I/O
|
|
E5
|
Check force recovery boot
|
|
E6
|
Checksum BIOS ROM
|
|
E7
|
Go to BIOS
|
|
E8
|
Set Huge Segment
|
|
E9
|
Initialize Multi Processor
|
|
EA
|
Initialize OEM special code
|
|
EB
|
Initialize PIC and DMA
|
|
EC
|
Initialize Memory type
|
|
ED
|
Initialize Memory size
|
|
EE
|
Shadow Boot Block
|
|
EF
|
System memory test
|
|
F0
|
Initialize interrupt vectors
|
|
F1
|
Initialize Run Time Clock
|
|
F2
|
Initialize video
|
|
F3
|
Initialize System Management Manager
|
|
F4
|
Output one beep
|
|
F5
|
Clear Huge Segment
|
|
F6
|
Boot to mini DOS
|
|
F7
|
Boot to Full DOS
|
SP Load Settings Subcommand
Description: Configures an SP with the same configuration as that of another SP.
You can also perform autoconfiguration from the operator panel to perform this same function. For more information, see Autoconfiguring the SP (Optional Method).
Format
Command format:
sp load settings {{ -s | --sp } SP_IP_OR_HOST [-H |--noheader]
TABLE H-46 lists the arguments for this subcommand.
TABLE H-46 Arguments for Subcommand sp load settings
|
Argument
|
Description
|
|
{ -s | --sp }
|
The IP address of the machine from which to copy the configuration information.
|
|
[-H |--noheader]
|
Suppresses header output.
|
Return Codes
TABLE H-47 lists the return codes for this subcommand.
TABLE H-47 Return Codes for Subcommand sp load settings
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_HostDown
|
14
|
Host is down.
|
SP Get Status Subcommand
Description: Returns the status of the overall system.
Format
Command format:
sp get status
TABLE H-48 lists the arguments for this subcommand.
TABLE H-48 Arguments for Subcommand sp get status
|
Argument
|
Description
|
|
Nominal
|
All components are operating within normal parameters.
|
|
Warning
|
One or more components are operating at warning levels.
|
|
Critical
|
One or more components are operating out of specification or have failed.
|
Return Codes
TABLE H-49 lists the return codes for this subcommand.
TABLE H-49 Return Codes for Subcommand sp get status
|
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_NoPermission
|
6
|
Not authorized to perform this operation.
|
SP Get TDULog Subcommand
Description: The Troubleshooting Dump Utility (TDU) captures debug data. When you execute this command, this data is gathered and stored on the Service Processor in a compressed tar file.
Format
Command format:
sp get tdulog [{-f | --filename} FILENAME or STDOUT ]
[{-c | --cpuregs} CPU REGISTERS]
[{-p | --pciregs} PCI REGISTERS]
[{-r | --reset} RESET PLATFORM]
TABLE H-50 lists the arguments for this subcommand.
TABLE H-50 Arguments for Subcommand sp get tdulog
|
Argument
|
Description
|
|
{-f | --filename}
|
Optional. The name of the output file to which the log files are copied, or the fully qualified path name. File names cannot contain the backward relative path reference (..) or the less than symbol (<).
The following log files are created by default:
envLog: contains the environment variables
vpdLog: contains raw VPD data
Additional log files are created for CPU2 and CPU3 registers.
The TDU data can also be redirected to stdout. If the file name is stdout, the output is sent to stdout and the log files are not created.
An NFS-mounted file share must be used to store the output file.
If you do not provide a file name, it creates a file named tdulog.tar in /logs/<hostname>, where the <hostname> is the host name of the SP. If the host name is localhost, then the MAC address is used instead.
|
|
{-c | --cpuregs}
|
Reads the K-8 registers (GPRs, MSRs, TCB and machine check) from up to four CPUs.
|
|
{-p | --pciregs}
|
Reads all PCI registers on the system.
|
|
{-r | --reset}
|
Resets the platform if unable to access HDT mode.
|
The register name, address and data are logged to a file. For example, the information for CPU0 is shown in TABLE H-51.
TABLE H-51 Sample Information for Subcommand sp get tdulog on CPU0
|
Reg Name
|
Reg Addr
|
Reg Data
|
|
MSR_MCG_CAP_MSR
|
0xc0020179
|
0x0000000000000105
|
|
MSR_MCG_STAT_MSR
|
0xc002017a
|
0x0000000000000000
|
|
MSR_MCG_CTL_MSR
|
0xc002017b
|
0x000000000000001F
|
|
MSR_MC0_CTL
|
0xc0020400
|
0x000000000000007F
|
Return Codes
TABLE H-52 lists the return codes for this subcommand.
TABLE H-52 Return Codes for Subcommand sp get tdulog
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
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_UnknownError
|
15
|
Miscellaneous error not captured by other errors.
|
|
NWSE_FileError
|
18
|
File open, file missing, or a read or write error occurred.
|
|
NWSE_NotMounted
|
21
|
File system is not mounted.
|
|
NWSE_ServiceNotAvailable
|
24
|
Requested service is not available.
|
SP Reboot Subcommand
Description: Restarts the SP. This command is useful in emergency situations in which you may not have physical access to a machine.
Format
Command format:
sp reboot [ {-f | --forced} ]
TABLE H-53 lists the argument for this command.
TABLE H-53 Argument for Subcommand sp reboot
|
Argument
|
Description
|
|
{-f | --forced}
|
Results in a hard power off.
|
Return Codes
TABLE H-54 lists the return codes for this command.
TABLE H-54 Return Codes for Subcommand sp reboot
|
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_NoMemory
|
8
|
Insufficient memory.
|
SP Reset Subcommand
Description: Restores selected settings of the SP to the default factory configuration.
The SP configuration files are stored in the directory /pstore. When you boot the system, the SP copies these configuration files from /pstore to /etc whenever the files are missing from /etc. Resetting the SP to its default configuration is accomplished by deleting the configuration files in the directory /pstore. A reboot of the SP is necessary for the SP reset to take effect.
By default, the SP reboots 60 seconds after the subcommand sp reset to default-settings executes, unless you specify the --nowait option, in which case the reboot occurs immediately.
Format
Command format:
sp reset to default-settings {-a | --all} {-c | --config}{-n | --network} {-s | --ssh} {-u | --users} {-W | --nowait}
TABLE H-55 lists the arguments for this command.
TABLE H-55 Arguments for Subcommand sp reset
|
Argument
|
Description
|
|
{-a | --all}
|
Resets all SP settings to their default configuration.
When the SP reboots, the settings are reset to their default values.
|
|
{-c | --config}
|
Resets other system configuration settings to their default configuration.
When the SP reboots, the system settings are reset to their default values.
|
|
{-n | --network}
|
Resets network settings to their default configuration.
When the SP reboots, it has no network capabilities or host name. Its NFS mounts fail and you cannot log into the SP remotely through ssh.
Set up the network configuration for the SP through the operator panel to restore network functions.
Set the host name for the SP in order to refer to the SP by name and set up the file resolv.conf in order to refer to other systems by name instead of by dot-quad IP addresses.
This option deletes all the network files in the directory /pstore.
|
|
{-s | --ssh}
|
Resets SSH settings to their default configuration.
When the SP reboots, new ssh public and private keys are generated. Using ssh to access the SP from a remote system that had previously logged into the SP causes a failure with a message about the "Remote Host Identification" changing because the ssh key on the SP has changed.
The remote system must delete its ssh public key entry for the SP in order to ssh into the SP successfully. This option deletes all the files in the directory /pstore/ssh/.
|
|
{-u | --users}
|
Resets user authentication settings to their default configuration.
When the SP reboots, all user accounts will have been deleted and you cannot log into the SP remotely through ssh.
|
|
[-W | --nowait]
|
Reboots the SP immediately.
|
|
Note - If you change the default addresses of JNET using this command and then re-install the platform operating system or reset the SP by running the subcommand sp reset to default-settings, you must re-issue the subcommand sp set jnet to re-establish the JNET connection.
Otherwise, the connection will be out-of-sync (one address will be modified and one will be re-set to the default address).
|
Return Codes
TABLE H-56 list the return codes for this command.
TABLE H-56 Return Codes for Subcommand sp reset
|
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_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
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.
|
SP Mount Subcommands
The subcommands in TABLE H-57 manage the SP mount points.
TABLE H-57 SP Mount Subcommands
|
Subcommand
|
Description
|
|
sp add mount
|
Creates or resets a mount point.
|
|
sp delete mount
|
Deletes the specified mount point.
|
|
sp get mounts
|
Displays the current mount points on the SP.
|
SP Add Mount Subcommand
Description: Creates or resets a mount point.
Format
Command format:
sp add mount [{-l | --local} MOUNTPOINT ] {-r | --remote} SERVER:FILESYSTEM
[{-u|--user} USER] [{-p|--password} PASSWORD]
TABLE H-58 lists the arguments for this subcommand.
TABLE H-58 Arguments for Subcommand sp add mount
|
Argument
|
Description
|
|
{-l | --local}
|
Optional; Specifies the local mount point. The only mount point supported is /mnt.
|
|
{-r | --remote}
|
Specifies the remote server and file system. If SERVER specifies a host name, DNS must be properly configured.
|
|
{-u | --user}
|
Specifies the user name for the mount. Only required for SMB.
|
|
{-p | --password}
|
Specifies the password for the mount user. Only required for SMB.
|
|
Note - Several error messages may appear when executing an smb mount while mounting windows partitions. Check that the mount succeeded after the call by running the subcommand sp get mount.
|
The required formats for remote NFS and SMB mounts are as follows:
- For NFS: server_name:server_exported_mountpoint
- For SMB: //server_name/windows_share_name
Return Codes
TABLE H-59 lists the return codes for this subcommand.
TABLE H-59 Return Codes for Subcommand sp add mount
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
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.
|
SP Delete Mount
Description: Deletes a mount point.
Format
Command format:
sp delete mount LOCAL_MOUNT_POINT [-q | --quiet]
TABLE H-60 lists the arguments for this subcommand.
TABLE H-60 Arguments for Subcommand sp delete mount
|
Argument
|
Description
|
|
LOCAL MOUNT POINT
|
Specifies the mount point to remove. If you do not specify the local mount point, /mnt is implicit as the default value.
|
|
[-q | --quiet]
|
If the mount point to delete is not found, this argument specifies that no error be returned.
|
Return Codes
TABLE H-61 lists the return codes for this subcommand.
TABLE H-61 Return Codes for Subcommand sp delete mount
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
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.
|
SP Get Mount Subcommand
Description: Displays the current mount points on the SP.
Format
Command format:
sp get mounts [{-l | --local} MOUNTPOINT] [-H | --noheader] [{-D | --delim <DELIMITER>}]
TABLE H-62 lists the arguments for this subcommand.
TABLE H-62 Arguments for Subcommand sp get mount
|
Arguments
|
Description
|
|
{-l | --local}
|
Specifies the local mount point. If you do not specify -l, /mnt is implicit as the local mount point.
|
|
{ -H | --noheader }
|
Suppresses column headings.
|
|
{ -D | --delim }
|
Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
Return Codes
TABLE H-63 lists the return codes for this subcommand.
TABLE H-63 Return Codes for Subcommand sp get mount
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NotFound
|
5
|
Entity (user, service, file, path or other) not found.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_Busy
|
9
|
Device or resource is busy.
|
|
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_NotMounted
|
21
|
File system is not mounted.
|
SP SMTP Subcommands
The subcommands in TABLE H-64 manage SMTP communications.
TABLE H-64 SP SMTP Subcommands
|
Subcommand
|
Description
|
|
sp get smtp server
|
Retrieves the SMTP server information.
|
|
sp get smtp subscribers
|
Returns detailed information about one or all SMTP subscribers.
|
|
sp set smtp server
|
Configures the SP SMTP client with the address for the remote SMTP server.
|
|
sp update smtp subscriber
|
Updates the information for an existing SMTP subscriber.
|
SP Get SMTP Server Subcommand
Description: Retrieves the SMTP server information, including the from address.
Format
Command format:
sp get smtp server [-H | --noheader] [{-D | --delim <DELIMITER>}]
TABLE H-65 lists the arguments for this subcommand.
TABLE H-65 Arguments for Subcommand sp get smtp server
|
Argument
|
Description
|
|
{ -H | --noheader }
|
Suppresses column headings.
|
|
{ -D | --delim }
|
Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
Return Codes
TABLE H-66 lists the return codes for this subcommand.
TABLE H-66 Return Codes for Subcommand sp get smtp server
|
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.
|
SP Set SMTP Server Subcommand
Description: Configures the SP SMTP client with the information for the remote SMTP server, including the address and optional port number.
Format
Command format:
sp set smtp server [{-f | --from} FROM FIELD ] IP OR HOSTNAME OF SMTP SERVER
TABLE H-67 lists the arguments for this subcommand.
TABLE H-67 Arguments for Subcommand sp set smtp server
|
Arguments
|
Description
|
|
{-f | --from}
|
Specifies the from field for the SMTP server.
|
|
IP OR HOSTNAME OF SMTP SERVER
|
Specifies the IP address or the host name of the SMTP server.
|
The value you supply is prepended onto @hostname | ip_address. The default value is system.
For example, if you enter admin for sp_22, email messages are sent from admin@sp_22.
If the host name is not set, the IP will be used as follows: admin@10.10.30.55.
Return Codes
TABLE H-68 lists the return codes for this subcommand.
TABLE H-68 Return Codes for Subcommand sp set smtp server
|
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.
|
SP Get SMTP Subscribers Subcommand
Description: Returns detailed information about one or all SMTP subscribers.
Format
Command format:
sp get smtp subscribers [{-n | --name} <NAME>] [-H | noheader] [{-D | --delim <DELIMITER>}]
TABLE H-69 lists the arguments for this subcommand.
TABLE H-70 lists the default SMTP subscribers.
TABLE H-69 Arguments for Subcommand sp get smtp sebscribers
|
Arguments
|
Description
|
|
{ -n | --namserver }
|
Specifies the name of the SMTP subscriber for which to retrieve information. If you do not specify this option, the command returns information for all subscribers.
|
|
{ -H | --noheader }
|
Suppresses column headings.
|
|
{ -D | --delim }
|
Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
TABLE H-70 Default SMTP Subscribers
|
Subscriber
|
Description
|
|
SMTP_Info_Short
|
Short email message, informational severity
|
|
SMTP_Info_Long
|
Long email message, informational severity
|
|
SMTP_Warning_Short
|
Short email message, warning severity
|
|
SMTP_Warning_Long
|
Long email message, warning severity
|
|
SMTP_Critical_Short
|
Short email message, critical severity
|
|
SMTP_Critical_Long
|
Long email message, critical severity
|
Long email messages contain full event details in the message body, while short email messages contain no message body and a descriptive subject line (the same subject as used for long messages).
The short-email format is intended to be used with pagers and other wireless access devices with which message-size constraints may prevent reception of the long-format message.
Return Codes
TABLE H-71 lists the return codes for this subcommand.
TABLE H-71 Return Codes for Subcommand sp get smtp subscribers
|
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_NotFound
|
5
|
Entity (user, service, file, path, etc.) was not found.
|
SP Update SMTP Subscriber Subcommand
Description: Updates the information for an existing SMTP subscriber.
Format
Command format:
sp update smtp subscriber {-n | --name} NAME {-r | --recipients} ADDRESS LIST
TABLE H-72 lists the arguments for this subcommand.
TABLE H-73 lists the default SMTP subscribers.
|
Note - All options replace the existing values with the new value. Unspecified options leave existing settings as they are. For example, if you only specify the -r option for an existing subscriber, the existing email address list is replaced with the new list specified in the command.
|
TABLE H-72 Arguments for Subcommand sp update smtp subscriber
|
Arguments
|
Description
|
|
{-n | --name}
|
Specifies the name of the SMTP subscriber to update. This argument is repeatable to update multiple SMTP subscribers at one time.
|
|
{-r | --recipients}
|
Specifies the address list of recipients for the SMTP subscriber.
|
TABLE H-73 Default SMTP Subscribers
|
Subscriber
|
Description
|
|
SMTP_Info_Short
|
Short email message, informational severity
|
|
SMTP_Info_Long
|
Long email message, informational severity
|
|
SMTP_Warning_Short
|
Short email message, warning severity
|
|
SMTP_Warning_Long
|
Long email message, warning severity
|
|
SMTP_Critical_Short
|
Short email message, critical severity
|
|
SMTP_Critical_Long
|
Long email message, critical severity
|
Long email messages contain full event details in the message body, while short email messages contain no message body and a descriptive subject line (the same subject as used for long messages).
The short-email format is intended to be used with pagers and other wireless access devices with which message-size constraints may prevent reception of the long-format message.
Return Codes
TABLE H-74 lists the return codes for this command.
TABLE H-74 Return Codes for Subcommand sp update smtp subscriber
|
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_NotFound
|
5
|
Entity (user, service, file, path, etc.) was not found.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
SP SNMP Subcommands
The subcommands in TABLE H-75 manage SNMP communications.
TABLE H-75 SP SNMP Subcommands
|
Subcommand
|
Description
|
|
sp add snmp destination
|
Adds an SNMP destination.
|
|
sp delete snmp destination
|
Deletes the SNMP destination.
|
|
sp get snmp destinations
|
Displays the available SNMP destinations (IP address or hostname) to which the Service Processor is configured to send.
|
|
sp get snmp proxy community
|
Returns the community name currently being used by the Service Processor SNMPD to proxy the platform SNMP agent.
|
|
sp set snmp proxy community
|
Sets the proxy entries that specify the OID to be referred, the IP to which they are referred and the community string to use while proxying.
|
SP Add SNMP Destination Subcommand
Description: Adds a single SNMP destination (either IP address or host name).
Format
Command format:
sp add snmp-destination IP ADDRESS/HOSTNAME
TABLE H-76 lists the argument for this subcommand.
TABLE H-76 Argument for Subcommand sp add snmp-destination
|
Arguments
|
Description
|
|
IP ADDRESS/HOSTNAME
|
Specifies the IP address or name of the host for the destination you wish to add.
This argument is repeatable to add multiple destinations at one time; however, the number of destinations you can create is limited due to memory constraints.
|
Return Codes
TABLE H-77 lists the return codes for this subcommand.
TABLE H-77 Return Codes for Subcommand sp add snmp-destination
|
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_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_RPCConnRefused
|
12
|
RPC connection refused.
|
|
NWSE_UnknownError
|
15
|
Miscellaneous error not captured by other errors.
|
|
NWSE_FileError
|
18
|
File open, file missing, or a read or write error occurred.
|
|
NWSE_Exist
|
19
|
Entity (user, service or other) already exists.
|
SP Delete SNMP Destination Subcommand
Description: Deletes a single SNMP destination (either IP address or host name).
Format
Command format:
sp delete snmp-destination { IP_ADDRESS/HOSTNAME | {-a | --all} [-q | --quiet]
TABLE H-78 lists the arguments for this subcommand.
TABLE H-78 Arguments for Subcommand sp delete snmp-destination
|
Arguments
|
Description
|
|
IP ADDRESS/HOSTNAME
|
Specifies the IP address or hostname of the destination to remove. This argument is repeatable to remove multiple destinations at one time.
|
|
[-a | --all]
|
Removes all SNMP destinations.
|
|
[-q | --quiet]
|
If the SNMP destination to delete is not found, this argument specifies that no error be returned.
|
Return Codes
TABLE H-79 lists the return codes for this subcommand.
TABLE H-79 Return Codes for Subcommand sp delete snmp-destination
|
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_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NotFound
|
5
|
Entity (user, service, file, path or other) not found.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_RPCConnRefused
|
12
|
RPC connection refused.
|
|
NWSE_UnknownError
|
15
|
Miscellaneous error not captured by other errors.
|
|
NWSE_FileError
|
18
|
File open, file missing, or a read or write error occurred.
|
SP Get SNMP Destinations Subcommand
Description: Displays the available SNMP destinations (IP address or host name) to which the SP is configured to send. Many networking programs use this information to identify the machine.
Format
Command format:
sp get snmp-destinations
Return Codes
TABLE H-80 lists the return codes for this subcommand.
TABLE H-80 Return Codes for Subcommand sp get snmp-destinations
|
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_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_UnknownError
|
15
|
Miscellaneous error not captured by other errors.
|
|
NWSE_FileError
|
18
|
File open, file missing, or a read or write error occurred.
|
SP Get SNMP Proxy Community Subcommand
Description: Returns the community name the SP is currently using to proxy the platform SNMP agent.
Format
Command format:
sp get snmp proxy community
Return Codes
TABLE H-81 lists the return codes for this subcommand.
TABLE H-81 Return Codes for Subcommand sp get snmp proxy community
|
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.
|
SP Set SNMP Proxy Community Subcommand
Description: The SNMP agent on the SP acts as a proxy for the master SNMP agent running on the platform. These proxy entries specify the OID to be referred, the IP address to which they are referred and the community string to use while proxying. The community string is the value configured on the platform-side SNMP configuration.
Format
Command format:
sp set snmp proxy community COMMUNITY STRING
TABLE H-82 lists the argument for this subcommand.
TABLE H-82 Argument for Subcommand sp set snmp proxy community
|
Argument
|
Description
|
|
COMMUNITY STRING
|
Specifies the name of the community to configure.
|
There are no restrictions on the length of the community strings; common names are private and public. The default name of the community string is private.
If you run the subcommand sp get snmp proxy community without setting it, the return valule is private. Otherwise, you can set it to any string.
Return Codes
TABLE H-83 lists the return codes for this subcommand.
TABLE H-83 Return Codes for Subcommand sp set snmp proxy community
|
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.
|
SP SSL Subcommands
The subcommands in TABLE H-84 manage SSL capabilities.
TABLE H-84 SP SSL Subcommands
|
Subcommand
|
Description
|
|
sp disable ssl-required
|
Disables forced use of the secure HTTP (https) protocol.
|
|
sp enable ssl-required
|
Enables forced use of the secure HTTP (https) protocol.
|
|
sp get ssl
|
Determines if the Apache Web server is using factory-supplied files or user-supplied files.
|
|
sp set ssl
|
Allows you to use site SSL certificates in the SP environment.
|
SP Disable SSL-Required Subcommand
Description: Disables automatic redirect to secure HTTP URLs. With SSL disabled, HTTP requests are serviced directly without redirecting to HTTPS. HTTPS requests continue to be secure.
Format
Command format:
sp disable ssl-required
Return Codes
TABLE H-85 lists the return codes for this command.
TABLE H-85 Return Codes for Subcommand sp disable ssl-required
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_FileError
|
18
|
File open, file missing, or a read or write error occurred.
|
|
NWSE_ServiceNotAvailable
|
24
|
Requested service is not available.
|
SP Enable SSL-Required Subcommand
Description: Enables automatic redirect to secure HTTP URLs. With SSL enabled, HTTP requests are automatically redirected to equivalent HTTPS requests to maintain site security.
SSL version 0.9.6j is supported.
Format
Command format:
sp enable ssl-required
Return Codes
TABLE H-86 lists the return codes for this command.
TABLE H-86 Return Codes for Subcommand sp enable ssl-required
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_FileError
|
18
|
File open, file missing, or a read or write error occurred.
|
|
NWSE_ServiceNotAvailable
|
24
|
Requested service is not available.
|
SP Get SSL Subcommand
Description: Determines if automatic redirect to secure HTTP is required or optional, and whether Apache Web Server is using factory or user-supplied SSL certificate files.
Format
Command format:
sp get ssl [{-H | noheader}] [{-D | --delim <DELIMITER>}]
TABLE H-87 lists the arguments for this subcommand.
TABLE H-87 Arguments for Subcommand sp get ssl
|
Arguments
|
Description
|
|
{ -H | --noheader }
|
Suppresses column headings.
|
|
{ -D | --delim }
|
Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
Return Codes
TABLE H-88 lists the return codes for this subcommand.
TABLE H-88 Return Codes for Subcommand sp get ssl
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_ServiceNotAvailable
|
24
|
Requested service is not available.
|
SP Set SSL Subcommand
Description: Allows you to use site SSL certificates in the Service Processor environment. This command allows you to replace the Server Certificate in the SP Value-Add image with your own internally-generated certificate and to restore the factory settings.
Format
Command format:
sp set ssl [-f]
sp set ssl {-c | --certfile} <FULL PATH OF THE SERVER CERTIFICATE FILE> {-k | --keyfile} <FULL PATH OF PRIVATE KEY FILE>
TABLE H-89 lists the arguments for this subcommand.
TABLE H-89 Arguments for Subcommand sp set ssl
|
Argument
|
Description
|
|
[-f]
|
Restores factory settings.
|
|
{-c | --certfile}
|
Flags the names of the files to be installed.
|
|
{-k | --keyfile}
|
Flags the names of the files to be installed.
|
Return Codes
TABLE H-90 lists the return codes for this subcommand.
TABLE H-90 Return Codes for Subcommand sp set ssl
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_FileError
|
18
|
File open, file missing, or a read or write error occurred.
|
|
NWSE_ServiceNotAvailable
|
24
|
Requested service is not available.
|
SP Update Subcommands
The subcommands in TABLE H-91 manage the SP flash.
TABLE H-91 SP Flash Subcommands
|
Subcommand
|
Description
|
|
sp update flash all
|
Sets the update flag to start the full flash update on the next reset of the SP.
|
|
sp update flash applications
|
Copies the file Value-Add to the Value-Add component of the SP flash.
|
|
sp update flash pic
|
Updates the PIC firmware to a newer version.
|
|
sp update diags
|
Updates the diagnostics to a newer version.
|
SP Update Flash All Subcommand
Description: Updates the entire SP flash image (kernel, base file system and value add) as part of a major SP software update. This command requires the use of the Java Update Server and verifies that it is available before beginning the update process. Once verified, the SP is rebooted and the update process is initiated. When completed, the SP is automatically rebooted using the updated image.
Format
Command format:
sp update flash all {-i | --ipaddress} <IP ADDRESS xxx.xxx.xxx.xxx> [{-p | --port}] <PORT#>
TABLE H-92 lists the arguments for this subcommand.
TABLE H-92 Arguments for Subcommand sp update flash all
|
Argument
|
Description
|
|
{-i | --serverip}
|
The IP address of the remote server on which the Java spUpdate program is running.
|
|
{-p | --port}
|
Optional: The port number on the remote server on which the Java spUpdate program is listening for SP flash update requests. If the port number is not provided, the command tries to connect to the default port. The default port number is 52708.
|
Return Codes
TABLE H-93 lists the return codes for this subcommand.
TABLE H-93 Return Codes for Subcommand sp update flash all
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_UnknownError
|
15
|
Miscellaneous error not captured by other errors.
|
|
NWSE_ServiceNotAvailable
|
24
|
Requested service is not available.
|
SP Update Flash Applications Subcommand
Description: The SP file system is divided into two componenets: Base and Value-Add. The Base component includes the repository and the Value-Add component includes the application software.
This command copies the file Value-Add to the Value-Add component of the SP flash. The new Value-Add image takes effect after you reset the SP.
Format
Command format:
sp update flash applications {-f | --filename}
TABLE H-94 lists the arguments for this subcommand.
TABLE H-94 Arguments for Subcommand sp update flash applications
|
Argument
|
Description
|
|
{-f | --filename}
|
Specifies the full path of the file.
|
Return Codes
TABLE H-95 lists the return codes for this subcommand.
TABLE H-95 Return Codes for Subcommand sp update flash applications
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NotFound
|
5
|
Entity (user, service, file, path or other) was not found.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_FileError
|
18
|
File open, file missing, or a read or write error occurred.
|
|
NWSE_DeviceError
|
25
|
Unable to read or write to the device.
|
SP Update Flash PIC Subcommand
Description: This command updates the PIC firmware to a newer version. An input PIC-update image file is provided.
Format
Command format:
sp update flash pic {-f | --filename} FULL PATH OF THE FILE | [{-v | --version}]
TABLE H-96 lists the arguments for this subcommand.
TABLE H-96 Arguments for Subcommand sp update flash pic
|
Argument
|
Description
|
|
{-f | --filename}
|
Specifies the full path of the file.
|
|
{-v | --version}
|
Outputs the current version of the firmware.
|
Return Codes
TABLE H-97 lists the return codes for this subcommand.
TABLE H-97 Return Codes for Subcommand sp update flash pic
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_NotFound
|
5
|
Entity (user, service, file, path, etc.) was not found.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
|
NWSE_FileError
|
18
|
File open, file missing, or a read or write error occurred.
|
|
NWSE_DeviceError
|
25
|
Unable to read or write to the device.
|
SP Update Diags Subcommand
Description: Updates the current version of diagnostics available.
While the SP functions normally without access to an external file system, a file system is required to enable several features, including diagnostics. The SP software uses a default version of diagnostics. However, if a new version is released and stored on the Network Share Volume, you must explicitly point to that new version to use it.
Format
Command format:
sp update diags {-p | --path} <PATH_TO_DIAGS_FOLDER>
TABLE H-98 lists the argument for this subcommand.
TABLE H-98 Argument for Subcommand sp update diags
|
Argument
|
Description
|
|
{-p | --path}
|
Points to the location of the new diagnostics.
|
Return Codes
TABLE H-99 lists the return codes for this subcommand.
TABLE H-99 Return Codes for Subcommand sp update diags
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_UnknownError
|
15
|
Miscellaneous error not captured by other errors.
|
| Sun Fire V20z and Sun Fire V40z Servers--Server Management Guide
|
817-5249-12
|
|
Copyright © 2004, Sun Microsystems, Inc. All Rights Reserved.