netbox.netbox.netbox_l2vpn module – Create, update or delete L2VPNs within NetBox

Note

This module is part of the netbox.netbox collection (version 3.20.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_l2vpn.

New in netbox.netbox 3.9.0

Synopsis

• Creates, updates or removes L2VPNs 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 L2VPN configuration
comments :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	Comments that may include additional information in regards to the L2VPN
custom_fields	Must exist in NetBox
description	The description of the L2VPN
export_targets	Route targets to export
identifier	The identifier of the L2VPN
import_targets	Route targets to import
name	The name of the L2VPN
tags	Any tags that the L2VPN may need to be associated with
tenant	The tenant that the L2VPN will be assigned to
type	The type of L2VPN
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 L2VPN within NetBox with only required information
      netbox.netbox.netbox_l2vpn:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test L2VPN
          type: vxlan
        state: present

    - name: Delete L2VPN within netbox
      netbox.netbox.netbox_l2vpn:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test L2VPN
          type: vxlan
        state: absent

    - name: Create L2VPN with all required information
      netbox.netbox.netbox_l2vpn:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test L2VPN
          type: vpls
          identifier: 43256
          import_targets:
            - "65000:1"
          export_targets:
            - "65000:2"
          tenant: Test Tenant
          description: Just a test
          tags:
            - Schnozzberry
        state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
l2vpn	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Martin Rødvand (@rodvand)

Collection links