vrf_device_assignment¶
Collection Note
This module is part of the networktocode.nautobot collection. To install the collection, use:
Added in version5.14.0
.
You need further requirements to be able to use this module, see the Requirements section for details.
Synopsis¶
- Creates or removes VRF to device assignments in Nautobot
Requirements¶
The following Python packages are needed on the host that executes this module:
Parameters¶
Parameter | Defaults / Choices | Comments |
---|---|---|
api_version str |
API Version Nautobot REST API Version Added: 4.1.0 |
|
device raw |
Device to assign the VRF to Requires one of I(device), I(virtual_machine), or I(virtual_device_context) if I(state=present) and the VRF to device assignment does not exist yet |
|
id str |
The UUID of the object to operate on Version Added: 5.13.0 |
|
query_params list / elements=str |
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. Version Added: 3.0.0 |
|
state str |
Default: present Choices: absent, present |
Use C(present) or C(absent) for adding or removing. |
token str required |
The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured. |
|
url str required |
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured. |
|
validate_certs raw |
Default: True |
If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured. |
virtual_device_context raw |
Virtual device context to assign the VRF to Requires one of I(device), I(virtual_machine), or I(virtual_device_context) if I(state=present) and the VRF to device assignment does not exist yet |
|
virtual_machine raw |
Virtual machine to assign the VRF to Requires one of I(device), I(virtual_machine), or I(virtual_device_context) if I(state=present) and the VRF to device assignment does not exist yet |
|
vrf raw |
VRF to assign to the device or virtual machine Required if I(state=present) and the VRF to device assignment does not exist yet |
Notes¶
Note
- This should be ran with connection C(local) and hosts C(localhost)
Examples¶
- name: "Create a VRF to device assignment"
networktocode.nautobot.vrf_device_assignment:
url: http://nautobot.local
token: thisIsMyToken
vrf: "My VRF"
device: "My Device"
state: present
- name: "Create a VRF to virtual machine assignment"
networktocode.nautobot.vrf_device_assignment:
url: http://nautobot.local
token: thisIsMyToken
vrf: "My VRF"
virtual_machine: "My Virtual Machine"
state: present
- name: "Delete a VRF to device assignment"
networktocode.nautobot.vrf_device_assignment:
url: http://nautobot.local
token: thisIsMyToken
vrf: "My VRF"
device: "My Device"
state: absent
- name: "Delete a VRF to virtual machine assignment"
networktocode.nautobot.vrf_device_assignment:
url: http://nautobot.local
token: thisIsMyToken
vrf: "My VRF"
virtual_machine: "My Virtual Machine"
state: absent
- name: "Delete a VRF to device assignment by id"
networktocode.nautobot.vrf_device_assignment:
url: http://nautobot.local
token: thisIsMyToken
id: 00000000-0000-0000-0000-000000000000
state: absent
Return Values¶
Key | Data Type | Description | Returned |
---|---|---|---|
msg | str | Message indicating successful operation | success |
vrf_device_assignment | dict | Serialized object as created or already existent within Nautobot | success (when I(state=present)) |
Authors¶
- Joe Wesch (@joewesch)