Command line syntax, Options, Properties – HP Virtual Connect FlexFabric 10Gb24-port Module for c-Class BladeSystem User Manual
Page 13

Introduction 13
Command line syntax
CLI input is case-insensitive, except when otherwise noted. The general CLI syntax format is as follows:
Item
Description
subcommand
Operation performed on a managed element
managed element
Target management entity
parameters
Command extensions for a particular management operation
options
Attributes used to customize or control command execution behavior such as output
format, quiet-mode, and others
properties
One or more name and value pairs that are accessories to the command operation,
mainly for set and add operations
Example: ->add user mark password=asdf89g fullname="Mark Smith" enabled=true
In the example, add is the subcommand, user is the managed element, mark is a required parameter for
the operation, password is a required property, and fullname and enabled are optional properties.
Depending on the specific command being executed, certain parameters or properties might be required.
For example, when adding a new user, both a parameter representing the user name, as well as a password
(in the form of a property) must be specified. All other user properties are optional at the time the user is
added. In general, the properties are in the format name=value. Separate multiple properties with spaces.
Press the Tab key to display auto completion options.
Options
Options enable users to control certain behavior characteristics available during the command execution.
Some examples of options include controlling output format and specifying a quiet mode to suppress
interactive prompts.
Distinguish options from other command line elements by using a preceding hyphen (-). Option arguments
are required or optional, depending on the option being specified. For example, the -output option
requires an argument, which is a list of one or more output format attributes. However, the -quiet option
does not require any arguments to be specified.
The general format of a CLI option is as follows:
-
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.
- Virtual Connect Flex-10.10D Module for c-Class BladeSystem Virtual Connect 4Gb Fibre Channel Module for c-Class BladeSystem Virtual Connect 8Gb 24-port Fibre Channel Module for c-Class BladeSystem Virtual Connect 8Gb 20-port Fibre Channel Module for c-Class BladeSystem Virtual Connect Flex-10 10Gb Ethernet Module for c-Class BladeSystem