netbox.netbox.netbox_vrf – Create, update or delete vrfs within NetBox¶
Note
This plugin is part of the netbox.netbox collection (version 3.5.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 netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_vrf
.
New in version 0.1.0: of netbox.netbox
Synopsis¶
Creates, updates or removes vrfs from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
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: