ansible / ansible.builtin / v2.8.13 / module / _nxos_ip_interface
Removed in 2.9
Reason:Replaced with common C(*_l3_interface) network modules. | Alternative:Use M(nxos_l3_interface) instead.
Manages L3 attributes for IPv4 and IPv6 interfaces.
| "added in version" 2.1 of ansible.builtin"
Authors: Jason Edelman (@jedelman8), Gabriele Gerbino (@GGabriele)
deprecated | supported by network
pip
Install with pip install ansible==2.8.13
Manages Layer 3 attributes for IPv4 and IPv6 interfaces.
- name: Ensure ipv4 address is configured on Ethernet1/32 nxos_ip_interface: interface: Ethernet1/32 transport: nxapi version: v4 state: present addr: 20.20.20.20 mask: 24
- name: Ensure ipv6 address is configured on Ethernet1/31 nxos_ip_interface: interface: Ethernet1/31 transport: cli version: v6 state: present addr: '2001::db8:800:200c:cccb' mask: 64
- name: Ensure ipv4 address is configured with tag nxos_ip_interface: interface: Ethernet1/32 transport: nxapi version: v4 state: present tag: 100 addr: 20.20.20.20 mask: 24
- name: Ensure ipv4 address is configured on sub-intf with dot1q encapsulation nxos_ip_interface: interface: Ethernet1/32.10 transport: nxapi version: v4 state: present dot1q: 10 addr: 20.20.20.20 mask: 24
- name: Configure ipv4 address as secondary if needed nxos_ip_interface: interface: Ethernet1/32 transport: nxapi version: v4 state: present allow_secondary: true addr: 21.21.21.21 mask: 24
tag: default: 0 description: - Route tag for IPv4 or IPv6 Address in integer format. version_added: '2.4' version_added_collection: ansible.builtin addr: description: - IPv4 or IPv6 Address. mask: description: - Subnet mask for IPv4 or IPv6 Address in decimal format. dot1q: description: - Configures IEEE 802.1Q VLAN encapsulation on the subinterface. The range is from 2 to 4093. version_added: '2.5' version_added_collection: ansible.builtin state: choices: - present - absent default: present description: - Specify desired state of the resource. version: choices: - v4 - v6 default: v4 description: - Version of IP address. If the IP address is IPV4 version should be v4. If the IP address is IPV6 version should be v6. 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 interface: description: - Full name of interface, i.e. Ethernet1/1, vlan10. required: true allow_secondary: default: 'no' description: - Allow to configure IPv4 secondary addresses on interface. type: bool version_added: '2.4' version_added_collection: ansible.builtin
changed: description: check to see if a change was made on the device returned: always sample: true type: bool commands: description: commands sent to the device returned: always sample: - interface ethernet1/32 - ip address 20.20.20.20/24 secondary tag 100 type: list end_state: description: k/v pairs of IP attributes after module execution returned: always sample: addresses: - addr: 11.11.11.11 mask: 17 secondary: false tag: 101 - addr: 20.20.20.20 mask: 24 secondary: true tag: 100 interface: ethernet1/32 prefixes: - 11.11.0.0/17 - 20.20.20.0/24 type: ethernet vrf: default type: dict existing: description: k/v pairs of existing IP attributes on the interface returned: always sample: addresses: - addr: 11.11.11.11 mask: 17 secondary: false tag: 101 interface: ethernet1/32 prefixes: - 11.11.0.0/17 type: ethernet vrf: default type: dict proposed: description: k/v pairs of parameters passed into module returned: always sample: addr: 20.20.20.20 allow_secondary: true interface: Ethernet1/32 mask: '24' tag: 100 type: dict