Installation properties for platform options files

The topic lists the properties that you can include in the options files for platform components. The values that you assign to these properties determine the installation settings for the installation program.

To help you determine your property values, see the installation worksheets provided for the GUI installation and the Sample-platform-options-file-templates.

Note

Preparing-for-installation includes installation worksheets for the platform components. Before beginning an installation, use these worksheets to record the property values for your environment. You can use these values when setting up your options files.

Installation properties for all platform options files

The following table contains installation properties that are common for all server platform components.

Property name	Description and sample property
installLocation	Specifies the full path to the installation directory. -P installLocation=<fullPathToTheInstallationDirectory> This property is required in every options file.
AO_INSTALL_TYPE	Specifies the installation type. install_new Installs a new version of the product -J AO_INSTALL_TYPE=install_new upgrade_new Performs the following upgrade actions: Upgrades from an earlier version of the component to the latest version Repairs the latest installed version Adds new features to the current version -J AO_INSTALL_TYPE=upgrade_new This property is required in every options file.
AO_INSTALLING_FEATURES	Specifies the components to install on the target computer. REPO, CDP, AP, LAP, OCP The following property specifies the repository -J AO_INSTALLING_FEATURES=REPO The following property specifies a CDP and Operator Control Panel. -J AO_INSTALLING_FEATURES=CDP,OCP With the exception of Development Studio, this property is required in every options file.
AO_START_SERVER_ON_SUCCESS	Specifies whether to start the server after a successful installation. true: Starts the server false: Does not start the server -J AO_START_SERVER_ON_SUCCESS=true You can use this optional property with any of the components.
AO_WEBSERVER_PORT	Specifies the port number for the repository. Default value: 28080 -J AO_WEBSERVER_PORT=28080
AO_WEBSERVER_SHUTDOWN_PORT	Specifies the web server shutdown port. Default value: 28050 -J AO_WEBSERVER_SHUTDOWN_PORT=28050
AO_WEBSERVER_PROTOCOL	Specifies the protocol on which the repository is installed. Valid values: http, https (default)
AO_WEBSERVER_HOST	Specifies the fully qualified domain name of the host where you want to install the repository or any other platform components.
AO_WEBSERVER_URL	Specifies the URL used to launch the platform component.
AO_WINDOWS_SERVICE_NAME	Specifies the service name on a Windows computer. Default values: BAO-CDP, BAO-REPO, BAO-OCP, BAO-DB, BAO-AP, BAO-LAP, BAO-HACDP You can use other alphanumeric values that do not contain spaces.
AO_WINDOWS_SERVICE_DISPLAY_NAME	Specifies the service display name on a Windows computer. Default values: BMC Atrium Orchestrator <component>, where <component> has one of the default values, CDP, REPO, OCP, DB, AP, LAP, HACDP.

Installation properties for repository options file

This section lists the properties to include in an options file that installs the repository component. See also the Repository-installation-worksheet.

The authentication-related properties that you include in the options file depend on which version of the Remedy Single Sign-On (Remedy SSO or RSSO) authentication system you want to use: an existing external instance or installing the embedded version with BMC Atrium Orchestrator Platform components. Use the appropriate values for your authentication option.

Properties for repository installation

Property name	Description and sample property
AO_REPOSITORY_HA_IPADDRESS	Specifies the repository IP address for communication with the enterprise service bus. This must be an IP address that allows access from the CDP and/or the HA-CDP. -J AO_REPOSITORY_HA_IPADDRESS=<ipAddress>
AO_REPOSITORY_HA_PORT	Specifies the repository port for communication with the enterprise service bus. Default value: 28090 -J AO_REPOSITORY_HA_PORT=28090

Authentication properties for repository installation using external Remedy SSO

Property name	Description and sample property
AO_USE_EXTERNAL_RSSO	Specifies to use the external Remedy SSO instance. -J AO_USE_EXTERNAL_RSSO=true
AO_USE_EMBEDDED_RSSO	Set this to false when using the external Remedy SSO instance. -J AO_USE_EMBEDDED_RSSO=false
AO_RSSO_ADMIN_PASSWORD	Specifies administrator password to log into the external Remedy SSO instance. -J AO_RSSO_ADMIN_PASSWORD=<password>
AO_RSSO_REALM	Specifies the name of the realm used for the external Remedy SSO instance. -J AO_RSSO_REALM=<realm>
AO_EXTERNAL_RSSO_URL=https://<RSSO>:<port>	Specifies the external Remedy Single Sign-On URL. -J AO_EXTERNAL_RSSO_URL=https://<fullyQualifiedRSSOhostName>:<port>

