Cisco UCS SMASH Reference Guide - Accessing and Using the SMASH CLP [Cisco Unified Computing System]

Table Of Contents

Accessing and Using the SMASH CLP

Accessing the SMASH CLP

Viewing the Available Commands

Viewing the Properties, Targets, and Verbs

Navigating to CLP Objects

Configuring a CLP Property

Task Examples

Configuring a Sensor Threshold

Setting the Indicator LED

Clearing the System Event Log

Controlling System Power

Accessing and Using the SMASH CLP

This chapter describes how to access the SMASH CLP and provides limited information about its use. For detailed information about using the SMASH CLP, see the DMTF documentation at the following URL:

http://www.dmtf.org/standards/smash

This chapter contains the following topics:

•Accessing the SMASH CLP

•Viewing the Available Commands

•Viewing the Properties, Targets, and Verbs

•Navigating to CLP Objects

•Configuring a CLP Property

•Task Examples

Accessing the SMASH CLP

The SMASH CLP interface is activated from within the Cisco UCS server command line interface. To access the SMASH CLP, connect to the command line interface of the UCS server using SSH or a console connection.

To activate the SMASH CLP, perform this task from the Cisco UCS server command line interface:

Command

Purpose

Step 1

Server# connect clp

Enters the CLP environment.

Step 2

/admin1->

This is the CLP prompt.

This example shows how to enter the CLP environment:
ucs-c460# connect clp
/admin1-> 
Viewing the Available Commands

The help command displays the SMASH CLP commands and options that are available at each level. To view the commands, perform this task:

Command

Purpose

Step 1

/admin1-> help

Displays the CLP commands and options.

This example shows how to view the CLP command options:
/admin1-> help
[Usage]
    show   [<options>] [<target>] [<properties>] 
           [<propertyname>== <propertyvalue>]
    set    [<options>] [<target>] <propertyname>=<value>
    cd     [<options>] [<target>]
    create [<options>] <target> [<property of new target>=<value>] 
           [<property of new target>=<value>]
    delete [<options>] <target>
    exit   [<options>]
    reset  [<options>] [<target>]
    start  [<options>] [<target>]
    stop   [<options>] [<target>]
    version [<options>]
    help   [<options>] [<help topics>]
    load -source <URI> [<options>] [<target>]
    dump -destination <URI> [<options>] [<target>]
/admin1-> 
Tip You can use the Tab key to complete a command. Partially typing a command name and pressing Tab causes the command to be displayed in full, or to the point where another keyword must be chosen or an argument value must be entered.

Viewing the Properties, Targets, and Verbs

The show command displays the SMASH CLP properties, targets, and verbs that are available at each level. To view the properties, targets, and verbs, perform this task:

Command

Purpose

Step 1

/admin1-> show

Displays the CLP properties, targets, and verbs.

This example shows how to view the CLP properties, targets, and verbs:
/admin1-> show
/admin1
        properties
                ElementName = SM CLP Admin Domain
        targets
                hdwr1
                profiles1
                system1
        verbs
                cd
                show
                help
                version
/admin1->
Navigating to CLP Objects

The cd command allows you to navigate to SMASH CLP targets. To navigate to a target, perform this task:

Command

Purpose

Step 1

/admin1-> cd target

Displays the CLP commands and options.

This example shows how to navigate from the root level to the profiles1 target:
/admin1-> cd profiles1
/admin1/profiles1-> 
Configuring a CLP Property

The set command allows you to change a configurable SMASH CLP property. To configure a property, perform this task:

Command

Purpose

Step 1

/admin1-> cd target

Navigates to the target.

Step 2

/admin1/target-> set property=value

Configures a new value for the property.

This example shows how to change the ActivationState property of the indicator LED:
/admin1-> cd /admin1/system1/leds1/identifyled1
/admin1/system1/leds1/identifyled1-> set ActivationState=3
        activationstate=3
/admin1/system1/leds1/identifyled1->
Task Examples

This section contains the following examples:

•Configuring a Sensor Threshold

•Setting the Indicator LED

•Clearing the System Event Log

•Controlling System Power

Configuring a Sensor Threshold

To configure a sensor threshold, perform this task:

Command

Purpose

Step 1

/admin1-> cd target

Navigates to the target.

Step 2

/admin1/target-> set property=value

Configures a new value for the property.

This example shows how to configure a sensor threshold:
/admin1-> cd /admin1/system1/sensors1/numsensor1
/admin1/system1/sensors1/numsensor1-> set LowerThresholdCritical=20000
        lowerthresholdcritical=19932
/admin1/system1/sensors1/numsensor1->
Note Because some properties have limited resolution, the actual resulting value may be slightly different from the value specified in the set command, as in this example.

Setting the Indicator LED

To set the indicator LED, perform this task:

Command

Purpose

Step 1

/admin1-> cd /admin1/system1/leds1/identifyled1

Navigates to the indicator LED object.

Step 2

/admin1/target-> set ActivationState=3

Configures a new value for the Activation State property.

This example shows how to set the indicator LED by changing the Activation State to 3:
/admin1-> cd /admin1/system1/leds1/identifyled1
/admin1/system1/leds1/identifyled1-> set ActivationState=3
        activationstate=3
/admin1/system1/leds1/identifyled1->
Clearing the System Event Log

The reset command allows you to clear the system event log (SEL). To clear the SEL, perform this task:

Command

Purpose

Step 1

/admin1-> cd /admin1/system1/log1

Navigates to the SEL.

Step 2

/admin1/system1/log1-> reset

Clears the SEL.

This example shows how to clear the SEL:
/admin1-> cd /admin1/system1/log1
/admin1/system1/log1-> reset
/admin1/system1/log1 reset at Tue Jun 1 11:43:54 2010
/admin1/system1/log1->
Controlling System Power

A set of power commands allows you to stop, start, and reset the server power. To control the server power, perform one of these tasks:

Command

Purpose

Step 1

/admin1-> cd /admin1/system1

Navigates to the system1 target.

Step 2

/admin1/system1-> start

Sets the powerstate to 2 (On).

/admin1/system1-> reset

Sets the powerstate to 5 (Power Cycle (Off-Soft)).

/admin1/system1-> stop -f

Sets the powerstate to 8 (Off-Soft).

/admin1/system1-> stop

Sets the powerstate to 12 (Off-Soft Graceful).

This example shows how to gracefully turn off the server power:
/admin1-> cd /admin1/system1
/admin1/system1-> stop
/admin1/system1 stopped at Wed Jun  2 07:31:15 2010
/admin1/system1->