Automatically regenerated library.

meraki/__init__.py

@@ -43,7 +43,7 @@
 )
 from meraki.rest_session import *
 
-__version__ = '1.41.0'
+__version__ = '1.42.0'
 
 
 class DashboardAPI(object):

meraki/aio/api/licensing.py

@@ -54,6 +54,7 @@ def claimAdministeredLicensingSubscriptionSubscriptions(self, claimKey: str, org
 
         - claimKey (string): The subscription's claim key
         - organizationId (string): The id of the organization claiming the subscription
+        - validate (boolean): Check if the provided claim key is valid and can be claimed into the organization.
         - name (string): Friendly name to identify the subscription
         - description (string): Extra details or notes about the subscription
         """

meraki/aio/api/organizations.py

@@ -1588,9 +1588,9 @@ def getOrganizationDevicesAvailabilitiesChangeHistory(self, organizationId: str,
         - 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.
-        - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 14 days from today.
-        - t1 (string): The end of the timespan for the data. t1 can be a maximum of 14 days after t0.
-        - timespan (number): The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 14 days. The default is 1 day.
+        - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
+        - t1 (string): The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
+        - timespan (number): The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
         - serials (array): Optional parameter to filter device availabilities history by device serial numbers
         - productTypes (array): Optional parameter to filter device availabilities history by device product types
         - networkIds (array): Optional parameter to filter device availabilities history by network IDs

meraki/aio/api/sm.py

@@ -166,7 +166,7 @@ def lockNetworkSmDevices(self, networkId: str, **kwargs):
         - wifiMacs (array): The wifiMacs of the devices to be locked.
         - ids (array): The ids of the devices to be locked.
         - serials (array): The serials of the devices to be locked.
-        - scope (array): The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be wiped.
+        - scope (array): The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be locked.
         - pin (integer): The pin number for locking macOS devices (a six digit number). Required only for macOS devices.
         """
 

meraki/api/batch/appliance.py

@@ -940,7 +940,7 @@ def updateNetworkApplianceVpnBgp(self, networkId: str, enabled: bool, **kwargs):
 
     def updateNetworkApplianceVpnSiteToSiteVpn(self, networkId: str, mode: str, **kwargs):
         """
-        **Update the site-to-site VPN settings of a network**
+        **Update the site-to-site VPN settings of a network. Only valid for MX networks in NAT mode.**
         https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-vpn-site-to-site-vpn
 
         - networkId (string): Network ID
@@ -1026,7 +1026,7 @@ def swapNetworkApplianceWarmSpare(self, networkId: str):
 
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "swap",
         }
         return action
 

meraki/api/batch/camera.py

@@ -154,7 +154,7 @@ def updateDeviceCameraVideoSettings(self, serial: str, **kwargs):
 
     def updateDeviceCameraWirelessProfiles(self, serial: str, ids: dict):
         """
-        **Assign wireless profiles to the given camera**
+        **Assign wireless profiles to the given camera. Incremental updates are not supported, all profile assignment need to be supplied at once.**
         https://developer.cisco.com/meraki/api-v1/#!update-device-camera-wireless-profiles
 
         - serial (string): Serial

meraki/api/batch/insight.py

@@ -9,7 +9,7 @@ def __init__(self):
 
     def createOrganizationInsightMonitoredMediaServer(self, organizationId: str, name: str, address: str, **kwargs):
         """
-        **Add a media server to be monitored for this organization**
+        **Add a media server to be monitored for this organization. Only valid for organizations with Meraki Insight.**
         https://developer.cisco.com/meraki/api-v1/#!create-organization-insight-monitored-media-server
 
         - organizationId (string): Organization ID
@@ -42,7 +42,7 @@ def createOrganizationInsightMonitoredMediaServer(self, organizationId: str, nam
 
     def updateOrganizationInsightMonitoredMediaServer(self, organizationId: str, monitoredMediaServerId: str, **kwargs):
         """
-        **Update a monitored media server for this organization**
+        **Update a monitored media server for this organization. Only valid for organizations with Meraki Insight.**
         https://developer.cisco.com/meraki/api-v1/#!update-organization-insight-monitored-media-server
 
         - organizationId (string): Organization ID
@@ -76,7 +76,7 @@ def updateOrganizationInsightMonitoredMediaServer(self, organizationId: str, mon
 
     def deleteOrganizationInsightMonitoredMediaServer(self, organizationId: str, monitoredMediaServerId: str):
         """
-        **Delete a monitored media server from this organization**
+        **Delete a monitored media server from this organization. Only valid for organizations with Meraki Insight.**
         https://developer.cisco.com/meraki/api-v1/#!delete-organization-insight-monitored-media-server
 
         - organizationId (string): Organization ID

meraki/api/batch/networks.py

@@ -89,7 +89,7 @@ def bindNetwork(self, networkId: str, configTemplateId: str, **kwargs):
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "bind",
             "body": payload
         }
         return action
@@ -101,7 +101,7 @@ def bindNetwork(self, networkId: str, configTemplateId: str, **kwargs):
 
     def provisionNetworkClients(self, networkId: str, clients: list, devicePolicy: str, **kwargs):
         """
-        **Provisions a client with a name and policy**
+        **Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.**
         https://developer.cisco.com/meraki/api-v1/#!provision-network-clients
 
         - networkId (string): Network ID
@@ -128,7 +128,7 @@ def provisionNetworkClients(self, networkId: str, clients: list, devicePolicy: s
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "provision",
             "body": payload
         }
         return action
@@ -159,7 +159,7 @@ def claimNetworkDevices(self, networkId: str, serials: list):
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "claim",
             "body": payload
         }
         return action
@@ -194,7 +194,7 @@ def vmxNetworkDevicesClaim(self, networkId: str, size: str):
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "claim",
             "body": payload
         }
         return action