Authentication properties for repository installation using embedded Remedy SSO

Property name	Description and sample property
AO_USE_EMBEDDED_RSSO	Specifies to install the embedded Remedy SSO instance. -J AO_USE_EMBEDDED_RSSO=true
AO_USE_EXTERNAL_RSSO	Set this to false when using the embedded Remedy SSO instance. -J AO_USE_EXTERNAL_RSSO=true
AO_RSSO_COOKIE_DOMAIN	Specifies the cookie domain for the embedded Remedy SSO instance. -J AO_RSSO_COOKIE_DOMAIN=<domain>

Installation properties for CDP options file

This section lists the properties to include in an options file that installs the primary CDP component. For more information about grid properties that you can assign during CDP installation and records of values for your environment, see the CDP-installation-worksheet.

The authentication-related properties that you include in the options file depend on which version of the Remedy Single Sign-On (Remedy SSO or RSSO) authentication system you want to use: an existing external instance or installing the embedded version with BMC Atrium Orchestrator Platform components. These properties are listed in two tables in this section. Use the appropriate values for your authentication option.

Properties for CDP installation

Property name	Description and sample property
AO_ENVIRONMENT_NAME	Specifies the name of the environment. -J AO_ENVIRONMENT_NAME=BAO Environment
AO_ADMIN_USERNAME	Specifies the name of the administrator. See Installing-the-repository for default user name and password details. -J AO_ADMIN_USERNAME=<adminUser>
AO_ADMIN_PASSWORD	Specifies the name of the administrator password. See Installing-the-repository for default user name and password details. -J AO_ADMIN_PASSWORD=<adminPassword>
AO_GRID_NAME	Specifies the grid name. A valid grid name contains 1-30 alphanumeric characters and does not contain any special characters or spaces. Default value: MyGrid -J AO_GRID_NAME=MyGrid
AO_GRID_TYPE	Specifies one of the following grid types: dev test preprod prod For more information about this grid property, see the Types table in CDP-installation-worksheet. Default value: dev -J AO_GRID_TYPE=prod
AO_GRID_LOGGING_LEVEL	Specifies one of the following logging levels: debug info warn error off For more information about this grid property, see the Logging table in CDP-installation-worksheet. Default value: debug -J AO_GRID_LOGGING_LEVEL=warn
AO_CDP_IS_PRIMARY	Specifies whether the installation is for the initial CDP. true: The peer is the primary CDP. false: This peer is HA-CDP. -J AO_CDP_IS_PRIMARY=true
AO_PEER_NAME	Specifies the name of the CDP Default value: CDP -J AO_PEER_NAME=CDP
AO_REPOSITORY_HOST	Specifies the host name or IP address for the repository. The value cannot be a loopback address. -J AO_REPOSITORY_HOST=<fullyQualifiedRepositoryHostName>
AO_REPOSITORY_PORT	Specifies the port used for the repository Default value: 28080 -J AO_REPOSITORY_PORT=28080
AO_REPOSITORY_PROTOCOL	Specifies the protocol used for the repository login page: http or https. Default value: https -J AO_REPOSITORY_PROTOCOL=https
AO_REPOSITORY_USER_NAME	Specifies the user name required to log on. -J AO_REPOSITORY_USER_NAME=<repositoryUser>
AO_REPOSITORY_PASSWORD	Specifies the password that corresponds to the user name. Note: The password value is encrypted and is not stored in the installation log. -J AO_REPOSITORY_PASSWORD=<password>
AO_CERT_PRINCIPAL	Specifies whether the certificate principal is the owner of the license; the expected value is a company name. -J AO_CERT_PRINCIPAL=<My Company Name>
AO_CERT_PASSWORD	Specifies a password that is at least six characters in length. -J AO_CERT_PASSWORD=<password>
AO_PEER_COMM_PORT	Specifies the grid peer communications port number. Default value: 61719 -J AO_PEER_COMM_PORT=61719
AO_REPOSITORY_HA_IPADDRESS	Specifies the repository IP address for communication with the enterprise service bus. This should be the repository HA address provided for the repository installation. -J AO_REPOSITORY_HA_IPADDRESS=<ipAddress>
AO_REPOSITORY_HA_PORT	Specifies the repository port for communication with the enterprise service bus. Default value: 28090 -J AO_REPOSITORY_HA_PORT=28090
AO_CDP_HA_IPADDRESS	Specifies the CDP IP address for communication with the enterprise service bus. This must be an IP address that allows access from the repository and/or the HA-CDP. -J AO_CDP_HA_IPADDRESS=<ipAddress>
AO_CDP_HA_PORT	Specifies the CDP port for communication with the enterprise service bus. Default value: 38090 -J AO_REPOSITORY_HA_PORT=38090

