QOS

QoS policies enable you to classify and limit network traffic.

Overview

active boolean filterable   orderable  
associatedDSCPForwardingClassTableID string
associatedDSCPForwardingClassTableName string
assocQosId string
BUMCommittedBurstSize string filterable  
BUMCommittedInformationRate string filterable  
BUMPeakBurstSize string filterable  
BUMPeakInformationRate string filterable  
BUMRateLimitingActive boolean filterable  
burst string filterable   orderable  
committedBurstSize string filterable  
committedInformationRate string filterable  
creationDate string read only   autogenerated   orderable  
description string filterable  
EgressFIPCommittedBurstSize string deprecated   filterable  
EgressFIPCommittedInformationRate string deprecated   filterable  
EgressFIPPeakBurstSize string deprecated   filterable  
EgressFIPPeakInformationRate string deprecated   filterable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
FIPCommittedBurstSize string deprecated   filterable  
FIPCommittedInformationRate string deprecated   filterable  
FIPPeakBurstSize string deprecated   filterable  
FIPPeakInformationRate string deprecated   filterable  
FIPRateLimitingActive boolean deprecated   filterable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable  
owner string autogenerated  
peak string filterable   orderable  
rateLimitingActive boolean filterable  
rewriteForwardingClass boolean filterable  
serviceClass enum (A | B | C | D | E | F | G | H | NONE) filterable   orderable  
trustedForwardingClass boolean filterable  

API Resource

/qos/id
delete get put

Parents

/zones/id/qos
get post
/qos
get
/subnettemplates/id/qos
get post
/vports/id/qos
get post
/subnets/id/qos
get post
/zonetemplates/id/qos
get post
/domains/id/qos
get post
get post
/l2domains/id/qos
get post
/hostinterfaces/id/qos
get post
get post
get post
/domaintemplates/id/qos
get post
/policydecisions/id/qos
get

Children

/qos/id/permissions
delete get post put
/qos/id/metadatas
get post
/qos/id/globalmetadatas
get post put
/qos/id/vms
get
/qos/id/containers
get
/qos/id/eventlogs
get

Members

This object has no members.

Attributes documentation

active boolean filterable   orderable  
Discussion

If enabled, it means that this ACL or QOS entry is active


Charateristics

SDK attribute: active

associatedDSCPForwardingClassTableID string
Discussion

ID of the DSCP->Forwarding Class used by this Qos Policy


Charateristics

Format: free
SDK attribute: associatedDSCPForwardingClassTableID

associatedDSCPForwardingClassTableName string
Discussion

Name of the DSCP->Forwarding Class used by this Qos Policy


Charateristics

Format: free
SDK attribute: associatedDSCPForwardingClassTableName

assocQosId string
Discussion

ID of object associated with this QoS object


Charateristics

Format: free
SDK attribute: assocQosId

BUMCommittedBurstSize string filterable  
Discussion

Committed burst size setting in kilo-bytes (kilo-octets) for BUM Shaper.


Charateristics

Format: free
SDK attribute: BUMCommittedBurstSize

BUMCommittedInformationRate string filterable  
Discussion

Committed information rate setting in Mb/s for BUM Shaper.


Charateristics

Format: free
SDK attribute: BUMCommittedInformationRate

BUMPeakBurstSize string filterable  
Discussion

Peak burst size setting in kilo-bytes (kilo-octets) for Broadcast/Multicast rate limiting (BUM).


Charateristics

Format: free
SDK attribute: BUMPeakBurstSize

BUMPeakInformationRate string filterable  
Discussion

Peak rate setting in Mb/s for Broadcast/Multicast rate limiting


Charateristics

Format: free
SDK attribute: BUMPeakInformationRate

BUMRateLimitingActive boolean filterable  
Discussion

Flag the indicates whether Broadcast/Multicast rate limiting is enabled or disabled


Charateristics

SDK attribute: BUMRateLimitingActive

burst string filterable   orderable  
Discussion

Peak Burst Size : The maximum burst size associated with the rate limiter in kilo-bytes (kilo-octets); only whole values allowed and 'INFINITY' if rate limiting is disabled.


