PowerScale OneFS 9.2.1.0 CLI Administration Guide

PDF

Syntax diagrams

The format of each command is described in a syntax diagram.

The following conventions apply for syntax diagrams:


Element	Description
[ ]	Square brackets indicate an optional element. If you omit the contents of the square brackets when specifying a command, the command still runs successfully.
< >	Angle brackets indicate a placeholder value. You must replace the contents of the angle brackets with a valid value, otherwise the command fails.
{ }	Braces indicate a group of elements. If the contents of the braces are separated by a vertical bar, the contents are mutually exclusive. If the contents of the braces are not separated by a bar, the contents must be specified together.
\|	Vertical bars separate mutually exclusive elements within the braces.
...	Ellipses indicate that the preceding element can be repeated more than once. If ellipses follow a brace or bracket, the contents of the braces or brackets can be repeated more than once.

Each isi command is broken into three parts: command, required options, and optional options. Required options are positional, meaning that you must specify them in the order that they appear in the syntax diagram. However, you can specify a required option in an alternative order by preceding the text displayed in angle brackets with a double dash. For example, consider isi snapshot snapshots create.

isi snapshot snapshots create <name> <path> 
  [--expires <timestamp>] 
  [--alias <string>]
  [--verbose]

If the <name> and <path> options are prefixed with double dashes, the options can be moved around in the command. For example, the following command is valid, where onefs_root is your OneFSinstallation's root directory:

isi snapshot snapshots create --verbose --path /onefs_root/data --alias newSnap_alias --name newSnap

Shortened versions of commands are accepted as long as the command is unambiguous and does not apply to multiple commands. For example, isi snap snap c newSnap /onefs_root/data is equivalent to isi snapshot snapshots create newSnap /onefs_root/data because the root of each word belongs to one command exclusively. If a word belongs to more than one command, the command fails. For example, isi sn snap c newSnap /onefs_root/data is not equivalent to isi snapshot snapshots create newSnap /onefs_root/data because the root of isi sn could belong to either isi snapshot or isi snmp.

If you begin typing a word and then press TAB, the rest of the word automatically appears as long as the word is unambiguous and applies to only one command. For example, isi snap completes to isi snapshot because that is the only valid possibility. However, isi sn does not complete, because it is the root of both isi snapshot and isi snmp.