Getting helpΒΆ

The CLI provides a comprehensive help system, which can be invoked in different ways.

The command help displays a context-sensitive list of available commands. In edition mode, the general commands are displayed first, followed by the context specific commands.

vrouter running physical eth0# help
  cmd                  Send a command.
  commit               Commit configuration.
  copy                 Copy a configuration into another one.
  del                  Delete a configuration node.
  echo                 Echo arguments.
  exec                 Execute a cli script file.
  exit                 Quit the edition mode.
  help                 Show the help.
  load                 Load a configuration in staging (overwrite current one).
  netconf              NETCONF related commands: connect, disconnect, status.
  pwd                  Show current path.
  resize               Resize terminal.
  save                 Save the current staging configuration in a file.
  show                 Show configuration or system state.
  validate             Validate current configuration.
  yang                 YANG related commands: Load, list, show.

  ..                   Go to parent.
  /                    Go to root.
  description          A textual description of the interface.
  enabled              The desired (administrative) state of the interface.
  ethernet             Top-level container for Ethernet configuration.
  ipv4                 Parameters for the IPv4 address family.
  ipv6                 Parameters for the IPv6 address family.
  mtu                  Set the max transmission unit size in octets.
  port                 Reference to a physical network port.

The help command is also used to display a more detailed help of a command:

vrouter running physical eth0# help show
== show ==
Show configuration or system state.
show config:
  Show the configuration.
  In edition mode, display the staging configuration.
  In operational mode, display the running configuration.
  This command supports several output formats, and can be constrained
  to a specific path.
  Command syntax: show config [staging|running|startup|<file>] [text|xml|json] [all|nodefault] [relative|absolute] [<path...>]
show state:
  Show the system state.
  In edition mode, show the state of the current path.
  In operational mode, show the full the state of the system.
  This command supports several output formats, and can be constrained
  to a specific path.
  Command syntax: show state [text|xml|json] [all|nodefault] [relative|absolute] [<path...>]
show <service>
  Show a service configuration.
  Command syntax: show <service> [args...]

The context-sensitive help can be requested at any time by entering a question mark ?. It displays a list of available options:

vrouter running physical eth0# i?
  ipv4                 Parameters for the IPv4 address family.
  ipv6                 Parameters for the IPv6 address family.
vrouter running physical eth0# ipv4 ?
  <return>             Validate command.
  address              The list of configured IPv4 addresses on the interface.
  dhcp                 DHCP client configuration.
(...)