Cloud Computing Jobs

Determines the ConnectionProfile:AWS Batch name that connects Control-M to AWS Batch.

Determines whether you supply your own JSON parameters in the JSON Format parameter.

Values:

• checked

• unchecked

Default: unchecked

Defines the parameters for the batch job, in JSON format, that enable you to control how the job executes.

For a description of this JSON syntax, see the description of SubmitJob in the AWS Batch API Reference.

This JSON body replaces the use of all other parameters described below, except for Status Polling Frequency:

{
   "containerOverrides":
   {
      "command":["echo","Hello, from Control-M"],
      "resourceRequirements":[
      {
         "type":"VCPU",
         "value":"2"
      }
]
   }
   "jobDefinition": "ctm-batch-job-definition",
   "jobName": "ctm-batch-job-single",
   "jobQueue": "ctm-batch-job-queue",
   "timeout": 
   {
      "attemptDurationSeconds": 70
   }
}

Defines the name of the batch job.

Determines which predefined job definition and version number (revision) is applied to the job, as follows:

• <jobDefinitionName>: The most recent revision of the job definition.

• <jobDefinitionName>:<revision>: A specific revision of the job definition.

Determines the job queue, which stores your batch job.

(Optional) Defines a command, in JSON format, that overrides the specified command in the job definition.

(Optional) Determines the number of times to retry a job run, which overrides the number of retry attempts determined in the job definition.

Valid Values: 1–10

(Optional) Determines the number of seconds to wait before a timeout occurs in a batch job, which overrides the timeout defined in the job definition.

Defines the name of the batch job.

Defines the job definition to use.

Defines the job definition revision.

Defines the queue to which the job is submitted.

Determines one of the following job types:

• Array

• Single

(Array job type) Determines the number of items in the array.

Valid Values: 2–10,000

Defines parameters that determine a job dependency.

(Array job type) Determines one of the following dependency types:

• Standard

• Sequential

• N-to-N

Defines the job ID that the batch job depends upon.

This parameter is mandatory for the following dependencies:

• Standard

• N-to-N

Defines a command to send to the container that overrides the default command from the Docker image or the job definition.

Defines the memory reserved for the job, in megabytes.

Minimum Value: 4

Defines the number of vCPUs to reserve for the container.

Determines the number of retry attempts.

Valid Values: 1–10

Defines the timeout duration in seconds.

Defines the ConnectionProfile:AWSEC2 name that connects Control-M to AWS EC2 Virtual Machine.

Determines one of the following operations to perform on the AWS EC2 Virtual Machine:

• Create: Creates a new virtual machine.

• Create from Instance Template: Creates a new virtual machine based on a template.

• Start: Starts an existing virtual machine.

• Stop: Stops a running virtual machine.

• Reboot: Resets a virtual machine.

• Terminate: Deletes an existing virtual machine.

Defines the template to use to create a VM from a template.

Defines the name of the VM instance where you want to run the operation.

This parameter is available for all operations except for the Create operations.

Defines the name of a new VM instance for Create operations.

Determines which AWS EC2 zone to use for a Create operation.

Determines the software requirements of the host computer when you create a new AWS EC2 Virtual Machine.

Defines the Subnet ID that is required to launch the instance in a Create operation.

Defines the security credential key set for a Create operation.

Defines the ID of the Amazon Machine Image (AMI) that is required to launch the instance in a Create operation.

Determines the number of copies of the VM to create in a Create operation.

Default: 1

Determines whether to display logs from the AWS EC2 instance at the end of the job output.

This parameter is available for all operations except for the Terminate operation.

Values:

• checked

• unchecked

Default: unchecked

Determines the number of seconds to wait before job status verification.

Default: 15

Defines the ConnectionProfile:AWS Lambda name that connects Control-M to AWS Lambda.

Defines the name of the predefined Lambda function that is executed.

Defines the version of the named Lambda function that is executed.

