HP (Hewlett-Packard) 449298-001 User Manual

HP Virtual Connect Manager Command Line Interface User Guide

Version 1.20

Part Number 449298-001 September 2007 (First Edition)

© Copyright 2007 Hewlett-Packard Development Company, L.P. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express

warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.

Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor’s standard commercial license.

Microsoft and Windows NT are U.S. registered trademarks of Microsoft Corporation.

Audience assumptions

This document is for the person who installs, administers, and troubleshoots servers and storage systems. HP assumes you are qualified in the servicing of computer equipment and trained in recognizing hazards in products with hazardous energy levels.

Introduction.................................................................................................................................. 5

Virtual Connect overview............................................................................................................................ 5

Command line overview............................................................................................................................. 5

Command line syntax ................................................................................................................................6

Parameters .....................................................................................................................................6

Options.......................................................................................................................................... 6

Properties ....................................................................................................................................... 7

CLI command execution modes ................................................................................................................... 7

Remote access to the Virtual Connect Manager............................................................................................. 8

Command line.............................................................................................................................. 9

Subcommands ..........................................................................................................................................9

Managed elements.................................................................................................................................... 9

devicebay ....................................................................................................................................10

domain ........................................................................................................................................ 10

enclosure...................................................................................................................................... 12

enet-connection ............................................................................................................................. 13

external-manager .......................................................................................................................... 15

fabric........................................................................................................................................... 16

fc-connection................................................................................................................................. 17

firmware ...................................................................................................................................... 18

igmp............................................................................................................................................ 19

interconnect.................................................................................................................................. 19

ldap ............................................................................................................................................ 20

ldap-group.................................................................................................................................... 21

mac-cache.................................................................................................................................... 22

network........................................................................................................................................ 23

profile.......................................................................................................................................... 24

server .......................................................................................................................................... 26

stackinglink................................................................................................................................... 28

status ........................................................................................................................................... 29

systemlog ..................................................................................................................................... 29

uplinkport..................................................................................................................................... 29

uplinkset....................................................................................................................................... 31

user ............................................................................................................................................. 32

vcm .............................................................................................................................................34

version......................................................................................................................................... 34

Help subsystem ....................................................................................................................................... 34

Output format ......................................................................................................................................... 36

Interactive user output format .......................................................................................................... 36

Scriptable output format .................................................................................................................38

Configuring the Virtual Connect domain using the CLI..................................................................... 40

Basic configuration.................................................................................................................................. 40

Logging in to the CLI...................................................................................................................... 40

Domain setup................................................................................................................................ 41

Network setup............................................................................................................................... 43

Contents 3

Fibre Channel setup....................................................................................................................... 46

Server Profile setup ........................................................................................................................ 47

Logging out of the CLI .................................................................................................................... 50

Common management operations ............................................................................................................. 50

Resetting the Virtual Connect Manager....................................................................................................... 51

Technical support........................................................................................................................ 53

Before you contact HP.............................................................................................................................. 53

HP contact information............................................................................................................................. 53

Acronyms and abbreviations........................................................................................................ 54

Index......................................................................................................................................... 56

Contents 4

Introduction

Virtual Connect overview

Virtual Connect is a set of interconnect modules and embedded software for HP BladeSystem c-Class enclosures that simplifies the setup and administration of server connections. HP Virtual Connect includes the HP 1/10Gb Virtual Connect Ethernet Module for c-Class BladeSystem, the HP 4Gb Virtual Connect Fibre Channel Module for c-Class BladeSystem, and the HP Virtual Connect Manager.

Virtual Connect implements server edge virtualization so that server administrators can upgrade, replace, or move server blades within their enclosures without changes being visible to the external LAN and SAN environments.

The Virtual Connect Manager is embedded on the HP 1/10Gb Virtual Connect Ethernet Module for cClass BladeSystem and is accessed by users through web links provided by the Onboard Administrator or through direct connection to the embedded web server.

The HP 1/10Gb VC-Enet Module supports the HP BladeSystem c7000 Enclosure, HP BladeSystem c3000 Enclosure, and all the server blades and networks contained within the enclosure and enables connection to all brands of data center Ethernet switches.

The HP 4Gb VC-FC Module enables connection of the enclosure to Brocade, Cisco, McData, or Qlogic data center Fibre Channel switches, but does not appear as a switch to the Fibre Channel fabric.

A Virtual Connect domain currently includes a single HP c-Class BladeSystem enclosure for a total of 16 servers. Within the domain, any server blade can access any LAN or SAN connected to a VC module, and a server blade can be used as a spare for any server blade within the same enclosure.

By stacking (cabling) the Ethernet modules within the domain, every server blade in the domain can be configured to access any external network connection. Fibre Channel modules within different I/O bays are each connected directly to the same set of FC SAN(s). With this configuration, the Virtual Connect Manager can deploy and migrate a server blade profile to any server in the Virtual Connect domain without the need to change external LAN or SAN configurations.

Command line overview

The CLI can be used as an alternative method for managing the Virtual Connect Manager. Using the CLI can be useful in the following scenarios:

• HP Management Applications (for example: Systems Insight Manager or Insight Control tools) can

query the Virtual Connect Manager for information these tools need to present a complete management view of HP BladeSystem enclosures and the devices contained within. This interface is also used by the Management tools to execute provisioning and configuration tasks to devices within the enclosure.

• Users can develop tools that utilize Virtual Connect Manager functions for data collection and for

executing provisioning and configuration tasks.

Introduction 5

• When no browser is available or you prefer to use a command line interface, you can access

management data and perform configuration tasks.

Command line syntax

CLI input is case-insensitive except when otherwise noted. The general CLI syntax format is as follows:

<subcommand> <managed element> <parameters> [<options>] [<properties>]

Item Description

subcommand Operation performed on a managed element managed element Management entity being operated on parameters Command extensions for a particular management operation options Attributes used to customize or control command execution behavior such as output

format, quiet-mode, and others

properties One or more name or value pairs that are accessories to the command operation,

Example: ->add user mark password=asdf89g fullname="Mark Smith" enabled=true

mainly for set and add operations

In the above example, add is the subcommand, user is the managed element, mark is a required parameter for the operation, password is a required property, and fullname and enabled are optional properties.

Depending on the specific command being executed, certain parameters or properties might be required. For example, when adding a new user, both a parameter representing the user name, as well as a password (in the form of a property) are required to be specified. All other user properties are optional at the time the user is added. In general, the properties are in the format name=value, and more than one property is separated by a space.

Parameters

Parameters are command extensions that provide extra information needed for the execution of a particular command. Whether or not a parameter is required depends on the specific command being executed. For example, the show user command has an optional parameter, which represents the user name if the user instance is being managed. If show user is entered, then a summary listing of all users is shown. However, if the optional parameter (user name) is provided, only a single user instance is displayed, for example, show user paul.

Some commands require that a parameter be specified, for example, the add user command. The required parameter is the user name (add user jake), and if the username is not provided, an error message displays indicating that a required parameter is missing.

