community.network.ce_ip_interface module – Manages L3 attributes for IPv4 and IPv6 interfaces on HUAWEI CloudEngine switches.
Note
This module is part of the community.network collection (version 4.0.2).
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_ip_interface
.
Synopsis
Manages Layer 3 attributes for IPv4 and IPv6 interfaces on HUAWEI CloudEngine switches.
Parameters
Parameter |
Comments |
---|---|
IPv4 or IPv6 Address. |
|
Full name of interface, i.e. 40GE1/0/22, vlanif10. |
|
Specifies an address type. The value is an enumerated type. main, primary IP address. sub, secondary IP address. Choices:
|
|
Subnet mask for IPv4 or IPv6 Address in decimal format. |
|
Specify desired state of the resource. Choices:
|
|
IP address version. Choices:
|
Notes
Note
Interface must already be a L3 port when using this module.
Logical interfaces (loopback, vlanif) must be created first.
mask
must be inserted in decimal format (i.e. 24) for both IPv6 and IPv4.A single interface can have multiple IPv6 configured.
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: Ip_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 ipv4 address is configured on 10GE1/0/22
community.network.ce_ip_interface:
interface: 10GE1/0/22
version: v4
state: present
addr: 20.20.20.20
mask: 24
provider: '{{ cli }}'
- name: Ensure ipv4 secondary address is configured on 10GE1/0/22
community.network.ce_ip_interface:
interface: 10GE1/0/22
version: v4
state: present
addr: 30.30.30.30
mask: 24
ipv4_type: sub
provider: '{{ cli }}'
- name: Ensure ipv6 is enabled on 10GE1/0/22
community.network.ce_ip_interface:
interface: 10GE1/0/22
version: v6
state: present
provider: '{{ cli }}'
- name: Ensure ipv6 address is configured on 10GE1/0/22
community.network.ce_ip_interface:
interface: 10GE1/0/22
version: v6
state: present
addr: 2001::db8:800:200c:cccb
mask: 64
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 IP attributes after module execution Returned: always Sample: |
|
k/v pairs of existing IP attributes on the interface Returned: always Sample: |
|
k/v pairs of parameters passed into module Returned: always Sample: |
|
commands sent to the device Returned: always Sample: |