netbox.netbox.netbox_route_target – Creates or removes route targets from Netbox
Note
This plugin is part of the netbox.netbox collection (version 2.0.0).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_route_target
.
New in version 2.0.0: of netbox.netbox
Synopsis
- Creates or removes route targets from Netbox
Requirements
The below requirements are needed on the host that executes this module.
- pynetbox
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
data dictionary / required | Defines the route target configuration | ||
custom_fields dictionary | must exist in Netbox | ||
description string | Tag description | ||
name string / required | Route target name | ||
tags list / elements=string | Any tags that the device may need to be associated with | ||
tenant raw | The tenant that the route target will be assigned to | ||
netbox_token string / required | The token created within Netbox to authorize API access | ||
netbox_url string / required | URL of the Netbox instance resolvable by Ansible control host | ||
query_params list / elements=string | This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. | ||
state string |
| Use present or absent for adding or removing. | |
validate_certs raw | Default: "yes" | If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Notes
Note
- Tags should be defined as a YAML list
- This should be ran with connection
local
and hostslocalhost
Examples
- name: "Test route target creation/deletion" connection: local hosts: localhost gather_facts: False tasks: - name: Create Route Targets netbox.netbox.netbox_route_target: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "{{ item.name }}" tenant: "Test Tenant" tags: - Schnozzberry loop: - { name: "65000:65001", description: "management" } - { name: "65000:65002", description: "tunnel" } - name: Update Description on Route Targets netbox.netbox.netbox_route_target: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "{{ item.name }}" tenant: "Test Tenant" description: "{{ item.description }}" tags: - Schnozzberry loop: - { name: "65000:65001", description: "management" } - { name: "65000:65002", description: "tunnel" } - name: Delete Route Targets netbox.netbox.netbox_route_target: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "{{ item }}" state: absent loop: - "65000:65001" - "65000:65002"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
msg string | always | Message indicating failure or info about what has been achieved |
route_target dictionary | always | Serialized object as created/existent/updated/deleted within Netbox |
Authors
- Mikhail Yohman (@fragmentedpacket)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netbox/netbox/netbox_route_target_module.html