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

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	Certificate path
data	Defines the config template configuration
description	Template description. Max length 200 characters
environment_params	Any additional parameters to pass when constructing the Jinja2 environment
name	Config template name
tags	Any tags that the device may need to be associated with
template_code	The template code to be rendered.
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

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	Serialized object as created/existent/updated/deleted within NetBox :ansible-option-returned-bold:`Returned:` always
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Antoine Dunn (@mindbreak)

Collection links