Options

Options enable users to control certain behavior characteristics available during the command execution. Some examples of options include controlling output format and specifying a quiet mode for suppressing interactive prompts that would normally require input from the user.

Options are distinguished from other command line elements by using a hyphen (-) in front of the option. Option arguments are required or optional depending on the option being specified. For example, the -

Introduction 6

output option requires an argument, which is a list of one or more output format attributes. However, the -quiet option does not require any arguments to be specified.

The general format of a CLI option is as follows:

-<option>[=argument1>,<argument2>, . . .]

Example: ->show user suzi -output=script1 In the example, -output is the option, and script1 is an option argument.

Properties

Properties are specific configuration attributes of a managed element. Properties are commonly used during set operations or add operations where a managed element is being modified or created. In some limited circumstances, properties might also be used as a part of a show or other command.

IMPORTANT: If a property value contains embedded spaces, then the entire property value

must be contained within single or double quotes. Likewise, if a double quote is part of a property value, it should be contained within single quotes, and if a single quote is part of a property value, it should be contained within double quotes.

CLI command execution modes

The Virtual Connect Manager CLI provides two different methods for executing commands: interactive shell mode and non-interactive mode.

Interactive Shell Mode This mode is used to invoke CLI command operations using the dedicated management shell. The shell is

provided after the user logs in with valid credentials, and only accepts known VCM CLI commands as input. Users can quit the shell by using the exit command. An example of logging into the interactive management shell is provided below. In the example, the primary VCM is located at IP address

192.168.0.120.

>ssh 192.168.0.120

--------------------------------------------------------------------

GETTING STARTED:

help : displays a list of available subcommands exit : quits the command shell <subcommand> ? : displays a list of managed elements for a subcommand <subcommand> <managed element> ? : displays detailed help for a command

Introduction 7

Non-Interactive Mode In some cases, users might want to write automated scripts that execute a single command at a time.

These scripts can be used to batch several commands in a single script file from the SSH client. An example of how to use the non-interactive mode for CLI command execution is provided below. In the example, the primary VCM is located at IP address 192.168.0.120.

IMPORTANT: To suppress prompting for a password during login, you must first setup the SSH

encryption keys using the VCM Web GUI, and configure your SSH client properly with the keys. For additional information on configuring the SSH keys, see the HP Virtual Connect for c- Class BladeSystem User Guide.

->ssh Administrator@192.160.0.120 show enclosure <command output displayed to console>

Remote access to the Virtual Connect Manager

The Virtual Connect Manager CLI can be accessed remotely through any SSH session:

1. Start an SSH session to the Virtual Connect Manager using any SSH client application.

2. When prompted, type the assigned IP address or DNS name of the Virtual Connect Manager, and

then press Enter.

3. Type a valid user name, and then press Enter.

4. Type a valid password, and then press Enter. The CLI command prompt displays.

5. Enter commands for the Virtual Connect Manager.

6. To terminate the remote access SSH session, close the communication software or enter exit at the

CLI command prompt.

Introduction 8

Command line

Subcommands

Command Description

add

assign

delete

exit

help

import

poweroff

poweron

reboot

remove

reset

set

show

unassign

update

Add a new object to the domain or to another object Assign a server profile to a server bay Delete the Virtual Connect domain configuration Exit the Virtual Connect Manager command-line shell Display help for a command or object Import an enclosure into the domain Power off one or more servers Power on one or more servers Reboot one or more servers Remove or delete an existing object (for example, users or profiles) Reset one or more servers or other objects Modify one or more configuration properties of an object Display properties or information about an object Unassign a server profile from a device bay Update firmware on one or more interconnect modules

Managed elements

Managed element Description

devicebay (on page 10)

domain (on page 10)

enclosure (on page 12)

enet-connection (on page 13)

external-manager (on page 15)

fabric (on page 16)

fc-connection (on page 17)

firmware (on page 18)

igmp (on page 19)

interconnect (on page 19)

ldap (on page 20)

Display general enclosure device bay settings and information Manage general Virtual Connect domain settings and

information Manage general enclosure settings and information Manage Ethernet network connections Manage external settings and information Manage FC SAN fabrics Manage Fibre Channel SAN fabric connections Manage interconnect module firmware Ethernet IGMP Snooping settings Manage I/O interconnect modules Manage LDAP configuration settings

Command line 9

Managed element Description

ldap-group (on page 21)

mac-cache (on page 22)

network (on page 23)

profile (on page 24)

server (on page 26)

stackinglink (on page 28)

status (on page 29)

systemlog (on page 29)

uplinkport (on page 29)

uplinkset (on page 31)

user (on page 32)

vcm (on page 34)

version (on page 34)

Manage LDAP group configuration settings Manage Ethernet MAC cache failover settings Manage Virtual Connect Ethernet networks Manage VC server profiles Manage server blades in the enclosure device bays Display stacking link information and status Display overall domain status information Display Virtual Connect Manager system event log Manage interconnect module uplink ports Manage shared uplink port sets Manage local domain user configurations Reset the Virtual Connect Manager that manages the domain Display CLI version information

The following sections provide detailed information on how the subcommands are used with each managed element.

To display command help, type a command followed by ? or -help. For additional information on the help subcommand, see "Help subsystem (on page 34)."

devicebay

Manage general enclosure device bay settings and information.

Supported actions: help, show

Item Description

show devicebay Syntax

Parameters: DeviceBayID

Examples:

Display all device bays in the domain

show devicebay [<DeviceBayID>|*]

The reference ID of a device bay in the domain The format of the device bay name is <EnclosureID:DeviceBay> When Enclosure ID is not specified, it defaults to the local enclosure

->show devicebay Displays a summary listing of all device bays

->show devicebay * Displays detailed information for all device bays

->show devicebay enc0:2 Displays detailed information for a specific device bay of a specific enclosure

domain

Manage general Virtual Connect domain settings and information.

Command line 10

Supported actions: delete, help, set, show

Item Description

delete domain

Syntax Examples:

Delete the existing Virtual Connect domain configuration. Deleting the domain removes the entire Virtual Connect domain configuration

and resets it back to the original defaults. After the domain has been deleted, you are logged out and the Virtual Connect Manager resets.

delete domain [-quiet]

->delete domain

Deletes the Virtual Connect domain configuration and prompts for user confirmation

->delete domain -quiet Deletes the Virtual Connect domain quietly without prompting for user

confirmation (primarily used in automated scripting scenarios)

Item Description

set domain

Syntax

Properties:

Name

DomainIP

IpAddress

SubnetMask

Gateway

MacType

MacPool

MacStart

MacEnd

WwnType

Modify domain configuration properties

set domain [Name=<NewName>] [DomainIp=<Enabled|Disabled>] [IpAddress=<IPAddress>] [SubnetMask=<mask>] [Gateway=<Gateway>] [MacType=<VC-Defined|Factory-Default| User-Defined>] [MacPool=<1-64>] [MacStart=<address>] [MacEnd=<address>] [WwnType=< VC-Defined|Factory-Default>] [WwnPool=<1-64>]

