HP Virtual Connect Manager Command Line Interface User Guide Version 1.
© 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.
Contents Introduction .................................................................................................................................. 5 Virtual Connect overview............................................................................................................................ 5 Command line overview............................................................................................................................. 5 Command line syntax ....................................
Fibre Channel setup....................................................................................................................... 46 Server Profile setup ........................................................................................................................ 47 Logging out of the CLI .................................................................................................................... 50 Common management operations .....................................................
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.
• 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.
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: -
-> 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.
Command line Subcommands Command Description add Add a new object to the domain or to another object assign Assign a server profile to a server bay delete Delete the Virtual Connect domain configuration exit Exit the Virtual Connect Manager command-line shell help Display help for a command or object import Import an enclosure into the domain poweroff Power off one or more servers poweron Power on one or more servers reboot Reboot one or more servers remove Remove or delete an existing
Managed element Description ldap-group (on page 21) Manage LDAP group configuration settings mac-cache (on page 22) Manage Ethernet MAC cache failover settings network (on page 23) Manage Virtual Connect Ethernet networks profile (on page 24) Manage VC server profiles server (on page 26) Manage server blades in the enclosure device bays stackinglink (on page 28) Display stacking link information and status status (on page 29) Display overall domain status information systemlog (on page 29)
Supported actions: delete, help, set, show Item Description delete domain 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.
Item Description WwnPool 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. Examples: ->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.
Item Description Syntax import enclosure UserName= 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.
Item Description PXE 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. AddressType 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.
Item Description PXE 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.
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 fabric Manage Fibre Channel SAN fabrics.
fc-connection Manage Fibre Channel SAN fabric connections. Supported actions: add, help, set Item Description add fc-connection Add a new FC SAN connection to an existing server profile Syntax add fc-connection [Fabric=] [Speed=] Parameters: ProfileName The name of an existing profile to which the new connection is added. (required) Properties: Fabric The name of an existing fabric to associate with the connection.
Item Description Syntax set fc-connection [Fabric=] [Speed=] [BootPriority=] [BootPort=] [BootLun=] Parameters: ProfileName The name of the server profile that contains the connection to modify Port The port number of the connection being modified Properties: Fabric The name of the FC SAN fabric to associate with the connection Speed The port speed of the FC SAN connection.
Item Description update firmware Update the firmware on all Virtual Connect modules in the domain Syntax update firmware url= Example ->update firmware url=http://www.myserver.com/fw/vc-1.20.rom Updates the firmware on all Virtual Connect modules in the domain igmp Manage Ethernet IGMP Snooping settings.
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 Display all interconnect modules known to the domain Syntax show interconnect [ModuleID|*] Examples: ->show interconnect
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 The target domain name. The maximum length is 64 characters.
Item Description set ldap-group Modify the properties of an existing directory group Syntax set ldap-group [Description=] [Privileges=] Parameters: GroupName The name of an existing group to modify Properties: Description A user-friendly description for the group Privileges A set of one or more privileges for the group. Valid values include any combination of "domain","server","network", and "storage".
network Manage Virtual Connect Ethernet networks. Supported actions: add, help, remove, set, show Item Description add network 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.
Item Description Parameters: NetworkName The name of an existing network to modify Properties: Name The new name of the network State Enables or disables the network.
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
Item Description show profile Display all server profiles that exist in the domain Syntax show profile [ | *] Examples: ->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 Unassign a server profile from a device bay Syntax unassign profile Parameters: ProfileName The name of a serv
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 * -timeo
Item Description ForceOnTimeout 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. Timeout Specifies the timeout period (in seconds) to wait for the operation to complete (per server). The default timeout is 60 seconds.
status View overall domain status information. Supported actions: help, show Item Description show status Display the status of the domain and all components in the domain Syntax show status Example ->show status Displays domain status information systemlog View Virtual Connect Manager system event log.
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 Remove an uplink port element from a network or a shared uplink port set Syntax remove uplinkport [Networ
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 Display all Ethernet module uplink ports Syntax show uplinkport Example ->show uplinkport Displays all uplink ports uplinkset Manage shared uplink port sets Supported actions: add, help, remove, set, show Item Descrip
Item Description show uplinkset Display shared uplink configurations Syntax show uplinkset [ | *] Examples: ->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 user Manage local domain user configurations.
Item Description ->remove user steve Removes a specific user by name ->remove user * Removes all users Item Description set user Modify attributes of an existing user Syntax set user [] Properties: UserName The new name of the user Password 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.
Item Description ->show user steve Displays details of an existing user by name ->show user * Displays details of all existing users vcm Reset the Virtual Connect Manager. Supported actions: help, reset Item Description reset vcm 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.
. . .
->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.
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.
UserName Privileges FullName ContactInfo Enabled : : : : : alice storage Alice Candle alice.candle@hp.com 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.
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 Johnson;steve.johnson@hp.com;true Admin;domain,server,network,storage;Admin;Admin;true steve;domain,server,network,storage;Steve Johnson;steve.johnson@hp.
Configuring the Virtual Connect domain using the CLI Basic configuration A Virtual Connect domain consists of an enclosure and a set of associated modules and server blades that are managed together by a single instance of the Virtual Connect Manager. The Virtual Connect domain contains specified networks, server profiles, and user accounts that simplify the setup and administration of server connections.
password: • LDAP Authentication >ssh 192.168.0.120 login as: password: Domain setup A Virtual Connect domain consists of an enclosure and a set of associated modules and server blades that are managed together by a single instance of the Virtual Connect Manager. the Virtual Connect domain contains specified networks, server profiles, and user accounts that simplify the setup and administration of server connections.
>add user bob password=fhkjdhfk privileges=domain,network • Modify an existing user >set user bob fullname="Bob J Smith" enabled=false • Remove an existing user >remove user bob • Remove all local users except for the Administrator account >remove user * Display local users: • Summary display >show user • Detailed display >show user * • Displaying info on a single user >show user steve Up to 32 local user accounts can be created.
It is possible to create a user with no privileges. This user can only view status and settings. NOTE: The vcmuser_ account is an internal Onboard Administrator account created and used by Virtual Connect Manager to communicate with the Onboard Administrator. This account can show up in the Onboard Administrator system log. This account cannot be changed or deleted. Configuring LDAP authentication support for users • Set LDAP properties >set ldap ipaddress=192.168.0.
override the factory default MAC addresses while the server remains in that Virtual Connect enclosure. When configured to assign MAC addresses, Virtual Connect securely manages the MAC addresses by accessing the physical NICs through the enclosure Onboard Administrator and the iLO interfaces on the individual server blades. Always establish control processes to ensure that a unique MAC address range is used in each Virtual Connect domain in the environment.
Creating an enet-network To create a new Ethernet network use the add network command: >add network MyNetworkName Modifying enet-network properties To modify Ethernet network properties, use the set network command: >set network MyNetworkName state=enabled name=NewName smartlink=enabled Displaying enet-networks To display Ethernet network properties, use the show network command: • Summary display >show network • Detailed display >show network * • Single network display > show network MyNetwork Add
Because VLAN tags are added or removed when Ethernet packets leave or enter the VC-Enet shared uplink, the VLAN tags have no relevance after the Ethernet packet enters the enclosure. IMPORTANT: If you are deploying a server where VLAN tags will be used (added) on the server itself, do not connect the server Ethernet port carrying VLAN-tagged traffic to a shared uplink set. Identifying an associated network as the native VLAN causes all untagged incoming Ethernet packets to be placed onto this network.
accessing the physical FC HBA through the enclosure Onboard Administrator and the iLO interfaces on the individual server blades. When assigning WWNs to a FC HBA port, Virtual Connect will assign both a port WWN and a node WWN. Because the port WWN is typically used for configuring fabric zoning, it is the WWN displayed throughout the Virtual Connect user interface. The assigned node WWN is always the same as the port WWN incremented by one.
Virtual Connect v1.20 adds the ability to configure PXE settings when using either VC Assigned or factory default MAC addresses. In addition, Use BIOS is a new option for PXE, which maintains the current settings as configured by RBSU. A new feature in Virtual Connect v1.20 is the ability to override the Virtual Connect assigned MACs and/or WWNs when creating a new profile.
If a server blade is inserted into a device bay already assigned a server profile, Virtual Connect Manager automatically updates the configuration of that server blade before it is allowed to power up and connect to the network. If a server blade is moved from a Virtual Connect managed enclosure to a non-Virtual Connect enclosure, local MAC addresses and WWNs are automatically returned to the original factory defaults.
IGMP allows VC-Enet modules to monitor (snoop) the IP multicast membership activities and to configure hardware Layer 2 switching behavior of multicast traffic to optimize network resource usage. Currently only IGMP v1 and v2 (RFC2236) are supported. The IGMP Snooping idle timeout interval is set to 260 seconds by default. This value is basically the "Group Membership Interval" value as specified by IGMP v2 specification (RFC2236).
Operation Examples Display stacking link configuration and status >show stackinglink Display the system log >show systemlog Display a list of servers in the domain • Summary display >show server • Detailed display >show server * • Single server display >show server enc0:1 >show server 2 Display server profiles • Summary display >show profile • Detailed display >show profile * • Single profile display >show profile MyProfile Delete the domain configuration >delete domain Update intercon
alternate Virtual Connect Ethernet module. This feature can be useful when troubleshooting the Virtual Connect manager. The network and FC processing of the Virtual Connect subsystem is not disturbed during the restart or failover of the Virtual Connect Manager.
Technical support Before you contact HP Be sure to have the following information available before you call HP: • Technical support registration number (if applicable) • Product serial number • Product model name and number • Product identification number • Applicable error messages • Add-on boards or hardware • Third-party hardware or software • Operating system type and revision level HP contact information For the name of the nearest HP authorized reseller: • In the United States, see
Acronyms and abbreviations BIOS Basic Input/Output System CLI Command Line Interface DHCP Dynamic Host Configuration Protocol DNS domain name system FC Fibre Channel HBA host bus adapter I/O input/output IGMP Internet Group Management Protocol IP Internet Protocol iSCSI Internet Small Computer System Interface LUN logical unit number MAC Media Access Control Acronyms and abbreviations 54
PXE Preboot Execution Environment SAN storage area network SSH Secure Shell VCM Virtual Connect Manager WWN World Wide Name WWPN worldwide port name Acronyms and abbreviations 55
Index A H authorized reseller 53 help command 34 help resources 53 B basic configuration 40 C CLI command execution modes 7 command line overview 5 command line syntax 6 common management operations 50 configuring LDAP 43 configuring the Virtual Connect domain 40 configuring, user accounts 41 D devicebay command 10 domain command 10 domain name 41 domain setup 41 E enclosure command 12 e-net networks, displaying 45 enet-connection command 13 enet-network connections, adding to a profile 49 enet-netwo
R remote access 8 resetting Virtual Connect Manager 51 S scriptable output format 38 server command 26 server profile, assigning to a device bay 49 setting the domain name 41 shared uplink port set, creating 45 shared uplink port sets, displaying 46 stackinglink command 28 status command 29 subcommands 9 systemlog command 29 T technical support 53 U uplink port properties, modifying 45 uplink ports, adding 45 uplink ports, adding to shared uplink port set 46 uplinkport command 29 uplinkset command 31 use
