GatewayQoSProfile

A Gateway QoS Profile Object.


Properties

integer
burstSize Optional

Burst size in bytes.


integer
committedBandwidth Optional

Committed bandwidth in both directions specificd in Mb/s. Bandwidth is limited to line rate when the value configured is greater than line rate.


string
description Optional

The description of the gateway QoS profile.


string
displayName Optional

Name of the gateway QoS profile. This corresponds to the name used in NSX-T manager’s logs or GUI.


string
excessAction Optional

Action on traffic exceeding bandwidth.


string
id Optional

The unique id of the gateway QoS profile.


nsxTManagerRef Optional

The NSX-T manager where this gateway QoS profile is configured.

JSON Example

{
	"burstSize": 0,
	"committedBandwidth": 0,
	"description": "string",
	"displayName": "string",
	"excessAction": "string",
	"id": "string",
	"nsxTManagerRef": {
		"id": "string",
		"name": "string"
	}
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-cross-references:
- cross-reference:
    alias: orgVdcId
    description: |
      A filter to look up gateway QoS profiles that can be used into this Org VDC.
    referenced-property: id
    referenced-type: ./networking/vdcs.yaml#/definitions/OrgVdc
- cross-reference:
    alias: vdcGroupId
    description: |
      A filter to look up gateway QoS profiles that can be used into this VDC Group.
    referenced-property: id
    referenced-type: ./networking/vdcGroups.yaml#/definitions/VdcGroup
x-vcloud-property-annotations:
  burstSize:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
  committedBandwidth:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
  description:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
  displayName:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
  excessAction:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
  id:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSortable
  nsxTManagerRef:
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSortable
    x-vcloud-restricted: Visible to provider users only
Availability
Added in 36.2
Property Of

GatewayQoSProfiles
What's changed in v36.2?

INTRODUCED

New! in version v36.2

Feedback

Was this page helpful?