Back to Contents Page

Using the iDRAC SM-CLP Command Line Interface

Integrated Dell™ Remote Access Controller Firmware Version 1.2
User Guide

  System Management With SM-CLP

  iDRAC SM-CLP Support

  SM-CLP Features

  Navigating the MAP Address Space

  Using the Show Verb

  iDRAC SM-CLP Examples

  Using Serial Over LAN (SOL) With Telnet or SSH


This section provides information about the Server Management Workgroup (SMWG) Server Management-Command Line Protocol (SM-CLP) that is incorporated in the iDRAC.

NOTE: This section assumes that you are familiar with the Systems Management Architecture for Server Hardware (SMASH) Initiative and the SMWG SM-CLP specifications. For more information on these specifications, see the Distributed Management Task Force (DMTF) website at www.dmtf.org.

The iDRAC SM-CLP is a protocol driven by the DMTF and SMWG to provide standards for systems management CLI implementations. Many efforts are driven by a defined SMASH architecture that is targeted as a foundation for more standardized systems management set of components. The SMWG SM-CLP is a subcomponent of the overall SMASH efforts driven by DMTF.

SM-CLP provides a subset of the functionality provided by the local RACADM command line interface, but with a different access path. SM-CLP executes within the iDRAC, while RACADM executes on the managed server. Also, RACADM is a Dell proprietary interface, where SM-CLP is an industry standard interface. See RACADM and SM-CLP Equivalencies for a mapping of the RACADM and SM-CLP commands.


System Management With SM-CLP

The iDRAC SM-CLP enables you to manage the following system features from a command line or script:


iDRAC SM-CLP Support

SM-CLP is hosted from the iDRAC firmware and supports telnet and SSH connections. The iDRAC SM-CLP interface is based on the SM-CLP Specification Version 1.0 provided by the DMTF organization.

The following sections provide an overview of the SM-CLP feature that is hosted from the iDRAC.


SM-CLP Features

The SM-CLP specification provides a common set of standard SM-CLP verbs that can be used for simple systems management through the CLI.

SM-CLP promotes the concept of verbs and targets to provide system configuration capabilities through the CLI. The verb indicates the operation to perform and the target determines the entity (or object) that runs the operation.

The following is the syntax of the SM-CLP command line:

<verb> [<options>] [<target>] [<properties>]

Table 11-1 provides a list of the verbs the iDRAC CLI supports, the syntax of each command, and a list of the options the verb supports.

Table 11-1. Supported SM-CLP CLI Verbs 

Verb

Description

Options

cd

Navigates through the managed system address space using the shell.

Syntax:

cd [options] [target]

–default, –examine, –help, –output, –version

delete

Deletes an object instance.

Syntax:

delete [options] target

–examine, –help, –output, –version

dump

Moves a binary image from the MAP to a URI.

dump -destination <URI> [options] [target]

–destination, –examine, –help, –output, –version

exit

Exits from the SM-CLP shell session.

Syntax:

exit [options]

–help, –output, –version

help

Displays help for SM-CLP commands.

help

-examine, -help, -output, -version

load

Moves a binary image to the MAP from a URI.

Syntax:

load -source <URI> [options] [target]

–examine, –help, –output, –source, –version

reset

Resets the target.

Syntax:

reset [options] [target]

–examine, –help, –output, –version

set

Sets the properties of a target

Syntax:

set [options] [target] <property name>=<value>

–examine, –help, –output, –version

show

Displays the target properties, verbs, and subtargets.

Syntax:

show [options] [target] <property name>=<value>

-all, -default, –display, –examine, –help, –level, –output, –version

start

Starts a target.

Syntax:

start [options] [target]

–examine, –force, –help, –output, –version

stop

Shuts down a target.

Syntax:

stop [options] [target]

–examine, –force, –help, –output, –state, –version, –wait

version

Displays the version attributes of a target.

Syntax:

version [options]

–examine, –help, –output, –version

Table 11-2 describes the SM-CLP options. Some options have abbreviated forms, as shown in the table.

Table 11-2. Supported SM-CLP Options 

SM-CLP Option

Description

–all, –a

Instructs the verb to perform all possible functions.

-destination

Specifies the location to store an image in the dump command.

Syntax:

-destination <URI>

-display, -d

Filters the command output.

Syntax:

-display <properties | targets | verbs>[, <properties | targets | verbs>]*

-examine, -x

Instructs the command processor to validate the command syntax without executing the command.

–help, –h

Displays help for the verb.

–level, -l

Instructs the verb to operate on targets at additional levels beneath the specified target.

Syntax:

-level <n | all>

–output, –o

Specifies the format for the output.

Syntax:

-output <text | clpcsv | clpxml>

-source

Specifies the location of an image in a load command.

Syntax:

-source <URI>

–version, –v

Displays the SMASH-CLP version number.


Navigating the MAP Address Space

NOTE: The slash (/) and backslash (\) are interchangeable in SM-CLP address paths. However, a backslash at the end of a command line continues the command on the next line and is ignored when the command is parsed.

Objects that can be managed with SM-CLP are represented by targets arranged in a hierarchical space called the Manageability Access Point (MAP) address space. An address path specifies the path from the root of the address space to an object in the address space.

