netbox_l2vpn_termination_module.rst

orphan:

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.14.0).

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_l2vpn_termination_module_requirements>` for details.

To use it in a playbook, specify: netbox.netbox.netbox_l2vpn_termination.

.. rst-class:: ansible-version-added

New in netbox.netbox 3.13.0

• Synopsis
• Requirements
• Parameters
• Notes
• See Also
• Examples
• Return Values

Synopsis

• Creates, updates or removes L2VPNs terminations from NetBox

Requirements

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

• pynetbox

Parameters

.. rst-class:: ansible-option-table

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

.. seealso::

   `FHRP Group Model reference <https://docs.netbox.dev/en/stable/models/ipam/l2vpntermination/>`_
       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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table

Key	Description
.. rst-class:: ansible-option-title l2vpn_termination .. rst-class:: ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line Returned: success (when state=present)
.. rst-class:: ansible-option-title msg .. rst-class:: ansible-option-type-line string	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always

Authors

• Andrii Konts (@andrii-konts)

Collection links

Issue Tracker Repository (Sources)