Control-M/Server Management

The Control-M/Server management tab enables you to troubleshoot, manage, and monitor self-hosted Control-M/Servers and their databases, Services, Agents, and Gateways, as described in the following procedures:

You can navigate to the Notification Destinations and self-hosted Control-M/Server System Parameters from the Control-M/Servers toolbar, as described in Notification Destinations and Configuring Control-M/Server System Parameters.

SaaS Control-M/Servers communicate with AWS services (SQS, S3, and IoT) via an HTTPS protocol on port 443. If your organization blocks internet access, ask your network administrator to grant outgoing access to the following URLs:

  • *.controlm.com:443 (HTTPS protocol) (outgoing only)

  • *.amazonaws.com:443 (outgoing only)

Adding a Self-Hosted Control-M/ServerLink copied to clipboard

This procedure describes how to add a self-hosted Control-M/Server or Control-M for z/OS to Control-M/EM, which enables you to divide job workflows based on load balancing requirements, geographic distribution, or organizational structure.

If Control-M/EM is configured for automatic time zone management, and this Control-M/Server contains jobs that are scheduled to run on user-defined time zones with IDs that do not match the Control-M/EM time zone IDs, you might receive a warning message in the Configuration domain and this Control-M/Server remains unmanaged until you redefine the Time Zone scheduling attribute in these jobs, as described in Scheduling.

Before You Begin

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. Toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. Click , then click Add Server.

    The Add Self-Hosted Control-M/Server dialog box appears.

  5. Define the self-hosted Control-M/Server or Control-M for z/OS parameters, as described in Self-Hosted Control-M/Server Component Parameters, and then click Add.

    A Self-Hosted Control-M/Server Added confirmation box appears.

    The added self-hosted Control-M/Server or Control-M for z/OS appears in the Self-Hosted Control-M/Servers tab, and Ready to Connect appears in the Status column of the added component.

  6. Connect the self-hosted Control-M/Server or Control-M for z/OS to Control-M SaaS, as described in Control-M SaaS Unified View Migration.

Self-Hosted Control-M/Server Component ParametersLink copied to clipboard

The following table describes the parameters that enable you to add a self-hosted Control-M/Server or Control-M for z/OS, as described in Adding a Self-Hosted Control-M/Server.

Parameter

Description

Name

Defines the logical name of the self-hosted Control-M/Server or Control-M for z/OS.