The new name of the domain. Valid characters include alphanumeric, "_", and ".". The maximum length of the name is 64 characters.

Enables or disables the Virtual Connect domain IP address. If enabled, then a valid IP address subnet mask must be configured. If disabled, then DHCP is used to obtain a valid IP address.

Enabling domain IP address configuration, or changing the domain IP address can cause a temporary loss of connectivity to the Virtual Connect Manager. Use caution when changing these settings.

A valid IP address to use for the domain IP address configuration A valid subnet mask for the domain IP address configuration A valid gateway address for the domain IP address configuration The type of MAC address source to use for assignment. Valid values include VC-

Defined, Factory-Default, and User-Defined The pre-defined MAC pool to use for address assignment. Valid values include

integers 1-64. This property is only valid if the MacType is set to "VC-Defined". If not specified, the default pool ID is 1.

The starting MAC address in a custom user-defined range. This property is only valid if the MacType is set to "User-Defined".

The ending MAC address in a custom user-defined range. This property is only valid if the MacType is set to "User-Defined".

The type of WWN address source to use for assignment. Valid values include VC-Defined and Factory-Default.

Command line 11

Item Description

WwnPool

Examples:

The pre-defined WWN pool to use for address assignment. Valid values include integers 1-64. This property is only valid if the WwnType is set to "VC-Defined". If not specified, the default pool ID is 1.

->set domain Name=MyNewDomainName Changes the name of the Virtual Connect domain

->set domain DomainIp=Enabled

Enables the domain IP address

->set domain DomainIp=Enabled IpAddress=192.168.0.120 SubnetMask=255.255.255.0 Gateway=192.168.0.1

Configures the domain IP address and enables it

->set domain DomainIp=Disabled Disables the domain IP address and uses DHCP instead

->set domain MacType=VC-Defined MacPool=10 Sets the MAC address source to VC-Defined with a pre-defined range

->set domain MacType=Factory-Default Set the MAC address source to use factory default MAC addresses

->set domain MacType=User-Defined MacStart=00-17-A4-77-0000 MacEnd=00-17-A4-77-00-FF

Sets the MAC address source to a custom, user-defined address range

->set domain WwnType=VC-Defined WwnPool=5 Sets the WWN address source to VC-Defined with a pre-defined range

->set domain WwnType=Factory-Default Sets the WWN address source to use factory default WWN addresses

Item Description

show domain

Syntax Examples:

Display general Virtual Connect domain information, such as the Virtual Connect domain name and the VCM domain IP address settings

show domain [addressPool]

->show domain

Displays domain information

->show domain addressPool Displays the VC defined address pools for the domain

enclosure

Manage general enclosure settings and information.

Supported actions: help, import, show

Item Description

import enclosure

Import an enclosure into the domain

Command line 12

Item Description

Syntax

Properties:

UserName

Password

Example

import enclosure UserName=<username> Password=<password>

The password field is optional on the command line. If not specified on the command line, the user is prompted for the same interactively.

A valid user name of the Onboard Administrator user A valid password of the Onboard Administrator user

->import enclosure UserName=Administrator Password=fgg7h*1

Imports the local enclosure

Item Description

show enclosure

Syntax Parameters:

EnclosureID

Examples:

Display all enclosures in the domain show enclosure [<EnclosureID>|*]

The ID of an enclosure in the domain

->show enclosure Displays a summary listing of all enclosures

->show enclosure * Displays detailed information for all enclosures

->show enclosure enc0 Displays detailed information for a specific enclosure

enet-connection

Manage Ethernet network connections.

Supported actions: add, help, remove, set

Item Description

add enet-connection

Syntax

Parameters:

ProfileName

Properties:

Network

Add a new Ethernet network connection to an existing server profile

add enet-connection <ProfileName> [Network=<NetworkName>] [PXE=<enabled|disabled|UseBios>] [AddressType=<VcDefined|Factory-Default|User-Defined>] [EthernetMAC=<MAC Address> iScsiMAC=<MAC Address>]

The name of an existing profile to which the new connection is added. (required)

The name of an existing network to associate with the connection. If the network name is not specified, or is set to "unassigned," then the network remains unassigned. (optional)

Command line 13

Item Description

PXE

AddressType

EthernetMAC

iScsiMAC

Examples:

Enables or disabled PXE on the network connection. Valid values are enabled, disabled, and UseBios. If this value is not specified, the default is "UseBios."

Only one connection can have PXE enabled per profile. The source of MAC address assignments to be used during the creation

of the new connection. If not specified, the default is the domain default. If "User-Defined" is specified, then both an Ethernet MAC Address and iSCSI MAC Address must also be specified. Valid values include VcDefined, Factory-Default, and User-Defined.

The user-defined Ethernet MAC address to use for the connection. This property is required if the AddressType specified is "User-Defined."

The user-defined iSCSI MAC address to use for the connection. This property is required if the AddressType specified is "User-Defined."

->add enet-connection MyNewProfile Network=SomeNetwork

Adds a new Ethernet network connection to a profile

->add enet-connection MyNewProfile Network=SomeNetwork2 PXE=enabled

Adds a new Ethernet network connection and enables PXE

->add enet-connection MyNewProfile Adds a new Ethernet network connection and leaves the network

unassigned

->add enet-connection MyNewProfile AddressType=Factory-Default

Adds a new Ethernet network connection and uses factory default addresses

->add enet-connection MyNewProfile AddressType=VcDefined

Adds a new Ethernet network connection using VC-defined addresses

->add enet-connection MyNewProfile AddressType=UserDefined EthernetMAC=00-17-A4-77-00-00 iScsiMAC=0017-A4-77-00-01

Adds a new Ethernet network connection and provides user-defined MAC addresses

Item Description

set enet-connection

Syntax

Parameters:

ProfileName

Port

Properties:

NetworkName

Modify an existing server profile connection

set enet-connection <ProfileName> <Port> [Network=<NetworkName>] [PXE=<enabled|disabled|UseBios>]

The name of the server profile that contains the connection to modify The port number of the connection being modified

The name of the Ethernet network to associate with the connection. Applies to Ethernet network connections only.

Command line 14

Item Description

PXE

Examples:

external-manager

Manage external manager settings and information.

Supported actions: delete, help, set, show

Item Description

show externalmanager

Syntax Examples:

Item Description

remove externalmanager

Syntax Properties:

UserName

Example

Item Description

set externalmanager

Syntax

Enables or disables PXE on a connection. Valid values are enabled, disabled, and UseBios. Applies to Ethernet network connections only.

PXE can be enabled on one connection per profile.

->set enet-connection MyProfile 2 NetworkName=NewNetworkName

Changes the network of an Ethernet connection

->set enet-connection RedProfile 1 NetworkName="" Sets a network connection to "unassigned"

