dellemc.enterprise_sonic.sonic_qos_maps module – Manage QoS maps configuration on SONiC
Note
This module is part of the dellemc.enterprise_sonic collection (version 2.5.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install dellemc.enterprise_sonic
.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_qos_maps
.
New in dellemc.enterprise_sonic 2.5.0
Synopsis
This module provides configuration management of QoS maps for devices running SONiC
Parameters
Parameter |
Comments |
---|---|
QoS maps configuration |
|
DOT1P maps configuration |
|
DOT1P map entries configuration |
|
DOT1P value, range 0-7 |
|
Forwarding group value, range 0-7 |
|
Name of DOT1P map |
|
DSCP maps configuration |
|
DSCP map entries configuration |
|
DSCP value, range 0-63 |
|
Forwarding group value, range 0-7 |
|
Name of DSCP map |
|
Forwarding group DOT1P maps configuration |
|
Forwarding group DOT1P map entries configuration |
|
DOT1P value, range 0-7 |
|
Forwarding group value, range 0-7 |
|
Name of forwarding group DOT1P map |
|
Forwarding group DSCP maps configuration |
|
Forwarding group DSCP map entries configuration |
|
DSCP value, range 0-63 |
|
Forwarding group value, range 0-7 |
|
Name of forwarding group DSCP map |
|
Forwarding group priority group maps configuration |
|
Forwarding group priority group entries configuration |
|
Forwarding group value, range 0-7 |
|
Priority group index value, range 0-7 |
|
Name of forwarding group priority group map |
|
Forwarding group queue maps configuration |
|
Forwarding group queue map entries configuration |
|
Forwarding group value, range 0-7 |
|
Output queue index value, range 0-7 |
|
Name of forwarding group queue map |
|
PFC priority priority group maps configuration |
|
PFC priority priority group map entries configuration |
|
DOT1P value, range 0-7 |
|
Priority group index value, range 0-7 |
|
Name of PFC priority priority group map SONiC currently only supports configuration of a single PFC priority priority group map |
|
PFC priority queue maps configuration |
|
PFC priority queue map entries configuration |
|
DOT1P value, range 0-7 |
|
Output queue index value, range 0-7 |
|
Name of PFC priority queue map SONiC currently only supports configuration of a single PFC priority queue map |
|
The state of the configuration after module completion. Choices:
|
Notes
Note
Tested against Enterprise SONiC Distribution by Dell Technologies.
Supports
check_mode
.
Examples
# Using Merged
#
# Before state:
# -------------
#
# sonic# show qos map dscp-tc
# (No qos map dscp-tc configuration present)
- name: Merge QoS maps configurations
dellemc.enterprise_sonic.sonic_qos_maps:
config:
dscp_maps:
- name: dscp_map1
entries:
- dscp: 0
fwd_group: 0
- dscp: 1
fwd_group: 7
- name: dscp_map2
entries:
- dscp: 2
fwd_group: 4
state: merged
# After state:
# ------------
#
# sonic# show qos map dscp-tc
# DSCP-TC-MAP: dscp_map1
# ----------------------------
# DSCP TC
# ----------------------------
# 0 0
# 1 7
# ----------------------------
# DSCP-TC-MAP: dscp_map2
# ----------------------------
# DSCP TC
# ----------------------------
# 2 4
# ----------------------------
#
#
# Using Replaced
#
# Before state:
# -------------
#
# sonic# show qos map dscp-tc
# DSCP-TC-MAP: dscp_map1
# ----------------------------
# DSCP TC
# ----------------------------
# 0 0
# 1 7
# ----------------------------
# DSCP-TC-MAP: dscp_map2
# ----------------------------
# DSCP TC
# ----------------------------
# 2 4
# ----------------------------
- name: Replace QoS maps configurations
dellemc.enterprise_sonic.sonic_qos_maps:
config:
dscp_maps:
- name: dscp_map1
entries:
- dscp: 3
fwd_group: 5
state: replaced
# After state:
# ------------
#
# sonic# show qos map dscp-tc
# DSCP-TC-MAP: dscp_map1
# ----------------------------
# DSCP TC
# ----------------------------
# 3 5
# ----------------------------
# DSCP-TC-MAP: dscp_map2
# ----------------------------
# DSCP TC
# ----------------------------
# 2 4
# ----------------------------
#
#
# Using Overridden
# Before state:
# -------------
#
# sonic# show qos map dscp-tc
# DSCP-TC-MAP: dscp_map1
# ----------------------------
# DSCP TC
# ----------------------------
# 3 5
# ----------------------------
# DSCP-TC-MAP: dscp_map2
# ----------------------------
# DSCP TC
# ----------------------------
# 2 4
# ----------------------------
- name: Override QoS maps configurations
dellemc.enterprise_sonic.sonic_qos_maps:
config:
pfc_priority_queue_maps:
- name: pfc_map1
entries:
- dot1p: 0
queue_index: 0
- dot1p: 4
queue_index: 5
state: overridden
# After state:
# ------------
#
# sonic# show qos map pfc-priority-queue
# PFC-Priority-Queue-MAP: pfc_map1
# ----------------------------
# PFC Priority Queue
# ----------------------------
# 0 0
# 4 5
# ----------------------------
#
#
# Using deleted
#
# Before state:
# -------------
#
# sonic# show qos map dot1p-tc
# DOT1P-TC-MAP: dot1p_map1
# ----------------------------
# DOT1P TC
# ----------------------------
# 0 0
# 1 6
# ----------------------------
# DOT1P-TC-MAP: dot1p_map2
# ----------------------------
# DOT1P TC
# ----------------------------
# 2 5
# ----------------------------
- name: Delete QoS maps configurations
dellemc.enterprise_sonic.sonic_qos_maps:
config:
dot1p_maps:
- name: dot1p_map1
entries:
- dot1p: 0
- dot1p: 1
fwd_group: 6
- name: dot1p_map2
state: deleted
# After state:
# ------------
#
# sonic# show qos map dot1p-tc
# (No qos map dot1p-tc configuration present)
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The resulting configuration module invocation. Returned: when changed Sample: |
|
The generated configuration module invocation. Returned: when Sample: |
|
The configuration prior to the module invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |