netbox.netbox.netbox_tunnel module – Create, update or delete tunnels 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.

New in netbox.netbox 3.20.0

Synopsis

• Creates, updates or removes tunnels 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 tunnel configuration
comments	Comments that may include additional information in regards to the tunnel
custom_fields	Must exist in NetBox
description	The description of the tunnel
encapsulation	The encapsulation protocol or technique employed to effect the tunnel :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"ipsec-transport"` :ansible-option-choices-entry:`"ipsec-tunnel"` :ansible-option-choices-entry:`"ip-ip"` :ansible-option-choices-entry:`"gre"`
ipsec_profile	The IPSec Profile employed to negotiate security associations
name	The name of the tunnel
status	Status of the tunnel
tags	Any tags that the tunnel may need to be associated with
tenant	The tenant that the tunnel will be associated with
tunnel_group	The Tunnel group the VLAN will be associated with. Must exist in NetBox
tunnel_id	The ID of the tunnel
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 tunnel within NetBox with only required information
      netbox.netbox.netbox_tunnel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Tunnel
          encapsulation: ipsec-tunnel
        state: present

    - name: Delete tunnel within NetBox
      netbox.netbox.netbox_tunnel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Tunnel
          encapsulation: ipsec-tunnel
        state: absent

    - name: Create tunnel with all information
      netbox.netbox.netbox_tunnel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Tunnel
          status: planned
          tunnel_group: Test Tunnel Group
          encapsulation: ipsec-tunnel
          ipsec_profile: ipsec-profile
          description: Test Description
          tenant: Test Tenant
          tunnel_id: 200
          tags:
            - Schnozzberry
        state: present

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