dellemc.enterprise_sonic.sonic_roce module – Manage RoCE QoS 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_roce.

New in dellemc.enterprise_sonic 2.5.0

Synopsis

  • This module provides configuration management of RoCE(v2) QoS for devices running SONiC

Parameters

Parameter

Comments

config

dictionary

RoCE QoS configuration

pfc_priority

string

Specifies the PFC priorities to enable RoCEv2 buffer default configuration on

Range 0-7, two priority values separated by comma

Ex. ‘3,4’

Only configurable when RoCE is enabled

roce_enable

boolean

Enable or disable RoCEv2 default buffer configuration

Choices:

  • false

  • true

state

string

The state of the configuration after module completion.

Choices:

  • "merged" ← (default)

Notes

Note

  • Tested against Enterprise SONiC Distribution by Dell Technologies.

  • Supports check_mode.

Examples

# Using Merged
#
# Before state:
# -------------
#
# sonic# show running-configuration | grep roce
# (No RoCE configuration present)

- name: Enable RoCE for PFC priorities
  dellemc.enterprise_sonic.sonic_roce:
    config:
      roce_enable: True
      pfc_priorities: '3,4'
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration | grep roce
# roce enable pfc-priority 3,4

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

after

list / elements=string

The configuration from module invocation.

Returned: when changed

Sample: ["The configuration returned will always be in the same format as the parameters above.\n"]

after(generated)

list / elements=string

The generated (simulated) configuration expected from module invocation.

Returned: when check_mode

Sample: ["The configuration returned will always be in the same format\n as the parameters above.\n"]

before

list / elements=string

The configuration prior to the module invocation.

Returned: always

Sample: ["The configuration returned will always be in the same format as the parameters above.\n"]

commands

list / elements=string

The set of commands pushed to the remote device.

Returned: always

Sample: ["command 1", "command 2", "command 3"]

Authors

  • Shade Talabi (@stalabi1)