netbox.netbox.netbox_tunnel_group module – Create, update or delete tunnel groups 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_tunnel_group.

New in netbox.netbox 3.20.0

Synopsis

• Creates, updates or deletes tunnel groups within NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the tunnel group configuration
custom_fields	Must exist in NetBox
description	The description of the tunnel group
name	The name of the tunnel group
slug	The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided
tags	The tags to add/update
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 Tunnel Group module"
  connection: local
  hosts: localhost
  gather_facts: false

  tasks:
    - name: Create tunnel group within NetBox with only required information
      netbox.netbox.netbox_tunnel_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Tunnel Group
        state: present

    - name: Delete tunnel group within netbox
      netbox.netbox.netbox_tunnel_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Tunnel Group
        state: absent

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
tunnel_group	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)

Authors

• Rich Bibby, NetBox Labs (@richbibby)

Collection links