warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP
shall not be liable for technical or editorial errors or omissions contained herein.
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212,
Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S.
Government under vendor’s standard commercial license.
Microsoft and Windows NT are U.S. registered trademarks of Microsoft Corporation.
Intended audience
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.
Help subsystem ....................................................................................................................................... 60
Output format ......................................................................................................................................... 62
Interactive user output format .......................................................................................................... 62
Scriptable output format .................................................................................................................64
Configuring the Virtual Connect domain using the CLI..................................................................... 66
Virtual Connect is a set of interconnect modules and embedded software for HP BladeSystem c-Class
enclosures that simplifies the setup and administration of server connections. HP Virtual Connect includes
the HP 1/10Gb Virtual Connect Ethernet Module for c-Class BladeSystem, the HP 4Gb Virtual Connect
Fibre Channel Module for c-Class BladeSystem, and the HP Virtual Connect Manager.
Virtual Connect implements server edge virtualization so that server administrators can upgrade, replace,
or move server blades within their enclosures without changes being visible to the external LAN and SAN
environments.
The Virtual Connect Manager is embedded on the HP 1/10Gb Virtual Connect Ethernet Module for cClass BladeSystem and is accessed by users through web links provided by the Onboard Administrator or
through direct connection to the embedded web server.
The HP 1/10Gb VC-Enet Module supports the HP BladeSystem c7000 Enclosure, HP BladeSystem c3000
Enclosure, and all the server blades and networks contained within the enclosure and enables connection
to all brands of data center Ethernet switches.
The HP 4Gb VC-FC Module enables connection of the enclosure to Brocade, Cisco, McData, or Qlogic
data center Fibre Channel switches, but does not appear as a switch to the Fibre Channel fabric.
A Virtual Connect domain currently includes a single HP c-Class BladeSystem enclosure for a total of 16
servers. Within the domain, any server blade can access any LAN or SAN connected to a VC module,
and a server blade can be used as a spare for any server blade within the same enclosure.
By stacking (cabling) the Ethernet modules within the domain, every server blade in the domain can be
configured to access any external network connection. Fibre Channel modules within different I/O bays
are each connected directly to the same set of FC SAN(s). With this configuration, the Virtual Connect
Manager can deploy and migrate a server blade profile to any server in the Virtual Connect domain
without the need to change external LAN or SAN configurations.
Command line overview
The CLI can be used as an alternative method for managing the Virtual Connect Manager. Using the CLI
can be useful in the following scenarios:
• HP Management Applications (for example: Systems Insight Manager or Insight Control tools) can
query the Virtual Connect Manager for information these tools need to present a complete
management view of HP BladeSystem enclosures and the devices contained within. This interface is
also used by the Management tools to execute provisioning and configuration tasks to devices within
the enclosure.
• Users can develop tools that utilize Virtual Connect Manager functions for data collection and for
executing provisioning and configuration tasks.
Introduction 5
Page 6
• When no browser is available or you prefer to use a command line interface, you can access
management data and perform configuration tasks.
Command line syntax
CLI input is case-insensitive except when otherwise noted. The general CLI syntax format is as follows:
subcommand Operation performed on a managed element
managed element Management entity being operated on
parameters Command extensions for a particular management operation
options Attributes used to customize or control command execution behavior such as output
format, quiet-mode, and others
properties One or more name or value pairs that are accessories to the command operation,
Example: ->add user mark password=asdf89g fullname="Mark Smith" enabled=true
mainly for set and add operations
In the above example, add is the subcommand, user is the managed element, mark is a required
parameter for the operation, password is a required property, and fullname and enabled are
optional properties.
Depending on the specific command being executed, certain parameters or properties might be required.
For example, when adding a new user, both a parameter representing the user name, as well as a
password (in the form of a property) are required to be specified. All other user properties are optional at
the time the user is added. In general, the properties are in the format name=value, and more than one
property is separated by a space.
Parameters
Parameters are command extensions that provide extra information needed for the execution of a
particular command. Whether or not a parameter is required depends on the specific command being
executed. For example, the show user command has an optional parameter, which represents the user
name if the user instance is being managed. If show user is entered, then a summary listing of all users
is shown. However, if the optional parameter (user name) is provided, only a single user instance is
displayed, for example, show user paul.
Some commands require that a parameter be specified, for example, the add user command. The
required parameter is the user name (add user jake), and if the username is not provided, an error
message displays indicating that a required parameter is missing.
Options
Options enable users to control certain behavior characteristics available during the command execution.
Some examples of options include controlling output format and specifying a quiet mode for
suppressing interactive prompts that would normally require input from the user.
Options are distinguished from other command line elements by using a hyphen (-) in front of the option.
Option arguments are required or optional depending on the option being specified. For example, the -
Introduction 6
Page 7
output option requires an argument, which is a list of one or more output format attributes. However,
the -quiet option does not require any arguments to be specified.
The general format of a CLI option is as follows:
-<option>[=argument1>,<argument2>, . . .]
Example: ->show user suzi -output=script1
In the example, -output is the option, and script1 is an option argument.
Properties
Properties are specific configuration attributes of a managed element. Properties are commonly used
during set operations or add operations where a managed element is being modified or created. In
some limited circumstances, properties might also be used as a part of a show or other command.
IMPORTANT: If a property value contains embedded spaces, then the entire property value
must be contained within single or double quotes. Likewise, if a double quote is part of a
property value, it should be contained within single quotes, and if a single quote is part of a
property value, it should be contained within double quotes.
Command batching
In previous versions of the CLI, the user had the following options to enable different CLI command
invocations:
• Interactively input commands at the shell after logging in via SSH. This method works well for
interactive users, but not necessarily for automation. Although users could write expect scripts for
command processing, the solution is not optimal.
• Enter remote shell script commands, one-at-a-time, using a remote SSH client. This method enhances
automation, but performance is lessened because each command requires logging in and logging
out of the remote SSH server in the firmware. Because the authentication and command processing is
performed over an encrypted channel, users experience a performance hit. If the user script is
performing many operations in the client script, the time necessary to perform the tasks increases.
The updated version of the CLI supports a new enhancement that enables users to enter multiple CLI
commands in a single command-line invocation. This capability is useful in situations where users prefer to
batch several commands together and execute them in a particular sequence, within the context of the
same user login SSH session. This method improves the overall performance of lengthy script processing.
Example 1: Sample commands with no command batching
Supporting comments and blank lines in CLI scripts
Scripts are useful for batching many CLI commands. Administrators can create a single CLI script to
configure an entire VC domain from scratch and use it on multiple enclosures.
Introduction 7
Page 8
The updated version of the CLI supports command scripts that contain blank lines and comments. In
previous firmware versions, all commands that were provided as input to the CLI through scripts could
only be valid commands. Supporting comments and blank lines enables users to maintain descriptive
comments and notes in the configuration script more easily.
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 allow script automation and better
security, SSH public/private key-pairs can be generated and uploaded to the public key to the VC
firmware.
>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.
>plink Admin@192.168.0.120 -m myscript.txt
The following sample script illustrates a CLI script that contains this type of formatting. Note that all
comment lines must begin with "#".
#-----------------------------------------------------------------------# This is my sample Virtual Connect Domain Configuration Script
# Revision 1.0.1.2
# February 15, 2008
#------------------------------------------------------------------------
# Add Some Users
add user SomeNetworkUser password=pass1 privileges=network
add user SomeStorageUser password=pass2 privileges=storage
add user SomeDomainUser password=pass6 privileges=domain
add user SomeAdminUser password=pass3 privileges=*
add user DomainNetworkUser password=764dhh privileges=domain,network
# Add Some Profiles with Default VC-Enet and VC-FC Connections
add profile MyProfile
add profile AnotherProfile
add profile Profile45
# Add a few VC-Enet Networks
add network MyNetwork
add network Network2
# Add a few uplink ports to the networks
add uplinkport enc0:1:1 network=MyNetwork
add uplinkport enc0:1:2 network=Network2
Introduction 8
Page 9
# Create a Shared Uplink Port Set
add uplinkset SharedSet1
# Assign a profile to a device bay
assign profile MyProfile enc0:1
# Done!!!
Unassigning multiple profiles
In previous firmware releases, if the user needed to unassign multiple profiles from several device bays,
the unassign profile <profileName> command could be used at the command line. When many
profiles need to be unassigned, sending a command for each server profile to be unassigned can be
tedious.
To simplify this scenario, the remove profile command has been extended to include unassigning 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 displays for that
server/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
CLI command execution modes
The Virtual Connect Manager CLI provides two different methods for executing commands: interactive
shell mode and non-interactive mode.
Interactive Shell Mode
This mode is used to invoke CLI command operations using the dedicated management shell. The shell is
provided after the user logs in with valid credentials, and only accepts known VCM CLI commands as
input. Users can quit the shell by using the exit command. An example of logging into the interactive
management shell is provided below. In the example, the primary VCM is located at IP address
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
->
Non-Interactive Mode
In some cases, users might want to write automated scripts that execute a single command at a time.
These scripts can be used to batch several commands in a single script file from the SSH client. An
example of how to use the non-interactive mode for CLI command execution is provided below. In the
example, the primary VCM is located at IP address 192.168.0.120.
IMPORTANT: To suppress prompting for a password during login, you must first setup the SSH
encryption keys using the VCM Web GUI, and configure your SSH client properly with the
keys. For additional information on configuring the SSH keys, see the HP Virtual Connect for c-Class BladeSystem User Guide.
->ssh Administrator@192.160.0.120 show enclosure
<command output displayed to console>
Remote access to the Virtual Connect Manager
The Virtual Connect Manager CLI can be accessed remotely through any SSH session:
1. Start an SSH session to the Virtual Connect Manager using any SSH client application.
2. When prompted, type the assigned IP address or DNS name of the Virtual Connect Manager, and
then press Enter.
3. Type a valid user name, and then press Enter.
4. Type a valid password, and then press Enter. The CLI command prompt displays.
5. Enter commands for the Virtual Connect Manager.
6. To terminate the remote access SSH session, close the communication software or enter exit at the
CLI command prompt.
Command output filtering
The CLI provides output filtering capabilities that enable users 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 examples below illustrate some common usage scenarios for output filtering.
Example 1: Displaying all enabled users
Introduction 10
Page 11
->show user enabled=trueExample 2: Displaying on VC Ethernet Interconnect Modules
->show interconnect type=VC-ENETExample 3: Displaying all external uplink that have a link established
->show uplinkport status=linkedExample 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
Introduction 11
Page 12
Command line
Subcommands
Command Description
add
assign
delete
exit
help
import
load
poweroff
poweron
reboot
remove
reset
save
set
show
unassign
update
Add a new object to the domain or to another object
Assign a server profile to a device bay
Delete the domain configuration
Exit the Virtual Connect Manager command-line shell
Display context-sensitive help for a command or object
Import an enclosure into the domain
Transfer a file from a remote location to the domain
Power off one or more servers
Power on one or more servers
Reboot one or more servers
Remove or delete an existing object (for example, users or profiles)
Perform a reset operation on an object (for example, vcm)
Transfer a file from the domain to a remote location
Modify one or more configuration properties of an object
Display properties or information about an object
Unassign a server profile from a device bay
Update firmware on one or more interconnect modules
Managed elements
Managed element Description
all (on page 13)
devicebay (on page 14)
domain (on page 14)
enclosure (on page 17)
enet-connection (on page 18)
enet-vlan (on page 20)
external-manager (on page 21)
fabric (on page 22)
fc-connection (on page 24)
Display all VC domain managed elements
Display enclosure device bay information
Manage general virtual connection domain settings and
information
Manage general enclosure settings and information
Manage Ethernet network connections
Manage Ethernet VLAN connections
Manage external manager settings and information
Manage Fibre Channel SAN fabrics
Manage Fibre Channel SAN fabric connections
Command line 12
Page 13
Managed element Description
firmware (on page 26)
igmp (on page 27)
interconnect (on page 28)
ldap (on page 29)
ldap-certificate (on page 30)
ldap-group (on page 31)
mac-cache (on page 32)
network (on page 33)
port-monitor (on page 36)
profile (on page 38)
server (on page 40)
serverid (on page 43)
server-port-map (on page 44)
snmp (on page 46)
snmp-trap (on page 47)
ssh (on page 49)
ssl-certificate (on page 50)
ssl-csr (on page 50)
ssl (on page 51)
stackinglink (on page 52)
status (on page 52)
support-info (on page 52)
systemlog (on page 52)
uplinkport (on page 53)
uplinkset (on page 55)
user (on page 57)
Manage interconnect module firmware
Manage ethernet IGMP Snooping settings
Manage I/O interconnect modules
Manage LDAP configuration settings
Manage LDAP certificate information
Manage LDAP group configuration settings
Manage Ethernet MAC cache failover settings
Manage Virtual Connect ethernet networks
Monitor port monitor configurations
Manage virtual connect server profiles
Manage physical HP BladeSystem servers
Manage virtual server ID configuration settings
Manage shared server downlink port mapping configuration
Modify SNMP configurations
Modify SNMP-trap configurations
Display SSL configuration and information
Manage SSL certificate information
Manage an SSL certificate signing request
Manage weak SSL encryption
Display stacking link information and status
Display overall virtual connect domain status information
Manage virtual connect support information
Display virtual connect manager system event log
Manage interconnect module uplink ports
Manage shared uplink port sets
Manage local virtual connect user configurations
all
user-security (on page 59)
vcm (on page 60)
version (on page 60)
Manage user security settings
Manage the virtual connect domain manager
Display CLI version information
The following sections provide detailed information on how the subcommands are used with each
managed element.
To display command help, type a command followed by ? or -help. For additional information on the
help subcommand, see "Help subsystem (on page 60)."
Manage all Virtual Connect domain elements.
Supported actions: help, show
Command line 13
Page 14
Item Description
show all
Syntax
Examples
devicebay
Manage general enclosure device bay settings and information.
Supported actions: help, show
Item Description
show devicebay
Syntax
Parameter
DeviceBayID
(Optional)
Examples
Display all Virtual Connect domain configuration objects. This commands is
typically useful for displaying a snapshot of the entire domain configuration with
a single command.
show all [*]
->show all
Displays all configuration objects (summary view)
->show all *
Displays all configuration objects (detailed view)
Display device bays of all enclosures that exist in the Virtual Connect domain.
show devicebay [<DeviceBayID>|*]
The reference ID of a device bay in the domain
The format of the device bay name is <EnclosureID:DeviceBay>
Example: “enc0:1” indicates device bay 1 of the local enclosure being
managed. If * is specified, then all enclosures are displayed with detailed
output format.
If EnclosureID is not specified, the default enclosure is the local enclosure where
the Virtual Connect manager and domain exist.
->show devicebay
Displays a summary listing of all device bays
->show devicebay *
Displays detailed information for all device bays
->show devicebay enc0:2
Displays detailed information for a specific device bay of a specific enclosure
->show devicebay enc1:4
Displays detailed information for a specific device bay 4 of a remote enclosure
domain
Manage general Virtual Connect domain settings and information.
Supported actions: delete, help, set, show
Command line 14
Page 15
Item Description
delete domain
Syntax
Option
quiet
Examples
Delete the existing Virtual Connect domain configuration.
Deleting the domain removes the entire Virtual Connect domain configuration
and resets it to the original defaults. After the domain has been deleted, you are
logged out and the Virtual Connect Manager resets.
delete domain [-quiet]
Suppresses user confirmation prompts. This option is useful when scripting delete
domain operations.
->delete domain
Deletes the Virtual Connect domain configuration and prompts for user
confirmation
->delete domain -quiet
Deletes the Virtual Connect domain quietly without prompting for user
confirmation (primarily used in automated scripting scenarios)
Item Description
set domain
Syntax
Properties
Name(optional)
DomainIP (optional)
IpAddress
(optional)
SubnetMask
(Required if IP
address specified)
Gateway (Required
if IP address
specified)
MacType (optional)
Modify general Virtual Connect domain configuration properties, such as the
domain name, domain IP address, and MAC and WWN address pool settings.
The new name of the domain. Valid characters include alphanumeric, "_", and
".". The maximum length of the name is 64 characters.
Enables or disables the Virtual Connect domain IP address. If enabled, then a
valid IP address subnet mask must be configured. If disabled, then DHCP is used
to obtain a valid IP address.
Enabling domain IP address configuration or changing the domain IP address
can cause a temporary loss of connectivity to the Virtual Connect Manager. Use
caution when changing these settings. Valid values include "Enabled" and
"Disabled".
A valid IP address to use for the domain IP address configuration. The IP address
must be in the format: xxx.xxx.xxx.xxx, where x is a number between 0 and 9.
Example: 192.168.0.10
A valid subnet mask for the domain IP address configuration. The subnet mask
must be in the format: xxx.xxx.xxx.xxx, where x is a number between 0 and 9.
For example: 255.255.255.0
A valid gateway address for the domain IP address configuration. The gateway
address must be in the format: xxx.xxx.xxx.xxx, where x is a number between 0
and 9. For example: 192.168.0.1
The type of MAC address source to use for assignment. Valid values include "VCDefined", "Factory-Default", and "User-Defined".
Command line 15
Page 16
Item Description
MacPool (optional)
MacStart (Required
if IP address
specified)
MacEnd (Required if
IP address
specified)
WwnType(optional)
WwnPool(optional)
WwnStart (Required
if IP address
specified)
WwnEnd (Required if
IP address
specified)
Examples
The pre-defined MAC pool to use for address assignment. Valid values include
integers 1-64. This property is only valid if the MacType is set to "VC-Defined". If
not specified, the default pool ID is 1.
The starting MAC address in a custom user-defined range. This property is only
valid if the MacType is set to "User-Defined".
The ending MAC address in a custom user-defined range. This property is only
valid if the MacType is set to "User-Defined".
The type of WWN address source to use for assignment. Valid values include
"VC-Defined", "User Defined", and "Factory-Default".
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.
The starting WWN address in a custom user-defined range. This property is only
valid if the WwnType is set to "User-Defined".
The ending WWN address in a custom user-defined range. This property is only
valid if the WwnType is set to "User-Defined".
->set domain Name=MyNewDomainName
Changes the name of the Virtual Connect domain
Sets the WWN address source to a custom, user-defined address range
Command line 16
Page 17
Item Description
show domain
Syntax
Parameter
addressPool
(Optional)
Examples
enclosure
Manage general enclosure settings and information.
Displays general Virtual Connect domain information, including the Virtual
Connect domain name, the VCM domain IP address settings, and MAC/WWN
address settings for the domain.
show domain [addressPool]
Displays all the VC-defined address pool range available for use
->show domain
Displays domain information
->show domain addressPool
Displays the VC-defined address pools for the domain
Supported actions: help, import, remove, show
Item Description
import enclosure
Syntax
Parameter
IpAddress (Required
for remote
enclosures)
Properties
UserName (Required)
Password (Required)
DoubleDense
(Optional)
Examples
Import local and remote enclosures into the Virtual Connect domain.
The password field is optional on the command line. If not specified on the
command line, the user is prompted for the same interactively.
The IP address of the remote enclosure to be imported. This property is
required when importing a remote enclosure into the domain. If the IP address
is not given, then the local enclosure is assumed.
A valid username of the Onboard Administrator user
A valid password of the Onboard Administrator user to be used for importing
the enclosure. If no password is given at the command-line, the password is
prompted for interactively during the import operation.
If the enclosure being imported supports double-density servers, then this
property enables the device bay display format to support a display for
double-dense servers. The default behavior is display for single-dense servers in
the enclosure.
Imports the local enclosure with double-dense device bay display format
Item Description
remove enclosure
Remove a remote enclosure that has been imported into the domain. The local
enclosure is not allowed to be removed from the domain using the remove enclosure command.
Syntax
remove enclosure <EnclosureID | *>
Parameter
EnclosureID
(Required)
The enclosure ID of the remote enclosure to be removed from the domain, where "*"
removes all the remote enclosures that exist in the domain. The enclosure IDs can be
identified for a particular enclosure by using the show enclosure command. The
local enclosure cannot be removed from the domain with this command.
Examples
->remove enclosure encl
Removes a remote enclosure
->remove enclosure *
Removes all remote enclosures from the domain
Item Description
show enclosure
Syntax
Parameter
EnclosureID
(optional)
Examples
Display all enclosures in the domain.
show enclosure [<EnclosureID>|*]
The ID of an enclosure in the domain. If specified, then only details for the
specified enclosure are displayed.
->show enclosure
Displays a summary listing of all enclosures
->show enclosure *
Displays detailed information for all enclosures
->show enclosure enc0
Displays detailed information for a specific enclosure
->show enclosure encl
Displays detailed information for a single enclosure
enet-connection
Manage Ethernet network connections.
Supported actions: add, help, remove, set
Item Description
add enet-connection
Add a new Ethernet network connection to an existing server profile.
Command line 18
Page 19
Item Description
Syntax
Parameter
ProfileName (required)
Properties
Networkn (optional)
PXE (optional)
AddressType (optional)
EthernetMAC (required if
AddressType is UserDefined)
iScsiMAC (required if
AddressType is UserDefined)
The name of an existing profile to which the new connection is added.
The name of an existing network to associate with the connection. If the
network name is not specified, or is set to "unassigned," then the
network remains unassigned. (optional)
Enables or disabled PXE on the network connection. Valid values are
"enabled", "disabled", and "UseBios". If this value is not specified, the
default is "UseBios."
Only one connection can have PXE enabled per profile.
The source of MAC address assignments to be used during the creation
of the new connection. If not specified, the default is the domain default.
If "User-Defined" is specified, then both an Ethernet MAC Address and
iSCSI MAC Address must also be specified. Valid values include
"Factory-Default" and "User-Defined".
The user-defined Ethernet MAC address to use for the connection. This
property is required if the AddressType specified is "User-Defined."
The user-defined iSCSI MAC address to use for the connection. This
property is required if the AddressType specified is "User-Defined."
Adds a new Ethernet network connection and provides user-defined
MAC addresses
Item Description
remove enet-connection
Remove the last Ethernet network connection from an existing server
profile.
Command line 19
Page 20
Item Description
Syntax
remove enet-connection <ProfileName>
Parameter
ProfileName (required)
The name of the profile from which to remove the ethernet connection.
Example
->remove enet-connection MyProfile
Removes an ethernet network connection from a profile.
Item Description
set enet-connection
Syntax
Parameters
ProfileName (required)
Port (required)
Properties
NetworkName
PXE
Examples
Modify an ethernet connection of a server profile.
set enet-connection <ProfileName> <Port>
[Network=<NetworkName>]
[PXE=<enabled|disabled|UseBios>]
The name of the server profile that contains the connection to modify
The port number of the connection being modified
The name of the Ethernet network to associate with the connection.
Applies to Ethernet network connections only. A blank string will make
the ethernet connection unassigned.
Enables or disables PXE on a connection. Valid values are "enabled",
"disabled", and "UseBios". Applies to Ethernet network connections
only.
->set enet-connection RedProfile 1 NetworkName=""
Sets a network connection to "unassigned"
->set enet-connection GreenProfile 3 PXE=disabled
Disables PXE on an Ethernet connection
enet-vlan
Manage Ethernet VLAN connections.
Supported actions: help, set, show
Item Description
set enet-vlan
Syntax
Properties
Modifiy general Ethernet VLAN configuration settings.
set enet-vlan VLanTagControl=<Tunnel|Map>
[SharedServerVLanId=<true|false>]
Command line 20
Page 21
Item Description
VLanTagControl
(optional)
Determines how Ethernet packet VLAN tags are handled by the domain. Valid
values include: "Tunnel" and "Map".
The "tunnel" option results in VLAN tagging to be supported only on networks
with dedicated uplinks. Also, Ethernet ports connected to networks using shared
uplink sets can only transmit and receive untagged frames.
The "map" option results in being able to add more than one network to a
single Ethernet port for the server profiles and also being able to specify VLAN
mapping between server tags and VC networks. Also, Ethernet networks with
dedicated uplinks can only transmit and receive untagged frames.
SharedServerVLanId
(optional)
Enables or disables the option to force server ports connected to multiple VC
Ethernet networks to use the same VLAN mappings as those used by
corresponding shared uplink sets. Valid values include: "true" and "false".
Setting the value to "true" restricts the server network connections to be selected
from a single shared uplink, and the VLAN ID cannot be modified.
Setting the value to "false" allows the user to select any VC Ethernet network for
the server Ethernet connections, and VLAN ID mappings can be modified to
ensure uniqueness.
SharedServerVLanId can be "true" only if VLanTagControl is set to "Map".
A unique name for the new VC-FC Fabric to be added to the domain
The specific interconnect bay number with which the fabric is associated
A list of one or more logical FC ports to be added to the fabric. Each port is
specified in the format "<port1>,<port2>,...", where port is the interconnect module
port number to be added to the fabric (affects all modules within a bay group).
Example: "1,2,3,4".
The port speed for the uplink ports in the fabric. Valid values include: "Auto",
"1Gb", "2Gb", and "4Gb". The default port speed is "Auto".
Specifies the login distribution scheme to use for load balancing. Valid values
include: "Static" and "Dynamic". The default login distribution is "Static".
Command line 22
Page 23
Item Description
Examples
->add fabric MyFabric1 Bay=3 Ports=1,2
Adds a new fabric, using default values
->add fabric MyFabric2 Bay=3 Ports=1 Speed=2Gb
Adds a new fabric with speed set to 2Gb
->add fabric MyFabric3 Bay=3 Ports=1,2,3,4 Login=Dynamic
Adds a new fabric with dynamic login distribution
->add fabric MyFabric4 Bay=3 Ports=1,2
Adds a new fabric with two logical ports
Item Description
remove fabric
Syntax
Remove an existing VC FC SAN fabric from the domain.
remove fabric <Name | *>
ParameterName (required)
The name of an existing fabric or "*" to be removed
Examples
->remove fabric VFabric_1
Removes VC FC SAN fabric VFabric_1
->remove fabric *
Removes all VC FC fabrics from the domain
Item Description
set fabric
Syntax
Parameter
FabricName
(required)
Option
loadBalance
Properties
Name (optional)
Speed (optional)
Login (optional)
Ports (optional)
Examples
Modify an existing FC SAN fabric.
set fabric <Name> [-loadBalance] [Name=<NewName>]
[Speed=<Auto|1Gb|2Gb|4Gb>] [Login=<Static|Dynamic>]
[Ports=<PortList>]
The name of an existing FC SAN fabric to modify (required)
Perform load balancing on a fabric configured for dynamic login distribution
The new name of the fabric
The port speed for the uplink ports in the fabric Valid values include: “Auto”, “1Gb”,
“2Gb”, and “4Gb”. The default port speed is “Auto”.
Specifies the login distribution scheme to use for load balancing. Valid values
include: "Static" and "Dynamic". The default login distribution is "Static".
A list of one or more logical FC ports associated with the fabric. Each port is
specified in the format "<port1>,<port2>,...", where port is the interconnect module
port to be modified in the fabric (affects all modules within a bay group). A blank
string removes all the ports that are assigned to the fabric.
Command line 23
Page 24
Item Description
->set fabric MyFabric1 Name=MyNewName1
Changes the name of an existing fabric
->set fabric MyFabric2 Speed=2Gb Login=Dynamic
Modifies the port speed and login distribution
->set fabric MyFabric3 Ports=1,2,3,4
Modifies the fabric ports contained in the fabric
->set fabric MyFabric4 ports=””
Removes the fabric ports assigned to the fabric
->set fabric MyFabric5 -loadBalance
Performs load balancing on a fabric with dynamic login distribution
Item Description
show fabric
Syntax
Parameter
FabricName
(optional)
Examples
Display all FC SAN fabrics.
show fabric [<FabricName> | *]
Name of an existing FC SAN fabric. “*” displays detailed output of all the fabrics in
the VC domain. If not specified, summary output of all fabrics is displayed.
->show fabric
Displays a summary listing of all FC SAN fabrics
->show fabric *
Displays detailed information for all FC SAN fabrics
->show fabric SAN_5
Displays detailed information for a specific FC SAN fabric
fc-connection
Add a new Fibre Channel SAN connection to a server profile.
Supported actions: add, help, set
Item Description
add fc-connection
Syntax
Parameter
ProfileName (required)
Properties
Fabric (optional)
Add a new FC SAN connection to an existing server profile.
The name of an existing profile to which the new connection is added.
(required)
The name of an existing fabric to associate with the connection. If the fabric
name is not specified, then the connection will be marked as “Unassigned”
but associated with a specific bay.
Command line 24
Page 25
Item Description
Speed (optional)
AddressType (optional)
PortWWN (required if
AddressType is UserDefined)
NodeWWN (required if
AddressType is UserDefined)
Examples
The port speed of the connection port. Valid values include "Auto", "1Gb",
"2Gb", "4Gb", and "Disabled". If not specified, then the default port speed
is set to "Auto".
The source of WWN address assignments to be used during the creation of
the new connection. If not specified, the default is the domain default. If
"UserDefined" is specified, then both a Port WWN and Node WWN must
also be specified. Valid values include "Factory-Default" and "User-Defined".
The user-defined Port WWN address to use for the connection. This property
is required if the AddressType specified is "User-Defined". PortWWN must be
an unused WWN address.
The user-defined Node WWN address to use for the connection. This
property is required if the AddressType specified is "User-Defined". The
NodetWWN must be an unused WWN address.
->add fc-connection MyNewProfile Fabric=SAN_5
Adds a new FC SAN fabric connection to a profile
Adds a new FC SAN connection and provides user-defined WWN addresses
Item Description
remove fc-connection
Syntax
Remove the last FC connection from an existing server profile.
remove fc-connection <ProfileName>
ParameterProfileName (required)
The name of an existing profile from which the last FC connection to be
removed.
Example
->remove fc-connection MyProfile
Removes an FC-connection from a profile
Item Description
set fc-connection
Syntax
Modify an existing server profile connection.
set fc-connection <ProfileName> <Port>
[Fabric=<FabricName>]
[Speed=<Auto|1Gb|2Gb|4Gb|Disabled>]
[BootPriority=<priority>] [BootPort=<portName>]
[BootLun=<LUN>]
Command line 25
Page 26
Item Description
Parameters
ProfileName (required)
Port (required)
Properties
Fabric (optional)
Speed (optional)
BootPriority
(optional)
BootPort (optional)
BootLun (optional)
Examples
The name of the server profile that contains the connection to modify
The port number of the connection being modified
The name of the FC SAN fabric to associate with the connection. The fabric
being specified should be associated with the same bay as the FC
connection.
The port speed of the FC SAN connection. Valid values include "Auto",
"4Gb", "2Gb", "1Gb", and "Disabled".
Controls whether the FC HBA port is enabled for SAN boot and will affect the
BIOS boot order. Valid values include "BIOS", "Primary", "Secondary",
"Disabled".
The target WWPN of the controller interface on the Fibre Channel storage
target. The port name is a 64-bit identifier in the format:
NN:NN:NN:NN:NN:NN:NN:NN, where N is a hexadecimal number
The LUN of the volume used for SAN boot. Valid values include an integer
from 0-255 or 16 hex digits (HP-UX only).
->set fc-connection MyProfile 1 Fabric=SAN_5
Changes the fabric of an FC SAN fabric connection
->set fc-connection RedProfile 2 Fabric=""
Sets a FC SAN fabric connection to "Unassigned"
->set fc-connection BlueProfile 1 Fabric=SAN_7
Changes the FC SAN Fabric of an FC SAN connection
->set fc-connection BlueProfile 1 Speed=4Gb
Changes the port speed of an FC SAN connection
Modify Ethernet IGMP Snooping settings.
set igmp [Enabled=<true|false>] [Timeout=<interval>]
Enables or disables IGMP Snooping. Valid values include "true" and "false".
The idle timeout interval (in seconds) for IGMP Snooping. Valid values include
integers from 1-3600. The default IGMP idle timeout is 260 seconds.
->set igmp Enabled=true
Enables IGMP Snooping
->set igmp Enabled=true Timeout=30
Enables IGMP Snooping and sets the idle timeout
Item Description
show igmp
Syntax
Example
Display Ethernet IGMP Snooping settings.
show igmp
->show igmp
Displays IGMP Snooping settings
Command line 27
Page 28
interconnect
Manage I/O interconnect modules.
Supported actions: help, remove, show
Item Description
remove interconnect
Remove a module from the domain that has been removed physically from an
enclosure. Normally this command is used if a module has been physically
removed from the enclosure. To be removed, the module must not be currently
in use by any element in the domain.
Syntax
remove interconnect <ModuleID|*>
Parameter
ModuleID(required)
The ID of the module to remove. The ID is in the format
<EnclosureID>:<BayNumber>. To display a list of the IDs corresponding
to modules in the domain, the show interconnect command can be used.
Examples
->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 present
physically in any enclosures
->remove interconnect enc0:*
Removes all interconnect modules that are not present physically in a specific
enclosure
Item Description
show interconnect
Syntax
Display all interconnect modules known to the domain.
show interconnect [ModuleID|*]
PropertyModuleID
ID of the interconnect module. “*” displays detailed view of all the modules in
the VC domain. If not specified, summary output of all the modules is displayed
Examples
->show interconnect
Displays a summary listing of all interconnect modules
->show interconnect *
Displays detailed information for all interconnect modules
->show interconnect *:5
Displays the detailed information for all enclosures with interconnect modules
in interconnect bay number 5
->show interconnect enc0:*
Displays interconnect modules in all bays of a specific enclosure
->show interconnect enc0:3
Displays detailed information on a specific interconnect module in interconnect
bay 3 of the primary enclosure
Command line 28
Page 29
ldap
Manage Virtual Connect directory server authentication settings.
Supported actions: help, set, show
Item Description
set ldap
Modify and test the Virtual Connect LDAP directory server authentication
settings.
Tests the LDAP configuration without applying changes
Properties
Enabled (optional)
Enables or disables LDAP authentication. Valid values include "true" and
"false".
LocalUsers (optional)
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.
Enabling and disabling local user authentication requires you to be logged in
as an LDAP user. This property cannot be modified if logged in as a local user.
NtAccountMapping
(optional)
Enables or disables Microsoft® Windows NT® account mapping. This
capability enables you to enter "domain\username". Valid values include
"Enabled" and "Disabled".
SearchContext1
(optional)
SearchContext2
(optional)
SearchContext3
(optional)
ServerAddress
First searchable path used to locate the user when the user is trying to
authenticate using directory services.
Second searchable path used to locate the user when the user is trying to
authenticate using directory services.
Third searchable path used to locate the user when the user is trying to
authenticate using directory services.
The IP address or host name of the LDAP server used for authentication
(optional)
SslPort (optional)
The port to use for LDAP communication. Valid values include a valid port
number between 1 and 65535. The default port number is 636.
Downloads LDAP certification from the remote FTP server
remove ldap-
Remove an existing LDAP certificate.
certificateSyntax
remove ldap-certificate <SerialNumber | *>
Parameter
SerialNumber
The serial number of an existing LDAP certificate or "*"
(required)Examples
->remove ldap-certificate B4:02:C0:29:B5:E5:B4:81
Removes an existing LDAP certificate by serial number
->remove ldap-certificate *
Removes all LDAP certificates
Item Description
show ldap-certificate
Syntax
Parameter
Display LDAP certificate information.
show ldap-certificate [<SerialNumber> | *]
Command line 30
Page 31
Item Description
SerialNumber
(optional)
Examples
ldap-group
Manage Virtual Connect directory groups.
Supported actions: add, help, remove, set, show
Item Description
The serial number of an existing LDAP certificate in a colon format. "*"displays
detailed output of all the LDAP certificates in the VC domain. If not specified,
then displays summary output of all the LDAP certificates.
The unique name of the new network to create (required)
Suppresses user confirmation prompts during network creation and modification.
This option is used mainly in automated scripting scenarios.
The name of an existing shared uplink port set to use with this new network. If this
property is specified, then a valid VLAN ID must also be provided. The limit is 32
networks per shared uplink set.
The VLAN ID associated with the network (used with shared uplink port set only). The
VLAN ID is a valid number between 1 and 4094.
Enables or disables the network. Valid values are "Enabled" and "Disabled". The
default value is "Enabled".
Enables or disables the SmartLink capability for a port. Valid values are "Enabled"
and "Disabled". The default value is "Disabled".
Enables or Disables the network to act as a native VLAN. Valid values are
"Enabled" and "Disabled". The default value is "Disabled". This property can be
specified only if the network is a shared network.
Enables or Disables the network to act as a private network. Valid values are
"Enabled" and "Disabled". The default value is "Disabled".
Specifies the connection type that is formed when multiple ports are added to the
network. Valid values include "Auto" and "Failover". The default value is "Auto".
Enables or Disables VLAN tag tunneling. If Enabled, VLAN tags are passed through
the domain without any modification. If disabled, all tagged frames are discarded.
If multiple networks on any server port is configured, this option cannot be modified.
Command line 33
Page 34
Item Description
Examples
->add network MyNewNetwork
Creates a new network, and then adds it to the domain
->add network MyNewNetwork2 UplinkSet=MyUplinkSet VLanID=145
Creates a new network and uses a shared uplink port set
->add network Network1 State=Disabled SmartLink=Enabled
Creates a new network with SmartLink Enabled and Status Disabled
->add network Network1 Private=Enabled
Configures a private network when adding a new network
Suppresses user confirmation prompts during network creation and modification.
This option is used mainly in automated scripting scenarios.
Command line 34
Page 35
Item Description
Name (optional)
State (optional)
SmartLink
(optional)
NativeVLAN
(optional)
Private
(optional)
VLanID (optional)
ConnectionMode
(optional)
VLanTunnell
(optional)
Examples
The new name of the network
Enables or disables the network. Valid values are "Enabled" and "Disabled."
Enables or disables the SmartLink capability for a port. Valid values include
"Enabled" and "Disabled".
Enables or Disables the network to act as a native VLAN. Valid values are
"Enabled" and "Disabled". The default value is "Disabled". This property can be
configured only if it is a applied to a shared network.
Enables or Disables the network to act as a private network. Valid values are
"Enabled" and "Disabled". The default value is "Disabled".
Modifies the VLAN ID of the network if it belongs to a shared uplink set that has not
been configured.
Specifies the connection type that is formed when multiple ports are added to the
network. Valid values include "Auto" and "Failover". The default value is "Auto".
Enables or Disables VLAN tag tunneling. If Enabled, VLAN tags are passed through
the domain without any modification. If disabled, all tagged frames are discarded.
If multiple networks are configured on any server port, this option cannot be
modified.
->set network MyNetwork State=Disabled
Disables an existing network named "MyNetwork"
->set network Blue Name=Red
Changes the name of an existing network from "Blue" to "Red"
->set network GreenNetwork SmartLink=Enabled
Enables the SmartLink feature on a specific network
->set network network1 NativeVLAN=Disabled
Disables the network native VLAN tagging
->set network network1 Private=Disabled
Disables the private network property
->set network Network1 Private=Enabled
Enables a private network
->set network Network1 VlanId=150
Changes the VLAN ID of a network associated with a shared uplink set
->set network Network1 VLanTunnel=Enabled
Enables VLAN tunneling on the network
Item Description
show network
Syntax
Parameter
NetworkName
(optional)
Examples
Display all Ethernet networks in the domain.
show network [<NetworkName> | *]
Name of an existing network in the VC domain. "*" displays a detailed view of all
the networks. If not specified, a summary view of the networks is displayed.
Command line 35
Page 36
Item Description
port-monitor
Add a new network analyzer port and other ports to be monitored.
Supported actions: add, remove, set, show
Item Description
add port monitor
Syntax
->show network
Displays a summary listing of all networks
->show network *
Displays detailed information for all networks
->show network MyNetwork
Displays detailed information for a specific network
Add a new network analyzer port and other ports to be monitored.
The uplink port that is used for monitoring network traffic. Only one port can be
configured as the analyzer port.
After a port has been allocated to port monitoring, it is not available for use in
VC networks and shared uplink sets.
The format of the network analyzer port is
<EnclosureID>:<InterconnectBay>:<PortNumber>.
If the enclosure ID is not specified, the default enclosure is the local enclosure
where the domain resides.
Speed (optional)
The port speed for the network analyzer port. Valid values include: "Auto",
"10Mb", "100Mb", "1Gb", and "Disabled". The default value is "Auto".
Duplex (optional)
The duplex mode of the network analyzer port. Valid values include: "Auto",
"Half", and "Full". The default value is "Auto".
MonitorPort
(optional)
The server port to be monitored. The format of the monitored port is:
<EnclosureID>:<DeviceBay>:<PortNumber>. If the enclosure ID is not
specified, the default enclosure is the local enclosure.
Direction
(optional)
The direction of network traffic on the port being monitored. Valid values include:
"ToServer", "FromServer", and "Both".
Enables or disables port monitoring. The network analyzer port must be
configured properly before port monitoring can be enabled.
The uplink port used for monitoring network traffic. The format of the network
analyzer port is: <EnclosureID>:<InterconnectBay>:<PortNumber>.
If the enclosure ID is not specified, the default enclosure is the local enclosure.
The port speed for the network analyzer port Valid values include: "Auto",
"10Mb", "100Mb", "1Gb", and "Disabled". The default value is "Auto".
The port duplex mode of the network analyzer port. Valid values include: "Auto",
"Half", and "Full". The default value is "Auto".
The server port to be monitored. The format of the monitored port is:
<EnclosureID>:<DeviceBay>:<PortNumber>.
If the enclosure ID is not specified, the default enclosure is the local enclosure
where the domain resides.
The direction of network traffic on the port being monitored. Valid values include:
"ToServer", "FromServer", and "Both".
SerialNumber
(Reuired if the
SNTyope is UserDefineD)
UUID (Optional)
Examples
Display the Virtual Connect port monitor configuration.
show port-monitor
->show port-monitor
Displays the port monitor configuration
Create a new server profile. After the profile has been created, the profile can
then be configured using the "set" subcommand and additional network and
fabric connections can also be added. The server profile can also be assigned to
a device bay using the "assign" subcommand.
The unique name of the new server profile to create
Do not add default Ethernet Network connections when creating the server profile
Do not add default FC SAN connections when creating the server profile
The source of the serial number assignment to be used during the profile
creation. If not specified, the serial number will be assigned as per the Virtual
connect default domain settings. Valid values include "Factory-Default" and
"User-Defined".
A custom user-defined serial number associated with the server profile. When the
profile is assigned to a device bay that contains a server, the server will inherit
the virtual serial number. The user-defined serial number must start with the
pattern VCX01.
A unique 128-bit identifier for the virtual server ID The format of the xxxxxxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx where x is any alpha-numeric character. If no UUID
is specified, then one will be auto-generated. The UUID can be specified only if
the SNType is User-Defined.
Command line 38
Page 39
Item Description
->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
->add profile MyNewProfile SNType=Factory-Default
Creates a new profile and uses the factory assigned serial number
Creates a new profile and specifies a custom virtual serial number and UUID
Item Description
assign profile
Syntax
Parameters
ProfileName
Assign a server profile to a device bay.
assign profile <ProfileName> <DeviceBay>
The unique name of the server profile to assign
(required)
DeviceBay
(required)
Example
The device bay to assign the profile to, in the format:
EnclosureID:DeviceBayNumber
If EnclosureID is not specified, it defaults to the local enclosure.
->assign profile MyProfile1 enc0:1
Assigns a profile to device bay 1 of the primary enclosure
Item Description
remove profile
Syntax
Parameter
ProfileName
(required)
Examples
Remove one or more server profiles from the domain.
remove profile <ProfileName | *>
Name of an existing profile in the VC domain. "*" will remove all the existing
profiles
->remove profile MyProfile
Removes a server profile by name
->remove profile *
Removes all server profiles
Item Description
set profile
Modify properties of an existing server profile.
Command line 39
Page 40
Item Description
Syntax
Parameter
ProfileName
(required)
Properties
Name (required)
EFIState
(required)
Example
set profile <ProfileName> [Name=<NewName>]
[EFIState=absent]
The current name of the profile to modify
The new name of the server profile
Specifies the presence or absence of EFI state information
->set profile MyProfile Name=MyNewProfileName
Changes the name of a server profile
->set profile Profile1 EFIState=absent
Removes EFI partition block information from a profile
Item Description
show profile
Syntax
Parameter
ProfileName
(optional)
Examples
Display all server profiles that exist in the domain.
show profile [<ProfileName> | *]
Name of an existing profile in the VC domain "*" will display all the existing
profiles. If not specified, summary of all the profiles is displayed.
->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 including if a profile is
configured for SAN Boot
Item Description
unassign profile
Syntax
Parameter
ProfileName
(required)
Example
Unassign a server profile from a device bay
unassign profile <ProfileName>
The name of a server profile that is currently assigned to a device bay
->unassign profile MyProfile1
Unassigns a server profile from a device bay
server
Manage server blades.
Command line 40
Page 41
Supported actions: help, poweroff, poweron, reboot, show
Item Description
poweroff server
Syntax
Parameter
ServerID (required)
Options
Force
ForceOnTimeout
Timeout
Examples
Power off one or more physical servers.
poweroff server [<ServerID> | *] [-Force |
-ForceOnTimeout] [-timeout=<timeout>]
The reference ID of a physical server in the domain. The format of the server ID is
<EnclosureID:DeviceBay>
If the Enclosure ID is not provided, then the primary or local enclosure is used by
default. "*" powers off all servers in the domain.
Forces a power off operation without waiting for the OS to shutdown gracefully.
This option should be used as a last resort, because it can cause potential data
loss on the server.
Attempts a graceful power down, but if the server does not shutdown within the
timeout period (default is 60 seconds), then the server is forced to power off.
Specifies the timeout period (in seconds) to wait for the operation to complete
(per server). The default timeout is 60 seconds.
->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 at the end of the timeout
period
->poweroff server * -timeout=180
Shuts down all servers and specifies a custom timeout of 3 minutes
Item Description
poweron server
Syntax
Parameter
ServerID (required)
Option
Timeout
Examples
Power on one or more physical servers.
poweron server [<ServerID> | *] [-timeout=<timeout>]
The reference ID of a server in the domain. The format of the server ID is
<EnclosureID:DeviceBay>. If the EnclosureID is not provided, then the
primary or local enclosure is used by default. "*" powers on all servers in the
domain.
The timeout period (in seconds) to wait for the operation to complete. The default
timeout is 60 seconds.
Command line 41
Page 42
Item Description
->poweron server 2
Powers on the specific server in bay 2 of the primary enclosure
->poweron server *
Powers on all servers in the domain
->poweron server enc0:*
Powers on all servers in a specific enclosure
Item Description
reboot server
Syntax
Parameter
ServerID (required)
Options
Force
ForceOnTimeout
Timeout
Examples
Reboot one or more physical servers.
reboot server [<ServerID>|*] [-Force]
[-ForceOnTimeout] [-timeout=<timeout>
The reference ID of a server in the domain. The format of the server ID is
<EnclosureID:DeviceBay>. If the Enclosure ID is not provided, then the
primary or local enclosure (enc0) is used by default. "*" reboots all servers in the
domain.
Forces a reboot operation without waiting for the OS to shutdown gracefully. This
option should be used only as a last resort because it can cause potential data
loss on the server.
Attempts a graceful power down, but if the server does not shutdown within the
timeout period (default is 60 seconds), then the server is forced to power off
Specifies the timeout period (in seconds) to wait for the operation to complete
(per server). The default timeout is 120 seconds.
->reboot server 2
Reboots the specific server in device bay 2 of the primary enclosure
->reboot server enc0:2 -force
Reboots a server using the force option
->reboot server * -ForceOnTimeout -timeout=180
Reboots all servers using the ForceOnTimeout option and a custom timeout
->reboot server *
Reboots all servers in the domain
->reboot server enc0:*
Reboots all servers in a specific enclosure
Item Description
show server
Syntax
Parameter
ServerID (required)
Examples
Display all servers in the domain.
show server [<ServerID> | *]
The reference ID of a server in the domain. The format of the server ID is
<EnclosureID:Bay>. If the EnclosureID is not provided, then the primary or
local enclosure is used by default.
Command line 42
Page 43
Item Description
serverid
Add Virtual Serial Number and Virtual UUID properties to server profiles.
Supported actions: help, set, show
Item Description
set serverid
Syntax
Properties
Type (required)
PoolID (optional)
Start (optional)
End (optional)
Examples
->show server
Displays a summary listing of all servers
->show server *
Displays detailed information for all servers
->show server enc2:*
Shows detailed information of all servers in a specific enclosure
->show server enc0:4
Displays detailed information for the specific server in device bay 4 of an
enclosure named "MyEnclosure"
Modifiy Virtual Server ID domain settings. The serial number attributes can be
changed only in one of the following scenarios:
• Virtual Server ID source is Factory-Default.
• Virtual Server ID source is VC-Defined or User-Defined but no profiles are
using server IDs from this source.
• Virtual Server ID source is User-Defined and this range is being extended by
lowering the start or increasing the end values.
set serverid Type=Factory-Default
set serverid Type=VC-Defined [PoolType=<1-64>]
set serverid Type=User-Defined Start=VCX01nnnnn
End=VCX01nnnnn
The type of the virtual serial number source. When server profiles are created,
the virtual serial numbers and UUID values are allocated from the specified pool
source.
Valid values: "Factory-Defined" (default), "VC-Defined", and "User-Defined"
The VC-Defined Pool ID to be used. If not specified, the default Pool ID is 1. This
property is only valid for VC-Defined-serial number types.
The starting serial number in a user-defined range. This property is only valid for
User-Defined serial number types. User-Defined serial number ranges should start
with the pattern VCX01.
The ending serial number in a user-defined range. This property is only valid for
User-Defined serial number types. User-Defined serial number ranges should start
with the pattern VCX01.
->set serverid Type=Factory-Default
Modifies virtual server ID settings to use factory default serial numbers
Command line 43
Page 44
Item Description
Item Description
show serverid
Syntax
Example
server-port-map
Add new server port network mapping
->set serverid Type=VC-Defined PoolId=5
Modifies virtual server ID settings to use VC-Defined serial numbers
The reference ID an existing enet-connection associated with a profile and a
server port. The format of the ConnectionId is <ProfileName:PortNumber>.
The name of a valid network to which the mapping will be added. A network
can be configured once for every profile connection, and every profile
connection can be configured for a maximum of 28 networks.
The name of the shared uplinkset to use with the server port mapping. If the
domain setting SharedServerVLanId is set to "true", then the Uplinkset is a
required value.
The VLAN ID to be used for the mapping. Valid values include 1 to 4094. If the
uplinkset name is specified, then the VLanID property should not be specified,
because the server VLAN ID is forced to be same as the VLAN ID used when
adding the network to the shared uplinkset.
Enable or disable the network to handle untagged packets. Only one network in
an Ethernet network connection can be made to handle untagged packets. The
default value is "false". If a shared uplink set is being used, then the untagged
network is the same as the native network, if present, but any other network can
be configured to handle untagged packets.
Command line 44
Page 45
Item Description
Examples
->add server-port-map MyProfile:1 Network1 VLanID=100
Adds a new server port to dedicated network mapping
The reference ID of an existing enet-connection associated with a profile and a
server port. The format of the ConnectionId is: <ProfileName:PortNumber>. "*" will
remove all server-port-map configurations from the domain
Network
The name of an Ethernet network to which the mapping exists.
(optional)
Examples
->remove server-port-map MyProfile:1 RedNetwork
Removes a server port network mapping
->remove server-port-map MyProfile:1 *
Removes all server port network mappings from a profile
->remove server-port-map *
Removes all the server port mappings in the domain
Item Description
set server-portmap
Syntax
Parameters
ConnectionID
(required)
Network
(required)
Properties
VLanID (optional)
Modify an existing server port network mapping. This command cannot be used if
the domain setting VLanTagControl is set to "Tunnel" or if the network is associated
with a shared uplink port set.
set server-port-map <ConnectionID> [Network=<Network Name>]
[VLanID=<VLanID>] [UnTagged=<true|false>]
The reference ID of an existing enet-connection associated with a profile and a
server port. The format of the ConnectionId is <ProfileName:PortNumber>.
The name of a valid Ethernet network to which the mapping exists
The new VLAN ID to be used for the mapping server port to network. Valid values
include 1 to 4094.
Command line 45
Page 46
Item Description
Untagged
(optional)
Enables or disables the network to handle untagged packets. Only one network in
an Ethernet network connection is allowed to handle untagged packets. The default
value is "false". If a shared uplink set is being used, then untagged network is the
same as the native network if present, but any network can also be configured to
handle untagged packets.
When changing a network untagged option from true to false, the user is required to
provide a VLanID if the global option SharedServerVLanId is set to "false".
Examples
->set server-port-map MyProfile:1 Network1 VLanId=100
Modifies the VLAN ID of an existing server port network mapping
->set server-port-map MyProfile:1 Network1 Untagged=true
Modifies the existing server port network mapping to handle untagged packets
Item Description
show server-portmap
Syntax
Parameter
ConnectionID
Examples
Display a server port network mapping. This command cannot be used if the domain
setting, VLanTagControl, is set to "Tunnel".
show server-port-map [<ConnectionID> | *]
The reference ID of an existing enet-connection associated with a profile and a
server port. The format of the ConnectionId is <ProfileName:PortNumber>.
->show server-port-map
Lists all the server port mappings
->show server-port-map MyProfile:1
Displays the server port mapping for a profile
->show server-port-map *
Displays detailed output of all the server port mappings
snmp
View and modify the SNMP configuration for VC-Enet and VC-FC modules, and add, modify, and remove
SNMP trap configurations related to trap destinations.
Supported actions: set, show
Item Description
set snmp
Syntax
Parameter
Type (required)
Properties
Modify the SNMP configuration for the VC Domain.
set snmp Type=<Enet|Fc>
[ReadCommunity=<ReadCommunityString>]
->set snmp Type=fc Enabled=false
Disables the SNMP agent for VC-FC modules
Item Description
show snmp
Syntax
Parameter
Type (optional)
Examples
Display the SNMP configuration settings for the VC domain.
show snmp [Type]
Indicates the type of VC module to display SNMP configuration for. If the type is
not specified, all VC module SNMP configuration information is displayed. Valid
values include: "Enet" and "FC".
->show snmp enet
Displays SNMP configuration for only VC-Enet modules
->show snmp fc
Displays SNMP configuration for only VC-FC modules
->show snmp
Displays SNMP configuration for all VC modules
snmp-trap
Displays SNMP trap information
Supported actions: add, remove, set, show
Item Description
snmp-trap
Syntax
Parameter
TrapID (required)
Add a new SNMP trap destination for VC-Enet and VC-FC interconnect modules.
add snmp-trap <TrapID> [Community=<community name string>]
(Required) The reference name of the new trap destination to be added. The
format of the trap ID is <ENET|FC>:<Address> where the address is the IP
address of the trap destination host.
Command line 47
Page 48
Item Description
Property
Community
(optional)
The SNMP community name string for the specified trap.Default is "public". For
VC-ENET modules, maximum string length is 39. For VC-FC modules, maximum
string length is 24.
Examples
->add snmp-trap ENET:192.112.34.89 community=datacenter1
Adds a new trap destination for VC-Enet modules
->add snmp-trap FC:192.112.34.89 community=public
Adds a new trap destination for VC-FC modules
(Required) The reference name of the trap destination to be removed. The format
of the trap ID is <ENET|FC>:<Address> where the address is the IP address of
the trap destination host. "*" removes all the configured SNMP traps.
->remove snmp-trap ENET:192.135.67.89
Removes an SNMP trap destination for VC-Enet modules
Item Description
set snmp-trap
Syntax
Parameter
TrapID (required)
Property
Community
(optional)
Example
Modify SNMP trap configuration properties.
set snmp-trap <TrapID> Community=<community name string>
(Required) The reference name of the trap destination to be modified. The format
of the trap ID is <ENET|FC>:<Address> where the address is the IP address of
the trap destination host.
The SNMP community name string for the trap. For ENET modules, maximum
string length is 39. For FC modules, maximum string length is 24. The default
community name is "public", if not specified.
Modifies an SNMP trap destination for VC-Enet modules
Item Description
->show snmp-trap
Syntax
Display the SNMP Traps that have been configured.
show snmp-trap [ <Type> | * ]
Parameter
Command line 48
Page 49
Item Description
ssh
Type (optional)
This parameter indicates the type of VC modules for which to display SNMP trap
information. The default behavior is to display all SNMP trap information if a
specific type is not specified. Valid types include "Enet:<Address>" and
"FC:<Address>", where "Address" can be a specific IP address or "*".
Examples
->show snmp-trap
Displays SNMP trap information for all VC modules
->show snmp-trap Enet:*
Displays SNMP trap information for only VC-Enet modules
->show snmp-trap Fc:*
Displays SNMP trap information for only VC-FC modules
->show snmp-trap Enet:10.20.30.40
Displays SNMP trap information for specific VC-Enet modules
Display the SSH key configuration.
Supported actions: help, load, remove, show
Item Description
load ssh
Transfer the SSH key from a remote FTP server and apply it to the Virtual Connect
domain. A customized SSH key enables additional security for SSH clients that are
allowed to access the domain configuration. If a new custom SSH key is applied,
then the SSH clients must be configured correctly to have access.
Remove any custom SSH keys that have been applied.
remove ssh
->remove ssh
Removes SSH keys
Item Description
show ssh
Display the SSH key configuration.
Command line 49
Page 50
Item Description
Syntax
Example
ssl-certificate
View and upload the SSL certificate from a remote FTP server.
Supported actions: help, load, show
Item Description
load ssl-certificate
Syntax
Properties
Address (required)
Filename (required)
Example
Item Description
show ssh
->show ssh
Displays the SSH key configuration
Transfer an SSL Certificate from a remote FTP server and apply it to the
Virtual Connect Manager web server. After a new SSL certificate is
applied, the web server is reset.
The ID of an uplink port to add (required). The ID is a combination of the enclosure
name, interconnect bay, and port number in a single descriptor. The format of the
port name is <EnclosureID>:<InterconnectBay>:<PortNumber>".
The name of an existing network to which the port is added
The name of an existing shared uplink port set to which the port is added
Specifies the port speed for the port (optional). Valid values include "Auto",
"10Mb", "100Mb", "1Gb", and "Disabled". If not specified, the default port speed
is "Auto".
Command line 53
Page 54
Item Description
Role (optional)
Examples
The Role played by the port if the connection mode of the network or shared
uplinkset is selected as "Failover". The default is "Primary".
->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
->add uplinkport enc0:2:4 Network=MyNetwork Role=Primary
Adds a new uplink port to a network with the connection mode as Failover and the
port role as Primary
Item Description
remove uplinkport
Syntax
Parameters
PortID (required)
Network
(optional)
UplinkSet
(optional)
Examples
Remove an uplink port element from a network or a shared uplink port set.
Disables a specific port that belongs to a shared uplink set
->set uplinkport enc0:2:4 Network=MyNetwork Role=Primary
Modifies an uplink port of a network with the connection mode as Failover to take
the primary port role
Item Description
show uplinkport
Syntax
Example
uplinkset
Manage shared uplink port sets
Supported actions: add, help, remove, set, show
Item Description
add uplinkset
Syntax
Parameter
UplinkSetName
(required)
Property
ConnectionMode
(optional)
Examples
Display all Ethernet module uplink ports known to the domain. If the port is a
member of a network or a shared uplink port set, then it will be displayed also.
The unique name of the new shared uplink port set to create (required)
Specifies the connection type that is formed when multiple ports are added to
the uplinkset. Valid values include "Auto" and "Failover". The default value is
"Auto".
Command line 55
Page 56
Item Description
->add uplinkset MyNewUplinkSet
Creates a new shared uplink port set and adds it to the domain
->add uplinkset MyNewUplinkSet ConnectionMode=Failover
Creates a new shared uplinkset and sets the connection mode to failover
Item Description
remove uplinkset
Syntax
Parameter
UplinkSetName
(required)
Example
Remove a shared uplink port set from the domain.
remove uplinkset <UplinkSetName> | *>
The name of an existing shared uplink port set. "*" removes all the existing
uplink port sets from the domain.
->remove uplinkset MyUplinkSet
Removes a shared uplink port set
Item Description
set uplinkset
Syntax
Parameter
UplinkSetName
(required)
Properties
Name (optional)
ConnectionMode
(optional)
Examples
Modify an existing shared uplink port set.
set uplinkset <UplinkSetName> [Name=<NewName>]
[ConnectionMode=<Auto|Failover>]
The name of an existing shared uplink set to modify
The new name of the shared uplink set
Specifies the connection type that is formed when multiple ports are added to
the uplinkset. Valid values include "Auto" and "Failover". The default value is
"Auto".
->set uplinkset Blue Name=Red
Changes the name of an shared uplink set from "Blue" to "Red"
->set uplinkset Blue connectionMode=Failover
Changes the connection mode of the uplink set
Item Description
show uplinkset
Syntax
Parameter
UplinkSetName
(optional)
Examples
Display shared uplink configurations.
show uplinkset [<UplinkSetName> | *]
Name of an existing uplink port set. "*" displays a detailed view of all the
uplink port sets. If not specified, summary of all uplink port sets will be
displayed.
->show uplinkset
Displays a summary listing of all uplink sets
Command line 56
Page 57
user
Item Description
->show uplinkset *
Displays detailed information for all shared uplink sets
->show uplinkset MyNetwork
Displays detailed information for a specific shared uplink set
Manage local domain user configurations.
Supported actions: add, help, remove, set, show
Item Description
add user
Syntax
ParameterUserName (required)
Properties
Password (required)
FullName (optional)
ContactInfo
(optional)
Enabled (optional)
Privileges
(optional)
Examples
Create a new user and add it to the Virtual Connect Manager database.
add user <UserName> Password=<password> [FullName=<Full
Name>] [ContactInfo=<Contact Details>]
[Enabled=<True|False>]
[Privileges=<Storage|Network|Server|Domain|*>]
The name of the new user to add. The username must be unique within the
domain.
The password of the new user. The password of the new user can be entered as
clear text in the command or as a masked string at the prompt.
The full name of the user (optional)
Contact information for the user (optional)
Enables or disables the user. Valid values include: "true" and "false". If not
specified, then the new user is enabled by default.
The allowed privileges for the user. The privileges may be any combination of
"domain", "server", "network", or "storage" separated by commas. If no
privilege is specified, then the user will have no privileges and will only be able
to display domain information. If "*" is specified, then all privileges apply.
->add user steve Password=fgY87hHl
Adds a new user by specifying the minimal amount of properties
->add user bill Password=HGtwf7272562
Privileges="domain,network" FullName="Bill Johnson"
ContactInfo=billj@company.com Enabled=true
Adds a new user and configures additional user properties
->add user Admin Password=hjkhfd Privileges=*
Adds an "Admin" user with all privileges
Item Description
remove user
Syntax
Remove a user from the Virtual Connect Manager database.
remove user <username | *>
Command line 57
Page 58
Item Description
Parameter
UserName (required)
Examples
The name of an existing user that will be removed. If "*" is specified, then all
users except for the default Administrator account are removed.
->remove user steve
Removes a specific user by name
->remove user *
Removes all users
Item Description
set user
Syntax
Parameter
UserName (required)
Properties
Password (optional)
FullName (optional)
ContactInfo
(optional)
Enabled (optional)
Privileges
(optional)
Examples
Modify attributes of an existing user.
set user <UserName> [<password>] [FullName=<Full Name>]
[ContactInfo=<Contact Details>] [Enabled=<True|False>]
[Privileges=<Storage|Network|Server|Domain|*>]
The name of the user to be modified
The new password of the user can be entered as clear text in the command or as
a masked string at the prompt. If the Password value is blank, the user is
prompted to enter the password at the prompt.
The full name of the user
Contact information for the user
Enables or disables the user. Valid values include: "true" and "false".
The allowed privileges for the user (optional). Privileges can be any combination
of "domain", "server", "network", "storage" separated by commas. If the
privilege is blank, then the user will have no privileges and will only be able to
display domain information. If "*" is specified, then all privileges apply.
->set user steve Password=fgY87hHl
Modifies an existing user password
->set user steve Password
Modifies an existing user password, masked, at the prompt
->set user bill Password=HGtwf7272562
Privileges="domain,network" FullName="Bill Johnson"
ContactInfo=billj@company.com Enabled=true
Modifies several properties of an existing user
->set user tom privileges=*
Gives a user all privileges
Item Description
show user
Syntax
Parameter
Display user summary or user details.
show user [<username>]
Command line 58
Page 59
Item Description
UserName (optional)
Examples
user-security
Manage strong password validations when adding new users and specifying passwords for users.
Supported actions: help, set, show
Item Description
set user-security
Syntax
Properties
StrongPasswords
(optional)
MinPasswordLength
(optional)
Examples
Item Description
show user-security
Syntax
Example
Name of an existing user in the VC domain. If not specified, then summary of all
existing user will be displayed.
->show user
Lists all existing users
->show user steve
Displays details of an existing user by name
->show user *
Displays details of all existing users
Modify domain user security settings and enforce additional security requirements
for user passwords.
set user-security StrongPasswords=<Enabled|Disabled>
inPasswordLength=<3-40>
Enables or disables strong password enforcement. If enabled, then new, local
users that are created are validated against the password characteristics
specified. Valid values include: "Enabled" and "Disabled".
The minimum password length allowed for new passwords when adding a new
user and when changing an existing password. The default value is 3.
->set user-security StrongPasswords=Enabled
Enables strong user password enforcement
->set user-security StrongPasswords=Disabled
Disables strong user password enforcement
->set user-security MinPasswordLength=10
->set user-security MinPasswordLength=30
Modifies the minimum and maximum password length
Display general domain user security settings.
show user-security
->show user-security
Displays strong user password settings
Command line 59
Page 60
vcm
Reset the Virtual Connect Manager.
Supported actions: help, reset
Item Description
reset vcm
Syntax
Option
Failover
Examples
Reset the Virtual Connect Manager. A failover to the standby VCM may
also be specified (optional), if there is a standby VCM available.
IMPORTANT: Resetting the VCM causes a temporary loss in connectivity
with the Virtual Connect Manager. If failover is specified and there is a
standby VCM, users are logged off and must reconnect using the standby
VCM IP address.
reset vcm [-failover]
Forces a failover from the current primary Virtual Connect Manager to the
standby manager
->reset vcm
Resets the Virtual Connect Manager
->reset vcm -failover
Resets the Virtual Connect Manager and forces a failover to the standby
VCM (if available)
version
Display CLI version information.
Supported actions: help, show
Item Description
show version
Syntax
Example
Help subsystem
The help subsystem consists of three options:
•Help summary—lists all supported actions and a short description of each:
>help (or ?)
add add an element to an existing object
assign assign a server profile to a device bay
. . .
•Subcommand help—displays help details associated with a specific subcommand, including
supported managed elements:
>assign -help (or assign ?)
Display CLI version information.
show version
->show version
Displays CLI version and copyright information
Command line 60
Page 61
assign a server profile to a device bay
Managed Elements:
profile
Examples:
assign profile MyProfile enc0:1
•Management element help—provides a listing of objects that are supported with a specific
subcommand and a brief description of the management element and what it represents in the
management model:
->help devicebay
General Enclosure Device Bay settings and information
This command displays all device bays in the domain
Syntax:
show devicebay [<DeviceBayName> | *]
Parameters:
DeviceBayName : The reference name of a device bay in the domain.
The format of the device bay name is
<EnclosureID:DeviceBay>
Examples:
- Display a summary listing of all device bays:
->show devicebay
- Show detailed information for all device bays:
->show device bay *
- Show detailed information for a specific device bay 2 of
a specific enclosure:
Command line 61
Page 62
->show devicebay enc0:2
Output format
The CLI provides two different output formats:
• Interactive user output format
• Scriptable output format
The interactive user output format is the default. However, by using a command-line option, the user can
also specify a "parse-friendly" output format, which provides data in a format that can be easily
interpreted by automated scripts invoking the CLI. The different output formats primarily impact the show
Interactive user output format
subcommand in the CLI infrastructure, where a majority of the informational details are displayed.
The interactive user output format provides a user friendly view of information at the command line. When
providing an overview, or listing, of several instances of data, a tabular text format is displayed. If an
individual instance of data is being displayed, then the stanza format is used.
Example 1: Tabular text output format for displaying a user list
->show user
============================================================================
UserName Privileges FullName ContactInfo Enabled
============================================================================
Administrator domain Steve Johnson steve.johnson@hp.com true
server
network
storage
---------------------------------------------------------------------------Admin domain Admin Admin true
server
network
storage
---------------------------------------------------------------------------steve domain Steve Johnson steve.johnson@hp.com true
server
network
storage
---------------------------------------------------------------------------brad domain Brad Mills brad.mills@hp.com true
server
---------------------------------------------------------------------------jim network Jimmy Joe jimmy.joe@hp.com true
Command line 62
Page 63
---------------------------------------------------------------------------alice storage Alice Candle alice.candle@hp.com false
Example 2: Stanza output format for displaying a single user instance
->show user steve
UserName : steve
Privileges : domain,server,network,storage
FullName : Steve Johnson
ContactInfo : steve.johnson@hp.com
Enabled : true
Example 3: Stanza output format for displaying all user details
->show user *
UserName : Administrator
Privileges : domain,server,network,storage
FullName : Steve Johnson
ContactInfo : steve.johnson@hp.com
Enabled : true
UserName : jim
Privileges : network
FullName : Jimmy Joe
ContactInfo : jimmy.joe@hp.com
Enabled : true
UserName : alice
Privileges : storage
FullName : Alice Candle
ContactInfo : alice.candle@hp.com
Command line 63
Page 64
Enabled : false
Scriptable output format
Scriptable output format allows scripts to invoke CLI commands and receive command responses that can
be easily parsed by the scripts. This capability is provided by two options that are available: output=script1 and -output=script2. These options are described in more detail below. To display output
with no headers or labels, use no-headers as an additional output option value.
IMPORTANT: If the delimiter is present within the data, then the entire value is surrounded by
• Script1 Output Format
• Script2 Output Format
double quotes.
The script1 output format can be used to format the output using a name-value pair format, using an
equal sign as the delimiter. All text on the left side of the equal sign designates the "name" of a
property, and the text on the right side of the equal sign designates the "value" of the property. If
"no-headers" is provided as an additional option value, only the values are displayed. Each
property is displayed on a separate line.
The script2 output format can be used to format all instance data in a single line, using a semi-colon
as the delimiter for the data. The first line contains the property names. This format is consistent with
a "table view" of the data, where the first line is represented by a list of column labels, while the
remaining lines provide the actual data being displayed. Each line represents a single instance of
data. For example, in the case of showing users, each line provides all data corresponding to a
single user instance.
The following examples provide some common scenarios for using the script output format options.
Example 1: Scriptable output format displaying all enclosures
->show enclosure -output=script1
ID=enc0
Name=Enclosure1
Import Status=Imported
Serial Number=USE0000BK2
Part Number=403321-021
Asset Tag=OA ASSET 453
Example 2: Scriptable output format displaying user "Administrator" information
->show user Administrator -output=script1
User Name=Administrator
Privileges=domain,server,network,storage
Full Name=
Contact Info=
Enabled=true
Example 3: Scriptable output format displaying all users (with table header)
Example 5: Scriptable output format displaying a single user (with table header)
->show user steve -output=script2
UserName;Privileges;FullName;ContactInfo;Enabled
steve;domain,server,network,storage;Steve
Johnson;steve.johnson@hp.com;true
Example 6: Scriptable output format displaying a single user (no table header)
->show user steve -output=script2,no-headers
steve;domain,server,network,storage;Steve
Johnson;steve.johnson@hp.com;true
Command line 65
Page 66
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. Establishing a Virtual Connect domain enables administrators to upgrade, replace,
or move servers within their enclosures without changes being visible to the external LAN/SAN
environments.
Before getting started, perform the following tasks:
• Verify that the HP Onboard Administrator is running the latest firmware (must be at least v2.20 or
later).
• Locate the Default Network Settings label attached to the HP 1/10Gb VC-Enet module in
interconnect module bay 1 and note the following information:
o DNS name
o User name
o Password
• Connect any Ethernet module stacking cables
IMPORTANT: After a CLI command is issued, it can take up to 90 seconds before
configuration changes are stored in persistent memory. Disruptive actions such as powering
The following sections provide the necessary steps to set up a basic domain.
For detailed information on a particular command, see "Managed elements (on page 12)."
cycling an I/O module within this time window can result in lost configuration changes.
Logging in to the CLI
The Virtual Connect Manager CLI can be accessed remotely through any SSH session ("Remote access to
the Virtual Connect Manager" on page 10):
• SSH
>ssh 192.168.0.120
login as: Administrator
password:
• Local User Authentication using default Administrator login credentials
>ssh 192.168.0.120
login as: Administrator
Configuring the Virtual Connect domain using the CLI 66
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. Establishing a Virtual Connect domain enables administrators to upgrade, replace,
or move servers within their enclosures without changes being visible to the external LAN/SAN
environments.
Before getting started, perform the following tasks:
• Verify that the Onboard Administrator is running the latest firmware (must be at least v1.30 or later).
• Locate the Default Network Settings label attached to the HP 1/10Gb VC-Enet Module in
interconnect module bay 1 and note the following information:
o DNS name
o User name
o Password
• Connect any Ethernet module stacking cables
After logging in, perform the following tasks to setup the domain:
To set the domain name, use the set domain command:
>set domain name=MyNewDomainName
The Virtual Connect domain name must be unique within the data center, and can be up to 64 characters
without spaces or special characters.
Configuring local users
• Add a new user
Configuring the Virtual Connect domain using the CLI 67
Page 68
>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.
Each account can be set up to have a combination of up to four access privileges:
• Domain
o Define local user accounts, set passwords, define roles
o Import enclosures
o Name the VC domain
o Set the domain IP address
o Update firmware
o Administer SSL certificates
o Delete the VC domain
o Save configuration to disk
o Restore the configuration from a backup
• Networking
o Configure network default settings
o Select the MAC address range to be used by the VC domain
o Create, delete, and edit networks
o Create, delete, and edit shared uplink sets
• Server
o Create, delete, and edit server Virtual Connect profiles
o Assign and unassign profiles to device bays
o Select and use available networks
o Power on and off server blades within the enclosure
• Storage
o Select the WWNs to be used by the domain
o Setup the connections to the external FC Fabrics
Configuring the Virtual Connect domain using the CLI 68
Page 69
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.110 enabled=true
• Add/Remove LDAP directory groups
>add ldap-group MyNewGroup description="This is my test group"
privileges=domain,server,network
• Enable/Disable local users
>set ldap localusers=disabled
• Display LDAP settings and directory groups
>show ldap
>show ldap-group
Network setup
To establish external Ethernet network connectivity for the HP BladeSystem c-Class enclosure, do the
following:
1. Identify the MAC addresses to be used on the server blades deployed within this Virtual Connect
domain.
2. Setup connections from the HP BladeSystem c-Class enclosure to the external Ethernet networks.
These connections can be uplinks dedicated to a specific Ethernet network or shared uplinks that
Configuring MAC Address ranges
carry multiple Ethernet networks with the use of VLAN tags.
IMPORTANT: Configuring Virtual Connect to assign server blade MAC addresses requires
careful planning to ensure that the configured range of MAC addresses is used once within the
environment. Duplicate MAC addresses on an Ethernet network can result in a server network
outage.
Each server blade Ethernet NIC ships with a factory default MAC address. The MAC address is a 48-bit
number that uniquely identifies the Ethernet interface to other devices on the network. While the hardware
ships with default MAC addresses, Virtual Connect has the ability to assign MAC addresses that will
Configuring the Virtual Connect domain using the CLI 69
Page 70
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. Reusing address ranges could result in server network outages
caused by multiple servers having the same MAC addresses.
If using Virtual Connect assigned MAC addresses, the following notes apply:
• Virtual Connect automatically reserves both a primary address and an iSCSI MAC address for use
by multifunction gigabit server adapters, such as the HP NC373m PCI Express Dual Port
Multifunction Gigabit server adapter. Only the primary MAC address is used by standard (not
multifunction) Ethernet devices.
• If a server blade is moved from a Virtual Connect managed enclosure to a non-Virtual Connect
enclosure, the local MAC addresses on that server blade are automatically returned to the original
factory defaults.
• If a server blade is removed from a bay within a Virtual Connect domain and installed in another
bay in the same Virtual Connect domain or in a bay in a different domain, it is assigned the new set
of addresses appropriate for that server location.
Assigned MAC addresses
The MAC address range used by the Virtual connect domain must be unique within the environment. HP
provides a set of pre-defined ranges that are for use by Virtual Connect Manager and will not conflict
with server factory default MAC addresses.
When using the HP-defined MAC address ranges, ensure that each range is used only once within the
environment.
Selecting VC-assigned MAC address ranges
When using VC-assigned MAC addresses, you can choose between using an HP pre-defined MAC
address range or using a user-defined MAC address range.
• HP pre-defined MAC address range (recommended). These pre-defined ranges are reserved and will
never show up as factory default on any hardware. There are 64 ranges of 1024 unique addresses
to choose from. Be sure to use each range only once within a data center.
• User-defined MAC address range. To avoid potential conflict with other hardware MAC addresses
in the environment, consider using a subrange of MAC addresses reserved by the IEEE for locally-
administered MAC addresses. Ensure that the range does not conflict with any Ethernet device
already deployed within the enterprise.
IMPORTANT: If you plan to use RDP for RedHat Linux installation and also plan to use User- or
HP-defined MAC addresses, you must import the enclosure before running RDP.
Select the type and range of MAC address, and then click Next.
NOTE: After any server profiles are deployed using a selected MAC address range, that
range cannot be changed until all server profiles are deleted.
Configuring the Virtual Connect domain using the CLI 70
Page 71
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:
To display Ethernet network properties, use the show network command:
• Summary display
>show network
• Detailed display
>show network *
• Single network display
> show network MyNetwork
Adding uplink ports to an enet-network
To add uplink ports to an existing Ethernet network, use the add uplinkport command:
>add uplinkport enc0:1:1 network=MyNetwork
>add uplinkport 1:1 network=MyNetwork
Modifying uplink port properties
To modify an uplink port that exists as a member of a network or shared uplink set, use the set
uplinkport command:
>set uplinkport network=Network1 speed=1Gb
Creating a shared uplink port set
To create a shared uplink port set, use the add uplinkset command:
>add uplinkset MyUplinkSetName
A shared uplink set is a way of identifying HP 1/10Gb VC-Enet module uplinks that will carry multiple
networks over the same cable. In this case, each Ethernet packet carries a VLAN tag (IEEE 802.1Q) to
identify the specific network to which it belongs. On shared uplinks, the VLAN tags are added when
packets leave the VC-enabled enclosure and are removed when packets enter the enclosure. The external
Ethernet switch and the Virtual Connect Manager must be configured to use the same VLAN tag identifier
(a number between 1 and 4094) for each network on the shared uplink(s).
Virtual Connect places no special restrictions on which VLAN identifiers can be used, so the VLAN IDs
already used for the networks in the data center can be used on these shared uplinks. To configure a
shared uplink set for VLAN tagging, obtain a list of the network names and their VLAN IDs.
A shared uplink set enables multiple ports to be included to support port aggregation and link failover
with a consistent set of VLAN tags.
Configuring the Virtual Connect domain using the CLI 71
Page 72
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. Only one associated network can be designated as the native VLAN. All outgoing Ethernet packets are VLAN tagged.
Displaying shared uplink port sets
• Summary display
>show uplinkset
• Detailed display
>show uplinkset *
• Single uplinkset display
>show uplinkset MyUplinkSetName
Adding uplink ports to a shared uplink port set
To add uplink ports to a shared uplink port set, use the add uplinkport command:
To configure external Fibre Channel connectivity for the HP BladeSystem c-Class enclosure, do the
following:
1. Identify WWNs to be used on the server blades deployed within this Virtual Connect Domain.
Configuring WWN address ranges
2. Define SAN fabrics.
• VC-Defined
>set domain WwnType=VC-Defined WwnPool=5
• Factory-Default
>set domain WwnType=Factory-Default
Each server blade FC HBA mezzanine card ships with factory default port and node WWNs for each FC
HBA port. Each WWN is a 64-bit number that uniquely identifies the FC HBA port/node to other devices
on the network. While the hardware ships with default WWNs, Virtual Connect has the ability to assign
WWNs that will override the factory default WWNs while the server remains in that Virtual Connect
enclosure. When configured to assign WWNs, Virtual Connect securely manages the WWNs by
Configuring the Virtual Connect domain using the CLI 72
Page 73
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.
Configuring Virtual Connect to assign WWNs in server blades maintains a consistent storage identity
(WWN) even when the underlying server hardware is changed. This method allows server blades to be
replaced without affecting the external Fibre Channel SAN administration.
CAUTION: To avoid storage networking issues and potential loss of data associated with
duplicate WWNs on a FC SAN fabric, plan carefully when allowing Virtual Connect to assign
server blade WWNs so that the configured range of WWNs is used only once within the
environment.
The WWN range used by the Virtual Connect domain must be unique within the environment. HP
provides a set of pre-defined ranges that are reserved for use by Virtual Connect and will not conflict with
server factory default WWNs.
When using the HP-defined WWN ranges, be sure that each range is used only once within the
environment.
Displaying FC fabrics
To display a list of all FC SAN fabrics, use the show fabric command:
>show fabric
Server Profile setup
A Virtual Connect server profile is a logical grouping of attributes related to server connectivity that can
be assigned to a server blade. With the Virtual Connect v1.10 and higher, the server profile can include
MAC address, PXE, and network connection settings for each server NIC port and WWN, SAN fabric
connection, and SAN boot parameter settings for each Fibre Channel HBA port. After being defined, the
server profile can be assigned to any server blade within the Virtual Connect domain. A Virtual Connect
domain can have a maximum of 64 Virtual Connect server profiles.
Virtual Connect provides 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.
Virtual Connect also provides the ability to override the Virtual Connect assigned MACs and/or WWNs
when creating a new profile.
When a server profile is assigned to a server blade, the Virtual Connect Manager securely connects to the
server blade, configures the NIC ports with the appropriate MAC addresses and PXE settings, and
configures the FC HBA ports with the appropriate WWNs and SAN boot settings. In addition, the Virtual
Connect Manager automatically connects the server blade Ethernet and Fibre Channel ports to the
specified networks and SAN fabrics. This server profile can then be re-assigned to another server blade
as needed, while maintaining the server's network and SAN identity and connectivity.
The Virtual Connect Manager can be configured so that server blades use server factory default
MACs/WWNs or Virtual-Connect-administered MACs/WWNs. These administered values override the
default MAC addresses and WWNs when a server profile is assigned to a server, and appear to pre-
Configuring the Virtual Connect domain using the CLI 73
Page 74
boot environments and host operating system software as the hardware addresses. To use administered
MAC addresses, select a range of HP pre-defined or user-specified MAC addresses.
Be sure to review the following list of guidelines before creating and deploying server profiles:
• The server blade firmware and option card firmware must be at a revision that supports Virtual
Connect profile assignment. See the HP website (http://www.hp.com/go/bladesystemupdates
).
• Before creating the first server profile, select whether to use moveable, administered MAC addresses
and WWNs or whether to use the local server blade factory default MAC addresses and WWNs.
• After an enclosure is imported into a Virtual Connect domain, server blades remain isolated from the
networks and SAN fabrics until a server profile is created and assigned.
• Server blades must be powered off to receive (or relinquish) a server profile assignment when using
Virtual Connect-administered MAC addresses, WWNs, or changing Fibre Channel boot parameters.
• FC SAN Connections are only shown in server profile screens when there is an HP Virtual Connect
Fibre Channel Module in the enclosure managed by Virtual Connect. FC SAN Connections are
added in pairs and cannot be deleted. If an HP Virtual Connect Fibre Channel Module is added to a
Virtual Connect domain that has existing profiles, an option to add FC connections appears in the
existing profiles when editing.
• Some server profile SAN boot settings (controller boot order) are only applied by Virtual Connect
after the server blade has been booted at least once with the final mezzanine card configuration.
• If PXE, controller boot order, or SAN boot settings are made outside of Virtual Connect (using RBSU
or other configuration tools), Virtual Connect will restore the settings defined by the server profile
after the server blade completes the next boot cycle.
• If using a QLogic HBA with some versions of Linux (RHEL3, RHEL4, SLES9, and SLES10), the HBA
connection type must be set to "point to point only" in the adapter configuration settings in the
QLogic BIOS utility or QLogic OS utility (if available). If the HBA settings are not changed, the HBA
may be unable to log into the fabric and discover devices on the SAN.
Server profiles are associated with a specific enclosure device bay. After a profile is assigned, the Virtual
Connect Manager configures the server blade in that device bay with the appropriate
MAC/PXE/WWN/SAN boot settings and connects the appropriate networks and fabrics. Server blades
that have been assigned a profile and remain in the same device bay do not require further Virtual
Connect Manager configuration during server or enclosure power cycle. They will boot and gain access
to the network and fabric when the server and interconnect modules are ready.
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. This feature
prevents duplicate MAC addresses and WWNs from appearing in the data center because of a server
blade redeployment.
NOTE: If you are using server factory default MAC addresses WWNs and default Fibre
Channel boot parameters, you do not have to power off a server to make any profile changes.
If you are using HP assigned or user assigned MAC addresses or WWNs, you must power a
server off when moving a profile to the server or away from the server.
Configuring the Virtual Connect domain using the CLI 74
Page 75
Creating server profiles
To create a new server profile, use the add profile command:
>add profile MyProfile
After an enclosure is imported into a Virtual Connect domain, server blades that have not been assigned
a server profile are isolated from all networks to ensure that only properly configured server blades are
attached to data center networks.
A server profile can be assigned and defined for each device bay so that the server blade can be
powered on and connected to a deployment network. These profiles can then later be modified or
replaced by another server profile.
A server profile can also be assigned to an empty bay to allow deployment at a later date.
Adding enet-network connections to a profile
To add a new Ethernet network connection to an existing server profile, use the add enet-connection
command:
To add a new FC SAN connection to an existing server profile, use the add fc-connection
command:
>add fc-connection MyProfile fabric=SAN_5
Assigning a server profile to device bay 1
To assign a server profile to a specific device bay, use the assign profile command:
>assign profile MyProfile enc0:1
>assign profile MyProfile 1
Configuring IGMP settings
To set Ethernet IGMP snooping properties, use the set igmp command:
> set igmp enabled=true timeout=30
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). For optimum
network resource usage, set the interval to match the configuration on the customer network's multicast
router settings.
Configuring MAC cache failover settings
•To configure MAC Cache Failover Settings, use the set mac-cache command:
>set mac-cache enabled=true refresh=10
•To display MAC Cache Failover Settings, use the show mac-cache command:
>show mac-cache
Configuring the Virtual Connect domain using the CLI 75
Page 76
When a VC-Enet uplink that was previously in standby mode becomes active, it can take several minutes
for external Ethernet switches to recognize that the c-Class server blades can now be reached on this
newly-active connection. Enabling Fast MAC Cache Failover causes Virtual Connect to transmit Ethernet
packets on newly-active links, which enables the external Ethernet switches to identify the new connection
(and update their MAC caches appropriately.) This transmission sequence repeats a few times at the
MAC refresh interval (5 seconds recommended) and completes in about 1 minute.
IMPORTANT: Be sure to set switches to allow MAC addresses to move from one port to
another without waiting for an expiration period or causing a lock out.
Logging out of the CLI
To log out of the CLI, use the exit command:
>exi"
Common management operations
The following table provides the syntax for the most commonly used management operations.
For detailed information on a particular command, see "Managed elements (on page 12)."
Force a failover to the standby VC Manager
Power off server blades
Power on server blades
Reset a server blade
Unassign a server profile from a device bay
Modify Ethernet network connection properties
Modify FC fabric connections
>delete domain
>update firmware
url=http://www.mywebserver.com/images/vc-
1.31.rom
>reset vcm - failover
>poweroff server enc0:2
>poweroff server 3
>poweroff server *
>poweron server enc0:1
>poweron server 2
>poweron server *
>reboot server enc0:4
>reboot server 6
>reboot server *
>unassign profile MyProfile
>set enet-connection MyProfile 1
pxe=disabled
>set fc-connection MyProfile 2 speed=auto
Resetting the Virtual Connect Manager
To reset the Virtual Connect Manager, use the reset vcm command:
>reset vcm
>reset vcm [-failover]
Administrator privileges are required for this operation.
If VC Ethernet Modules are installed in I/O bays 1 and 2 of the enclosure, the user can manually change
which Virtual Connect Ethernet Module is hosting the Virtual Connect Manager through the use of this
feature. The feature can also force the Virtual Connect manager to restart without switching to the
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.
If the command line option -failover is included in the reset vcm command and a Virtual Connect
Ethernet module is available in the alternate I/O bay (I/O Bays 1 and 2 can host the Virtual Connect
Manager), the command line displays the message:
SUCCESS: The Virtual Connect Manager is being reset. Please wait...
The user is logged out of the session after approximately 1 minute. An attempted login to the same Virtual
Connect Ethernet Module is rejected with the message:
Configuring the Virtual Connect domain using the CLI 77
Page 78
Virtual Connect Manager not found at this IP address.
If the user attempts to login to the alternate I/O bay, they might receive the error message during the
attempted login:
Unable to communicate with the Virtual Connect Manager. Please retry
again later.
The login should succeed after the Virtual Connect Manager has restarted on this alternate Virtual
Connect Ethernet module. Allow up to 5 minutes, depending on the enclosure configuration.
If the command line option -failover is not included in the reset vcm command or a Virtual Connect
Ethernet module is not available in the alternate I/O bay, the command line displays the message:
SUCCESS: The Virtual Connect Manager is being reset. Please wait...
The user is logged out of the session after approximately 1 minute. If the user attempts to re-login they
might receive the error message during the attempted login:
Unable to communicate with the Virtual Connect Manager. Please retry
again later.
The login should succeed after the Virtual Connect Manager has restarted. Allow up to 5 minutes,
depending on the enclosure configuration.
Configuring the Virtual Connect domain using the CLI 78
Page 79
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 the HP US service locator webpage (http://www.hp.com/service_locator).
• In other locations, see the Contact HP worldwide (in English) webpage
scriptable output format 64
server command 40
server identification 43
server profile, assigning to a device bay 75
setting the domain name 67
shared uplink port set, creating 71
shared uplink port sets, displaying 72
SNMP (Simple Network Management Protocol) 46
SNMP traps 47
SNMP traps, enabling 47
SSH administration 49
SSH key authorization 49
SSH key authorization, tool definition files 49
SSH key, adding 49
SSH key, administration 49
SSH keys, authorized 49
SSH keys, importing 49
SSL certificate administration 50
stackinglink command 52
status command 52
subcommands 12
Support-info 52
system log 52
systemlog command 52
version command 60
T
technical support 79
U
uplink port properties, modifying 71
uplink ports, adding 71
uplink ports, adding to shared uplink port set 72
uplinkport command 53
uplinkset command 55
user command 57
user profile 59
V
vcm command 60
Index 83
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.