cisco / cisco.nxos / 3.2.0 / module / nxos_l3_interface
Removed in None
Reason:Updated modules released with more functionality | Alternative:nxos_l3_interfaces
(deprecated, removed after 2022-06-01) Manage L3 interfaces on Cisco NXOS network devices
| "added in version" 1.0.0 of cisco.nxos"
Authors: Trishna Guha (@trishnaguha)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.nxos:==3.2.0
collections: - name: cisco.nxos version: 3.2.0
This module provides declarative management of L3 interfaces on Cisco NXOS network devices.
- name: Set interface IPv4 address cisco.nxos.nxos_l3_interface: name: Ethernet2/3 ipv4: 192.168.0.1/24
- name: Remove interface IPv4 address cisco.nxos.nxos_l3_interface: name: Ethernet2/3 state: absent
- name: Set IP addresses on aggregate cisco.nxos.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 cisco.nxos.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
ipv4: description: - IPv4 of the L3 interface. type: str ipv6: description: - IPv6 of the L3 interface. type: str name: description: - Name of the L3 interface. type: str state: choices: - present - absent default: present description: - State of the L3 interface configuration. type: str provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.' - This option will be removed in a release after 2022-06-01. - For more information please see the U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. type: str authorize: default: false description: - Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. type: bool host: description: - 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. type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either I(cli) or I(nxapi) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: description: - Specifies the port to use when building the connection to the remote device. This value applies to either I(cli) or I(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). type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the I(cli) transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: str timeout: description: - 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). type: int transport: choices: - cli - nxapi default: cli description: - 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. type: str use_proxy: default: true description: - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. type: bool use_ssl: default: false description: - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi), otherwise this value is ignored. type: bool username: description: - 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 C(ANSIBLE_NET_USERNAME) will be used instead. type: str validate_certs: default: false description: - If C(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. type: bool type: dict aggregate: description: List of L3 interfaces definitions. elements: dict suboptions: ipv4: description: - IPv4 of the L3 interface. type: str ipv6: description: - IPv6 of the L3 interface. type: str name: description: - Name of the L3 interface. type: str state: choices: - present - absent description: - State of the L3 interface configuration. type: str type: list
commands: description: The list of configuration mode commands to send to the device returned: always, except for the platforms that use Netconf transport to manage the device. sample: - 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 type: list