Dashboard API release 1.30.0

Author: TKIPisalegacycipher

meraki/__init__.py

@@ -44,7 +44,7 @@
     USE_ITERATOR_FOR_GET_PAGES,
 )
 
-__version__ = '1.27.1'
+__version__ = '1.30.0'
 
 
 class DashboardAPI(object):

meraki/aio/api/appliance.py

@@ -264,7 +264,7 @@ def updateNetworkApplianceContentFiltering(self, networkId: str, **kwargs):
         kwargs.update(locals())
 
         if 'urlCategoryListSize' in kwargs:
-            options = ['topSites', 'fullList']
+            options = ['fullList', 'topSites']
             assert kwargs['urlCategoryListSize'] in options, f'''"urlCategoryListSize" cannot be "{kwargs['urlCategoryListSize']}", & must be set to one of: {options}'''
 
         metadata = {
@@ -1048,10 +1048,10 @@ def updateNetworkApplianceSecurityIntrusion(self, networkId: str, **kwargs):
         kwargs.update(locals())
 
         if 'mode' in kwargs:
-            options = ['prevention', 'detection', 'disabled']
+            options = ['detection', 'disabled', 'prevention']
             assert kwargs['mode'] in options, f'''"mode" cannot be "{kwargs['mode']}", & must be set to one of: {options}'''
         if 'idsRulesets' in kwargs:
-            options = ['connectivity', 'balanced', 'security']
+            options = ['balanced', 'connectivity', 'security']
             assert kwargs['idsRulesets'] in options, f'''"idsRulesets" cannot be "{kwargs['idsRulesets']}", & must be set to one of: {options}'''
 
         metadata = {
@@ -1101,7 +1101,7 @@ def updateNetworkApplianceSecurityMalware(self, networkId: str, mode: str, **kwa
         kwargs.update(locals())
 
         if 'mode' in kwargs:
-            options = ['enabled', 'disabled']
+            options = ['disabled', 'enabled']
             assert kwargs['mode'] in options, f'''"mode" cannot be "{kwargs['mode']}", & must be set to one of: {options}'''
 
         metadata = {
@@ -1154,7 +1154,7 @@ def updateNetworkApplianceSettings(self, networkId: str, **kwargs):
             options = ['IP address', 'MAC address', 'Unique client identifier']
             assert kwargs['clientTrackingMethod'] in options, f'''"clientTrackingMethod" cannot be "{kwargs['clientTrackingMethod']}", & must be set to one of: {options}'''
         if 'deploymentMode' in kwargs:
-            options = ['routed', 'passthrough']
+            options = ['passthrough', 'routed']
             assert kwargs['deploymentMode'] in options, f'''"deploymentMode" cannot be "{kwargs['deploymentMode']}", & must be set to one of: {options}'''
 
         metadata = {
@@ -1199,6 +1199,7 @@ def updateNetworkApplianceSingleLan(self, networkId: str, **kwargs):
         - subnet (string): The subnet of the single LAN configuration
         - applianceIp (string): The appliance IP address of the single LAN
         - ipv6 (object): IPv6 configuration on the VLAN
+        - mandatoryDhcp (object): Mandatory DHCP will enforce that clients connecting to this LAN must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. Only available on firmware versions 17.0 and above
         """
 
         kwargs.update(locals())
@@ -1210,7 +1211,7 @@ def updateNetworkApplianceSingleLan(self, networkId: str, **kwargs):
         networkId = urllib.parse.quote(str(networkId), safe='')
         resource = f'/networks/{networkId}/appliance/singleLan'
 
-        body_params = ['subnet', 'applianceIp', 'ipv6', ]
+        body_params = ['subnet', 'applianceIp', 'ipv6', 'mandatoryDhcp', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)
@@ -1273,12 +1274,13 @@ def updateNetworkApplianceSsid(self, networkId: str, number: str, **kwargs):
         - encryptionMode (string): The psk encryption mode for the SSID ('wep' or 'wpa'). This param is only valid if the authMode is 'psk'.
         - wpaEncryptionMode (string): The types of WPA encryption. ('WPA1 and WPA2', 'WPA2 only', 'WPA3 Transition Mode' or 'WPA3 only'). This param is only valid if (1) the authMode is 'psk' & the encryptionMode is 'wpa' OR (2) the authMode is '8021x-meraki' OR (3) the authMode is '8021x-radius'
         - visible (boolean): Boolean indicating whether the MX should advertise or hide this SSID.
+        - dhcpEnforcedDeauthentication (object): DHCP Enforced Deauthentication enables the disassociation of wireless clients in addition to Mandatory DHCP. This param is only valid on firmware versions >= MX 17.0 where the associated LAN has Mandatory DHCP Enabled 
         """
 
         kwargs.update(locals())
 
         if 'authMode' in kwargs:
-            options = ['open', 'psk', '8021x-meraki', '8021x-radius']
+            options = ['8021x-meraki', '8021x-radius', 'open', 'psk']
             assert kwargs['authMode'] in options, f'''"authMode" cannot be "{kwargs['authMode']}", & must be set to one of: {options}'''
         if 'encryptionMode' in kwargs:
             options = ['wep', 'wpa']
@@ -1295,7 +1297,7 @@ def updateNetworkApplianceSsid(self, networkId: str, number: str, **kwargs):
         number = urllib.parse.quote(str(number), safe='')
         resource = f'/networks/{networkId}/appliance/ssids/{number}'
 
-        body_params = ['name', 'enabled', 'defaultVlanId', 'authMode', 'psk', 'radiusServers', 'encryptionMode', 'wpaEncryptionMode', 'visible', ]
+        body_params = ['name', 'enabled', 'defaultVlanId', 'authMode', 'psk', 'radiusServers', 'encryptionMode', 'wpaEncryptionMode', 'visible', 'dhcpEnforcedDeauthentication', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)
@@ -1707,6 +1709,7 @@ def updateNetworkApplianceTrafficShapingUplinkSelection(self, networkId: str, **
         - activeActiveAutoVpnEnabled (boolean): Toggle for enabling or disabling active-active AutoVPN
         - defaultUplink (string): The default uplink. Must be one of: 'wan1' or 'wan2'
         - loadBalancingEnabled (boolean): Toggle for enabling or disabling load balancing
+        - failoverAndFailback (object): WAN failover and failback behavior
         - wanTrafficUplinkPreferences (array): Array of uplink preference rules for WAN traffic
         - vpnTrafficUplinkPreferences (array): Array of uplink preference rules for VPN traffic
         """
@@ -1724,7 +1727,7 @@ def updateNetworkApplianceTrafficShapingUplinkSelection(self, networkId: str, **
         networkId = urllib.parse.quote(str(networkId), safe='')
         resource = f'/networks/{networkId}/appliance/trafficShaping/uplinkSelection'
 
-        body_params = ['activeActiveAutoVpnEnabled', 'defaultUplink', 'loadBalancingEnabled', 'wanTrafficUplinkPreferences', 'vpnTrafficUplinkPreferences', ]
+        body_params = ['activeActiveAutoVpnEnabled', 'defaultUplink', 'loadBalancingEnabled', 'failoverAndFailback', 'wanTrafficUplinkPreferences', 'vpnTrafficUplinkPreferences', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)
@@ -1793,6 +1796,7 @@ def createNetworkApplianceVlan(self, networkId: str, id: str, name: str, **kwarg
         - cidr (string): CIDR of the pool of subnets. Applicable only for template network. Each network bound to the template will automatically pick a subnet from this pool to build its own VLAN.
         - mask (integer): Mask used for the subnet of all bound to the template networks. Applicable only for template network.
         - ipv6 (object): IPv6 configuration on the VLAN
+        - mandatoryDhcp (object): Mandatory DHCP will enforce that clients connecting to this VLAN must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. Only available on firmware versions 17.0 and above
         """
 
         kwargs.update(locals())
@@ -1808,7 +1812,7 @@ def createNetworkApplianceVlan(self, networkId: str, id: str, name: str, **kwarg
         networkId = urllib.parse.quote(str(networkId), safe='')
         resource = f'/networks/{networkId}/appliance/vlans'
 
-        body_params = ['id', 'name', 'subnet', 'applianceIp', 'groupPolicyId', 'templateVlanType', 'cidr', 'mask', 'ipv6', ]
+        body_params = ['id', 'name', 'subnet', 'applianceIp', 'groupPolicyId', 'templateVlanType', 'cidr', 'mask', 'ipv6', 'mandatoryDhcp', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.post(metadata, resource, payload)
@@ -1906,15 +1910,16 @@ def updateNetworkApplianceVlan(self, networkId: str, vlanId: str, **kwargs):
         - cidr (string): CIDR of the pool of subnets. Applicable only for template network. Each network bound to the template will automatically pick a subnet from this pool to build its own VLAN.
         - mask (integer): Mask used for the subnet of all bound to the template networks. Applicable only for template network.
         - ipv6 (object): IPv6 configuration on the VLAN
+        - mandatoryDhcp (object): Mandatory DHCP will enforce that clients connecting to this VLAN must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. Only available on firmware versions 17.0 and above
         """
 
         kwargs.update(locals())
 
         if 'dhcpHandling' in kwargs:
-            options = ['Run a DHCP server', 'Relay DHCP to another server', 'Do not respond to DHCP requests']
+            options = ['Do not respond to DHCP requests', 'Relay DHCP to another server', 'Run a DHCP server']
             assert kwargs['dhcpHandling'] in options, f'''"dhcpHandling" cannot be "{kwargs['dhcpHandling']}", & must be set to one of: {options}'''
         if 'dhcpLeaseTime' in kwargs:
-            options = ['30 minutes', '1 hour', '4 hours', '12 hours', '1 day', '1 week']
+            options = ['1 day', '1 hour', '1 week', '12 hours', '30 minutes', '4 hours']
             assert kwargs['dhcpLeaseTime'] in options, f'''"dhcpLeaseTime" cannot be "{kwargs['dhcpLeaseTime']}", & must be set to one of: {options}'''
         if 'templateVlanType' in kwargs:
             options = ['same', 'unique']
@@ -1928,7 +1933,7 @@ def updateNetworkApplianceVlan(self, networkId: str, vlanId: str, **kwargs):
         vlanId = urllib.parse.quote(str(vlanId), safe='')
         resource = f'/networks/{networkId}/appliance/vlans/{vlanId}'
 
-        body_params = ['name', 'subnet', 'applianceIp', 'groupPolicyId', 'vpnNatSubnet', 'dhcpHandling', 'dhcpRelayServerIps', 'dhcpLeaseTime', 'dhcpBootOptionsEnabled', 'dhcpBootNextServer', 'dhcpBootFilename', 'fixedIpAssignments', 'reservedIpRanges', 'dnsNameservers', 'dhcpOptions', 'templateVlanType', 'cidr', 'mask', 'ipv6', ]
+        body_params = ['name', 'subnet', 'applianceIp', 'groupPolicyId', 'vpnNatSubnet', 'dhcpHandling', 'dhcpRelayServerIps', 'dhcpLeaseTime', 'dhcpBootOptionsEnabled', 'dhcpBootNextServer', 'dhcpBootFilename', 'fixedIpAssignments', 'reservedIpRanges', 'dnsNameservers', 'dhcpOptions', 'templateVlanType', 'cidr', 'mask', 'ipv6', 'mandatoryDhcp', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)
@@ -2036,7 +2041,7 @@ def updateNetworkApplianceVpnSiteToSiteVpn(self, networkId: str, mode: str, **kw
         kwargs.update(locals())
 
         if 'mode' in kwargs:
-            options = ['none', 'spoke', 'hub']
+            options = ['hub', 'none', 'spoke']
             assert kwargs['mode'] in options, f'''"mode" cannot be "{kwargs['mode']}", & must be set to one of: {options}'''
 
         metadata = {

meraki/aio/api/camera.py

@@ -251,10 +251,10 @@ def updateDeviceCameraQualityAndRetention(self, serial: str, **kwargs):
         kwargs.update(locals())
 
         if 'quality' in kwargs:
-            options = ['Standard', 'High', 'Enhanced']
+            options = ['Enhanced', 'High', 'Standard']
             assert kwargs['quality'] in options, f'''"quality" cannot be "{kwargs['quality']}", & must be set to one of: {options}'''
         if 'resolution' in kwargs:
-            options = ['1280x720', '1920x1080', '1080x1080', '2058x2058', '2112x2112', '2880x2880', '2688x1512', '3840x2160']
+            options = ['1080x1080', '1280x720', '1920x1080', '2058x2058', '2112x2112', '2688x1512', '2880x2880', '3840x2160']
             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]

meraki/aio/api/devices.py

@@ -287,7 +287,7 @@ def getDeviceLossAndLatencyHistory(self, serial: str, ip: str, **kwargs):
         kwargs.update(locals())
 
         if 'uplink' in kwargs:
-            options = ['wan1', 'wan2', 'cellular']
+            options = ['cellular', 'wan1', 'wan2']
             assert kwargs['uplink'] in options, f'''"uplink" cannot be "{kwargs['uplink']}", & must be set to one of: {options}'''
 
         metadata = {

meraki/aio/api/licensing.py

@@ -0,0 +1,65 @@
+import urllib
+
+
+class AsyncLicensing:
+    def __init__(self, session):
+        super().__init__()
+        self._session = session
+        
+
+
+    def getOrganizationLicensingCotermLicenses(self, organizationId: str, total_pages=1, direction='next', **kwargs):
+        """
+        **List the licenses in a coterm organization**
+        https://developer.cisco.com/meraki/api-v1/#!get-organization-licensing-coterm-licenses
+
+        - organizationId (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
+        - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
+        - 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.
+        - invalidated (boolean): Filter for licenses that are invalidated
+        - expired (boolean): Filter for licenses that are expired
+        """
+
+        kwargs.update(locals())
+
+        metadata = {
+            'tags': ['licensing', 'configure', 'coterm', 'licenses'],
+            'operation': 'getOrganizationLicensingCotermLicenses'
+        }
+        organizationId = urllib.parse.quote(str(organizationId), safe='')
+        resource = f'/organizations/{organizationId}/licensing/coterm/licenses'
+
+        query_params = ['perPage', 'startingAfter', 'endingBefore', 'invalidated', 'expired', ]
+        params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}
+
+        return self._session.get_pages(metadata, resource, params, total_pages, direction)
+        
+
+
+    def moveOrganizationLicensingCotermLicenses(self, organizationId: str, destination: dict, licenses: list):
+        """
+        **Moves a license to a different organization (coterm only)**
+        https://developer.cisco.com/meraki/api-v1/#!move-organization-licensing-coterm-licenses
+
+        - organizationId (string): (required)
+        - destination (object): Destination data for the license move
+        - licenses (array): The list of licenses to move
+        """
+
+        kwargs = locals()
+
+        metadata = {
+            'tags': ['licensing', 'configure', 'coterm', 'licenses'],
+            'operation': 'moveOrganizationLicensingCotermLicenses'
+        }
+        organizationId = urllib.parse.quote(str(organizationId), safe='')
+        resource = f'/organizations/{organizationId}/licensing/coterm/licenses/move'
+
+        body_params = ['destination', 'licenses', ]
+        payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
+
+        return self._session.post(metadata, resource, payload)
+