This page provides information for creating a configuration file for the provisioning of a Control-M/Server. This configuration file is a payload JSON file that contains the details of a Control-M/Server that you want to provision.
The exact group of properties that you include in the configuration file depends on the following considerations:
|
Consideration |
Options |
|---|---|
|
OS and database |
|
|
Type of installation |
|
The following code samples show the available objects and properties that you can include within such a file for each type of installation. The rest of this page provides descriptions of all properties.
New server on Windows with MS SQL database
{
"JavaHome": "C:\\java\\Eclipse_Adoptium_jre-17.0.6.10-hotspot",
"Installation": "new",
"ControlMName": "MyControlMName",
"InstallPath": "C:\\Program Files\\BMC Software",
"Database": {
"Vendor": "MSSQL",
"Host": "10.10.10.10",
"Port": 1433,
"AdminLogin": "manager",
"AdminPassword": "*********",
"OwnerLogin": "ctmuser",
"OwnerPassword": "*********",
"Size": "Small",
"TablespaceSize": 250,
"Databasename": "ctrlmdb",
"CJK": "false",
"FullPathName": "C:\\Program Files\\Microsoft SQL Server\\MSSQL12.MSSQLSERVER\\MSSQL\\DATA\\ctmuser.dat"
},
"Log": {
"Size": 90,
"FullPath": "C:\\Program Files\\Microsoft SQL Server\\MSSQL12.MSSQLSERVER\\MSSQL\\DATA\\ctmuser.log"
},
"Configuration": {
"Hostname": "10.10.10.10",
"ControlMEMTcpIpPort": 2370,
"IPCPort": 6005,
"ConfigurationAgentPort": 2369,
"ServerToAgentPort": 7006,
"AgentToServerPort": 7005,
"HighAvailabilityPort": 2368
}
}Rehydrated server on Windows with MS SQL database
{
"JavaHome": "C:\\java\\Eclipse_Adoptium_jre-17.0.6.10-hotspot",
"Installation": "rehydrate",
"Database": {
"Host": "10.10.10.10",
"Port": 1433,
"OwnerLogin": "ctmuser",
"OwnerPassword": "*********"
},
"Configuration": {
"Hostname": "10.10.10.10",
"ControlMEMTcpIpPort": 2370,
"IPCPort": 6005,
"ConfigurationAgentPort": 2369,
"ServerToAgentPort": 7006,
"AgentToServerPort": 7005,
"HighAvailabilityPort": 2368
},
"PrimaryServer": {
"Database": "MSSQL",
"Installation": "CTM",
"Hostname": "server1"
}
}New server on Linux with Oracle database
{
"JavaHome": "C:\\java\\Eclipse_Adoptium_jre-17.0.6.10-hotspot",
"Installation": "new",
"ControlMName": "MyControlMName",
"Database": {
"Vendor": "Oracle",
"InstanceName": "ORCL",
"Host": "10.10.10.10",
"Port": 1521,
"AdminLogin": "manager",
"AdminPassword": "********",
"OwnerLogin": "ctmuser",
"OwnerPassword": "********",
"Size": "Small",
"TablespaceSize": 250,
"TablespaceName": "ctmuser_tbs"
},
"Configuration": {
"Hostname": "10.10.10.10",
"ControlMEMTcpIpPort": 2370,
"IPCPort": 6005,
"ConfigurationAgentPort": 2369,
"ServerToAgentPort": 7006,
"AgentToServerPort": 7005,
"HighAvailabilityPort": 2368
}
}Rehydrated server on Linux with Oracle database
{
"JavaHome": "C:\\java\\Eclipse_Adoptium_jre-17.0.6.10-hotspot",
"Installation": "rehydrate",
"Database": {
"InstanceName": "ORCL",
"Host": "10.10.10.10",
"Port": 1521,
"OwnerLogin": "ctmuser",
"OwnerPassword": "********"
},
"Configuration": {
"Hostname": "10.10.10.10",
"ControlMEMTcpIpPort": 2370,
"IPCPort": 6005,
"ConfigurationAgentPort": 2369,
"ServerToAgentPort": 7006,
"AgentToServerPort": 7005,
"HighAvailabilityPort": 2368
},
"PrimaryServer": {
"Database": "Oracle",
"Installation": "CTM",
"Hostname": "server1"
}
}General settings
The following table describes the General Settings object properties, which are at the top of the configuration file and define the basic settings of the Control-M/Server:
|
Property |
Description |
|---|---|
|
JavaHome |
Defines the path where a JRE is installed. If you upgrade Control-M/Server to version 9.0.21, you must set the JavaHome parameter. |
|
Installation |
Determines the type of installation:
|
|
ControlMName |
(New server only) Defines a logical name for the new Control-M/Server. |
|
InstallPath |
(New server on MS SQL only) Defines the installation path of the Control-M/Server on an MS SQL host. Typically, this is C:\\Program Files\\BMC Software |
Database settings
The following table lists the database-related properties that appear under the Database object, indicating the types of installations and databases for which each property is required.
|
Property |
Description |
New MS SQL |
Rehydrate MS SQL |
New Oracle |
Rehydrate Oracle |
|---|---|---|---|---|---|
|
Vendor |
Database vendor, either Oracle or MSSQL. |
Yes |
No |
Yes |
No |
|
InstanceName |
Name of the Oracle database instance. |
No |
No |
Yes |
Yes |
|
Host |
Host name, IP address, or alias of the database host machine. |
Yes |
Yes |
Yes |
Yes |
|
Port |
Number of the TCP/IP port for communication between Control‑M and the database. |
Yes |
Yes |
Yes |
Yes |
|
AdminLogin |
Database administrator user name. |
Yes |
No |
Yes |
No |
|
AdminPassword |
Database administrator password. |
Yes |
No |
Yes |
No |
|
OwnerLogin |
Name of the Control-M/Server database owner. |
Yes |
Yes |
Yes |
Yes |
|
OwnerPassword |
Password of the Control-M/Server database owner. |
Yes |
Yes |
Yes |
Yes |
|
Size |
Textual category for database memory requirements — SMALL, MEDIUM, or LARGE. |
Yes |
No |
Yes |
No |
|
TablespaceSize |
Total size of the Control-M/Server database. |
Yes |
No |
Yes |
No |
|
TablespaceName |
Name of the Oracle tablespace. |
No |
No |
Yes |
No |
|
DatabaseName |
Name of the Control-M/Server MS SQL database. |
Yes |
No |
No |
No |
|
CJK |
Whether the database supports CJK characters, either true or false. |
Yes |
No |
No |
No |
|
FullPathName |
Full path to the MS SQL database installation. Example: C:\\Program Files\\Microsoft SQL Server\\ MSSQL12.MSSQLSERVER\\MSSQL\\DATA\\ctmuser.dat |
Yes |
No |
No |
No |
Two more properties under the Log object are relevant only for a new server on MS SQL:
|
Property |
Description |
|---|---|
|
Size |
Amount of space (MB) to allocate for theControl-M/Server database log. |
|
FullPath |
Full path to the Control-M/Server database log. Example: C:\\Program Files\\Microsoft SQL Server\\MSSQL12.MSSQLSERVER\\MSSQL\\DATA\\ctmuser.log |
Control-M settings
The following properties under the Configuration object define settings for the Control-M/Server that you are provisioning and its interaction with the Control-M environment:
|
Property |
Description |
|---|---|
|
Hostname |
Host name, IP address, or alias of the machine on which to install the Control-M/Server. |
|
ControlMEMTcpIpPort |
Number of Control-M/Server port that listens for communication from Control-M/EM. Valid values: 1025–32767. Typical value: 2370 |
|
IPCPort |
Number of port used by the RT process for inter-process communication (IPC). Valid values: 1025–32767. Typical value: 6005 |
|
ConfigurationAgentPort |
Number of port for communication from the Control-M/Server to the Control-M/EMConfiguration Server. Valid values: 1025–32767 Typical value: 2369 |
|
ServerToAgentPort |
Number of port used by the Control-M/Agent to receive communication from the Control-M/Server. Valid values: 1024–65534 Typical value: 7006 |
|
AgentToServerPort |
Number of port used by the Control-M/Server to receive communication from the Control-M/Agent. Valid values: 1024–65534 Typical value: 7005 |
|
HighAvailabilityPort |
Number of port for communication between the Control-M/Server Configuration Agents on the primary and secondary host in a High Availability (HA) environment. Typical value: 2368 |
When performing server rehydration, the following additional properties under the PrimaryServer object define the primary server from which the Control-M/Server is being transferred:
|
Property |
Description |
|---|---|
|
Database |
Type of database on the primary server, either Oracle or MSSQL. |
|
Installation |
Type of installation. Currently only CTM is supported. |
|
Hostname |
Host name, IP address, or alias of the machine that hosts the primary server. |
YouTube
Twitter
Facebook
LinkedIn