netbox.netbox.netbox_vrf module – Create, update or delete vrfs within NetBox

Note

This module is part of the netbox.netbox collection (version 3.22.0).

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

New in netbox.netbox 0.1.0

Synopsis

• Creates, updates or removes vrfs from NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the vrf configuration
comments :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	Comments that may include additional information in regards to the VRF
custom_fields	must exist in NetBox
description	The description of the vrf
enforce_unique	Prevent duplicate prefixes/IP addresses within this VRF :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
export_targets :ansible-option-versionadded:`added in netbox.netbox 2.0.0`	Export targets tied to VRF
import_targets :ansible-option-versionadded:`added in netbox.netbox 2.0.0`	Import targets tied to VRF
name	The name of the vrf
rd	The RD of the VRF. Must be quoted to pass as a string.
tags	Any tags that the vrf may need to be associated with
tenant	The tenant that the vrf will be assigned to
headers	Dictionary of headers to be passed to the NetBox API.
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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.
state	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`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 NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: false

  tasks:
    - name: Create vrf within NetBox with only required information
      netbox_vrf:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test VRF
        state: present

    - name: Delete vrf within netbox
      netbox_vrf:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test VRF
        state: absent

    - name: Create vrf with all information
      netbox_vrf:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always
vrf	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links