Cloud Computing Jobs

Determines the authorization credentials that are used to connect Control-M to AWS Batch, as described in AWS Batch Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case Sensitive: Yes

• Invalid Characters: Blank spaces.

Determines whether you supply your own JSON parameters.

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

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

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

Defines the name of the batch job.

Determines which predefined job definition and version number (revision) is applied to the job, depending upon how you complete the field, as follows:

• Job Definition Name: When you type only the job definition name in the field, this job definition and its most recent version is applied to the job.

• Job Definition Name:Version Number: When you type the job definition name—followed by a colon (:), followed by a version number—in the field, this job definition and version number is applied to the job.

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 execution, which overrides the 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 specified timeouts in the job definition.

Determines the authorization credentials that are used to connect Control-M to AWS EC2, as described in AWS EC2 Virtual Machine Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

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

• Create: Creates a virtual machine.

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

• Start: Starts an existing virtual machine.

• Stop: Stops a running virtual machine.

• Reboot: Reboots 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 execute the operation.

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.

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

Default: 15 seconds

Determines the authorization credentials that are used to connect Control-M to AWS Lambda, as described in AWS Lambda Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

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 appears in the following example:

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

For no parameters, type {}.

Determines the authorization credentials that are used to connect Control-M to Azure Batch Accounts, as described in Azure Batch Accounts Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

Defines the name of the job that is created in Azure Portal.

Defines a prefix that is added to the task ID.

Defines the commands that the job performs.

Determines the maximum amount of time the job executes, as follows:

• Unlimited

• Custom

Variable name: %%AWS-BATCH_ WALLCLOCK

Defines the Custom maximum number of seconds, minutes, hours, or days the job executes.

Default: 1

Determines the Custom units used to define the maximum amount of time the job executes.

• Seconds

• Minutes

• Hours

• Days

Default: Minutes

Determines the maximum number of times to re-execute a failed job, as follows:

• None

• Unlimited

• Custom

Default: None

Determines the Custom maximum number of times to re-execute a failed job.

Default: 1

Determines the file retention period, as follows:

• Unlimited: Retains the job directory and its files indefinitely.

• Custom: Determines the number of days, hours, minutes, or seconds to retain the job directory and its files.

Default: Unlimited

Determines the number of seconds, minutes, hours, or days to set the Custom file retention period for.

Default: 1

Determines the unit of time used to set the Custom file retention period for.

• Seconds

• Minutes

• Hours

• Days

Default: Hours

Determines whether to add the job log to the output A tab in the job properties pane of the Monitoring domain where the job output appears that indicates whether a job ended OK, and is used, for example, with jobs that check file location..

Determines the authorization credentials that are used to connect Control-M to Azure Functions, as described in Azure Functions Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

Variable name: %%AZURE-ACCOUNT

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

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

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

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

For no parameters, type {}.

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

• 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 times to check the job status before ending Not OK.

Default: 2

Determines the authorization credentials that are used to connect Control-M to Azure VM, as described in Azure Virtual Machine Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

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

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

• Create\Update: Creates a virtual machine.

• Delete: Deletes an existing virtual machine.

• Deallocate: Empties a virtual machine.

• Reset: Reboots a virtual machine.

• Start: Starts a virtual machine.

• Stop: Stops a running virtual machine.

Defines the input parameters in JSON format for a Create operation, as shown in the following example:

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

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.

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

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

Default: 15 seconds

Determines the authorization credentials that are used to connect Control-M to GCP Batch, as described in GCP Batch Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

Defines the GCP project ID where the batch 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 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 execution priority of the batch job.

Larger numbers indicate higher priority.

Valid Values: Any number between 1 and 99.

Default: 99

Determines one of the following types of batch jobs:

• Script: Executes a UNIX shell scripting language.

• Container: Creates a Docker container from an image.

Defines the shell script that the batch job executes.

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 executes.

If the container image contains an entry point or if an entry point is defined in the Entry Point attribute above, 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/

Determines 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 execution when it fails.

Valid Values: Any number between 0 and 10.

Default: 0

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

• Machine Type: Executes 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: Executes the job on a custom-made virtual machine, based on a predefined template in the GCE.

Defines the virtual machine type that executes the job.

Defines the virtual machine template that executes 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 executing or cause it to fail.

Default: Standard

Determines whether 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.

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

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

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

Determines the authorization credentials that are used to connect Control-M to GCP Functions, as described in GCP Functions Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

Variable name: %%AZURE-ACCOUNT

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

Determines the authorization credentials that are used to connect Control-M to GCP VM, as described in GCP Virtual Machine Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

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: Creates a virtual machine

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

• Start: Starts an existing virtual machine.

• Stop: Stops a running virtual machine.

• Reset: Reboots a virtual machine.

• Delete: Deletes 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 execute 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 shown in the following example:

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

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

Default: 15

Determines the authorization credentials that are used to connect Control-M to OCI Functions, as described in OCI Functions Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

Defines the function Oracle Cloud Identifier (OCID) which is a unique identifier that is assigned to each function that is created within the Oracle Cloud Infrastructure.

(Optional) Enables you to upload an OCI Functions payload file. The file maximum size is 100KB. This payload file can contain parameters, which you define through the Payload File Parameters attribute.

