From e3626d6793b7303e42be2fd2158b4cde38bac175 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Wed, 1 Jul 2026 15:08:51 +0000 Subject: [PATCH] Auto-generated library v4.3.0b0 for API v1.72.0-beta.0. --- docs/generation-report.md | 6 ++ meraki/__init__.py | 2 +- meraki/_version.py | 2 +- meraki/aio/api/appliance.py | 60 ++++++++++- meraki/aio/api/organizations.py | 141 ++++++++++++++++++++++++- meraki/aio/api/wireless.py | 166 +++++++++++++++++++++++++++++- meraki/api/appliance.py | 60 ++++++++++- meraki/api/batch/appliance.py | 8 +- meraki/api/batch/organizations.py | 3 - meraki/api/organizations.py | 141 ++++++++++++++++++++++++- meraki/api/wireless.py | 166 +++++++++++++++++++++++++++++- pyproject.toml | 2 +- uv.lock | 2 +- 13 files changed, 726 insertions(+), 33 deletions(-) diff --git a/docs/generation-report.md b/docs/generation-report.md index c59fd21..461f645 100644 --- a/docs/generation-report.md +++ b/docs/generation-report.md @@ -1,5 +1,11 @@ # Generation Report +## 2026-07-01 | Library v4.3.0b0 | API 1.72.0-beta.0 + + +No Python keyword parameter conflicts detected. + + ## 2026-06-24 | Library v4.2.0b3 | API 1.71.0-beta.3 diff --git a/meraki/__init__.py b/meraki/__init__.py index 84d8582..5b3ea1c 100644 --- a/meraki/__init__.py +++ b/meraki/__init__.py @@ -59,7 +59,7 @@ from meraki._version import __version__ # noqa: F401 from datetime import datetime -__api_version__ = "1.71.0-beta.3" +__api_version__ = "1.72.0-beta.0" __all__ = [ "APIError", diff --git a/meraki/_version.py b/meraki/_version.py index e3503fc..a49c94f 100644 --- a/meraki/_version.py +++ b/meraki/_version.py @@ -1 +1 @@ -__version__ = "4.2.0b3" +__version__ = "4.3.0b0" diff --git a/meraki/aio/api/appliance.py b/meraki/aio/api/appliance.py index 7d7f83e..d3dcfdb 100644 --- a/meraki/aio/api/appliance.py +++ b/meraki/aio/api/appliance.py @@ -2896,7 +2896,7 @@ def createNetworkApplianceVlan(self, networkId: str, id: str, name: str, **kwarg - dhcpOptions (array): The list of DHCP options that will be included in DHCP responses. Each object in the list should have "code", "type", and "value" properties. - adaptivePolicyGroupId (string): Adaptive policy group ID this VLAN is assigned to. - sgt (object): Security Group Tag settings for the VLAN. - - vrf (object): VRF configuration on the VLAN + - vrf (object): VRF configuration on the VLAN. - uplinks (array): Per-uplink NAT exception override configuration on the VLAN. Applicable only for networks that support NAT exceptions. """ @@ -3054,7 +3054,7 @@ def updateNetworkApplianceVlan(self, networkId: str, vlanId: str, **kwargs): - 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 - adaptivePolicyGroupId (string): Adaptive policy group ID that all traffic originating from this VLAN is assigned to. - sgt (object): Security Group Tag settings for the VLAN. - - vrf (object): VRF configuration on the VLAN + - vrf (object): VRF configuration on the VLAN. - uplinks (array): Per-uplink NAT exception override configuration on the VLAN. Applicable only for networks that support NAT exceptions. """ @@ -3163,11 +3163,11 @@ def updateNetworkApplianceVpnBgp(self, networkId: str, enabled: bool, **kwargs): - networkId (string): Network ID - enabled (boolean): Boolean value to enable or disable the BGP configuration. When BGP is enabled, the asNumber (ASN) will be autopopulated with the preconfigured ASN at other Hubs or a default value if there is no ASN configured. - - asNumber (integer): An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512. + - asNumber (integer): An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain and is only configurable for Auto VPN BGP networks. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512. - ibgpHoldTimer (integer): The iBGP holdtimer in seconds. The iBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240. - ipv6 (object): Settings for IPv6 configurations on the organization. - tunnelDownTermination (object): Settings for tunnel down termination on the organization. - - vpnAsNumber (integer): Network specific number of the Autonomous System to which the appliance belongs. + - vpnAsNumber (integer): Network specific number of the Autonomous System to which the appliance belongs. This field is only configurable for Independent BGP networks. - priorityRoute (string): Sets the priority route between eBGP and Auto VPN. - routerId (string): The router ID of the appliance - neighbors (array): List of BGP neighbors. This list replaces the existing set of neighbors. When absent, this field is not updated. @@ -4534,6 +4534,58 @@ def getOrganizationApplianceSecurityEvents(self, organizationId: str, total_page return self._session.get_pages(metadata, resource, params, total_pages, direction) + def httpsiOrganizationApplianceSecurity(self, organizationId: str): + """ + **Retrieve the HTTPS Inspection state for all security appliances in an organization.** + https://developer.cisco.com/meraki/api-v1/#!httpsi-organization-appliance-security + + - organizationId (string): Organization ID + """ + + metadata = { + "tags": ["appliance", "configure", "security"], + "operation": "httpsiOrganizationApplianceSecurity", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/appliance/security/httpsi" + + return self._session.get(metadata, resource) + + def certificatesOrganizationApplianceSecurityHttpsi(self, organizationId: str, contents: str, serials: list, **kwargs): + """ + **Upload an HTTPS Inspection certificate to MX devices in the same organization** + https://developer.cisco.com/meraki/api-v1/#!certificates-organization-appliance-security-httpsi + + - organizationId (string): Organization ID + - contents (string): The private key and certificate used to inspect HTTPS traffic. The certificate must be in .pem format. + - serials (array): Serial numbers of the security appliances that will receive the new HTTPS certificate for HTTPS Inspection + """ + + kwargs = locals() + + metadata = { + "tags": ["appliance", "configure", "security", "httpsi"], + "operation": "certificatesOrganizationApplianceSecurityHttpsi", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/appliance/security/httpsi/certificates" + + body_params = [ + "contents", + "serials", + ] + payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} + + if self._session._validate_kwargs: + all_params = [] + body_params + invalid = [k for k in kwargs if k.strip() not in all_params and k != "self"] + if invalid and self._session._logger: + self._session._logger.warning( + f"certificatesOrganizationApplianceSecurityHttpsi: ignoring unrecognized kwargs: {invalid}" + ) + + return self._session.post(metadata, resource, payload) + def getOrganizationApplianceSecurityIntrusion(self, organizationId: str): """ **Returns all supported intrusion settings for an organization** diff --git a/meraki/aio/api/organizations.py b/meraki/aio/api/organizations.py index bc8629e..037fd5a 100644 --- a/meraki/aio/api/organizations.py +++ b/meraki/aio/api/organizations.py @@ -3505,6 +3505,56 @@ def getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByInter return self._session.get(metadata, resource, params) + def getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByServer(self, organizationId: str, **kwargs): + """ + **Summarizes wired connection successes and failures by server.** + https://developer.cisco.com/meraki/api-v1/#!get-organization-assurance-wired-experience-successful-connections-by-network-by-server + + - organizationId (string): Organization ID + - networkIds (array): Filter results by network. + - serials (array): Filter results by device serial. + - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. + """ + + kwargs.update(locals()) + + metadata = { + "tags": ["organizations", "configure", "wired", "experience", "successfulConnections", "byNetwork", "byServer"], + "operation": "getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByServer", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork/byServer" + + query_params = [ + "networkIds", + "serials", + "t0", + "t1", + "timespan", + ] + params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params} + + array_params = [ + "networkIds", + "serials", + ] + for k, v in kwargs.items(): + if k.strip() in array_params: + params[f"{k.strip()}[]"] = kwargs[f"{k}"] + params.pop(k.strip()) + + if self._session._validate_kwargs: + all_params = query_params + array_params + invalid = [k for k in kwargs if k.strip() not in all_params and k != "self"] + if invalid and self._session._logger: + self._session._logger.warning( + f"getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByServer: ignoring unrecognized kwargs: {invalid}" + ) + + return self._session.get(metadata, resource, params) + def getOrganizationAssuranceWorkflows(self, organizationId: str, total_pages=1, direction="next", **kwargs): """ **Return workflows filtered by organization ID, network ID, type, and category** @@ -7137,6 +7187,94 @@ def getOrganizationDevicesSoftwareUpdatesOverviewsByNetwork( return self._session.get_pages(metadata, resource, params, total_pages, direction) + def getOrganizationDevicesSoftwareVersions(self, organizationId: str, releaseType: str, **kwargs): + """ + **List the available software upgrade versions for an organization.** + https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-software-versions + + - organizationId (string): Organization ID + - releaseType (string): Filter by release type + """ + + kwargs = locals() + + if "releaseType" in kwargs: + options = ["beta", "generallyAvailable", "recommended"] + assert kwargs["releaseType"] in options, ( + f'''"releaseType" cannot be "{kwargs["releaseType"]}", & must be set to one of: {options}''' + ) + + metadata = { + "tags": ["organizations", "configure", "devices", "software", "versions"], + "operation": "getOrganizationDevicesSoftwareVersions", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/devices/software/versions" + + query_params = [ + "releaseType", + ] + params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params} + + if self._session._validate_kwargs: + all_params = query_params + invalid = [k for k in kwargs if k.strip() not in all_params and k != "self"] + if invalid and self._session._logger: + self._session._logger.warning( + f"getOrganizationDevicesSoftwareVersions: ignoring unrecognized kwargs: {invalid}" + ) + + return self._session.get(metadata, resource, params) + + def getOrganizationDevicesSoftwareVersionsChangelogs(self, organizationId: str, total_pages=1, direction="next", **kwargs): + """ + **Provide changelogs for specified versions or, if unspecified, for all versions in the organization, including reference to the last and next versions.** + https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-software-versions-changelogs + + - organizationId (string): Organization ID + - 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 + - versionIds (array): Array of version IDs for filtering + - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 30. + - 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": ["organizations", "configure", "devices", "software", "versions", "changelogs"], + "operation": "getOrganizationDevicesSoftwareVersionsChangelogs", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/devices/software/versions/changelogs" + + query_params = [ + "versionIds", + "perPage", + "startingAfter", + "endingBefore", + ] + params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params} + + array_params = [ + "versionIds", + ] + for k, v in kwargs.items(): + if k.strip() in array_params: + params[f"{k.strip()}[]"] = kwargs[f"{k}"] + params.pop(k.strip()) + + if self._session._validate_kwargs: + all_params = query_params + array_params + invalid = [k for k in kwargs if k.strip() not in all_params and k != "self"] + if invalid and self._session._logger: + self._session._logger.warning( + f"getOrganizationDevicesSoftwareVersionsChangelogs: ignoring unrecognized kwargs: {invalid}" + ) + + return self._session.get_pages(metadata, resource, params, total_pages, direction) + def getOrganizationDevicesStatuses(self, organizationId: str, total_pages=1, direction="next", **kwargs): """ **List the status of every Meraki device in the organization** @@ -11574,7 +11712,6 @@ def attachOrganizationSaseSites(self, organizationId: str, **kwargs): - organizationId (string): Organization ID - items (array): List of Meraki SD-WAN sites with the associated regions to be attached. - - callback (object): Details for the callback. Please include either an httpServerId OR url and sharedSecret """ kwargs.update(locals()) @@ -11588,7 +11725,6 @@ def attachOrganizationSaseSites(self, organizationId: str, **kwargs): body_params = [ "items", - "callback", ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} @@ -11667,7 +11803,6 @@ def detachOrganizationSaseSites(self, organizationId: str, **kwargs): - organizationId (string): Organization ID - items (array): List of Secure Access sites to be detached. - - callback (object): Details for the callback. Please include either an httpServerId OR url and sharedSecret """ kwargs.update(locals()) diff --git a/meraki/aio/api/wireless.py b/meraki/aio/api/wireless.py index 8085bb2..756d981 100644 --- a/meraki/aio/api/wireless.py +++ b/meraki/aio/api/wireless.py @@ -4630,7 +4630,7 @@ def getOrganizationAssuranceWirelessExperienceChannelAvailabilityInsightsByNetwo - bands (array): Filter results by band. - contributor (string): Contributor for which to retrieve insights. If not specified, returns overall insights. - subContributor (string): Sub-contributor for which to retrieve insights. If not specified, returns all sub contributor insights. - - insights (string): Insights version to use. + - insights (string): Insights version to use. Defaults to 2. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5325,7 +5325,7 @@ def getOrganizationAssuranceWirelessExperienceCoverageInsightsByNetwork( - bands (array): Filter results by band. - contributor (string): Contributor for which to retrieve insights. If not specified, returns overall insights. - subContributor (string): Sub-contributor for which to retrieve insights. If not specified, returns all sub contributor insights. - - insights (string): Insights version to use. + - insights (string): Insights version to use. Defaults to 2. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5549,6 +5549,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetwork( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5559,6 +5560,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetwork( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetwork", @@ -5571,6 +5578,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetwork( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5615,6 +5623,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByBand( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5625,6 +5634,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByBand( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byBand"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByBand", @@ -5637,6 +5652,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByBand( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5681,6 +5697,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5691,6 +5708,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byClient"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClient", @@ -5703,6 +5726,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5747,6 +5771,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5757,6 +5782,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byClientOs"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClientOs", @@ -5769,6 +5800,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5813,6 +5845,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5823,6 +5856,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byClientType"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClientType", @@ -5835,6 +5874,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5879,6 +5919,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByDevic - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5889,6 +5930,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByDevic kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byDevice"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByDevice", @@ -5901,6 +5948,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByDevic "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5945,6 +5993,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByInter - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 2 hours. If interval is provided, the timespan will be autocalculated. @@ -5956,6 +6005,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByInter kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "monitor", "experience", "successfulConnects", "byNetwork", "byInterval"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByInterval", @@ -5968,6 +6023,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByInter "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6013,6 +6069,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByServe - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6023,6 +6080,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByServe kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byServer"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByServer", @@ -6035,6 +6098,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByServe "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6079,6 +6143,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkBySsid( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6089,6 +6154,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkBySsid( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "bySsid"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkBySsid", @@ -6101,6 +6172,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkBySsid( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6147,7 +6219,8 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsInsightsByNetwor - bands (array): Filter results by band. - contributor (string): Contributor for which to retrieve insights. If not specified, returns overall insights. - subContributor (string): Sub-contributor for which to retrieve insights. If not specified, returns all sub contributor insights. - - insights (string): Insights version to use. + - insights (string): Insights version to use. Defaults to 2. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6168,6 +6241,11 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsInsightsByNetwor assert kwargs["insights"] in options, ( f'''"insights" cannot be "{kwargs["insights"]}", & must be set to one of: {options}''' ) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "insights", "byNetwork"], @@ -6184,6 +6262,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsInsightsByNetwor "contributor", "subContributor", "insights", + "variant", "t0", "t1", "timespan", @@ -6228,6 +6307,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetwork( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6238,6 +6318,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetwork( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetwork", @@ -6250,6 +6336,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetwork( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6294,6 +6381,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByBand( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6304,6 +6392,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByBand( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byBand"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByBand", @@ -6316,6 +6410,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByBand( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6360,6 +6455,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6370,6 +6466,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byClient"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient", @@ -6382,6 +6484,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6426,6 +6529,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientOs( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6436,6 +6540,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientOs( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byClientOs"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientOs", @@ -6448,6 +6558,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientOs( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6492,6 +6603,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientType - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6502,6 +6614,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientType kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byClientType"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientType", @@ -6514,6 +6632,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientType "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6558,6 +6677,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByDevice( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6568,6 +6688,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByDevice( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byDevice"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByDevice", @@ -6580,6 +6706,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByDevice( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6624,6 +6751,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByInterval( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 2 hours. If interval is provided, the timespan will be autocalculated. @@ -6635,6 +6763,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByInterval( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "monitor", "experience", "timeToConnect", "byNetwork", "byInterval"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByInterval", @@ -6647,6 +6781,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByInterval( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6692,6 +6827,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByServer( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6702,6 +6838,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByServer( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byServer"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByServer", @@ -6714,6 +6856,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByServer( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6758,6 +6901,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkBySsid( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6768,6 +6912,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkBySsid( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "bySsid"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkBySsid", @@ -6780,6 +6930,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkBySsid( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6826,7 +6977,8 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectInsightsByNetwork( - bands (array): Filter results by band. - contributor (string): Contributor for which to retrieve insights. If not specified, returns overall insights. - subContributor (string): Sub-contributor for which to retrieve insights. If not specified, returns all sub contributor insights. - - insights (string): Insights version to use. + - insights (string): Insights version to use. Defaults to 2. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6847,6 +6999,11 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectInsightsByNetwork( assert kwargs["insights"] in options, ( f'''"insights" cannot be "{kwargs["insights"]}", & must be set to one of: {options}''' ) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "insights", "byNetwork"], @@ -6863,6 +7020,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectInsightsByNetwork( "contributor", "subContributor", "insights", + "variant", "t0", "t1", "timespan", diff --git a/meraki/api/appliance.py b/meraki/api/appliance.py index fa7b1fd..7b12213 100644 --- a/meraki/api/appliance.py +++ b/meraki/api/appliance.py @@ -2896,7 +2896,7 @@ def createNetworkApplianceVlan(self, networkId: str, id: str, name: str, **kwarg - dhcpOptions (array): The list of DHCP options that will be included in DHCP responses. Each object in the list should have "code", "type", and "value" properties. - adaptivePolicyGroupId (string): Adaptive policy group ID this VLAN is assigned to. - sgt (object): Security Group Tag settings for the VLAN. - - vrf (object): VRF configuration on the VLAN + - vrf (object): VRF configuration on the VLAN. - uplinks (array): Per-uplink NAT exception override configuration on the VLAN. Applicable only for networks that support NAT exceptions. """ @@ -3054,7 +3054,7 @@ def updateNetworkApplianceVlan(self, networkId: str, vlanId: str, **kwargs): - 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 - adaptivePolicyGroupId (string): Adaptive policy group ID that all traffic originating from this VLAN is assigned to. - sgt (object): Security Group Tag settings for the VLAN. - - vrf (object): VRF configuration on the VLAN + - vrf (object): VRF configuration on the VLAN. - uplinks (array): Per-uplink NAT exception override configuration on the VLAN. Applicable only for networks that support NAT exceptions. """ @@ -3163,11 +3163,11 @@ def updateNetworkApplianceVpnBgp(self, networkId: str, enabled: bool, **kwargs): - networkId (string): Network ID - enabled (boolean): Boolean value to enable or disable the BGP configuration. When BGP is enabled, the asNumber (ASN) will be autopopulated with the preconfigured ASN at other Hubs or a default value if there is no ASN configured. - - asNumber (integer): An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512. + - asNumber (integer): An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain and is only configurable for Auto VPN BGP networks. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512. - ibgpHoldTimer (integer): The iBGP holdtimer in seconds. The iBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240. - ipv6 (object): Settings for IPv6 configurations on the organization. - tunnelDownTermination (object): Settings for tunnel down termination on the organization. - - vpnAsNumber (integer): Network specific number of the Autonomous System to which the appliance belongs. + - vpnAsNumber (integer): Network specific number of the Autonomous System to which the appliance belongs. This field is only configurable for Independent BGP networks. - priorityRoute (string): Sets the priority route between eBGP and Auto VPN. - routerId (string): The router ID of the appliance - neighbors (array): List of BGP neighbors. This list replaces the existing set of neighbors. When absent, this field is not updated. @@ -4534,6 +4534,58 @@ def getOrganizationApplianceSecurityEvents(self, organizationId: str, total_page return self._session.get_pages(metadata, resource, params, total_pages, direction) + def httpsiOrganizationApplianceSecurity(self, organizationId: str): + """ + **Retrieve the HTTPS Inspection state for all security appliances in an organization.** + https://developer.cisco.com/meraki/api-v1/#!httpsi-organization-appliance-security + + - organizationId (string): Organization ID + """ + + metadata = { + "tags": ["appliance", "configure", "security"], + "operation": "httpsiOrganizationApplianceSecurity", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/appliance/security/httpsi" + + return self._session.get(metadata, resource) + + def certificatesOrganizationApplianceSecurityHttpsi(self, organizationId: str, contents: str, serials: list, **kwargs): + """ + **Upload an HTTPS Inspection certificate to MX devices in the same organization** + https://developer.cisco.com/meraki/api-v1/#!certificates-organization-appliance-security-httpsi + + - organizationId (string): Organization ID + - contents (string): The private key and certificate used to inspect HTTPS traffic. The certificate must be in .pem format. + - serials (array): Serial numbers of the security appliances that will receive the new HTTPS certificate for HTTPS Inspection + """ + + kwargs = locals() + + metadata = { + "tags": ["appliance", "configure", "security", "httpsi"], + "operation": "certificatesOrganizationApplianceSecurityHttpsi", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/appliance/security/httpsi/certificates" + + body_params = [ + "contents", + "serials", + ] + payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} + + if self._session._validate_kwargs: + all_params = [] + body_params + invalid = [k for k in kwargs if k.strip() not in all_params and k != "self"] + if invalid and self._session._logger: + self._session._logger.warning( + f"certificatesOrganizationApplianceSecurityHttpsi: ignoring unrecognized kwargs: {invalid}" + ) + + return self._session.post(metadata, resource, payload) + def getOrganizationApplianceSecurityIntrusion(self, organizationId: str): """ **Returns all supported intrusion settings for an organization** diff --git a/meraki/api/batch/appliance.py b/meraki/api/batch/appliance.py index 461f1c1..e8ba826 100644 --- a/meraki/api/batch/appliance.py +++ b/meraki/api/batch/appliance.py @@ -1195,7 +1195,7 @@ def createNetworkApplianceVlan(self, networkId: str, id: str, name: str, **kwarg - dhcpOptions (array): The list of DHCP options that will be included in DHCP responses. Each object in the list should have "code", "type", and "value" properties. - adaptivePolicyGroupId (string): Adaptive policy group ID this VLAN is assigned to. - sgt (object): Security Group Tag settings for the VLAN. - - vrf (object): VRF configuration on the VLAN + - vrf (object): VRF configuration on the VLAN. - uplinks (array): Per-uplink NAT exception override configuration on the VLAN. Applicable only for networks that support NAT exceptions. """ @@ -1305,7 +1305,7 @@ def updateNetworkApplianceVlan(self, networkId: str, vlanId: str, **kwargs): - 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 - adaptivePolicyGroupId (string): Adaptive policy group ID that all traffic originating from this VLAN is assigned to. - sgt (object): Security Group Tag settings for the VLAN. - - vrf (object): VRF configuration on the VLAN + - vrf (object): VRF configuration on the VLAN. - uplinks (array): Per-uplink NAT exception override configuration on the VLAN. Applicable only for networks that support NAT exceptions. """ @@ -1391,11 +1391,11 @@ def updateNetworkApplianceVpnBgp(self, networkId: str, enabled: bool, **kwargs): - networkId (string): Network ID - enabled (boolean): Boolean value to enable or disable the BGP configuration. When BGP is enabled, the asNumber (ASN) will be autopopulated with the preconfigured ASN at other Hubs or a default value if there is no ASN configured. - - asNumber (integer): An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512. + - asNumber (integer): An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain and is only configurable for Auto VPN BGP networks. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512. - ibgpHoldTimer (integer): The iBGP holdtimer in seconds. The iBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240. - ipv6 (object): Settings for IPv6 configurations on the organization. - tunnelDownTermination (object): Settings for tunnel down termination on the organization. - - vpnAsNumber (integer): Network specific number of the Autonomous System to which the appliance belongs. + - vpnAsNumber (integer): Network specific number of the Autonomous System to which the appliance belongs. This field is only configurable for Independent BGP networks. - priorityRoute (string): Sets the priority route between eBGP and Auto VPN. - routerId (string): The router ID of the appliance - neighbors (array): List of BGP neighbors. This list replaces the existing set of neighbors. When absent, this field is not updated. diff --git a/meraki/api/batch/organizations.py b/meraki/api/batch/organizations.py index 3718ecf..b0d6747 100644 --- a/meraki/api/batch/organizations.py +++ b/meraki/api/batch/organizations.py @@ -3013,7 +3013,6 @@ def attachOrganizationSaseSites(self, organizationId: str, **kwargs): - organizationId (string): Organization ID - items (array): List of Meraki SD-WAN sites with the associated regions to be attached. - - callback (object): Details for the callback. Please include either an httpServerId OR url and sharedSecret """ kwargs.update(locals()) @@ -3023,7 +3022,6 @@ def attachOrganizationSaseSites(self, organizationId: str, **kwargs): body_params = [ "items", - "callback", ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { @@ -3040,7 +3038,6 @@ def detachOrganizationSaseSites(self, organizationId: str, **kwargs): - organizationId (string): Organization ID - items (array): List of Secure Access sites to be detached. - - callback (object): Details for the callback. Please include either an httpServerId OR url and sharedSecret """ kwargs.update(locals()) diff --git a/meraki/api/organizations.py b/meraki/api/organizations.py index 7361921..f1cfa53 100644 --- a/meraki/api/organizations.py +++ b/meraki/api/organizations.py @@ -3505,6 +3505,56 @@ def getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByInter return self._session.get(metadata, resource, params) + def getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByServer(self, organizationId: str, **kwargs): + """ + **Summarizes wired connection successes and failures by server.** + https://developer.cisco.com/meraki/api-v1/#!get-organization-assurance-wired-experience-successful-connections-by-network-by-server + + - organizationId (string): Organization ID + - networkIds (array): Filter results by network. + - serials (array): Filter results by device serial. + - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. + """ + + kwargs.update(locals()) + + metadata = { + "tags": ["organizations", "configure", "wired", "experience", "successfulConnections", "byNetwork", "byServer"], + "operation": "getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByServer", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork/byServer" + + query_params = [ + "networkIds", + "serials", + "t0", + "t1", + "timespan", + ] + params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params} + + array_params = [ + "networkIds", + "serials", + ] + for k, v in kwargs.items(): + if k.strip() in array_params: + params[f"{k.strip()}[]"] = kwargs[f"{k}"] + params.pop(k.strip()) + + if self._session._validate_kwargs: + all_params = query_params + array_params + invalid = [k for k in kwargs if k.strip() not in all_params and k != "self"] + if invalid and self._session._logger: + self._session._logger.warning( + f"getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByServer: ignoring unrecognized kwargs: {invalid}" + ) + + return self._session.get(metadata, resource, params) + def getOrganizationAssuranceWorkflows(self, organizationId: str, total_pages=1, direction="next", **kwargs): """ **Return workflows filtered by organization ID, network ID, type, and category** @@ -7137,6 +7187,94 @@ def getOrganizationDevicesSoftwareUpdatesOverviewsByNetwork( return self._session.get_pages(metadata, resource, params, total_pages, direction) + def getOrganizationDevicesSoftwareVersions(self, organizationId: str, releaseType: str, **kwargs): + """ + **List the available software upgrade versions for an organization.** + https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-software-versions + + - organizationId (string): Organization ID + - releaseType (string): Filter by release type + """ + + kwargs = locals() + + if "releaseType" in kwargs: + options = ["beta", "generallyAvailable", "recommended"] + assert kwargs["releaseType"] in options, ( + f'''"releaseType" cannot be "{kwargs["releaseType"]}", & must be set to one of: {options}''' + ) + + metadata = { + "tags": ["organizations", "configure", "devices", "software", "versions"], + "operation": "getOrganizationDevicesSoftwareVersions", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/devices/software/versions" + + query_params = [ + "releaseType", + ] + params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params} + + if self._session._validate_kwargs: + all_params = query_params + invalid = [k for k in kwargs if k.strip() not in all_params and k != "self"] + if invalid and self._session._logger: + self._session._logger.warning( + f"getOrganizationDevicesSoftwareVersions: ignoring unrecognized kwargs: {invalid}" + ) + + return self._session.get(metadata, resource, params) + + def getOrganizationDevicesSoftwareVersionsChangelogs(self, organizationId: str, total_pages=1, direction="next", **kwargs): + """ + **Provide changelogs for specified versions or, if unspecified, for all versions in the organization, including reference to the last and next versions.** + https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-software-versions-changelogs + + - organizationId (string): Organization ID + - 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 + - versionIds (array): Array of version IDs for filtering + - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 30. + - 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": ["organizations", "configure", "devices", "software", "versions", "changelogs"], + "operation": "getOrganizationDevicesSoftwareVersionsChangelogs", + } + organizationId = urllib.parse.quote(str(organizationId), safe="") + resource = f"/organizations/{organizationId}/devices/software/versions/changelogs" + + query_params = [ + "versionIds", + "perPage", + "startingAfter", + "endingBefore", + ] + params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params} + + array_params = [ + "versionIds", + ] + for k, v in kwargs.items(): + if k.strip() in array_params: + params[f"{k.strip()}[]"] = kwargs[f"{k}"] + params.pop(k.strip()) + + if self._session._validate_kwargs: + all_params = query_params + array_params + invalid = [k for k in kwargs if k.strip() not in all_params and k != "self"] + if invalid and self._session._logger: + self._session._logger.warning( + f"getOrganizationDevicesSoftwareVersionsChangelogs: ignoring unrecognized kwargs: {invalid}" + ) + + return self._session.get_pages(metadata, resource, params, total_pages, direction) + def getOrganizationDevicesStatuses(self, organizationId: str, total_pages=1, direction="next", **kwargs): """ **List the status of every Meraki device in the organization** @@ -11574,7 +11712,6 @@ def attachOrganizationSaseSites(self, organizationId: str, **kwargs): - organizationId (string): Organization ID - items (array): List of Meraki SD-WAN sites with the associated regions to be attached. - - callback (object): Details for the callback. Please include either an httpServerId OR url and sharedSecret """ kwargs.update(locals()) @@ -11588,7 +11725,6 @@ def attachOrganizationSaseSites(self, organizationId: str, **kwargs): body_params = [ "items", - "callback", ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} @@ -11667,7 +11803,6 @@ def detachOrganizationSaseSites(self, organizationId: str, **kwargs): - organizationId (string): Organization ID - items (array): List of Secure Access sites to be detached. - - callback (object): Details for the callback. Please include either an httpServerId OR url and sharedSecret """ kwargs.update(locals()) diff --git a/meraki/api/wireless.py b/meraki/api/wireless.py index c4c5088..cc0c21d 100644 --- a/meraki/api/wireless.py +++ b/meraki/api/wireless.py @@ -4630,7 +4630,7 @@ def getOrganizationAssuranceWirelessExperienceChannelAvailabilityInsightsByNetwo - bands (array): Filter results by band. - contributor (string): Contributor for which to retrieve insights. If not specified, returns overall insights. - subContributor (string): Sub-contributor for which to retrieve insights. If not specified, returns all sub contributor insights. - - insights (string): Insights version to use. + - insights (string): Insights version to use. Defaults to 2. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5325,7 +5325,7 @@ def getOrganizationAssuranceWirelessExperienceCoverageInsightsByNetwork( - bands (array): Filter results by band. - contributor (string): Contributor for which to retrieve insights. If not specified, returns overall insights. - subContributor (string): Sub-contributor for which to retrieve insights. If not specified, returns all sub contributor insights. - - insights (string): Insights version to use. + - insights (string): Insights version to use. Defaults to 2. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5549,6 +5549,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetwork( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5559,6 +5560,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetwork( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetwork", @@ -5571,6 +5578,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetwork( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5615,6 +5623,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByBand( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5625,6 +5634,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByBand( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byBand"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByBand", @@ -5637,6 +5652,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByBand( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5681,6 +5697,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5691,6 +5708,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byClient"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClient", @@ -5703,6 +5726,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5747,6 +5771,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5757,6 +5782,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byClientOs"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClientOs", @@ -5769,6 +5800,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5813,6 +5845,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5823,6 +5856,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byClientType"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClientType", @@ -5835,6 +5874,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClien "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5879,6 +5919,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByDevic - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -5889,6 +5930,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByDevic kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byDevice"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByDevice", @@ -5901,6 +5948,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByDevic "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -5945,6 +5993,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByInter - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 2 hours. If interval is provided, the timespan will be autocalculated. @@ -5956,6 +6005,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByInter kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "monitor", "experience", "successfulConnects", "byNetwork", "byInterval"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByInterval", @@ -5968,6 +6023,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByInter "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6013,6 +6069,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByServe - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6023,6 +6080,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByServe kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "byServer"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByServer", @@ -6035,6 +6098,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByServe "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6079,6 +6143,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkBySsid( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6089,6 +6154,12 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkBySsid( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "byNetwork", "bySsid"], "operation": "getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkBySsid", @@ -6101,6 +6172,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkBySsid( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6147,7 +6219,8 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsInsightsByNetwor - bands (array): Filter results by band. - contributor (string): Contributor for which to retrieve insights. If not specified, returns overall insights. - subContributor (string): Sub-contributor for which to retrieve insights. If not specified, returns all sub contributor insights. - - insights (string): Insights version to use. + - insights (string): Insights version to use. Defaults to 2. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6168,6 +6241,11 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsInsightsByNetwor assert kwargs["insights"] in options, ( f'''"insights" cannot be "{kwargs["insights"]}", & must be set to one of: {options}''' ) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) metadata = { "tags": ["wireless", "configure", "experience", "successfulConnects", "insights", "byNetwork"], @@ -6184,6 +6262,7 @@ def getOrganizationAssuranceWirelessExperienceSuccessfulConnectsInsightsByNetwor "contributor", "subContributor", "insights", + "variant", "t0", "t1", "timespan", @@ -6228,6 +6307,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetwork( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6238,6 +6318,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetwork( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetwork", @@ -6250,6 +6336,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetwork( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6294,6 +6381,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByBand( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6304,6 +6392,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByBand( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byBand"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByBand", @@ -6316,6 +6410,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByBand( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6360,6 +6455,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6370,6 +6466,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byClient"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient", @@ -6382,6 +6484,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6426,6 +6529,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientOs( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6436,6 +6540,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientOs( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byClientOs"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientOs", @@ -6448,6 +6558,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientOs( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6492,6 +6603,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientType - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6502,6 +6614,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientType kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byClientType"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientType", @@ -6514,6 +6632,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClientType "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6558,6 +6677,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByDevice( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6568,6 +6688,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByDevice( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byDevice"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByDevice", @@ -6580,6 +6706,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByDevice( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6624,6 +6751,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByInterval( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 2 hours. If interval is provided, the timespan will be autocalculated. @@ -6635,6 +6763,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByInterval( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "monitor", "experience", "timeToConnect", "byNetwork", "byInterval"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByInterval", @@ -6647,6 +6781,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByInterval( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6692,6 +6827,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByServer( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6702,6 +6838,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByServer( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "byServer"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByServer", @@ -6714,6 +6856,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByServer( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6758,6 +6901,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkBySsid( - serials (array): Filter results by device serial. - ssidNumbers (array): Filter results by SSID number. - bands (array): Filter results by band. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6768,6 +6912,12 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkBySsid( kwargs.update(locals()) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) + metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "byNetwork", "bySsid"], "operation": "getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkBySsid", @@ -6780,6 +6930,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkBySsid( "serials", "ssidNumbers", "bands", + "variant", "t0", "t1", "timespan", @@ -6826,7 +6977,8 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectInsightsByNetwork( - bands (array): Filter results by band. - contributor (string): Contributor for which to retrieve insights. If not specified, returns overall insights. - subContributor (string): Sub-contributor for which to retrieve insights. If not specified, returns all sub contributor insights. - - insights (string): Insights version to use. + - insights (string): Insights version to use. Defaults to 2. + - variant (string): Wireless State Machine variant to use. - 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 greater than or equal to 15 minutes and be less than or equal to 14 days. The default is 2 hours. @@ -6847,6 +6999,11 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectInsightsByNetwork( assert kwargs["insights"] in options, ( f'''"insights" cannot be "{kwargs["insights"]}", & must be set to one of: {options}''' ) + if "variant" in kwargs: + options = ["A", "B"] + assert kwargs["variant"] in options, ( + f'''"variant" cannot be "{kwargs["variant"]}", & must be set to one of: {options}''' + ) metadata = { "tags": ["wireless", "configure", "experience", "timeToConnect", "insights", "byNetwork"], @@ -6863,6 +7020,7 @@ def getOrganizationAssuranceWirelessExperienceTimeToConnectInsightsByNetwork( "contributor", "subContributor", "insights", + "variant", "t0", "t1", "timespan", diff --git a/pyproject.toml b/pyproject.toml index 1c3a31f..478ff52 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "meraki" -version = "4.2.0b3" +version = "4.3.0b0" description = "Cisco Meraki Dashboard API library" authors = [ {name = "Cisco Meraki", email = "api-feedback@meraki.net"} diff --git a/uv.lock b/uv.lock index 98696d0..82b5e11 100644 --- a/uv.lock +++ b/uv.lock @@ -314,7 +314,7 @@ wheels = [ [[package]] name = "meraki" -version = "4.2.0b3" +version = "4.3.0b0" source = { editable = "." } dependencies = [ { name = "httpx" },