updated w/ release 1.1.0b3

Author: Shiyue Cheng

meraki/__init__.py

@@ -20,7 +20,7 @@
     SUPPRESS_LOGGING, SIMULATE_API_CALLS, BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
 )
 
-__version__ = '1.1.0b2'
+__version__ = '1.1.0b3'
 
 class DashboardAPI(object):
     """

meraki/aio/api/appliance.py

@@ -700,6 +700,22 @@ def updateNetworkApplianceSecurityMalware(self, networkId: str, mode: str, **kwa
 
         return self._session.put(metadata, resource, payload)
 
+    def getNetworkApplianceSettings(self, networkId: str):
+        """
+        **Return the appliance settings for a network**
+        https://developer.cisco.com/meraki/api-v1/#!get-network-appliance-settings
+
+        - networkId (string): (required)
+        """
+
+        metadata = {
+            'tags': ['appliance', 'configure', 'settings'],
+            'operation': 'getNetworkApplianceSettings'
+        }
+        resource = f'/networks/{networkId}/appliance/settings'
+
+        return self._session.get(metadata, resource)
+
     def getNetworkApplianceSingleLan(self, networkId: str):
         """
         **Return single LAN configuration**

meraki/aio/api/networks.py

@@ -435,14 +435,67 @@ def removeNetworkDevices(self, networkId: str, serial: str):
 
         return self._session.post(metadata, resource, payload)
 
-    def getNetworkEvents(self, networkId: str, total_pages=1, direction='prev', **kwargs):
+    def getNetworkEnvironmentalEvents(self, networkId: str, total_pages=1, direction='next', **kwargs):
+        """
+        **List the environmental events for the network**
+        https://developer.cisco.com/meraki/api-v1/#!get-network-environmental-events
+
+        - networkId (string): (required)
+        - total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
+        - direction (string): direction to paginate, either "next" (default) or "prev" page
+        - includedEventTypes (array): A list of event types. The returned events will be filtered to only include events with these types.
+        - excludedEventTypes (array): A list of event types. The returned events will be filtered to exclude events with these types.
+        - sensorSerial (string): The serial of the sensor device which the list of events will be filtered with
+        - gatewaySerial (string): The serial of the environmental gateway device which the list of events will be filtered with
+        - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10.
+        - startingAfter (string): A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
+        - endingBefore (string): A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
+        """
+
+        kwargs.update(locals())
+
+        metadata = {
+            'tags': ['networks', 'monitor', 'environmental', 'events'],
+            'operation': 'getNetworkEnvironmentalEvents'
+        }
+        resource = f'/networks/{networkId}/environmental/events'
+
+        query_params = ['includedEventTypes', 'excludedEventTypes', 'sensorSerial', 'gatewaySerial', 'perPage', 'startingAfter', 'endingBefore', ]
+        params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}
+
+        array_params = ['includedEventTypes', 'excludedEventTypes', ]
+        for k, v in kwargs.items():
+            if k.strip() in array_params:
+                params[f'{k.strip()}[]'] = kwargs[f'{k}']
+                params.pop(k.strip())
+
+        return self._session.get_pages(metadata, resource, params, total_pages, direction)
+
+    def getNetworkEnvironmentalEventsEventTypes(self, networkId: str):
+        """
+        **List the event type to human-readable description**
+        https://developer.cisco.com/meraki/api-v1/#!get-network-environmental-events-event-types
+
+        - networkId (string): (required)
+        """
+
+        metadata = {
+            'tags': ['networks', 'configure', 'environmental', 'events', 'eventTypes'],
+            'operation': 'getNetworkEnvironmentalEventsEventTypes'
+        }
+        resource = f'/networks/{networkId}/environmental/events/eventTypes'
+
+        return self._session.get(metadata, resource)
+
+    def getNetworkEvents(self, networkId: str, total_pages=1, direction='prev', event_log_end_time=None, **kwargs):
         """
         **List the events for the network**
         https://developer.cisco.com/meraki/api-v1/#!get-network-events
 
         - networkId (string): (required)
         - total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
         - direction (string): direction to paginate, either "next" or "prev" (default) page
+        - event_log_end_time (string): ISO8601 Zulu/UTC time, to use in conjunction with startingAfter, to retrieve events within a time window
         - productType (string): The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
         - includedEventTypes (array): A list of event types. The returned events will be filtered to only include events with these types.
         - excludedEventTypes (array): A list of event types. The returned events will be filtered to exclude events with these types.
@@ -476,7 +529,7 @@ def getNetworkEvents(self, networkId: str, total_pages=1, direction='prev', **kw
                 params[f'{k.strip()}[]'] = kwargs[f'{k}']
                 params.pop(k.strip())
 
-        return self._session.get_pages(metadata, resource, params, total_pages, direction)
+        return self._session.get_pages(metadata, resource, params, total_pages, direction, event_log_end_time)
 
     def getNetworkEventsEventTypes(self, networkId: str):
         """
