networktocode.nautobot.vrf module – Create, update or delete vrfs within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 5.2.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.vrf.

New in networktocode.nautobot 1.0.0

Synopsis

  • Creates, updates or removes vrfs from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

api_version

string

added in networktocode.nautobot 4.1.0

API Version Nautobot REST API

custom_fields

dictionary

added in networktocode.nautobot 3.0.0

Must exist in Nautobot and in key/value format

description

string

added in networktocode.nautobot 3.0.0

The description of the vrf

export_targets

list / elements=string

added in networktocode.nautobot 3.0.0

Export targets tied to VRF

import_targets

list / elements=string

added in networktocode.nautobot 3.0.0

Import targets tied to VRF

name

string / required

added in networktocode.nautobot 3.0.0

The name of the vrf

namespace

string

added in networktocode.nautobot 5.0.0

namespace that IP address is associated with. VRFs are unique per namespaces.

Default: :ansible-option-default:`"Global"`

query_params

list / elements=string

added in networktocode.nautobot 3.0.0

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.

rd

string / required

added in networktocode.nautobot 3.0.0

The RD of the VRF. Must be quoted to pass as a string.

state

string

Use present or absent for adding or removing.

Choices:

tags

list / elements=any

added in networktocode.nautobot 3.0.0

Any tags that this item may need to be associated with

tenant

any

added in networktocode.nautobot 3.0.0

The tenant that the vrf will be assigned to

token

string / required

The token created within Nautobot to authorize API access

Can be omitted if the NAUTOBOT_TOKEN environment variable is configured.

url

string / required

The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)

Can be omitted if the NAUTOBOT_URL environment variable is configured.

validate_certs

any

If 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 NAUTOBOT_VALIDATE_CERTS environment variable is configured.

Default: :ansible-option-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 Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create vrf within Nautobot with only required information
      networktocode.nautobot.vrf:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test VRF
        state: present

    - name: Delete vrf within nautobot
      networktocode.nautobot.vrf:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test VRF
        state: absent

    - name: Create vrf with all information
      networktocode.nautobot.vrf:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test VRF
        rd: "65000:1"
        tenant: Test Tenant
        import_targets:
          - "65000:65001"
        export_targets:
          - "65000:65001"
        description: VRF description
        tags:
          - Schnozzberry
        state: present

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

vrf

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

Authors

  • Mikhail Yohman (@FragmentedPacket)