Create Performance Policy Set (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/perfmgmtpolicysets

Create a new performance policy set.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Details of PERFMGMT Policy Set to be created

clone_from string

The performance policy set that has been cloned from.

defaultrule_policyset boolean

The default rule of the policy set.

description

The description of the performance policy set. Max size = 256.

disabled boolean

Lists if the performance policy sets are disabled.

disabled_reason string

Reason the performance policy set is disabled.

id string

The ID of the policy set.

inactive boolean

Lists if the performance policy set is inactive.

inactive_reason string

Reason the performance policy set is inactive.

link_health_policyrule_order string[]

The order of the policy rule.

link_health_rules PerfMgmtPolicyRule[]
The details of the policy rule.
Array [
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.
]
name stringrequired

The name of the performance policy set. Max size = 128.

policy_rules BasePolicyRule[]
Lists the details of the policy rules.
Array [
description
The description of the policy rule. Max size = 256.
disabled boolean
Lists if the policy rules are disabled.
disabled_reason string
Reason the policy rule is disabled.
id string
The policy rule ID.
inactive boolean
Lists if the policy rule is inactive.
inactive_reason string
Reason the policy rule is inactive.
name stringrequired
The name of the policy rule.
policyset_id string
The ID of the policy set.
region string
The region of the site.
tags string[]
A information field that can be added to identify the policy rule. Maximum 10 unique tags of length 1024 each are allowed.
tenant_id stringrequired
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
]
region string

The region of the site. ID of the DEM status.

send_to_element boolean

Send To Element

tags string[]

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

tenant_id stringrequired

The tenant ID.

Responses

200

Successful Operation

application/json

Schema

Schema

clone_from string

The performance policy set that has been cloned from.

defaultrule_policyset boolean

The default rule of the policy set.

description

The description of the performance policy set. Max size = 256.

disabled boolean

Lists if the performance policy sets are disabled.

disabled_reason string

Reason the performance policy set is disabled.

id string

The ID of the policy set.

inactive boolean

Lists if the performance policy set is inactive.

inactive_reason string

Reason the performance policy set is inactive.

link_health_policyrule_order string[]

The order of the policy rule.

link_health_rules PerfMgmtPolicyRule[]
The details of the policy rule.
Array [
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.
]
name stringrequired

The name of the performance policy set. Max size = 128.

policy_rules BasePolicyRule[]
Lists the details of the policy rules.
Array [
description
The description of the policy rule. Max size = 256.
disabled boolean
Lists if the policy rules are disabled.
disabled_reason string
Reason the policy rule is disabled.
id string
The policy rule ID.
inactive boolean
Lists if the policy rule is inactive.
inactive_reason string
Reason the policy rule is inactive.
name stringrequired
The name of the policy rule.
policyset_id string
The ID of the policy set.
region string
The region of the site.
tags string[]
A information field that can be added to identify the policy rule. Maximum 10 unique tags of length 1024 each are allowed.
tenant_id stringrequired
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
]
region string

The region of the site. ID of the DEM status.

send_to_element boolean

Send To Element

tags string[]

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

tenant_id stringrequired

The tenant ID.

Example (from schema)

{
  "clone_from": "string",
  "defaultrule_policyset": true,
  "disabled": true,
  "disabled_reason": "string",
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "link_health_policyrule_order": [
    "string"
  ],
  "link_health_rules": [
    {
      "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"
    }
  ],
  "name": "string",
  "policy_rules": [
    {
      "disabled": true,
      "disabled_reason": "string",
      "id": "string",
      "inactive": true,
      "inactive_reason": "string",
      "name": "string",
      "policyset_id": "string",
      "region": "string",
      "tags": [
        "string"
      ],
      "tenant_id": "string"
    }
  ],
  "region": "string",
  "send_to_element": true,
  "tags": [
    "string"
  ],
  "tenant_id": "string"
}

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": "POLICY_SET_CONFIG_CREATION_FAILED"
      },
      {
        "code": "PERFMGMT_SET_CONFIG_INVALID_CLONE_FROM"
      },
      {
        "code": "PERFMGMT_DUPLICATE_RULES_IN_RULES_ORDER"
      },
      {
        "code": "PERFMGMT_INVALID_POLICY_SET_ORDER"
      }
    ]
  }
}

Loading...