Default: $LATEST

Defines the parameters for the AWS Lambda job, in JSON format, that enable you to control how the job executes, as shown in the following example:

"{\"action\":\"increment\",\"number\": 3}",

For no parameters, type {}.

Defines the Lambda function to execute.

(Optional) Defines the Lambda function version.

(Optional) Defines the Lambda function payload, in JSON format.

Invalid Characters: Special characters.

Defines the ConnectionProfile:Azure Batch Accounts name that connects Control-M to Azure Batch Accounts.

Defines the name of the Batch Account Job created in Azure Portal.

Defines a prefix string to append to the task ID.

Defines the command line that runs your application or script on the compute node. The task is added to the job at runtime.

Determines one of the following types of time limits for the job run:

• Unlimited

• Custom

Default: Unlimited

Defines the number (of the specified time unit) for a custom maximum time limit.

Default: 1

Determines the time units for a custom maximum time limit:

• Seconds

• Minutes

• Hours

• Days

Default: Minutes

Determines the maximum number of times to rerun a failed task:

• Unlimited

• Custom

• None

Default: None

Determines the number of retries for a custom task retry count.

Default: 1

Determines one of the following options for a minimum period of time for retention of the Task directory of the batch job:

• Unlimited: By Azure default, 7 days, unless the compute node is removed or the job is deleted.

• Custom

Default: Unlimited

Determines the number (of the specified time unit) for a custom retention period.

Default: 1

Determines one of the following time units for a custom retention period:

• Seconds

• Minutes

• Hours

• Days

Default: Hours

Determines whether to add task stdout.txt content to the plug-in job output.

Values:

• checked

• unchecked

Default: checked

Defines the ID of the batch job.

Defines a command line that the batch job runs.

(Optional) Determines whether to add the log to the job output.

Values:

• true

• false

Default: true

(Optional) Determines a maximum limit for the job's run time. (Unit is determined)

If you do not include this parameter, the default is unlimited run time.

Use this parameter to set a custom time limit. Include the following next-level parameters:

• Time: Number of the specified time unit—0 or higher.

• Unit: One of the following units of time:

  • Seconds

  • Minutes

  • Hours

  • Days

(Optional) Defines the number of times to retry running a failed task.

If you do not include this parameter, the default is none (no retries).

Use this parameter to choose between the following options:

• Unlimited number of retries. For this option, include the following next-level parameter:

  Option: "Unlimited"

• Custom number of retries, 1 or higher. For this option, include the following next-level parameters:

  • "Count": number

  • "Option": "Custom"

Defines the ConnectionProfile:AzureFunctions name that connects Control-M to Azure Functions.

Defines the name of the Azure function application that you want to run.

Defines the name of the function that you want to run.

