On this page
mellanox.onyx.onyx_qos – Configures QoS
Note
This plugin is part of the mellanox.onyx collection (version 1.0.0).
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 mellanox.onyx.
To use it in a playbook, specify: mellanox.onyx.onyx_qos.
Synopsis
- This module provides declarative management of Onyx QoS configuration on Mellanox ONYX network devices.
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| interfaces
        
        string / required
         | 
      
        
        list of interfaces name.
         | 
     |
| rewrite_dscp
        
        string
         | 
      
       
  | 
      
        
        rewrite with type dscp.
         | 
     
| rewrite_pcp
        
        string
         | 
      
       
  | 
      
        
        rewrite with type pcp.
         | 
     
| trust
        
        string
         | 
      
       
  | 
      
        
        trust type.
         | 
     
Notes
Note
- Tested on ONYX 3.6.8130
 
Examples
- name: Configure QoS
  onyx_QoS:
    interfaces:
      - Mpo7
      - Mpo7
    trust: L3
    rewrite_pcp: disabled
    rewrite_dscp: enabled
- name: Configure QoS
  onyx_QoS:
    interfaces:
      - Eth1/1
      - Eth1/2
    trust: both
    rewrite_pcp: disabled
    rewrite_dscp: enabled
  Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| commands
        
        list / elements=string
         | 
      always | 
        
        The list of configuration mode commands to send to the device.
         Sample:
        
       
        ['interface ethernet 1/16 qos trust L3', 'interface mlag-port-channel 7 qos trust L3', 'interface port-channel 1 qos trust L3', 'interface mlag-port-channel 7 qos trust L2', 'interface mlag-port-channel 7 qos rewrite dscp', 'interface ethernet 1/16 qos rewrite pcp', 'interface ethernet 1/1 no qos rewrite pcp']
         | 
     
Authors
- Anas Badaha (@anasb)
 
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/latest/collections/mellanox/onyx/onyx_qos_module.html