Create Priority Policy Rule (v2.1)
POST/v2.1/api/tenants/:tenant_id/prioritypolicysets/:policy_set_id/prioritypolicyrules
Create a new priority policy rule.
Request
Path Parameters
The tenant ID.
The ID of the priority policy set.
- application/json
Body
Details of the priority policy to be created
The app definition IDs that have applied priority policy rules. The number of applications for a policy rule is limited to 256.
The description of the priority policy rule. Max size = 256.
The destination prefix ID.
dscp DSCP
The DSCP value - When policy rules with marked DSCP bits are applied to a site, the ION branch device will honor the bits in the first packet on an unknown application flow, and queue the flow in the specified priority class.
The DSCP value.
The priority policy rules based on rules that are enabled.
The priority policy rule ID.
The name of the priority policy rule. Max size = 128.
The network context applied to the priority policy rule. Network context segments network traffic for the purpose of applying different QoS policy rules for the same application.
The order number. The default order number for a policy rule is 1024.
The priority number. Priority determines the relative priority of network resources assigned to each application.
The source prefix ID. Source prefix filters are often added as exceptions.
A information field that can be added to identify the priority policy rule. Maximum 10 unique tags of length 1024 each are allowed.
user_or_group UserGroup
The details of the user or group.
The user group IDs.
The user IDs.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
The app definition IDs that have applied priority policy rules. The number of applications for a policy rule is limited to 256.
The description of the priority policy rule. Max size = 256.
The destination prefix ID.
dscp DSCP
The DSCP value - When policy rules with marked DSCP bits are applied to a site, the ION branch device will honor the bits in the first packet on an unknown application flow, and queue the flow in the specified priority class.
The DSCP value.
The priority policy rules based on rules that are enabled.
The priority policy rule ID.
The name of the priority policy rule. Max size = 128.
The network context applied to the priority policy rule. Network context segments network traffic for the purpose of applying different QoS policy rules for the same application.
The order number. The default order number for a policy rule is 1024.
The priority number. Priority determines the relative priority of network resources assigned to each application.
The source prefix ID. Source prefix filters are often added as exceptions.
A information field that can be added to identify the priority policy rule. Maximum 10 unique tags of length 1024 each are allowed.
user_or_group UserGroup
The details of the user or group.
The user group IDs.
The user IDs.
{
"app_def_ids": [
"string"
],
"destination_prefixes_id": "string",
"dscp": {
"value": 0
},
"enabled": true,
"id": "string",
"name": "string",
"network_context_id": "string",
"order_number": 0,
"priority_number": 0,
"source_prefixes_id": "string",
"tags": [
"string"
],
"user_or_group": {
"user_group_ids": [
"string"
],
"user_ids": [
"string"
]
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "DUPLICATE_APP_DEF_IDS"
},
{
"code": "APP_DEF_ID_LIST_SIZE_EXCEEDED"
},
{
"code": "INVALID_NETWORK_CONTEXT_ID"
},
{
"code": "INVALID_ORDER_NUMBER_MINIMUM_VAL"
},
{
"code": "INVALID_ORDER_NUMBER_MAXIMUM_VAL"
},
{
"code": "INVALID_SOURCE_PREFIXES_ID"
},
{
"code": "INVALID_DESTINATION_PREFIXES_ID"
},
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "PRIORITYPOLICYSET_NOT_PRESENT"
},
{
"code": "POLICYRULE_CREATION_NOT_ALLOWED"
},
{
"code": "INVALID_POLICYSET_STATE"
},
{
"code": "INVALID_DEFAULT_RULE_FLAG"
},
{
"code": "POLICYRULE_CONFIG_DEFAULT_RULE_NAME"
},
{
"code": "POLICYRULE_CONFIG_INVALID_APPDEF_IDS"
},
{
"code": "POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT"
},
{
"code": "POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX"
},
{
"code": "POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX"
},
{
"code": "POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS"
},
{
"code": "INVALID_PRIORITY_NUMBER"
},
{
"code": "PRIORITY_NUMBER_MINIMUM_VAL"
},
{
"code": "PRIORITY_NUMBER_MAXIMUM_VAL"
}
]
}
}