orphan: |
---|
Note
This module is part of the netbox.netbox collection (version 3.17.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 :ref:`Requirements <ansible_collections.netbox.netbox.netbox_config_template_module_requirements>` for details.
To use it in a playbook, specify: netbox.netbox.netbox_config_template
.
.. rst-class:: ansible-version-added
New in netbox.netbox 3.15.0
- Creates or removes config templates from NetBox
The below requirements are needed on the host that executes this module.
- pynetbox
.. tabularcolumns:: \X{1}{3}\X{2}{3}
Parameter | Comments |
---|---|
Certificate path |
|
Defines the config template configuration |
|
Template description. Max length 200 characters |
|
Any additional parameters to pass when constructing the Jinja2 environment |
|
Config template name |
|
Any tags that the device may need to be associated with |
|
The template code to be rendered. |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. .. rst-class:: ansible-option-line |
|
If This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`true` |
Note
- Tags should be defined as a YAML list
- 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
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. tabularcolumns:: \X{1}{3}\X{2}{3}
Key | Description |
---|---|
Serialized object as created/existent/updated/deleted within NetBox .. rst-class:: ansible-option-line |
|
Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line |
- Antoine Dunn (@mindbreak)
.. ansible-links:: - title: "Issue Tracker" url: "https://github.com/netbox-community/ansible_modules/issues" external: true - title: "Repository (Sources)" url: "https://github.com/netbox-community/ansible_modules" external: true