BMC Control-M

Provides access to BMC Control-M Services

Actions

Control-M Connect

Creates a connection handler for Control-M REST API Service, once connected other actions can be used without the requirement of providing credentials on all actions

Input

Name Description Type Required Syntax
URL URL required to access to Control-M REST API Service. input True True
Username Username to authenticate to the REST API Service. input True True
Password Password to authenticate to the REST API Service. password-input True True
Certificate Verify When False certificates wont be checked for validity. checkbox True False

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Logout

Close an existing open Control-M API Service connection.

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Custom Request

Execute a call to a given API endpoint.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
API Endpoint Target API endpoint input True True
HTTP Method The HTTP method to use e.g. HEAD, GET, PUT, POST, DELETE. dropdown True True
Data Body data to include with the request. json-input False True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Update Alert

Update details of an alert.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Alert ID ID of the alert to update. input True True
Urgency Define alert urgency. input True True
Comment Define alert comment. input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Update Alert Status

Update the status of an alert.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Alert ID ID of the alert to update. input True True
Status Define the status of the alert. input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Get Events

Get a list of recent events.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Get Jobs By Status

Get jobs by a job status i.e. 'Ended Not OK'

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Status Filter The status type to return. input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Set Job Confirm

Confirm a job.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Job Delete

Delete a job.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Job Free

Free a job.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Get Job

Get a job and its details.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Job Hold

Hold a job.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Job Kill

Kill a job.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Get Job Log

Get the job log.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Get Job Output

Get job output.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Job Rerun

Rerun a job.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Job Run Now

Run a job now

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Set Job Ok

Mark a job as OK.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Get Job Statistics

Get job statistics.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Get Job Status

Get the status of a job.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Job Undelete

Undelete a job.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}

Control-M Job Wait Info

Get job wait info.

Input

Name Description Type Required Syntax
Local Object Authentication When checked you are able to define the API details directly on the action without the need of the Control-M Connect object. group-checkbox False False
URL URL required to access to Control-M REST API Service. input False True
Username Username to authenticate to the REST API Service. input False True
Password Password to authenticate to the REST API Service. password-input False True
Job ID Target Job ID for the given action input True True

Output

Name Description Type always_present values
result Returns True when successful. boolean True {"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc Returns the exit code for the action. number True {"0": {"description": "Successful."}, "500": {"description": "Unable to authenticate or connect to the defined Control-M API Service ."}, "501": {"description": "Existing connection was not found and object authentication was not provided."}}