CDT Primary Configuration File

The $CDTDIR/CentralDeploymentTool.xml file is the CDT's primary configuration file.

Important:

  • Names of all elements in this XML file are case-sensitive.

  • String values are case-sensitive.                                                                  

The Central Deployment Tool installs a sample configuration file.

Elements of the CDT Primary Configuration File

In the CDT Advanced Mode (see Advanced Mode), the packages to install are configured in the Deployment Plan File (see Deployment Plan File). If you configure the element "<PackageToInstall>" in the CDT primary configuration file, the CDT tries to run in Basic Mode.

The "<PackageToInstall>" element contains these attributes:

Attribute

Default value

Description

Path

None

Holds the absolute path (with the file name) on the Management Server to the CPUSE Offline package you wish to deploy.

ConnectivityUpgrade

true

Specifies whether to keep the current connections when you upgrade a cluster.

Accepted values:

  • true - The CDT keeps the current connections during the upgrade.

    The CDT uses the:

    • Multi-Version Cluster (MVC) Upgrade when you upgrade to R80.40 or higher.

    • Full Connectivity Upgrade (FCU) when you upgrade to R80.30 or lower.

  • false - The CDT does not keep the current connections during the upgrade.

The "<Logging>" element controls the CDT messages its writes to the CDT log file (/var/log/CPcdt/<execution time>/<log file name>).

  • Messages that the CDT shows on the screen.

  • Messages that the CDT sends to the Syslog server.

The "<Logging>" element contains these Attributes:

Attribute

Default value

Description

FileLevel

DEBUG

Holds the value of the desired priority to filter the CDT log entries that are saved in the CDT log file (order below is from highest to lowest priority):

  1. DEBUG

  2. NORMAL

  3. ERROR

  4. ALWAYS

  5. NONE

For example, if FileLevel is set to ERROR, then messages marked as DEBUG and NORMAL are not written to the CDT log file - only messages marked as ERROR and ALWAYS are written to the CDT log file.

For example, if FileLevel is set to NONE, then no messages are written to the CDT log file.

ScreenLevel

NORMAL

Holds the value of the desired priority to filter the CDT log entries that are displayed on the screen (order below is from highest to lowest priority):

  1. DEBUG

  2. NORMAL

  3. ERROR

  4. ALWAYS

  5. NONE

For example, if ScreenLevel is set to ERROR, then messages marked as DEBUG and NORMAL are not shown on the screen - only messages marked as ERROR and ALWAYS are shown on the screen.

For example, if ScreenLevel is set to NONE, then no messages are shown on the screen.

SyslogLevel

NONE

Holds the value of the desired priority to filter the CDT log entries that are sent to a Syslog server. All CDT messages are sent to the local 0 facility with the prefix CDT (order below is from highest to lowest priority):

  1. DEBUG

  2. NORMAL

  3. ERROR

  4. ALWAYS

  5. NONE

For example, if SyslogLevel is set to ERROR, then messages marked as DEBUG and NORMAL are not sent to a Syslog server - only messages marked as ERROR and ALWAYS are sent to a Syslog server.

For example, if SyslogLevel is set to NONE, then no messages are sent to a Syslog server.

Mapping between the CDT Log Level priority in the SyslogLevel element and the Syslog Severity:

  • DEBUG - debug

  • NORMAL - normal

  • ERROR - err

  • ALWAYS - info

  • NONE - Not sent to Syslog server

Colors

false

Configures if the CDT shows log messages on the screen in color.

Accepted values:

  • false - The CDT uses your default terminal settings

  • true - The CDT uses color

The "<CPUSE>" element contains this attribute:

Attribute

Default value

Description

RPMPath

/sysimg/CPwrapper/linux/CPda/CPda-00-00.i386.rpm

Holds the absolute path (with the file name) on the Management Server to the CPUSE Agent's RPM package:

CPda-00-00.i386.rpm

The "<Batch>" element contains these attributes:

Attribute

Default value

Description

MaxMachinesCount

UNLIMITED

Configures the maximal integer number of Security Gateways to put in one batch, when generating the Installation Candidates List File.

LatestAllowedDate

31/12/2099

The latest date, on which a new batch is permitted to start. Format is: DD/MM/YYYY.

LatestAllowedTime

23:59

The latest time, on which a new batch is permitted to start. Format is: HH:MM.

The "<PreInstallationScript>" element contains these attributes:

Attribute

Default value

Description

Path

None

Holds the absolute path (with the script name) on the Management Server to the user Pre-Installation shell script.

IsBlocking

true

Configures if the CDT stops or continues the package installation, if the user Pre-Installation script returns an error during its execution.

Accepted values:

  • true - The CDT stops

  • false - The CDT continues

The "<PostInstallationScript>" element contains these attributes:

