netbox.netbox.netbox_route_target module – Creates or removes route targets from NetBox¶
Note
This module is part of the netbox.netbox collection (version 3.10.0).
To install it, use: ansible-galaxy collection install netbox.netbox
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netbox.netbox.netbox_route_target
.
New in netbox.netbox 2.0.0
Synopsis¶
Creates or removes route targets from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the route target configuration |
|
Comments that may include additional information in regards to the route target |
|
must exist in NetBox |
|
Tag description |
|
Route target name |
|
Any tags that the device may need to be associated with |
|
The tenant that the route target will be assigned to |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. |
|
The state of the object. Choices: |
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: :ansible-option-default:`true` |
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 |
Description |
---|---|
Message indicating failure or info about what has been achieved Returned: always |
|
Serialized object as created/existent/updated/deleted within NetBox Returned: always |