New in version 2.7.
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_key | Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. | |
auto_bind bool |
| 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. aliases: name | |
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. aliases: organization | |
output_level |
| Set amount of debug output during module execution |
state |
| Specifies whether configuration template information should be queried, modified, or deleted. |
timeout int | Default: 30 | Time to timeout for HTTP requests. |
use_https bool |
| If no , it will use HTTP. Otherwise it will use HTTPS.Only useful for internal Meraki developers |
use_proxy bool |
| If no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
validate_certs bool |
| Whether to validate HTTP certificates. |
Note
net_id
parameters in Meraki modules.- 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
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 int | success | Unique identification number of organization Sample: L_2930418 | |
name string | success | Name of configuration template Sample: YourTemplate |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 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