Charateristics

Format: free
SDK attribute: burst

committedBurstSize string filterable  
Discussion

Committed Burst Size : Burst size associated with the rate limiter in kilo-bytes (kilo-octets); only whole values are supported.


Charateristics

Format: free
SDK attribute: committedBurstSize

committedInformationRate string filterable  
Discussion

Committed Information Rate : Committed bandwidth that is allowed from each VM in Mb/s; only whole values supported.


Charateristics

Format: free
SDK attribute: committedInformationRate

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.


Charateristics

SDK attribute: creationDate

description string filterable  
Discussion

A description of the QoS object


Charateristics

Format: free
Max length: 255
SDK attribute: description

EgressFIPCommittedBurstSize string deprecated   filterable  
Discussion

Committed burst size setting in kilo-bytes (kilo-octets) for FIP Shaper on the Egress.


Charateristics

Format: free
SDK attribute: EgressFIPCommittedBurstSize

EgressFIPCommittedInformationRate string deprecated   filterable  
Discussion

Committed information rate setting in Mb/s for FIP Shaper on the egress side.


Charateristics

Format: free
SDK attribute: EgressFIPCommittedInformationRate

EgressFIPPeakBurstSize string deprecated   filterable  
Discussion

Peak burst size setting in kilo-bytes (kilo-octets) for Egress FIP rate limiting.


Charateristics

Format: free
SDK attribute: EgressFIPPeakBurstSize

EgressFIPPeakInformationRate string deprecated   filterable  
Discussion

Peak rate setting for FIP rate limiting on egress in Mb/s


Charateristics

Format: free
SDK attribute: EgressFIPPeakInformationRate

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

FIPCommittedBurstSize string deprecated   filterable  
Discussion

Committed burst size setting in kilo-bytes (kilo-octets) for FIP Shaper.


Charateristics

Format: free
SDK attribute: FIPCommittedBurstSize

FIPCommittedInformationRate string deprecated   filterable  
Discussion

Committed information rate setting in Mb/s for FIP Shaper.


Charateristics

Format: free
SDK attribute: FIPCommittedInformationRate

FIPPeakBurstSize string deprecated   filterable  
Discussion

Peak burst size setting in kilo-bytes (kilo-octets) for FIP rate limiting.


Charateristics

Format: free
SDK attribute: FIPPeakBurstSize

FIPPeakInformationRate string deprecated   filterable  
Discussion

Peak rate setting for FIP rate limiting in Mb/s;


Charateristics

Format: free
SDK attribute: FIPPeakInformationRate

FIPRateLimitingActive boolean deprecated   filterable  
Discussion

Flag the indicates whether FIP rate limiting is enabled or disabled


Charateristics

SDK attribute: FIPRateLimitingActive

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.


Charateristics

SDK attribute: lastUpdatedDate

name string required   filterable   orderable  
Discussion

A unique name of the QoS object


Charateristics

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

owner string autogenerated  
Discussion

Identifies the user that has created this object.


Charateristics

Format: free
SDK attribute: owner

peak string filterable   orderable  
Discussion

Peak Information Rate : Peak bandwidth that is allowed from each VM in Mb/s; only whole values allowed and 'INFINITY' if rate limiting is disabled.


Charateristics

Format: free
SDK attribute: peak

rateLimitingActive boolean filterable  
Discussion

Identifies if rate limiting must be implemented


Charateristics

SDK attribute: rateLimitingActive

rewriteForwardingClass boolean filterable  
Discussion

Specifies if the rewrite flag is set for the QoS policy / template


Charateristics

SDK attribute: rewriteForwardingClass

serviceClass enum filterable   orderable  
Discussion

Class of service to be used. Service classes in order of priority are A(1), B(2), C(3), D(4), E(5), F(6), G(7) and H(8) Possible values are NONE, A, B, C, D, E, F, G, H, .


Charateristics

Allowed values: A, B, C, D, E, F, G, H, NONE
SDK attribute: serviceClass

trustedForwardingClass boolean filterable  
Discussion

Specifies if the trusted flag is set for the QoS policy / template


Charateristics

SDK attribute: trustedForwardingClass