APIRef_tm_net_bwc_policyΒΆ

mgmt/tm/net/bwc/policy

/tm/net/bwc

Bandwidth control policy for traffic flow.

REST Endpoints

Collection URI
/mgmt/tm/net/bwc/policy
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/net/bwc/policy/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write The application service that the object belongs to.
description string   optional read/write Description for the policy.
dynamic string disabled optional read/write Policy type: If dynamic enabled or disabled. Policy type change modification is a disallowed configuration.
ipTos string 255 optional read/write Specifies the Type of Service (ToS) level to use when outgoing packets cross threshold (Note: in such case, bwc just does only marking and not shaping). The default value is pass-through.
linkQos string 255 optional read/write Specifies the Quality of Service (QoS) level to use when outgoing packets cross threshold (Note: in such case, bwc just does only marking and not shaping). The default value is pass-through.
logPeriod integer 2048 optional read/write Specifies the frequency for bwc measurement to log to publisher.
logPublisher string   optional read/write Specifies the logging publisher. A new log-publisher object can be created via TMSH command tmsh create sys log-config publisher.
maxRate uint64 0 optional read/write Maximum rate for this policy class.
maxUserRate uint64 0 optional read/write Maximum per user rate for this policy class.
maxUserRatePps uint64 0 optional read/write Maximum user pps for this policy class.
measure string disabled optional read/write Enables/Disables bandwidth measurement for this policy. Available for only dynamic policies.
tmPartition string Common optional read/write Displays the administrative partition within which the bwc policy resides.
trafficPriorityMap string   optional read/write Policy Priority Traffic group to use as enforcement during congestion along with policy rate configured.

Array Structures

Name Type Default Value Required Access Description
/categories array_structure   optional read/write  
/categories/app-service string   optional read/write The application service that the object belongs to.
/categories/description string   optional read/write Description for the policy category.
/categories/ip-tos string 255 optional read/write Specifies the Type of Service (ToS) level to use when outgoing packets cross threshold (Note: in such case, bwc just does only marking and not shaping). The default value is pass-through.
/categories/link-qos string 255 optional read/write Specifies the Quality of Service (QoS) level to use when outgoing packets cross threshold (Note: in such case, bwc just does only marking and not shaping). . The default value is pass-through.
/categories/max-cat-rate integer   optional read/write Policy Category - Maximum rate for this category. This becomes marking threshold when marking is done instead of enforcement.
/categories/max-cat-rate-percentage integer   optional read/write Policy Category - Percentage of max-user-rate for this category. This becomes marking threshold when marking is done instead of enforcement.
/categories/traffic-priority-map string   optional read/write Policy Priority Traffic group to use as enforcement during congestion along with category configured.
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.