Defines the function parameters, in JSON format, that enable you to control the presentation of data, as follows:

 {\"param1\":\"val1\", \"param2\":\"val2\"}

For no parameters, specify {}.

Determines which of the following types of Azure functions to run:

• Activity: The basic unit of work in a durable function and that can be called by an orchestrator function.

• HTTP: An HTTP-triggered function that can be used to build serverless APIs and respond to webhooks. You cannot call an orchestrator function from an HTTP function.

• Orchestrator: A type of durable function that enables you to determine how and in what order actions are executed.

Determines the number of seconds to wait before checking the status of the Azure Functions job.

Default: 20

Defines the name of the Azure function to execute.

Defines the name of the Azure function app.

(Optional) Defines function parameters as pairs of name and value.

Defines the ConnectionProfile:Azure VM name that connects Control-M to Azure Virtual Machine.

Defines the name of the Azure Virtual Machine to run the operation.

Determines one of the following operations to perform on the Azure Virtual Machine.

• Create\Update: Create a new virtual machine.

• Delete: Delete an existing virtual machine.

• Deallocate: Empty a virtual machine.

• Reset: Reset a virtual machine.

• Start: Start a virtual machine.

• Stop: Stop a running virtual machine.

Defines the input parameters in JSON format for a Create operation, as follows:

{\"param1\":\"val1\", \"param2\":\"val2\"}

Determines whether to display logs from Azure VM at the end of the job output.

This parameter is available for all operations except for the Delete operation.

Values:

• checked

• unchecked

Default: unchecked

Determines whether to delete the Azure Virtual Machine disk when you delete an Azure Virtual Machine.

Values:

• checked

• unchecked

Default: unchecked

Determines the number of seconds to wait before job status verification.

Default: 15

Defines the ConnectionProfile:GCP Batch name that connects Control-M to GCP Batch.

Defines the GCP project ID where the batch job runs.

A project is a set of configuration settings that define the resources your GCP Batch jobs use and how they interact with GCP.

Defines the region that is predefined in the GCP Batch platform where the virtual machine resources are located.

Determines whether to override the predefined region in the GCP Batch platform, as follows:

• Yes

• No

Default: No

Defines the new region, or zones in a region, where the virtual machine resources are located.

Defines a unique name for the batch job.

Determines the run priority of the batch job.

Larger numbers indicate higher priority.

Valid Values: 1–99

Default: 99

Determines one of the following types of batch jobs:

• Script: Runs a UNIX shell scripting language.

• Container: Creates a Docker container from an image.

Defines the shell script that the batch job runs.

Defines the Uniform Resource Identifier (URI) that points to the container image.

Defines the entry point (ENTRYPOINT) for the Docker container, which overrides the entry point defined in the original image.

An entry point is the location in the container where the program begins its execution.

"/bin/project"

Determines whether to override the Docker command (CMD), which is the executable container application code that is defined in the original image, as follows:

• Yes

• No

Default: No

Defines the Docker command (CMD) that executes when a Docker container runs.

If the container image contains an entry point or if an entry point is defined in the Entry Point parameter, the command is appended as an argument.

Defines the file or directory to copy (mount) onto a container volume, which is a virtual hard drive, inside the Docker container.

/home/usr:/app/

Defines the number of millicores of virtual CPU resources that are reserved for the batch job.

Virtual machines measure CPU resources in millicores (m), which are thousandths of a CPU core. For example, 2000m equals 2 cores.

Determines the number of mebibytes (MiB; mega binary bytes) of virtual memory resources that are reserved for the batch job.

Determines the number of times to retry a job run when it fails.

Valid Characters:  0–10

Default: 0

Determines which kind of virtual machine (instance) runs the job.

• Machine Type: Runs the job on one of the virtual machine types available in the Google Compute Engine (GCE), which is the infrastructure-as-a-service component of GCP.

• Machine Template: Runs the job on a custom-made virtual machine, based on a predefined template in the GCE.

Defines the virtual machine type that runs the job.

Defines the virtual machine template that runs the job.

Determines the price and availability of virtual machine resources, as follows:

• Standard: Allocates virtual machine resources to the user and is used for production-level jobs.

• Spot: Allocates virtual machine resources only when there is excess capacity in the Google Compute Engine (GCE). These resources disappear when they are needed by other users, which might prevent a job from running or cause it to fail.

Default: Standard

Determines whether to save the batch job logs and where they appear.

• No Logs: The batch job logs are not saved in the GCP Batch platform or in the Control-M Log in the Monitoring domain.

• Cloud Logging: The batch job logs are saved in both the GCP Batch platform and the Control-M Log in the Monitoring domain.

Determines whether you supply your own JSON parameters, instead of several of the parameters described above.

Defines the parameters for the batch job, in JSON format, that enable you to control how the job runs.

For a description of this JSON syntax, see the description of Resource:Job in the GCP Batch Job API Reference.

{
   "priority": "99",
   "taskGroups": [
   {
      "taskSpec": 
      {
         "computeResource": 
         {
            "cpuMilli": "1000",
            "memoryMib": "1000"
         },
         "runnables": [
         {
            "script": 
            {
               "text": "Total tasks: ${BATCH_TASK_COUNT}"
            }
         }]
      },
      "taskCount": "1",
      "parallelism": "1"
   }],
   "allocationPolicy": 
   {
      "location": 
      {
         "allowedLocations": 
         [ 
            "regions/us-east1",
            "zones/us-east1-b",
            "zones/us-east1-c",
            "zones/us-east1-d"
         ]
      },
      "labels": 
      {
         "batch-job-id": "guy3"
      },
      "instances": [
      {
         "policy": 
         {
            "machineType": "e2-micro",
            "provisioningModel": "STANDARD"
         }
      } ]
   },
   "logsPolicy": 
   {
      "destination": "CLOUD_LOGGING"
   }
}

Defines the ConnectionProfile:GCP Functions name that connects Control-M to GCP Functions.

Defines the GCP project ID where the GCP Functions job executes.

A project is a set of configuration settings that define the resources your GCP Batch jobs use and how they interact with GCP.

Defines where the functions job executes.

Defines the name of the function that you want to execute.

Determines one of the following types of parameters to pass to the function:

• URL Parameters

• Body

Defines the URL parameters that are passed to the function, in the following format:

<Parameter_Name_1>=<Value_1>

Defines the JSON-based body parameters that are passed to the function, in the following format:

{\\\"parameter_1\\\":\\\"value_1\\\", \\\"parameter_2\\\":\\\"value_2\\\"}

For no parameters, type {}.

Maximum Characters: 4,000

Determines the number of seconds to wait before checking the status of the GCP Functions job.

Default: 20

Determines the number of times to check the job status before ending Not OK.

Default: 2

Defines the ConnectionProfile:GCP VM name that connects Control-M to GCP VM.

Defines the project ID of the  Google Cloud Project Virtual Machine.

Defines the name of the zone for the request.

Determines one of the following operations to perform on the Google Virtual Machine:

• Create: Create a virtual machine.

• Create from Template: Create a new virtual machine based on a template.

• Start: Start an existing virtual machine.

• Stop: Stop a running virtual machine.

• Reset: Reset a virtual machine.

• Delete: Delete an existing virtual machine.

Defines the name of a template for creation of a new Google Virtual Machine from a template. 

Defines the name of the VM instance where you want to run the operation.

This parameter is available for all operations except for the Create operations.

Defines the input parameters in JSON format for a Create operation, as follows:

{"param1": "value1", "param2": "value2", …}

Determines whether to display logs from Google VM at the end of the job output.

This parameter is available for all operations except for the Delete operation.

Values:

• checked

• unchecked

Default: unchecked

Determines the number of seconds to wait before job status verification.

Default: 15

Determines the Connection Profile:OCI VM name that connects Control-M to OCI VM.

Determines one of the following actions to perform on the OCI VM.

• Start: Powers on the instance.

• Stop: Powers off the instance.

• Reset Powers off the instance and then powers it back on.

• Create: Creates a virtual machine.

• Get Details: Gets details of the VM.

• Soft Stop: Shuts down the instance using the OS. Sends a shutdown command to the instance's operating system, waits for 15 minutes for the OS to shut down, then powers off the instance.

  If the applications that run on the instance take more than 15 minutes to shut down, they can stop improperly, resulting in data corruption. To avoid this, manually shut down the instance using the OS commands before you softstop the instance.

• Soft Reset: Reboots the instance using the OS. Sends a shutdown command to the instance's operating system, waits for 15 minutes for the OS to shut down, then reboots the instance.

• Delete: Deletes a virtual machine.

Defines the input parameters in JSON format for a Create action, as appears in the example above.

Defines the name of the OCI VM instance you wish to create or operate on.

Determines the number of seconds to wait before checking the status of the OCI VM job.

Default: 15