| 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 subcommand 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 real-time clock (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.
|
|
MAC address
|
Retrieves the MAC address for the SP.
|
|
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 real-time clock (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 real-time clock (RTC).
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 real-time clock (RTC).
Format
sp set date DATE STRING
TABLE H-4 lists the argument for this subcommand.
TABLE H-4 Argument for Subcommand sp set date
|
Argument
|
Description
|
|
DATE STRING
|
Specifies the date and time on the service processor RTC. The date string is a Coordinated Universal Time (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 synchronized 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 Configuration 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
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 name server 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
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 name server, they print on separate lines.
|
|
{ -s | --searchdomain }
|
Displays the search domain(s). If there is more than one search domain, 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
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, or other) 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.
Administrators can view this information using this command. For a list of all possible events, refer to TABLE 3-4.
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 is returned.
|
|
{-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
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 host name 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
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
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 return codes 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
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
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
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 reinstall the platform OS or reset the SP through the subcommand sp reset to default-settings, you must reissue 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 reset 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 Locatelight 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-panel 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-panel and rear-panel identification lights). The possible states are blinking or off.
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-panel and rear-panel identification lights).
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 eventlog file configuration.
|
|
sp set logfile
|
Configures the eventlog file that is the destination of all Event Manager events and notices.
|
SP Get Logfile Subcommand
Description: Retrieves the event log file configuration.
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
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 might be considering for the SP.
|
|
sp get mac address
|
Retrieves the MAC address for the SP.
|
|
sp get port 80
|
Retrieves the last port 80 POST code 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 autoconfigure
|
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 to 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).
When you execute this command, the SP generates three new events, each with a different level of severity. To view these events, run the subcommand sp get events. Then retrieve the configuration settings for SNMP, SMTP, and log files and validate that the events reached the configured destinations.
SNMP
To configure destinations for SNMP traps, run the subcommand sp add snmp-destination. To view your current settings, run the subcommand sp get snmp-destinations. All SP events are translated into SNMP traps and are sent to all configured destinations.
SMTP
You can configure destinations for events as SMTP addresses. You must first run the subcommand sp set smtp server to configure your SMTP server and from address. Then run the subcommand sp update smtp subscriber to configure the destination addresses and formats to be used for different severity events. This command enables you to configure the format of the events that are delivered (long or short) and the recipient(s) of events of different severities.
All SP events are translated into alerts and are sent to all configured SMTP destinations according to the event severity (the subscribers). You can run the subcommands sp get smtp server and sp get smtp subscribers to view your current settings.
Log Files
All events that are generated on the SP are written to either a default or a user-specified log file if a mount point is configured. To add a mount point, run the subcommand sp add mount. You can then run the subcommand sp set logfile to configure the name and size of the target file on the mounted file system. To view your current settings, run the subcommands sp get mounts and sp get logfile.
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_RPCNotConnected
|
3
|
Unable to connect to the RPC server.
|
|
NWSE_NoMemory
|
8
|
Insufficient memory.
|
SP Get MAC Address Subcommand
Description: Retrieves the MAC address for the SP.
Format
sp get mac
Return Codes
TABLE H-42 lists the return codes for this subcommand.
TABLE H-42 Return Codes for Subcommand sp get mac
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_ServiceNotAvailable
|
24
|
Requested service is not available.
|
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. You can use this subcommand to debug platform-boot problems.
Format
sp get port80 {-m | --monitor}
TABLE H-43 lists the arguments for this subcommand.
TABLE H-43 Argument 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 and Sun Fire V40z Servers--User Guide.
See TABLE H-45 for a list of the Power On Self Test (POST) codes for the Phoenix BIOS.
See TABLE H-46 for a list of the boot block codes on Flash ROM.
Return Codes
TABLE H-44 lists the return codes for this subcommand.
TABLE H-44 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-45 lists the POST codes for the Phoenix BIOS.
TABLE H-45 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 512-KB 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 Upper Memory Block (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 on-board super I/O ports and IRQs
|
|
81
|
Late POST device initialization
|
|
82
|
Detect and install external RS-232 ports
|
|
83
|
Configure non-MCD IDE controllers
|
|
84
|
Detect and install external parallel ports
|
|
85
|
Initialize PC compatible PnP ISA devices
|
|
86
|
Reinitialize on-board 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 multiprocessor boards
|
|
95
|
Install CD-ROM for boot
|
|
96
|
Clear huge ES segment register
|
|
97
|
Fix up multiprocessor 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 keystroke
|
|
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 rate
|
|
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-46 lists the boot block codes in Flash ROM.
TABLE H-46 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 Multiprocessor
|
|
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 Autoconfigure Subcommand
Description: Copies the configuration settings from one service processor to another service processor.
You can also perform autoconfiguration from the operator panel to perform this same function. For more information, see Autoconfiguring the SP.
The command invokes a series of HTTPS requests for all of the configuration files from the source machine and then loads configuration data to the second SP. The uploaded files are copied to the local pstore file and the second SP is rebooted. While this operation is running, you cannot execute any other configuration changes.
By default, configuration sharing is disabled and you must enable it on the source machine.
After the command is executed, a message is displayed indicating that the SP will be rebooted. The SSH connection then terminates.
Format
sp autoconfigure {{ -s | --sp } SP_IP_OR_HOST [-H |--noheader]
TABLE H-47 lists the arguments for this subcommand.
TABLE H-47 Arguments for Subcommand sp autoconfigure
|
Argument
|
Description
|
|
{ -s | --sp }
|
The DNS host name or IP address of the machine from which to copy the configuration information.
|
|
[-H | --noheader]
|
Suppresses header output.
|
Return Codes
TABLE H-48 lists the return codes for this subcommand.
TABLE H-48 Return Codes for Subcommand sp autoconfigure
|
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.
|
|
NWSE_TimedOut
|
23
|
Operation timed out.
|
|
NWSE_ServiceNotAvailable
|
24
|
Requested service is not available.
|
SP Get Status Subcommand
Description: Returns the status of the overall system.
Format
sp get status
TABLE H-49 lists the arguments for this subcommand.
TABLE H-49 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-50 lists the return codes for this subcommand.
TABLE H-50 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 SP in a compressed tar file.
Format
sp get tdulog [{-f | --filename} FILENAME or STDOUT ]
[{-c | --cpuregs} CPU REGISTERS]
[{-p | --pciregs} PCI REGISTERS]
[{-r | --reset} RESET PLATFORM]
TABLE H-51 lists the arguments for this subcommand.
TABLE H-51 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 adds the .tar to the filename. If you do not provide a filename, tdulog creates a file named tdulog.tar in the current directory, if the current directory is NFS mounted. An NFS-mounted file share must be used to store the output file.
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.
|
|
{-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 CPU 0 is shown in TABLE H-52.
TABLE H-52 Sample Information for Subcommand sp get tdulog on CPU 0
|
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-53 lists the return codes for this subcommand.
TABLE H-53 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 might not have physical access to a machine.
Format
sp reboot [ {-f | --forced} ]
TABLE H-54 lists the argument for this command.
TABLE H-54 Argument for Subcommand sp reboot
|
Argument
|
Description
|
|
{-f | --forced}
|
Results in a hard power off.
|
Return Codes
TABLE H-55 lists the return codes for this command.
TABLE H-55 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.
A message is displayed every 20 seconds to indicate that the reboot will occur.
Format
sp reset to default-settings {-a | --all} {-c | --config}{-n | --network} {-s | --ssh} {-u | --users} {-W | --nowait}
TABLE H-56 lists the arguments for this command.
TABLE H-56 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. This option also includes events and IPMI settings.
|
|
{-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 on to 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 in to 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 reinstall the platform OS or reset the SP by running the subcommand sp reset to default-settings, you must reissue 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 reset to the default address).
|
Return Codes
TABLE H-57 list the return codes for this command.
TABLE H-57 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-58 manage the SP mount points.
TABLE H-58 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
sp add mount {-r | --remote} REMOTE_FILE_SYSTEM [{-l | --local} LOCAL_MOUNT_POINT] [{-u | --user} USERNAME] [{-p | --password} PASSWORD] [{-W | --nowait}]
TABLE H-59 lists the arguments for this subcommand.
TABLE H-59 Arguments for Subcommand sp add mount
|
Argument
|
Description
|
|
{-r | --remote}
|
Specifies the remote server and file system to use.
If the remote file system is exported over NFS, use the following format to specify it:
-r <server_name_ID>:<path>
If the remote file system is exported over CIFS (Windows network share), use the following format to specify it:
-r //<server_name>/<share_name>
User name and password options are appropriate only when mounting CIFS file systems. In these examples, Server_Name is the IP address or host name of the remote server.
The required format for remote NFS or SMB mounts is:
- NFS: server_name:/server_exported_mountpoint
- SMB: //server_name/windows_share_name
|
|
{-l | --local}
|
Optional. Specifies the local mount point. The only mount point supported is /mnt.
|
|
{-u | --user}
|
Specifies the Microsoft Windows account user name. If Windows domains are in force, you may need to specify the domain, as in the following example:
-u <File_Server_Domain>\<username>
|
|
{-p | --password}
|
Specifies the Microsoft Windows account password.
|
|
{-W | --nowait}
|
If --nowait is specified, there is no wait for asynchronous commands to complete.
|
|
Note - Several error messages might appear when executing an smb mount while mounting Microsoft Windows partitions. Check that the mount succeeded after the call by running the subcommand sp get mounts.
|
Return Codes
TABLE H-60 lists the return codes for this subcommand.
TABLE H-60 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 Subcommand
Description: Deletes a mount point.
Format
sp delete mount LOCAL MOUNT POINT [-q | --quiet]
TABLE H-61 lists the arguments for this subcommand.
TABLE H-61 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-62 lists the return codes for this subcommand.
TABLE H-62 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
sp get mounts [{-l | --local} MOUNTPOINT] [-H | --noheader] [{-D | --Delim <DELIMITER>}]
TABLE H-63 lists the arguments for this subcommand.
TABLE H-63 Arguments for Subcommand sp get mount
|
Argument
|
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-64 lists the return codes for this subcommand.
TABLE H-64 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-65 manage SMTP communication.
TABLE H-65 SP SMTP Subcommands
|
Subcommand
|
Description
|
|
sp get smtp server
|
Retrieves the SMTP server information.
|
|
sp set smtp server
|
Configures the SP SMTP client with the address for the remote SMTP server.
|
|
sp get smtp subscribers
|
Returns detailed information about one or all SMTP subscribers.
|
|
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
sp get smtp server [-H | --noheader] [{-D | --Delim <DELIMITER>}]
TABLE H-66 lists the arguments for this subcommand.
TABLE H-66 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-67 lists the return codes for this subcommand.
TABLE H-67 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
sp set smtp server [{-f | --from} FROM FIELD ] IP OR HOSTNAME OF SMTP SERVER
TABLE H-68 lists the arguments for this subcommand.
TABLE H-68 Arguments for Subcommand sp set smtp server
|
Argument
|
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 address is used as shown in this example: admin@10.10.30.55.
Return Codes
TABLE H-69 lists the return codes for this subcommand.
TABLE H-69 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
sp get smtp subscribers [{-n | --name} <NAME>] [-H | noheader] [{-D | --Delim <DELIMITER>}]
TABLE H-70 lists the arguments for this subcommand.
TABLE H-71 lists the default SMTP subscribers.
TABLE H-70 Arguments for Subcommand sp get smtp subscribers
|
Argument
|
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-71 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. Both types have a descriptive subject line.
The short email format is intended to be used with pagers and other wireless access devices with which message-size constraints might prevent reception of the long format message.
Return Codes
TABLE H-72 lists the return codes for this subcommand.
TABLE H-72 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 or other) was not found.
|
SP Update SMTP Subscriber Subcommand
Description: Updates the information for an existing SMTP subscriber.
Format
sp update smtp subscriber {-n | --name} NAME {-r | --recipients} ADDRESS LIST
TABLE H-73 lists the arguments for this subcommand.
TABLE H-74 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 specify only the -r option for an existing subscriber, the existing email address list is replaced with the new list specified in the command.
|
TABLE H-73 Arguments for Subcommand sp update smtp subscriber
|
Argument
|
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-74 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. Both types have a descriptive subject line.
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-75 lists the return codes for this command.
TABLE H-75 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-76 manage SNMP communications.
TABLE H-76 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 host name) to which the SP is configured to send.
|
|
sp get snmp proxy community
|
Returns the community name currently being used by the SP 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 address to which they are referred, and the community string to use while proxying.
|
|
sp get snmp community
|
Returns the community name currently being used by the service processor.
|
|
sp set snmp community
|
Sets the SNMP community string used by the service processor.
|
SP Add SNMP-Destination Subcommand
Description: Adds a single SNMP destination (either IP address or host name).
Format
sp add snmp-destination IP ADDRESS/HOSTNAME
TABLE H-77 lists the argument for this subcommand.
TABLE H-77 Argument for Subcommand sp add snmp-destination
|
Argument
|
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-78 lists the return codes for this subcommand.
TABLE H-78 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
sp delete snmp-destination { IP_ADDRESS/HOSTNAME | {-a | --all} [-q | --quiet]
TABLE H-79 lists the arguments for this subcommand.
TABLE H-79 Arguments for Subcommand sp delete snmp-destination
|
Argument
|
Description
|
|
IP ADDRESS/HOSTNAME
|
Specifies the IP address or host name 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-80 lists the return codes for this subcommand.
TABLE H-80 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
sp get snmp-destinations
Return Codes
TABLE H-81 lists the return codes for this subcommand.
TABLE H-81 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
sp get snmp proxy community
Return Codes
TABLE H-82 lists the return codes for this subcommand.
TABLE H-82 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
sp set snmp proxy community COMMUNITY STRING
TABLE H-83 lists the argument for this subcommand.
TABLE H-83 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 value is private. Otherwise, you can set it to any string.
Return Codes
TABLE H-84 lists the return codes for this subcommand.
TABLE H-84 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 Get SNMP Community Subcommand
Description: Returns the community name that is currently being used by the service processor.
Format
sp get snmp community
Return Codes
TABLE H-85 lists the return codes for this subcommand.
TABLE H-85 Return Codes for Subcommand sp get snmp community
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command completed successfully.
|
|
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 might or might not have been serviced by the server.
|
|
NWSE_RPCNotConnected
|
3
|
Unable to connect to the RPC server.
|
SP Set SNMP Community Subcommand
Description: Enables you to set the community name to be used by the service processor itself, as opposed to the proxy community string that is used between the service processor and the platform.
There are no restrictions on the length of the community string. Typical names are "private" and "public." The factory default name of the community string is "public," so if you run the command sp get snmp community before you set a value, public is returned. Set the value to any string without spaces.
Format
sp set snmp community COMMUNITY_STRING
Return Codes
TABLE H-86 lists the argument for this subcommand.
TABLE H-86 Argument for Subcommand sp set snmp community
|
Argument
|
Description
|
|
COMMUNITY STRING
|
Specifies the name of the community to configure.
|
TABLE H-87 lists the return codes for this subcommand.
TABLE H-87 Return Codes for Subcommand sp set snmp community
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command completed successfully.
|
|
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 might or might not have been serviced by the server.
|
|
NWSE_RPCNotConnected
|
3
|
Unable to connect to the RPC server.
|
SP SSH1 Subcommands
The subcommands in TABLE H-88 manage SSH1 protocol.
TABLE H-88 SP SSH1 Subcommands
|
Subcommand
|
Description
|
|
sp disable ssh1
|
Disables protocol version 1 accesses to sshd.
|
|
sp enable ssh1
|
Enables protocol version 1 accesses to sshd.
|
|
sp get ssh1
|
Retrieves the current state of the protocol version 1 activation.
|
SP Disable SSH1
Description: Disables older less secure protocol verison 1 accesses to the secure shell daemon, sshd.
|
Note - Protocol version 2 remains enabled.
|
Format
sp disable ssh1
Successful Output:
localhost # sp disable ssh1
SP Enable SSH1
Description: Enables protocol version 1 accesses to the secure shell daemon, sshd.
|
Note - Protocol version 2 remains enabled.
|
Format
sp enable ssh1
Successful Output:
localhost # sp enable ssh1
ssh protocol version 1 and version 2 accesses allowed
Restarting OpenBSD Secure Shell Server: SSHD
SP Get SSH1
Description: Retrieves the current status of the protocol level 1 activation.
|
Note - The status of SSH1 is set using SP Disable SSH1 and SP Enable SSH1 commands.
|
Format
sp get ssh1
Successful Output:
localhost # sp get ssh1
SSH protocol version 1 and version 2 accesses allowed
or
SSH protocol version 2 accesses allowed. Version 1 NOT allowed!
Table listing the return codes in the sp set snmp community subcommand and a description of each.
SP SSL Subcommands
The subcommands in TABLE H-89 manage SSL capabilities.
TABLE H-89 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 whether the Apache Web server is using factory-supplied files or user-supplied files.
|
|
sp set ssl
|
Enables you to use site SSL certificates in the SP environment.
|
SP Disable SSL-Required Subcommand
Description: Disables automatic redirect to secure HTTP (HTTPS) URLs. With SSL disabled, HTTP requests are serviced directly without redirecting to HTTPS. HTTPS requests continue to be secure.
Format
sp disable ssl-required
Return Codes
TABLE H-90 lists the return codes for this subcommand.
TABLE H-90 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 (HTTPS) 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
sp enable ssl-required
Return Codes
TABLE H-91 lists the return codes for this subcommand.
TABLE H-91 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 whether automatic redirect to secure HTTP (HTTPS) is required or optional, and whether Apache Web Server is using factory-supplied or user-supplied SSL certificate files.
Format
sp get ssl [{-H | noheader}] [{-D | --Delim <DELIMITER>}]
TABLE H-92 lists the arguments for this subcommand.
TABLE H-92 Arguments for Subcommand sp get ssl
|
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-93 lists the return codes for this subcommand.
TABLE H-93 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: Enables you to use site SSL certificates in the SP environment. This command enables 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
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-94 lists the arguments for this subcommand.
TABLE H-94 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-95 lists the return codes for this subcommand.
TABLE H-95 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-96 manage the SP flash.
TABLE H-96 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 diags
|
Updates the diagnostics to a newer version.
|
SP Update Flash All Subcommand
|
Note - Before using this command you must start the Java Update Server. For instructions on starting Java Update Server, see Updating the SP Base Package.
|
Description: Updates the entire SP flash image (kernel, base file system, and value-add) as part of a major SP software update.
This subcommand first verifies that the Java sp update program is on the specified remote server and that the correct version of the update server is running
Once verified, the subcommand sets the update flag to start the full flash update on the next reset of the SP. When the SP boots, it connects with the sp update program, downloads and installs the new flash image, and reboots the SP into normal operation mode. It also sets the server IP address and optional server port number in the environment variables.
Run the command sp -V from the SP to verify the version of the new flash image.
- If this command fails for the Value-Add image, run the subcommand sp update flash applications.
- If this command fails for the Base image, update the flash using the operator panel. For information about the operator panel, refer to the Sun Fire V20z and Sun Fire V40z Servers--User Guide.
|
Note - The subcommand sp update flash all does not update pstore data.
|
Format
sp update flash all { i | --serverip} <ipaddress xx.xx.xx.xx> [{ p | --port} <port#>] [{-r|--remote} REMOTE_VERSION ]
TABLE H-97 lists the arguments for this subcommand.
TABLE H-97 Arguments for Subcommand sp update flash all
|
Argument
|
Description
|
|
{-i | --serverip}
|
The IP address of the remote server on which the update server (Java application) is running. The update server also contains the flash images.
|
|
{-p | --port}
|
Optional. The port number on the remote server on which the Java sp update 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.
|
|
{-r | --remote}
|
Identifies the version to be used for the update. Specify a version (for example, v1.2.3.4) or select LATEST to use the latest version available on the update server.
|
Return Codes
TABLE H-98 lists the return codes for this subcommand.
TABLE H-98 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_NotFound
|
5
|
Requested version was not found.
|
|
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.
|
Downgrades
If you want to downgrade service processor versions, you must use the procedure below to avoid problems when the service processor attempts to boot.
1. Execute sp reset to default-settings --all.
2. After the SP reboots:
a. Create a new manager user by logging in as the user setup.
b. Execute sp update flash all.
3. After the SP reboots, execute sp reset to default-settings --all.
4. After the SP reboots, create a new manager user and update your configuration as needed. If you are performing this procedure on multiple machines, use the sp autoconfigure command from a preconfigured service processor.
If the sp update flash all command fails for the Value-Add image, use the sp update flash applications command. If this command fails for the Base image, update the flash using the operator panel. See Operator Panel and the Sun Fire V20z and Sun Fire V40z Servers--User Guide for information about using the operator panel.
SP Update Flash Applications Subcommand
Description: The SP file system is divided into two components: 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.
If the subcommand sp update flash applications fails and the Value-Add image is corrupted, you can use the similar command that is available in the SP Base image.
Format
sp update flash applications [{-f|--filename} FILE] [{-h|--help}] [{-i|--ipaddress} REMOTE_ADDRESS][{-p|--port} REMOTE_PORT] [{-r|--remote} REMOTE_VERSION]
TABLE H-99 lists the arguments for this subcommand.
TABLE H-99 Arguments for Subcommand sp update flash applications
|
Argument
|
Description
|
|
{-f | --filename}
|
Specifies the full path of the file.
|
|
{-i | --ipaddress}
|
The IP address of the server on which the update server (Java application) is running.
|
|
{-p | --port}
|
Optional. The port number on the remote server on which the Java sp update 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.
|
|
{-r | --remote}
|
Identifies the version to be used for the update. Specify a version (for example, v1.2.3.4) or select LATEST to use the latest version available on the update server.
|
Return Codes
TABLE H-100 lists the return codes for this subcommand.
TABLE H-100 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_ServiceNotAvailable
|
24
|
Requested service is not available.
|
|
NWSE_DeviceError
|
25
|
Unable to read or write to the device.
|
SP Update Diags Subcommand
Description: Updates the current version of diagnostics, if an update is 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
sp update diags {-p | --path} <PATH_TO_DIAGS_FOLDER>
TABLE H-101 lists the argument for this subcommand.
TABLE H-101 Argument for Subcommand sp update diags
|
Argument
|
Description
|
|
{-p | --path}
|
Points to the location of the new diagnostics.
|
Return Codes
TABLE H-102 lists the return codes for this subcommand.
TABLE H-102 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-17
|
|
Copyright © 2004-2007, Sun Microsystems, Inc. All Rights Reserved.