Dell PowerProtect Cyber Recovery 19.15 Command-Line Interface Reference Guide

CRCLI help system

The CRCLI help system provides reference documentation that gives detailed information about each command.

After you log in to the CRCLI, you can access help:

• To view the entire help system, enter:

  # crcli

• To view help for a specific module, include the module name in the command, as shown in the following example:

  [root@cr-system]# crcli events
  
  Usages:
  crcli events list     <list all events>
               show     <show detailed information of an event>

• To view help for a specific action, include the action name after the module name, as shown in the following example:

  [root@cr-system]# crcli events show
    -e, --eventuid string   (required) ex. --eventuid 5a8364e6ef43dba08a373636
    -j, --json              (optional) ex. --json
  
  crcli events show   <Show an event details>
  
                     --eventuid <Event UID Number>
                     -e "5a8364e6ef43dba08a373636"
      Required:
                     eventuid             : The UID of the event to view
      Options:
                     json                 : Get a json detailed output returned
      Examples:
                     crcli events show --eventuid 5a8364e6ef43dba08a373636
                     crcli events show -e 5a8364e6ef43dba08a373636 -j