community.network.ce_interface – Manages physical attributes of interfaces on HUAWEI CloudEngine switches.
community.network.ce_interface – Manages physical attributes of interfaces on HUAWEI CloudEngine switches.
Note
This plugin is part of the community.network collection (version 1.3.0).
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.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
admin_state string |
|
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 string |
Specifies an interface description. The value is a string of 1 to 242 case-sensitive characters, spaces supported but question marks (?) not supported. | |
interface string |
Full name of interface, i.e. 40GE1/0/10, Tunnel1. | |
interface_type string |
|
Interface type to be configured from the device. |
l2sub boolean |
|
Specifies whether the interface is a Layer 2 sub-interface. |
mode string |
|
Manage Layer 2 or Layer 3 state of the interface. |
state string |
|
Specify desired state of the resource. |
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: 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
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 | 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 switchport after module execution
Sample: {'admin_state': 'down', 'description': 'None', 'interface': '10GE1/0/10', 'mode': 'layer2'} |
existing dictionary |
always |
k/v pairs of existing switchport
Sample: {'admin_state': 'up', 'description': 'None', 'interface': '10GE1/0/10', 'mode': 'layer2'} |
proposed dictionary |
always |
k/v pairs of parameters passed into module
Sample: {'admin_state': 'down', 'interface': '10GE1/0/10'} |
updates list / elements=string |
always |
command list sent to the device
Sample: ['interface 10GE1/0/10', 'shutdown'] |
Authors
- QijunPan (@QijunPan)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ce_interface_module.html