| URI | Description |
|---|---|
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | Configures, modifies and retrieves QoS on an interface. |
| GET URIs | Description |
|---|---|
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | Quality of Service (QoS). Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/dscp-cos | Apply DSCP-to-Traffic-Class map. Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/dscp-mutation | Apply DSCP-Mutation map. Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/dscp-traffic-class | Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos | Configure Default CoS. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/traffic-class | Configure Default Traffic Class (TC). Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust | Configure QoS Trust. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust/cos | Trust L2 CoS field in incoming packets for deriving internal Traffic Class. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust/dscp | Trust L3 DSCP field in incoming packets for deriving internal Traffic Class. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos-mutation | Apply CoS-Mutation map. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/traffic-class-cos | Apply Traffic-Class-to-CoS map. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos-traffic-class | Apply CoS-to-Traffic-Class map. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/random-detect | Configure Random Early Detect (RED) Profile. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/random-detect/traffic-class/{red-tc-value} | Traffic-class to configure RED on. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/drop-monitor | Configure QoS drop monitor polling. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/drop-monitor/enable | Enable polling on ingress and egress queue drops on this interface. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/flowcontrol | Configure IEEE 802.3x Flow Control. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/flowcontrol/rx | Configure Pause reception. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue | Configure Ingress Queue Parameters. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/unicast | Configure Unicast Packet Handling Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/unicast/queue-size/{traffic-class} | Configure unicast queue size. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast | Configure Multicast Packet Handling. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast/guarantee-rate | Configure multicast data guarantee rate. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast/best-effort-rate | Configure multicast data best effort rate. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast/queue-size/{traffic-class} | Configure multicast queue size. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos-mutation | Apply CoS Mutation map. Supported interface type: Ethernet, Port-channel. |
| POST URIs | Payload | Description |
|---|---|---|
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/random-detect | <traffic-class><red-tc-value>{traffic-class-id-type}</red-tc-value><red-profile-id>{uint32}</red-profile-id></traffic-class> | Configure RED on a traffic class. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface{interface-type}/{interface-name}/qos/rx-queue/unicast | <queue-size><traffic-class>{traffic-class-id-type}</traffic-class><min-queue-size>{min-queue-size-type}</min-queue-size><max-queue-size>{max-queue-size-type}</max-queue-size></queue-size> | Configure unicast queue size. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface{interface-type}/{interface-name}/qos/rx-queue/multicast | <queue-size><traffic-class>{traffic-class-id-type}</traffic-class><min-queue-size>{min-queue-size-type}</min-queue-size><max-queue-size>{max-queue-size-type}</max-queue-size></queue-size> | Configure multicast queue size. Supported interface type: Ethernet. |
| PUT URIs | Payload | Description |
|---|---|---|
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/dscp-cos | <dscp-cos>{map-name-type}</dscp-cos> | Configure Default CoS. Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/dscp-mutation | <dscp-mutation>{map-name-type}</dscp-mutation | Apply DSCP-Mutation map. Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/dscp-traffic-class | <dscp-traffic-class>{map-name-type}</dscp-traffic-class> | Apply DSCP-to-Traffic-Class map. Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos | <cos>{cos-id-type}</cos> | Configure Default CoSSupported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/traffic-class | <traffic-class>{traffic-class-id-type}</traffic-class> | Configure Default Traffic Class (TC). Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust/cos | <cos>true</cos> | Trust L2 CoS field in incoming packets for deriving internal Traffic ClassSupported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust/dscp | <dscp>true</dscp> | Trust L3 DSCP field in incoming packets for deriving internal Traffic ClassSupported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos-mutation | <cos-mutation>{map-name-type}</cos-mutation> | Apply CoS-Mutation map. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/traffic-class-cos | <traffic-class-cos>{map-name-type}</traffic-class-cos> | Apply Traffic-Class-to-CoS map. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos-traffic-class | <cos-traffic-class>{map-name-type}</cos-traffic-class> | Apply CoS-to-Traffic-Class map. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/drop-monitor/enable | <enable>true</enable> | Enable polling on ingress and egress queue drops on this interface. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/flowcontrol | <flowcontrol><tx>{enumeration}</tx><rx>{enumeration}</rx></flowcontrol> | Configure IEEE 802.3x Flow Control. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast/best-effort-rate | <best-effort-rate>{best-effort-rate-type}</best-effort-rate> | Configure multicast data best effort rate. Supported interface type: Ethernet. |
| PATCH URIs | Payload | Description |
|---|---|---|
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | <qos><dscp-cos>{map-name-type}</dscp-cos></qos> | Apply DSCP-to-CoS map. Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | <qos><dscp-traffic-class>{map-name-type}</dscp-traffic-class></qos> | Apply DSCP-to-Traffic-Class map. Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | <qos><dscp-mutation>{map-name-type}</dscp-mutation></qos> | Apply DSCP-Mutation map. Supported interface type: Ethernet, Port-channel, VE. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | <qos><cos>{cos-id-type}</cos></qos> | Configure Default CoS. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | <qos><traffic-class>{traffic-class-id-type}</traffic-class></qos> | Configure Default Traffic Class. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust | <trust><cos>true</cos></trust> | Trust L2 CoS field in incoming packets for deriving internal Traffic Class. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust | <trust><dscp>true</dscp></trust> | Trust L3 DSCP field in incoming packets for deriving internal Traffic Class. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | <qos><cos-mutation>{map-name-type}</cos-mutation></qos> | Apply CoS-Mutation mapSupported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | <qos><traffic-class-cos>{map-name-type}</traffic-class-cos></qos> | Apply Traffic-Class-to-CoS mapSupported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos | <qos><cos-traffic-class>{map-name-type}</cos-traffic-class></qos> | Apply CoS-to-Traffic-Class map. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/random-detect/traffic-class/{red-tc-value} | <traffic-class><red-profile-id>{uint32}</red-profile-id></traffic-class> | Configure RED on a traffic class. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/drop-monitor | <drop-monitor><enable>true</enable></drop-monitor> | Enable drop monitor polling on ingress and egress queue drops on this interface. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/flowcontrol | <flowcontrol><tx>{enumeration}</tx><rx>{enumeration}</rx></flowcontrol> | Configure IEEE 802.3x Flow Control. Supported interface type: Ethernet, Port-channel. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/unicast/queue-size/{traffic-class} | <queue-size><min-queue-size>{min-queue-size-type}</min-queue-size><max-queue-size>{max-queue-size-type}</max-queue-size></queue-size> | Configure unicast queue size. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast | <multicast><guarantee-rate>{guarantee-rate-type}</guarantee-rate></multicast> | Configure multicast data guarantee rate. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast | <multicast><best-effort-rate>{best-effort-rate-type}</best-effort-rate></multicast> | Configure multicast data best effort rate. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast/queue-size/{traffic-class} | <queue-size><min-queue-size>{min-queue-size-type}</min-queue-size><max-queue-size>{max-queue-size-type}</max-queue-size></queue-size> | Configure multicast data best effort rate. Supported interface type: Ethernet. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust | <trust><dscp/></trust> | Configure QoS trust DSCP for an specific interface. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/remark | <remark><dscp/></remark> | Configure QoS remark DSCP for an specific interface. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos-mutation | <cos-mutation><map>{cos-mutation-map-name}</map></cos-mutation> | Configure a CoS Mutation map for the interface. |
| DELETE URIs |
|---|
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/dscp-cos |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/dscp-mutation |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/dscp-traffic-class |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/traffic-class |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust/cos |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/trust/dscp |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos-mutation |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/traffic-class-cos |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/cos-traffic-class |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/random-detect/traffic-class/{red-tc-value} |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/drop-monitor/enable |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/flowcontrol |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/unicast/queue-size/{traffic-class} |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast/guarantee-rate |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast/best-effort-rate |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/qos/rx-queue/multicast/queue-size/{traffic-class} |
GET, POST, PATCH, DELETE, OPTIONS, and HEAD operations are supported.
The following example uses the GET option to retrieve the QoS configuration details.
http://host:80/rest/config/running/interface/Ethernet/%220/10%22/qos
None
<qos xmlns="urn:brocade.com:mgmt:brocade-qos-mls" xmlns:y="http://brocade.com/ns/rest"
y:self="/rest/config/running/interface/Ethernet/%220/10%22/qos">
<trust y:self="/rest/config/running/interface/Ethernet/%220/10%22/qos/trust">
<cos>false</cos>
<dscp>false</dscp>
</trust>
<random-detect y:self="/rest/config/running/interface/Ethernet/%220/10%22/qos/random-detect">
</random-detect>
<drop-monitor y:self="/rest/config/running/interface/Ethernet/%220/10%22/qos/drop-monitor">
<enable>false</enable>
</drop-monitor>
<flowcontrol y:self="/rest/config/running/interface/Ethernet/%220/10%22/qos/flowcontrol">
</flowcontrol>
</qos>
The following example uses the PATCH option to configure QoS.
http://host:80/rest/config/running/interface/Ethernet/%220/10%22/qos
<qos><cos>0</cos></qos>
None
The following example uses the DELETE option to remove the QOS configuration.
http://host:80/rest/config/running/interface/Ethernet/%220/10%22/qos
None
None
The following example uses the PATCH option to apply a CoS Mutation map to the specific ethernet interface.
http://host:80/rest/config/running/interface/ethernet/0/2/qos
<cos-mutation><map>cos-mut-map-1</map><cos-mutation>
None