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

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.vrf.

New in version 1.0.0: of networktocode.nautobot

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

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

The description of the vrf

enforce_unique

boolean

added in 3.0.0 of networktocode.nautobot

Prevent duplicate prefixes/IP addresses within this VRF

Choices:

  • no

  • yes

export_targets

list / elements=string

added in 3.0.0 of networktocode.nautobot

Export targets tied to VRF

import_targets

list / elements=string

added in 3.0.0 of networktocode.nautobot

Import targets tied to VRF

name

string / required

added in 3.0.0 of networktocode.nautobot

The name of the vrf

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.

rd

string

added in 3.0.0 of networktocode.nautobot

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

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

tags

list / elements=raw

added in 3.0.0 of networktocode.nautobot

Any tags that the vrf may need to be associated with

tenant

raw

added in 3.0.0 of networktocode.nautobot

The tenant that the vrf 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

raw

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

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
        enforce_unique: true
        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)