Control-M/Server Provisioning

The Control-M/Server provision process is supported on Windows with an MS SQL database and on Linux with an Oracle database. You can create a new Control-M/Server or transfer an existing Control-M/Server from one host to another (server rehydration).

Provisioning Control-M/Server is based on images. An image is JSON code that lists the installation packages in the order they are installed. Control-M Automation API provides several default images, and you can create custom images that include, for example, a newer version of Control-M/Server.

You must obtain the Control-M/Server installation packages that are referenced in the images before provisioning. You can save these installation packages in a customized location, such as in a JFrog Artifactory repository, Amazon S3 buckets, or a local file system. Alternatively, you can set up a local repository to save the installation packages and images.

You can provision Control-M/Server with one of the following methods:

• Run separate image and setup commands: Enables you to download and prepare the installation files for Control-M/Server with the image command. You can later install and register Control-M/Server with the setup command. This is useful for dynamic installations, such as installations that use a VM image.

• Run a single install command: Performs the full Control-M/Server installation process with a single install command. This is useful for static architectures that do not distinguish between image building and instantiation.

Control-M/Serversetup or installation is based on settings that you define in a configuration file that is a payload JSON file. For the full description of this configuration file, see Control-M/Server Provisioning.

The following API commands enable you to provision or uninstall Control-M/Server:

• provision images: (For Control-M/Servers and Agents) Lists all existing images.

• provison image: (For Control-M/Servers and Agents) Downloads and prepares an image.

• provision server::setup: Installs a Control-M/Server and registers it in the Control-M environment.

• provision server::install: Combines the image and setup commands into one action.

• provision image::remove: (For Control-M/Servers and Agents) Removes an image from the user account.

• provision server::uninstall: Uninstalls a Control-M/Server from the user account and unregisters it from the Control-M environment.

provision server::setup

The provision server::setup command enables you to install a Control-M/Server and registers it in the Control-M environment.

CLI Syntax

The following shows the CLI syntax for the provision server::setup command:

ctm provision server::setup -f <configuration file>

where <configuration file> defines the pathname to a JSON file that contains the Control-M/Server definitions. For the full description of this configuration file, see Control-M/Server Provisioning.

If annotation is enabled for the Configuration Management category in the CCM or Configuration domain, you must also provide an annotation to justify your action. For more information, see Annotation Input.

provision server::install

The provision server::install command enables you to combine the image and setup commands into one action. It downloads the Control-M/Server, installs it and registers it in the Control-M environment.

CLI Syntax

The following shows the CLI syntax for the provision server::install command:

ctm provision server::install <image> -f <configuration file>

The following table describes the provision server::install command parameters.

If annotation is enabled for the Configuration Management category in the CCM or Configuration domain, you must also provide an annotation to justify your action. For more information, see Annotation Input.

provision server::uninstall

The provision server::uninstall command enables you to uninstall a Control-M/Server from the user account and unregisters it from the Control-M environment.

CLI Syntax

The following shows the CLI syntax for the provision server::uninstall command:

ctm provision server::uninstall [server]

where [server] is the name of the Control-M/Server. This is required only on a Linux host that has multiple Control-M/Servers installed.

If annotation is enabled for the Configuration Management category in the CCM or Configuration domain, you must also provide an annotation to justify your action. For more information, see Annotation Input.

Server Provisioning Configuration

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:

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.

{  
    "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
    }
}

{        
    "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"
    }
}

{        
    "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
    }
}

{        
    "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.

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.

Two more properties under the Log object are relevant only for a new server on MSSQL.

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.

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.