1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
class ModuleDocFragment(object):
# Standard files documentation fragment
DOCUMENTATION = r'''
options:
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY
type: str
required: true
meraki_base_url:
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
default: https://api.meraki.com/api/v1
meraki_single_request_timeout:
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API call
type: int
default: 60
meraki_certificate_path:
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy
type: str
default: ''
meraki_requests_proxy:
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
default: ''
meraki_wait_on_rate_limit:
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
default: true
meraki_nginx_429_retry_wait_time:
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
default: 60
meraki_action_batch_retry_wait_time:
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time
type: int
default: 60
meraki_retry_4xx_error:
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)?
type: bool
default: false
meraki_retry_4xx_error_wait_time:
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
default: 60
meraki_maximum_retries:
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors
type: int
default: 2
meraki_output_log:
description:
- meraki_output_log (boolean), create an output log file?
type: bool
default: true
meraki_log_file_prefix:
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
default: meraki_api_
meraki_log_path:
description:
- log_path (string), path to output log; by default, working directory of script if not specified
type: str
default: ''
meraki_print_console:
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
default: true
meraki_suppress_logging:
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
default: false
meraki_simulate:
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
default: false
meraki_be_geo_id:
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID
type: str
default: ''
meraki_caller:
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
default: ''
meraki_use_iterator_for_get_pages:
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items
type: bool
default: false
meraki_inherit_logging_config:
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
default: false
notes:
- "Supports C(check_mode)"
- "The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco meraki SDK"
- "The parameters starting with meraki_ are used by the Cisco meraki Python SDK to establish the connection"
'''
|