->set enet-connection GreenProfile 3 PXE=disabled Disables PXE on an Ethernet connection

Display the information of an existing external manager

show external-manager

->show external-manager

Displays the information of an existing external manager.

->show external-manager Displays the information of an existing external manager in the specified output

format.

->show external-manager Displays the information of an existing external manager in the specified output

format.

Remove an existing manager and regain control of the VC Manager

remove external-manager UserName=<username>

A valid external manager user name

->remove external-manager UserName=<username> Removes external management control of the VC Manager

Modify external manager configuration properties

set external-manager UserName=<username> Enabled=<true|false>

Command line 15

fabric

Item Description

Examples:

->set external-manager UserName=steve Enabled=false Disables the external manager

->set external-manager UserName=steve Enabled=true Enables the external manager

Manage Fibre Channel SAN fabrics.

Support actions: help, set, show

Item Description

set fabric

Syntax

Parameters:

FabricName

Properties:

Name

NumPorts

PortSpeed

Examples:

Modify an existing FC SAN fabric

set fabric <FabricName> [Name=<NewName>] [NumPorts=<1|2|4>] [PortSpeed=<Auto|2Gb|4Gb>]

The name of an existing FC SAN fabric to modify (required)

The new name of the fabric The number of uplink ports to use for the fabric The port speed for the uplink ports in the fabric

->set fabric MyFabric NumPorts=2 Changes the number of ports used by the fabric

->set fabric Blue Name=Red Changes the name of an existing fabric from "Blue" to "Red"

->set fabric GreenFabric PortSpeed=4Gb Changes the port speed of the uplinks in a fabric

Item Description

show fabric Syntax

Examples:

Display all FC SAN fabrics

show fabric [<FabricName> | *]

->show fabric

Displays a summary listing of all FC SAN fabrics

->show fabric * Displays detailed information for all FC SAN fabrics

->show fabric SAN_5 Displays detailed information for a specific FC SAN fabric

Command line 16

fc-connection

Manage Fibre Channel SAN fabric connections.

Supported actions: add, help, set

Item Description

add fc-connection

Syntax

Parameters:

ProfileName

Properties:

Fabric

Speed

AddressType

PortWWN

NodeWWN

Examples:

Item Description

set fc-connection

Add a new FC SAN connection to an existing server profile

add fc-connection <ProfileName> [Fabric=<FabricName>] [Speed=<Auto|2Gb|4Gb|Disabled>]

The name of an existing profile to which the new connection is added. (required)

The name of an existing fabric to associate with the connection. If the fabric name is not specified, it will be assigned to the next available SAN Fabric.

The port speed of the connection port. Valid values include Auto, 2Gb, 4Gb, and Disabled. If not specified, then the default port speed is set to "Auto".

The source of WWN address assignments to be used during the creation of the new connection. If not specified, the default is the domain default. If "UserDefined" is specified, then both a Port WWN and Node WWN must also be specified. Valid values include Vc-Defined, Factory-Default, and UserDefined.

The user-defined Port WWN address to use for the connection. This property is required if the AddressType specified is "User-Defined".

The user-defined Node WWN address to use for the connection. This property is required if the AddressType specified is "User-Defined".

->add fc-connection MyNewProfile Fabric=SAN_5 Adds a new FC SAN fabric connection to a profile

->add fc-connection MyNewProfile Fabric=SomeFabric Speed=4Gb

Adds a new FC SAN connection and configures the port speed

->add fc-connection MyNewProfile Adds a new FC SAN connection and uses the next available fabric

->add fc-connection MyNewProfile AddressType=FactoryDefault

Adds a new FC SAN connection and uses factory-default addresses

->add fc-connection MyNewProfile AddressType=Vc-Defined Adds a new FC SAN connection and uses VC-defined addresses

->add fc-connection MyNewProfile AddressType=UserDefined PortWWN=50:06:0B:00:00:C2:62:00 NodeWWN=50:06:0B:00:00:C2:62:00

Adds a new FC SAN connection and provides user-defined WWN addresses

Modify an existing server profile connection

Command line 17

Item Description

Syntax

Parameters:

ProfileName

Port

Properties:

Fabric

Speed

BootPriority

BootPort

BootLun

Examples:

set fc-connection <ProfileName> <Port> [Fabric=<FabricName>] [Speed=<Auto|2Gb|4Gb|Disabled>] [BootPriority=<priority>] [BootPort=<portName>] [BootLun=<LUN>]

The name of the server profile that contains the connection to modify The port number of the connection being modified

The name of the FC SAN fabric to associate with the connection The port speed of the FC SAN connection. Valid values include Auto, 4Gb,

2Gb, and Disabled Controls whether the FC HBA port is enabled for SAN boot and will affect the

BIOS boot order. Valid values include BIOS, Primary, Secondary, Disabled The target WWPN of the controller interface on the Fibre Channel storage

target. The port name is a 64-bit identifier in the format: NN:NN:NN:NN:NN:NN:NN:NN, where N is a hexadecimal number

The LUN of the volume used for SAN boot. Valid values include an integer from 0-255.

->set fc-connection MyProfile 1 Fabric=SAN_5 Changes the fabric of an FC SAN fabric connection

->set fc-connection RedProfile 2 Fabric="" Sets a FC SAN fabric connection to "Unassigned"

->set fc-connection BlueProfile 1 Fabric=SAN_7 Changes the FC SAN Fabric of an FC SAN connection

->set fc-connection BlueProfile 1 Speed=4Gb Changes the port speed of a FC SAN connection

->set fc-connection BlueProfile 1 BootPriority=Primary BootPort=50:06:0B:00:00:C2:62:00 BootLun=5

Changes the SAN boot priority and sets additional boot parameters

firmware

Display or update Virtual Connection firmware version.

Support actions: help, show, update

Item Description

show firmware

Syntax Examples:

Display current version of firmware of all interconnect modules in the domain

show firmware

->show firmware

Displays current version of the firmware

Command line 18

Item Description

igmp

update firmware

Syntax Example

Update the firmware on all Virtual Connect modules in the domain

update firmware url=<firmware image address>

->update firmware url=http://www.myserver.com/fw/vc-1.20.rom

Updates the firmware on all Virtual Connect modules in the domain

Manage Ethernet IGMP Snooping settings.

Supported actions: help, set, show

Item Description

set igmp

Syntax Properties:

Enabled

Timeout

Examples:

Modify Ethernet IGMP Snooping settings set igmp [Enabled=<true|false>] [Timeout=<interval>]

Enables or disables IGMP Snooping. Valid values include "true" and "false". The idle timeout interval (in seconds) for IGMP Snooping. Valid values include

integers from 1-3600. The default IGMP idle timeout is 260 seconds.

->set igmp Enabled=true Enables IGMP Snooping

->set igmp Enabled=true Timeout=30 Enables IGMP Snooping and sets the idle timeout

Item Description

show igmp

Syntax Example

Display Ethernet IGMP Snooping settings

show igmp