Attribute

Default value

Description

Path

None

Holds the absolute path (with the script name) on the Management Server to the user Post-Installation shell script.

IsBlocking

true

Configures if the CDT stop or continues the package installation, if the user Post-Installation script returns an error during its execution.

Accepted values:

  • true - The CDT stops

  • false - The CDT continues

Duplicate the <PreInstallationScript> and <PostInstallationScript> elements based on the number of user shell scripts that the CDT needs to run on the Security Gateway.

The CDT runs these shell scripts in the order they are configured in the CDT primary configuration file.

Important - This step applies only if you configured a valid mail server on the Security Management Server or Multi-Domain Security Management Server. Otherwise, delete this element.

The "<MailNotification>" element contains this attribute:

Attribute

Default value

Description

SendTo

aa@xyz.com

Holds one valid e-mail address.

Notes:

  • Add the "<MailNotification>" element for each e-mail address.

  • CDT sends the email only to the default SMTP TCP port 25.

You must first configure a mail notification server on the Gaia OS of the Management Server (see the Gaia Administration Guide for your version):

Where

Instructions

In Gaia Portal

Perform these steps:

  1. In the left navigation tree, click System Management > Mail Notification.

  2. In the Mail Server field, enter the IP address or hostname of the Mail Server that receives the e-mails.

    For example: mail.example.com

  3. In the User Name field, enter the username on the Mail Server that receives the e-mails.

    For example: user@mail.example.com

  4. Click Apply.

In Gaia Clish

Perform these steps:

  1. Connect to the command line.

  2. Log in to the Gaia Clish.

  3. Configure the IP address or hostname of the Mail Server that receives the e-mails (for example, mail.example.com):

    set mail-notification server <IP Address or HostName of Mail Server>

    For example: mail.example.com

  4. Configure the username on the Mail Server that receives the e-mails (for example, user@mail.example.com):

    set mail-notification username <UserName on Mail Server>@<Domain Name>

    For example: user@mail.example.com

  5. Save the changes:

    save config

  6. Examine the configuration:

    show mail-notification server

    show mail-notification username

The Gaia OS sends an email notification in these events:

  • Batch installation is completed.

    The e-mail message is the installation results for each Security Gateway and Cluster selected for the installation batch.

  • Installation error.

    An installation error for a Security Gateway and Cluster generates an e-mail notification with the error details and applicable error logs.

The "<Repository>" element contains this attribute:

Attribute

Default value

Description

path

/home/admin/

Holds the location of package files on the Management Server for the RMA Mode (see RMA Mode).

Example CDT Configuration File

These are basic examples of the primary configuration file $CDTDIR/CentralDeploymentTool.xml:

Copy 
<?xml version="1.0" encoding="UTF-8" ?>
<CentralDeploymentTool>
  <PackageToInstall Path="/home/admin/toInstall.tgz" ConnectivityUpgrade="true"/>
  <Logging FileLevel="DEBUG" ScreenLevel="NORMAL" SyslogLevel="DEBUG" Colors="false"/>
  <CPUSE RPMPath="/sysimg/CPwrapper/linux/CPda/CPda-00-00.i386.rpm" />
  <Batch MaxMachinesCount="UNLIMITED" />
  <PreInstallationScript Path="/home/admin/PreScript.sh" IsBlocking="true"/>
  <PostInstallationScript Path="/home/admin/PostScript.sh" IsBlocking="true"/>
  <MailNotification SendTo="abc@example.com"/>
  <MailNotification SendTo="xyz@example.com"/>
</CentralDeploymentTool>
Copy 
<?xml version="1.0" encoding="UTF-8" ?>
<CentralDeploymentTool>
 <Logging FileLevel="DEBUG" ScreenLevel="NORMAL" SyslogLevel="NONE" Colors="false"/>
 <CPUSE RPMPath="/sysimg/CPwrapper/linux/CPda/CPda-00-00.i386.rpm"/>
  <Batch MaxMachinesCount="UNLIMITED" LatestAllowedDate="31/12/2099" LatestAllowedTime="23:59"/>
  <MailNotification SendTo="abc@example.com"/>
  <MailNotification SendTo="xyz@example.com"/>
</CentralDeploymentTool>
Copy 
<?xml version="1.0" encoding="UTF-8" ?>
<CentralDeploymentTool>
  <Logging FileLevel="DEBUG" ScreenLevel="NORMAL" SyslogLevel="NONE" Colors="false"/>
  <CPUSE RPMPath="/sysimg/CPwrapper/linux/CPda/CPda-00-00.i386.rpm"/>
  <MailNotification SendTo="abc@example.com"/>
  <MailNotification SendTo="xyz@example.com"/>
  <Repository path="/home/admin/"/>
</CentralDeploymentTool>