EgressQOSPolicy

An Egress QoS Policy is a policy that groups rate-limiting profiles, traffic directionality and classifiers to govern the rate of traffic being sent or received by an end-host or application.

Overview

assocEgressQosId string
associatedCOSRemarkingPolicyTableID string
associatedDSCPRemarkingPolicyTableID string
creationDate string read only   autogenerated   orderable  
customSpqDepth integer filterable   orderable  
defaultServiceClass enum (A | B | C | D | E | F | G | H) filterable   orderable  
description string filterable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
mgmtQueueAssociatedRateLimiterID string
name string required   filterable   orderable  
networkCtrlQueueAssociatedRateLimiterID string
owner string autogenerated  
parentQueueAssociatedRateLimiterID string required  
queue1AssociatedRateLimiterID string
queue1ForwardingClasses list (A | B | C | D | E | F | G | H | NONE)
queue2AssociatedRateLimiterID string
queue2ForwardingClasses list (A | B | C | D | E | F | G | H | NONE)
queue3AssociatedRateLimiterID string
queue3ForwardingClasses list (A | B | C | D | E | F | G | H | NONE) required  
queue4AssociatedRateLimiterID string
queue4ForwardingClasses list (A | B | C | D | E | F | G | H | NONE)

API Resource

/egressqospolicies/id
delete get put

Parents

/enterprises/id/egressqospolicies
get post
/egressqospolicies
get post

Children

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

Members

This object has no members.

Attributes documentation

assocEgressQosId string
Discussion

ID of object associated with this QoS object

Charateristics

Format: free
SDK attribute: assocEgressQosId

associatedCOSRemarkingPolicyTableID string
Discussion

ID of the associated CoS Remarking Policy table.

Charateristics

Format: free
SDK attribute: associatedCOSRemarkingPolicyTableID

associatedDSCPRemarkingPolicyTableID string
Discussion

ID of the DSCP Remarking Policy Table associated with this Egress QoS policy.

Charateristics

Format: free
SDK attribute: associatedDSCPRemarkingPolicyTableID

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

customSpqDepth integer filterable   orderable  
Discussion

Custom Depth of the Strict Priority Queue (Queue1). Measured as 'Number of Packets'. A value of zero indicates it is 'not set'. Valid values are in range 32 to 512.

Charateristics

Default value: 0
Max value: 512
SDK attribute: customSpqDepth

defaultServiceClass enum filterable   orderable  
Discussion

The Default Service Class for this Egress QoS Policy. The queue that contains the default service class will be treated as the default queue.

Charateristics

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

description string filterable  
Discussion

A description of the QoS object

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

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

mgmtQueueAssociatedRateLimiterID string
Discussion

Rate Limiter ID associated to the Management Queue for this Egress QoS Policy.

Charateristics

Format: free
SDK attribute: mgmtQueueAssociatedRateLimiterID

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

networkCtrlQueueAssociatedRateLimiterID string
Discussion

Rate limiter ID associated to the Network Control Queue for this Egress QoS Policy.

Charateristics

Format: free
SDK attribute: networkCtrlQueueAssociatedRateLimiterID

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

parentQueueAssociatedRateLimiterID string required  
Discussion

ID of the parent rate limiter associated with this Egress QoS policy.

Charateristics

Format: free
SDK attribute: parentQueueAssociatedRateLimiterID

queue1AssociatedRateLimiterID string
Discussion

ID of the queue1 rate limiter associated with this Egress QoS policy.

Charateristics

Format: free
SDK attribute: queue1AssociatedRateLimiterID

queue1ForwardingClasses list
Discussion

Queue1 Forwarding Classes for this Egress QoS Policy 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: queue1ForwardingClasses

queue2AssociatedRateLimiterID string
Discussion

ID of the queue2 rate limiter associated with this Egress QoS policy.

Charateristics

Format: free
SDK attribute: queue2AssociatedRateLimiterID

queue2ForwardingClasses list
Discussion

Queue2 Forwarding Classes for this Egress QoS Policy 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: queue2ForwardingClasses

queue3AssociatedRateLimiterID string
Discussion

ID of the queue3 rate limiter associated with this Egress QoS policy.

Charateristics

Format: free
SDK attribute: queue3AssociatedRateLimiterID

queue3ForwardingClasses list required  
Discussion

Queue3 Forwarding Classes for this Egress QoS Policy 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: queue3ForwardingClasses

queue4AssociatedRateLimiterID string
Discussion

ID of the queue4 rate limiter associated with this Egress QoS policy.

Charateristics

Format: free
SDK attribute: queue4AssociatedRateLimiterID

queue4ForwardingClasses list
Discussion

Queue4 Forwarding Classes for this Egress QoS Policy 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: queue4ForwardingClasses