Authentication properties for CDP installation using external Remedy SSO

Property name	Description and sample property
AO_USE_EXTERNAL_RSSO	Specifies to use the external Remedy SSO instance. -J AO_USE_EXTERNAL_RSSO=true
AO_USE_EMBEDDED_RSSO	Set this to false when using the external Remedy SSO instance. -J AO_USE_EMBEDDED_RSSO=false
AO_RSSO_ADMIN_PASSWORD	Specifies administrator password to log into the external Remedy SSO instance. -J AO_RSSO_ADMIN_PASSWORD=<password>
AO_RSSO_REALM	Specifies the name of the realm used for the external Remedy SSO instance. -J AO_RSSO_REALM=<realm>
AO_EXTERNAL_RSSO_URL=https://<RSSO>:<port>	Specifies the external Remedy Single Sign-On URL. -J AO_EXTERNAL_RSSO_URL=https://<fullyQualifiedRSSOhostName>:<port>

Authentication properties for CDP installation using embedded Remedy SSO

Property name	Description and sample property
AO_USE_EMBEDDED_RSSO	Specifies to install the embedded Remedy SSO instance. -J AO_USE_EMBEDDED_RSSO=true
AO_USE_EXTERNAL_RSSO	Set this to false when using the embedded Remedy SSO instance. -J AO_USE_EXTERNAL_RSSO=true
AO_RSSO_COOKIE_DOMAIN	Specifies the cookie domain for the embedded Remedy SSO instance. -J AO_RSSO_COOKIE_DOMAIN=<domain>

Installation properties for Operator Control Panel options file

The following table lists the properties to include in an options file that installs the Operator Control Panel. See also the Operator-Control-Panel-installation-worksheet.

Notes

Review these notes before using the sample files for an installation.

If you are installing a non-English version of the Operator Control Panel, you must install it separately from the CDP. You must install the non-English OCP and CDP on separate Tomcat servers.
Some Remedy SSO-related properties take values specific to embedded or external Remedy SSO environments. Use the appropriate value for your environment as instructed in the comments.

Property name	Description and sample property
AO_USE_EXTERNAL_RSSO	Specifies to use the external Remedy SSO instance. This should always be set to true for a stand-alone OCP installation, because the Remedy SSO instance is external to the OCP (whether it is embedded on a BAO component or an external Remedy SSO environment). -J AO_USE_EXTERNAL_RSSO=true
AO_USE_EMBEDDED_RSSO	Set this to false for a stand-alone OCP installation. -J AO_USE_EMBEDDED_RSSO=false
AO_RSSO_REALM	For embedded Remedy SSO environments use BAOLocal or use the external Remedy SSO realm name.
AO_EXTERNAL_RSSO_URL	For embedded Remedy SSO environments use the CDP URL or use the external Remedy SSO URL.
AO_PEER_NET_CONFIG_CDP_CONTEXT	Specifies the Web context for the CDP. -J AO_PEER_NET_CONFIG_CDP_CONTEXT=baocdp
AO_PEER_NET_CONFIG_PEER_NAME	Specifies the name of the peer to which the OCP will connect. -J AO_PEER_NET_CONFIG_PEER_NAME=CDP
AO_PEER_NET_CONFIG_CDP_HOST	Specifies the host name or IP address of the CDP. -J AO_PEER_NET_CONFIG_CDP_HOST=<fullyQualifiedCDPhostName>
AO_PEER_NET_CONFIG_CDP_PORT	Specifies the web communication port for the CDP. -J AO_PEER_NET_CONFIG_CDP_PORT=38080
AO_PEER_NET_CONFIG_GRID_NAME	Specifies the name of the grid to join Default value: MyGrid -J AO_PEER_NET_CONFIG_GRID_NAME=MyGrid
AO_PEER_NET_CONFIG_PROTOCOL	Specifies the protocol: http or https. Default value: https -J AO_PEER_NET_CONFIG_PROTOCOL=https
AO_PEER_NET_CONFIG_VALIDATE	Specifies whether to validate peer communications configuration. true: enables the silent installation program to test the peer-to-CDP or OCP-to-CDP communication configuration false: continues the installation without validating the peer communication configurations Default value: true -J AO_PEER_NET_CONFIG_VALIDATE=true

Installation properties for AP options file

The following table lists the properties to include in an options file that installs an optional AP. See also the AP-installation-worksheet.

Note