->show igmp

Displays IGMP Snooping settings

interconnect

Manage I/O interconnect modules.

Supported actions: help, remove, show

Item Description

remove interconnect

Syntax Parameters:

ModuleID

Examples:

Remove a module from the domain that has physically been removed from an enclosure

remove interconnect <ModuleID|*>

The ID of the module to remove. The ID is in the format <EnclosureID>:<BayNumber>

Command line 19

Item Description

->remove interconnect enc0:2 Removes a specific interconnect module (bay 2) from the domain

->remove interconnect * Removes all interconnect modules from the domain that are not physically

present in any enclosures

->remove interconnect enc0:* Remove all interconnect modules that are not physically present in a specific

enclosure

Item Description

show interconnect

Syntax

Examples:

Display all interconnect modules known to the domain

show interconnect [ModuleID|*]

->show interconnect

Displays a summary listing of all interconnect modules

->show interconnect * Displays detailed information for all interconnect modules

->show interconnect *:5 Displays the detailed information for all enclosures with interconnect modules

in interconnect bay number 5

->show interconnect enc0:* Displays interconnect modules in all bays of a specific enclosure

->show interconnect enc0:3 Displays detailed information on a specific interconnect module in interconnect

bay 3 of the primary enclosure

ldap

Manage Virtual Connect directory server authentication settings.

Supported actions: help, set, show

Item Description

set ldap

Syntax

Properties:

Enabled

Modify the Virtual Connect directory server settings set ldap [Enabled=<true|false>]

[LocalUsers=<enabled|disabled>] [NtAccountMapping=<enabled|disabled>] [TargetDomain=<domainName>] [IpAddress=<ipAddress>] [SslPort=<portNum>] [SearchContext1=<string>] [SearchContext2=<string>] [SearchContext2=<string>]

Enables or disables directory authentication. Valid values include "true" and "false".

Command line 20

Item Description

LocalUsers

Enables or disables local user authentication. Valid values include "Enabled" and "Disabled".

WARNING: Disabling local users without correctly configuring LDAP authentication first may result in not being able to log on.

NtAccountMapping

Enables or disables Microsoft® Windows NT® account mapping. This capability allows you to enter "domain\username". Valid values include "Enabled" and "Disabled".

TargetDomain

IpAddress

SslPort

The target domain name. The maximum length is 64 characters. The IP address or DNS name of the directory server The port to use for LDAP communication. Valid values include a valid port

number between 1 and 65535. The default port number is 636.

SearchContext1

First searchable path used to locate the user when the user is trying to authenticate using directory services.

SearchContext2

Second searchable path used to locate the user when the user is trying to authenticate using directory services.

SearchContext3

Third searchable path used to locate the user when the user is trying to authenticate using directory services.

Example

->set ldap LDAP=enabled IpAddress=192.168.0.124 Enables directory services authentication for users

Item Description

show ldap

Syntax

Display LDAP information show ldap

Example

ldap-group

Manage Virtual Connect directory groups.

Supported actions: add, help, remove, set, show

Item Description

add ldap-group

Syntax

Example

Item Description

remove ldap-group

Syntax Example

->show ldap

Add a new directory group to the directory services configuration

add ldap-group <GroupName> [Description=<string>] [Privileges=domain,server,network,storage]

->add ldap-group MyNewGroup Description="Test Group" Privileges=domain,server

Adds a new directory group

Remove an existing directory group

remove ldap-group <GroupName>

->remove ldap-group MyGroup

Removes a directory group

Command line 21

Item Description

set ldap-group

Syntax

Parameters: GroupName

Properties:

Description

Privileges

Example

Modify the properties of an existing directory group

set ldap-group <GroupName> [Description=<description>] [Privileges=<privileges>]

The name of an existing group to modify

A user-friendly description for the group A set of one or more privileges for the group. Valid values include any

combination of "domain","server","network", and "storage".

->set ldap-group MyGroup Description="Test Group" Privileges=domain,server,network

Modifies a directory group description and privileges

Item Description

show ldap-group

Syntax Example

mac-cache

Manage Ethernet MAC Cache failover settings.

Supported actions: help, set, show

Item Description

set mac-cache

Syntax Properties:

Enabled

Refresh

Examples:

Item Description

show mac-cache

Syntax Example

Display the existing directory groups

show ldap-group

->show ldap-group

Display LDAP group information

Modify Ethernet MAC Cache failover settings set mac-cache [Enabled=<true|false>] [Refresh=<interval>]

Enables or disables MAC cache failover. Valid values include "true" and "false". The refresh interval for the MAC Cache (in seconds). Valid values include integers

from 1-30.

->set mac-cache Enabled=true Enables MAC Cache Failover

->set mac-cache Enabled=true Refresh=10 Enables MAC Cache Failover and sets the refresh interval

Display Ethernet MAC Cache failover settings

show mac-cache

->show mac-cache

Displays Ethernet MAC Cache failover settings

Command line 22

network

Manage Virtual Connect Ethernet networks.

Supported actions: add, help, remove, set, show

Item Description

add network

Syntax

Parameters:

NetworkName

Properties:

UplinkSet

VLanID

State

SmartLink

Examples:

Item Description

remove network

Syntax Parameters:

NetworkName

Examples:

Item Description

set network

Syntax

Create a new Ethernet Network. After the network has been created, uplink ports can be added, if the network is not using a shared uplink port set.

add network <NetworkName> [UplinkSet=<UplinkSetName> VLanID=<VLanID>] [State=<Enabled|Disabled>] [SmartLink=<Enabled|Disabled>]

The unique name of the new network to create (required)

The name of an existing shared uplink port set to use with this new network (optional). If this property is specified, then a valid VLAN ID must also be provided.

The VLAN ID associated with the network (used with shared uplink port set only). The VLAN ID is a valid number between 1 and 4094.

Enables or Disables the network. Valid values are "Enabled" and "Disabled". The default value is "Enabled".

Enables or Disables the SmartLink capability for a port. Valid values are "Enabled" and "Disabled". The default value is "Disabled".

->add network MyNewNetwork Creates a new network, and then adds it to the domain

->add network MyNewNetwork2 UplinkSet=MyUplinkSet VLanID=145 Creates a new network and uses a shared uplink port set

->add network Network1 State=Disabled SmartLink=Enabled Creates a new network with SmartLink Enabled and Status Disabled

Remove a network from the domain remove network <NetworkName | *>

The name of an existing network in the domain

->remove network MyNetwork Removes a network

->remove network * Removes all networks

Modify an existing Ethernet network

set network <NetworkName> [Name=<NewName>] [State=<Enabled|Disabled>] [SmartLink=<Enabled|Disabled>]

Command line 23

Item Description

Parameters:

NetworkName

The name of an existing network to modify

Properties:

Name

State

SmartLink

The new name of the network Enables or disables the network. Valid values are "Enabled" and "Disabled" Enables or disables the SmartLink capability for a port

Examples:

