ce_interface - Manages physical attributes of interfaces on HUAWEI CloudEngine switches.¶

New in version 2.4.

Synopsis
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

Manages physical attributes of interfaces on HUAWEI CloudEngine switches.

Parameters ¶

Parameter	Choices/Defaults	Comments
admin_state	Choices: up down	Specifies the interface management status. The value is an enumerated type. up, An interface is in the administrative Up state. down, An interface is in the administrative Down state.
description		Specifies an interface description. The value is a string of 1 to 242 case-sensitive characters, spaces supported but question marks (?) not supported.
interface		Full name of interface, i.e. 40GE1/0/10, Tunnel1.
interface_type	Choices: ge 10ge 25ge 4x10ge 40ge 100ge vlanif loopback meth eth-trunk nve tunnel ethernet fcoe-port fabric-port stack-port null	Interface type to be configured from the device.
l2sub bool	Choices: no ← yes	Specifies whether the interface is a Layer 2 sub-interface.
mode	Choices: layer2 layer3	Manage Layer 2 or Layer 3 state of the interface.
state	Choices: present ← absent default	Specify desired state of the resource.

Notes ¶

Note

This module is also used to create logical interfaces such as vlanif and loopbacks.

Examples ¶

- name: interface module 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: Ensure an interface is a Layer 3 port and that it has the proper description
    ce_interface:
      interface: 10GE1/0/22
      description: 'Configured by Ansible'
      mode: layer3
      provider: '{{ cli }}'

  - name: Admin down an interface
    ce_interface:
      interface: 10GE1/0/22
      admin_state: down
      provider: '{{ cli }}'

  - name: Remove all tunnel interfaces
    ce_interface:
      interface_type: tunnel
      state: absent
      provider: '{{ cli }}'

  - name: Remove all logical interfaces
    ce_interface:
      interface_type: '{{ item }}'
      state: absent
      provider: '{{ cli }}'
    with_items:
      - loopback
      - eth-trunk
      - nve

  - name: Admin up all 10GE interfaces
    ce_interface:
      interface_type: 10GE
      admin_state: up
      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 dict	always	k/v pairs of switchport after module execution Sample: {'interface': '10GE1/0/10', 'admin_state': 'down', 'description': 'None', 'mode': 'layer2'}
existing dict	always	k/v pairs of existing switchport Sample: {'interface': '10GE1/0/10', 'admin_state': 'up', 'description': 'None', 'mode': 'layer2'}
proposed dict	always	k/v pairs of parameters passed into module Sample: {'interface': '10GE1/0/10', 'admin_state': 'down'}
updates list	always	command list sent to the device Sample: ['interface 10GE1/0/10', 'shutdown']

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

QijunPan (@CloudEngine-Ansible)

Hint

If you notice any issues in this documentation you can edit this document to improve it.