@@ -764,7 +817,7 @@ def deleteNetworkGroupPolicy(self, networkId: str, groupPolicyId: str):
 
     def getNetworkMerakiAuthUsers(self, networkId: str):
         """
-        **List the splash or RADIUS users configured under Meraki Authentication for a network**
+        **List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)**
         https://developer.cisco.com/meraki/api-v1/#!get-network-meraki-auth-users
 
         - networkId (string): (required)
@@ -780,22 +833,22 @@ def getNetworkMerakiAuthUsers(self, networkId: str):
 
     def createNetworkMerakiAuthUser(self, networkId: str, email: str, name: str, password: str, authorizations: list, **kwargs):
         """
-        **Create a user configured with Meraki Authentication for a network (currently supports 802.1X and Splash Guest users, and currently, organizations have a 50,000 user cap)**
+        **Create a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)**
         https://developer.cisco.com/meraki/api-v1/#!create-network-meraki-auth-user
 
         - networkId (string): (required)
         - email (string): Email address of the user
         - name (string): Name of the user
         - password (string): The password for this user account
         - authorizations (array): Authorization zones and expiration dates for the user.
-        - accountType (string): Authorization type for user. Can be either 'Guest' or '802.1X'. Defaults to '802.1X'.
+        - accountType (string): Authorization type for user. Can be 'Guest' or '802.1X' for wireless networks, or 'Client VPN' for wired networks. Defaults to '802.1X'.
         - emailPasswordToUser (boolean): Whether or not Meraki should email the password to user. Default is false.
         """
 
         kwargs.update(locals())
 
         if 'accountType' in kwargs:
-            options = ['Guest', '802.1X']
+            options = ['Guest', '802.1X', 'Client VPN']
             assert kwargs['accountType'] in options, f'''"accountType" cannot be "{kwargs['accountType']}", & must be set to one of: {options}'''
 
         metadata = {
@@ -811,7 +864,7 @@ def createNetworkMerakiAuthUser(self, networkId: str, email: str, name: str, pas
 
     def getNetworkMerakiAuthUser(self, networkId: str, merakiAuthUserId: str):
         """
-        **Return the Meraki Auth splash or RADIUS user**
+        **Return the Meraki Auth splash guest, RADIUS, or client VPN user**
         https://developer.cisco.com/meraki/api-v1/#!get-network-meraki-auth-user
 
         - networkId (string): (required)
@@ -828,7 +881,7 @@ def getNetworkMerakiAuthUser(self, networkId: str, merakiAuthUserId: str):
 
     def deleteNetworkMerakiAuthUser(self, networkId: str, merakiAuthUserId: str):
         """
-        **Delete a user configured with Meraki Authentication (currently, 802.1X RADIUS and Splash Guest users can be deleted)**
+        **Delete a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be deleted)**
         https://developer.cisco.com/meraki/api-v1/#!delete-network-meraki-auth-user
 
         - networkId (string): (required)
@@ -845,7 +898,7 @@ def deleteNetworkMerakiAuthUser(self, networkId: str, merakiAuthUserId: str):
 
     def updateNetworkMerakiAuthUser(self, networkId: str, merakiAuthUserId: str, **kwargs):
         """