Rules:

  • Alphanumeric Latin Characters: 1–20

  • Case-Sensitive: Yes

  • Invalid Characters: Whitespace, %, &, (, ), $, ;, <, >, /, `, *, and \.

Host

Defines the self-hosted Control-M/Server or Control-M for z/OS hostname.

ID

Defines a unique three-character ID, such as 999 or NYC, which Control-M uses to identify each self-hosted Control-M/Server or Control-M for z/OS.

Default: The next available consecutive ID.

Pausing a Self-Hosted Control-M/ServerLink copied to clipboard

This procedure describes how to pause a self-hosted Control-M/Server or Control-M for z/OS, which enables you to keep jobs from executing until you resume the self-hosted Control-M/Server.

The New Day procedure and User Dailies still run on paused Control-M/Servers and Control-M for z/OS environments, but newly run jobs do not execute until you resume.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. Toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. From the Control-M/Servers tab, select the relevant self-hosted Control-M/Server or Control-M for z/OS, and from the Control-M/Servers toolbar click Pause.

    A Pause Control-M/Server confirmation dialog box appears.

  5. Click Pause.

    The self-hosted Control-M/Server or Control-M for z/OS remains up, but jobs do not execute until you reselect the self-hosted Control-M/Server or Control-M for z/OS, and from the Control-M/Servers toolbar, click Resume.

Disabling a Self-Hosted Control-M/ServerLink copied to clipboard

This procedure describes how to disable a self-hosted Control-M/Server or Control-M for z/OS. This removes the ability to sync new folder and job definitions and monitor and manage the self-hosted Control-M/Server or Control-M for z/OS and its components.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. Toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. From the Control-M/Servers tab, select the relevant self-hosted Control-M/Server or Control-M for z/OS, and then from the Control-M/Servers toolbar click Disable.

    A Disable Control-M/Server confirmation dialog box appears.

  5. Click Disable.

    The self-hosted Control-M/Server or Control-M for z/OS remains up, but you can neither monitor and manage it and its components, nor define and run new jobs until you reselect the self-hosted Control-M/Server or Control-M for z/OS, and from the Control-M/Servers toolbar, click Enable.

Recycling a Self-Hosted Control-M/ServerLink copied to clipboard

This procedure describes how to recycle (restart) a self-hosted Control-M/Server or Control-M for z/OS.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. Toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. From the Control-M/Servers tab, select the relevant self-hosted Control-M/Server or Control-M for z/OS, from the Control-M/Servers toolbar click Desired State, and then click Recycle.

    A Recycle Control-M/Server confirmation dialog box appears.

  5. Click Recycle.

    The Desired State of the self-hosted Control-M/Server or Control-M for z/OS changes to Recycle, the Actual State changes to Down and then Up, and then the Desired State reverts to Up.

Starting Up the Self-Hosted Control-M/ServerLink copied to clipboard

This procedure describes how to start up a self-hosted Control-M/Server or Control-M for z/OS. This instructs the Configuration Agent to attempt to start up the Control-M/Server or Control-M for z/OS when it is down, which enables it to communicate with other components and schedule jobs.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. Toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. From the Control-M/Servers tab, select the relevant self-hosted Control-M/Server or Control-M for z/OS, from the Control-M/Servers toolbar click Desired State, and then click Up.

    A Set Desired State to Up confirmation dialog box appears.

  5. Click Set to Up.

    The Desired State and then the Actual State of the self-hosted Control-M/Server or Control-M for z/OS changes to Up.

Shutting Down the Self-Hosted Control-M/ServerLink copied to clipboard

This procedure describes how to shut down a self-hosted Control-M/Server or Control-M for z/OS. This instructs the Configuration Agent to attempt to shut down the Control-M/Server or Control-M for z/OS when it is up, which disables communication with other components and removes the ability to schedule jobs.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. Toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. From the Control-M/Servers tab, select the relevant self-hosted Control-M/Server or Control-M for z/OS, from the Control-M/Servers toolbar click Desired State, and then click Down.

    A Set Desired State to Down confirmation dialog box appears.

  5. Click Set to Down.

    The Desired State and then the Actual State of the self-hosted Control-M/Server or Control-M for z/OS changes to Down.

Ignoring a Self-Hosted Control-M/ServerLink copied to clipboard

This procedure describes how to ignore a self-hosted Control-M/Server or Control-M for z/OS. This instructs the Configuration Agent to make no attempts to change the state of a self-hosted Control-M/Server or Control-M for z/OS.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. Toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. From the Control-M/Servers tab, select the relevant self-hosted Control-M/Server or Control-M for z/OS, from the Control-M/Servers toolbar click Desired State, and then click Ignore.

    A Set Desired State to Ignore confirmation dialog box appears.

  5. Click Set to Ignore.

    The Desired State and then the Actual State of the self-hosted Control-M/Server or Control-M for z/OS changes to Ignored.

Recycling a Self-Hosted ServiceLink copied to clipboard

This procedure describes how to recycle (restart) a self-hosted Control-M Service. For more information, see Control-M Services.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. Toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. From the Control-M/Servers tab, select the relevant self-hosted Control-M/Server or Control-M for z/OS, and then from the Services Status column click the status message.

    The Services dialog box appears.

  5. From the Service Type column in the Services tab, select the relevant Service, and then from the Recycle Service column click Recycle.

    A Recycle Service confirmation dialog box appears.

  6. Click Recycle.

    The Service recycles and its new State and Desired State appears in the Services tab.

Control-M/Server SecurityLink copied to clipboard

Control-M/Server security enables you to define authorizations for a Run as User or group in Control-M/Server. You can authorize which Run as Users or groups can run a certain job and which actions they are authorized to perform, such as add a folder, edit a job or force a job.

A Run as User that is a member of a group can inherit the permissions of the group. If you remove a group or remove a specific user from a group, the user is moved to the root level.

Configuring Control-M/Server SecurityLink copied to clipboard

This procedure describes how to configure Control-M/Server security for Run as Users and groups.

If the EM_BYPASS_CTMSEC system parameter Default Value is set to N, a Control-M/EM user request will be checked twice, once by Control-M/EM and then by Control-M/Server security. If the value is set to Y, the Control-M/EM user request will only be checked by Control-M/EM.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. In the Name column, click the relevant Control-M/Server name.

    The Control-M/Server Overview dialog box appears.

  4. From the Actions drop-down list, select Security.

    The Control-M/Server Security dialog box appears.

  5. Click Add.

  6. From the drop-down, select User or Group.

    The Add User or Add Group dialog box appears.

  7. Type the User Name or Group Name.

  8. (Optional) Type the Description.

  9. (Optional) In the Add User dialog box, click Add to Group and select the group from the drop-down list.

    If you assign a user to a group, the user can inherit the group permissions. If you do not assign a user to a group, the user is created as a root user.

  10. Click Save.

    The users and groups appear in the left pane.

  11. In the navigation, click the relevant user or group.

  12. Select the permissions for each user or group.

  13. Click Save.

Disconnecting a Self-Hosted Control-M/ServerLink copied to clipboard

This procedure describes how to disconnect a self-hosted Control-M/Server or Control-M for z/OS from Control-M SaaS Unified View when it requires maintenance, collapses, or becomes corrupted. After maintenance or replacement, you can then reconnect the self-hosted Control-M/Server or transfer its data to a new self-hosted Control-M/Server, as described in Reconnecting a Self-Hosted Control-M/Server. Control-M/Server data is saved to Control-M SaaS before you disconnect it.

Before You Begin

  • Verify that the self-hosted Control-M/Server or Control-M for z/OS is version 9.0.22.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. From the Control-M/Servers toolbar, toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. From the Control-M/Servers tab, select the relevant self-hosted Control-M/Server, and then from the toolbar click and then click Disconnect.

    The Disconnect Self-Hosted Control-M/Server dialog box appears.

  5. Click Disconnect.

    The self-hosted Control-M/Server disconnects from Control-M SaaS Unified View and the Ready to Connect button appears next to the Control-M/Server in the Control-M/Servers tab.

Reconnecting a Self-Hosted Control-M/ServerLink copied to clipboard

This procedure describes how to reconnect a disconnected self-hosted Control-M/Server or Control-M for z/OS to Control-M SaaS or transfer the data from a previously connected Control-M/Server to a new one. Control-M/Server data is saved to Control-M SaaS before you disconnect it to perform maintenance or address a technical malfunction.

Before You Begin

  • Verify that the self-hosted Control-M/Server or Control-M for z/OS is version 9.0.22.

Begin

  1. From the icon in Control-M SaaS, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers tab appears.

  3. From the Control-M/Servers toolbar, toggle on Self-Hosted.

    The Self-Hosted Control-M Servers tab appears.

  4. From the Control-M/Servers tab, next to the relevant self-hosted Control-M/Server, click Ready to Connect.

    The Ready to Connect dialog box appears.

  5. (Optional) Transfer this self-hosted Control-M/Server data to a new self-hosted Control-M/Server, as follows:

    1. Click Hostname.

      The New Server Hostname dialog box appears.

    2. In the Hostname field, type a new hostname and click Save.

      The host is renamed and the Ready to Connect dialog box appears with the new hostname.

  6. Click Get Control-M/Server Token and record the token that appears, which you must provide when you are prompted by the registration utility.

  7. Do one of the following:

    • If your Control-M/Server is not connected to Control-M/EM, do one of the following: 

      • Connect a Self-Hosted Control-M/Server: From the self-hosted Control-M/Server host, do the following:

        1. Run the following command:

          ctm_menu

          The Control-M Main Menu appears.

        2. Press 1.

        3. Type 11 and follow the prompts.

          The registration utility runs and connects the self-hosted Control-M/Server to Control-M SaaS.

      • Connect a Self-Hosted Control-M for z/OS: From your Control-M for z/OS, load ICE, as described in Installing INCONTROL Products with ICE.

        1. Select Installation.

          The IOA Installation menu appears.

        2. Select Customized Installation.

          The IOA Customized Installation menu appears.

        3. From the IOA Customized Installation menu, at the Option ===> prompt, type 2, at the Product ID ===> prompt, type CTM, and then press ENTER.

          The Major Steps Selection menu appears.

        4. Select 13 - Register Control-M for z/OS to Helix CTM.

          The Minor Steps Selection menu appears for major step 13 - Register Control-M for z/OS to Helix CTM.

        5. Follow steps 1–8 in the Minor Steps Selection menu, as described in Step 13 - Register Control-M for z/OS to Helix CTM.

          The self-hosted Control-M for z/OS is now connected to Control-M SaaS.

    • If your Control-M/Server is connected to Control-M/EM, do one of the following:

Deleting a Self-Hosted Control-M/Server from Control-M SaaSLink copied to clipboard

This procedure describes how to delete a self-hosted Control-M/Server from Control-M SaaS, which disconnects the self-hosted Control-M/Server and deletes its data from Control-M SaaS.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

  3. The Control-M/Servers tab appears.

  4. Toggle on Self-Hosted and from the Self-Hosted area of the Control-M/Servers pane, select the required self-hosted Control-M/Server, and click Delete.

    The Control-M/Server and all of its data is deleted from Control-M SaaS.

  5. Log in to Control-M/Server and run the following command:

    ctm_menu

    The CONTROL-M Main Menu appears.

  6. Type the relevant menu number to select CONTROL-M Manager.

    The CONTROL-M Manager Menu appears.

  7. Type the relevant menu number to select Unregister Control-M/Server from Helix Control-M/EM, and follow the prompts.

    Your Self-Hosted Control-M/Server is now deleted from Control-M SaaS.