community.network.ce_interface module – Manages physical attributes of interfaces on HUAWEI CloudEngine switches.
Note
This module is part of the community.network collection (version 5.0.3).
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 community.network
.
To use it in a playbook, specify: community.network.ce_interface
.
Synopsis
Manages physical attributes of interfaces on HUAWEI CloudEngine switches.
Aliases: network.cloudengine.ce_interface
Parameters
Parameter |
Comments |
---|---|
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. Choices:
|
|
Specifies an interface description. The value is a string of 1 to 242 case-sensitive characters, spaces supported but question marks (?) not supported. |
|
Full name of interface, i.e. 40GE1/0/10, Tunnel1. |
|
Interface type to be configured from the device. Choices:
|
|
Specifies whether the interface is a Layer 2 sub-interface. Choices:
|
|
Manage Layer 2 or Layer 3 state of the interface. Choices:
|
|
Specify desired state of the resource. Choices:
|
Notes
Note
This module is also used to create logical interfaces such as vlanif and loopbacks.
This module requires the netconf system service be enabled on the remote device being managed.
Recommended connection is
netconf
.This module also works with
local
connections for legacy playbooks.
Examples
- name: Interface module test
hosts: cloudengine
connection: local
gather_facts: false
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
community.network.ce_interface:
interface: 10GE1/0/22
description: 'Configured by Ansible'
mode: layer3
provider: '{{ cli }}'
- name: Admin down an interface
community.network.ce_interface:
interface: 10GE1/0/22
admin_state: down
provider: '{{ cli }}'
- name: Remove all tunnel interfaces
community.network.ce_interface:
interface_type: tunnel
state: absent
provider: '{{ cli }}'
- name: Remove all logical interfaces
community.network.ce_interface:
interface_type: '{{ item }}'
state: absent
provider: '{{ cli }}'
with_items:
- loopback
- eth-trunk
- nve
- name: Admin up all 10GE interfaces
community.network.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 |
Description |
---|---|
check to see if a change was made on the device Returned: always Sample: |
|
k/v pairs of switchport after module execution Returned: always Sample: |
|
k/v pairs of existing switchport Returned: always Sample: |
|
k/v pairs of parameters passed into module Returned: always Sample: |
|
command list sent to the device Returned: always Sample: |