MyWebUniversity.com Home Page

This command may be used to set a field string to a new value. It replaces the FRU data found at index in the specified section with the supplied string. fru id is the digit ID of the FRU (see output of 'fru print'). section is a string which refers to FRU Inventory Information Storage Areas and may be refer to: c FRU Inventory Chassis Info Area b FRU Inventory Board Info Area p FRU Inventory Product Info Area index specifies the field number. Field numbering starts on the first 'english text' field type. For instance in the info area field '0' is and field '2' is ; see IPMI Plat- form Management FRU Information Storage Definition v1.0 R1.1 for field locations. string must be the same length as the string being replaced and must be 8-bit ASCI (0xCx). edit oem iana [] This command edits the data found in the mul- tirecord area. Support for OEM specific records is limited. firewall This command supports the firmware firewall capability. It may be used to add or remove security-based restric- tions on certain commands/command sub-functions or to list the current firmware firewall restrictions set on SunOS 5.10 Last change: 10 December 2008 17 Maintenance Commands ipmitool(1m) any commands. For each firmware firewall command listed below, parameters may be included to cause the command to be executed with increasing granularity on a specific LUN, for a specific NetFn, for a specific IPMI Command, and finally for a specific command's sub- function (see Appendix H in the IPMI 2.0 Specification for a listing of any sub-function numbers that may be associated with a particular command). Parameter syntax and dependencies are as follows: [] [ [ [] Note that if "netfn " is specified, then "lun " must also be specified; if "command " is specified, then "netfn " (and therefore "lun ") must also be specified, and so forth. "channel " is an optional and standalone parameter. If not specified, the requested operation will be per- formed on the current channel. Note that command sup- port may vary from channel to channel. Firmware firewall commands: info [] List firmware firewall information for the speci- fied LUN, NetFn, and Command (if supplied) on the current or specified channel. Listed information includes the support, configurable, and enabled bits for the specified command or commands. Some usage examples: info [] [] This command will list firmware firewall information for all NetFns for the specified LUN on either the current or the specified channel. info [] [ [] This command will print out all command information for a single LUN/NetFn pair. info [] [ [ [] info [] [ [ [] This command is used to enable commands for a given NetFn/LUN combination on the specified chan- nel. disable [] [force] This command is used to disable commands for a given NetFn/LUN combination on the specified chan- nel. Great care should be taken if using the "force" option so as not to disable the "Set Com- mand Enables" command. reset [] This command may be used to reset the firmware firewall back to a state where all commands and command sub-functions are enabled. i2c [] Sends an I^2C Master Write-Read command (if is supplied, it is written to the I^2C master first) to the device at address and displays bytes of response. Note: this command is not supported by all BMCs. The following command writes the values 0x2, 0x3, and 0x4, then attempts to read 5 bytes from the I^2C master at address 0xa: ipmitool i2c 0xa 5 0x2 0x3 0x4 isol info SunOS 5.10 Last change: 10 December 2008 19 Maintenance Commands ipmitool(1m) Retrieve information about the Intel IPMI v1.5 Serial-Over-LAN configuration. set Configure parameters for Intel IPMI v1.5 Serial-over-LAN. Valid parameters and values are: enabled true, false privilege-level user, operator, admin, oem bit-rate 9.6, 19.2, 38.4, 57.6, 115.2 activate Causes ipmitool to enter Intel IPMI v1.5 Serial Over LAN mode. An RMCP] connection is made to the BMC, the terminal is set to raw mode, and user input is sent to the serial console on the remote server. On exit, the the SOL payload mode is deac- tivated and the terminal is reset to its original settings. Special escape sequences are provided to control the SOL session: ~. Terminate connection ~^Z Suspend ipmitool on restart ~^X Suspend ipmitool, but don't restore tty ~B Send break twice ~~ Send the escape character by typing it ~? Print the supported escape sequences Note that escapes are only recognized immediately after newline. kontronoem SunOS 5.10 Last change: 10 December 2008 20 Maintenance Commands ipmitool(1m) OEM commands specific to Kontron devices. setsn Set FRU serial number. setmfgdate Set FRU manufacturing date. nextboot Select the next boot order on the Kontron CP6012. lan print [] Print the current configuration for the given channel. The default will print information on the first found LAN channel. set Set the given command and parameter on the given channel. Valid command/parameters are: ipaddr Set the IP address for this channel. netmask Set the netmask for this channel. macaddr Set the MAC address for this channel. defgw ipaddr Set the default gateway IP address. defgw macaddr Set the default gateway MAC address. bakgw ipaddr Set the backup gateway IP address. bakgw macaddr SunOS 5.10 Last change: 10 December 2008 21 Maintenance Commands ipmitool(1m) Set the backup gateway MAC address. password Set the null user password. snmp Set the SNMP community string. user Enable user access mode for userid 1 (issue the `user' command to display information about userids for a given channel). access Set LAN channel access mode. alert Enable or disable PEF alerting for this chan- nel. ipsrc Set the IP address source: none = unspecified static = manually configured static IP address dhcp = address obtained by BMC running DHCP bios = address loaded by BIOS or system software arp respond Set BMC generated ARP responses. arp generate Set BMC generated gratuitous ARPs. arp interval Set BMC generated gratuitous ARP interval. auth Set the valid authtypes for a given auth level. Levels: callback, user, operator, admin SunOS 5.10 Last change: 10 December 2008 22 Maintenance Commands ipmitool(1m) Types: none, md2, md5, password, oem cipherprivs Correlates cipher suite numbers with the max- imum privilege level that is allowed to use it. In this way, cipher suites can res- tricted to users with a given privilege level, so that, for example, administrators are required to use a stronger cipher suite than normal users. The format of privlist is as follows. Each character represents a privilege level and the character position identifies the cipher suite number. For example, the first charac- ter represents cipher suite 1 (cipher suite 0 is reserved), the second represents cipher suite 2, and so on. privlist must be 15 characters in length. Characters used in privlist and their associ- ated privilege levels are: X Cipher Suite Unused c CALBACK u USER o OPERATOR a ADMIN O OEM So, to set the maximum privilege for cipher suite 1 to USER and suite 2 to ADMIN, issue the following command: ipmitool -I interface lan set channel cipherprivs uaX alert print [] [] Print alert information for the specified channel and destination. The default will print all alerts for all alert destinations on the first found LAN channel. alert set Set an alert on the given LAN channel and destina- tion. Alert Destinations are listed via the 'lan alert print' command. Valid command/parameters SunOS 5.10 Last change: 10 December 2008 23 Maintenance Commands ipmitool(1m) are: ipaddr Set alert IP address. macaddr Set alert MAC address. gateway Set the channel gateway to use for alerts. ack Set Alert Acknowledge on or off. type Set the destination type as PET or OEM. time Set ack timeout or unack retry interval. retry Set the number of alert retries. stats get [] Retrieve information about the IP connections on the specified channel. The default will retrieve statistics on the first found LAN channel. stats clear [] Clear all IP/UDP/RMCP Statistics to 0 on the specified channel. The default will clear statis- tics on the first found LAN channel. pef info This command will query the BMC and print informa- tion about the PEF supported features. status This command prints the current PEF status (the SunOS 5.10 Last change: 10 December 2008 24 Maintenance Commands ipmitool(1m) last SEL entry processed by the BMC, etc). policy This command lists the PEF policy table entries. Each policy entry describes an alert destination. A policy set is a collection of table entries. PEF alert actions reference policy sets. list This command lists the PEF table entries. Each PEF entry relates a sensor event to an action. When PEF is active, each platform event causes the BMC to scan this table for entries matching the event, and possible actions to be taken. Actions are performed in priority order (higher critical- ity first). picmg Run a PICMG/ATA extended command. Get PICMG properties may be used to obtain and print Extension major version information, PICMG identifier, FRU Device ID and Max FRU Device ID. addrinfo Get address information. This command may return information on the Hardware address, IPMB-0 Address, FRU ID, Site/Entity ID, and Site/Entity Type. frucontrol Set various control options: 0x00 - Cold Reset 0x01 - Warm Reset 0x02 - Graceful Reboot 0x03 - Issue Diagnostic Interrupt 0x04 - Quiesce [AMC only] 0x05-0xF - Cold Reset activate Activate the specified FRU. SunOS 5.10 Last change: 10 December 2008 25 Maintenance Commands ipmitool(1m) deactivate Deactivate the specified FRU. policy get Get FRU activation policy. policy set Set FRU activation policy. lockmask is 1 or 0 to indicate action on the deactivation or activation locked bit respectively. lock is 1 or 0 to set/clear locked bit. portstate setgetallgetgrantedgetdenied Get or set various port states. See usage for parameter details. power Alias for the "chassis power" commands. See the "chassis power" commands for usage information. raw [] This will allow you to execute raw IPMI commands. For example to query the POH counter with a raw command: ipmitool -v -I bmc raw 0x0 0xf RAW REQ (netfn=0x0 cmd=0xf datalen=0) RAW RSP (5 bytes) 3c 72 0c 00 00 sdr info This command will query the BMC for Sensor Data Record (SDR) Repository information. type [list] Displays sensor data records only for the sensor type (e.g. `temperature', `voltage', etc.) chosen. A list of all supported sensor types may be displayed if the `list' keyword is used instead of a sensor type. Note that the sensor type is not case sensitive. Also note that there may be a large delay before any information is displayed, because ipmitool does a full scan of all sensor SunOS 5.10 Last change: 10 December 2008 26 Maintenance Commands ipmitool(1m) records and builds a list of just those that meet the type criterion given. listelist [allfullcompacteventmclocfrugeneric] This command will read the Sensor Data Records (SDR) and extract sensor information of a given type, then query each sensor and print its name, reading, and status. The `elist' form of this command prints additional information about each data record (e.g. threshold type, sensor number, sensor entity). Valid types are: all All SDR records (Sensor and Locator) full Full Sensor Record compact Compact Sensor Record event Event-Only Sensor Record mcloc Management Controller Locator Record fru FRU Locator Record generic Generic SDR records entity [.] Displays all sensors associated with an entity. Get a list of valid entity ids on the target sys- tem by issuing the `sdr list' command with the verbose option (`-v'). A list of all entity ids can be found in the IPMI specifications. dump SunOS 5.10 Last change: 10 December 2008 27 Maintenance Commands ipmitool(1m) Dumps raw SDR data to a file. This file may also be used as the sdr cache, supplied to ipmitool with the `-S' option, dramatically speeding up the `sdr' and `sel elist' commands. fill sensors Create the SDR Repository for the current confi- guration. Will perform a 'Clear SDR Repository' command so be careful. fill file Fill the SDR Repository using records stored in a binary data file. Will perform a 'Clear SDR Repo- sitory' command so be careful. sel NOTE: System Event Log (SEL) entry-times are displayed as `Pre-Init Time-stamp' if the SEL clock needs to be set. Ensure that the SEL clock is accurate by invoking the `sel time get' and `sel time set ' commands. info This command will query the BMC for information about the System Event Log (SEL) and its contents. clear This command will clear the contents of the SEL. It cannot be undone so be careful. listelist When this command is invoked without arguments, the entire contents of the SEL are displayed. In addition to the information displayed by the `list' command, the `elist' command will cross- reference SEL records with SDR records to produce descriptive event output. first Displays the first count (least-recent) entries in the SEL. If count is zero, all entries are displayed. last SunOS 5.10 Last change: 10 December 2008 28 Maintenance Commands ipmitool(1m) Displays the last count (most-recent) entries in the SEL. If count is zero, all entries are displayed. delete ... Delete one or more SEL event records. add Read event entries from a file and add them to the SEL. New SEL entries area added onto the SEL after the last record in the SEL. Record added is of type 2 and is automatically timestamped. get Print information on the specified SEL Record entry. save Save SEL records to a text file that can be fed back into the `event file' ipmitool command. This can be useful for testing Event generation by building an appropriate Platform Event Message file based on existing events. Please see the available help for the 'event file ...' command for a description of the format of this file. writeraw Save SEL records to a file in raw, binary format. This file can be fed back to the `sel readraw' ipmitool command for viewing. readraw Read and display SEL records from a binary file. Such a file can be created using the `sel wri- teraw' ipmitool command. time get Displays the SEL clock's current time. set Sets the SEL clock. Future SEL entries will use the time set by this command. is of the form "M/D/Y H:M:S". Note that hours are in 24-hour form. It is recommended that the SEL be cleared before setting the time. sensor list Lists sensors and thresholds in a wide table for- mat. get ... [id] Prints information for sensors specified by name. thresh This allows you to set a particular sensor thres- hold value. The sensor is specified by name. Valid thresholds are: unr Upper Non-Recoverable ucr Upper Critical unc Upper Non-Critical lnc Lower Non-Critical lcr Lower Critical lnr Lower Non-Recoverable session info Get information about the specified session(s). You may identify sessions by their id, by their handle number, by their active status, or by using the keyword `all' to specify all sessions. sol info [] Retrieve information about the Serial-Over-LAN configuration on the specified channel. If no channel is given, it will display SOL configura- tion data for the currently used channel. payload Enable or disable SOL payload for the user on the specified channel. SunOS 5.10 Last change: 10 December 2008 30 Maintenance Commands ipmitool(1m) set [channel] Configure parameters for Serial Over Lan. If no channel is given, it will display SOL configura- tion data for the currently used channel. Confi- guration parameter updates are automatically guarded with the updates to the set-in-progress parameter. Valid parameters and values are: set-in-progress set-complete set-in-progress commit-write enabled true false force-encryption true false force-authentication true false privilege-level user operator admin oem character-accumulate-level Decimal number given in 5-millisecond incre- ments character-send-threshold Decimal number retry-count Decimal number. 0 indicates no retries after packet is transmitted. retry-interval Decimal number in 10 millisend increments. 0 indicates that retries should be sent back to back. non-volatile-bit-rate serial, 19.2, 38.4, 57.6, 115.2. Setting this value to serial indicates that the BMC should use the setting used by the IPMI over serial channel. volatile-bit-rate serial, 19.2, 38.4, 57.6, 115.2. Setting this value to serial indiates that the BMC should use the setting used by the IPMI over SunOS 5.10 Last change: 10 December 2008 31 Maintenance Commands ipmitool(1m) serial channel. activate [usesolkeepalive nokeepalive] Causes ipmitool to enter Serial Over LAN mode, and is only available when using the lanplus inter- face. An RMCP] connection is made to the BMC, the terminal is set to raw mode, and user input is sent to the serial console on the remote server. On exit,the the SOL payload mode is deactivated and the terminal is reset to its original set- tings. Special escape sequences are provided to control the SOL session: ~. Terminate connection ~^Z Suspend ipmitool restart ~^X Suspend ipmitool, but don't restore tty on ~B Send break ~~ Send the escape character by typing it twice ~? Print the supported escape sequences Note that escapes are only recognized immediately after newline. deactivate Deactivates Serial Over LAN mode on the BMC. Exiting Serial Over LAN mode should automatically cause this command to be sent to the BMC, but in the case of an unintentional exit from SOL mode, this command may be necessary to reset the state of the BMC. spd [] [] This command may be used to read SPD (Serial Presence Detect) data using the I2C Master Write-Read IPMI com- mand. sunoem Sun OEM-specific IPMI commands. Support for these com- mands depends heavily on the Sun platform targeted. SunOS 5.10 Last change: 10 December 2008 32 Maintenance Commands ipmitool(1m) Please consult your Sun Hardware Reference Guide for information on Sun OEM-specific IPMI functionality to determine if the following commands are supported on your desired platform. fan speed <0-100> Sets the system fan speed (in units of PWM duty cycle) sshkey Administer SH keys for service processor users. set Sets the SH key for the given userid to the key found in the given file. (A list of users may be obtained with the 'user list' command). del Delete the SH key for the given userid. led Manipulate the settings for LEDs found via the `sdr elist generic' command. Once the sensor ID of the LED is found (the `elist' command displayed the sensor ID), it may be used in the following subcommands. When an LED type is required, it can be one of the following values: `OK2RM' (OK to Remove), `SERVICE' (Service Required), `ACT' (Activity), or `LOCATE' (Locate). When an LED mode is required, it can be one of the following values: `OF' (Off), `ON' (Steady On), `STANDBY' (100ms ON, 2900ms OF blink rate), `SLOW' (1HZ blink rate), or `FAST' (4HZ blink rate). get [] Read the status of the LED with the given . If is the special keyword `all', then the status of all LEDs will be displayed. The optional parameter, , further restricts the output to LEDs of the given type. set [] SunOS 5.10 Last change: 10 December 2008 33 Maintenance Commands ipmitool(1m) Sets the mode of the LED with the given (and optionally the given type ) to the given . If is the special keyword `all', then the status of all LEDs will be set (optionally qualified by the given type ). user summary Displays a summary of userid information, includ- ing maximum number of userids, the number of enabled users, and the number of fixed names defined. list Displays a list of user information for all defined userids. set name Sets the username associated with the given userid. password [] Sets the password for the given userid. If no password is given, the password is cleared (set to the NUL password). Be careful when removing passwords from administrator-level accounts. disable Disables access to the BMC by the given userid. enable Enables access to the BMC by the given userid. priv [] Set user privilege level on the specified channel. If the channel is not specified, the current chan- nel will be used. test <1620> [] SunOS 5.10 Last change: 10 December 2008 34 Maintenance Commands ipmitool(1m) Determine whether a password has been stored as 16 or 20 bytes. NOTE: Sun systems, such as the v20z and v40z, maintain the LAN interface on channel 1. To determine on which channel the LAN interface is located, issue the `channel info chan- nel' command. BMC INTERFACE The ipmitool bmc interface utilizes the bmc device driver. In order to force ipmitool to make use of the device inter- face you can specify it on the command line: ipmitool -I bmc LAN INTERFACE The ipmitool lan interface communicates with a remote BMC over an Ethernet LAN connection using UDP over IPv4. UDP datagrams are formatted to contain IPMI request/response messages with IPMI session headers and RMCP headers. IPMI-over-LAN uses version 1 of the Remote Management Con- trol Protocol (RMCP) to support pre-OS and OS-absent manage- ment. RMCP is a request-response protocol delivered using UDP datagrams to port 623. The LAN interface is an authenticated multi-session connec- tion; messages delivered to the BMC can (and should) be authenticate with a challenge/response protocol with either straight password/key or MD5 message-digest. ipmitool will attempt to connect with administrator privilege level as this is required to perform chassis power func- tions. You can tell ipmitool to use the lan interface with the -I option: ipmitool -I lan -H [-f passwordfile] A hostname must be given on the command line in order to use the lan interface with 'ipmitool'. The passwordfile is optional but, if present, should contain the password to be used for authentication. If no password is given, ipmitool will attempt to connect without authentication. If passwordfile is present and non-empty ipmitool will attempt to authenticate with an MD5 message-digest if MD5 is supported by the BMC. If MD5 is not supported by the BMC, straight password/key authentication will be attempted. SunOS 5.10 Last change: 10 December 2008 35 Maintenance Commands ipmitool(1m) LANPLUS INTERFACE Like the lan interface, the lanplus interface communicates with the BMC over an Ethernet LAN connection using UDP over IPv4. The difference is that the lanplus interface uses the RMCP] protocol as described in the IPMI v2.0 specification. RMCP] allows for improved authentication and data integrity checks, as well as encryption and the ability to carry mul- tiple types of payloads. Generic Serial-over-LAN support requires RMCP], so the ipmitool sol activate command requires the use of the lanplus interface. Establishing a RMCP] session uses RAKP (Remote Authenticated Key-Exchange Protocol), which enables the negotiation of many options. ipmitool does not yet allow the user to specify values for all the options, defaulting to the most obvious settings for those settings marked as required in the v2.0 specification. Authentication and integrity HMACs use the SHA-1 algorithm, and encryption is performed with AES, in CBC mode, at 128-bits of strength. Role-level logins are not supported. ipmitool must be configured with the appropriate option for the lanplus interface to be avail- able, as it is not enabled by default. This interface currently requires the OpenSL library. You can tell ipmitool to use the lanplus interface with the -I option: ipmitool -I lanplus -H [-U username] [-f passwordfile] The options available for the lanplus interface are identi- cal to those available for the lan interface. EXIT STATUS Upon successful completion, ipmitool returns 0. On failure, 1 is returned. EXAMPLES Example 1 : Listing remote sensors: > ipmitool -I lan -H 1.2.3.4 -f passfile sdr list Baseboard 1.25V 1.24 Volts ok Baseboard 2.5V 2.49 Volts ok Baseboard 3.3V 3.32 Volts ok Example 2: Displaying status of a remote sensor: > ipmitool -I lan -H 1.2.3.4 -f passfile sensor get "Baseboard 1.25V" SunOS 5.10 Last change: 10 December 2008 36 Maintenance Commands ipmitool(1m) Locating sensor record... Sensor ID : Baseboard 1.25V (0x10) Sensor Type (Analog) : Voltage Sensor Reading : 1.245 (]/- 0.039) Volts Status : ok Lower Non-Recoverable : na Lower Critical : 1.078 Lower Non-Critical : 1.107 Upper Non-Critical : 1.382 Upper Critical : 1.431 Upper Non-Recoverable : na Example 3: Displaying the power status of a remote chassis: > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power status Chassis Power is on Example 4: Controlling the power on a remote chassis: > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power on Chassis Power Control: Up/On FILES /platform/i86pc/kernel/drv/bmc 32-bit ELF kernel module for the bmc driver. /platform/i86pc/kernel/drv/amd64/bmc 64-bit ELF kernel module for the bmc driver. /dev/bmc Character device node used to communicate with the bmc driver. ATRIBUTES See attributes(5) for descriptions of the following attri- butes: SunOS 5.10 Last change: 10 December 2008 37 Maintenance Commands ipmitool(1m) ATRIBUTE TYPE ATRIBUTE VALUE Availability SUNWipmi Interface Stability Volatile SEE ALSO attributes(5) IPMI Specifications http:/www.intel.com/design/servers/ipmi/spec.htm NOTES IPMI V1.5 and, at the time of writing, IPMI V2.X only sup- port IPv4. There is no requirement for a BMC to use the same IP address as its host system. In an IPv6 environment the host system can have an IPv6 address and 'ipmitool' can be used to assign an IPv4 address to the BMC. SunOS 5.10 Last change: 10 December 2008 38