Create Performance Policy Rule (v2.1)

POST 
/v2.1/api/tenants/:tenant_id/perfmgmtpolicysets/:perfmgmtpolicyset_id/perfmgmtpolicyrules

Create a new performance policy rule.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

perfmgmtpolicyset_id stringrequired

The performance policy set ID.

application/json

Body

Details of PERFMGMT Policy Rule to be created

actions PerfMgmtAction[]
The valid actions configured for the performance policy rule.
Array [
action_type stringrequired
Possible values: [RAISE_ALARM, MOVE_FLOWS, MOVE_FLOWS_FORCED, FEC, VISIBILITY, APP_ACCELERATION, PACKET_DUPLICATION]
The values of the action type for the performance policy rule.
app_perf PerfMgmtActionParameters
The details of the application performance parameters.
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
circuit_utilization_perf PerfMgmtActionParameters
Circuit Utilization Perf: Valid
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
lqm_perf PerfMgmtActionParameters
The details of the LQM performance parameters.
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
probe_perf PerfMgmtActionParameters
Probe Perf: Valid
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
sys_perf PerfMgmtActionParameters
Sys Perf: Valid
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
]
app_filters ApplicationFilter

The details of the app filters used for the performance policy rule.

app_transfer_types string[]

Possible values: [RT_AUDIO, RT_VIDEO, TRANSACTIONAL, BULK]

Lists the app transfer types. Maximum 4 app transfer types are supported.

application_ids string[]

Lists the application IDs in a rule. Maximum 64 applications can be specified in a rule.

description

The description of the performance policy rule. Max characters = 256.

enabled boolean

Lists if the performance policy rule is enabled.

id string

Lists the performance policy rules by ID.

name stringrequired

The name of the performance policy rule.

path_filters PathFilter[]
Lists the path filters applied. Maximum 32 path filters are supported.
Array [
label string
The policy rule path label.
path_type stringrequired
Possible values: [vpn, direct, servicelink, all]
The path type specified in the path filter.
]
service_label_ids string[]

Lists the service label IDs. Maximum 32 service labels are supported.

tags string[]

A information field that can be added to identify the performance policy rule. Maximum 10 unique tags of length 1024 each are allowed.

thresholdprofile_id string

Lists the threshold profile IDs.

type stringrequired

Possible values: [APP_CIRCUIT_HEALTH, SYSTEM_SITE_HEALTH]

The type of performance policy rule.

Responses

200

Successful Operation

application/json

Schema

Schema

actions PerfMgmtActionV2N1[]
The valid actions configured for the performance policy rule.
Array [
action_type stringrequired
Possible values: [RAISE_ALARM, MOVE_FLOWS, MOVE_FLOWS_FORCED, FEC, VISIBILITY, APP_ACCELERATION, PACKET_DUPLICATION]
The values of the action type for the performance policy rule.
app_perf PerfMgmtActionParameters
The details of the application performance parameters.
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
circuit_utilization_perf PerfMgmtActionParameters
The details of the circuit utilization parameters.
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
lqm_perf PerfMgmtActionParameters
The details of the LQM performance parameters.
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
probe_perf PerfMgmtActionParameters
The details of the probe performance parameters.
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
sys_perf PerfMgmtActionParameters
The details of the system performance parameters.
bad_health_thresholds PerfMgmtHealthThresholds
Lists the valid / invalid performance policy rules thresholds.
clear_below int32
The clear_below value should be between 1-80L.
raise_above int32
The raise_above value should be between 10-100L.
monitoring_approach stringrequired
Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]
The monitoring approach for the rule.
]
app_filters ApplicationFilter

The details of the app filters used for the performance policy rule.

app_transfer_types string[]

Possible values: [RT_AUDIO, RT_VIDEO, TRANSACTIONAL, BULK]

Lists the app transfer types. Maximum 4 app transfer types are supported.

application_ids string[]

Lists the application IDs in a rule. Maximum 64 applications can be specified in a rule.

description

The description of the performance policy rule. Max characters = 256.

enabled boolean

Lists if the performance policy rule is enabled.

id string

Lists the performance policy rules by ID.

name stringrequired

The name of the performance policy rule.

path_filters PathFilter[]
Lists the path filters applied. Maximum 32 path filters are supported.
Array [
label string
The policy rule path label.
path_type stringrequired
Possible values: [vpn, direct, servicelink, all]
The path type specified in the path filter.
]
service_label_ids string[]

