Improve documentation of module (#42332)
This commit is contained in:
parent
9cd2388d1a
commit
78fd5ce651
1 changed files with 42 additions and 7 deletions
|
@ -19,12 +19,11 @@ module: meraki_config_template
|
||||||
short_description: Manage configuration templates in the Meraki cloud
|
short_description: Manage configuration templates in the Meraki cloud
|
||||||
version_added: "2.7"
|
version_added: "2.7"
|
||||||
description:
|
description:
|
||||||
- Allows for management of SNMP settings for Meraki.
|
- Allows for querying, deleting, binding, and unbinding of configuration templates.
|
||||||
notes:
|
notes:
|
||||||
- More information about the Meraki API can be found at U(https://dashboard.meraki.com/api_docs).
|
|
||||||
- Some of the options are likely only used for developers within Meraki.
|
|
||||||
- Module is not idempotent as the Meraki API is limited in what information it provides about configuration templates.
|
- 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.
|
- Meraki's API does not support creating new configuration templates.
|
||||||
|
- To use the configuration template, simply pass its ID via C(net_id) parameters in Meraki modules.
|
||||||
options:
|
options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
|
@ -66,14 +65,50 @@ EXAMPLES = r'''
|
||||||
org_name: YourOrg
|
org_name: YourOrg
|
||||||
state: query
|
state: query
|
||||||
delegate_to: localhost
|
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 = r'''
|
RETURN = r'''
|
||||||
data:
|
data:
|
||||||
description: Information about queried or updated object.
|
description: Information about queried object.
|
||||||
type: list
|
returned: success
|
||||||
returned: info
|
type: complex
|
||||||
|
contains:
|
||||||
|
id:
|
||||||
|
description: Unique identification number of organization
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
sample: L_2930418
|
||||||
|
name:
|
||||||
|
description: Name of configuration template
|
||||||
|
returned: success
|
||||||
|
type: string
|
||||||
|
sample: YourTemplate
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
Loading…
Add table
Reference in a new issue