Manuals

Manuals
Using the DRAC 5 SM-CLP Command Line Interface: Dell Remote Access Controller 5 Firmware Version 1.40 User's Guide

Back to Contents Page

Using the DRAC 5 SM-CLP Command Line Interface

Dell™ Remote Access Controller 5 Firmware Version 1.40 User's Guide

  DRAC 5 SM-CLP Support

  SM-CLP Features


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

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 DRAC 5 SM-CLP is a protocol driven by the DMTF and SMWG to provide standards for systems management CLI implementations. The SMWG SM-CLP is a subcomponent of the overall SMASH efforts overseen by DMTF.


DRAC 5 SM-CLP Support

DRAC 5 is the first RAC product that provides support for the SM-CLP standard-based command line protocol. The SM-CLP is hosted from the DRAC 5 controller firmware and supports telnet, SSH, and serial-based interfaces. The DRAC 5 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 DRAC 5.


SM-CLP Features

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

Below is an example of the SM-CLP command line syntax.

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

During a typical SM-CLP session, the user can perform operations using the verbs listed in Table 12-1 and Table 12-2.

Table 12-1. Supported CLI Verbs for System 

Verb

Definition

cd

Navigates through the MAP using the shell.

delete

Deletes an object instance.

help

Displays help for a specific target.

reset

Resets the target.

show

Displays the target properties, verbs, and subtargets.

start

Turns on a target.

stop

Shuts down a target.

exit

Exits from the SM-CLP shell session.

version

Displays the version attributes of a target.

Table 12-2. Supported CLI Verbs for Fans, Batteries, Intrusion, Hardware Performance, Power supplies, Temperatures and Voltages 

Verb

Definition

cd

Navigates through the MAP using the shell.

help

Displays help for a specific target.

show

Displays the target properties, verbs, and subtargets.

exit

Exits from the SM-CLP shell session.

version

Displays the version attributes of a target.

Using SM-CLP

  1. SSH (or telnet) to the DRAC 5 with correct credentials.

  2. At the command prompt, type smclp.

The SMCLP prompt (->) is displayed.

SM-CLP Management Operations and Targets

Management Operations

The DRAC 5 SM-CLP enables users to manage the following:

  • Server Power Management — Turn on, shutdown, or reboot the system

  • System Event Log (SEL) Management — Display or clear the SEL records

Options

Table 12-3 lists the supported SM-CLP options.

Table 12-3. Supported SM-CLP Options

SM-CLP Option

Description

-all

Instructs the verb to perform all possible functions.

-display

Displays the user-defined data.

-examine

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

-help

Displays command verb help.

-version

Displays the command verb version.

Targets

Table 12-4 provides a list of targets provided through the SM-CLP to support these operations.

Table 12-4. SM-CLP Targets 

Target

Definition

/system1

The managed system target.

/system1/logs1

The log collections target

/system1/logs1/log1

The System Event Log (SEL) target on the managed system.

/system1/logs1/log1/
record1

An individual SEL record instance on the managed system.

/system1/pwrmgtsvc1

The power management service for the system.

/system1/pwrmgtsvc1/
pwrmgtcap1

Capabilities of the power management service for the system.

/system1/fan1

A fan target on the managed system.

/system1/fan1/
tachsensor1

An individual sensor target on the fan target on the managed system.

/system1/batteries1

A battery target on the managed system.

/system1/batteries1/
sensor1

An individual sensor target on the battery target on the managed system.

/system1/intrusion1

A chassis intrusion target on the managed system.

/system1/intrusion1/
sensor1

An individual sensor target on the chassis intrusion target on the managed system.

/system1/hardwareperformance1

A hardware performance target on the managed system.

/system1/hardwareperformance1/sensor1

An individual sensor target on the hardware performance target on the managed system.

/system1/powersupplies1

A power supply target on the managed system.

/system1/powersupplies1/sensor1

An individual sensor target on the power supply target on the managed system.

/system1/temperatures1

A temperature target on the managed system.

/system1/temperatures1/tempsensor1

An individual sensor target on the temperature target on the managed system.

/system1/voltages1

A voltage target on the managed system.

/system1/voltages1/voltsensor1

An individual sensor target on the voltage target on the managed system.

/system1/chassis1

An individual chassis target of the system.

SM-CLP Output Format

The DRAC 5 currently supports text-based output as described in the SM-CLP specifications.

DRAC 5 SM-CLP Examples

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

  • Server power management

  • SEL management

  • MAP target navigation

  • Display system properties

