Sample platform options file templates

This topic contains sample options files that you can use as templates to create options files to install the repository, CDPs, APs, Operator Control Panel, Dashboards, and Development Studio.

Note

To replace the variables or sample values (such as port numbers) in these examples, use the values that you provided in your installation worksheets (see Installation worksheets).

For more information about the properties in these files, see Installation properties for platform options files.

If you are doing an upgrade instead of a fresh installation, follow the instructions in Creating options files for an upgrade.

The topic includes the following sections:

Note

The following properties listed in these options files are applicable only when you are installing the components on a Windows server:

  • #-J AO_WINDOWS_SERVICE_NAME
  • #-J AO_WINDOWS_SERVICE_DISPLAY_NAME

If you are installing components on a Windows server, uncomment these properties in the options files.

Sample options file to install BMC Atrium Single Sign-On

Before you install any of the platform components, ensure that you install BMC Atrium Single Sign-On. For more information about installing BMC Atrium Single Sign-On, see  Installing silently Open link  in BMC Atrium Single Sign-On online documentation.

Sample options file to install the repository

The following options file contains sample variable names for the properties required to install the repository.

#Replace the variables and sample values in this example.
-P installLocation=<fullPathToTheInstallationDirectory>
-J AO_INSTALL_TYPE=install_new
-J AO_INSTALLING_FEATURES=REPO,WEBSERVER
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_ATRIUMSSO_URL=https://<fullyQualifiedSSOhostName>:<port>/atriumsso
-J AO_SECURITY_COMM_HOST=<fullyQualifiedSSOhostName>
-J AO_SECURITY_WEB_PORT=8443
-J AO_SECURITY_WEB_PROTOCOL=https
-J AO_WEBSERVER_PORT=28080
-J AO_WEBSERVER_SHUTDOWN_PORT=28050
-J AO_WEBSERVER_PROTOCOL=https
-J AO_WEBSERVER_HOST=<fullyQualifiedAOwebServerHostName>
-J AO_WEBSERVER_URL=https://<fullyQualifiedAOwebServerHostName>:<webServerPort>/baorepo
-J AO_AMADMIN_PASSWORD=<password>
#Optional properties only required for Windows OS
#-J AO_WINDOWS_SERVICE_NAME=BAO-REPO
#-J AO_WINDOWS_SERVICE_DISPLAY_NAME=BMC Atrium Orchestrator REPO

Sample options file to install the CDP

The following options file contains sample variable names for the properties required to install the CDP.

#Replace the variables and sample values in this example.
-P installLocation=<fullPathToTheInstallationDirectory>
-J AO_INSTALL_TYPE=install_new
-J AO_INSTALLING_FEATURES=CDP
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_WEBSERVER_PORT=38080
-J AO_WEBSERVER_SHUTDOWN_PORT=38050
-J AO_WEBSERVER_PROTOCOL=https
-J AO_CDP_IS_PRIMARY=true
-J AO_ENVIRONMENT_NAME=BAO Environment
-J AO_GRID_NAME=MyGrid
-J AO_GRID_TYPE=dev
-J AO_GRID_LOGGING_LEVEL=debug
-J AO_PEER_NAME=CDP
-J AO_CERT_PRINCIPAL=<My Company Name>
-J AO_CERT_PASSWORD=<password>
-J AO_PEER_COMM_PORT=61719
-J AO_REPOSITORY_HOST=<fullyQualifiedRepositoryHostName>
-J AO_REPOSITORY_PROTOCOL=https
-J AO_REPOSITORY_PORT=28080
#The following two values can be either blank or valid BAO user
-J AO_ADMIN_USERNAME=<adminUser>
-J AO_ADMIN_PASSWORD=<password>
-J AO_AMADMIN_PASSWORD=<password>
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_WEBSERVER_HOST=<fullyQualifiedAOwebServerHostName>
-J AO_WEBSERVER_URL=https://<fullyQualifiedAOwebServerHostName>:<webServerPort>/baocdp
#Optional properties only required for Windows OS
#-J AO_WINDOWS_SERVICE_NAME=BAO-CDP
#-J AO_WINDOWS_SERVICE_DISPLAY_NAME=BMC Atrium Orchestrator CDP

