cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Meraki: Add types to common parameters (#49998)

Browse source
This commit is contained in:
Dag Wieers 2018-12-17 18:24:43 +01:00 committed by Alicia Cozine
parent 0eb2924380
commit 00a83035f2
1 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
lib/ansible/utils/module_docs_fragments/meraki.py
View file

@ -1,25 +1,25 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# Copyright: (c) 2018, Kevin Breit (@kbreit) <kevin.breit@kevinbreit.net> # Copyright: (c) 2018, Kevin Breit (@kbreit) <kevin.breit@kevinbreit.net>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files for documentation fragment # Standard files for documentation fragment
DOCUMENTATION = ''' DOCUMENTATION = r'''
notes: notes:
- More information about the Meraki API can be found at U(https://dashboard.meraki.com/api_docs). - 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 - Some of the options are likely only used for developers within Meraki.
options: options:
auth_key: auth_key:
description: description:
- Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. - Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
type: str
host: host:
description: description:
- Hostname for Meraki dashboard - Hostname for Meraki dashboard.
- Only useful for internal Meraki developers - Only useful for internal Meraki developers.
type: string type: str
default: 'api.meraki.com' default: 'api.meraki.com'
use_proxy: use_proxy:
description: description:
@ -28,14 +28,15 @@ options:
use_https: use_https:
description: description:
- If C(no), it will use HTTP. Otherwise it will use HTTPS. - If C(no), it will use HTTP. Otherwise it will use HTTPS.
- Only useful for internal Meraki developers - Only useful for internal Meraki developers.
type: bool type: bool
default: 'yes' default: 'yes'
output_level: output_level:
description: description:
- Set amount of debug output during module execution - Set amount of debug output during module execution
choices: ['normal', 'debug'] type: str
default: 'normal' choices: [ normal, debug ]
default: normal
timeout: timeout:
description: description:
- Time to timeout for HTTP requests. - Time to timeout for HTTP requests.
@ -49,8 +50,10 @@ options:
org_name: org_name:
description: description:
- Name of organization. - Name of organization.
type: str
aliases: [ organization ] aliases: [ organization ]
org_id: org_id:
description: description:
- ID of organization. - ID of organization.
type: str
''' '''