Server Power Management

Table 12-5 provides examples of using SM-CLP to perform power management operations on a managed system.

Table 12-5. Server Power Management Operations 

Operation

Syntax

Logging into the RAC using the telnet/SSH interface

>ssh 192.168.0.120
>login: root
>password:

Starting the SM-CLP management shell

-
>smclp
DRAC5 SM-CLP System Management Shell, version 1.0
Copyright (c) 2004-2008 Dell, Inc.
All Rights Reserved
->

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 12-6 provides examples of using the SM-CLP to perform SEL-related operations on the managed system.

Table 12-6. SEL Management Operations 

Operation

Syntax

Viewing the SEL

->show /system1/logs1/log1
/system1/logs1/log1

Targets:
Record1
Record2
Record3
Record4
Record5

Properties:
InstanceID = IPMI:BMC1 SEL Log
MaxNumberOfRecords = 512
CurrentNumberOfRecords = 5
Name = IPMI SEL
EnabledState = 2
OperationalState = 2
HealthState = 2
Caption = IPMI SEL
Description = IPMI SEL
ElementName = IPMI SEL

Commands:
cd
show
help
exit
version

Viewing the SEL record

->show /system1/logs1/log1/record4
/system1/logs1/log1/record4

Properties:
LogCreationClassName = CIM_RecordLog
CreationClassName = CIM_LogRecord
LogName = IPMI SEL
RecordID = 1
MessageTimeStamp = 20050620100512.000000- 000
Description = FAN 7 RPM: fan sensor, detected a failure
ElementName = IPMI SEL Record

Commands:
cd
show
help
exit
version

Clearing the SEL

->delete /system1/logs1/log1/record*
All records deleted successfully

Batteries Management

Table 12-7 provides example of using the SM-CLP to perform operations on the batteries.

Table 12-7. Batteries Management Operations 

Operation

Syntax

Viewing the status of the batteries

->show system1/batteries1/sensor1
/system1/batteries1/sensor1:

Properties:

SystemCreationClassName = CIM_ComputerSystem

SystemName = F196P1S

CreationClassName = CIM_Sensor

DeviceID = BATTERY 1

SensorType = 1

PossibleStates = {"Good" "Bad" "Unknown"}

CurrentState = good

ElementName = System Board CMOS Battery

OtherSensorTypeDescription = CMOS battery sensor.

EnabledState = 1

Verbs:

cd
exit
help
show
version

MAP Target Navigation

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

Table 12-8. 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 logs1/log1
->show

->cd system1/logs1/log1
->show

Display current target

->cd .

Move up one level

->cd ..

Exiting the shell

->exit

System Properties

The Table 12-9 lists the system properties that are displayed when the user types the following:

show /system1

These properties are derived from the Base System Profile that is provided by the standards body and is based on the CIM_ComputerSystem class as defined by the CIM schema.

For additional information, see the DMTF CIM schema definitions.

Table 12-9. System Properties 

Object

Property

Description

CIM_ComputerSystem

Name

Unique identifier of a System instance that exists in the enterprise environment.

MaxLen = 256

ElementName

User-friendly name for the system.

MaxLen = 64

NameFormat

Identifies the method by which the Name is generated.

Values:

Other, IP, Dial, HID, NWA, HWA, X25, ISDN, IPX, DCC, ICD, E.164, SNA, OID/OSI, WWN, NAA

Dedicated

Enumeration indicating whether the system is a special-purpose system or general-purpose system.

Values:

0=Not Dedicated

1=Unknown

2=Other

3=Storage

4=Router

5=Switch

6=Layer 3 Switch

7=CentralOffice Switch

8=Hub

9=Access Server

10=Firewall

11=Print

12=I/O

13=Web Caching

14=Management

15=Block Server

16=File Server

17=Mobile User Device,

18=Repeater

19=Bridge/Extender

20=Gateway

21=Storage Virtualizer

22=Media Library

23=Extender Node

24=NAS Head

25=Self-Contained NAS

26=UPS

27=IP Phone

28=Management Controller

29=Chassis Manager

ResetCapability

Defines the reset methods available on the system

Values:

1=Other

2=Unknown

3=Disabled

4=Enabled

5=Not Implemented

CreationClassName

The superclass from which this instance is derived.

EnabledState

Indicates the enabled/disabled states of the system.

Values:

0=Unknown

1=Other

2=Enabled

3=Disabled

4=Shutting Down

5=Not Applicable

