Usage service


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

Note: The usage service requires Control-M/Enterprise Manager version 9.0.21 or higher.

ctm usage jobs::get

Enables the administrator to get a count of eligible jobs 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

CLI
ctm usage jobs::get

REST API Syntax

See REST API reference.

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"

Sample responses

The following response show that 5000 jobs have been executed on a single Control-M/Server:

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

The following response shows how many jobs have been executed 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
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

Control-M