The CDT Primary Configuration File
The CentralDeploymentTool.xml
file is the CDT's primary configuration file.
Important Notes:
-
Names of all elements in this XML file are case-sensitive.
-
String values are case-sensitive.
A sample configuration file is supplied with the Central Deployment Tool.
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 (see Deployment Plan). 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 |
---|---|---|
|
None |
Holds the absolute path (with the file name) on the Management Server to the CPUSE Offline package you wish to deploy. |
|
|
Defines whether to perform a Connectivity Upgrade when you upgrade a cluster. Valid values:
|
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 |
---|---|---|
|
|
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):
For example, if For example, if |
|
|
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):
For example, if For example, if |
|
|
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
For example, if For example, if Mapping between the CDT Log Level priority in the
|
|
|
Configures if the CDT shows log messages on the screen in color. Valid values:
|
The <CPUSE>
element contains this attribute:
Attribute |
Default value |
Description |
---|---|---|
|
|
Holds the absolute path (with the file name) on the Management Server to the CPUSE Agent's RPM package:
|
The <Batch>
element contains these attributes:
Attribute |
Default value |
Description |
---|---|---|
|
|
Configures the maximal integer number of Security Gateways to put in one batch, when generating the Candidates List. |
|
|
The latest date, on which a new batch is permitted to start. Format is: |
|
|
The latest time, on which a new batch is permitted to start. Format is: |
The <PreInstallationScript>
element contains these attributes:
Attribute |
Default value |
Description |
---|---|---|
|
|
Holds the absolute path (with the script name) on the Management Server to the user Pre-Installation shell script. |
|
|
Configures if the CDT stops or continues the package installation, if the user Pre-Installation script returns an error during its execution. Valid values:
|
The <PostInstallationScript>
element contains these attributes:
Attribute |
Default value |
Description |
---|---|---|
|
|
Holds the absolute path (with the script name) on the Management Server to the user Post-Installation shell script. |
|
|
Configures if the CDT stop or continues the package installation, if the user Post-Installation script returns an error during its execution. Valid values:
|
Duplicate the <PreInstallationScript>
and <PostInstallationScript>
elements according to 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 defined 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. Otherwise, delete this element.
The <MailNotification>
element contains this attribute:
Attribute |
Default value |
Description |
---|---|---|
|
|
Holds one valid e-mail address. |
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:
|
In Gaia Clish |
Perform these steps:
|
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 |
---|---|---|
|
|
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 CentralDeploymentTool.xml
:
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
Central Deployment Tool (CDT) v1.7 Administration Guide