networktocode.nautobot.route_target module – Creates or removes route targets from Nautobot

Note

This module is part of the networktocode.nautobot collection (version 4.1.1).

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.route_target.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates or removes route targets from Nautobot

Requirements

The below requirements are needed on the host that executes this module.

  • pynautobot

Parameters

Parameter

Comments

api_version

string

added in 4.1.0 of networktocode.nautobot

API Version Nautobot REST API

custom_fields

dictionary

added in 3.0.0 of networktocode.nautobot

must exist in Nautobot

description

string

added in 3.0.0 of networktocode.nautobot

Tag description

name

string / required

Route target name

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

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.

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

tags

list / elements=any

added in 3.0.0 of networktocode.nautobot

Any tags that the device may need to be associated with

tenant

any

added in 3.0.0 of networktocode.nautobot

The tenant that the route target will be assigned to

token

string / required

The token created within Nautobot to authorize API access

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Default: “true”

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test route target creation/deletion"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create Route Targets
      networktocode.nautobot.route_target:
        url: http://nautobot.local
        token: thisIsMyToken
        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
      networktocode.nautobot.route_target:
        url: http://nautobot.local
        token: thisIsMyToken
        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
      networktocode.nautobot.route_target:
        url: http://nautobot.local
        token: thisIsMyToken
        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

msg

string

Message indicating failure or info about what has been achieved

Returned: always

route_target

dictionary

Serialized object as created/existent/updated/deleted within Nautobot

Returned: always

Authors

  • Mikhail Yohman (@FragmentedPacket)