Some Remedy SSO-related properties take values specific to embedded or external Remedy SSO environments. Use the appropriate value for your environment as instructed in the comments.

Property name	Description and sample property
AO_USE_EXTERNAL_RSSO	Specifies to use the external Remedy SSO instance. This should always be set to true for an AP installation, because the Remedy SSO instance is external to the AP (whether it is embedded on a BAO component or an external Remedy SSO environment). -J AO_USE_EXTERNAL_RSSO=true
AO_USE_EMBEDDED_RSSO	Set this to false for an AP installation. -J AO_USE_EMBEDDED_RSSO=false
AO_RSSO_REALM	For embedded Remedy SSO environments use BAOLocal or use the external Remedy SSO realm name.
AO_EXTERNAL_RSSO_URL	For embedded Remedy SSO environments use the CDP URL or use the external Remedy SSO URL.
AO_PEER_NET_CONFIG_CDP_HOST	Specifies the host name or IP address of the CDP. -J AO_PEER_NET_CONFIG_CDP_HOST=<fullyQualifiedHostName>
AO_PEER_NET_CONFIG_CDP_PORT	Specifies the web communication port for the CDP -J AO_PEER_NET_CONFIG_CDP_PORT=38080
AO_PEER_NET_CONFIG_CDP_USER	Specifies the user name required to log on. -J AO_PEER_NET_CONFIG_CDP_USER=<password>
AO_PEER_NET_CONFIG_CDP_PASSWORD	Specifies the password that corresponds to the user name. Note: The password value is encrypted and is not stored in the installation log. -J AO_PEER_NET_CONFIG_CDP_PASSWORD=<password>
AO_PEER_NET_CONFIG_GRID_NAME	Specifies the name of the grid to join. Default value: MyGrid -J AO_PEER_NET_CONFIG_GRID_NAME=MyGrid
AO_PEER_NET_CONFIG_NEW_PEER_NAME	Specifies the name of the new peer to install . -J AO_PEER_NET_CONFIG_NEW_PEER_NAME=AP1
AO_PEER_NET_CONFIG_PROTOCOL	Specifies the protocol: http or https. Default value: http -J AO_PEER_NET_CONFIG_PROTOCOL=http Note: Do not set the value to https unless you have configured the web server container for SSL.
AO_PEER_NET_CONFIG_VALIDATE	Specifies whether to validate peer communications configuration. true: enables the silent installation program to test the peer-to-CDP or OCP-to-CDP communication configuration false: continues the installation without validating the peer communication configurations Default value: true -J AO_PEER_NET_CONFIG_VALIDATE=true

Installation properties for LAP

The following table lists the properties to include in an options file that installs an optional LAP. See also the LAP-installation-worksheet.

Property name	Description and sample property
AO_PEER_NET_CONFIG_CDP_HOST	Specifies the host name or IP address of the CDP. -J AO_PEER_NET_CONFIG_CDP_HOST=<fullyQualifiedHostName>
AO_PEER_NET_CONFIG_CDP_PORT	Specifies the web communication port for the CDP -J AO_PEER_NET_CONFIG_CDP_PORT=38080
AO_PEER_NET_CONFIG_CDP_USER	Specifies the user name required to log on. -J AO_PEER_NET_CONFIG_CDP_USER=<password>
AO_PEER_NET_CONFIG_CDP_PASSWORD	Specifies the password that corresponds to the user name. Note: The password value is encrypted and is not stored in the installation log. -J AO_PEER_NET_CONFIG_CDP_PASSWORD=<password>
AO_PEER_NET_CONFIG_GRID_NAME	Specifies the name of the grid to join. Default value: MyGrid -J AO_PEER_NET_CONFIG_GRID_NAME=MyGrid
AO_PEER_NET_CONFIG_NEW_PEER_NAME	Specifies the name of the new peer to install . -J AO_PEER_NET_CONFIG_NEW_PEER_NAME=AP1
AO_PEER_NET_CONFIG_PROTOCOL	Specifies the protocol: http or https. Default value: http -J AO_PEER_NET_CONFIG_PROTOCOL=http Note: Do not set the value to https unless you have configured the web server container for SSL.
AO_PEER_NET_CONFIG_VALIDATE	Specifies whether to validate peer communications configuration. true: enables the silent installation program to test the peer-to-CDP or OCP-to-CDP communication configuration false: continues the installation without validating the peer communication configurations Default value: true -J AO_PEER_NET_CONFIG_VALIDATE=true

Installation properties for HA-CDP options file

This section lists the properties to include in an options file that installs optional peers. See also the HA-CDP-installation-worksheet.