Install Certificate Manager by script

This article includes updates for CM 8.12.

This article describes how to install CM servers and clients using script.

Execute the script

The properties script is loaded and executed via the -script switch command from the install shell scripts, that is, install_server.bat and install_server.sh.

Example:

CODE

install_server.bat -script install_server_script.properties

Type -help to see the available switch commands.

Use manual input

When a script is executed, it will run the normal CM installation, but the installation will be sequentially instructed from the defined parameters inside the properties file. However, it is possible to define parameters to be instructed manually by the user, just like a normal installation. This is done by the <USER_INPUT> parameter value.

Example:

CODE

database_user_password=<USER_INPUT>

Scramble sensitive parameters

Sensitive parameters, for example, passwords, can be scrambled. This is done by defining the keyword .encrypted after the target key parameter.

Scramble data in configuration files

For information about how to scramble data in configuration files, see Scramble sensitive data in configuration files in Protocol Gateway.

Values in the properties file that are marked .encrypted are scrambled by calling the installer with the -scramble switch command.

Example

CODE

install_server.bat -scramble -script install_server_script.properties

Properties to define for different components

It is essential to know before hand which properties your components requires. Note that all the required properties for a specific component MUST be defined in your properties file. Empty values are not permitted, so either give them a value or set them as <USER_INPUT>.

These tables list the parameters required (and optional) for each component.

Component (server)	Required properties	OS
ALL	`server_install_dir=<DIR_PATH>` `server_config_dir=<DIR_PATH>` `license_file_path=<FILE_PATH>` `components_install_server=<CF CIS SNMP JDBC CMDB>` `cluster_install_option=<BOOLEAN>`	ALL
SNMP	`monitoring_separate_dir_option=<BOOLEAN>` `monitoring_install_dir=<DIR_PATH>`	LIN
JDBC/CMDB	`database_host_name=<NAME>` `database_user_password=<PASSWORD>` `database_port=<NUMBER>`	ALL
JDBC	`database_engine_type=<MSSQLServer\|AzureSQLServer\|Oracle\|PostgreSQL\|MySQL\|MariaDB\|SQLite>` `database_instance_name=<NAME>` `database_user_username=<NAME>`	ALL
CMDB	`database_engine_type=<MSSQLServer>` `database_size=<NUMBER>` `database_log_size=<NUMBER>` `database_install_dir=<DIR_PATH>` `database_admin_username=<NAME>` `database_admin_password=<PASSWORD>`	ALL

Component (server)	Optional properties	OS
JAVA	`jre_path=<DIR_PATH>`	WIN

Component (clients)	Required properties	OS
ALL	`client_install_dir=<DIR_PATH>` `client_config_dir=<DIR_PATH>` `license_file_path=<FILE_PATH>` `components_install_client=<AWB RA CC SP CMSDK CMWS PGWY>`	ALL

Examples

Example: A script using CMDB on Windows

CODE

server_install_dir=C:/Program Files/Nexus/Certificate Manager/server
server_config_dir=C:/ProgramData/Nexus/CertificateManager/server
license_file_path=C:/Users/Administrator/Desktop/CM8.license
components_install_server=CF CIS SNMP CMDB
database_engine_type=MSSQLServer
database_host_name=localhost
database_port=1433
database_size=100
database_log_size=50
database_install_dir=C:/ProgramData/Nexus/cm/db
database_admin_username=sa
database_admin_password=<USER_INPUT>
database_user_password=<USER_INPUT>

Example: A script using JDBC on Linux

CODE

server_install_dir=/opt/cm/server
server_config_dir=/opt/cm/server
license_file_path=/user/home/administrator/CM8.license
components_install_server=CF CIS SNMP JDBC
monitoring_separate_dir_option=false
database_engine_type=Oracle
database_instance_name=XE
database_host_name=localhost
database_port=1521
database_user_username=lcmreq
database_user_password=<USER_INPUT>