CLI Syntax Quick Reference

Notes for Multi-Domain Server:

• Go to the context of the applicable Domain Management Server before you continue:

  # mdsenv <IP Address or Name of Domain Management Server>

• You must specify the IP Address or Name of the Domain Management Server in the syntax:

  # ./CentralDeploymentTool <options> <IP Address or Name of Domain Management Server>

Quick Reference for the CDT Basic Mode:

• To show built-in usage:

  # ./CentralDeploymentTool [-h | --help]

• To generate an Installation Candidates List:

  # ./CentralDeploymentTool –generate <Desired Name of Candidates List File>.csv [<IP Address or Name of Domain Management Server>]

• To run only preparations on all marked candidates in the Candidates List, run:

  # ./CentralDeploymentTool -preparations <Name of Candidates List File>.csv [<IP Address or Name of Domain Management Server>]

• To run extended preparations on all marked candidates, run:

  # ./CentralDeploymentTool -extended_preparations <Name of Candidates List File>.csv [<IP Address or Name of Domain Management Server>]

• To run a full installation on all marked candidates, run:

  # ./CentralDeploymentTool -install <Name of Candidates List File>.csv [<IP Address or Name of Domain Management Server>]

• To monitor the installation progress:

  Note - The CDT writes the progress details at 5 seconds intervals to these log files in the directory of the CentralDeploymentTool binary file.

  # watch -d cat CDT_status.txt # watch -d cat CDT_status_brief.txt

• To retry (in a new SSH shell):

  # ./CentralDeploymentTool -retry [<IP Address or Name of Domain Management Server>]

Quick Reference for the CDT Advanced Mode:

• To generate an installation Candidates List:

  # ./CentralDeploymentTool -generate -candidates=<Name of Candidates List File>.csv -deploymentplan=<Name of Deployment Plan File>.xml [-server=<IP Address or Name of Domain Management Server>]

• To select Security Gateways, for which to generate the Candidates List:

  # ./CentralDeploymentTool -generate -candidates=<Name of Candidates List File>.csv -deploymentplan=<Name of Deployment Plan File>.xml -filter=<Name of Filter File> [-server=<IP Address or Name of Domain Management Server>]

• To run a Deployment Plan on Security Gateways in the Candidates List:

  # ./CentralDeploymentTool -execute -candidates=<Name of Candidates List File>.csv -deploymentplan=<Name of Deployment Plan File>.xml [-server=<IP Address or Name of Domain Management Server>]

• To monitor the installation progress:

  Note - The CDT writes the progress details at 5 seconds intervals to these log files in the directory of the CentralDeploymentTool binary file.

  # watch -d cat CDT_status.txt # watch -d cat CDT_status_brief.txt

• To retry (in a new SSH shell):

  # ./CentralDeploymentTool -retry [<IP Address or Name of Domain Management Server>]

Quick Reference for the CDT RMA Mode:

• To show the RMA backup information of a specified remote Security Gateway:

  # ./CentralDeploymentTool -rma -info -gateway=<Name of Security Gateway or Cluster Member Object>

• To collect RMA backup from specified remote Security Gateways according to the Candidates List:

  # ./CentralDeploymentTool -rma -backup -candidates=<Name of Candidates List File>.csv [-server=<IP Address or Name of Domain Management Server>]

• To collect RMA backup information from all remote Security Gateways (Candidates List file is not needed):

  # ./CentralDeploymentTool -rma -backupall [-server=<IP Address or Name of Domain Management Server>]

• To restore the RMA backup information on a remote Security Gateway:

  # ./CentralDeploymentTool -rma -restore -gateway=<Name of Security Gateway or Cluster Member Object> -license=<Path to License file> [-server=<IP Address or Name of Domain Management Server>]

• To specify a CPUSE Clean Install package when you restore the RMA backup information:

  # ./CentralDeploymentTool -rma -restore -gateway=<Name of Security Gateway or Cluster Member Object> -license=<Path to License file> -package=<File Name of CPUSE Offline Package>.tgz [-server=<IP Address or Name of Domain Management Server>]