Syntax diagram conventions

Syntax diagram conventions

To read syntax diagrams, follow the path of the line. Read from left to right, and top to bottom.
  • The ►►— symbol indicates the beginning of the syntax diagram.
  • The —► symbol at the end of a line indicates that the syntax diagram continues on the next line.
  • The ►— symbol at the beginning of a line indicates that the syntax diagram continues from the previous line.

    The —►◄ symbol indicates the end of the syntax diagram.

Syntax diagrams use position to indicate required, optional, and default values for keywords, variables, and operands:
  • On the line (required element)
  • Above the line (default element)
  • Below the line (optional element)

Abbreviations

The administrative CLI does not currently support aliases or abbreviations; however, you can use aliases that you set up in the shell environment.

Dash

A dash (-) indicates that in single-shot command mode you want to supply parameters to a command from an input stream (stdin) rather than entering parameters. In the following example, the command line gets input from the file /work/myfile:
$> sfscli cmd - < work/myfile
In the following example, the command line gets input from returned data:
$> sfscli lspool -s -hdr off -type user | sfscli rmpool -quiet -
CMMNP5083I Storage Pool mypool1 was removed successfully.
CMMNP5083I Storage Pool mypool2 was removed successfully.

Defaults

Default values are above the main line. If the default is a keyword, it appears only above the main line. You can specify this item or allow it to default. In the following example, the keyword A is the default. You can override it by choosing B or C. You can also specify the default value explicitly.
Read syntax diagramSkip visual syntax diagram
   .-A-.
>>-+-B-+-------------------------------------------------------><
   '-C-'

Optional items

Repeatable items

An arrow returning to the left means you can repeat the item, for example:
Read syntax diagramSkip visual syntax diagram
   .--------.
   V        |
>>---repeat-+--------------------------------------------------><

A character or space within the arrow means you must separate repeated items with that character or space, for example:
Read syntax diagramSkip visual syntax diagram
   .-,------.
   V        |
>>---repeat-+--------------------------------------------------><

Required items

Syntax fragments

Commands that contain lengthy groups or a section that is used more that once in a command are shown as separate fragments following the main diagram. The fragment name appears between vertical bars in the diagram. The expanded fragment also appears between vertical bars after the heading with the same fragment name.
Read syntax diagramSkip visual syntax diagram
>>-| The fragment name |---------------------------------------><

The fragment name

|--+-A-+--------------------------------------------------------|
   +-B-+
   '-C-'

Variables

Parent topic: Administrative CLI overview

Library | Support | Terms of use | Feedback
(C) Copyright IBM Corporation 2003, 2004. All Rights Reserved.
IBM TotalStorage SAN File System v2.2