April 2010 version 0.10 release

Author: Shiyue Cheng

meraki/__init__.py

@@ -82,10 +82,11 @@
 from .api.wireless_settings import WirelessSettings
 from .config import (
     API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, 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, SIMULATE_API_CALLS
 )
 
-__version__ = '0.90.1'
+__version__ = '0.100.0'
 
 class DashboardAPI(object):
     """
@@ -96,6 +97,10 @@ class DashboardAPI(object):
     - 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
     - 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
@@ -106,6 +111,9 @@ class DashboardAPI(object):
 
     def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeout=SINGLE_REQUEST_TIMEOUT,
                  certificate_path=CERTIFICATE_PATH, 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, simulate=SIMULATE_API_CALLS):
         # Check API key
@@ -144,6 +152,10 @@ def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeo
             single_request_timeout=single_request_timeout,
             certificate_path=certificate_path,
             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,
         )

meraki/api/alert_settings.py

@@ -25,7 +25,7 @@ def updateNetworkAlertSettings(self, networkId: str, **kwargs):
         https://api.meraki.com/api_docs#update-the-alert-configuration-for-this-network
         
         - networkId (string)
-        - defaultDestinations (object): The network_wide destinations for all alerts on the network.
+        - defaultDestinations (object): The network-wide destinations for all alerts on the network.
         - alerts (array): Alert-specific configuration for each type. Only alerts that pertain to the network can be updated.
         """
 

meraki/api/cameras.py

@@ -31,6 +31,7 @@ def updateDeviceCameraQualityAndRetentionSettings(self, serial: str, **kwargs):
         - restrictedBandwidthModeEnabled (boolean): Boolean indicating if restricted bandwidth is enabled(true) or disabled(false) on the camera
         - quality (string): Quality of the camera. Can be one of 'Standard', 'High' or 'Enhanced'. Not all qualities are supported by every camera model.
         - resolution (string): Resolution of the camera. Can be one of '1280x720', '1920x1080', '1080x1080' or '2058x2058'. Not all resolutions are supported by every camera model.
+        - motionDetectorVersion (integer): The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.
         """
 
         kwargs.update(locals())
@@ -41,14 +42,17 @@ def updateDeviceCameraQualityAndRetentionSettings(self, serial: str, **kwargs):
         if 'resolution' in kwargs:
             options = ['1280x720', '1920x1080', '1080x1080', '2058x2058']
             assert kwargs['resolution'] in options, f'''"resolution" cannot be "{kwargs['resolution']}", & must be set to one of: {options}'''
+        if 'motionDetectorVersion' in kwargs:
+            options = [1, 2]
+            assert kwargs['motionDetectorVersion'] in options, f'''"motionDetectorVersion" cannot be "{kwargs['motionDetectorVersion']}", & must be set to one of: {options}'''
 
         metadata = {
             'tags': ['Cameras'],
             'operation': 'updateDeviceCameraQualityAndRetentionSettings',
         }
         resource = f'/devices/{serial}/camera/qualityAndRetentionSettings'
 
-        body_params = ['profileId', 'motionBasedRetentionEnabled', 'audioRecordingEnabled', 'restrictedBandwidthModeEnabled', 'quality', 'resolution']
+        body_params = ['profileId', 'motionBasedRetentionEnabled', 'audioRecordingEnabled', 'restrictedBandwidthModeEnabled', 'quality', 'resolution', 'motionDetectorVersion']
         payload = {k: v for (k, v) in kwargs.items() if k in body_params}
 
         return self._session.put(metadata, resource, payload)

meraki/api/networks.py

@@ -194,13 +194,17 @@ def getNetworkTraffic(self, networkId: str, **kwargs):
         - networkId (string)
         - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 30 days from today.
         - timespan (number): The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days.
-        - deviceType (string):     Filter the data by device type: combined (default), wireless, switch, appliance.
-    When using combined, for each rule the data will come from the device type with the most usage.
+        - deviceType (string):     Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'.
+    When using 'combined', for each rule the data will come from the device type with the most usage.
 
         """
 
         kwargs.update(locals())
 
