QosPolicer

QoS Policer ensures that traffic adheres to the stipulated QoS defined in your network. Contains Rate and Burst configurations and can be associated to VLANs.

Overview

burst integer filterable   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
rate integer filterable   orderable  

API Resource

/qospolicers/id
delete get put

Parents

/qospolicers
get post

Children

/qospolicers/id/permissions
delete get post put
/qospolicers/id/metadatas
get post
/qospolicers/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

burst integer filterable   orderable  
Discussion

Burst Size: The maximum burst size associated with the QoS Policer in kilo-bits; only whole values are supported.

Charateristics

Default value: 1
Min value: 1
Max value: 2147483647
SDK attribute: burst

description string filterable   orderable  
Discussion

Description of the QoS Policer

Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the QoS Policer

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

rate integer filterable   orderable  
Discussion

Rate: Bandwidth that is allowed in Mb/s; only whole values supported.

Charateristics

Default value: 1
Min value: 1
Max value: 2147483647
SDK attribute: rate