The root target is represented by a slash (/) or a backslash (\). It is the default starting point when you log in to the iDRAC. Navigate down from the root using the cd verb. For example to navigate to the third record in the System Event Log (SEL), enter the following command:

->cd /system1/sp1/logs1/record3

Enter the cd verb with no target to find your current location in the address space. The .. and . abbreviations work as they do in Windows and Linux: .. refers to the parent level and . refers to the current level.

Targets

Table 11-3 provides a list of targets available through the SM-CLP.

Table 11-3. SM-CLP Targets

Target

Definition

/system1/

The managed system target.

/system1/sp1

The service processor.

/system1/sol1

Serial over LAN target.

/system1/sp1/account1 through /system1/sp1/account16

The sixteen local iDRAC user accounts. account1 is the root account.

/system1/sp1/enetport1

The iDRAC NIC MAC address.

/system1/sp1/enetport1/lanendpt1/
ipendpt1

The iDRAC IP, gateway, and netmask settings.

/system1/sp1/enetport1/lanendpt1/
ipendpt1/dnsendpt1

The iDRAC DNS server settings.

/system1/sp1/group1 through /system1/sp1/group5

The Active Directory standard schema groups.

/system1/sp1/logs1

The log collections target.

/system1/sp1/logs1/record1

An individual SEL record instance on the managed system.

/system1/sp1/logs1/records

The SEL target on the managed system.

/system1/sp1/oemdell_racsecurity1

Storage for parameters used to generate a Certificate Signing Request.

/system1/sp1/oemdell_ssl1

SSL certificate request state.

/system1/sp1/oemdell_vmservice1

The virtual media configuration and state.


Using the Show Verb

To learn more about a target use the show verb. This verb displays the target's properties, sub-targets, and a list of the SM-CLP verbs that are allowed at that location.

Using the -display Option

The show –display option allows you to limit the output of the command to one or more of properties, targets, and verbs. For example, to display just the properties and targets at the current location, use the following command:

show -d properties,targets /system1/sp1/account1

To list only certain properties, qualify them, as in the following command:

show -d properties=(userid,username) /system1/sp1/account1

If you only want to show one property, you can omit the parentheses.

Using the -level Option

The show -level option executes show over additional levels beneath the specified target. For example, if you want to see the username and userid properties of the account1 through account16 targets beneath /system1/sp1, you could enter the following command:

show -l 1 -d properties=(userid,username) /system1/sp1/account*

To see all targets and properties in the address space, use the -l all option, as in the following command:

show -l all -d properties /

Using the -output Option

The -output option specifies one of four formats for the output of SM-CLP verbs: text, clpcsv, keyword, and clpxml.

The default format is text, and is the most readable output. The clpcsv format is a comma-separated values format suitable for loading into a spreadsheet program. The keyword format outputs information as a list of keyword=value pairs one per line. The clpxml format is an XML document containing a response XML element. The DMTF has specified the clpcsv and clpxml formats and their specifications can be found on the DMTF website at www.dmtf.org.

The following example shows how to output the contents of the SEL in XML:

show -l all -output format=clpxml /system1/sp1/logs1


iDRAC SM-CLP Examples

The following subsections provide examples for using the SM-CLP to perform the following operations:

For information on the use of the iDRAC SM-CLP interface, see iDRAC SMCLP Property Database.

Server Power Management

Table 11-4 provides examples of using SM-CLP to perform power management operations on a managed server.

Table 11-4. Server Power Management Operations 

Operation

Syntax

Logging into the iDRAC using the SSH interface

>ssh 192.168.0.120
>login: root
>password:

Power down the server

->stop /system1
system1 has been stopped successfully

Power up the server from a powered-off state

->start /system1
system1 has been started successfully

Reboot the server

->reset /system1
system1 has been reset successfully

SEL Management

Table 11-5 provides examples of using the SM-CLP to perform SEL-related operations on the managed system.

Table 11-5. SEL Management Operations 

Operation

Syntax

Viewing the SEL

->show /system1/sp1/logs1

Targets:
record1
record2
record3
record4
record5

Properties:
Description=IPMI SEL
MaxNumberOfRecords=512
CurrentNumberOfRecords=5

Verbs:
cd
delete
exit
help
show
version

Viewing the SEL record

->show /system1/sp1/logs1/record4
ufip=/system1/sp1/logs1/log1/record4

Properties:
Caption=Not defined
Description=Backplane Drive 0: drive slot sensor for Backplane, drive presence was asserted
ElementName=Not Supported
LogCreationClassName=CIM_RecordLog
LogName=IPMI SEL
CreationClassName=CIM_LogRecord
RecordID=4
MessageTimeStamp=16:37:10,January 13,2007

Verbs:
cd
exit
help
show
version

Clearing the SEL

->delete /system1/sp1/logs1
All records deleted successfully

MAP Target Navigation

Table 11-6 provides examples of using the cd verb to navigate the MAP. In all examples, the initial default target is assumed to be /.

Table 11-6. Map Target Navigation Operations 

Operation

Syntax

Navigate to the system target and reboot

