Documentation

nxos_l3_interface - Manage L3 interfaces on Cisco NXOS network devices

New in version 2.5.

Synopsis

  • This module provides declarative management of L3 interfaces on Cisco NXOS network devices.

Options

parameter
required
default
choices
comments
username
no
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
ssh_keyfile
no
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
name
no
Name of the L3 interface.
provider
no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
host
yes
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.
state
no
present
  • present
  • absent
State of the L3 interface configuration.
ipv4
no
IPv4 of the L3 interface.
timeout
(added in 2.3)
no
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. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
ipv6
no
IPv6 of the L3 interface.
aggregate
no
List of L3 interfaces definitions.
use_ssl
no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
password
no
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
validate_certs
no
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.
port
no
0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
transport
yes
cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
use_proxy
(added in 2.5)
no
yes
  • yes
  • no
If no, the environment variables http_proxy and https_proxy will be ignored.

Examples

- name: Set interface IPv4 address
  nxos_l3_interface:
    name: Ethernet2/3
    ipv4: 192.168.0.1/24

- name: Remove interface IPv4 address
  nxos_l3_interface:
    name: Ethernet2/3
    state: absent

- name: Set IP addresses on aggregate
  nxos_l3_interface:
    aggregate:
      - { name: Ethernet2/1, ipv4: 192.168.2.10/24 }
      - { name: Ethernet2/5, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }

- name: Remove IP addresses on aggregate
  nxos_l3_interface:
    aggregate:
      - { name: Ethernet2/1, ipv4: 192.168.2.10/24 }
      - { name: Ethernet2/5, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this {{plugin_type}}:

name
description
returned
type
sample
commands
The list of configuration mode commands to send to the device
always, except for the platforms that use Netconf transport to manage the device.
list
['interface ethernet2/3', 'no switchport', 'ip address 192.168.22.1/24', 'ipv6 address "fd5d:12c9:2201:1::1/64"', 'no ip address 192.168.22.1/24']


Notes

Note

Author

  • Trishna Guha (@trishnaguha)

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

If you want to help with development, please read Community Information & Contributing, Testing Ansible and Developing Modules.