+        if 'deviceType' in kwargs:
+            options = ['combined', 'wireless', 'switch', 'appliance']
+            assert kwargs['deviceType'] in options, f'''"deviceType" cannot be "{kwargs['deviceType']}", & must be set to one of: {options}'''
+
         metadata = {
             'tags': ['Networks'],
             'operation': 'getNetworkTraffic',

meraki/api/organizations.py

@@ -93,7 +93,7 @@ def deleteOrganization(self, organizationId: str):
 
         return self._session.delete(metadata, resource)
 
-    def claimOrganization(self, organizationId: str, **kwargs):
+    def claimIntoOrganization(self, organizationId: str, **kwargs):
         """
         **Claim a list of devices, licenses, and/or orders into an organization. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory.**
         https://api.meraki.com/api_docs#claim-a-list-of-devices-licenses-and/or-orders-into-an-organization
@@ -108,7 +108,7 @@ def claimOrganization(self, organizationId: str, **kwargs):
 
         metadata = {
             'tags': ['Organizations'],
-            'operation': 'claimOrganization',
+            'operation': 'claimIntoOrganization',
         }
         resource = f'/organizations/{organizationId}/claim'
 

meraki/api/ssids.py

@@ -62,18 +62,18 @@ def updateNetworkSsid(self, networkId: str, number: str, **kwargs):
         - number (string)
         - name (string): The name of the SSID
         - enabled (boolean): Whether or not the SSID is enabled
-        - authMode (string): The association control method for the SSID ('open', 'psk', 'open-with-radius', '8021x-meraki' or '8021x-radius')
+        - authMode (string): The association control method for the SSID ('open', 'psk', 'open-with-radius', '8021x-meraki', '8021x-radius', 'ipsk-with-radius' or 'ipsk-without-radius')
         - enterpriseAdminAccess (string): Whether or not an SSID is accessible by 'enterprise' administrators ('access disabled' or 'access enabled')
         - encryptionMode (string): The psk encryption mode for the SSID ('wep' or 'wpa'). This param is only valid if the authMode is 'psk'
         - psk (string): The passkey for the SSID. This param is only valid if the authMode is 'psk'
         - wpaEncryptionMode (string): The types of WPA encryption. ('WPA1 only', 'WPA1 and WPA2', 'WPA2 only', 'WPA3 Transition Mode' or 'WPA3 only')
         - splashPage (string): The type of splash page for the SSID ('None', 'Click-through splash page', 'Billing', 'Password-protected with Meraki RADIUS', 'Password-protected with custom RADIUS', 'Password-protected with Active Directory', 'Password-protected with LDAP', 'SMS authentication', 'Systems Manager Sentry', 'Facebook Wi-Fi', 'Google OAuth' or 'Sponsored guest'). This attribute is not supported for template children.
-        - radiusServers (array): The RADIUS 802.1x servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius' or '8021x-radius'
+        - radiusServers (array): The RADIUS 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'
         - radiusCoaEnabled (boolean): If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server.
         - radiusFailoverPolicy (string): This policy determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable ('Deny access' or 'Allow access')
         - radiusLoadBalancingPolicy (string): This policy determines which RADIUS server will be contacted first in an authentication attempt and the ordering of any necessary retry attempts ('Strict priority order' or 'Round robin')
-        - radiusAccountingEnabled (boolean): Whether or not RADIUS accounting is enabled. This param is only valid if the authMode is 'open-with-radius' or '8021x-radius'
-        - radiusAccountingServers (array): The RADIUS accounting 802.1x servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius' or '8021x-radius' and radiusAccountingEnabled is 'true'
+        - radiusAccountingEnabled (boolean): Whether or not RADIUS accounting is enabled. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'
+        - radiusAccountingServers (array): The RADIUS accounting 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius' and radiusAccountingEnabled is 'true'
         - radiusAttributeForGroupPolicies (string): Specify the RADIUS attribute used to look up group policies ('Filter-Id', 'Reply-Message', 'Airespace-ACL-Name' or 'Aruba-User-Role'). Access points must receive this attribute in the RADIUS Access-Accept message
         - ipAssignmentMode (string): The client IP assignment mode ('NAT mode', 'Bridge mode', 'Layer 3 roaming', 'Layer 3 roaming with a concentrator' or 'VPN')
         - useVlanTagging (boolean): Whether or not traffic should be directed to use specific VLANs. This param is only valid if the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'
@@ -94,7 +94,7 @@ def updateNetworkSsid(self, networkId: str, number: str, **kwargs):
         kwargs.update(locals())
 
         if 'authMode' in kwargs:
-            options = ['open', 'psk', 'open-with-radius', '8021x-meraki', '8021x-radius']
+            options = ['open', 'psk', 'open-with-radius', '8021x-meraki', '8021x-radius', 'ipsk-with-radius', 'ipsk-without-radius']
             assert kwargs['authMode'] in options, f'''"authMode" cannot be "{kwargs['authMode']}", & must be set to one of: {options}'''
         if 'enterpriseAdminAccess' in kwargs:
             options = ['access disabled', 'access enabled']

meraki/api/vlans.py

@@ -19,7 +19,7 @@ def getNetworkVlans(self, networkId: str):
 
         return self._session.get(metadata, resource)
 
-    def createNetworkVlan(self, networkId: str, id: str, name: str, subnet: str, applianceIp: str):
+    def createNetworkVlan(self, networkId: str, id: str, name: str, subnet: str, applianceIp: str, **kwargs):
         """
         **Add a VLAN**
         https://api.meraki.com/api_docs#add-a-vlan
@@ -29,17 +29,18 @@ def createNetworkVlan(self, networkId: str, id: str, name: str, subnet: str, app
         - name (string): The name of the new VLAN
         - subnet (string): The subnet of the VLAN
         - applianceIp (string): The local IP of the appliance on the VLAN
+        - groupPolicyId (string): The id of the desired group policy to apply to the VLAN
         """
 
-        kwargs = locals()
+        kwargs.update(locals())
 
         metadata = {
             'tags': ['VLANs'],
             'operation': 'createNetworkVlan',
         }
         resource = f'/networks/{networkId}/vlans'
 
-        body_params = ['id', 'name', 'subnet', 'applianceIp']
+        body_params = ['id', 'name', 'subnet', 'applianceIp', 'groupPolicyId']
         payload = {k: v for (k, v) in kwargs.items() if k in body_params}
 
         return self._session.post(metadata, resource, payload)
@@ -71,6 +72,7 @@ def updateNetworkVlan(self, networkId: str, vlanId: str, **kwargs):
         - name (string): The name of the VLAN
         - subnet (string): The subnet of the VLAN
         - applianceIp (string): The local IP of the appliance on the VLAN
+        - groupPolicyId (string): The id of the desired group policy to apply to the VLAN
         - vpnNatSubnet (string): The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN
         - dhcpHandling (string): The appliance's handling of DHCP requests on this VLAN. One of: 'Run a DHCP server', 'Relay DHCP to another server' or 'Do not respond to DHCP requests'
         - dhcpRelayServerIps (array): The IPs of the DHCP servers that DHCP requests should be relayed to
@@ -99,7 +101,7 @@ def updateNetworkVlan(self, networkId: str, vlanId: str, **kwargs):
         }
         resource = f'/networks/{networkId}/vlans/{vlanId}'
 
-        body_params = ['name', 'subnet', 'applianceIp', 'vpnNatSubnet', 'dhcpHandling', 'dhcpRelayServerIps', 'dhcpLeaseTime', 'dhcpBootOptionsEnabled', 'dhcpBootNextServer', 'dhcpBootFilename', 'fixedIpAssignments', 'reservedIpRanges', 'dnsNameservers', 'dhcpOptions']
+        body_params = ['name', 'subnet', 'applianceIp', 'groupPolicyId', 'vpnNatSubnet', 'dhcpHandling', 'dhcpRelayServerIps', 'dhcpLeaseTime', 'dhcpBootOptionsEnabled', 'dhcpBootNextServer', 'dhcpBootFilename', 'fixedIpAssignments', 'reservedIpRanges', 'dnsNameservers', 'dhcpOptions']
         payload = {k: v for (k, v) in kwargs.items() if k in body_params}
 
         return self._session.put(metadata, resource, payload)