Appliances can run a script to support third party add-ons such as external reporting or monitoring agents. It is generally not recommended to run these scripts on appliances in AppGate ZTNA as they can compromise system security, which is why they are disabled by default. However, appliance customization scripts are sometimes required in enterprise deployments. If they are required, the scripts can be enabled when an appliance is created in cz-setup or when the seed file is generated.
Before you start
Consider the following before configuring appliance customization scripts:
Each appliance can have only one script configured. If two separate functions need to be performed, then the script calls the two sub-functions that should also be included in the script.
There is a limit 200MB for all customizations configured. This is set to limit the amount of data that needs to be synced via BDR.
The .zip file must meet specific requirements set out in the Adding third party executables section.
Customization scripts must be enabled for the appliance.You can enable scripts using cz-config.
Running the customization script
Once uploaded, the script can be selected in the appliances' settings in the Miscellaneous tab. Once selected, these will then be under the control of cz-configd and will be started, stopped, and monitored the same as all the other running processes.
Viewing customized appliances
If an appliance has a customization selected, this will be shown in the Appliances page in the Version column. There will be a (c) next to the version number.
By clicking on the Status of the appliance, the detailed view window will show which specific customization is in use.
Use the Appliance Customizations page to:
View all the appliance customizations you have configured in the Collective.
Upload new appliance customizations.
Perform actions using the action buttons provided.
See the Configure Appliance Customizations page when you are ready to add a customization.
Action Buttons
Action buttons are accessed by clicking the three dots icon (
) to the right of each line item in the page or from the <Actions> button within the item. They are contextual, changing depending on the type of item and the state of the item. The Action button in the Appliance Customizations page displays the following option:
Download Customization. Downloads the zip archive for the customization.