New in version 2.1.
Manages Layer 3 attributes for IPv4 and IPv6 interfaces.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| addr | no | IPv4 or IPv6 Address. |
||
| 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, vlan10. |
||
| mask | no | Subnet mask for IPv4 or IPv6 Address in decimal format. |
||
| 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 | no | present |
| Specify desired state of the resource. |
| 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 |
| 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. The value of username 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. |
# 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 # 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
Common return values are documented here Common Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| end_state | k/v pairs of IP attributes after module execution | always | dict | {'interface': 'ethernet1/32', 'prefix': '20.20.20.0', 'type': 'ethernet', 'addresses': [{'mask': 24, 'addr': '20.20.20.20'}], 'vrf': 'default'} |
| changed | check to see if a change was made on the device | always | boolean | True |
| updates | commands sent to the device | always | list | ['interface ethernet1/32', 'ip address 20.20.20.20/24'] |
| proposed | k/v pairs of parameters passed into module | always | dict | {'interface': 'ethernet1/32', 'mask': '24', 'addr': '20.20.20.20'} |
| existing | k/v pairs of existing IP attributes on the interface | dict | {'interface': 'ethernet1/32', 'prefix': '11.11.0.0', 'type': 'ethernet', 'addresses': [{'mask': 17, 'addr': '11.11.11.11'}], 'vrf': 'default'} |
Note
Interface must already be a L3 port when using this module.
Note
Logical interfaces (po, loop, svi) must be created first.
Note
mask must be inserted in decimal format (i.e. 24) for both IPv6 and IPv4.
Note
A single interface can have multiple IPv6 configured.
For more information on what this means please read Core Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_ip_interface_module.html