Usage Alerts Configuration

The following API commands enable you to configure Usage Alerts, which notify you when the number of tasks in a Control-M/Enterprise Manager environment exceed the permitted limit of tasks in the Active Jobs file.

• config usage:alerts::disable

• config usage:alerts::enable

• config usage:alerts:state::get

• config usage:alerts::get

• config usage:alerts::set

• config usage:alerts:connectivity::test

This feature requires Control-M/EM version 9.0.27 or higher.

config usage:alerts::disable

The config usage:alerts::disable command turns off usage alerting in the environment.

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

curl -H -X POST "$AuthHeader" \
"$endpoint/config/usage/alerts/disable"

config usage:alerts::enable

The config usage:alerts::enable command turns on usage alerting in the environment.

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

curl -H -X POST "$AuthHeader" \
"$endpoint/config/usage/alerts/enable"

config usage:alerts:state::get

The config usage:alerts:state::get command retrieves the current status of usage alerting in the environment, whether enabled or disabled.

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

curl -H -X GET "$AuthHeader" "$endpoint/config/usage/alerts/state"

config usage:alerts::get

The config usage:alerts::get command enables you to get the current usage alert settings.

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

curl -H -X GET "$AuthHeader" "$endpoint/config/usage/alerts"

Response

The following sample response presents the usage alert settings:

{
  "usageAlerts": [
    {
      "platform": ALL,
      "maxCount": "3",
      "percent": "75",
      "email": [
        "[email protected]",
        "[email protected]"
      ]
    }
  ]
}

The following table describes the config usage:alerts::get response details that are shown in the above response:

config usage:alerts::set

The config usage:alerts::set command enables you to change usage alert settings.

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

curl -H -X POST "$AuthHeader" -H "Content-Type: application/json" \
--data "@c:\tmp\usageAlertSettings.json" "$endpoint/config/usage/alerts"

<alertSettingsFile> is the full path to a JSON file that contains Usage Alert settings.

To create this file, you can obtain the current settings from the config usage:alerts::get command response, save this response as a JSON file, and adjust the settings that you want to modify.

The following table describes the Usage Alert settings that you can include in the Alert Settings file for the config usage:alerts::set command:

config usage:alerts:connectivity::test

The config usage:alerts:connectivity::test command enables you to check connectivity to the Control-M/EM environment where task counts and alerts are implemented.

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

curl -H -X POST "$AuthHeader" -H "Content-Type: application/json" \
--data "@c:\tmp\environmentSettingsFile.json" \
"$endpoint/config/usage/alerts/connectivity/test"

<environmentSettingsFile> is the full path to a JSON file that contains environment connection settings, as in the following example:

{
   "name": "em_env_1",
   "dbType": Oracle,
   "host": "db-host-name",
   "port": "546",
   "userName": "jdoe",
   "password": "********",
   "dbName": "Ora_DB"
}

The following table describes the environment connection settings that you can include in the Environment Settings file for the config usage:alerts:connectivity::test command: