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

Note

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

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

New in netbox.netbox 3.13.0

Synopsis

• Creates, updates or removes L2VPNs terminations from NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert any	Certificate path
data dictionary / required	Defines the L2VPN termination configuration
assigned_object_id integer / required	Assigned object id
assigned_object_type string / required	Assigned object type Choices: :ansible-option-choices-entry:`"dcim.interface"` :ansible-option-choices-entry:`"ipam.vlan"` :ansible-option-choices-entry:`"virtualization.vminterface"`
custom_fields dictionary	Must exist in NetBox
l2vpn integer / required	L2vpn object id
tags list / elements=any	Any tags that the L2VPN termination may need to be associated with
netbox_token string / required	The NetBox API token.
netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params list / elements=string	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 string	The state of the object. Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. 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

See Also

See also

FHRP Group Model reference

NetBox Documentation for FHRP Group Model.

Examples

- hosts: localhost
  connection: local
  module_defaults:
    group/netbox.netbox.netbox:
      netbox_url: "http://netbox.local"
      netbox_token: "thisIsMyToken"
  tasks:
    - name: Create L2VPN termination within NetBox with only required information
      netbox.netbox.netbox_l2vpn_termination:
        data:
          l2vpn: 1
          assigned_object_type: dcim.interface
          assigned_object_id: 32
        state: present

    - name: Delete L2VPN termination within netbox
      netbox.netbox.netbox_l2vpn_termination:
        data:
          l2vpn: 1
          assigned_object_type: dcim.interface
          assigned_object_id: 32
        state: absent

Return Values

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

Key	Description
l2vpn_termination dictionary	Serialized object as created or already existent within NetBox Returned: success (when state=present)
msg string	Message indicating failure or info about what has been achieved Returned: always

Authors

• Andrii Konts (@andrii-konts)

Collection links

Issue Tracker Repository (Sources)