Sample options file to install the CDP and the OCP

The following options file contains sample values for the properties that are required to install the CDP and Operator Control Panel in the same directory.

Note

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.

#Replace the variables and sample values in this example.
-P installLocation=<fullPathToTheInstallationDirectory>
-J AO_INSTALL_TYPE=install_new
-J AO_INSTALLING_FEATURES=CDP,WEBSERVER,OCP
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_WEBSERVER_PORT=38080
-J AO_WEBSERVER_SHUTDOWN_PORT=38050
-J AO_WEBSERVER_PROTOCOL=https
-J AO_WEBSERVER_HOST=<fullyQualifiedAOwebServerHostName>
-J AO_CDP_IS_PRIMARY=true
-J AO_ENVIRONMENT_NAME=BAO Environment
-J AO_GRID_TYPE=dev
-J AO_GRID_LOGGING_LEVEL=debug
-J AO_PEER_NAME=CDP
-J AO_CERT_PRINCIPAL=<My Company Name>
-J AO_CERT_PASSWORD=<password>
-J AO_PEER_COMM_PORT=61719
-J AO_PEER_NET_CONFIG_GRID_NAME=MyGrid
-J AO_OCP_DEPLOYMENT_CONTEXT=baoocp
-J AO_PEER_NET_CONFIG_VALIDATE=true
-J AO_PEER_NET_CONFIG_CDP_CONTEXT=baocdp
-J AO_PEER_NET_CONFIG_CDP_HOST=<fullyQualifiedCDPhostName>
-J AO_PEER_NET_CONFIG_CDP_PASSWORD=<password>
-J AO_PEER_NET_CONFIG_CDP_PORT=38080
-J AO_REPOSITORY_HOST=<fullyQualifiedRepositoryHostName>
-J AO_REPOSITORY_PROTOCOL=https
-J AO_REPOSITORY_PORT=28080
-J AO_ADMIN_USERNAME=<adminUser> 
-J AO_ADMIN_PASSWORD=<password>
-J AO_AMADMIN_PASSWORD=<password>
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_WEBSERVER_URL=https://<fullyQualifiedAOwebServerHostName>:<webServerPort>/baocdp
#Optional properties only required for Windows OS
#-J AO_WINDOWS_SERVICE_NAME=BAO-CDP-Test
#-J AO_WINDOWS_SERVICE_DISPLAY_NAME=BMC Atrium Orchestrator CDP-Test

Sample options file to install an activity peer

The following options file contains variable names for the properties required to install an activity peer.

#Replace the variables and sample values in this example.
-P installLocation=<fullPathToTheInstallationDirectory>
-J AO_INSTALL_TYPE=install_new
-J AO_INSTALLING_FEATURES=AP,WEBSERVER
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_WEBSERVER_PORT=38080
-J AO_WEBSERVER_SHUTDOWN_PORT=38050
-J AO_PEER_NET_CONFIG_PROTOCOL=https
-J AO_PEER_NET_CONFIG_CDP_USER=<adminUser>
-J AO_PEER_NET_CONFIG_CDP_PASSWORD=<password>
-J AO_PEER_NET_CONFIG_CDP_HOST=<fullyQualifiedCDPhostName>
-J AO_PEER_NET_CONFIG_CDP_PORT=38080
-J AO_PEER_NET_CONFIG_GRID_NAME=MyGrid
-J AO_PEER_NET_CONFIG_NEW_PEER_NAME=AP1
-J AO_PEER_NET_CONFIG_VALIDATE=true
-J AO_ENVIRONMENT_NAME=BAO Environment
-J AO_ADMIN_PASSWORD=<password>
-J AO_GRID_TYPE=dev
-J AO_GRID_LOGGING_LEVEL=warn
-J AO_WEBSERVER_HOST=<fullyQualifiedAOwebServerHostName>
#Optional properties only required for Windows OS 
#-J AO_WINDOWS_SERVICE_NAME=BAO-AP
#-J AO_WINDOWS_SERVICE_DISPLAY_NAME=BMC Atrium Orchestrator AP

