Usage Service

The usage service enables you to manage your Control-M license constraints.

The usage service requires Control-M/EM version 9.0.21 or higher.

ctm usage jobs::get

The ctm usage jobs::get command enables the administrator to get a count of eligible jobs (also known as loaded tasks) in the current (active) day from New Day onwards. You can run this command as a cyclic job which can trigger further action when a defined threshold is reached.

CLI Syntax

ctm usage jobs::get

REST API Syntax

Example using curl:

endpoint=
token=
AuthHeader="x-api-key: $token"
# AuthHeader="Authentication: Bearer $token"  #for a session token

curl -H "$AuthHeader" -X GET "$endpoint/usage/jobs"

For more information, see Control-M Automation REST API Reference.

Sample responses

The following response shows that 5000 jobs have been executed (that is, 5000 loaded tasks were counted) on a single Control-M/Server:

{
    "usage":[
        {
            "server":"server1",
            "jobExecution": 5000
        }
    ],
    "totalJobExecution": 5000
}

The following response shows how many jobs have been executed (that is, tasks loaded) on each Control-M/Server when multiple servers exist. The total number of executed jobs appears at the end:

{
    "usage":[
        {
            "server":"server1",
            "jobExecution": 5000
        },
        {
            "server":"server2",
            "jobExecution": 200
        },
        {
            "server":"server3",
            "jobExecution": 10000
        }
    ],
    "totalJobExecution": 15200
}