meraki_config_template – Manage configuration templates in the Meraki cloud
meraki_config_template – Manage configuration templates in the Meraki cloud
New in version 2.7.
Synopsis
- Allows for querying, deleting, binding, and unbinding of configuration templates.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_key - |
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. | |
auto_bind boolean |
|
Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model. |
config_template - |
Name of the configuration template within an organization to manipulate.
| |
host string |
Default: "api.meraki.com" |
Hostname for Meraki dashboard Only useful for internal Meraki developers |
net_id - |
ID of the network to bind or unbind configuration template to. | |
net_name - |
Name of the network to bind or unbind configuration template to. | |
org_id - |
ID of organization associated to a configuration template. | |
org_name - |
Name of organization containing the configuration template.
| |
output_level - |
|
Set amount of debug output during module execution |
state - |
|
Specifies whether configuration template information should be queried, modified, or deleted. |
timeout integer |
Default: 30 |
Time to timeout for HTTP requests. |
use_https boolean |
|
If Only useful for internal Meraki developers |
use_proxy boolean |
|
If |
validate_certs boolean |
|
Whether to validate HTTP certificates. |
Notes
Note
- Module is not idempotent as the Meraki API is limited in what information it provides about configuration templates.
- Meraki’s API does not support creating new configuration templates.
- To use the configuration template, simply pass its ID via
net_id
parameters in Meraki modules. - More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
- Some of the options are likely only used for developers within Meraki
Examples
- name: Query configuration templates
meraki_config_template:
auth_key: abc12345
org_name: YourOrg
state: query
delegate_to: localhost
- name: Bind a template from a network
meraki_config_template:
auth_key: abc123
state: present
org_name: YourOrg
net_name: YourNet
config_template: DevConfigTemplate
delegate_to: localhost
- name: Unbind a template from a network
meraki_config_template:
auth_key: abc123
state: absent
org_name: YourOrg
net_name: YourNet
config_template: DevConfigTemplate
delegate_to: localhost
- name: Delete a configuration template
meraki_config_template:
auth_key: abc123
state: absent
org_name: YourOrg
config_template: DevConfigTemplate
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
data complex |
success |
Information about queried object.
| |
id integer |
success |
Unique identification number of organization
Sample: L_2930418 | |
name string |
success |
Name of configuration template
Sample: YourTemplate |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Kevin Breit (@kbreit)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/meraki_config_template_module.html