Sample options file to install a lightweight activity peer

The following options file contains variable names for the properties required to install a lightweight activity peer.

#Replace the variables and sample values in this example.
-P installLocation=<fullPathToTheInstallationDirectory>
-J AO_INSTALL_TYPE=install_new
-J AO_INSTALLING_FEATURES=LAP,WEBSERVER
-J AO_ENVIRONMENT_NAME=BAO Environment
-J AO_ADMIN_PASSWORD=<password>
-J AO_GRID_NAME=GRID1
-J AO_GRID_TYPE=dev
-J AO_GRID_LOGGING_LEVEL=warn
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_PEER_NET_CONFIG_VALIDATE=true
-J AO_PEER_NET_CONFIG_CDP_CONTEXT=baocdp
-J AO_PEER_NET_CONFIG_CDP_HOST=<fullyQualifiedCDPhostName>
-J AO_PEER_NET_CONFIG_CDP_PASSWORD=<password>
-J AO_PEER_NET_CONFIG_CDP_PORT=38080
-J AO_PEER_NET_CONFIG_CDP_USER=<adminUser>
-J AO_PEER_NET_CONFIG_GRID_NAME=MyGrid
-J AO_PEER_NET_CONFIG_PEER_NAME=CDP
-J AO_PEER_NET_CONFIG_NEW_PEER_NAME=LAP1
-J AO_PEER_NET_CONFIG_PROTOCOL=https
-J AO_WEBSERVER_PORT=38080
-J AO_WEBSERVER_SHUTDOWN_PORT=38050
-J AO_WEBSERVER_DETECTED_OLD_SETTINGS=false
-J AO_SERVER_STOP_SUCCCESSFUL=false
-J AO_WEBSERVER_HOST=<fullyQualifiedAOwebServerHostName>
#Optional properties only required for Windows OS 
#-J AO_WINDOWS_SERVICE_NAME=BAO-LAP
#-J AO_WINDOWS_SERVICE_DISPLAY_NAME=BMC Atrium Orchestrator LAP

Sample options file to install an HA-CDP

The following options file contains sample values for the properties that are required to install a high-availability configuration distribution peer
HA-CDP.

#Replace the variables and sample values in this example.
-P installLocation=<fullPathToTheInstallationDirectory>
-J AO_INSTALL_TYPE=install_new
-J AO_INSTALLING_FEATURES=CDP
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_WEBSERVER_PORT=38080
-J AO_WEBSERVER_SHUTDOWN_PORT=38050
-J AO_WEBSERVER_PROTOCOL=https
-J AO_CDP_IS_PRIMARY=false
-J AO_PEER_NET_CONFIG_PROTOCOL=https
-J AO_PEER_NET_CONFIG_CDP_HOST=<fullyQualifiedCDPhostName>
-J AO_PEER_NET_CONFIG_CDP_PORT=38080
-J AO_PEER_NET_CONFIG_GRID_NAME=MyGrid
-J AO_PEER_NET_CONFIG_NEW_PEER_NAME=HACDP1
-J AO_PEER_NET_CONFIG_VALIDATE=true
-J AO_WEBSERVER_HOST=<fullyQualifiedAOwebServerHostName>
-J AO_WEBSERVER_URL=https://<fullyQualifiedAOwebServerHostName>:38080/baocdp
-J AO_REPOSITORY_HOST=<fullyQualifiedRepoServerHostName>
-J AO_REPOSITORY_PROTOCOL=https
-J AO_REPOSITORY_PORT=28080
-J AO_REPOSITORY_USER_NAME=<adminUser>
-J AO_REPOSITORY_PASSWORD=<password>
-J AO_AMADMIN_PASSWORD=<password>
#Optional properties only required for Windows OS
#-J AO_WINDOWS_SERVICE_NAME=BAO-HACDP
#-J AO_WINDOWS_SERVICE_DISPLAY_NAME=BMC Atrium Orchestrator HACDP

