CLI Syntax Quick Reference in the Expert mode

This section provides a summary of CLI command for the Central Deployment Tool operation modes in the Expert mode.

For CLI commands in Gaia Clish, see CDT in Gaia Clish.

Notes for a Multi-Domain Security Management Server:

  1. mdsenv <IP Address or Name of Domain Management Server>

    • In the Basic Mode:

      $CDTDIR/CentralDeploymentTool <options> <IP Address or Name of Domain Management Server>

    • In the Advanced Mode and the RMA Mode:

      $CDTDIR/CentralDeploymentTool <options> -server=<IP Address or Name of Domain Management Server>

CLI Syntax Quick Reference for the Basic Mode

$CDTDIR/CentralDeploymentTool [-h | --help]

$CDTDIR/CentralDeploymentTool –generate <Path to and Desired Name of Installation Candidates List File>.csv [<IP Address or Name of Domain Management Server>]

$CDTDIR/CentralDeploymentTool -preparations <Path to Installation Candidates List File>.csv [<IP Address or Name of Domain Management Server>]

$CDTDIR/CentralDeploymentTool -extended_preparations <Path to Installation Candidates List File>.csv [<IP Address or Name of Domain Management Server>]

$CDTDIR/CentralDeploymentTool -install <Path to Installation Candidates List File>.csv [<IP Address or Name of Domain Management Server>]

Note - The CDT writes the progress details at 5 seconds intervals to these log files in the $CDTDIR directory.

  • Log files on a Security Management Server:

    • Full log:

      watch -d cat $CDTDIR/CDT_status.txt

    • Brief log:

      watch -d cat $CDTDIR/CDT_status_brief.txt

  • Log files on a Multi-Domain Security Management Server:

    • Full log:

      watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>.txt

      Example:

      watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain_MySession.txt

    • Brief log:

      watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>_brief.txt

      Example:

      watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain_MySession_brief.txt

Important - You must run this command in a new SSH shell.

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

CLI Syntax Quick Reference for the Advanced Mode

$CDTDIR/CentralDeploymentTool -generate -candidates=<Path to and Desired Name of Installation Candidates List File>.csv -deploymentplan=<Path to Deployment Plan File>.xml [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

$CDTDIR/CentralDeploymentTool -generate -candidates=<Path to and Desired Name of Installation Candidates List File>.csv -deploymentplan=<Path to Deployment Plan File>.xml -filter=<Path to Filter File, including File Extension> [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

$CDTDIR/CentralDeploymentTool -execute -candidates=<Path to Installation Candidates List File>.csv -deploymentplan=<Path to Deployment Plan File>.xml [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

Note - The CDT writes the progress details at 5 seconds intervals to these log files in the $CDTDIR directory.

  • Full log, if you specified the parameter "-session=<Name of Management Session without Spaces>":

    watch -d cat $CDTDIR/CDT_status_<Name of Management Session without Spaces>.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MySession.txt

  • Full log, if you did not specify the parameter "-session":

    watch -d cat $CDTDIR/CDT_status.txt

  • Brief log, if you specified the parameter "-session=<Name of Management Session without Spaces>":

    watch -d cat $CDTDIR/CDT_status_<Name of Management Session without Spaces>_brief.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MySession_brief.txt

  • Brief log, if you did not specify the parameter "-session":

    watch -d cat $CDTDIR/CDT_status_brief.txt

  • Full log, if you specified the parameter "-session=<Name of Management Session without Spaces>":

    watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>_<Name of Management Session without Spaces>.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain_MySession.txt

  • Full log, if you did not specify the parameter "-session":

    watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>.txt

    Example: watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain.txt

  • Brief log, if you specified the parameter "-session=<Name of Management Session without Spaces>":

    watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>_<Name of Management Session without Spaces>_brief.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain_MySession_brief.txt

  • Brief log, if you did not specify the parameter "-session":

    watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>_brief.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain_MySession_brief.txt

Important - You must run this command in a new SSH shell.

$CDTDIR/CentralDeploymentTool -retry [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

$CDTDIR/CentralDeploymentTool -resume -deploymentplan=<Path to Deployment Plan File>.xml [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

CLI Syntax Quick Reference for the RMA Mode

$CDTDIR/CentralDeploymentTool -rma -generate [-additional_files=<Path to File with List of Additional Files, including File Extension>] -candidates=<Path to and Desired Name of Installation Candidates List File>.csv [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

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

$CDTDIR/CentralDeploymentTool -rma -backup [-additional_files=<Path to File with List of Additional Files, including File Extension>] -candidates=<Path to Installation Candidates List File>.csv [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

$CDTDIR/CentralDeploymentTool -rma -backupall [-additional_files=<Path to File with List of Additional Files, including File Extension>] [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

$CDTDIR/CentralDeploymentTool -rma -restore -gateway=<Name of Security Gateway or Cluster Member Object> -license=<Path to License File, including File Extension> [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

$CDTDIR/CentralDeploymentTool -rma -restore -gateway=<Name of Security Gateway or Cluster Member Object> -license=<Path to License File, including File Extension> -package=<Path to CPUSE Offline Package, including File Extension> [-server=<IP Address or Name of Domain Management Server>] [–session=<Name of Management Session without Spaces>]

Note - The CDT writes the progress details at 5 seconds intervals to these log files in the $CDTDIR directory.

  • Full log, if you specified the parameter "-session=<Name of Management Session without Spaces>":

    watch -d cat $CDTDIR/CDT_status_<Name of Management Session without Spaces>.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MySession.txt

  • Full log, if you did not specify the parameter "-session":

    watch -d cat $CDTDIR/CDT_status.txt

  • Brief log, if you specified the parameter "-session=<Name of Management Session without Spaces>":

    watch -d cat $CDTDIR/CDT_status_<Name of Management Session without Spaces>_brief.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MySession_brief.txt

  • Brief log, if you did not specify the parameter "-session":

    watch -d cat $CDTDIR/CDT_status_brief.txt

  • Full log, if you specified the parameter "-session=<Name of Management Session without Spaces>":

    watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>_<Name of Management Session without Spaces>.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain_MySession.txt

  • Full log, if you did not specify the parameter "-session":

    watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>.txt

    Example: watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain.txt

  • Brief log, if you specified the parameter "-session=<Name of Management Session without Spaces>":

    watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>_<Name of Management Session without Spaces>_brief.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain_MySession_brief.txt

  • Brief log, if you did not specify the parameter "-session":

    watch -d cat $CDTDIR/CDT_status_<Name of Domain Management Server>_<Name of Domain>_brief.txt

    Example:

    watch -d cat $CDTDIR/CDT_status_MyDomainServer_MyDomain_MySession_brief.txt