W3cubDocs

/Ansible 2.11

community.network.ce_mtu – Manages MTU settings on HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.ce_mtu.

Synopsis

  • Manages MTU settings on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
interface
string
Full name of interface, i.e. 40GE1/0/22.
jumbo_max
string
Maximum frame size. The default value is 9216. The value is an integer and expressed in bytes. The value range is 1536 to 12224 for the CE12800 and 1536 to 12288 for ToR switches.
jumbo_min
string
Non-jumbo frame size threshold. The default value is 1518. The value is an integer that ranges from 1518 to jumbo_max, in bytes.
mtu
string
MTU for a specific interface. The value is an integer ranging from 46 to 9600, in bytes.
state
string
    Choices:
  • present ←
  • absent
Specify desired state of the resource.

Notes

Note

  • Either sysmtu param is required or interface AND mtu params are req’d.
  • state=absent unconfigures a given MTU if that value is currently present.
  • Recommended connection is network_cli.
  • This module also works with local connections for legacy playbooks.

Examples

- name: Mtu test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: "Config jumboframe on 40GE1/0/22"
    community.network.ce_mtu:
      interface: 40GE1/0/22
      jumbo_max: 9000
      jumbo_min: 8000
      provider: "{{ cli }}"

  - name: "Config mtu on 40GE1/0/22 (routed interface)"
    community.network.ce_mtu:
      interface: 40GE1/0/22
      mtu: 1600
      provider: "{{ cli }}"

  - name: "Config mtu on 40GE1/0/23 (switched interface)"
    community.network.ce_mtu:
      interface: 40GE1/0/22
      mtu: 9216
      provider: "{{ cli }}"

  - name: "Config mtu and jumboframe on 40GE1/0/22 (routed interface)"
    community.network.ce_mtu:
      interface: 40GE1/0/22
      mtu: 1601
      jumbo_max: 9001
      jumbo_min: 8001
      provider: "{{ cli }}"

  - name: "Unconfigure mtu and jumboframe on a given interface"
    community.network.ce_mtu:
      state: absent
      interface: 40GE1/0/22
      provider: "{{ cli }}"

Return Values

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

Key Returned Description
changed
boolean
always
check to see if a change was made on the device

Sample:
True
end_state
dictionary
always
k/v pairs of mtu/sysmtu values after module execution

Sample:
{'jumbo_max': '9000', 'jumbo_min': '8000', 'mtu': '1700'}
existing
dictionary
always
k/v pairs of existing mtu/sysmtu on the interface/system

Sample:
{'jumbo_max': '9216', 'jumbo_min': '1518', 'mtu': '1600'}
proposed
dictionary
always
k/v pairs of parameters passed into module

Sample:
{'jumbo_max': '9000', 'jumbo_min': '8000', 'mtu': '1700'}
updates
list / elements=string
always
command sent to the device

Sample:
['interface 40GE1/0/23', 'mtu 1700', 'jumboframe enable 9000 8000']


Authors

  • QijunPan (@QijunPan)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/ce_mtu_module.html