Lists the service label IDs. Maximum 32 service labels are supported.

tags string[]

A information field that can be added to identify the performance policy rule. Maximum 10 unique tags of length 1024 each are allowed.

thresholdprofile_id string

Lists the threshold profile IDs.

type stringrequired

Possible values: [APP_CIRCUIT_HEALTH, SYSTEM_SITE_HEALTH]

The type of performance policy rule.

Example (from schema)

{
  "actions": [
    {
      "action_type": "RAISE_ALARM",
      "app_perf": {
        "bad_health_thresholds": {
          "clear_below": 0,
          "raise_above": 0
        },
        "monitoring_approach": "AGGRESSIVE"
      },
      "circuit_utilization_perf": {
        "bad_health_thresholds": {
          "clear_below": 0,
          "raise_above": 0
        },
        "monitoring_approach": "AGGRESSIVE"
      },
      "lqm_perf": {
        "bad_health_thresholds": {
          "clear_below": 0,
          "raise_above": 0
        },
        "monitoring_approach": "AGGRESSIVE"
      },
      "probe_perf": {
        "bad_health_thresholds": {
          "clear_below": 0,
          "raise_above": 0
        },
        "monitoring_approach": "AGGRESSIVE"
      },
      "sys_perf": {
        "bad_health_thresholds": {
          "clear_below": 0,
          "raise_above": 0
        },
        "monitoring_approach": "AGGRESSIVE"
      }
    }
  ],
  "app_filters": {
    "app_transfer_types": [
      "RT_AUDIO"
    ],
    "application_ids": [
      "string"
    ]
  },
  "enabled": true,
  "id": "string",
  "name": "string",
  "path_filters": [
    {
      "label": "string",
      "path_type": "vpn"
    }
  ],
  "service_label_ids": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "thresholdprofile_id": "string",
  "type": "APP_CIRCUIT_HEALTH"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_DUPLICATE_KEY"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "PERFMGMT_INVALID_PATH_TYPE"
      },
      {
        "code": "PERFMGMT_INVALID_APP_TRANSFER_TYPE"
      },
      {
        "code": "PERFMGMT_INVALID_ACTION_TYPE"
      },
      {
        "code": "PERFMGMT_INVALID_MONITORING_APPROACH"
      },
      {
        "code": "PERFMGMT_INVALID_RAISE_ABOVE"
      },
      {
        "code": "PERFMGMT_INVALID_CLEAR_BELOW"
      },
      {
        "code": "PERFMGMT_RULE_THRESHOLD_CLEAR_BELOW_INVALID"
      },
      {
        "code": "PERFMGMT_INVALID_SERVICE_LABEL_IDS"
      },
      {
        "code": "PERFMGMT_INVALID_THRESHOLD_PROFILE_ID"
      },
      {
        "code": "PERFMGMT_POLICY_RULE_NOT_PRESENT"
      },
      {
        "code": "PERFMGMT_MISSING_THRESHOLD_PROFILE_ID"
      },
      {
        "code": "PERFMGMT_RULE_MISSING_ACTIONS"
      },
      {
        "code": "PERFMGMT_RULE_LQM_THRESHOLD_MISSING"
      },
      {
        "code": "PERFMGMT_RULE_APP_THRESHOLD_MISSING"
      },
      {
        "code": "PERFMGMT_RULE_APP_PERF_BAD_HEALTH_THRESHOLD_MISSING"
      },
      {
        "code": "PERFMGMT_RULE_MISSING_ACTION_TYPE"
      },
      {
        "code": "PERFMGMT_RULE_APP_FILTER_AND_APP_THRESHOLDS_NOT_ALLOWED"
      },
      {
        "code": "PERFMGMT_RULE_THRESHOLDS_MISSING"
      },
      {
        "code": "PERFMGMT_RULE_APP_FILTER_MISSING"
      },
      {
        "code": "PERFMGMT_RULE_INVALID_APP_FILTER"
      },
      {
        "code": "PERFMGMT_INVALID_APPLICATION_IDS"
      },
      {
        "code": "PERFMGMT_RULE_DUPLICATE_APPLICATION_IDS"
      },
      {
        "code": "PERFMGMT_RULE_DUPLICATE_SERVICE_LABEL_IDS"
      },
      {
        "code": "PERFMGMT_RULE_DUPLICATE_APP_TRANSFER_TYPES"
      },
      {
        "code": "PERFMGMT_RULE_DUPLICATE_PATH_TYPE_IN_PATH_FILTERS"
      },
      {
        "code": "PERFMGMT_RULE_DUPLICATE_LABEL_IN_PATH_FILTERS"
      },
      {
        "code": "PERFMGMT_RULE_DUPLICATE_ACTION_TYPE"
      },
      {
        "code": "PERFMGMT_RULE_TYPE_REQUIRED"
      },
      {
        "code": "PERFMGMT_INVALID_RULE_TYPE"
      },
      {
        "code": "PERFMGMT_APP_TRANSFER_TYPE_LIST_SIZE_EXCEEDED"
      },
      {
        "code": "PERFMGMT_PATH_FILTERS_LIST_SIZE_EXCEEDED"
      },
      {
        "code": "PERFMGMT_APP_FILTER_MANDATORY_FOR_APP_THRESHOLDS"
      },
      {
        "code": "PERFMGMT_RULE_APP_FILTER_MANDATORY"
      },
      {
        "code": "PERFMGMT_RULE_EXCEEDS_MAX_LIMIT"
      },
      {
        "code": "PERFMGMT_RULE_DUPLICATE_PATH_LABEL_PATH_TYPE_IN_PATH_FILTERS"
      },
      {
        "code": "PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_FEC"
      },
      {
        "code": "PERFMGMT_RULE_APP_FILTER_MANDATORY_FOR_ACTION_MOVE_FLOWS"
      },
      {
        "code": "PERFMGMT_RULE_LQM_THRESHOLDS_REQUIRED_FOR_VISIBILITY"
      },
      {
        "code": "PERFMGMT_RULE_VISIBILITY_APP_FILTERS_PROHIBITED"
      },
      {
        "code": "PERFMGMT_RULE_FEC_APP_THRESHOLDS_PROHIBITED"
      },
      {
        "code": "PERFMGMT_RULE_THRESHOLDS_MISSING_FOR_APP_PERF"
      },
      {
        "code": "PERFMGMT_RULE_APP_FILTER_MISSING_FOR_APP_PERF"
      },
      {
        "code": "PERFMGMT_RULE_LQM_THRESHOLD_MISSING_FOR_LQM_PERF"
      },
      {
        "code": "PERFMGMT_SERVICE_LABELS_NOT_ALLOWED_FOR_DIRECT_PATHS"
      },
      {
        "code": "PERFMGMT_RULE_CANNOT_BE_CREATED_FOR_DEFAULT_SET"
      },
      {
        "code": "APP_DEF_ID_LIST_SIZE_EXCEEDED_64"
      },
      {
        "code": "SERVICE_LABEL_ID_LIST_SIZE_EXCEEDED"
      },
      {
        "code": "PERFMGMT_RULE_OVERLAPPING_PATH_FILTERS"
      },
      {
        "code": "PERFMGMT_RULE_PERF_PARAMETERS_NOT_ALLOWED"
      },
      {
        "code": "PERFMGMT_RULE_INVALID_ACTIONS_FOR_SYNTHETIC_PROBE_THRESHOLDS"
      },
      {
        "code": "PERFMGMT_RULE_INCOMPATIBLE_THRESHOLD_PROFILE"
      },
      {
        "code": "PERFMGMT_RULE_INVALID_MATCH_CRITERIA_PARAMETERS_FOR_TYPE"
      },
      {
        "code": "PERFMGMT_SYSTEM_RULE_ONLY_ALL_PATHS_ALLOWED"
      },
      {
        "code": "PERFMGMT_SYSTEM_HEALTH_RULE_UNSUPPORTED_ACTION"
      },
      {
        "code": "PERFMGMT_SYSTEM_HEALTH_RULE_UNSUPPORTED_ACTION_FIELDS"
      },
      {
        "code": "PERFMGMT_APP_CIRCUIT_HEALTH_RULE_UNSUPPORTED_ACTION_FIELDS"
      },
      {
        "code": "PERFMGMT_RULE_TENANT_NOT_APP_ACCELERATION_ENABLED"
      },
      {
        "code": "PERFMGMT_RULE_APP_ACCEL_ACTION_PATH_FILTER_MANDATORY"
      }
    ]
  }
}

Loading...