New in version 2.4.
parameter | required | default | choices | comments |
---|---|---|---|---|
admin_state |
no |
|
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 |
no |
Specifies an interface description. The value is a string of 1 to 242 case-sensitive characters, spaces supported but question marks (?) not supported.
|
||
interface |
no |
Full name of interface, i.e. 40GE1/0/10, Tunnel1.
|
||
interface_type |
no |
|
Interface type to be configured from the device.
|
|
l2sub |
no |
Specifies whether the interface is a Layer 2 sub-interface.
|
||
mode |
no |
|
Manage Layer 2 or Layer 3 state of the interface.
|
|
state |
yes | present |
|
Specify desired state of the resource.
|
- 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 }}'
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
changed |
check to see if a change was made on the device
|
always | boolean | True |
end_state |
k/v pairs of switchport after module execution
|
always | dict | {'interface': '10GE1/0/10', 'admin_state': 'down', 'description': 'None', 'mode': 'layer2'} |
existing |
k/v pairs of existing switchport
|
always | dict | {'interface': '10GE1/0/10', 'admin_state': 'up', 'description': 'None', 'mode': 'layer2'} |
proposed |
k/v pairs of parameters passed into module
|
always | dict | {'interface': '10GE1/0/10', 'admin_state': 'down'} |
updates |
command list sent to the device
|
always | list | ['interface 10GE1/0/10', 'shutdown'] |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.