|C H A P T E R 5|
Overview of the XSCF Shell
This chapter describes how to use the XSCF Shell. The chapter also describes how to use commands and log in with an XSCF user account. It also explains command errors.
Performing certain XSCF commands on the XSCF Shell terminal can display the server status so that control and configuration information related to system operation can be viewed.
The XSCF commands are effectively used by users who have created user accounts for the XSCF Shell terminal but cannot use the XSCF Web.
The following XSCF commands can be used from the XSCF Shell prompt (XSCF>) displayed after login to XSCF.
There are nine user privilege types as described below. For details on setting the user privilege, see Chapter 2. For details on the operations available with each user privilege level, see Chapter 1 or the Administration Guide.
TABLE 5-1 outlines the XSCF Shell commands. For details on each command and user privileges, see the man page or the XSCF Reference Manual.
Moves a system board to another domain. Alternatively, it reserves a move to the system board. If the movement is reserved, the deletion is done after Oracle Solaris OS reboot of source domain, and the assignment to the new domain is done.
Displays the domain host ID, the hardware initial diagnostic level, information of enabled or disabled status on break signal sending, Host watchdog, automatic boot, and displays CPU operation mode, ethernet address (mac address).
|Note - In the M3000/M4000/M5000/M8000/M9000 servers, some of the commands are not available, depending on the model in use. For the support information of each command, see the man page or the XSCF Reference Manual.|
This section describes how to log in to XSCF. The user can log in to XSCF from an XSCF-LAN port using either SSH or telnet, or from the serial port.
Note the following before attempting to log in:
|Note - In this manual, the window of the XSCF Shell terminal is called the XSCF console.|
This section describes how to log in from a terminal connected to the serial port.
1. After the terminal is connected to the serial port, press the Enter key on the terminal.
2. Enter a user account and password when prompted by XSCF.
3. Enter XSCF commands at the shell prompt (XSCF>) that is displayed after login to XSCF.
The following is a login example:
This section describes how to log in to XSCF through an XSCF-LAN (SSH) connection.
1. Before logging in using SSH, check that the fingerprint is pre-stored. If you did not save the fingerprint, please connect to the serial port and use showssh(8) to make a memo of the fingerprint of the host public key.
2. From an SSH client, specify the IP address or host name of XSCF and the port number, if necessary (default port number 22), and use SSH connection via XSCF-LAN.
3. Enter a user account and password when prompted by XSCF.
4. The fingerprint of the host public key may be displayed with a request to confirm its authenticity. If it is authentic, enter "yes" as the response, since the XSCF is correct with confirming the fingerprint.
5. Enter XSCF commands at the shell prompt (XSCF>) that is displayed after log in to XSCF.
|Note - To set the password for an XSCF user account, use the password(8) command. The shownetwork(8) command can be used to display XSCF-LAN setting information and the current network connection status.|
The following is a login example:
[foo@phar foo]% ssh firstname.lastname@example.org The authenticity of host '192.168.0.2 (192.168.0.2)' can't be established. RSA key fingerprint is 03:4b:b4:b2:3d:4d:0c:24:03:ca:f1:63:f2:a7:f3:35. Are you sure you want to continue connecting ? [yes|no] : yes Warning: Permanently added '192.168.0.2' (RSA) to the list of known hosts. foo@phar's password:xxxxxx XSCF>
When the SSH connection is done using a user key, install the user public key in XSCF in advance. See Chapter 2 for instructions on how to install the user public key.
The following example shows a login using a user public key:
This section describes how to log in to XSCF via an XSCF-LAN (telnet) connection.
1. Enter the IP address or host name of XSCF and port number 23, and use telnet via XSCF-LAN.
2. Enter a user account and password from the XSCF console.
3. Enter XSCF commands at the shell prompt (XSCF>) that is displayed after you login to XSCF.
4. The following is a login example:
This section describes the typical XSCF Shell commands that can be used to display the server status, operate the server, and control the server. For details on the commands, see the man page or the XSCF Reference Manual. For XSCF setup commands, see Chapter 2.
The showenvironment(8) command displays the values of all sensors in the server. By finding out the intake temperature, humidity, voltage, and fan rotation speed in the server, the system administrator can check for errors in the system environment.
In addition, by knowing the power consumption and volume of air exhausted from the server, the plant administrator can identify the specific areas in the installation site where the energy consumption can be reduced.
These commands display status information indicated by the LEDs on devices and the operator panel of the server. Finding out information on device errors is helpful in component degradation and replacement. Also, the system administrator can use the commands to identify the target device among many devices.
The showconsolepath(8) command displays the operating status of the domain console. By finding out the users of domain consoles, the system administrator can notify the users before a user performs a server operation or server control.
The server has an architecture that performs fault management (FMA) for CPUs, memory, and the I/O system during Oracle Solaris OS operation. The system administrator can use the fmadm(8) command to display configuration and status information about individual FMA modules that detect faults, perform fault diagnoses, and resolve faults. The command can also list faulty and degraded resources. The fmstat(8) command displays the processing time and number of events for each FMA module. The fmdump(8) command displays detailed fault information so that system administrator can determine faulty resources.
The showdomainstatus(8) command displays the current operating status of a domain. The system administrator can find out the status of each domain from its power on time to its operation start time.
There are three types of resets: the system reset, the panic instruction, and the CPU reset. To reset a domain, the system administrator can perform the reset(8) command with one of these three types specified. Performing the poweron(8) or poweroff(8) command can turn power on or off to a constructed domain in the system configuration.
The system administrator can use the sendbreak(8) command to send a break signal to the Oracle Solaris OS.
This section describes the typical XSCF Shell commands used to display configuration information on components in the server, such as the number of CPUs and memory capacity, the XSCF network configuration, the time, and degradation information.
The showhardconf(8) command lists all the components mounted in the server and their status information. A problem component is indicated by a mark (*). The system administrator can check the component configurations and the numbers of different types of components.
The shownetwork(8) command displays the IP addresses, masks, and network connection information for the XSCF-LAN and ISN installed in the XSCF Unit. Also, the shownetwork(8) command displays the XSCF network connection status. By finding out the amount of data sent or received through a particular interface, the system administrator can check the LAN connection status and the management network load. The showhostname(8) command displays the current host name for the XSCF unit. The showroute(8) command displays routing environment such as destination IP addresses. The shownameserver(8) displays the DNS server. The system administrator can view the interface information required for the XSCF network. The showdscp(8) command displays the IP addresses assigned for DSCP usage. The showpacketfilters(8) command displays the IP packet filtering rules that are set in the XSCF network.
The showntp(8) command displays the NTP server configured with the server and the XSCF's own local clock informations. The showdate(8) command displays the system standard time (XSCF time). The system administrator can use the showdate(8) command to determine the reference time used in the server.
The system administrator can use the showstatus(8) command to list degraded components.
This section describes the typical XSCF Shell commands that manage resource assignment to domains and resource removal from domains, install devices, remove devices, replace devices, and enable or disable functions.
The cfgdevice(8) command displays the domain to which a DVD drive unit or tape drive unit is assigned. Also, the cfgdevice(8) command can be used only on M8000/M9000 servers. The showdevices(8) command displays the operating status of resources installed on a system board (XSB). The system administrator can use this command to determine the devices to be assigned to a domain and check whether the DR function can be used to connect or disconnect an XSB.
The console(8) command establishes a connection to the domain console. This command supports both interactive and read-only connections.
The showdcl(8) command displays the domain configuration information (DCL) specified for individual domains or LSBs that compose a domain, and the setdcl(8) command specifies the configuration. The system administrator refers to and specifies DCL when adding an XSB to a domain.
The showfru(8) command displays the locations of devices, such as system boards, mounted in the server and resource partition information, and the setupfru(8) command specifies these locations and this information. The system administrator can use the commands for effective use of resources.
The addfru(8) command is used to select a device, such as a CPU/Memory Board unit, I/O unit, fan unit, or PSU, to add it to the server, and the deletefru(8) and replacefru(8) commands are used to select and remove or replace, respectively, such a device mounted in the server. Each type of operation can be performed interactively with menus.
The showboards(8) command displays status information about a system board (XSB). The system administrator can use the command to find out whether a system board has been configured to a domain or unconfigured from it, and to find out whether this operation was successful. The addboard(8) command adds a system board to the domain, the deleteboard(8) command removes a system board, and the moveboard(8) command moves a system board.
|Note - In the M3000 server, the domain configuration cannot be changed.|
In a certain domain, the user may want to suppress the break signal or panic with host watchdog or disable the automatic boot function. The system administrator can use the showdomainmode(8) command to display the related function settings and the setdomainmode(8) command to suppress or disable one of these functions for a domain. Also, the showdomainmode(8) command displays a domain host ID and ethernet address (mac address).
This section describes the XSCF commands that fetch and display server operation logs, console logs, temperature histories, and error logs from XSCF log files which also configure the information for archiving XSCF logs to a host.
For details on error logs, see Appendix B.
The showlogs(8) command displays error logs, power logs, event logs, console logs, panic logs, IPL logs, and temperature/humidity logs. The system administrator can use the command to check the operating status of the server and the cause of any error in the system.
The showarchiving(8) and setarchiving(8) commands display and specify, respectively, the information required for saving XSCF log information to servers. The system administrator can use these commands to set up automatic, secure archiving of logs to a specified archive host.
This section describes the typical XSCF commands for user management and security management.
The showuser(8) command can be used to list XSCF user accounts or display information about a particular user account. The adduser(8) and deleteuser(8) commands add and delete user accounts. The enableuser(8) and disableuser(8) commands enable and disable, respectively, user accounts.
The password(8) and setprivilege(8) commands set passwords and user privileges, respectively, for user accounts. The showpasswordpolicy(8) and setpasswordpolicy(8) commands display and specify the validity of passwords and other password policy information.
The showlookup(8) and setlookup(8) commands display and specify information on whether an LDAP server should be used for looking up the authentication and the user privilege. The showldap(8) and setldap(8) commands display and specify LDAP client settings, which are used when retrieving data from an LDAP server. The showad(8) and setad(8) commands display and specify Active Directory client settings, which are used when retrieving user informations from an Active Directory server. The showldapssl(8) and setldapssl(8) commands display and specify LDAP/SSL client settings, which are used when retrieving user informations from an LDAP/SSL server.
The showaudit(8) and setaudit(8) commands display and specify information such as which events can be subject for auditing. The system administrator can use the viewaudit(8) command to display audit records (audit trail).
The showloginlockout(8) and setloginlockout(8) commands display and specify information on whether to refuse a user login for a certain period of time after multiple attempts to log in to that user account failed.
The showssh(8) and setssh(8) commands can be used to display and specify the information on whether or not to enable the SSH access when a user logs in to XSCF. These commands can be used in generating the host key, registering/deleting the user public key, setting the timeout period of XSCF Shell, and setting whether or not to permit the SSH access from domain to XSCF via DSCP.
The following XSCF Shell commands end the XSCF Shell and display version information. (Note)
|Note - The server provides many other commands. For details on these commands, see the man page or the XSCF Reference Manual.|
The exit(1) command ends the XSCF Shell.
The version(8) command displays the comprehensive firmware version (XCP version, see Note) of the XSCF firmware and POST/OpenBoot PROM firmware. The system administrator can display version information when upgrading firmware.
|Note - XCP: XSCF Control Package that includes the programs which control the hardware components making up a computer system.|
TABLE 5-2 lists the typical messages from each XSCF Shell command.
|Note - The error message depends on the command. Therefore, you will occasionally see more messages.|