->cd system1
->reset

NOTE: The current default target is /.

Navigate to the SEL target and display the log records

->cd system1
->cd sp1
->cd logs1
->show

->cd system1/sp1/logs1
->show

Display current target

->cd .

Move up one level

->cd ..

Exiting the shell

->exit

Setting the iDRAC IP Address, Subnet Mask, and Gateway Address

Using SM-CLP to update the iDRAC network properties is a two-part process:

  1. Set new values for the NIC properties at location /system1/sp1/enetport1/lanendpt1/ipendpt1:

  2. Commit the new values by setting the committed property to 1.

Whenever the commit property has the value of 1, the current settings of the properties are active. When you change any of the properties, the commit property is reset to 0 to indicate that the values have not been committed.

NOTE: The commit property only affects the properties at the /system1/sp1/enetport1/lanendpt1/ipendpt1 MAP location. All other SM-CLP commands take effect immediately.
NOTE: If you use local RACADM to set the iDRAC network properties, your changes take affect immediately because local RACADM does not depend upon a network connection.

When you commit the changes, the new network settings take effect, which causes your telnet or ssh session to be terminated. By introducing the commit step, you can delay the termination of your session until you have completed all of your SM-CLP commands.

Table 11-7 provides examples of setting the iDRAC properties using SM-CLP.

Table 11-7. Setting iDRAC Networking Properties with SM-CLP

Operation

Syntax

Navigate to the iDRAC NIC properties location

->cd /system1/sp1/enetport1/lanendpt1/ipendpt1

Set the new IP address

->set ipaddress=10.10.10.10

Set the subnet mask

->set subnetmask=255.255.255.255

Turn on the DHCP flag

->set oemdell_usedhcp=1

Enable the NIC

->set oemdell_nicenable=1

Commit the changes

->set committed=1

Updating the iDRAC Firmware Using SM-CLP

To update the iDRAC firmware using SM-CLP, you must know the TFTP URI for the Dell update package.

Follow these steps to update the firmware using SM-CLP:

  1. Log in to the iDRAC using telnet or SSH.

  2. Check the current firmware version by entering the following command:

version

  1. Enter the following command:

load -source tftp://<tftp-server>/<update-path> /system1/sp1

where <tftp-server> is the DNS name or IP address of your TFTP server and <update-path> is the path to the update package on the TFTP server.

Your telnet or SSH session will be terminated. You may need to wait several minutes for the firmware update to complete.

  1. To verify that the new firmware was written, start a new telnet or SSH session and re-enter the version command again.


Using Serial Over LAN (SOL) With Telnet or SSH

Use a Telnet or SSH console on your management station to connect to the iDRAC and then redirect the serial port of the managed server into your console. This feature is an alternative to IPMI SOL, which requires a utility such as solproxy to translate the serial stream to and from network packets. The iDRAC SOL implementation eliminates the need for an additional utility because the serial to network translation happens within the iDRAC.

The Telnet or SSH console that you use should be able to interpret and respond to the data arriving from the managed server's serial port. The serial port usually attaches to a shell that emulates an ANSI- or VT100- terminal.

Using Telnet, you connect to the IPMI LAN SOL port—port 2100. The serial console is automatically redirected to your Telnet console.

With SSH or Telnet, you connect to the iDRAC the same way you connect to SM-CLP. The SOL redirection can then be started from the /system1/sol1 target.

See Installing Telnet or SSH Clients for more information about using Telnet and SSH clients with iDRAC.

Using SOL Over Telnet With HyperTerminal on Microsoft Windows

  1. Select Start® All Programs® Accessories® Communications® HyperTerminal.

  2. Enter a name for the connection, choose an Icon, and click OK.

  3. Choose TCP/IP (Winsock) from the list in the Connect using field.

  4. Enter the DNS name or IP address of the iDRAC in the Host address field.

  5. Enter the Telnet port number in the Port number field.

  6. Click OK.

To end the SOL session, click the HyperTerminal disconnect icon.

Using SOL Over Telnet With Linux

To start SOL from Telnet on a Linux management station, follow these steps:

  1. Start a shell.

  2. Connect to the iDRAC with the following command:

telnet <iDRAC-ip-address>

NOTE: If you have changed the port number for the Telnet service from the default, port 23, add the port number to the end of the telnet command.
  1. Enter the following command to start SOL:

start /system1/sol1

This connects you to the managed server's serial port.

When you are ready to quit SOL, type <Ctrl>+] (hold down control and type a right square bracket, and then release). A Telnet prompt displays. Type quit to exit Telnet.

Using SOL Over SSH

The /system1/sol1 target allows you to redirect the managed server's serial port into your SSH console.

  1. Connect to the iDRAC using OpenSSH or PuTTY.

  2. Enter the following command to start SOL:

start /system1/sol1

This connects you to the managed server's serial port. The SM-CLP commands are no longer available to you.

When you are ready to quit SOL redirection, press <Enter>, <Esc>, and then <T> (press the keys in sequence, one after the other). The SSH session will be closed.

You cannot return to SM-CLP once you have started SOL. You must quit the SSH session and start a new one to use SM-CLP.


Back to Contents Page