iosxr_interface – Manage Interface on Cisco IOS XR network devices¶
New in version 2.4.
DEPRECATED¶
| Removed in Ansible: | |
|---|---|
| version: 2.13 | |
| Why: | Newer and updated modules released with more functionality in Ansible 2.9 |
| Alternative: | iosxr_interfaces |
Synopsis¶
- This module provides declarative management of Interfaces on Cisco IOS XR network devices.
Requirements¶
The below requirements are needed on the host that executes this module.
- ncclient >= 0.5.3 when using netconf
- lxml >= 4.1.1 when using netconf
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
active
-
added in 2.5 |
|
Whether the interface is
active or preconfigured. Preconfiguration allows you to configure modular services cards before they are inserted into the router. When the cards are inserted, they are instantly configured. Active cards are the ones already inserted. |
|
|
aggregate
-
|
List of Interface definitions. Include multiple interface configurations together, one each on a separate line
|
||
|
delay
-
|
Default: 10
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values
up/down, tx_rate and rx_rate. |
|
|
description
-
|
Description of Interface being configured.
|
||
|
duplex
-
|
|
Configures the interface duplex mode. Default is auto-negotiation when not configured.
|
|
|
enabled
boolean
|
|
Removes the shutdown configuration, which removes the forced administrative down on the interface, enabling it to move to an up or down state.
|
|
|
mtu
-
|
Sets the MTU value for the interface. Range is between 64 and 65535'
|
||
|
name
-
/ required
|
Name of the interface to configure in
type + path format. e.g. GigabitEthernet0/0/0/0 |
||
|
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli.For more information please see the Network Guide.
A dict object containing connection details.
|
||
|
host
string
/ required
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
|
||
|
password
string
|
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_PASSWORD will be used instead. |
||
|
port
integer
|
Default: 22
|
Specifies the port to use when building the connection to the remote device.
|
|
|
ssh_keyfile
path
|
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
|
timeout
integer
|
Default: 10
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
|
|
username
string
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_USERNAME will be used instead. |
||
|
rx_rate
-
|
Receiver rate in bits per second (bps).
This is state check parameter only.
Supports conditionals, see Conditionals in Networking Modules
|
||
|
speed
-
|
|
Configure the speed for an interface. Default is auto-negotiation when not configured.
|
|
|
state
-
|
|
State of the Interface configuration,
up means present and operationally up and down means present and operationally down |
|
|
tx_rate
-
|
Transmit rate in bits per second (bps).
This is state check parameter only.
Supports conditionals, see Conditionals in Networking Modules
|
||
Notes¶
Note
- This module works with connection
network_cliandnetconf. See the IOS-XR Platform Options. - Tested against IOS XRv 6.1.3.
- Preconfiguration of physical interfaces is not supported with
netconftransport. - For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Examples¶
- name: configure interface
iosxr_interface:
name: GigabitEthernet0/0/0/2
description: test-interface
speed: 100
duplex: half
mtu: 512
- name: remove interface
iosxr_interface:
name: GigabitEthernet0/0/0/2
state: absent
- name: make interface up
iosxr_interface:
name: GigabitEthernet0/0/0/2
enabled: True
- name: make interface down
iosxr_interface:
name: GigabitEthernet0/0/0/2
enabled: False
- name: Create interface using aggregate
iosxr_interface:
aggregate:
- name: GigabitEthernet0/0/0/3
- name: GigabitEthernet0/0/0/2
speed: 100
duplex: full
mtu: 512
state: present
- name: Create interface using aggregate along with additional params in aggregate
iosxr_interface:
aggregate:
- { name: GigabitEthernet0/0/0/3, description: test-interface 3 }
- { name: GigabitEthernet0/0/0/2, description: test-interface 2 }
speed: 100
duplex: full
mtu: 512
state: present
- name: Delete interface using aggregate
iosxr_interface:
aggregate:
- name: GigabitEthernet0/0/0/3
- name: GigabitEthernet0/0/0/2
state: absent
- name: Check intent arguments
iosxr_interface:
name: GigabitEthernet0/0/0/5
state: up
delay: 20
- name: Config + intent
iosxr_interface:
name: GigabitEthernet0/0/0/5
enabled: False
state: down
delay: 20
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module will be removed in version 2.13. [deprecated]
- For more information see DEPRECATED.
Authors¶
- Ganesh Nalawade (@ganeshrn)
- Kedar Kekan (@kedarX)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.