-
Notifications
You must be signed in to change notification settings - Fork 148
/
__init__.py
183 lines (163 loc) · 7.65 KB
/
__init__.py
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
from datetime import datetime
import logging
import os
from meraki.rest_session import *
from meraki.api.administered import Administered
from meraki.api.organizations import Organizations
from meraki.api.networks import Networks
from meraki.api.devices import Devices
from meraki.api.appliance import Appliance
from meraki.api.camera import Camera
from meraki.api.cellularGateway import CellularGateway
from meraki.api.insight import Insight
from meraki.api.sensor import Sensor
from meraki.api.sm import Sm
from meraki.api.switch import Switch
from meraki.api.wireless import Wireless
# Batch class imports
from meraki.api.batch import Batch
# Config import
from meraki.config import (
API_KEY_ENVIRONMENT_VARIABLE,
DEFAULT_BASE_URL,
SINGLE_REQUEST_TIMEOUT,
CERTIFICATE_PATH,
REQUESTS_PROXY,
WAIT_ON_RATE_LIMIT,
NGINX_429_RETRY_WAIT_TIME,
ACTION_BATCH_RETRY_WAIT_TIME,
RETRY_4XX_ERROR,
RETRY_4XX_ERROR_WAIT_TIME,
MAXIMUM_RETRIES,
OUTPUT_LOG,
LOG_PATH,
LOG_FILE_PREFIX,
PRINT_TO_CONSOLE,
SUPPRESS_LOGGING,
INHERIT_LOGGING_CONFIG,
SIMULATE_API_CALLS,
BE_GEO_ID,
MERAKI_PYTHON_SDK_CALLER,
USE_ITERATOR_FOR_GET_PAGES,
)
__version__ = '1.22.1'
class DashboardAPI(object):
"""
**Creates a persistent Meraki dashboard API session**
- api_key (string): API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY
- base_url (string): preceding all endpoint resources
- single_request_timeout (integer): maximum number of seconds for each API call
- certificate_path (string): path for TLS/SSL certificate verification if behind local proxy
- requests_proxy (string): proxy server and port, if needed, for HTTPS
- wait_on_rate_limit (boolean): retry if 429 rate limit error encountered?
- nginx_429_retry_wait_time (integer): Nginx 429 retry wait time
- action_batch_retry_wait_time (integer): action batch concurrency error retry wait time
- retry_4xx_error (boolean): retry if encountering other 4XX error (besides 429)?
- retry_4xx_error_wait_time (integer): other 4XX error retry wait time
- maximum_retries (integer): retry up to this many times when encountering 429s or other server-side errors
- output_log (boolean): create an output log file?
- log_path (string): path to output log; by default, working directory of script if not specified
- log_file_prefix (string): log file name appended with date and timestamp
- print_console (boolean): print logging output to console?
- suppress_logging (boolean): disable all logging? you're on your own then!
- inherit_logging_config (boolean): Inherits your own logger instance
- simulate (boolean): simulate POST/PUT/DELETE calls to prevent changes?
- be_geo_id (string): optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID
- caller (string): optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER
- use_iterator_for_get_pages (boolean): list* methods will return an iterator with each object instead of a complete list with all items
"""
def __init__(self,
api_key=None,
base_url=DEFAULT_BASE_URL,
single_request_timeout=SINGLE_REQUEST_TIMEOUT,
certificate_path=CERTIFICATE_PATH,
requests_proxy=REQUESTS_PROXY,
wait_on_rate_limit=WAIT_ON_RATE_LIMIT,
nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME,
retry_4xx_error=RETRY_4XX_ERROR,
retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME,
maximum_retries=MAXIMUM_RETRIES,
output_log=OUTPUT_LOG,
log_path=LOG_PATH,
log_file_prefix=LOG_FILE_PREFIX,
print_console=PRINT_TO_CONSOLE,
suppress_logging=SUPPRESS_LOGGING,
simulate=SIMULATE_API_CALLS,
be_geo_id=BE_GEO_ID,
caller=MERAKI_PYTHON_SDK_CALLER,
use_iterator_for_get_pages=USE_ITERATOR_FOR_GET_PAGES,
inherit_logging_config=INHERIT_LOGGING_CONFIG,
):
# Check API key
api_key = api_key or os.environ.get(API_KEY_ENVIRONMENT_VARIABLE)
if not api_key:
raise APIKeyError()
# Pull the BE GEO ID from an environment variable if present
be_geo_id = be_geo_id or os.environ.get('BE_GEO_ID')
# Pull the caller from an environment variable if present
caller = caller or os.environ.get('MERAKI_PYTHON_SDK_CALLER')
use_iterator_for_get_pages = use_iterator_for_get_pages
inherit_logging_config = inherit_logging_config
# Configure logging
if not suppress_logging:
self._logger = logging.getLogger(__name__)
if not inherit_logging_config:
self._logger.setLevel(logging.DEBUG)
formatter = logging.Formatter(
fmt='%(asctime)s %(name)12s: %(levelname)8s > %(message)s',
datefmt='%Y-%m-%d %H:%M:%S'
)
handler_console = logging.StreamHandler()
handler_console.setFormatter(formatter)
if output_log:
if log_path and log_path[-1] != '/':
log_path += '/'
self._log_file = f'{log_path}{log_file_prefix}_log__{datetime.now():%Y-%m-%d_%H-%M-%S}.log'
handler_log = logging.FileHandler(
filename=self._log_file
)
handler_log.setFormatter(formatter)
if output_log and not self._logger.hasHandlers():
self._logger.addHandler(handler_log)
if print_console:
handler_console.setLevel(logging.INFO)
self._logger.addHandler(handler_console)
elif print_console and not self._logger.hasHandlers():
self._logger.addHandler(handler_console)
else:
self._logger = None
# Creates the API session
self._session = RestSession(
logger=self._logger,
api_key=api_key,
base_url=base_url,
single_request_timeout=single_request_timeout,
certificate_path=certificate_path,
requests_proxy=requests_proxy,
wait_on_rate_limit=wait_on_rate_limit,
nginx_429_retry_wait_time=nginx_429_retry_wait_time,
action_batch_retry_wait_time=action_batch_retry_wait_time,
retry_4xx_error=retry_4xx_error,
retry_4xx_error_wait_time=retry_4xx_error_wait_time,
maximum_retries=maximum_retries,
simulate=simulate,
be_geo_id=be_geo_id,
caller=caller,
use_iterator_for_get_pages=use_iterator_for_get_pages,
)
# API endpoints by section
self.administered = Administered(self._session)
self.organizations = Organizations(self._session)
self.networks = Networks(self._session)
self.devices = Devices(self._session)
self.appliance = Appliance(self._session)
self.camera = Camera(self._session)
self.cellularGateway = CellularGateway(self._session)
self.insight = Insight(self._session)
self.sensor = Sensor(self._session)
self.sm = Sm(self._session)
self.switch = Switch(self._session)
self.wireless = Wireless(self._session)
# Batch definitions
self.batch = Batch()