6=Enabled but Offline

7=In Test

8=Deferred

9=Quiesce

10=Starting

EnabledDefault

Indicates the default startup configuration for the enabled state of the system. By default, the system is "Enabled" (value=2).

Values:

2=Enabled

3=Disabled

4=Not Applicable

5=Enabled but Offline

6=No Default

RequestedState

Indicates the last requested or desired state for the system.

Values:

2=Enabled

3=Disabled

4=Shut Down

5=No Change

6=Offline

7=Test

8=Deferred

9=Quiesce

10=Reboot

11=Reset

12=Not Applicable

HealthState

Indicates the current health of the system.

Values:

0=Unknown

5=OK

10=Degraded/Warning

15=Minor Failure

20=Major Failure

30=Critical Failure

35=Non-recoverable Error

OperationalStatus

Indicates the current status of the system.

Values:

0=Unknown

1=Other

2=OK

3=Degraded

4=Stressed

5=Predictive Failure

6=Error

7=Non-Recoverable Error

8=Starting

9=Stopping

10=Stopped

11=In Service

12=No Contact

13=Lost Communication

14=Aborted

15=Dormant

16=Supporting Entity in Error

17=Completed

18=Power Mode

Description

A text-based description of the system.

Property Names for Fan, Temperature, Numeric Voltage, Power Consumption, and Amperage Sensors

Supported Property Names for Fans, Temperature, Numeric Voltage, Power Consumption, and Amperage Sensors

Table 12-10. Sensors 

Object

Property

Description

CIM_NumericSensor

SystemCreationClassName

The name of the system creation class— CIM_ComputerSystem)

SystemName

The service tag of the system, which is a unique identifier of a system that exists in the enterprise environment

CreationClassName

The creation class name —CIM_NumericSensor

DeviceID

The unique ID for the sensor in the system

fan1...n (for tachsensor)
temp 1...n (for tempsensor)
numeric voltage 1...n) for numericsensor (voltage) (PMBus systems only))
power consumption 1...n (for power consumption (PMBus systems only))
amperage 1...n (for amperage (PMBus systems only))

BaseUnits

The units of measurement of the sensor

RPM=Tachometer (for tachsensor)
C=Temperature (for tempsensor)
V=Voltage (for numericsensor) Watts=Power Consumption (for powerconsumption)
Amp=Amperage (for amperage)

CurrentReading

The current reading of the sensor.

LowerThresholdNonCritical

The lower threshold non critical value

UpperThresholdNonCritical

The upper threshold non critical value

LowerThresholdCritical

The lower threshold critical value

UpperThresholdCritical

The upper threshold critical value

SupportedThreshold

The supported threshold for the sensor.

{ "LowerThresholdCritical" } (for tachsensor)
{ "LowerThresholdNonCritical", "UpperThresholdNonCritical",
"UpperThresholdCritical", "LowerThresholdCritical" } (for tempsensor)
{} (for voltsensor (numeric sensor))
{"UpperThresholdNonCritical", "UpperThresholdCritical"} (for powerconsumption
{} for amperage)

SettableThreshold

The threshold levels that you can set for a sensor.

{ } (no sensor support for setting the threshold values)

SensorTypes

Type of the sensor:
5=Tachometer (for tachsensor)
2=Temperature (for temperature)
3=Voltage (for voltage)
1=Power Consumption (for powerconsumption)
1=Ampereage (for amperage)

PossibleStates

The possible states of the sensor.

{ "unknown", "warning", "failed", "non-recoverable" }

CurrentState

The current state as reported by a sensor

ElementName

The name of the sensor

OtherSensorTypeDescription

If the sensortype property contains a value of "1" (others), this property gives additional description about that sensor.

"Power consumption sensor." for powerconsumption
"Amperage sensor." for amperage

EnabledState

Indicates if the sensor is enabled or disabled.

1=Enabled

Property Names for Power Supply Sensors

Table 12-11. Supported Property Names for Power Supply Sensors 

Object

Property

Description

CIM_NumericSensor

SystemCreationClassName

The name of the system creation class CIM_ComputerSystem)

SystemName

The service tag of the system, which is a unique identifier of a system that exists in the enterprise environment

CreationClassName

The creation class name —CIM_PowerSupply

DeviceID

The unique ID for the sensor in the system.

pwrsupply 1...n

TotalOutputPower

The total power output as shown on the DRAC user interface

ElementName

Name of the particular sensor.

OperationalStatus

Current operational status of the power supply unit.

