networktocode.nautobot.ip_address_to_interface module – Creates or removes IP address to interface association from Nautobot
Note
This module is part of the networktocode.nautobot collection (version 5.2.0).
To install it, use: ansible-galaxy collection install networktocode.nautobot
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: networktocode.nautobot.ip_address_to_interface
.
New in networktocode.nautobot 5.0.0
Synopsis
Creates or removes IP address to interface association from Nautobot
Requirements
The below requirements are needed on the host that executes this module.
pynautobot
Parameters
Parameter |
Comments |
---|---|
API Version Nautobot REST API |
|
Device interface to associate with an IP. |
|
IP address to associate with an interface. |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment. |
|
Use Choices: |
|
The token created within Nautobot to authorize API access |
|
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) |
|
If Default: :ansible-option-default:`true` |
|
VM interface to associate with an IP. |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples
- name: "Test Nautobot IP address to interface module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: "Add IP address on GigabitEthernet4 - test100"
networktocode.nautobot.ip_address_to_interface:
url: "{{ nautobot_url }}"
token: "{{ nautobot_token }}"
ip_address: "{{ ip_address['key'] }}"
interface:
name: GigabitEthernet4
device: test100
vars:
ip_address: "{{ lookup('networktocode.nautobot.lookup', 'ip-addresses', api_endpoint=nautobot_url, token=nautobot_token, api_filter='address=10.100.0.1/32') }}"
- name: "Delete IP address on GigabitEthernet4 - test100"
networktocode.nautobot.ip_address_to_interface:
url: "{{ nautobot_url }}"
token: "{{ nautobot_token }}"
ip_address: "{{ ip_address['key'] }}"
interface:
name: GigabitEthernet4
device: test100
state: absent
vars:
ip_address: "{{ lookup('networktocode.nautobot.lookup', 'ip-addresses', api_endpoint=nautobot_url, token=nautobot_token, api_filter='address=10.100.0.1/32') }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Serialized object as created or already existent within Nautobot Returned: on creation |
|
Message indicating failure or info about what has been achieved Returned: always |