Skip to main content

Update Priority Policy Set (v2.0)

PUT 

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

Update a priority policy set.

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

    policy_set_id stringrequired

    The ID of the priority policy set.

Body

Details of the priority policy to be updated

    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

Successful Operation

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.

Loading...