HealthState

The health status of the power supply unit.

EnabledState

Indicates if the sensor is enabled or disabled

1=Enabled

Property Names for Intrusion, Battery, Voltage, and Hardware Performance Sensors

Table 12-12. Supported Property Names for Intrusion, Battery, Voltage, and Hardware Performance Sensors 

Object

Property

Description

CIM_NumericSensor

 

SystemCreationClassName

The name of the system creation class—CIM_ComputerSystem)

SystemName

The service tag of the system, which is a unique identifier of a system that exists in the enterprise environment

CreationClassName

The creation class name —CIM_Sensor

DeviceID

Unique ID for the sensor in the system

Intrusion1...n (for intrusion sensor)
Battery1...n (for battery sensor)
Voltage1...n (for voltage sensor)
Hardware performance sensor1...n (for hardware performance sensor)

SensorType

1=Other
3=Voltage (for voltage sensor)

PossibleStates

The possible states for the sensor

{ "no intrusion", "chassis intrusion," "drive bay intrusion," "I/O card area intrusion," "processor area intrusion," "LAN disconnect," "unauthorized dock," "FAN area intrusion" } (for the Intrusion sensor)

{ "absent," "low," "failed," "good" } (for the Battery sensor)

{ "good," "bad," "unknown" } (for the Voltage sensor)

{ "Normal," "Others," "Thermal Protection," "Cooling Capacity changed," "Power Capacity changed," "User Configuration" } (for the Hardware Performance sensor)

CurrentState

Current state reported by the sensor.

ElementName

The name of the sensor

OtherSensorTypeDescription

If the sensortype property contains a value of "1" (others), this property gives additional description about that sensor.

"Chassis intrusion sensor" (for Intrusion sensor)

"CMOS battery sensor" (for Battery sensor)

"Hardware performance sensor" (for Hardware Performance)

EnabledState

Indicates if the sensor is enabled or disabled

1=Enabled (for all sensors)

Property Names for Fan and Power Supply Redundancy Set Sensors

Table 12-13. Supported Property Names for Fan and Power Supply Redundancy Set Sensors 

Object

Property

Description

CIM_RedundancySet

InstanceID

Instance number

RedundancyStatus

The redundancy status.

TypeOfSet

3=Load balanced (for fan redundancy)
4=Sparing (for Power Supply redundancy)

MinNumberNeeded

0=Unknown

ElementName

Name of the sensor

Property Names for Chassis Sensors

Table 12-14. Supported Property Names for Chassis Sensors 

Object

Property

Description

CIM_Chassis

 

CreationClassName

The name of the creation class—CIM_Chassis

PackageType

Type of package

3=Chassis

ChassisPackageType

Chassis package type

17=Main system chassis

Manufacturer

Manufacturer

"Dell"

Model

The model name of the system

ElementName

Element name

Property Names for Power Management Service

Table 12-15. Supported Property Names for Power Management Service 

Object

Property

Description

CIM_PowerManagementService

CreationClassName

The name of the creation class—CIM_PowerManagementService

Name

IPMI Power Service

ElementName

Dell Server Power Management Service

powerstate

Current power state of the system.

2=On
6=Off

Can be set to the following values:

2=Power On
6=Power Off
5=Power Reset
9=Powercycle the system

Using the set verb, you can set the power state of the system. for example, to turn on the system if it is off:

set powerstate=2

Property Names for Power Capability

Table 12-16. Supported Property Names for Power Capability 

Object

Property

Description

CIM_PowerManagementCapabilities

InstanceID

Unique instance ID for the power capabilities

PowerChangeCapabilities

3=Power State Settable

ElementName

Dell Server Power Management Service

PowerStatesSupported

2=Power On
6=Power Off
5=Power Reset
9=Powercycle the system


Back to Contents Page

 

Notebooks| Desktops| Business-Notebooks| Business-Desktops| Workstations| Servers| Speichermedien| Monitore| Drucker| | LCD TV| Elektronik
Copyright 1999-2009 Dell Inc. | Geschäftsbedingungen | Impressum / Anbieterkennzeichnung § 5 TMG | Nicht behobene Probleme | Datenschutz | Dell-Recycling | Kontakte | Feedback |
AT | AU | BE | BR | CA | CH | CL | CN | CO | DK | ES | FR | HK | IE | IN | IT | JP | KR | ME | MX | MY | NL | NO | PA | PR | RU | SE | SG | UK | US | VE | ALLE

snWEB1