In the following example, the contents of a payload file define one name parameter.

Determines the authorization credentials that are used to connect Control-M to OCI VM, as described in OCI VM Connection Profile Parameters.

Rules:

• Characters: 1−30

• Case sensitive: Yes

• Invalid characters: Blank spaces.

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 following example:

{
   "availabilityDomain": "Idbi:PHX-AD-1",
   "compartmentId": "ocid1.compartment.oc1..aaaaaaaahjokjhkhkfghdfhdfghpgikuby4rdybd4wywxuz5aziyqpkvq",
   "subnetId": "ocid1.subnet.oc1.phx.aaaaaaafthfdhfchfghgjfgpl2fghdfghfrtrv5kmg5wa",
   "displayName": "Asaf_VM",
   "extendedMetadata": {},
   "faultDomain": "FAULT-DOMAIN-2",
   "freeformTags": {},
   "imageId": "ocid1.image.oc1.phx.aaaaaaaa6tyfghfhgdfhjyeyum5nmijrhktkqxypt34ouwf6q",
   "ipxeScript": null,
   "launchMode": "PARAVIRTUALIZED",
   "instanceOptions": 
   {
      "areLegacyImdsEndpointsDisabled": false
   },
   "availabilityConfig": 
   {
      "isLiveMigrationPreferred": null,
      "recoveryAction": "RESTORE_INSTANCE"
   },
   "preemptibleInstanceConfig": null,
   "lifecycleState": "PROVISIONING",
   "metadata": {},
   "region": "phx",
   "shape": "VM.Standard.E2.1.Micro",
   "shapeConfig": 
   {
      "ocpus": 1.0,
      "memoryInGBs": 1.0,
      "baselineOcpuUtilization": null,
      "processorDescription": "2.0 GHz AMD EPYC 7551",
      "networkingBandwidthInGbps": 0.48,
      "maxVnicAttachments": 1,
      "gpus": 0,
      "gpuDescription": null,
      "localDisks": 0,
      "localDisksTotalSizeInGBs": null,
      "localDiskDescription": null,
      "vcpus": 2
   },
   "isCrossNumaNode": false,
   "sourceDetails": 
   {
      "sourceType": "image",
      "bootVolumeSizeInGBs": null,
      "imageId": "ocid1.image.oc1.phx.aaaaaaaa6tdsgfdfgfdhfhfdgcrty56746787698fghfdghdfghqxypt34ouwf6q",
      "kmsKeyId": null,
      "bootVolumeVpusPerGB": null,
      "instanceSourceImageFilterDetails": null
   },
   "systemTags": 
   {
      "orcl-cloud": 
      {
         "free-tier-retained": "true"
      }
   },
   "timeCreated": "2024-01-22T14:16:35.641Z",
   "timeMaintenanceRebootDue": null,
   "timeStopScheduled": null,
   "preferredMaintenanceAction": null,
   "platformConfig": null,
   "instanceConfigurationId": null

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

Determines one of the following tasks to perform on the virtual machine:

• Power Operations

• Configuration Tasks

• Snapshots

Determines one of the following power-related actions to perform:

• Start VM: Starts up the virtual machine.

• Stop VM: Shuts down the virtual machine.

• Reset VM: Resets the virtual machine.

• Suspend VM: Disables execution capabilities on the virtual machine.

Determines one of the following configuration settings for the virtual machine:

• Reconfigure VM: Edits the virtual machine settings.

• Clone VM: Creates a clone of the virtual machine.

• Deploy From Template: Creates a virtual machine from a template.

• Migrate VM: Migrates a virtual machine execution to a location.

Determines one of the following actions related to virtual machine snapshots:

• Take Snapshot: Creates a snapshot of the virtual machine.

• Revert To Snapshot: Changes the execution state of the virtual machine to the state of the most recent snapshot.

Defines the name of the virtual machine.

(Optional) Defines the folder where the virtual machine is located.

(Optional) Defines the resource pool where the virtual machine is located.

(Optional) Defines the host of the virtual machine.

(Optional) Defines the cluster where the virtual machine is located.

(Optional) Defines the data center where the virtual machine is located.

Determines one of the following tasks to change the virtual machine:

• CPU

• Memory

Determines whether to remove CPUs from the virtual machine when it runs.

• True: Removes the CPU when the virtual machine runs.

• False: Removes the CPU but not when the virtual machine runs.

Default: False

Determines whether to add CPUs to the virtual machine when it runs.

• True: Adds the CPU while the virtual machine runs.

• False: Adds the CPU but not while the virtual machine runs.

Default: False

Determines the number of CPU cores allocated to the virtual machine.

Determines the number of CPU cores allocated per virtual CPU socket.

Determines the number of megabytes (MiB) assigned to the virtual machine.

Defines the JSON required for the API request.

Defines the JSON-encoded information that indicates where to place the virtual machine, such as a host or storage resource.

Defines the name of the snapshot for a snapshot task.

Defines a description of the snapshot.

Determines whether to include a memory dump of the virtual machine in the snapshot.

• True

• False

Determines whether to pause the virtual machine file system to ensure a consistent snapshot.

• True

• False

Defines the version and format of the API data structure for compatibility across different API releases.

(Optional) Determines the number of seconds to wait before checking the job status.

Default: 60