->set network MyNetwork State=Disabled Disables an existing network named "MyNetwork"

->set network Blue Name=Red Changes the name of an existing network from "Blue" to "Red"

->set network GreenNetwork SmartLink=Enabled Enables the SmartLink feature on a specific network

Item Description

show network

Syntax Examples:

Display all Ethernet networks in the domain

show network [<NetworkName> | *]

->show network

Displays a summary listing of all networks

->show network * Displays detailed information for all networks

->show network MyNetwork Displays detailed information for a specific network

profile

Manage server profiles.

Supported actions: add, assign, help, remove, set, show, unassign

Item Description

add profile

Syntax

Parameters:

ProfileName

Options:

NoDefaultEnetConn

NoDefaultFcConn

Create a new server profile. After the profile has been created, the profile can then be configured using the "set" subcommand and additional network and fabric connections can also be added. The server profile can also be assigned to a device bay using the "assign" subcommand.

add profile <ProfileName> [-NoDefaultEnetConn] [-NoDefaultFcConn]

The unique name of the new server profile to create

Do not add default Ethernet Network connections when creating the server profile Do not add default FC SAN connections when creating the server profile

Command line 24

Item Description

Examples:

->add profile MyNewProfile Creates a new profile and adds it to the domain, using default connections

->add profile MyNewProfile2 -NoDefaultEnetConn Creates a new profile without adding default Ethernet connections

->add profile MyNewProfile2 -NoDefaultFcConn Creates a new profile without adding default FC connections

->add profile MyNewProfile2 -NoDefaultEnetConn

-NoDefaultFcConn

Creates a new profile without adding default Ethernet and FC connections

Item Description

assign profile

Syntax Parameters:

ProfileName

DeviceBay

Example

Assign a server profile to a device bay assign profile <ProfileName> <DeviceBay>

The unique name of the server profile to assign The device bay to assign the profile to, in the format:

EnclosureID:DeviceBayNumber

If EnclosureID is not specified it defaults to the local enclosure

->assign profile MyProfile1 enc0:1 Assigns a profile to device bay 1 of the primary enclosure

Item Description

remove profile

Syntax Examples:

Remove one or more server profiles from the domain

remove profile <ProfileName | *>

->remove profile MyProfile

Removes a server profile by name

->remove profile * Removes all server profiles

Item Description

set profile

Syntax Parameters:

ProfileName

Properties:

Name

Example

Modify properties of an existing server profile set profile <ProfileName> Name=<NewName>

The current name of the profile to modify

The new name of the server profile

->set profile MyProfile Name=MyNewProfileName Changes the name of a server profile

Command line 25

Item Description

show profile

Syntax Examples:

Display all server profiles that exist in the domain

show profile [<ProfileName> | *]

->show profile

Displays a summary listing of all server profiles

->show profile * Displays detailed information for all profiles

->show profile MyProfile Displays detailed information for a specific profile

Item Description

unassign profile

Syntax Parameters:

ProfileName

Example

Unassign a server profile from a device bay unassign profile <ProfileName>

The name of a server profile that is currently assigned to a device bay

->unassign profile MyProfile1 Unassigns a server profile from a device bay

server

Manage server blades.

Supported actions: help, poweroff, poweron, reboot, show

Item Description

poweroff server

Syntax

Parameters:

ServerID

Options:

Force

ForceOnTimeout

Timeout

Examples:

Power off one or more physical servers

poweroff server [<ServerID> | *] [-Force |

-ForceOnTimeout] [-timeout=<timeout>]

The reference ID of a physical server in the domain. The format of the server ID is

<EnclosureID:DeviceBay>

If the Enclosure ID is not provided, then the primary or local enclosure is used by default.

Forces a power off operation without waiting for the OS to shutdown gracefully. This option should only be used as a last resort because it can potentially cause data loss on the server.

Attempts a graceful power down, but if the server does not shutdown within the timeout period (default is 60 seconds), then the server will be forced to power off.

Specifies the timeout period (in seconds) to wait for the operation to complete (per server). The default timeout is 60 seconds.

Command line 26

Item Description

->poweroff server enc0:2 Shuts down a specific server in device bay 2 of an enclosure with ID enc0

->poweroff server enc0:2 -Force Forces a power off operation on a specific server (primary/local enclosure)

->poweroff server * Powers off all servers in the domain

->poweroff server enc0:* Powers off all servers in a specific enclosure

->poweroff server enc0:2 -ForceOnTimeout Attempts a graceful poweroff, but forces a shutdown if not completed within

timeout period

->poweroff server * -timeout=180 Shuts down all servers and specifies a custom timeout of 3 minutes

Item Description

poweron server

Syntax Parameters:

ServerID

Options:

Timeout

Examples:

Power on one or more physical servers poweron server [<ServerID> | *] [-timeout=<timeout>]

The reference ID of a server in the domain. The format of the server ID is <EnclosureID:DeviceBay>

The timeout period (in seconds) to wait for the operation to complete. The default timeout is 60 seconds.

->poweron server 2 Powers on the specific server in bay 2 of the primary enclosure

->poweron server * Powers on all servers in the domain

->poweron server enc0:* Powers on all servers in a specific enclosure

Item Description

reboot server

Syntax

Parameters:

ServerID

Options:

Force

Reboot one or more physical servers