Sample options file to install the OCP

You can use the following sample options file to install the Operator Control Panel.

Note

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.

Non-English versions of the Operator Control Panel must be installed on servers set up for the associated locale.

#Replace the variables and sample values in this example.
-P installLocation=<fullPathToTheInstallationDirectory>
-J AO_WEBSERVER_PROTOCOL=https
-J AO_INSTALL_TYPE=install_new
-J AO_INSTALLING_FEATURES=OCP,WEBSERVER
-J AO_ENVIRONMENT_NAME=BAO Environment
-J AO_GRID_NAME=MyGrid
-J AO_GRID_TYPE=dev
-J AO_GRID_LOGGING_LEVEL=debug
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_OCP_DEPLOYMENT_CONTEXT=baoocp
-J AO_PEER_NAME=CDP
-J AO_PEER_NET_CONFIG_CDP_CONTEXT=baocdp
-J AO_PEER_NET_CONFIG_CDP_HOST=<fullyQualifiedCDPhostName>
-J AO_PEER_NET_CONFIG_CDP_PORT=38080
-J AO_PEER_NET_CONFIG_GRID_NAME=MyGrid
-J AO_PEER_NET_CONFIG_PEER_NAME=CDP
-J AO_PEER_NET_CONFIG_PROTOCOL=https
-J AO_REPOSITORY_HOST=<fullyQualifiedRepositoryHostName>
-J AO_REPOSITORY_PROTOCOL=https
-J AO_REPOSITORY_PORT=28080
-J AO_REPOSITORY_USER_NAME=<adminUser>
-J AO_REPOSITORY_PASSWORD=<password>
-J AO_AMADMIN_PASSWORD=<password>
-J AO_SECURITY_ACTIVE=true
-J AO_SECURITY_COMM_HOST=<fullyQualifiedAtriumSSOhostName>
-J AO_SECURITY_WEB_PORT=8443
-J AO_SECURITY_WEB_PROTOCOL=https
-J AO_WEBSERVER_PORT=38080
-J AO_WEBSERVER_SHUTDOWN_PORT=38050
-J AO_WEBSERVER_HOST=<fullyQualifiedAOwebServerHostName>
-J AO_ATRIUMSSO_URL=https://<fullyQualifiedAtriumSSOhostName>:8443/atriumsso
-J AO_WEBSERVER_URL=https://<fullyQualifiedAOwebServerHostName>:38080/baoocp
#Optional properties only required for Windows OS
#-J AO_WINDOWS_SERVICE_NAME=BAO-OCP
#-J AO_WINDOWS_SERVICE_DISPLAY_NAME=BMC Atrium Orchestrator OCP

Sample options file to install the Dashboards

You can use the following sample options file to install the Dashboard component.

#Replace the variables and sample values in this example.
-P installLocation=<fullPathToTheInstallationDirectory>
-J AO_INSTALL_TYPE=install_new
-J AO_INSTALLING_FEATURES=DB
-J AO_START_SERVER_ON_SUCCESS=true
-J AO_WEBSERVER_PORT=18080
-J AO_WEBSERVER_SHUTDOWN_PORT=18050
-J AO_WEBSERVER_PROTOCOL=https
-J AO_WEBSERVER_HOST=<fullyQualifiedAOwebServerHostName>
#Optional properties only required for Windows OS
#-J AO_WINDOWS_SERVICE_NAME=BAO-DB
#-J AO_WINDOWS_SERVICE_DISPLAY_NAME=BMC Atrium Orchestrator DB

Sample options file to install Development Studio

You can use the following sample options file to install Development Studio. 

#Replace the variables and sample values in this example.
-P installLocation=<fullPathToTheInstallationDirectory>
-J DEVSTUDIO_INSTALL_TYPE=install_new
-J DEVSTUDIO_WORKSPACE_DIR=<fullPathToWorkspaceDirectory>

Was this page helpful? Yes No Submitting... Thank you

Comments