@@ -225,7 +225,7 @@ def removeNetworkDevices(self, networkId: str, serial: str):
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "remove",
             "body": payload
         }
         return action
@@ -800,7 +800,7 @@ def splitNetwork(self, networkId: str):
 
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "split",
         }
         return action
 
@@ -830,7 +830,7 @@ def unbindNetwork(self, networkId: str, **kwargs):
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "unbind",
             "body": payload
         }
         return action
@@ -937,7 +937,7 @@ def createNetworkWebhooksPayloadTemplate(self, networkId: str, name: str, **kwar
 
     def deleteNetworkWebhooksPayloadTemplate(self, networkId: str, payloadTemplateId: str):
         """
-        **Destroy a webhook payload template for a network**
+        **Destroy a webhook payload template for a network. Does not work for included templates ('wpt_00001', 'wpt_00002', 'wpt_00003', 'wpt_00004', 'wpt_00005' or 'wpt_00006')**
         https://developer.cisco.com/meraki/api-v1/#!delete-network-webhooks-payload-template
 
         - networkId (string): Network ID

meraki/api/batch/organizations.py

@@ -86,7 +86,7 @@ def updateOrganizationAdaptivePolicyAcl(self, organizationId: str, aclId: str, *
 
     def deleteOrganizationAdaptivePolicyAcl(self, organizationId: str, aclId: str):
         """
-        **Deletes the specified adaptive policy ACL**
+        **Deletes the specified adaptive policy ACL. Note this adaptive policy ACL will also be removed from policies using it.**
         https://developer.cisco.com/meraki/api-v1/#!delete-organization-adaptive-policy-acl
 
         - organizationId (string): Organization ID
@@ -146,7 +146,7 @@ def createOrganizationAdaptivePolicyGroup(self, organizationId: str, name: str,
 
     def updateOrganizationAdaptivePolicyGroup(self, organizationId: str, id: str, **kwargs):
         """
-        **Updates an adaptive policy group**
+        **Updates an adaptive policy group. If updating "Infrastructure", only the SGT is allowed. Cannot update "Unknown".**
         https://developer.cisco.com/meraki/api-v1/#!update-organization-adaptive-policy-group
 
         - organizationId (string): Organization ID
@@ -682,7 +682,7 @@ def updateOrganizationEarlyAccessFeaturesOptIn(self, organizationId: str, optInI
 
     def assignOrganizationLicensesSeats(self, organizationId: str, licenseId: str, networkId: str, seatCount: int):
         """
-        **Assign SM seats to a network**
+        **Assign SM seats to a network. This will increase the managed SM device limit of the network**
         https://developer.cisco.com/meraki/api-v1/#!assign-organization-licenses-seats
 
         - organizationId (string): Organization ID
@@ -703,7 +703,7 @@ def assignOrganizationLicensesSeats(self, organizationId: str, licenseId: str, n
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "assignSeats",
             "body": payload
         }
         return action
@@ -715,7 +715,7 @@ def assignOrganizationLicensesSeats(self, organizationId: str, licenseId: str, n
 
     def moveOrganizationLicenses(self, organizationId: str, destOrganizationId: str, licenseIds: list):
         """
-        **Move licenses to another organization**
+        **Move licenses to another organization. This will also move any devices that the licenses are assigned to**
         https://developer.cisco.com/meraki/api-v1/#!move-organization-licenses
 
         - organizationId (string): Organization ID
@@ -735,7 +735,7 @@ def moveOrganizationLicenses(self, organizationId: str, destOrganizationId: str,
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "move",
             "body": payload
         }
         return action
@@ -768,7 +768,7 @@ def moveOrganizationLicensesSeats(self, organizationId: str, destOrganizationId:
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "moveSeats",
             "body": payload
         }
         return action
@@ -780,7 +780,7 @@ def moveOrganizationLicensesSeats(self, organizationId: str, destOrganizationId:
 
     def renewOrganizationLicensesSeats(self, organizationId: str, licenseIdToRenew: str, unusedLicenseId: str):
         """
-        **Renew SM seats of a license**
+        **Renew SM seats of a license. This will extend the license expiration date of managed SM devices covered by this license**
         https://developer.cisco.com/meraki/api-v1/#!renew-organization-licenses-seats
 
         - organizationId (string): Organization ID
@@ -800,7 +800,7 @@ def renewOrganizationLicensesSeats(self, organizationId: str, licenseIdToRenew:
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "renewSeats",
             "body": payload
         }
         return action
@@ -944,7 +944,7 @@ def combineOrganizationNetworks(self, organizationId: str, name: str, networkIds
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "combine",
             "body": payload
         }
         return action

meraki/api/batch/sensor.py

@@ -137,7 +137,7 @@ def deleteNetworkSensorAlertsProfile(self, networkId: str, id: str):
 
     def updateNetworkSensorMqttBroker(self, networkId: str, mqttBrokerId: str, enabled: bool):
         """
-        **Update the sensor settings of an MQTT broker**
+        **Update the sensor settings of an MQTT broker. To update the broker itself, use /networks/{networkId}/mqttBrokers/{mqttBrokerId}.**
         https://developer.cisco.com/meraki/api-v1/#!update-network-sensor-mqtt-broker
 
         - networkId (string): Network ID

meraki/api/batch/switch.py

@@ -28,7 +28,7 @@ def cycleDeviceSwitchPorts(self, serial: str, ports: list):
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "cycle",
             "body": payload
         }
         return action
@@ -376,7 +376,7 @@ def deleteDeviceSwitchRoutingStaticRoute(self, serial: str, staticRouteId: str):
 
     def updateDeviceSwitchWarmSpare(self, serial: str, enabled: bool, **kwargs):
         """
-        **Update warm spare configuration for a switch**
+        **Update warm spare configuration for a switch. The spare will use the same L3 configuration as the primary. Note that this will irreversibly destroy any existing L3 configuration on the spare.**
         https://developer.cisco.com/meraki/api-v1/#!update-device-switch-warm-spare
 
         - serial (string): Serial
@@ -408,7 +408,7 @@ def updateDeviceSwitchWarmSpare(self, serial: str, enabled: bool, **kwargs):
 
     def createNetworkSwitchAccessPolicy(self, networkId: str, name: str, radiusServers: list, radiusTestingEnabled: bool, radiusCoaSupportEnabled: bool, radiusAccountingEnabled: bool, hostMode: str, urlRedirectWalledGardenEnabled: bool, **kwargs):
         """
-        **Create an access policy for a switch network**
+        **Create an access policy for a switch network. If you would like to enable Meraki Authentication, set radiusServers to empty array.**
         https://developer.cisco.com/meraki/api-v1/#!create-network-switch-access-policy
 
         - networkId (string): Network ID
@@ -462,7 +462,7 @@ def createNetworkSwitchAccessPolicy(self, networkId: str, name: str, radiusServe
 
     def updateNetworkSwitchAccessPolicy(self, networkId: str, accessPolicyNumber: str, **kwargs):
         """
-        **Update an access policy for a switch network**
+        **Update an access policy for a switch network. If you would like to enable Meraki Authentication, set radiusServers to empty array.**
         https://developer.cisco.com/meraki/api-v1/#!update-network-switch-access-policy
 
         - networkId (string): Network ID
@@ -577,7 +577,7 @@ def updateNetworkSwitchAlternateManagementInterface(self, networkId: str, **kwar
 
     def updateNetworkSwitchDhcpServerPolicy(self, networkId: str, **kwargs):
         """
-        **Update the DHCP server settings**
+        **Update the DHCP server settings. Blocked/allowed servers are only applied when default policy is allow/block, respectively**
         https://developer.cisco.com/meraki/api-v1/#!update-network-switch-dhcp-server-policy
 
         - networkId (string): Network ID
@@ -959,7 +959,7 @@ def updateNetworkSwitchQosRulesOrder(self, networkId: str, ruleIds: list):
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "update",
+            "operation": "update_order",
             "body": payload
         }
         return action
@@ -1222,7 +1222,7 @@ def updateNetworkSwitchSettings(self, networkId: str, **kwargs):
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "update",
+            "operation": "settings/actions/update",
             "body": payload
         }
         return action
@@ -1641,7 +1641,7 @@ def updateOrganizationConfigTemplateSwitchProfilePort(self, organizationId: str,
 
     def cloneOrganizationSwitchDevices(self, organizationId: str, sourceSerial: str, targetSerials: list):
         """
-        **Clone port-level and some switch-level configuration settings from a source switch to one or more target switches**
+        **Clone port-level and some switch-level configuration settings from a source switch to one or more target switches. Cloned settings include: Aggregation Groups, Power Settings, Multicast Settings, MTU Configuration, STP Bridge priority, Port Mirroring**
         https://developer.cisco.com/meraki/api-v1/#!clone-organization-switch-devices
 
         - organizationId (string): Organization ID
@@ -1661,7 +1661,7 @@ def cloneOrganizationSwitchDevices(self, organizationId: str, sourceSerial: str,
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "clone",
             "body": payload
         }
         return action

meraki/api/batch/wireless.py

@@ -225,7 +225,7 @@ def assignNetworkWirelessEthernetPortsProfiles(self, networkId: str, serials: li
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "aps",
             "body": payload
         }
         return action
@@ -256,7 +256,7 @@ def setNetworkWirelessEthernetPortsProfilesDefault(self, networkId: str, profile
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
-            "operation": "create",
+            "operation": "default",
             "body": payload
         }
         return action