reboot server [<ServerID>|*] [-Force] [-ForceOnTimeout] [-timeout=<timeout>

The reference ID of a server in the domain. The format of the server ID is <EnclosureID:DeviceBay>. If the Enclosure ID is not provided, then the primary or local enclosure (enc0) is used by default.

Forces a reboot operation without waiting for the OS to shutdown gracefully. This option should only be used as a last resort because it can potentially cause data loss on the server.

Command line 27

Item Description

ForceOnTimeout

Timeout

Examples:

Attempts a graceful power down, but if the server does not shutdown within the timeout period (default is 60 seconds), then the server will be forced to reboot.

Specifies the timeout period (in seconds) to wait for the operation to complete (per server). The default timeout is 60 seconds.

->reboot server 2 Reboots the specific server in device bay 2 of the primary enclosure

->reboot server enc0:2 -force Reboots a server using the force option

->reboot server * -ForceOnTimeout -timeout=180 Reboots all servers using the ForceOnTimeout option and a custom timeout

->reboot server * Reboots all servers in the domain

->reboot server enc0:* Reboots all servers in a specific enclosure

Item Description

show server

Syntax Parameters:

ServerID

Examples:

Display all servers in the domain show server [<ServerID> | *]

The reference ID of a server in the domain. The format of the server ID is

<EnclosureID:Bay>

->show server

Displays a summary listing of all servers

->show server * Displays detailed information for all servers

->show server enc0:4 Displays detailed information for the specific server in device bay 4 of an

enclosure named "MyEnclosure"

stackinglink

Display stacking link information and status.

Supported actions: help, show

Item Description

show stackinglink

Syntax Example

Display stacking links and their status

show stackinglink

->show stackinglink

Displays a summary listing of all stacking links and status

Command line 28

status

View overall domain status information.

Supported actions: help, show

Item Description

show status

Syntax Example

systemlog

View Virtual Connect Manager system event log.

Supported actions: help, show

Item Description

show systemlog

Syntax Example

Display the status of the domain and all components in the domain

show status

->show status

Displays domain status information

Display the Virtual Connect manager system log

show systemlog

->show systemlog

Displays the system log

uplinkport

Manage interconnect module uplink ports.

Supported actions: add, help, remove, set, show

Item Description

add uplinkport

Syntax

Parameters:

PortID

Properties:

Network

UplinkSet

Speed

Examples:

Add a new uplink port to an existing network or a shared uplink port set

add uplinkport <PortID> [Network=<NetworkName> | UplinkSet=<UplinkSet>] [Speed=<Auto|10Mb|100Mb|1Gb|Disabled>]

The ID of an uplink port to add (required). The name is actually a combination of the enclosure name, interconnect bay, and port number in a single descriptor. The format of the port name is "<EnclosureID>:<InterconnectBay>:<PortNumber>". If Enclosure ID is not specified, it defaults to the local enclosure.

The name of an existing network to which the port is added The name of an existing shared uplink port set to which the port is added Specifies the port speed for the port (optional). Acceptable values include Auto,

10Mb, 100Mb, 1Gb, and Disabled. If not specified, the default port speed is "Auto".

Command line 29

Item Description

->add uplinkport enc0:1:1 Network=MyNetwork Adds a new uplink port (Bay 1, Port 1) to a network

->add uplinkport enc0:2:4 Network=MyNetwork Speed=1Gb Adds a new uplink port (Bay 2, Port 4) to a network and sets the port speed

->add uplinkport enc0:2:3 UplinkSet=MyUplinkSet Adds a new uplink port (Bay 2, Port 3) to a shared uplink port set

Item Description

remove uplinkport

Syntax

Parameters:

PortID

Network

UplinkSet

Examples:

Remove an uplink port element from a network or a shared uplink port set

remove uplinkport <PortID> [Network=<NetworkName> | UplinkSet=<UplinkSetName>]

The name of the port to remove from a network. (required). The port name must be in the following format:

If EnclosureID is not specified, it defaults to the local enclosure. The name of the network from which the port is removed The name of the shared uplink port set from which the port is removed

->remove uplinkport enc0:1:2 Network=MyNetwork Removes a specific uplink port (Bay 1, Port 2) from a network

->remove uplinkport * Network=BlueNetwork Removes all uplink ports from a network named "BlueNetwork"

->remove uplinkport enc0:2:3 UplinkSet=SharedUplinkSet1 Removes a specific uplink port (Bay 2, Port 3) from a shared uplink set

Item Description

set uplinkport

Syntax

Parameters:

PortID

Properties:

Network

UplinkSet

Speed

Examples:

Modify an uplink port that exists as a member of a network or shared uplink port set

set uplinkport <PortID> [Network=<NetworkName> | UplinkSet=<UplinkSetName>] Speed=<Auto|10Mb|100Mb|1Gb|Disabled>

The name of the port to modify (required). The specified port must already be added to a network or uplink port set. The port name is in the format:

The name of the network to which the port belongs The name of the shared uplink port set to which the port belongs

Specifies the port speed for the port. Acceptable values include Auto, 10Mb, 100Mb, 1Gb, and Disabled.

->set uplinkport enc0:1:2 Network=MyNetwork Speed=1Gb Changes the port speed of a network port

Command line 30

Item Description

->set uplinkport enc0:2:1 Network=MyNetwork Speed=Disabled Disables a specific port that belongs to a network

->set uplinkport enc0:2:4 UplinkSet=MyUplinkSet Speed=Disabled

Disables a specific port that belongs to a shared uplink set

Item Description

show uplinkport

Syntax Example

uplinkset

Manage shared uplink port sets

Supported actions: add, help, remove, set, show

Item Description

add uplinkset

Syntax Parameters:

UplinkSetName

Example

Item Description

remove uplinkset

Syntax

Display all Ethernet module uplink ports

show uplinkport

->show uplinkport

Displays all uplink ports

Create a new shared uplink port set add uplinkset <UplinkSetName>

The unique name of the new shared uplink port set to create (required)

->add uplinkset MyNewUplinkSet Creates a new shared uplink port set and adds it to the domain

Remove a shared uplink port set from the domain remove uplinkset <UplinkSetName>

Parameters: UplinkSetName

Example

The name of an existing shared uplink port set

->remove uplinkset MyUplinkSet Removes a shared uplink port set

Item Description

set uplinkset

Syntax Parameters:

UplinkSetName

Properties:

Name

Example

Modify an existing shared uplink port set set uplinkset <UplinkSetName> [Name=<NewName>]

The name of an existing shared uplink set to modify

The new name of the shared uplink set

->set uplinkset Blue Name=Red Changes the name of an shared uplink set from "Blue" to "Red"

Command line 31

user

Item Description

show uplinkset

Syntax Examples:

Display shared uplink configurations

show uplinkset [<UplinkSetName> | *]

->show uplinkset

Displays a summary listing of all uplink sets

->show uplinkset * Displays detailed information for all shared uplink sets

->show uplinkset MyNetwork Displays detailed information for a specific shared uplink set

Manage local domain user configurations.

Supported actions: add, help, remove, set, show

Item Description

add user

Syntax

Properties:

Password

FullName

ContactInfo

Enabled Privileges

Examples:

Create a new user and add it to the Virtual Connect Manager database

add user <username> Password=<password> [<optional user properties>]

The password of the new user. The password of the new user can be entered as clear text in the command or as a masked string at the prompt.

The full name of the user (optional) Contact information for the user (optional) Enables or disables the user [true | false] (optional) The allowed privileges for the user (optional). Privileges can be any combination

of "domain", "server", "network", or "storage" separated by commas.

->add user steve Password=fgY87hHl Adds a new user by specifying the minimal amount of properties

->add user bill Password=HGtwf7272562 Privileges="domain,network" FullName="Bill Johnson" ContactInfo=billj@company.com Enabled=true

Adds a new user and configures additional user properties

->add user Admin Password=hjkhfd Privileges=* Adds an "Admin" user with all privileges

Item Description

remove user

Syntax Examples:

Remove a user from the Virtual Connect Manager database remove user <username>

Command line 32

Item Description

->remove user steve Removes a specific user by name

->remove user * Removes all users

Item Description

set user

Syntax Properties:

UserName

Password

FullName

ContactInfo

Enabled Privileges

Examples:

Modify attributes of an existing user set user <username> [<one or more user properties>]

The new name of the user The new password of the user can be entered as clear text in the command or as

a masked string at the prompt. If the Password value is blank, the user is prompted to enter the password at the prompt.

The full name of the user Contact information for the user Enables or disables the user [true | false] The allowed privileges for the user (optional). Privileges can be any combination

of "domain", "server", "network", "storage" separated by commas.

->set user steve Password=fgY87hHl Modifies an existing user's password

->set user steve Password Modifies an existing user's password, masked, at the prompt

->set user bill Password=HGtwf7272562 Privileges="domain,network" FullName="Bill Johnson" ContactInfo=billj@company.com Enabled=true

Modifies several properties of an existing user

->set user tom privileges=* Gives a user all privileges

Item Description

show user

Syntax Properties:

Privileges

FullName

ContactInfo

Enabled

Examples:

Display user summary or user details show user [<username>]

The allowed privileges for the user, which can be any combination of "domain", "server", "network", or "storage" separated by commas

The full name of the user Contact information for the user Specifies if the user is enabled or disabled

->show user Displays a listing of all existing users

Command line 33

vcm

Item Description

->show user steve Displays details of an existing user by name

->show user * Displays details of all existing users

Reset the Virtual Connect Manager.

Supported actions: help, reset

Item Description

reset vcm

Syntax reset vcm [-failover] Examples:

Reset the Virtual Connect Manager. A failover to the standby VCM may also be specified (optional), if there is a standby VCM available.

IMPORTANT: Resetting the VCM causes a temporary loss in connectivity with the Virtual Connect Manager. If failover is specified and there is a standby VCM, users are logged off and must reconnect using the standby VCM IP address.

->reset vcm Resets the Virtual Connect Manager

->reset vcm -failover Resets the Virtual Connect Manager and forces a failover to the standby

VCM (if available)

version

Display CLI version information.

Supported actions: help, show

Item Description

show version

Syntax Example

Help subsystem

The help subsystem consists of three options:

• Help summary—lists all supported actions and a short description of each:

>help (or ?) add add an element to an existing object assign assign a server profile to a device bay

Display CLI version information

show version

->show version

Displays CLI version and copyright information

Command line 34

. . .

• Subcommand help—displays help details associated with a specific subcommand, including

supported managed elements:

>assign -help (or assign ?) assign a server profile to a device bay

Managed Elements: profile

Examples: assign profile MyProfile enc0:1

• Management element help—provides a listing of objects that are supported with a specific

subcommand and a brief description of the management element and what it represents in the management model:

->help devicebay

General Enclosure Device Bay settings and information

Supported Subcommands: help show

-----------------------------------------------------------------------

->show devicebay -help

Description:

This command displays all device bays in the domain

Syntax:

show devicebay [<DeviceBayName> | *]

Parameters:

DeviceBayName : The reference name of a device bay in the domain. The format of the device bay name is <EnclosureID:DeviceBay>

Examples:

- Display a summary listing of all device bays:

->show devicebay

- Show detailed information for all device bays:

Command line 35

->show device bay *

- Show detailed information for a specific device bay 2 of a specific enclosure:

->show devicebay enc0:2

Output format

The CLI provides two different output formats:

• Interactive user output format

• Scriptable output format

The interactive user output format is the default. However, by using a command-line option, the user can also specify a "parse-friendly" output format, which provides data in a format that can be easily interpreted by automated scripts invoking the CLI. The different output formats primarily impact the show

Interactive user output format

subcommand in the CLI infrastructure, where a majority of the informational details are displayed.

The interactive user output format provides a user friendly view of information at the command line. When providing an overview, or listing, of several instances of data, a tabular text format is displayed. If an individual instance of data is being displayed, then the stanza format is used.

Example 1: Tabular text output format for displaying a user list

->show user

============================================================================

UserName Privileges FullName ContactInfo Enabled

============================================================================

Administrator domain Steve Johnson steve.johnson@hp.com true

server

network

storage

----------------------------------------------------------------------------

Admin domain Admin Admin true

server

network

storage

----------------------------------------------------------------------------

steve domain Steve Johnson steve.johnson@hp.com true

server

network

storage

----------------------------------------------------------------------------

Command line 36

brad domain Brad Mills brad.mills@hp.com true

server

----------------------------------------------------------------------------

jim network Jimmy Joe jimmy.joe@hp.com true

----------------------------------------------------------------------------

alice storage Alice Candle alice.candle@hp.com false

----------------------------------------------------------------------------

Example 2: Stanza output format for displaying a single user instance

->show user steve UserName : steve Privileges : domain,server,network,storage FullName : Steve Johnson ContactInfo : steve.johnson@hp.com Enabled : true

Example 3: Stanza output format for displaying all user details

->show user * UserName : Administrator Privileges : domain,server,network,storage FullName : Steve Johnson ContactInfo : steve.johnson@hp.com Enabled : true

UserName : Admin Privileges : domain,server,network,storage FullName : Admin ContactInfo : Admin Enabled : true

UserName : steve Privileges : domain,server,network,storage FullName : Steve Johnson ContactInfo : steve.johnson@hp.com Enabled : true

UserName : brad Privileges : domain,server FullName : Brad Mills ContactInfo : brad.mills@hp.com Enabled : true

UserName : jim Privileges : network FullName : Jimmy Joe ContactInfo : jimmy.joe@hp.com Enabled : true

Command line 37

UserName : alice Privileges : storage FullName : Alice Candle ContactInfo : alice.candle@hp.com Enabled : false

Scriptable output format

Scriptable output format allows scripts to invoke CLI commands and receive command responses that can be easily parsed by the scripts. This capability is provided by two options that are available: output=script1 and -output=script2. These options are described in more detail below. To display output with no headers or labels, use no-headers as an additional output option value.

IMPORTANT: If the delimiter is present within the data, then the entire value is surrounded by

• Script1 Output Format

double quotes.

The script1 output format can be used to format the output using a name-value pair format, using an equal sign as the delimiter. All text on the left side of the equal sign designates the "name" of a property, and the text on the right side of the equal sign designates the "value" of the property. If "no-headers" is provided as an additional option value, only the values are displayed. Each property is displayed on a separate line.

• Script2 Output Format

The script2 output format can be used to format all instance data in a single line, using a semi-colon as the delimiter for the data. The first line contains the property names. This format is consistent with a "table view" of the data, where the first line is represented by a list of column labels, while the remaining lines provide the actual data being displayed. Each line represents a single instance of data. For example, in the case of showing users, each line provides all data corresponding to a

single user instance. The following examples provide some common scenarios for using the script output format options. Example 1: Scriptable output format displaying all enclosures

->show enclosure -output=script1

ID=enc0

Name=Enclosure1

Import Status=Imported

Serial Number=USE0000BK2

Part Number=403321-021

Asset Tag=OA ASSET 453

Example 2: Scriptable output format displaying user "Administrator" information

->show user Administrator -output=script1

User Name=Administrator

Privileges=domain,server,network,storage

Full Name=

Contact Info=

Enabled=true

Command line 38

Example 3: Scriptable output format displaying all users (with table header)

->show user -output=script2

UserName;Privileges;FullName;ContactInfo;Enabled

Administrator;domain,server,network,storage;Steve