Create Priority Policy Set (v2.0)

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

Create a new priority policy set.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Details of the priority policy to be created

bandwidth_allocation_schemes BandwidthAllocationSchemeV2[]required
The bandwidth allocation schemes configured for a given policy set. Upto four bandwidth allocation schemes can be configured.
Array [
bandwidth_range BandwidthRange
The defined bandwidth range.
high double
The high range of the bandwidth allocated.
low double
The low range of the bandwidth allocated.
business_priorities BusinessPriorityV2[]
The defined business priorities.
Array [
bandwidth_allocation double
The bandwidth allocated.
bandwidth_split_per_type BandwidthSplit
The bandwidth allocated split by type.
bulk double
Bulk
rt_audio double
Rt Audio
rt_video double
Rt Video
transactional double
Transactional
priority_number int32
The priority number for a type.
]
]
business_priority_names BusinessPriorityNameMapper[]required
The business priority names. Max list size = 4.
Array [
priority_name string
The business priority name.
priority_num int32
The business priority number.
]
clone_from string

The existing policy from Stacked Policies for cloning the policy set.

default_rule_dscp_mappings DefaultRuleDSCPMapping[]
The default rule of the DSCP mappings.
Array [
dscp integer[]
The default DSCP rule mapping.
priority_number int32
The priority number of the rule.
transfer_type string
Possible values: [RT_AUDIO, RT_VIDEO, TRANSACTIONAL, BULK]
The transfer type.
]
defaultrule_policyset boolean

The default rule of the policy set.

description

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

id string

The priority policy set ID.

name stringrequired

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

tags string[]

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

template boolean

The template used for cloning the policy rule. The template option creates a set of rules from a predefined template can be customized after creation.

Responses

200

Successful Operation

application/json

Schema

Schema

bandwidth_allocation_schemes BandwidthAllocationSchemeV2[]required
The bandwidth allocation schemes configured for a given policy set. Upto four bandwidth allocation schemes can be configured.
Array [
bandwidth_range BandwidthRange
The defined bandwidth range.
high double
The high range of the bandwidth allocated.
low double
The low range of the bandwidth allocated.
business_priorities BusinessPriorityV2[]
The defined business priorities.
Array [
bandwidth_allocation double
The bandwidth allocated.
bandwidth_split_per_type BandwidthSplit
The bandwidth allocated split by type.
bulk double
Bulk
rt_audio double
Rt Audio
rt_video double
Rt Video
transactional double
Transactional
priority_number int32
The priority number for a type.
]
]
business_priority_names BusinessPriorityNameMapper[]required
The business priority names. Max list size = 4.
Array [
priority_name string
The business priority name.
priority_num int32
The business priority number.
]
clone_from string

The existing policy from Stacked Policies for cloning the policy set.

default_rule_dscp_mappings DefaultRuleDSCPMapping[]
The default rule of the DSCP mappings.
Array [
dscp integer[]
The default DSCP rule mapping.
priority_number int32
The priority number of the rule.
transfer_type string
Possible values: [RT_AUDIO, RT_VIDEO, TRANSACTIONAL, BULK]
The transfer type.
]
defaultrule_policyset boolean

The default rule of the policy set.

description

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

id string

The priority policy set ID.

name stringrequired

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

tags string[]

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

template boolean

The template used for cloning the policy rule. The template option creates a set of rules from a predefined template can be customized after creation.

Example (from schema)

{
  "bandwidth_allocation_schemes": [
    {
      "bandwidth_range": {
        "high": 0,
        "low": 0
      },
      "business_priorities": [
        {
          "bandwidth_allocation": 0,
          "bandwidth_split_per_type": {
            "bulk": 0,
            "rt_audio": 0,
            "rt_video": 0,
            "transactional": 0
          },
          "priority_number": 0
        }
      ]
    }
  ],
  "business_priority_names": [
    {
      "priority_name": "string",
      "priority_num": 0
    }
  ],
  "clone_from": "string",
  "default_rule_dscp_mappings": [
    {
      "dscp": [
        0
      ],
      "priority_number": 0,
      "transfer_type": "RT_AUDIO"
    }
  ],
  "defaultrule_policyset": true,
  "id": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "template": true
}

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": "NAME_REQD"
      },
      {
        "code": "DESCRIPTION_EXCEEDS_LIMIT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_POLICYSET_TEMPLATE"
      },
      {
        "code": "BANDWIDTH_ALLOCATION_SCHEME_REQD"
      },
      {
        "code": "BUSINESS_PRIORITY_NAMES_REQD"
      },
      {
        "code": "BUSINESS_PRIORITY_NAME_LIST_SIZE_EXCEEDED"
      },
      {
        "code": "INVALID_DSCP_MAPPINGS"
      },
      {
        "code": "INVALID_DSCP_VALUE"
      },
      {
        "code": "DUPLICATE_DSCP_VALUE"
      },
      {
        "code": "BUSINESS_PRIORITY_NAME_REQD"
      },
      {
        "code": "BUSINESS_PRIORITY_NAME_EXCEEDS_LIMIT"
      },
      {
        "code": "INVALID_PRIORITY_NUMBER"
      },
      {
        "code": "BUSINESS_PRIORITY_NUMBER_REQD"
      },
      {
        "code": "POLICY_SET_INVALID_BANDWIDTH_RANGE"
      },
      {
        "code": "POLICY_SET_CONFIG_INVALID_CLONE_FROM"
      },
      {
        "code": "POLICY_SET_CONFIG_CREATION_FAILED"
      },
      {
        "code": "INVALID_DEFAULTRULE_FLAG_OF_CLONE_FROM"
      },
      {
        "code": "INVALID_TEMPLATE_CONFIG_FOR_DEFAULTRULE_POLICYSET"
      },
      {
        "code": "INVALID_TEMPLATE_AND_CLONE_FROM"
      },
      {
        "code": "TENANT_APPDEF_VERSION_NOT_FOUND"
      },
      {
        "code": "BANDWIDTH_ALLOCATION_SCHEME_LIST_SIZE_EXCEEDED"
      }
    ]
  }
}

Loading...