netbox.netbox.netbox_config_template module – Creates or removes config templates from NetBox

Note

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

You might already have this collection installed if you are using the ansible package. 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_config_template.

New in netbox.netbox 3.15.0

Synopsis

  • Creates or removes config templates 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 config template configuration

description

string

Template description. Max length 200 characters

environment_params

dictionary

Any additional parameters to pass when constructing the Jinja2 environment

name

string / required

Config template name

tags

list / elements=any

Any tags that the device may need to be associated with

template_code

string

The template code to be rendered.

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:

  • "present" ← (default)

  • "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: true

Notes

Note

  • Tags should be defined as a YAML list

Examples

- name: "Test config template creation/deletion"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create config template
      netbox.netbox.netbox_config_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "thisIsMyTemplateName"
          tags:
            - Cloud
          template_code: |
            #cloud-config
            packages:
              - ansible

    - name: Delete config template
      netbox.netbox.netbox_config_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "thisIsMyTemplateName"
        state: absent

Return Values

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

Key

Description

config_templates

dictionary

Serialized object as created/existent/updated/deleted within NetBox

Returned: always

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Antoine Dunn (@mindbreak)