This document contains user information for the HP Virtual Connect Manager version 4.20 CLI. 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.
Part Number: 762319-001
April 2014
Edition: 1
© Copyright 2014 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®, Windows®, and Windows NT® are U.S. registered trademarks of Microsoft Corporation. RedHat® is a registered trademark of Red Hat, Inc. in the United States and other countries.
Contents |
|
Introduction.................................................................................................................................. |
6 |
What's new.............................................................................................................................................. |
6 |
Changes from VC 4.10 to VC 4.20 ................................................................................................... |
7 |
Unassigning multiple profiles ...................................................................................................................... |
9 |
Supporting comments and blank lines in CLI scripts........................................................................................ |
9 |
Virtual Connect overview.......................................................................................................................... |
10 |
Using multiple enclosures................................................................................................................ |
12 |
CLI command execution modes ................................................................................................................. |
12 |
Remote access to the Virtual Connect Manager ........................................................................................... |
13 |
Command output filtering ......................................................................................................................... |
14 |
Command line overview........................................................................................................................... |
14 |
Command line syntax .............................................................................................................................. |
14 |
Options........................................................................................................................................ |
15 |
Properties ..................................................................................................................................... |
15 |
Command batching ....................................................................................................................... |
15 |
Command line............................................................................................................................ |
17 |
Subcommands ........................................................................................................................................ |
17 |
Managed elements.................................................................................................................................. |
17 |
activity ......................................................................................................................................... |
20 |
all ............................................................................................................................................... |
20 |
auto-deployment............................................................................................................................ |
20 |
banner ......................................................................................................................................... |
22 |
cli................................................................................................................................................ |
23 |
config .......................................................................................................................................... |
23 |
configbackup................................................................................................................................ |
24 |
connection-map............................................................................................................................. |
26 |
devicebay .................................................................................................................................... |
27 |
domain ........................................................................................................................................ |
27 |
enclosure...................................................................................................................................... |
30 |
enet-connection ............................................................................................................................. |
32 |
enet-vlan ...................................................................................................................................... |
35 |
external-manager .......................................................................................................................... |
37 |
fabric........................................................................................................................................... |
39 |
fc-connection................................................................................................................................. |
42 |
fcoe-connection ............................................................................................................................. |
45 |
firmware ...................................................................................................................................... |
49 |
igmp-group................................................................................................................................... |
49 |
igmp............................................................................................................................................ |
49 |
interconnect-mac-table.................................................................................................................... |
50 |
interconnect .................................................................................................................................. |
51 |
iscsi-boot-param ............................................................................................................................ |
52 |
iscsi-connection ............................................................................................................................. |
55 |
lacp-timer ..................................................................................................................................... |
58 |
ldap-certificate .............................................................................................................................. |
58 |
ldap-group.................................................................................................................................... |
60 |
ldap ............................................................................................................................................ |
61 |
Contents |
3 |
link-dist-interval.............................................................................................................................. |
62 |
lldp.............................................................................................................................................. |
63 |
local-users .................................................................................................................................... |
63 |
log-target...................................................................................................................................... |
64 |
loop-protect .................................................................................................................................. |
66 |
mac-cache .................................................................................................................................... |
67 |
mcast-filter-rule .............................................................................................................................. |
67 |
mcast-filter-set................................................................................................................................ |
68 |
mcast-filter .................................................................................................................................... |
70 |
mfs-filter ....................................................................................................................................... |
72 |
nag-network.................................................................................................................................. |
72 |
name-server .................................................................................................................................. |
74 |
network-access-group ..................................................................................................................... |
74 |
network-range ............................................................................................................................... |
75 |
network........................................................................................................................................ |
78 |
port-monitor .................................................................................................................................. |
83 |
port-protect ................................................................................................................................... |
85 |
profile .......................................................................................................................................... |
86 |
qos-class ...................................................................................................................................... |
91 |
qos-classifier ................................................................................................................................. |
93 |
qos-map ....................................................................................................................................... |
94 |
qos.............................................................................................................................................. |
95 |
radius-group ................................................................................................................................. |
97 |
radius .......................................................................................................................................... |
98 |
role ............................................................................................................................................. |
99 |
server-port-map-range................................................................................................................... |
100 |
server-port-map ........................................................................................................................... |
101 |
server-port .................................................................................................................................. |
103 |
server ........................................................................................................................................ |
104 |
serverid...................................................................................................................................... |
106 |
session....................................................................................................................................... |
107 |
sflow.......................................................................................................................................... |
108 |
sflow-module............................................................................................................................... |
108 |
sflow-ports .................................................................................................................................. |
110 |
sflow-receiver .............................................................................................................................. |
112 |
snmp-access................................................................................................................................ |
114 |
snmp-trap ................................................................................................................................... |
115 |
snmp ......................................................................................................................................... |
117 |
ssh............................................................................................................................................. |
118 |
ssl-certificate ............................................................................................................................... |
119 |
ssl-csr ......................................................................................................................................... |
120 |
ssl ............................................................................................................................................. |
123 |
stackinglink................................................................................................................................. |
123 |
statistics...................................................................................................................................... |
124 |
statistics-throughput ...................................................................................................................... |
126 |
status ......................................................................................................................................... |
127 |
storage-management.................................................................................................................... |
128 |
supportinfo ................................................................................................................................. |
129 |
systemlog ................................................................................................................................... |
130 |
tacacs ........................................................................................................................................ |
131 |
uplinkport ................................................................................................................................... |
132 |
uplinkset..................................................................................................................................... |
135 |
user-security ................................................................................................................................ |
137 |
|
Contents 4 |
user ........................................................................................................................................... |
138 |
vcm ........................................................................................................................................... |
140 |
version....................................................................................................................................... |
141 |
User roles............................................................................................................................................. |
141 |
Help subsystem ..................................................................................................................................... |
147 |
Output format ....................................................................................................................................... |
148 |
Interactive user output format ........................................................................................................ |
149 |
Scriptable output format ............................................................................................................... |
150 |
Statistics descriptions ............................................................................................................................. |
152 |
Ethernet modules ......................................................................................................................... |
152 |
Fibre Channel modules................................................................................................................. |
162 |
Configuring the Virtual Connect domain using the CLI................................................................... |
167 |
Basic configuration................................................................................................................................ |
167 |
Logging in to the CLI .................................................................................................................... |
167 |
Domain setup.............................................................................................................................. |
168 |
Network setup............................................................................................................................. |
173 |
Server VLAN Tagging Support ...................................................................................................... |
177 |
Fibre Channel setup..................................................................................................................... |
178 |
Serial number settings .................................................................................................................. |
179 |
Server profile setup...................................................................................................................... |
180 |
Server profile setup...................................................................................................................... |
182 |
Logging out of the CLI .................................................................................................................. |
194 |
Common management operations ........................................................................................................... |
194 |
Port status conditions ............................................................................................................................. |
195 |
Resetting the Virtual Connect Manager..................................................................................................... |
195 |
Support and other resources ...................................................................................................... |
197 |
Before you contact HP............................................................................................................................ |
197 |
HP contact information........................................................................................................................... |
197 |
Acronyms and abbreviations...................................................................................................... |
198 |
Documentation feedback ........................................................................................................... |
202 |
Index....................................................................................................................................... |
203 |
Contents 5
The command line interface user guide contains the following changes for VC 4.20:
•Added the following managed elements: o cli (on page 23)
o sflow (on page 108)
o sflow-module (on page 108) o sflow-ports (on page 110)
o sflow-receiver (on page 112)
•Updated the Ethernet uplink port speed selection to include 40Gb in the following commands: o port-monitor (on page 83)
o uplinkport (on page 132)
•VC 4.20 supports the HP VC FlexFabric-20/40 F8 Module.
•The following commands support an uplink port label of Qx:y: o lldp (on page 63)
o port-monitor (on page 83) o statistics (on page 124)
o statistics-throughput (on page 126) o uplinkport (on page 132)
•Updated the following commands to include the "Pool-Specified" option: o enet-connection (on page 32)
o fc-connection (on page 42)
o fcoe-connection (on page 45) o iscsi-connection (on page 55) o profile (on page 86)
•Updated the following command to include the -fip_snooping option: o show interconnect ("interconnect" on page 51)
Introduction 6
Command |
Changes |
Virtual Connect 4.10 |
Virtual Connect 4.20 |
|
|
|
|
set cli |
The new managed |
Not supported |
Both of these commands |
help cli |
element modifies |
|
are supported. |
|
command execution |
|
|
|
behavior in script |
|
|
|
mode and |
|
|
|
auto-deployment. |
|
|
set sflow |
The new managed |
Not supported |
All of these commands are |
show sflow |
element configures |
|
supported. |
help sflow |
the existing VC |
|
|
|
Ethernet network used |
|
|
|
to send datagrams to |
|
|
|
the receiver. |
|
|
help sflow-module |
The new managed |
Not supported |
All of these commands are |
reset sflow-module |
element configures |
|
supported. |
set sflow-module |
the network settings |
|
|
show sflow-module |
for the network |
|
|
|
interface created for |
|
|
|
sflow. |
|
|
add sflow-ports |
The new managed |
Not supported |
All of these commands are |
help sflow-ports |
element configures |
|
supported. |
remove sflow-ports |
the ports to be |
|
|
set sflow-ports |
sampled or polled for |
|
|
show sflow-ports |
a receiver. |
|
|
add sflow-receiver |
The new managed |
Not supported |
All of these commands are |
remove sflow-receiver |
element configures |
|
supported. |
help sflow-receiver |
the receivers. |
|
|
set sflow-receiver |
|
|
|
show sflow-receiver |
|
|
|
show lldp |
Modified the |
show lldp <PortID> |
show lldp <PortID> |
reset statistics |
commands to include |
where the format of the |
where the format of the |
show statistics |
QSFP+ uplink ports |
<PortID> is |
<PortID> is |
add uplinkport |
|
<EnclosureID>:<Int |
<EnclosureID>:<Int |
remove uplinkport |
|
erconnectBay>:<Por |
erconnectBay>:<Por |
set uplinkport |
|
tLabel> |
tLabel>. |
show uplinkport |
|
|
For QSFP+ ports, the |
|
|
|
<PortLabel> format is |
|
|
|
Q<x>.<y>. |
Introduction 7
Command |
Changes |
Virtual Connect 4.10 |
Virtual Connect 4.20 |
|
|
|
|
add port-monitor |
Modified the |
add port-monitor |
add port-monitor |
remove port-monitor |
commands to include |
[AnalyzerPort=<Por |
[AnalyzerPort=<Por |
set port-monitor |
QSFP+ uplink ports in |
tID>] |
tID>] |
|
the AnalyzerPort |
[Speed=<Auto|10Mb| |
[Speed=<Auto|10Mb| |
|
100Mb|1Gb|10Gb|Dis |
100Mb|1Gb|10Gb|40G |
|
|
property |
abled>] |
b|Disabled>] |
|
|
[Duplex=<Auto|Half |
[Duplex=<Auto|Half |
|
|
|Full>] |
|Full>] |
|
|
[MonitorPort=<Port |
[MonitorPort=<Port |
|
|
ID>] |
ID>] |
|
|
[Direction=<ToServ |
[Direction=<ToServ |
|
|
er|FromServer|Both |
er|FromServer|Both |
|
|
>] |
>] |
|
|
where the format of the |
where the format of the |
|
|
network analyzer |
network analyzer |
|
|
<PortID> is |
<PortID> is |
|
|
<EnclosureID>:<Int |
<EnclosureID>:<Int |
|
|
erconnectBay>:<Por |
erconnectBay>:<Por |
|
|
tNumber> |
tNumber>. |
|
|
|
For QSFP+ ports, the |
|
|
|
<PortNumber> format is |
|
|
|
Q<x>.<y>. |
add port-monitor |
Modified the |
[Speed=<Auto|10Mb| |
[Speed=<Auto|10Mb| |
set port-monitor |
commands to include |
100Mb|1Gb|10Gb|Dis |
100Mb|1Gb|10Gb|40G |
add uplinkport |
the "40Gb" speed |
abled>] |
b|Disabled>] |
set uplinkport |
type |
|
|
show config |
The |
Not available |
Available |
|
includePoolInfo |
|
|
|
option provides |
|
|
|
VC-defined |
|
|
|
addresses and |
|
|
|
user-defined |
|
|
|
addresses for |
|
|
|
profiles, to be used to |
|
|
|
restore the profiles |
|
|
|
while maintaining the |
|
|
|
pool-specified IDs. |
|
|
add profile |
The |
Not available |
Available |
add enet-connection |
PoolSpecified |
|
|
add fc-connection |
option supports |
|
|
add fcoe-connection |
creating a profile and |
|
|
add iscsi-connection |
its connections with |
|
|
|
pool-specified |
|
|
|
addresses, if |
|
|
|
available in the |
|
|
|
specified domain |
|
|
|
pool. |
|
|
show interconnect |
The |
Not available |
Available |
|
-fip_snooping |
|
|
|
option displays FIP |
|
|
|
snooping information |
|
|
|
for the specified |
|
|
|
interconnect module. |
|
|
Introduction 8
The unassign profile command includes the ability to unassign multiple profiles from device bays with a single command.
The following example illustrates four server profiles being unassigned from device bays with a single CLI command. If an operation fails on one of the device bays, an error message appears for that server or device
bay, but the remaining operations continue.
->unassign profile *
SUCCESS: Profile1 unassigned from device bay enc0:1 SUCCESS: MyProfile2 unassigned from device bay enc0:2 SUCCESS: GreenProfile unassigned from device bay enc0:3 SUCCESS: RedProfile unassigned from device bay enc0:4
The CLI supports command scripts that contain blank lines and comments. Support for comments and blank lines enables you to maintain descriptive notes within the configuration script.
The following sample script illustrates a CLI script that contains this type of formatting. All comment lines must begin with "#".
#------------------------------------------------------------------------
#This is my sample Virtual Connect Domain Configuration Script
#Revision 1.0.1.2
#February 15, 2014
#------------------------------------------------------------------------
# Add Users
add user SomeNetworkUser password=pass1 role=network add user SomeStorageUser password=pass2 role=storage add user SomeDomainUser password=pass6 role=domain add user SomeAdminUser password=pass3 role=*
add user DomainNetworkUser password=764dhh role=domain,network
#Add Profiles with Default VC-Enet and VC-FC Connections add profile MyProfile
add profile AnotherProfile add profile Profile45
#Add VC-Enet Networks
add network MyNetwork add network Network2
Introduction 9
# Add uplink ports to the networks
add uplinkport enc0:1:1 network=MyNetwork add uplinkport enc0:1:2 network=Network2
#Create a Shared Uplink Port Set add uplinkset SharedSet1
#Add a new FCoE SAN fabric connection to a profile add fcoe-connection MyNewProfile Fabric=SAN_5
#Reset the active QoS configuration type to the factory default settings but does not change the saved configuration types
reset qos -active
#Set the domain default LACP timer to the short setting (one second) set lacp-timer default=Short
#Add a Multicast Filter "filter1" to Filterset "mfs1"
add mfs-filter FilterSet=mfs1 McastFilter =filter1
#Set the global option to enable the loop protection and pause flood protection set port-protect networkLoop=Enabled PauseFlood=Enabled
#Set idle user sessions to expire after 20 minutes of inactivity
set session Timeout=20
#Create a new Multicast Filter and adds it to the domain add mcast-filter MyMcastFilter
#Assign a profile to a device bay
assign profile MyProfile enc0:1
# Done!!!
HP Virtual Connect is a set of interconnect modules and embedded software for HP BladeSystem c-Class enclosures. VC simplifies the setup and administration of server connections and includes the following components:
Introduction 10
•VC-Enet modules
o HP VC Flex-10 10Gb Ethernet Module for BladeSystem c-Class
o HP VC FlexFabric 10Gb/24-port Module for BladeSystem c-Class, which provides the capability to configure Ethernet and FC/FCoE or iSCSI connections
o HP VC FlexFabric-20/40 F8 Module for BladeSystem c-Class, which provides the capability to configure Ethernet and FC/FCoE or iSCSI connections
o HP VC Flex-10/10D Module for BladeSystem c-Class
NOTE: Using a Flex-10 capable NIC with an HP VC Flex-10 or FlexFabric module provides the ability to divide a 10Gb NIC into four FlexNICs with configurable bandwidth.
•VC-FC modules
o HP VC 4Gb Fibre Channel Module for BladeSystem c-Class (enhanced NPIV) o HP VC 8Gb 24-Port Fibre Channel Module for BladeSystem c-Class
o HP VC 8Gb 20-Port Fibre Channel Module for BladeSystem c-Class
Please note this document may have references to yet to be announced products. For details, please contact your HP representative.
•HP VCM
NOTE: Beginning with VC 4.10, the HP 4GB Virtual Connect Fibre Channel Module is no longer supported.
VC implements server edge virtualization between the server and the data center infrastructure so networks can communicate with individual servers or pools of HP BladeSystem server blades. Upgrade, replace, or move server blades within the enclosures without visible changes to the external LAN and SAN environments. The external networks connect to a shared resource server pool rather than to individual servers. VC cleanly separates server enclosure administration from LAN and SAN administration.
VCM is embedded on VC-Enet modules. Access VCM through a web-based GUI or CLI. The Onboard Administrator provides a web link to the VC GUI. The CLI can be accessed remotely through any SSH session or through the Onboard Administrator CLI.
The VC modules support the HP BladeSystem c7000 Enclosure, the HP BladeSystem c3000 Enclosure, and all server blades and networks contained within the enclosure. FlexFabric 10 Gb modules are supported only in BladeSystem c7000 enclosures with G6 or newer server blades or Integrity i2 and i4 server blades with VC firmware v3.15 and later. FlexFabric-20/40 F8 modules are supported only with v4.20 and later on the following HP BladeSystem c-Class c7000 enclosure SKUs: 507014-B21, 507015-B21, 507016-B21, 507017-B21, 507019-B21, 681840-B21, 681842-B21 and 681844-B21. For information on updated SKUs, see the QuickSpecs on the HP website (http://www.hp.com/go/productbulletin).
VC-Enet modules enable connectivity to data center Ethernet switches. VC-Enet modules can also be directly connected to other types of devices, such as printers, laptops, rack servers, and network storage devices.
The VC-FC and FlexFabric modules enable connectivity of the enclosure to data center FC switches. Every FC fabric is limited in the number of switches it can support, but the VC-FC and FlexFabric modules do not appear as switches to the FC fabric and do not count against FC fabric limits.
A basic VC domain includes a single HP c-Class BladeSystem c7000 Enclosure for a total of 16 servers (or up to 32 servers if the double-dense option is enabled), or a single HP c-Class BladeSystem c3000 Enclosure for a total of 8 servers (or up to 16 servers if the double-dense option is enabled). For more information on the double-dense option, see "Double-dense server bay option" in the user guide. Within the domain, any
Introduction 11
server blade with the requisite LAN or SAN devices can access any LAN or SAN connected to a VC module, and a server blade of a given processor type (Integrity or X86) can be used as a spare for any server blade of the same processor type within the same enclosure, as long as the server has the requisite number and type of connections. Using the network access groups feature, the network administrator can clearly define a separation of networks based on their allowed functionality and prevent the server administrator from assigning specific network combinations in the same server profile.
By stacking (cabling) the VC-Enet modules together within the domain and connecting the VC-FC or FlexFabric module FC uplinks on the same bay of all enclosures to the same FC switch, every server blade in the domain can be configured to access any external network or fabric connection. With this configuration, you can use VCM to deploy and migrate a server blade profile to any server in the Virtual Connect domain without changing external LAN or SAN configurations.
Beginning with VC 4.10, the FTP service on VC-Enet modules is disabled by default. The VCSU software temporarily enables and disables the FTP service during firmware upgrades of VC-FC modules as needed. More recent versions of VC use SFTP instead of FTP for firmware upgrades.
Each version of VC is tested and supported with one or more SPPs. For a list of supported SPPs that must be installed, see the VC release notes.
Multiple enclosure support enables up to four c7000 enclosures to be managed within a single VC domain for a total of 128 servers, if double-dense support is enabled while using the Domain Setup Wizard. There are 16 half-height or 8 full-height server bays in a c7000 enclosure. A combination of full-height and half-height servers can be used in the same enclosure.
Multiple enclosure domains are not supported on c3000 enclosures. The VC-Enet modules use stacking cables between enclosures so that network traffic can be routed from any server Ethernet port to any uplink within the VC domain. Since FC does not support stacking, the VC-FC or FlexFabric module FC uplinks on the same bay of all enclosures must be connected to the same FC switch to enable profile mobility.
The management interfaces for all enclosure Onboard Administrators and VC modules within the same VC domain must be on the same lightly loaded subnet and highly reliable network. Overloads or loss of connectivity can disable configuration attempts until the connectivity is re-established and synchronized with the domain. HP recommends that the Onboard Administrator IP addresses used be static. The Onboard Administrator user credential for all enclosures must be consistent to enable VCSU firmware updates for VC modules in the remote enclosures. All FC-capable modules in the same horizontally adjacent bay pair (bays 1-2, 3-4, and so on) must be of the same type and position in all enclosures.
Multi-enclosure double-dense domains require similar and compatible VC-FC modules in bays 5, 6, 7, and 8 in all enclosures if FC connectivity is required. If a multi-enclosure double-dense configuration contains incompatible VC-FC modules in bays 5, 6, 7, or 8 in the local or remote enclosures, some or all of the compatible VC-FC modules in the remote enclosures might be designated INCOMPATIBLE after import.
The Virtual Connect Manager CLI provides two different methods for executing commands: interactive shell mode and script mode. Script mode is the same as non-interactive mode.
Interactive Shell Mode
This mode is used to invoke CLI command operations with the dedicated management shell. The shell is provided after you log in with valid credentials, and only accepts known VCM CLI commands as input.
Introduction 12
Press the Tab key to auto complete subcommands and managed-elements. You can also type characters and then press the Tab key to see a narrowed-down list of command options.
You can quit the shell by using the exit command. See the example of logging in to the interactive
management shell below. In the example, the primary VCM is located at IP address 192.168.0.120.
>ssh 192.168.0.120
login as: michael password: ***********
--------------------------------------------------------------------
HP Virtual Connect Management CLI v4.20
(C) Copyright 2006-2014 Hewlett-Packard Development Company, L.P. All Rights Reserved
--------------------------------------------------------------------
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
->
Script Mode
In some cases, you 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. See the example of how to use the script mode for CLI command execution below. In the example, the primary VCM is located
at IP address 192.168.0.120.
->ssh Administrator@192.160.0.120 show enclosure <command output displayed to user's screen>
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 more information on configuring the SSH keys, see the HP Virtual Connect for c-Class BladeSystem User Guide on the HP website (http://www.hp.com/go/vc/manuals).
To access the VCM CLI remotely through any SSH session:
1.Using any SSH client application, start an SSH session to the Virtual Connect Manager.
2.When prompted, enter the assigned IP address or DNS name of the Virtual Connect Manager.
3.Enter a valid user name.
4.Enter a valid password. The CLI command prompt appears.
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.
To access the VCM CLI remotely through the Onboard Administrator CLI, run the connect interconnect command from the Onboard Administrator CLI.
Introduction 13
The CLI provides output filtering capabilities that enable you to display only properties of interest. This feature is useful for filtering large amounts of output data for specific information. One or more properties can be specified in the output filtering rules.
The following examples illustrate some common usage scenarios for output filtering:
Example 1: Displaying all enabled users
->show user enabled=true
Example 2: Displaying all VC Ethernet modules
->show interconnect type=VC-ENET
Example 3: Displaying all external uplinks that have a link established
->show uplinkport status=linked
Example 4: Displaying all uplink ports with connector type of RJ-45 and speed configured to Auto
->show uplinkport type=RJ45 Speed=Auto
Example 5: Displaying all servers currently powered on
->show server power=On
The VCM Command Line Interface can be used as an alternative method for administering the VCM. Using the CLI can be useful in the following scenarios:
•You can develop tools that utilize VCM functions for data collection and for executing provisioning and configuration tasks.
•When no browser is available or you prefer to use a command line interface, you can access management data and perform configuration tasks.
•You can batch commands using script files. These script files can be run manually or scheduled to run automatically.
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 |
Target management entity |
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 and value pairs that are accessories to the command operation, |
|
mainly for set and add operations |
Example: ->add user mark password=asdf89g fullname="Mark Smith" enabled=true
Introduction 14
In the 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) must 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. Separate multiple properties with spaces.
Press the Tab key to display auto completion 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 to suppress interactive prompts.
Distinguish options from other command line elements by using a preceding hyphen (-). Option arguments are required or optional, depending on the option being specified. For example, the -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 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.
Scripts are useful for batching many CLI commands. You can create a single CLI script to configure an entire VC domain from scratch and use it on multiple enclosures.
When using a Linux SSH client, simply redirect the script into SSH. If the SSH keys are not configured on the client and in the firmware, a password prompt appears. To enable script automation and better security, SSH
public/private key-pairs can be generated and uploaded to the public key to the VC firmware. For example:
>ssh Admin@192.168.0.120 < myscript.txt
When using a Windows-based SSH client, pass the file to the client using the -m option. If the SSH keys are not configured on the client and in the firmware, a password prompt appears. To allow script automation and better security, SSH public/private key-pairs can be generated and uploaded to the public key to the VC
firmware. For example:
>plink Admin@192.168.0.120 -m myscript.txt
Introduction 15
The CLI enables you to enter multiple CLI commands in a single command-line invocation. This capability is useful when batching several commands together and executing them in a particular sequence, within the context of the same SSH session. This method improves the overall performance of lengthy script processing.
Example 1: Sample commands with no command batching add profile Profile1
add network Network1 add uplinkset UplinkSet1
Example 2: Sample commands using command batching
add profile Profile1;add network Network1;add uplinkset UplinkSet1
Introduction 16
Command |
Description |
|
|
add |
Add a new object to the domain or to another object |
assign |
Assign a server profile to a device bay |
copy |
Copy a configuration from one server profile to another server profile |
delete |
Delete the domain configuration |
exit |
Exit the Virtual Connect Manager command-line shell |
help |
Display context-sensitive help for a command or object |
import |
Import an enclosure into the domain |
load |
Transfer a file from a remote location to 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 object (for example, users or profiles) |
reset |
Perform a reset operation on an object (for example, vcm) |
restore |
Restore a file from a remote location |
save |
Transfer a file from the domain to a remote location |
set |
Modify one or more configuration properties of an object |
show |
Display properties or information about an object |
test |
Test the configuration of an object (for example, log-target) |
unassign |
Unassign a server profile from a device bay |
Managed element |
Description |
|
|
|
|
all (on page 20) |
Display all VC domain-managed elements |
|
|
|
|
activity (on page 20) |
Display activity events performed by VCM and the step-wise |
|
progress of those events |
|
|
|
|
|
|
|
|
auto-deployment (on page 20) |
Manage VC domain configurations from a centralized location |
|
|
|
|
banner (on page 22) |
Manage the login screen banner configuration |
|
|
|
|
cli (on page 23) |
Modify command execution behavior in script mode and |
|
auto-deployment |
|
|
|
|
|
|
|
|
config (on page 23) |
Display all commands for all objects defined in the domain |
|
|
|
|
configbackup (on page 24) |
Manage configuration backup and restore operations |
|
|
|
|
connection-map (on page 26) |
Display server-to-target connectivity information for servers with |
|
assigned profiles containing DirectAttach fabrics |
|
|
|
|
|
|
|
|
devicebay (on page 27) |
Display enclosure device bay information |
|
|
|
|
|
Command line 17 |
Managed element |
Description |
|
|
|
|
domain (on page 27) |
Manage general VC domain settings and information |
|
|
||
enclosure (on page 30) |
Manage general enclosure settings and information |
|
|
||
enet-connection (on page 32) |
Manage Ethernet network connections |
|
|
||
enet-vlan (on page 35) |
Manage Ethernet VLAN settings configuration |
|
|
||
external-manager (on page 37) |
Manage external manager settings and information |
|
|
||
fabric (on page 39) |
Manage Fibre Channel SAN fabrics |
|
|
||
fc-connection (on page 42) |
Manage Fibre Channel SAN fabric connections |
|
|
||
fcoe-connection (on page 45) |
Manage FCoE SAN fabric connections |
|
|
||
firmware (on page 49) |
Manage interconnect module firmware |
|
|
||
igmp (on page 49) |
Manage Ethernet IGMP Snooping settings |
|
|
||
igmp-group (on page 49) |
Display interconnect module IGMP Group table information |
|
|
||
interconnect (on page 51) |
Manage I/O interconnect modules |
|
|
||
interconnect-mac-table (on page 50) |
Display interconnect module MAC table information |
|
|
||
iscsi-boot-param (on page 52) |
Manage iSCSI connection boot parameters |
|
|
||
iscsi-connection (on page 55) |
Manage iSCSI connections |
|
|
||
lacp-timer (on page 58) |
Manage the domain default LACP timer |
|
|
||
ldap (on page 61) |
Manage LDAP configuration settings |
|
|
||
ldap-certificate (on page 58) |
Manage LDAP certificate information |
|
|
||
ldap-group (on page 60) |
Manage LDAP group configuration settings |
|
|
||
link-dist-interval (on page 62) |
Manage the FC login re-distribution interval |
|
|
||
lldp (on page 63) |
Display LLDP information received on a port |
|
|
||
local-users (on page 63) |
Modify the local user authentication settings for the VC domain |
|
|
||
log-target (on page 64) |
Manage remote log destination settings |
|
|
||
loop-protect (on page 66) |
Manage network loop protection settings |
|
|
||
mac-cache (on page 67) |
Manage Ethernet MAC cache failover settings |
|
|
||
mfs-filter (on page 72) |
Manage Multicast Filters in Multicast Filtersets |
|
|
||
mcast-filter (on page 70) |
Monitor and manage multicast group membership for hosts |
|
subscribing to IGMP Multicast traffic |
||
|
||
|
|
|
mcast-filter-rule (on page 67) |
Manage new Multicast Filter rules for a Multicast Filter |
|
|
||
mcast-filter-set (on page 68) |
Manage Multicast Filtersets |
|
|
||
nag-network (on page 72) |
Manage network access group memberships |
|
|
||
name-server (on page 74) |
Display a snapshot of all hosts and direct attached storage |
|
devices for the specified FlexFabric module |
||
|
||
|
|
|
network (on page 78) |
Manage VC Ethernet networks |
|
|
||
network-access-group (on page 74) |
Manage network access groups |
|
|
||
network-range (on page 75) |
Manage ranges of networks |
|
|
||
port-monitor (on page 83) |
Manage port monitor configuration |
|
|
||
profile (on page 86) |
Manage VC server profiles |
|
|
||
qos (on page 95) |
Manage the QoS configurations |
|
|
||
qos-class (on page 91) |
Manage the class of the active QoS configuration |
|
|
||
qos-classifier (on page 93) |
Manage the traffic classifier for the active QoS configuration |
|
|
||
qos-map (on page 94) |
Manage the traffic classification maps of the active QoS |
|
configuration |
||
|
||
|
|
Command line 18
Managed element |
Description |
|
|
|
|
radius (on page 98) |
Manage RADIUS authentication settings |
|
|
||
radius-group (on page 97) |
Manage RADIUS group configuration settings |
|
|
||
role (on page 99) |
Manage user authentication order by access role (privilege) |
|
|
||
server (on page 104) |
Manage physical HP BladeSystem server blades |
|
|
||
serverid (on page 106) |
Manage virtual server ID configuration settings |
|
|
||
server-port (on page 103) |
Display all physical server ports |
|
|
||
server-port-map (on page 101) |
Manage shared server downlink port mapping configuration |
|
|
||
server-port-map-range (on page 100) |
Manage ranges of shared server downlink port mapping |
|
configurations |
||
|
||
|
|
|
session (on page 107) |
Manage the session timeout value |
|
|
||
sflow (on page 108) |
Manage the existing VC Ethernet network with sFlow |
|
|
||
sflow-module (on page 108) |
Manage the network interface settings created for sFlow |
|
|
||
sflow-ports (on page 110) |
Manage the ports to be sampled or polled for a receiver |
|
|
||
sflow-receiver (on page 112) |
Manage the receivers |
|
|
||
snmp (on page 117) |
Modify SNMP configurations |
|
|
||
snmp-access (on page 114) |
Manage SNMP access configurations |
|
|
||
snmp-trap (on page 115) |
Modify SNMP-trap configurations |
|
|
||
snmp-user |
Manage SNMP user profiles |
|
ssh (on page 118) |
Manage SSH configuration and information |
|
|
||
ssl (on page 123) |
Manage SSL configuration and information |
|
|
||
ssl-certificate (on page 119) |
Manage SSL certificate information |
|
|
||
ssl-csr (on page 120) |
Manage an SSL certificate signing request |
|
|
||
stackinglink (on page 123) |
Display stacking link information and status |
|
|
||
statistics (on page 124) |
Display or reset statistics on a designated interconnect module |
|
port |
||
|
||
|
|
|
statistics-throughput (on page 126) |
Manage the port throughput statistics |
|
|
||
status (on page 127) |
Display overall VC domain status information |
|
|
||
storage-management (on page 128) |
Manage iSCSI storage management information |
|
|
||
supportinfo (on page 129) |
Generate VC support information |
|
|
||
systemlog (on page 130) |
Display the VCM system event log |
|
|
||
tacacs (on page 131) |
Manage TACACS+ authentication settings |
|
|
||
uplinkport (on page 132) |
Manage interconnect module uplink ports |
|
|
||
uplinkset (on page 135) |
Manage shared uplink port sets |
|
|
||
user (on page 138) |
Manage local VC user configurations |
|
|
||
user-security (on page 137) |
Manage user security settings |
|
|
||
vcm (on page 140) |
Manage the VC domain manager |
|
|
||
version (on page 141) |
Display CLI version information |
|
|
The following sections provide detailed information for using the subcommands with each managed element.
To display command help, enter a command followed by ? or -help. For more information on the help subcommand, see "Help subsystem (on page 147)."
Command line 19
Display activity events being performed by VCM and the step-wise progress of those events.
Supported actions: help, show
Item |
Description |
|
|
|
|
show activity |
Display activity events being performed by VCM and the step-wise progress of |
|
|
those events. The activity event display includes the following columns: |
|
|
• |
Time |
|
• |
User |
|
• |
Reason |
|
• |
Activity |
|
• |
Progress |
|
• |
Detail |
|
To close the activity display, press q. |
|
Syntax |
show activity |
|
Example |
|
|
|
->show activity |
|
|
Displays the activity events being performed by VCM and the step-wise progress |
|
|
of those events |
|
|
|
|
all
Manage all Virtual Connect domain elements.
Supported actions: help, show
Item |
Description |
|
|
show all |
Display all Virtual Connect domain configuration objects. This command is |
|
typically useful for displaying a snapshot of the entire domain configuration with a |
|
single command. |
|
|
Syntax |
show all [*] |
|
|
Examples |
|
|
|
|
->show all |
|
Displays all configuration objects (summary view) |
|
|
|
->show all * |
|
Displays all configuration objects (detailed view) |
Configure multiple VC domain configurations from a centralized location.
IMPORTANT: Auto-deployment supports single-enclosure domains. Multi-enclosure (stacked) domains are not supported. For more information on auto-deployment, see the HP Virtual Connect for c-Class BladeSystem User Guide on the HP website (http://www.hp.com/go/vc/manuals).
Supported actions: help, set, show, start, stop
Command line 20
Item |
Description |
|
|
set auto-deployment |
This command enables customization of options related to auto-deployment, |
|
such as choosing to use DHCP to discover a TFTP server location or to manually |
|
specify TFTP settings to use for the configuration script location used for |
|
deployment. |
|
|
Syntax |
set auto-deployment TftpMode=<Auto|Manual> |
|
[TftpServer=<IP or DNS name> TftpFile=<file name> |
Examples |
|
|
->set auto-deployment TftpMode=Manual |
|
TftpServer=192.168.1.1 |
|
TftpFile=myconfig.script |
|
Use a specified TFTP server as the configuration script source used for |
|
deployment |
|
->set auto-deployment TftpMode=Auto |
|
Use DHCP for automatic discovery of the configuration script source |
Item |
Description |
|
|
show auto-deployment |
This command displays properties related to auto-deployment. This includes the |
|
current status, deployment log, the configuration script used for deployment, |
|
and the command output generated from the configuration of the domain during |
|
deployment. |
|
|
Syntax |
show auto-deployment [[status] [log] [config] [output]] |
Examples |
|
|
->show auto-deployment |
|
->show auto-deployment status |
|
Display the status of auto-deployment along with its settings |
|
->show auto-deployment log |
|
Display the deployment log |
|
->show auto-deployment config |
|
Display the configuration script used in the deployment |
|
->show auto-deployment output |
|
Display the output generated from executing the configuration script |
Item |
Description |
|
|
start auto-deployment |
This command initiates the auto-deployment process. During deployment, |
|
servers are powered off, the domain is cleared, and the configuration is |
|
deployed using the configuration script downloaded from the remote TFTP |
|
server. This command might cause the current user session to log out during the |
|
deployment process. |
|
|
Syntax |
start auto-deployment |
Examples |
|
|
|
|
->start auto-deployment |
|
Starts a new deployment process |
|
|
Item |
Description |
|
|
stop auto-deployment |
Stop a deployment operation that is in progress. |
|
|
Syntax |
stop auto-deployment |
Command line 21
Item |
Description |
Examples
->stop auto-deployment
Stops an in-progress deployment operation
Manage the login screen banner configuration.
Supported actions: add, help, remove, show
Item |
Description |
|
|
add banner |
Add banner text to the login screen. You can access VCM through ssh or the OA. |
|
After banner text is added, the banner is displayed before the user credential |
|
prompt when VCM is accessed. |
|
|
Syntax |
add banner text=[”<banner text>”|’<banner text>’] |
Properties |
|
text (required) |
The text to display on the login in screen. Multi-line banner text can be entered |
|
through multiple add banner commands. New lines are appended to existing |
|
text. The banner text limit is 1500 bytes. If the accumulated banner text length |
|
exceeds 1500 bytes, either from one or multiple add banner commands, an |
|
error message appears. Only printable characters are allowed. |
Examples |
|
|
->add banner text="This is a private system, unauthorized |
|
access is not allowed." |
|
Adds banner text with a single command |
|
->add banner text="This is a private system." |
|
->add banner text="" |
|
->add banner text="Unauthorized access is prohibited." |
|
->add banner text="" |
|
->add banner text="Communications are monitored." |
|
Adds banner text with multiple commands (A blank line is displayed in between |
|
each line of text in this example.) |
|
|
Item |
Description |
|
|
remove banner |
Remove configured banner text. |
|
|
Syntax |
remove banner |
Example |
|
|
->remove banner |
|
Removes the configured banner text |
Item |
Description |
|
|
show banner |
Display the configured banner text. |
|
|
Syntax |
show banner |
Example |
|
|
->show banner |
|
Displays the configured banner text |
Command line 22
cli
This command modifies command execution behavior in script mode and auto-deployment. Script mode is the same as non-interactive mode.
IMPORTANT: The show config output contains the set cli command with the default property and value, which is commented out. To modify command execution behavior while passing a script to CLI over SSH, uncomment and change the value of the ExitOnFailure property. If this command is specified in an auto-deployment command script, the expected value should be 'true'. If 'false' is specified, it results in a command failure and prevents deployment execution because overriding command failures is not supported in auto-deployment.
Supported actions: help, set
Item |
Description |
|
|
set cli |
Set CLI command execution behavior. Only supported in script mode. |
|
|
Syntax |
set cli ExitOnFailure=<True|False> |
Property |
|
ExitOnFailure |
Controls whether the VCMCLI will exit on command failure during execution of |
(required) |
commands. This capability is only supported if passing a command script to the |
|
VCMCLI over SSH. If set to false, a failed command displays the appropriate |
|
error message. The script continues and the remaining commands are executed. |
|
Valid values include 'true' and 'false'. The default value is 'true'. |
|
|
Examples |
|
|
->set cli ExitOnFailure=False |
|
Sets the CLI to ignore command failure and continue to execute the remaining |
|
commands in the script |
|
->set cli ExitOnFailure=True |
|
Sets the CLI to exit on command failure if a command fails in a script while |
|
passing to the CLI over SSH |
|
|
Display all CLI commands for all objects defined in the domain. The show config command is useful for generating a CLI script that can be used for creating a domain configuration. The generated script is only valid for the firmware version currently running. A script generated on one version of firmware is unlikely to be properly executed by a different version of firmware.
Externally-defined MAC addresses, WWNs and serial numbers are displayed with a warning in the output and cannot be used on VCMCLI commands when recreating the domain.
Supported actions: help, show
Item |
Description |
|
|
|
|
show config |
Generate a configuration script from the running domain. |
|
|
|
|
Syntax |
show config -includePoolInfo |
|
Option |
|
|
includePoolInfo |
Include VC-defined or user-defined pool assigned SerialNumber, MAC, and |
|
|
WWN addresses for the domain. |
|
Examples |
|
|
|
Command line 23 |
Item |
Description |
|
|
|
->show config |
|
Displays the configuration script for the running domain |
|
->show config -includePoolInfo |
|
Displays the configuration script for the running domain, including the pool ID or |
|
user-defined range |
|
|
Manage the domain configuration file.
Supported actions: help, restore, save
CAUTION: Do not restore a configuration backup file by using a file from another domain and including the property to ignore the enclosure serial number. Restoring a Virtual Connect domain configuration from a backup file that was created on another Virtual Connect domain is not supported and can cause serious faults within this and other Virtual Connect Domains within the environment. The restore selection and configuration files should only be used to restore the same previously existing domain.
Item |
Description |
|
|
|
|
restore configbackup |
Transfer a configuration file from a remote TFTP or FTP server and restore the |
|
|
configuration. Be sure that the domain state is IMPORTED before attempting to |
|
|
restore the configuration. |
|
|
|
|
Syntax |
restore configbackup [-quiet][-maskEncryptKey] |
|
|
address=<tftp://ipaddress/[filename] | |
|
|
ftp://user:password@ipaddress/[filename]> |
|
|
[encryptionkey=<secret password>] |
|
|
[ignoreenclosureid=<true|false>] |
|
|
[ignorefwversion=<true|false>] |
|
Option |
|
|
quiet (optional) |
Suppresses user confirmation prompts |
|
maskEncryptKey |
Enables you to interactively specify the encryption key as a masked string at the |
|
(optional) |
command prompt |
|
Properties |
|
|
Address (required) |
A valid IP address of a TFTP or FTP server with user name and password (where |
|
|
needed) and the name of the configuration backup file. If not specified, the |
|
|
default file name is "vc-config-backup". The file path specified is treated as |
|
|
relative to the login directory for the user on the FTP server. Be sure that the |
|
|
permissions are appropriate for a successful transfer. |
|
|
|
|
EncryptionKey |
A password used to encrypt the configuration backup file |
|
(optional) |
|
|
IgnoreEnclosureID |
Restores a configuration that was generated on another enclosure. Valid values |
|
(optional) |
are "true" and "false". The default value is "false". When the value is set to |
|
|
"false", the configuration generated on another enclosure is rejected. |
|
IgnoreFWVersion |
Restores a configuration that was generated on another firmware version. Valid |
|
(optional) |
values are "true" and "false". The default value is "false". When the value is set |
|
|
to "false", the configuration generated on another firmware version is rejected. |
|
Examples |
|
|
|
->restore configbackup |
|
|
address=tftp://192.168.10.12/new-vc-config-backup |
|
|
->restore configbackup |
|
|
address=tftp://[2001::50]/new-vc-config-backup |
|
|
Command line 24 |
Item |
Description |
|
|
|
Restores a configuration backup file from a remote TFTP server |
|
|
|
->restore configbackup |
|
address=ftp://user:password@192.168.10.12/new-vc-config-b |
|
ackup |
|
->restore configbackup |
|
address=ftp://user:password@[2001::50]/new-vc-config-back |
|
up |
|
Restores a configuration backup file from a remote FTP server |
|
->restore configbackup |
|
address=ftp://user:password@192.168.10.12/new-vc-config-b |
|
ackup ignoreenclosureid=true |
|
->restore configbackup |
|
address=ftp://user:password@[2001::50]/new-vc-config-back |
|
up ignoreenclosureid=true |
|
Restores a configuration backup file from a remote FTP server and ignores the |
|
serial number |
|
|
|
->restore configbackup |
|
address=ftp://user:password@192.168.10.12/new-vc-config-b |
|
ackup ignorefwversion=true |
|
->restore configbackup |
|
address=ftp://user:password@[2001::50]/new-vc-config-back |
|
up ignorefwversion=true |
|
Restores a configuration backup file from a remote FTP server and ignores the |
|
firmware version |
|
|
|
->restore configbackup |
|
address=ftp://user:password@192.168.10.12/new-vc-config-b |
|
ackup encryptionkey=secret |
|
->restore configbackup |
|
address=ftp://user:password@[2001::50]/new-vc-config-back |
|
up encryptionkey=secret |
|
Restores a configuration backup file from a remote FTP server with an encryption |
|
key |
|
|
|
->restore configbackup -maskEncryptKey |
|
address=ftp://user:password@192.168.10.12/new-vc-config-b |
|
ackup |
|
->restore configbackup -maskEncryptKey |
|
address=ftp://user:password@[2001::50]/new-vc-config-back |
|
up |
|
Restores a configuration backup file from a remote FTP server with a masked |
|
encryption key |
|
|
|
->restore configbackup -quiet |
|
address=ftp://192.168.10.12/new-vc-config-backup |
|
->restore configbackup -quiet |
|
address=ftp://[2001::50]/new-vc-config-backup |
|
Restores a configuration backup file without user confirmation prompts |
|
->restore configbackup |
|
address=ftp://user:password@192.168.10.12:2000/new-vc-con |
|
fig-backup |
|
->restore configbackup |
|
address=ftp://[2001::50]:2000/new-vc-config-backup |
|
Restores a configuration backup file from a remote FTP server with a |
|
user-specified port number. |
|
|
Item |
Description |
|
|
save configbackup |
Generate and transfer a Virtual Connect configuration backup file to a remote |
|
TFTP or FTP server. |
Syntax |
save configbackup [-maskEncryptKey] |
Command line 25
Item |
Description |
|
|
|
address=<tftp://ipaddress/[filename] | |
|
ftp://user:password@ipaddress/[filename]> |
|
[encryptionkey=<secret password>] |
Option |
|
maskEncryptKey |
Enables you to interactively specify the encryption key as a masked string at the |
(optional) |
command prompt |
Properties |
|
Address (required) |
A valid IP address of a TFTP or FTP server with user name and password (where |
|
needed) and the name of the configuration backup file. If not specified, the |
|
default file name is "vc-config-backup". The file path specified is treated as |
|
relative to the login directory for the user on the FTP server. Be sure that the |
|
permissions are appropriate for a successful transfer. |
|
|
EncryptionKey |
A password used to encrypt the configuration backup file |
(optional) |
|
Examples |
|
|
->save configbackup |
|
address=tftp://192.168.10.12/new-vc-config-backup |
|
->save configbackup |
|
address=tftp://[2001::50]/new-vc-config-backup |
|
Saves a configuration backup file to a remote TFTP server |
|
->save configbackup |
|
address=ftp://user:password@192.168.10.12/new-vc-config-b |
|
ackup |
|
->save configbackup |
|
address=ftp://user:password@[2001::50]/new-vc-config-back |
|
up |
|
Saves a configuration backup file to a remote FTP server |
|
->save configbackup |
|
address=ftp://user:password@192.168.10.12/new-vc-config-b |
|
ackup encryptionkey=secret |
|
->save configbackup |
|
address=ftp://user:password@[2001::50]/new-vc-config-back |
|
up encryptionkey=secret |
|
Saves a configuration backup file to a remote FTP server with an encryption key |
|
->save configbackup -maskEncryptKey |
|
address=ftp://user:password@192.168.10.12/new-vc-config-b |
|
ackup |
|
->save configbackup -maskEncryptKey |
|
address=ftp://user:password@[2001::50]/new-vc-config-back |
|
up |
|
Saves a configuration backup file to a remote FTP server with a masked |
|
encryption key |
|
|
|
->save configbackup |
|
address=ftp://user:password@192.168.10.12:2000/new-vc-con |
|
fig-backup |
|
->save configbackup |
|
address=ftp://user:password@[2001::50]:2000/new-vc-config |
|
-backup |
|
Save a configbackup file to a remote FTP server with a user-specified port number |
Display server-to-target connectivity information for servers with assigned profiles containing DirectAttach fabrics.
Command line 26
Supported actions: help, show
Item |
Description |
|
|
show |
Display server-to-target connectivity information for servers with assigned profiles |
connection-map |
containing DirectAttach fabrics. |
Syntax |
show connection-map <ModuleID> |
Parameter |
|
ModuleID |
The ID of the module for which to display the connection map information. The module |
(required) |
must be a FlexFabric module. The ID is in the format of |
|
<EnclosureID>:<BayNumber>. |
Example |
|
|
->show connection-map enc0:1 |
|
Displays the connection map information for the module in bay 1 of enclosure enc0 |
Manage general enclosure device bay settings and information.
Supported actions: help, show
Item |
Description |
|
|
show devicebay |
Display device bays of all enclosures that exist in the Virtual Connect domain. |
Syntax |
show devicebay [<DeviceBayID>|*] |
Parameter |
|
DeviceBayID |
The reference ID of a device bay in the domain |
(Optional) |
The format of the device bay ID is <EnclosureID:DeviceBay>. |
|
Example: “enc0:1” indicates device bay 1 of the local enclosure being managed. |
|
Use "*" to display detailed information for all enclosures. |
|
If EnclosureID is not specified, the default enclosure is the local enclosure where |
|
the Virtual Connect Manager and domain exist. |
|
If a multi-blade server is present, use the DeviceBayID of the monarch bay. This is |
|
the ID value shown by show devicebay. |
Examples |
|
|
->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 device bay 2 of the local enclosure |
|
->show devicebay enc1:4 |
|
Displays detailed information for device bay 4 of a remote enclosure |
|
->show devicebay enc0:5 |
|
Displays detailed information for a multi-blade server in device bays 5-8 of the |
|
primary enclosure. |
|
|
Manage general VC domain settings and information.
Supported actions: delete, help, set, show
Command line 27
Item |
Description |
|
|
delete domain |
Delete the existing VC domain configuration. |
|
Deleting the domain removes the entire VC domain configuration and resets it to the |
|
original defaults. After the domain is deleted, you are logged out and the VCM |
|
resets. |
|
|
Syntax |
delete domain [-quiet] |
Option |
|
quiet |
Suppresses user confirmation prompts. This option is useful when scripting delete |
|
domain operations. |
Examples |
|
|
->delete domain |
|
Deletes the VC domain configuration and prompts for user confirmation |
|
->delete domain -quiet |
|
Deletes the VC domain quietly without prompting for user confirmation (primarily |
|
used in automated scripting scenarios) |
|
|
Item |
Description |
|
|
|
|
set domain |
Modify general VC domain configuration properties, such as the domain name, |
|
|
domain IP address, and MAC and WWN address pool settings. |
|
Syntax |
set domain [Name=<NewName>] [DomainIp=<Enabled|Disabled>] |
|
|
[IpAddress=<IPAddress>] [SubnetMask=<mask>] |
|
|
[Gateway=<Gateway>] [DomainIpv6=<Enabled|Disabled>] |
|
|
[Ipv6Address=<IPv6Address>/<prefix-length>] |
|
|
[Ipv6Gateway=<IPv6Address>] |
|
|
[MacType=<VC-Defined|Factory-Default| User-Defined>] |
|
|
[MacPool=<1-64>] [MacStart=<MAC address>] [MacEnd=<MAC |
|
|
address>] [WwnType=<VC-Defined | Factory-Default | |
|
|
User-Defined>] [WwnPool=<1-64>] [WwnStart=<WWN Address>] |
|
|
[WwnEnd=<WWN Address>] [SingleDense=true|false] |
|
Properties |
|
|
Name(optional) |
The new name of the domain. Valid characters include alphanumeric, "_", and ".". |
|
|
The maximum length of the name is 31 characters. |
|
DomainIP (optional) |
Enables or disables the VC domain IP address. If enabled, a valid IP address and |
|
|
subnet mask must be configured. If disabled, 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 VCM. Use caution when changing |
|
|
these settings. |
|
|
Values include "Enabled" and "Disabled". |
|
|
|
|
IpAddress (Required |
A valid IP address to use for the domain IP address configuration. The IP address |
|
if DomainIP is |
must be in the format xxx.xxx.xxx.xxx, where x is a number between 0 and 9, for |
|
enabled) |
example, 192.168.0.10. |
|
SubnetMask (Required |
A valid subnet mask for the domain IP address configuration. The subnet mask must |
|
if IP address |
be in the format xxx.xxx.xxx.xxx, where x is a number between 0 and 9, for |
|
specified) |
example, 255.255.255.0. |
|
Gateway (Required if |
A valid gateway address for the domain IP address configuration. The gateway |
|
IP address |
address must be in the format xxx.xxx.xxx.xxx, where x is a number between 0 and |
|
specified) |
9, for example, 192.168.0.1. |
|
DomainIpv6 |
Enables or disables the VC domain IPv6 address. If enabled, you must configure a |
|
(optional) |
valid IPv6 address. |
|
|
Enabling a domain IPv6 address configuration or changing the domain IPv6 |
|
|
address can cause a temporary loss of connectivity to the VCM. Use caution when |
|
|
changing these settings. |
|
|
Command line 28 |
Item |
Description |
|
|
|
|
|
Values include "Enabled" and "Disabled." |
|
|
|
|
Ipv6 Address |
A valid IPv6 address to use for the domain IPv6 address configuration. The IPv6 |
|
address must be specified with a prefix, for example, 2001::3/64. |
|
|
(optional) |
|
|
Ipv6Gateway |
A valid IPv6 gateway for the domain IPv6 address configuration, for example, |
|
(Required if an IPv6 |
2001::10. |
|
address is |
|
|
specified) |
|
|
MacType (optional) |
The type of MAC address source to use for assignment. Values include |
|
|
"VC-Defined", "Factory-Default", and "User-Defined". |
|
MacPool (optional) |
The pre-defined MAC pool to use for address assignment. Values include integers |
|
|
from 1 to 64. This property is valid only if the MacType is set to "VC-Defined". If not |
|
|
specified, the default pool ID is 1. |
|
|
Carefully choose the pool so there are no conflicts with other addresses in the |
|
|
environment. |
|
|
|
|
MacStart (Required |
The starting MAC address in a custom user-defined range. This property is valid |
|
if MacType is |
only if the MacType is set to "User-Defined". |
|
User-Defined) |
|
|
MacEnd (Required if |
The ending MAC address in a custom user-defined range. This property is valid |
|
MacType is |
only if the MacType is set to "User-Defined". |
|
User-Defined) |
|
|
WwnType(optional) |
The type of WWN address source to use for assignment. Values include |
|
|
"VC-Defined", "User-Defined", and "Factory-Default". |
|
WwnPool(optional) |
The pre-defined WWN pool to use for address assignment. Values include integers |
|
|
from 1 to 64. This property is valid only if the WwnType is set to "VC-Defined". If |
|
|
not specified, the default pool ID is 1. |
|
|
Carefully choose the pool so there are no conflicts with other addresses in the |
|
|
environment. |
|
|
|
|
WwnStart (Required |
The starting WWN address in a custom user-defined range. This property is valid |
|
if WwnType is |
only if the WwnType is set to "User-Defined". |
|
User-Defined) |
|
|
WwnEnd (Required if |
The ending WWN address in a custom user-defined range. This property is valid |
|
WwnType is |
only if the WwnType is set to "User-Defined". |
|
User-Defined) |
|
|
SingleDense |
If the imported domain supports double-dense server blades, this property enables |
|
(optional) |
the device bay display format to support the display for single-dense servers along |
|
|
with the double-dense servers. In a double-dense supported configuration, the |
|
|
default for this property is false, which disables the display of single-dense servers. |
|
|
|
|
Examples |
|
|
|
->set domain Name=MyNewDomainName |
|
|
Changes the name of the VC 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 and enables the domain IP address |
|
|
->set domain DomainIp=Disabled |
|
|
Disables the domain IP address and uses DHCP instead |
|
|
->set domain DomainIpv6=Enabled Ipv6Address=2001::34/64 |
|
|
Ipv6Gateway=2002::10 |
|
|
Configures and enables the domain IPv6 address |
|
|
->set domain DomainIpv6=Disabled |
|
|
Disables the domain IPv6 address and uses DHCP instead |
|
|
Command line 29 |
Item |
Description |
|
|
|
->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 |
|
Sets the MAC address source to use factory default MAC addresses |
|
->set domain MacType=User-Defined MacStart=00-17-A4-77-00-00 |
|
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 |
|
->set domain WwnType=User-Defined |
|
WwnStart=50:06:0B:00:00:C2:62:00 |
|
WwnEnd=50:06:0B:00:00:C2:62:FF |
|
Sets the WWN address source to a custom, user-defined address range |
|
->set domain SingleDense=true |
|
Sets the display option to support single-dense servers in a double-dense supported |
|
configuration |
|
|
Item |
Description |
|
|
show domain |
Display general VC domain information, including the VC domain name, the VCM |
|
domain IP address and IPv6 settings, and MAC/WWN address settings for the |
|
domain. |
|
|
Syntax |
show domain [addressPool] |
Parameter |
|
addressPool |
Displays all VC-defined address pool ranges available for use |
(Optional) |
|
Examples |
|
|
->show domain |
|
Displays domain information |
|
->show domain addressPool |
|
Displays the VC-defined address pool ranges available for use |
Manage general enclosure settings and information.
Supported actions: help, import, remove, show
Item |
Description |
|
|
|
|
import enclosure |
Import local and remote enclosures into the VC domain. VC supports up to four |
|
|
c7000 enclosures in a single domain. |
|
Syntax |
import enclosure [<IpAddress>][-quiet] |
|
|
[UserName=<username>] [Password=<password>] |
|
|
[DoubleDense=<True|False>] |
|
|
For enclosures that are not imported, the password field is optional. If not |
|
|
specified, the system interactively prompts you for the password. |
|
|
|
|
Parameter |
|
|
IpAddress (Optional) |
The address or DNS name of the remote enclosure to be imported. If not |
|
|
specified, the local enclosure is assumed. |
|
Option |
|
|
|
Command line 30 |