User`s guide
4 XgOS User’s Guide • September 2014
For example, to get command-completion hints and context-sensitive help about
adding a vNIC:
Online Help
In addition to command completion, the CLI includes online help topics at various
levels. To access these topics enter help <command>. The CLI displays the detailed
help topic for that item, if such a topic is available.
Certain higher-level concepts also have help topics within the CLI. Enter help
<TopicName> to see these help items. Topics in the CLI online help include:
■ Getting-started: Information about getting started with the system
■ Scripts: Information about the use of scripts
■ Concepts: High-level concepts describing the OVN system
■ High Availability: High availability features
■ VLANS: Virtual LAN features
■ QoS: Quality of Service features
■ Aikido: Information on the Aikido programming language used by the CLI for
scripting facilities
■ Roles: Xsigo's Role Based Access Control mechanism
■ Phone-Home: the command for Xsigo ProWatch facility for remote diagnostics
For example, to view the help topic about adding vNICs:
add vnic ?
Possible completions:
<name> Virtual NIC name
Repeat '?' for detailed help.
help add vnic
Add a new virtual Network Interface Card (vNIC) to the system. You must provide
a hierarchical name for the vNIC at the time that it is added. A 'hierarchical'
name includes the name of the vNIC, plus the name of the server profile to which
the vNIC is assigned. The two names are separated by the dot '.' character. For
example: 'add vnic <vNIC_name>.<server_profile_name>'.
A second (optional) parameter of the 'add' command specifies the termination for
the vNIC. A vNIC can be terminated on an I/O port. For example:
‘add vnic <vNIC_name>.<server_profile_name> slot/port'.