Follow

exit 

ROLE: All Roles

Description

End current session.

Syntax

exit

Example

exit

Output

Goodbye!
Session closed


help 

ROLE: All Roles

Description

Displays help for commands, parameters and categories.

This command returns information on a searched command, category, parameter, string, or a list of commands than contain objects that match the search string.

Syntaxhelp on=SUBJECT search=STR 
Argumentssearch Any sequence of characters 
onName of a command or a category 
ExampleIn the following example we search for help on a snapshot.
help search=snap 
Search results: snap
      Categories:
          cg.snap
          fs.snap
          vol.snap

      Commands:
          cg.snap.create          source=CG name=NAME
                                  [snap_prefix=NAME]
                                  [snap_suffix=NAME]

          cg.snap.delete          name=SG[,SG,...]
                                  [delete_members={YES|NO|Y|N}]

          cg.snap.member_query    name=SG[,SG,...]
                                  [--detailed]
                                  [--columns=FIELD[,FIELD,...]]
                                  [--sort=FIELD[,FIELD,...]]
                                  [--format={csv|json}]
                                  [--grep=PATTERN]
                                  [--grepv|--inverted-grep=PATTERN]
ExampleIn the following example we search for help on the vol.create command.
help on=vol.create

Create a new volume.
          Syntax:
            vol.create name=NAME[,NAME,...] size=SIZE [pool=POOL]
                       [thin={YES|NO|Y|N}]
                       [ssd_cache={YES|NO|Y|N}]
                       [compression={YES|NO|Y|N}]
                       [series=SERIES]

          Arguments:
             name      A maximum of 65 Latin characters, numbers, spaces, and the                           following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation
                       marks). Leading and trailing whitespace characters are                               stripped. (multiple values, separated by commas).

            size       A positive number (up to 2 digits beyond the decimal point),                         optionally followed by a unit; e.g. 1TB, 1000000000000.

            pool       Name of an existing pool.

            thin       Either yes, or no.

            ssd_cache  Either yes, or no.

            compression  Either yes, or no.

            series     Either a range of numbers, e.g "3-7", or a single number, e.g                         "5", which is the same as "1-5". Zero-padding the numbers                             yields a zero-padded sequence. The series may contain at most                         100 items, and the index of the last item may not exceed                             10000000000.


history 

ROLE: All Roles

Description

Show user history.

Displays commands that were run by the user (by this user alone). Filterable by:

  • --grep
  • --inverted-grep.
Syntaxhistory 
ExampleRun the command with no arguments 
history 
--- COMMAND
1 pool.create name=p1 physical_capacity=10t
2 cg.create name=cg1
3 vol.create name=v-cg1- size=10g series=3
4 cg.add_member cg=cg1 member=v-cg-1,v-cg-2,v-cg-3
5 cg.member_query
6 history  
ExampleRun the command looking for a specific string 
history --grep=cg 
--- COMMAND
2 cg.create name=cg1
3 vol.create name=v-cg1- size=10g series=3
4 cg.add_member cg=cg1 member=v-cg-1,v-cg-2,v-cg-3
5 cg.member_query
ExampleRun the command excluding a specific string
history --inverted-grep=cg
--- COMMAND
1 pool.create name=p1 physical_capacity=10t
6 history

login 

ROLE: All Roles

Description

Login as another user. 

Syntaxlogin username=USERSTR 
Argumentsusername User name 
Example
login username=admin 
The command prompt. 



quit 

ROLE: All Roles

Description

End current session.

Syntax

quit

Example

quit

Output

Goodbye!
Session closed

Was this article helpful?
0 out of 0 found this helpful

0 out of 0 found this helpful

Last edited: 2022-08-06 08:36:53 UTC

Comments