-        **Update a user configured with Meraki Authentication (currently, 802.1X RADIUS and Splash Guest users can be updated)**
+        **Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be deleted)**
         https://developer.cisco.com/meraki/api-v1/#!update-network-meraki-auth-user
 
         - networkId (string): (required)

meraki/aio/rest_session.py

@@ -275,32 +275,48 @@ async def get(self, metadata, url, params=None):
         return await response.json()
 
     async def get_pages(
-        self, metadata, url, params=None, total_pages=-1, direction="next"
+        self, metadata, url, params=None, total_pages=-1, direction="next", event_log_end_time=None
     ):
         if type(total_pages) == str and total_pages.lower() == "all":
             total_pages = -1
+        elif type(total_pages) == str and total_pages.isnumeric():
+            total_pages = int(total_pages)
         metadata["page"] = 1
 
         response = await self.request(metadata, "GET", url, params=params)
         results = await response.json()
 
+        # For event log endpoint when using 'next' direction, so results/events are sorted chronologically
+        if type(results) == dict and metadata["operation"] == "getNetworkEvents" and direction == "next":
+            results["events"] = results["events"][::-1]
+
         # Get additional pages if more than one requested
         while total_pages != 1:
             links = response.links
 
             # GET the subsequent page
             if direction == "next" and "next" in links:
-                # Prevent getNetworkEvents from infinite loop when requesting events after specified endingBefore time
+                # Prevent getNetworkEvents from infinite loop as time goes forward
                 if metadata["operation"] == "getNetworkEvents":
                     starting_after = urllib.parse.unquote(links["next"]["url"].split("startingAfter=")[1])
                     delta = datetime.utcnow() - datetime.fromisoformat(starting_after[:-1])
                     # Break out of loop if startingAfter returned from next link is within 5 minutes of current time
                     if delta.total_seconds() < 300:
                         break
+                    # Or if next page is past the specified window's end time
+                    elif event_log_end_time and starting_after > event_log_end_time:
+                        break
 
                 metadata["page"] += 1
                 response = await self.request(metadata, "GET", links["next"]["url"])
             elif direction == "prev" and "prev" in links:
+                # Prevent getNetworkEvents from infinite loop as time goes backward (to epoch 0)
+                if metadata["operation"] == "getNetworkEvents":
+                    ending_before = urllib.parse.unquote(links["prev"]["url"].split("endingBefore=")[1])
+                    # Break out of loop if endingBefore returned from prev link is before 2014
+                    if ending_before < "2014-01-01":
+                        break
+                
                 metadata["page"] += 1
                 response = await self.request(metadata, "GET", links["prev"]["url"])
             else:
@@ -315,6 +331,8 @@ async def get_pages(
                 start = json_response["pageStartAt"]
                 end = json_response["pageEndAt"]
                 events = json_response["events"]
+                if direction == "next":
+                    events = events[::-1]
                 if start < results["pageStartAt"]:
                     results["pageStartAt"] = start
                 if end > results["pageEndAt"]:

meraki/api/appliance.py

@@ -700,6 +700,22 @@ def updateNetworkApplianceSecurityMalware(self, networkId: str, mode: str, **kwa
 
         return self._session.put(metadata, resource, payload)
 
+    def getNetworkApplianceSettings(self, networkId: str):
+        """
+        **Return the appliance settings for a network**
+        https://developer.cisco.com/meraki/api-v1/#!get-network-appliance-settings
+
+        - networkId (string): (required)
+        """
+
+        metadata = {
+            'tags': ['appliance', 'configure', 'settings'],
+            'operation': 'getNetworkApplianceSettings'
+        }
+        resource = f'/networks/{networkId}/appliance/settings'
+
+        return self._session.get(metadata, resource)
+
     def getNetworkApplianceSingleLan(self, networkId: str):
         """
         **Return single LAN configuration**