W3cubDocs

/Ansible

nxos_interface - Manages physical attributes of interfaces.

New in version 2.1.

Synopsis

  • Manages physical attributes of interfaces of NX-OS switches.

Options

parameter required default choices comments
admin_state
 no up
  • up
  • down
Administrative state of the interface.
description
 no
Interface description.
fabric_forwarding_anycast_gateway
(added in 2.2)
 no
  • true
  • false
Associate SVI with anycast gateway under VLAN configuration mode.
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.
interface
 yes
Full name of interface, i.e. Ethernet1/1, port-channel10.
interface_type
(added in 2.2)
 no
  • loopback
  • portchannel
  • svi
  • nve
Interface type to be unconfigured from the device.
ip_forward
(added in 2.2)
 no
  • enable
  • disable
Enable/Disable ip forward feature on SVIs.
mode
 no
  • layer2
  • layer3
Manage Layer 2 or Layer 3 state of the interface.
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.
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).
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.
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.
state
 yes present
  • present
  • absent
  • default
Specify desired state of the resource.
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).
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_ssl
 no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
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.
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.

Examples

- name: Ensure an interface is a Layer 3 port and that it has the proper description
  nxos_interface:
    interface: Ethernet1/1
    description: 'Configured by Ansible'
    mode: layer3
    host: 68.170.147.165

- name: Admin down an interface
  nxos_interface:
    interface: Ethernet2/1
    host: 68.170.147.165
    admin_state: down

- name: Remove all loopback interfaces
  nxos_interface:
    interface: loopback
    state: absent
    host: 68.170.147.165

- name: Remove all logical interfaces
  nxos_interface:
    interface_type: "{{ item }} "
    state: absent
    host: "{{ inventory_hostname }}"
  with_items:
    - loopback
    - portchannel
    - svi
    - nve

- name: Admin up all loopback interfaces
  nxos_interface:
    interface: loopback 0-1023
    admin_state: up

- name: Admin down all loopback interfaces
  nxos_interface:
    interface: looback 0-1023
    admin_state: down

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
commands
command list sent to the device
 always list ['interface port-channel101', 'shutdown']

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • This module is also used to create logical interfaces such as svis and loopbacks.
  • Be cautious of platform specific idiosyncrasies. For example, when you default a loopback interface, the admin state toggles on certain versions of NX-OS.
  • The nxos_overlay_global anycast_gateway_mac attribute must be set before setting the fabric_forwarding_anycast_gateway property.

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 this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/nxos_interface_module.html