meraki_admin - Add documentation for tags and network access (#51415)
* Add documentation for tags and network access * Documentation changes from dag and sam * Change examples to include proper YAML and not dict * Update lib/ansible/modules/network/meraki/meraki_admin.py Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
This commit is contained in:
parent
fa82188147
commit
bcbcd209f4
2 changed files with 47 additions and 1 deletions
|
@ -43,10 +43,29 @@ options:
|
||||||
- Tags the administrator has privileges on.
|
- Tags the administrator has privileges on.
|
||||||
- When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.
|
- When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.
|
||||||
- If C(none) is specified, C(network) or C(tags) must be specified.
|
- If C(none) is specified, C(network) or C(tags) must be specified.
|
||||||
|
suboptions:
|
||||||
|
tag:
|
||||||
|
description:
|
||||||
|
- Object tag which privileges should be assigned.
|
||||||
|
type: str
|
||||||
|
access:
|
||||||
|
description:
|
||||||
|
- The privilege of the dashboard administrator for the tag.
|
||||||
|
type: str
|
||||||
networks:
|
networks:
|
||||||
description:
|
description:
|
||||||
- List of networks the administrator has privileges on.
|
- List of networks the administrator has privileges on.
|
||||||
- When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.
|
- When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.
|
||||||
|
suboptions:
|
||||||
|
id:
|
||||||
|
description:
|
||||||
|
- Network ID for which administrator should have privileges assigned.
|
||||||
|
type: str
|
||||||
|
access:
|
||||||
|
description:
|
||||||
|
- The privilege of the dashboard administrator on the network.
|
||||||
|
- Valid options are C(full), C(read-only), or C(none).
|
||||||
|
type: str
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Create or modify, or delete an organization
|
- Create or modify, or delete an organization
|
||||||
|
@ -125,6 +144,32 @@ EXAMPLES = r'''
|
||||||
org_name: YourOrg
|
org_name: YourOrg
|
||||||
state: absent
|
state: absent
|
||||||
email: jane@doe.com
|
email: jane@doe.com
|
||||||
|
|
||||||
|
- name: Create a new administrator with full access to two tags
|
||||||
|
meraki_admin:
|
||||||
|
auth_key: abc12345
|
||||||
|
org_name: YourOrg
|
||||||
|
state: present
|
||||||
|
name: Jane Doe
|
||||||
|
orgAccess: read-only
|
||||||
|
email: jane@doe.com
|
||||||
|
tags:
|
||||||
|
- tag: tenant
|
||||||
|
access: full
|
||||||
|
- tag: corporate
|
||||||
|
access: read-only
|
||||||
|
|
||||||
|
- name: Create a new administrator with full access to a network
|
||||||
|
meraki_admin:
|
||||||
|
auth_key: abc12345
|
||||||
|
org_name: YourOrg
|
||||||
|
state: present
|
||||||
|
name: Jane Doe
|
||||||
|
orgAccess: read-only
|
||||||
|
email: jane@doe.com
|
||||||
|
networks:
|
||||||
|
- id: N_12345
|
||||||
|
access: full
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = r'''
|
RETURN = r'''
|
||||||
|
|
|
@ -57,7 +57,8 @@
|
||||||
orgAccess: none
|
orgAccess: none
|
||||||
tags:
|
tags:
|
||||||
- { "tag": "production", "access": "read-only" }
|
- { "tag": "production", "access": "read-only" }
|
||||||
- { "tag": "beta", "access": "full" }
|
- tag: beta
|
||||||
|
access: full
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
register: create_tags
|
register: create_tags
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue