Accessing the vcemcli help – HP Virtual Connect Enterprise Manager Software User Manual
Page 19
Accessing the VCEMCLI help
Obtain help by running the VCEMCLI without any arguments.
GETTING STARTED:
-help : displays a list of available commands and managed elements
-help <command | managed element>: displays help on the specified item
------------------------------------------------------------------
Control commands
------------------------------------------------------------------
-logfile : The path to a logfile for VCEMCLI diagnostic logging
-loglevel : Controls the level of diagnostic logging
-logsize : The maximum size in KB of the VCEMCLI logfile
-nb : Return immediately without waiting for command results
-pollinginterval : How frequently VCEMCLI checks for results
-pw : The password to authenticate with the CMS
-serverport : The port number to use when contacting the CMS
-silent : Suppress output from VCEMCLI
-timeout : Number of seconds VCEMCLI waits for results of blocking commands
-user : The username to authenticate with the CMS
------------------------------------------------------------------
Subcommands
------------------------------------------------------------------
-add : Add a new object to the domain or to another object
-assign : Assign a server profile to a device bay
-cancelvcdmaint : Cancel maintenance mode for the VC domain.
-completevcdmaint : Complete maintenance for the VC domain.
-completevcdfwupdate : Complete firmware update for the VC domain.
-export : Export VCEM information to a CSV file.
-fcoenetwork : Name of FCoE network associated with the connection
-help : Displays a list of available subcommands
-move : Move a server profile within the VC Domain Group or across VC Domain Groups
-poweroff : Power off a bay in an enclosure
-poweron : Power on a bay in an enclosure
-remove : Remove or delete an existing object (networks, etc.)
-set : Modify one or more configuration properties of an object
-show : Display information about a job, bay power, VCEM domain status or VCEMCLI version
-startvcdmaint : Enter maintenance mode for the VC domain.
-startvcdfwupdate : Enter firmware update mode for the VC domain.
-unassign : Unassign a server profile from a device bay
------------------------------------------------------------------
Subcommand options
------------------------------------------------------------------
-authentication : Authentication method used by the initiator to login to the target.
-bayname : The name or number of the bay containing the server
-bootlun : The logical unit number (LUN) to use for SAN boot
-bootorder : Enables or disables iSCSI boot.
-bootport : The target WWPN for the SAN target
-bootpriority : Controls whether the HBA port is enabled for SAN boot
-connectionbay : The bay containing the Ethernet or SAN interface
-customspeed : The custom speed for the FCoE connection
-dhcpvendorid : String used to match the Vendor Class Id field in the DHCP offer packet.
-domainname : Virtual Connect domain name
-efistate : Specifies the presence of EFI state information
-enclosurename : The name the administrator has assigned to the VC enclosure
-exportfile : The name of a file to receive the exported VCEM information.
-fabric : The name of an existing SAN fabric to associate with the profile
-force : Forces an abrupt power off operation
-forceontimeout : Force a shutdown if normal shutdown doesn't complete in the specified timeout period
-gateway : Default IP route used by the iSCSI initiator.
-initiatorip : IP address used by the iSCSI initiator.
-initiatorname : Name used for the iSCSI initiator on the booting system.
-iscsibootparamdhcp : Allows iSCSI option ROM to retrieve iSCSI boot parameters from DHCP or static configuration.
-jobid : The VCEM jobid to report status on
-lun : The Logical Unit Number (LUN) of the Target identifies the volume to be accessed.
-mactypeoverride : Override VCEM MAC address and instead use the factory default.
-mask : IP network mask used by the iSCSI initiator.
-matchuplinkset : Requires matching Vlans on uplinkset.
-mcastfilter : Name of an existing multicast filter associated with the connection.
-mcastfilterset : Name of an existing multicast filter set associated with the connection.
-mutualsecret : Mutual Secret password for CHAPM authentication.
-mutualusername : Mutual username for CHAPM authentication.
-nag : Network Access Group
-name : The new name to be set on the profile
-network : An existing network name to be associated with the profile
-networkparamdhcp : Allows iSCSI option ROM to retrieve TCP/IP parameters from DHCP or static configuration.
-portnumber : An integer uniquely identifying network connections in the server profile
-poweronbay : Power the bay on after assigning the profile.
-profilename : The name of the profile to be managed
-pxe : Specifies preboot execution environment setting for the connection
-restoreconfig : Restore previous domain configuration if needed
-secret : Secret password for CHAP and CHAPM authentication.
-sntypeoverride : Override the VCEM serial number and instead use the factory default
-speed : The speed for the connection
-speedtype : The speed setting for iSCSI, FCoE or Ethernet connections
-targetip : Primary IP address of the iSCSI target.
-targetip2 : Alternate target IP address for use if the primary port is unavailable.
-targetname : Name of the target from which to boot.
-targetport : The TCP port associated with the primary target IP address.
Accessing the VCEMCLI help
19