Restore: Automated Deployment

This section offers the option to download a Configuration Import Tool to set up and configure the Software Appliances more quickly, consistently, and without manual intervention via Webconf.

The intention is to simplify the deployment process by automating standard setup tasks such as:

• network

• logging

• monitoring

• email

• external connections

as well as the reconfiguration.

Automated Deployment Process

• automates the appliance deployment process so that manual Webconf steps are completely eliminated

• restores previous configurations and applies them to new appliances or re-deployments

• integrates easier into internal workflows

• provides better use in business-critical environments (e.g., rapid on-site reconfiguration)

1. Log in to the Software Appliance.

2. Open the Restore page.

3. In the Automated Deployment section, select the Operating System for witch the Configuration Import Tool should be downloaded.
   Use the drop down menu.
   

   

   
   

Install the Configuration Import Tool on Linux:

1. Click Download in the Configuration Import Tool section.

2. Go to the folder where Configuration Import Tool was downloaded and mark the Configuration Import Tool as executable:
   chmod +x configtool-linux

3. Following is an example of how to configure the appliance to match the settings defined in the YML file by uploading it directly via the Configuration Import Tool.
   Execute using parameters and configuration file:
   ./configtool-linux -c config.yml -f upload -d <DMS> -v nx -p <OTP> -t <appliance IP>

Install the Configuration Import Tool on MacOS - Apple Silicon/Intel:

MacOS - Apple Silicon:

MacOS - Intel:

1. Click Download in the Configuration Import Tool section.

2. After opening the downloaded Configuration Import Tool a warning will appear.
   macOS Security Warning: could not verify the file.

   • Click Done in the modal dialogue.

   • Go to System Settings → Privacy & Security.

   • Scroll down and click Open Anyway.

   • Authenticate with Touch ID or your password.

   • Click Open on the final prompt

3. ./configtool-darwin-arm64 --help would not work without changing the permission level

4. To verify the Configuration Import Tool is working try the command below.
   Go to the folder where Configuration Import Tool was downloaded and run:
   ./configtool-darwin-arm64 --help
   If everything is set up correctly, the instructions for use or the help will appear.

Execute using parameters and configuration file:
./configtool-darwin-arm64 -c config.yml -f upload -d <DMS> -v nx -p <OTP> -t <appliance IP>

Install the Configuration Import Tool on Windows:

1. Click Download in the Configuration Import Tool section.

2. Once the Windows tool has finished downloading, it is immediately ready to use.

Execute using parameters and configuration file:

Execute for help:

./configtool-windows.exe --help.
Execute to operate:
./configtool-windows.exe -c config.yml -f upload -d <DMS> -v nx -p <OTP> -t <appliance IP>

How to operate the Configuration Import Tool

Reference Documentation

Example: YAML reference file: automated deployment reference.zip

Integrity Protection

For all HSM configurations that support the use of multiple HSMs the order of settings is important. The add*Hsm must happen before the set*Configuration setting.

Checksum for configuration element(s)

When using URIs (“file://“, “http://” or “https://“) to specify a configuration element, it is possible to include the checksum by appending

• ;configimport?sha256sum=<SHA256sum>

• ;configimport?sha512sum=<SHA512sum>

to the URI. Either one of the checksums or both can be used.