HP 449298-001 manual Command line syntax, Parameters, Options

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> <managed element> <parameters> [<options>] [<properties>]

Item

Description

 

 

subcommand

Operation performed on a managed element

 

 

managed element

Management entity being operated on

 

 

parameters

Command extensions for a particular management operation

 

 

options

Attributes used to customize or control command execution behavior such as output

 

format, quiet-mode, and others

 

 

properties

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

 

mainly for set and add operations

 

 

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

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

Image 6
Contents HP Virtual Connect Manager Command Line Interface User Guide Audience assumptions Contents Technical support Command line overview IntroductionVirtual Connect overview Parameters Command line syntaxSubcommand managed element parameters options properties OptionsCLI command execution modes PropertiesRemote access to the Virtual Connect Manager Command line SubcommandsManaged elements Devicebay DomainSupported actions delete, help, set, show Enclosure Enet-connection Supported actions add, help, remove, setAddressType Network=SomeNetwork2 PXE=enabledAddressType=Factory-Default EthernetMACExternal-manager Fabric Fc-connection Support actions help, show, update FirmwareIgmp InterconnectLdap Ldap-group Supported actions add, help, remove, set, showMac-cache Network Profile Add profile MyNewProfile Add profile MyNewProfile2 -NoDefaultEnetConnAdd profile MyNewProfile2 -NoDefaultFcConn Assign profileSupported actions help, poweroff, poweron, reboot, show ServerPoweroff server enc0 Poweroff server enc02Poweroff server enc02 -Force Poweroff server enc02 -ForceOnTimeoutStackinglink Status SystemlogUplinkport Speed=Auto10Mb100Mb1GbDisabled Set uplinkportSet uplinkport PortID Network=NetworkName Set uplinkport enc012 Network=MyNetwork Speed=1GbUplinkset User Set user bill Password=HGtwf7272562 Set user steve Password=fgY87hHlSet user steve Password Remove user steveHelp subsystem VcmVersion Command line Output format Interactive user output formatBrad Domain Brad Mills Brad.mills@hp.com True Server Scriptable output format Command line Ssh 192.168.0.120 login as Administrator password Configuring the Virtual Connect domain using the CLIBasic configuration Ssh 192.168.0.120 login as AdministratorConfiguring local users Domain setupSetting the domain name Importing an enclosureRemove user bob Add user bob password=fhkjdhfk privileges=domain,networkSet user bob fullname=Bob J Smith enabled=false Remove userNetwork setup Configuring Ldap authentication support for usersConfiguring MAC Address ranges Assigned MAC addresses Creating an enet-network Adding uplink ports to an enet-networkCreating a shared uplink port set Adding uplink ports to a shared uplink port set Fibre Channel setupConfiguring WWN address ranges Creating a network that uses a shared uplink port setDisplaying FC fabrics Server Profile setupModifying FC fabric properties Set fabric name=MyNewName portspeed=4GbConfiguring the Virtual Connect domain using the CLI Adding enet-network connections to a profile Configuring Igmp settingsCreating server profiles Adding FC fabric connections to a server profileCommon management operations Configuring MAC cache failover settingsSet mac-cache enabled=true refresh=10 Logging out of the CLIResetting the Virtual Connect Manager Reset vcm Reset vcm -failoverVirtual Connect Manager not found at this IP address Technical support Before you contact HPHP contact information Acronyms and abbreviations IgmpPXE Index Index