Wireless (Batch)

Assign AP port profile to list of APs.

API documentation: assignNetworkWirelessEthernetPortsProfiles

Parameters:

• network_id (str) –

  Network ID.

• serials (list[str]) –

  List of AP serials.

• profile_id (str) –

  AP profile ID.

Creates a new rule.

API documentation: createNetworkWirelessAirMarshalRule

Parameters:

• network_id (str) –

  Network ID.

• type_ (CreateNetworkWirelessAirMarshalRuleType) –

  Indicates if this rule will allow, block, or alert.

• match (CreateNetworkWirelessAirMarshalRuleMatch) –

  Object describing the rule specification.

Create an AP port profile.

API documentation: createNetworkWirelessEthernetPortsProfile

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  AP port profile name.

• ports (list[CreateNetworkWirelessEthernetPortsProfilePortsItem]) –

  AP ports configuration.

• usb_ports (list[CreateNetworkWirelessEthernetPortsProfileUsbPortsItem] | None, default: None ) –

  AP usb ports configuration.

Creates new RF profile for this network.

API documentation: createNetworkWirelessRfProfile

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name of the new profile. Must be unique. This param is required on creation.

• client_balancing_enabled (bool | None, default: None ) –

  Steers client to best available access point. Can be either true or false. Defaults to true.

• min_bitrate_type (CreateNetworkWirelessRfProfileMinBitrateType | None, default: None ) –

  Minimum bitrate can be set to either 'band' or 'ssid'. Defaults to band.

• band_selection_type (CreateNetworkWirelessRfProfileBandSelectionType) –

  Band selection can be set to either 'ssid' or 'ap'. This param is required on creation.

• ap_band_settings (CreateNetworkWirelessRfProfileApBandSettings | None, default: None ) –

  Settings that will be enabled if selectionType is set to 'ap'.

• two_four_ghz_settings (CreateNetworkWirelessRfProfileTwoFourGhzSettings | None, default: None ) –

  Settings related to 2.4Ghz band.

• five_ghz_settings (CreateNetworkWirelessRfProfileFiveGhzSettings | None, default: None ) –

  Settings related to 5Ghz band.

• six_ghz_settings (CreateNetworkWirelessRfProfileSixGhzSettings | None, default: None ) –

  Settings related to 6Ghz band. Only applicable to networks with 6Ghz capable APs.

• transmission (CreateNetworkWirelessRfProfileTransmission | None, default: None ) –

  Settings related to radio transmission.

• per_ssid_settings (CreateNetworkWirelessRfProfilePerSsidSettings | None, default: None ) –

  Per-SSID radio settings by number.

• flex_radios (CreateNetworkWirelessRfProfileFlexRadios | None, default: None ) –

  Flex radio settings.

Create an Identity PSK.

API documentation: createNetworkWirelessSsidIdentityPsk

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• name (str) –

  The name of the Identity PSK.

• passphrase (str | None, default: None ) –

  The passphrase for client authentication. If left blank, one will be auto- generated.

• group_policy_id (str) –

  The group policy to be applied to clients.

• expires_at (str | None, default: None ) –

  Timestamp for when the Identity PSK expires. Will not expire if left blank.

Create a zero touch deployment for a wireless access point.

API documentation: createOrganizationWirelessDevicesProvisioningDeployment

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[CreateOrganizationWirelessDevicesProvisioningDeploymentItemsItem]) –

  List of zero touch deployments to create.

• meta (CreateOrganizationWirelessDevicesProvisioningDeploymentMeta | None, default: None ) –

  Metadata relevant to the paginated dataset.

Add new receiver for scanning API.

API documentation: createOrganizationWirelessLocationScanningReceiver

Parameters:

• organization_id (str) –

  Organization ID.

• network (CreateOrganizationWirelessLocationScanningReceiverNetwork) –

  Add scanning API receiver for network.

• url (str) –

  Receiver Url.

• version (str) –

  Scanning API Version.

• radio (CreateOrganizationWirelessLocationScanningReceiverRadio) –

  Add scanning API Radio.

• shared_secret (str) –

  Secret Value for Receiver.

Create isolation allow list MAC entry for this organization.

API documentation: createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry

Parameters:

• organization_id (str) –

  Organization ID.

• description (str | None, default: None ) –

  The description of mac address.

• client (CreateOrganizationWirelessSsidsFirewallIsolationAllowlistEntryClient) –

  The client of allowlist.

• ssid (CreateOrganizationWirelessSsidsFirewallIsolationAllowlistEntrySsid) –

  The SSID that allowlist belongs to.

• network (CreateOrganizationWirelessSsidsFirewallIsolationAllowlistEntryNetwork) –

  The Network that allowlist belongs to.

Delete an Air Marshal rule.

API documentation: deleteNetworkWirelessAirMarshalRule

Parameters:

• network_id (str) –

  Network ID.

• rule_id (str) –

  Rule ID.

Delete an AP port profile.

API documentation: deleteNetworkWirelessEthernetPortsProfile

Parameters:

• network_id (str) –

  Network ID.

• profile_id (str) –

  Profile ID.

Delete a RF Profile.

API documentation: deleteNetworkWirelessRfProfile

Parameters:

• network_id (str) –

  Network ID.

• rf_profile_id (str) –

  Rf profile ID.

Delete an Identity PSK.

API documentation: deleteNetworkWirelessSsidIdentityPsk

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• identity_psk_id (str) –

  Identity psk ID.

Delete a zero touch deployment.

API documentation: deleteOrganizationWirelessDevicesProvisioningDeployment

Parameters:

• organization_id (str) –

  Organization ID.

• deployment_id (str) –

  Deployment ID.

Delete a scanning API receiver.

API documentation: deleteOrganizationWirelessLocationScanningReceiver

Parameters:

• organization_id (str) –

  Organization ID.

• receiver_id (str) –

  Receiver ID.

Destroy isolation allow list MAC entry for this organization.

API documentation: deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry

Parameters:

• organization_id (str) –

  Organization ID.

• entry_id (str) –

  Entry ID.

Recalculates automatically assigned channels for every AP within specified the specified network(s).

API documentation: recalculateOrganizationWirelessRadioAutoRfChannels

Parameters:

• organization_id (str) –

  Organization ID.

• network_ids (list[str]) –

  A list of network ids (limit: 15).

Set the AP port profile to be default for this network.

API documentation: setNetworkWirelessEthernetPortsProfilesDefault

Parameters:

• network_id (str) –

  Network ID.

• profile_id (str) –

  AP profile ID.

Update alternate management interface IPv6 address.

API documentation: updateDeviceWirelessAlternateManagementInterfaceIpv6

Parameters:

• serial (str) –

  Serial.

• addresses (list[UpdateDeviceWirelessAlternateManagementInterfaceIpv6AddressesItem] | None, default: None ) –

  configured alternate management interface addresses.

Update the bluetooth settings for a wireless device.

API documentation: updateDeviceWirelessBluetoothSettings

Parameters:

• serial (str) –

  Serial.

• uuid (str | None, default: None ) –

  Desired UUID of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.

• major (int | None, default: None ) –

  Desired major value of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.

• minor (int | None, default: None ) –

  Desired minor value of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.

Update the ESL settings of a device.

API documentation: updateDeviceWirelessElectronicShelfLabel

Parameters:

• serial (str) –

  Serial.

• channel (str | None, default: None ) –

  Desired ESL channel for the device, or 'Auto' (case insensitive) to use the recommended channel.

• enabled (bool | None, default: None ) –

  Turn ESL features on and off for this device.

Update 2.4 GHz and 5 GHz radio settings (channel, channel width, power) that override RF profiles.

API documentation: updateDeviceWirelessRadioSettings

Parameters:

• serial (str) –

  Serial.

• rf_profile_id (str | None, default: None ) –

  The ID of an RF profile to assign to the device. If the value of this parameter is null, the appropriate basic RF profile (indoor or outdoor) will be assigned to the device. Assigning an RF profile will clear ALL manually configured overrides on the device (channel width, channel, power).

• two_four_ghz_settings (UpdateDeviceWirelessRadioSettingsTwoFourGhzSettings | None, default: None ) –

  Manual radio settings for 2.4 GHz.

• five_ghz_settings (UpdateDeviceWirelessRadioSettingsFiveGhzSettings | None, default: None ) –

  Manual radio settings for 5 GHz.

Update a rule.

API documentation: updateNetworkWirelessAirMarshalRule

Parameters:

• network_id (str) –

  Network ID.

• rule_id (str) –

  Rule ID.

• type_ (UpdateNetworkWirelessAirMarshalRuleType | None, default: None ) –

  Indicates if this rule will allow, block, or alert.

• match (UpdateNetworkWirelessAirMarshalRuleMatch | None, default: None ) –

  Object describing the rule specification.

Updates Air Marshal settings.

API documentation: updateNetworkWirelessAirMarshalSettings

Parameters:

• network_id (str) –

  Network ID.

• default_policy (UpdateNetworkWirelessAirMarshalSettingsDefaultPolicy) –

  Allows clients to access rogue networks. Blocked by default.

Update alternate management interface and device static IP.

API documentation: updateNetworkWirelessAlternateManagementInterface

Parameters:

• network_id (str) –

  Network ID.

• enabled (bool | None, default: None ) –

  Boolean value to enable or disable alternate management interface.

• vlan_id (int | None, default: None ) –

  Alternate management interface VLAN, must be between 1 and 4094.

• protocols (UpdateNetworkWirelessAlternateManagementInterfaceProtocols | None, default: None ) –

  Can be one or more of the following values: 'radius', 'snmp', 'syslog' or 'ldap'.

• access_points (list[UpdateNetworkWirelessAlternateManagementInterfaceAccessPointsItem] | None, default: None ) –

  Array of access point serial number and IP assignment. Note: accessPoints IP assignment is not applicable for template networks, in other words, do not put 'accessPoints' in the body when updating template networks. Also, an empty 'accessPoints' array will remove all previous static IP assignments.

Update the billing settings.

API documentation: updateNetworkWirelessBilling

Parameters:

• network_id (str) –

  Network ID.

• currency (str | None, default: None ) –

  The currency code of this node group's billing plans.

• plans (list[UpdateNetworkWirelessBillingPlansItem] | None, default: None ) –

  Array of billing plans in the node group. (Can configure a maximum of 5).

Update the ESL settings of a wireless network.

API documentation: updateNetworkWirelessElectronicShelfLabel

Parameters:

• network_id (str) –

  Network ID.

• hostname (str | None, default: None ) –

  Desired ESL hostname of the network.

• enabled (bool | None, default: None ) –

  Turn ESL features on and off for this network.

• mode (UpdateNetworkWirelessElectronicShelfLabelMode | None, default: None ) –

  Electronic shelf label mode of the network. Valid options are 'Bluetooth', 'high frequency'.

Update the AP port profile by ID for this network.

API documentation: updateNetworkWirelessEthernetPortsProfile

Parameters:

• network_id (str) –

  Network ID.

• profile_id (str) –

  Profile ID.

• name (str | None, default: None ) –

  AP port profile name.

• ports (list[UpdateNetworkWirelessEthernetPortsProfilePortsItem] | None, default: None ) –

  AP ports configuration.

• usb_ports (list[UpdateNetworkWirelessEthernetPortsProfileUsbPortsItem] | None, default: None ) –

  AP usb ports configuration.

Change scanning API settings.

API documentation: updateNetworkWirelessLocationScanning

Parameters:

• network_id (str) –

  Network ID.

• enabled (bool | None, default: None ) –

  Collect location and scanning analytics.

• api (UpdateNetworkWirelessLocationScanningApi | None, default: None ) –

  Enable push API for scanning events, analytics must be enabled.

Update the AutoRF settings for a wireless network.

API documentation: updateNetworkWirelessRadioRrm

Parameters:

• network_id (str) –

  Network ID.

• busy_hour (UpdateNetworkWirelessRadioRrmBusyHour | None, default: None ) –

  Busy Hour settings.

• channel (UpdateNetworkWirelessRadioRrmChannel | None, default: None ) –

  Channel settings.

• fra (UpdateNetworkWirelessRadioRrmFra | None, default: None ) –

  FRA settings.

• ai (UpdateNetworkWirelessRadioRrmAi | None, default: None ) –

  AI settings.

Updates specified RF profile for this network.

API documentation: updateNetworkWirelessRfProfile

Parameters:

• network_id (str) –

  Network ID.

• rf_profile_id (str) –

  Rf profile ID.

• name (str | None, default: None ) –

  The name of the new profile. Must be unique.

• is_indoor_default (bool | None, default: None ) –

  Set this profile as the default indoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default.

• is_outdoor_default (bool | None, default: None ) –

  Set this profile as the default outdoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default.

• client_balancing_enabled (bool | None, default: None ) –

  Steers client to best available access point. Can be either true or false.

• min_bitrate_type (UpdateNetworkWirelessRfProfileMinBitrateType | None, default: None ) –

  Minimum bitrate can be set to either 'band' or 'ssid'.

• band_selection_type (UpdateNetworkWirelessRfProfileBandSelectionType | None, default: None ) –

  Band selection can be set to either 'ssid' or 'ap'.

• ap_band_settings (UpdateNetworkWirelessRfProfileApBandSettings | None, default: None ) –

  Settings that will be enabled if selectionType is set to 'ap'.

• two_four_ghz_settings (UpdateNetworkWirelessRfProfileTwoFourGhzSettings | None, default: None ) –

  Settings related to 2.4Ghz band.

• five_ghz_settings (UpdateNetworkWirelessRfProfileFiveGhzSettings | None, default: None ) –

  Settings related to 5Ghz band.

• six_ghz_settings (UpdateNetworkWirelessRfProfileSixGhzSettings | None, default: None ) –

  Settings related to 6Ghz band. Only applicable to networks with 6Ghz capable APs.

• transmission (UpdateNetworkWirelessRfProfileTransmission | None, default: None ) –

  Settings related to radio transmission.

• per_ssid_settings (UpdateNetworkWirelessRfProfilePerSsidSettings | None, default: None ) –

  Per-SSID radio settings by number.

• flex_radios (UpdateNetworkWirelessRfProfileFlexRadios | None, default: None ) –

  Flex radio settings.

Update the wireless settings for a network.

API documentation: updateNetworkWirelessSettings

Parameters:

• network_id (str) –

  Network ID.

• meshing_enabled (bool | None, default: None ) –

  Toggle for enabling or disabling meshing in a network.

• ipv6_bridge_enabled (bool | None, default: None ) –

  Toggle for enabling or disabling IPv6 bridging in a network (Note: if enabled, SSIDs must also be configured to use bridge mode).

• location_analytics_enabled (bool | None, default: None ) –

  Toggle for enabling or disabling location analytics for your network.

• upgrade_strategy (UpdateNetworkWirelessSettingsUpgradeStrategy | None, default: None ) –

  The default strategy that network devices will use to perform an upgrade. Requires firmware version MR 26.8 or higher.

• upgrade (UpdateNetworkWirelessSettingsUpgrade | None, default: None ) –

  Upgrade settings for the network.

• led_lights_on (bool | None, default: None ) –

  Toggle for enabling or disabling LED lights on all APs in the network (making them run dark).

• multicast_to_unicast_conversion (UpdateNetworkWirelessSettingsMulticastToUnicastConversion | None, default: None ) –

  Multicast-to-unicast conversion settings across the network.

• named_vlans (UpdateNetworkWirelessSettingsNamedVlans | None, default: None ) –

  Named VLAN settings for wireless networks.

Update the attributes of an MR SSID.

API documentation: updateNetworkWirelessSsid

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• name (str | None, default: None ) –

  The name of the SSID.

• enabled (bool | None, default: None ) –

  Whether or not the SSID is enabled.

• auth_mode (UpdateNetworkWirelessSsidAuthMode | None, default: None ) –

  The association control method for the SSID ('open', 'open-enhanced', 'psk', 'open-with-radius', 'open-enhanced-with-radius', 'open-with-nac', '8021x-meraki', '8021x-nac', '8021x-radius', '8021x-google', '8021x-entra', '8021x-localradius', 'ipsk-with-radius', 'ipsk-without- radius', 'ipsk-with-nac' or 'ipsk-with-radius-easy-psk').

• enterprise_admin_access (UpdateNetworkWirelessSsidEnterpriseAdminAccess | None, default: None ) –

  Whether or not an SSID is accessible by 'enterprise' administrators ('access disabled' or 'access enabled').

• ssid_admin_accessible (bool | None, default: None ) –

  SSID Administrator access status.

• encryption_mode (UpdateNetworkWirelessSsidEncryptionMode | None, default: None ) –

  The psk encryption mode for the SSID ('wep' or 'wpa'). This param is only valid if the authMode is 'psk'.

• psk (str | None, default: None ) –

  The passkey for the SSID. This param is only valid if the authMode is 'psk'.

• wpa_encryption_mode (UpdateNetworkWirelessSsidWpaEncryptionMode | None, default: None ) –

  The types of WPA encryption. ('WPA1 only', 'WPA1 and WPA2', 'WPA2 only', 'WPA3 Transition Mode', 'WPA3 only' or 'WPA3 192-bit Security').

• dot11w (UpdateNetworkWirelessSsidDot11w | None, default: None ) –

  The current setting for Protected Management Frames (802.11w).

• dot11r (UpdateNetworkWirelessSsidDot11r | None, default: None ) –

  The current setting for 802.11r.

• splash_page (UpdateNetworkWirelessSsidSplashPage | None, default: None ) –

  The type of splash page for the SSID ('None', 'Click-through splash page', 'Billing', 'Password-protected with Meraki RADIUS', 'Password-protected with custom RADIUS', 'Password-protected with Active Directory', 'Password-protected with LDAP', 'SMS authentication', 'Systems Manager Sentry', 'Facebook Wi-Fi', 'Google OAuth', 'Microsoft Entra ID', 'Sponsored guest', 'Cisco ISE' or 'Google Apps domain').This attribute is not supported for template children.

• splash_guest_sponsor_domains (list[str] | None, default: None ) –

  Array of valid sponsor email domains for sponsored guest splash type.

• oauth (UpdateNetworkWirelessSsidOauth | None, default: None ) –

  The OAuth settings of this SSID. Only valid if splashPage is 'Google OAuth'.

• local_radius (UpdateNetworkWirelessSsidLocalRadius | None, default: None ) –

  The current setting for Local Authentication, a built-in RADIUS server on the access point. Only valid if authMode is '8021x-localradius'.

• ldap (UpdateNetworkWirelessSsidLdap | None, default: None ) –

  The current setting for LDAP. Only valid if splashPage is 'Password-protected with LDAP'.

• active_directory (UpdateNetworkWirelessSsidActiveDirectory | None, default: None ) –

  The current setting for Active Directory. Only valid if splashPage is 'Password-protected with Active Directory'.

• radius_servers (list[UpdateNetworkWirelessSsidRadiusServersItem] | None, default: None ) –

  The RADIUS 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'.

• radius_proxy_enabled (bool | None, default: None ) –

  If true, Meraki devices will proxy RADIUS messages through the Meraki cloud to the configured RADIUS auth and accounting servers.

• radius_testing_enabled (bool | None, default: None ) –

  If true, Meraki devices will periodically send Access-Request messages to configured RADIUS servers using identity 'meraki_8021x_test' to ensure that the RADIUS servers are reachable.

• radius_called_station_id (str | None, default: None ) –

  The template of the called station identifier to be used for RADIUS (ex. $NODE_MAC$:$VAP_NUM$).

• radius_authentication_nas_id (str | None, default: None ) –

  The template of the NAS identifier to be used for RADIUS authentication (ex. $NODE_MAC$:$VAP_NUM$).

• radius_server_timeout (int | None, default: None ) –

  The amount of time for which a RADIUS client waits for a reply from the RADIUS server (must be between 1-10 seconds).

• radius_server_attempts_limit (int | None, default: None ) –

  The maximum number of transmit attempts after which a RADIUS server is failed over (must be between 1-5).

• radius_fallback_enabled (bool | None, default: None ) –

  Whether or not higher priority RADIUS servers should be retried after 60 seconds.

• radius_radsec (UpdateNetworkWirelessSsidRadiusRadsec | None, default: None ) –

  The current settings for RADIUS RADSec.

• radius_coa_enabled (bool | None, default: None ) –

  If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server.

• radius_failover_policy (UpdateNetworkWirelessSsidRadiusFailoverPolicy | None, default: None ) –

  This policy determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable ('Deny access' or 'Allow access').

• radius_load_balancing_policy (UpdateNetworkWirelessSsidRadiusLoadBalancingPolicy | None, default: None ) –

  This policy determines which RADIUS server will be contacted first in an authentication attempt and the ordering of any necessary retry attempts ('Strict priority order' or 'Round robin').

• radius_accounting_enabled (bool | None, default: None ) –

  Whether or not RADIUS accounting is enabled. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'.

• radius_accounting_servers (list[UpdateNetworkWirelessSsidRadiusAccountingServersItem] | None, default: None ) –

  The RADIUS accounting 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with- radius', '8021x-radius' or 'ipsk-with-radius' and radiusAccountingEnabled is 'true'.

• radius_accounting_interim_interval (int | None, default: None ) –

  The interval (in seconds) in which accounting information is updated and sent to the RADIUS accounting server.

• radius_attribute_for_group_policies (UpdateNetworkWirelessSsidRadiusAttributeForGroupPolicies | None, default: None ) –

  Specify the RADIUS attribute used to look up group policies ('Filter-Id', 'Reply-Message', 'Airespace-ACL-Name' or 'Aruba- User-Role'). Access points must receive this attribute in the RADIUS Access-Accept message.

• ip_assignment_mode (str | None, default: None ) –

  The client IP assignment mode ('NAT mode', 'Bridge mode', 'Layer 3 roaming', 'Ethernet over GRE', 'Layer 3 roaming with a concentrator', 'VPN' or 'Campus Gateway').

• use_vlan_tagging (bool | None, default: None ) –

  Whether or not traffic should be directed to use specific VLANs. This param is only valid if the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'.

• concentrator_network_id (str | None, default: None ) –

  The concentrator to use when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'.

• secondary_concentrator_network_id (str | None, default: None ) –

  The secondary concentrator to use when the ipAssignmentMode is 'VPN'. If configured, the APs will switch to using this concentrator if the primary concentrator is unreachable. This param is optional. ('disabled' represents no secondary concentrator.).

• disassociate_clients_on_vpn_failover (bool | None, default: None ) –

  Disassociate clients when 'VPN' concentrator failover occurs in order to trigger clients to re-associate and generate new DHCP requests. This param is only valid if ipAssignmentMode is 'VPN'.

• vlan_id (int | None, default: None ) –

  The VLAN ID used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'.

• default_vlan_id (int | None, default: None ) –

  The default VLAN ID used for 'all other APs'. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'.

• ap_tags_and_vlan_ids (list[UpdateNetworkWirelessSsidApTagsAndVlanIdsItem] | None, default: None ) –

  The list of tags and VLAN IDs used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'.

• walled_garden_enabled (bool | None, default: None ) –

  Allow access to a configurable list of IP ranges, which users may access prior to sign-on.

• walled_garden_ranges (list[str] | None, default: None ) –

  Specify your walled garden by entering an array of addresses, ranges using CIDR notation, domain names, and domain wildcards (e.g. '192.168.1.1/24', '192.168.37.10/32', 'www.yahoo.com', '*.google.com']). Meraki's splash page is automatically included in your walled garden.

• gre (UpdateNetworkWirelessSsidGre | None, default: None ) –

  Ethernet over GRE settings.

• radius_override (bool | None, default: None ) –

  If true, the RADIUS response can override VLAN tag. This is not valid when ipAssignmentMode is 'NAT mode'.

• radius_guest_vlan_enabled (bool | None, default: None ) –

  Whether or not RADIUS Guest VLAN is enabled. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode.

• radius_guest_vlan_id (int | None, default: None ) –

  VLAN ID of the RADIUS Guest VLAN. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode.

• min_bitrate (float | None, default: None ) –

  The minimum bitrate in Mbps of this SSID in the default indoor RF profile. ('1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54').

• band_selection (str | None, default: None ) –

  The client-serving radio frequencies of this SSID in the default indoor RF profile. ('Dual band operation', '5 GHz band only' or 'Dual band operation with Band Steering').

• per_client_bandwidth_limit_up (int | None, default: None ) –

  The upload bandwidth limit in Kbps. (0 represents no limit.).

• per_client_bandwidth_limit_down (int | None, default: None ) –

  The download bandwidth limit in Kbps. (0 represents no limit.).

• per_ssid_bandwidth_limit_up (int | None, default: None ) –

  The total upload bandwidth limit in Kbps. (0 represents no limit.).

• per_ssid_bandwidth_limit_down (int | None, default: None ) –

  The total download bandwidth limit in Kbps. (0 represents no limit.).

• lan_isolation_enabled (bool | None, default: None ) –

  Boolean indicating whether Layer 2 LAN isolation should be enabled or disabled. Only configurable when ipAssignmentMode is 'Bridge mode'.

• visible (bool | None, default: None ) –

  Boolean indicating whether APs should advertise or hide this SSID. APs will only broadcast this SSID if set to true.

• available_on_all_aps (bool | None, default: None ) –

  Boolean indicating whether all APs should broadcast the SSID or if it should be restricted to APs matching any availability tags. Can only be false if the SSID has availability tags.

• availability_tags (list[str] | None, default: None ) –

  Accepts a list of tags for this SSID. If availableOnAllAps is false, then the SSID will only be broadcast by APs with tags matching any of the tags in this list.

• adaptive_policy_group_id (str | None, default: None ) –

  Adaptive policy group ID this SSID is assigned to.

• mandatory_dhcp_enabled (bool | None, default: None ) –

  If true, Mandatory DHCP will enforce that clients connecting to this SSID must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate.

• adult_content_filtering_enabled (bool | None, default: None ) –

  Boolean indicating whether or not adult content will be blocked.

• dns_rewrite (UpdateNetworkWirelessSsidDnsRewrite | None, default: None ) –

  DNS servers rewrite settings.

• speed_burst (UpdateNetworkWirelessSsidSpeedBurst | None, default: None ) –

  The SpeedBurst setting for this SSID'.

• named_vlans (UpdateNetworkWirelessSsidNamedVlans | None, default: None ) –

  Named VLAN settings.

• local_auth_fallback (UpdateNetworkWirelessSsidLocalAuthFallback | None, default: None ) –

  The current configuration for Local Authentication Fallback. Enables the Access Point (AP) to store client authentication data for a specified duration that can be adjusted as needed.

• radius_accounting_start_delay (int | None, default: None ) –

  The delay (in seconds) before sending the first RADIUS accounting start message. Must be between 0 and 60 seconds.

Update the bonjour forwarding setting and rules for the SSID.

API documentation: updateNetworkWirelessSsidBonjourForwarding

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• enabled (bool | None, default: None ) –

  If true, Bonjour forwarding is enabled on this SSID.

• rules (list[UpdateNetworkWirelessSsidBonjourForwardingRulesItem] | None, default: None ) –

  List of bonjour forwarding rules.

• exception (UpdateNetworkWirelessSsidBonjourForwardingException | None, default: None ) –

  Bonjour forwarding exception.

Update the device type group policies for the SSID.

API documentation: updateNetworkWirelessSsidDeviceTypeGroupPolicies

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• enabled (bool | None, default: None ) –

  If true, the SSID device type group policies are enabled.

• device_type_policies (list[UpdateNetworkWirelessSsidDeviceTypeGroupPoliciesDeviceTypePoliciesItem] | None, default: None ) –

  List of device type policies.

Update the EAP overridden parameters for an SSID.

API documentation: updateNetworkWirelessSsidEapOverride

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• timeout (int | None, default: None ) –

  General EAP timeout in seconds.

• identity (UpdateNetworkWirelessSsidEapOverrideIdentity | None, default: None ) –

  EAP settings for identity requests.

• max_retries (int | None, default: None ) –

  Maximum number of general EAP retries.

• eapol_key (UpdateNetworkWirelessSsidEapOverrideEapolKey | None, default: None ) –

  EAPOL Key settings.

Update the L3 firewall rules of an SSID on an MR network.

API documentation: updateNetworkWirelessSsidFirewallL3FirewallRules

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• rules (list[UpdateNetworkWirelessSsidFirewallL3FirewallRulesRulesItem] | None, default: None ) –

  An ordered array of the firewall rules for this SSID.

• allow_lan_access (bool | None, default: None ) –

  Allow wireless client access to local LAN (boolean value - true allows access and false denies access) (optional).

Update the L7 firewall rules of an SSID on an MR network.

API documentation: updateNetworkWirelessSsidFirewallL7FirewallRules

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• rules (list[UpdateNetworkWirelessSsidFirewallL7FirewallRulesRulesItem] | None, default: None ) –

  An array of L7 firewall rules for this SSID. Rules will get applied in the same order user has specified in request. Empty array will clear the L7 firewall rule configuration.

Update the Hotspot 2.0 settings of an SSID.

API documentation: updateNetworkWirelessSsidHotspot20

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• enabled (bool | None, default: None ) –

  Whether or not Hotspot 2.0 for this SSID is enabled.

• operator (UpdateNetworkWirelessSsidHotspot20Operator | None, default: None ) –

  Operator settings for this SSID.

• venue (UpdateNetworkWirelessSsidHotspot20Venue | None, default: None ) –

  Venue settings for this SSID.

• network_access_type (UpdateNetworkWirelessSsidHotspot20NetworkAccessType | None, default: None ) –

  The network type of this SSID ('Private network', 'Private network with guest access', 'Chargeable public network', 'Free public network', 'Personal device network', 'Emergency services only network', 'Test or experimental', 'Wildcard').

• domains (list[str] | None, default: None ) –

  An array of domain names.

• roam_consort_ois (list[str] | None, default: None ) –

  An array of roaming consortium OIs (hexadecimal number 3-5 octets in length).

• mcc_mncs (list[UpdateNetworkWirelessSsidHotspot20MccMncsItem] | None, default: None ) –

  An array of MCC/MNC pairs.

• nai_realms (list[UpdateNetworkWirelessSsidHotspot20NaiRealmsItem] | None, default: None ) –

  An array of NAI realms.

Update an Identity PSK.

API documentation: updateNetworkWirelessSsidIdentityPsk

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• identity_psk_id (str) –

  Identity psk ID.

• name (str | None, default: None ) –

  The name of the Identity PSK.

• passphrase (str | None, default: None ) –

  The passphrase for client authentication.

• group_policy_id (str | None, default: None ) –

  The group policy to be applied to clients.

• expires_at (str | None, default: None ) –

  Timestamp for when the Identity PSK expires, or 'null' to never expire.

Update the OpenRoaming setting for the SSID.

API documentation: updateNetworkWirelessSsidOpenRoaming

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• enabled (bool | None, default: None ) –

  If true, OpenRoaming is enabled on this SSID.

• tenant_id (str | None, default: None ) –

  The OpenRoaming DNA Spaces tenant ID.

Update the outage schedule for the SSID.

API documentation: updateNetworkWirelessSsidSchedules

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• enabled (bool | None, default: None ) –

  If true, the SSID outage schedule is enabled.

• ranges (list[UpdateNetworkWirelessSsidSchedulesRangesItem] | None, default: None ) –

  List of outage ranges. Has a start date and time, and end date and time. If this parameter is passed in along with rangesInSeconds parameter, this will take precedence.

• ranges_in_seconds (list[UpdateNetworkWirelessSsidSchedulesRangesInSecondsItem] | None, default: None ) –

  List of outage ranges in seconds since Sunday at Midnight. Has a start and end. If this parameter is passed in along with the ranges parameter, ranges will take precedence.

Modify the splash page settings for the given SSID.

API documentation: updateNetworkWirelessSsidSplashSettings

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• splash_url (str | None, default: None ) –

  [optional] The custom splash URL of the click-through splash page. Note that the URL can be configured without necessarily being used. In order to enable the custom URL, see 'useSplashUrl'.

• use_splash_url (bool | None, default: None ) –

  [optional] Boolean indicating whether the users will be redirected to the custom splash url. A custom splash URL must be set if this is true. Note that depending on your SSID's access control settings, it may not be possible to use the custom splash URL.

• splash_timeout (UpdateNetworkWirelessSsidSplashSettingsSplashTimeout | None, default: None ) –

  Splash timeout in minutes. This will determine how often users will see the splash page.

• redirect_url (str | None, default: None ) –

  The custom redirect URL where the users will go after the splash page.

• use_redirect_url (bool | None, default: None ) –

  The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. A custom redirect URL must be set if this is true.

• welcome_message (str | None, default: None ) –

  The welcome message for the users on the splash page.

• theme_id (str | None, default: None ) –

  The id of the selected splash theme.

• splash_logo (UpdateNetworkWirelessSsidSplashSettingsSplashLogo | None, default: None ) –

  The logo used in the splash page.

• splash_image (UpdateNetworkWirelessSsidSplashSettingsSplashImage | None, default: None ) –

  The image used in the splash page.

• splash_prepaid_front (UpdateNetworkWirelessSsidSplashSettingsSplashPrepaidFront | None, default: None ) –

  The prepaid front image used in the splash page.

• block_all_traffic_before_sign_on (bool | None, default: None ) –

  How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged.

• controller_disconnection_behavior (UpdateNetworkWirelessSsidSplashSettingsControllerDisconnectionBehavior | None, default: None ) –

  How login attempts should be handled when the controller is unreachable. Can be either 'open', 'restricted', or 'default'.

• allow_simultaneous_logins (bool | None, default: None ) –

  Whether or not to allow simultaneous logins from different devices.

• guest_sponsorship (UpdateNetworkWirelessSsidSplashSettingsGuestSponsorship | None, default: None ) –

  Details associated with guest sponsored splash.

• billing (UpdateNetworkWirelessSsidSplashSettingsBilling | None, default: None ) –

  Details associated with billing splash.

• sentry_enrollment (UpdateNetworkWirelessSsidSplashSettingsSentryEnrollment | None, default: None ) –

  Systems Manager sentry enrollment splash settings.

• self_registration (UpdateNetworkWirelessSsidSplashSettingsSelfRegistration | None, default: None ) –

  Self-registration settings for splash with Meraki authentication.

Update the traffic shaping rules for an SSID on an MR network.

API documentation: updateNetworkWirelessSsidTrafficShapingRules

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• traffic_shaping_enabled (bool | None, default: None ) –

  Whether traffic shaping rules are applied to clients on your SSID.

• default_rules_enabled (bool | None, default: None ) –

  Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.

• rules (list[UpdateNetworkWirelessSsidTrafficShapingRulesRulesItem] | None, default: None ) –

  An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.

Update the VPN settings for the SSID.

API documentation: updateNetworkWirelessSsidVpn

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• concentrator (UpdateNetworkWirelessSsidVpnConcentrator | None, default: None ) –

  The VPN concentrator settings for this SSID.

• split_tunnel (UpdateNetworkWirelessSsidVpnSplitTunnel | None, default: None ) –

  The VPN split tunnel settings for this SSID.

• failover (UpdateNetworkWirelessSsidVpnFailover | None, default: None ) –

  Secondary VPN concentrator settings. This is only used when two VPN concentrators are configured on the SSID.

Update Zigbee Configs for specified network.

API documentation: updateNetworkWirelessZigbee

Parameters:

• network_id (str) –

  Network ID.

• enabled (bool | None, default: None ) –

  To enable/disable Zigbee on the network.

• iot_controller (UpdateNetworkWirelessZigbeeIotController | None, default: None ) –

  Zigbee's IoT controller details.

• lock_management (UpdateNetworkWirelessZigbeeLockManagement | None, default: None ) –

  Login Credentials of on-premises lock management.

• defaults (UpdateNetworkWirelessZigbeeDefaults | None, default: None ) –

  Default Settings for Zigbee Devices.

Update a zero touch deployment.

API documentation: updateOrganizationWirelessDevicesProvisioningDeployments

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[UpdateOrganizationWirelessDevicesProvisioningDeploymentsItemsItem]) –

  List of zero touch deployments to create.

• meta (UpdateOrganizationWirelessDevicesProvisioningDeploymentsMeta | None, default: None ) –

  Metadata relevant to the paginated dataset.

Change scanning API receiver settings.

API documentation: updateOrganizationWirelessLocationScanningReceiver

Parameters:

• organization_id (str) –

  Organization ID.

• receiver_id (str) –

  Receiver ID.

• url (str | None, default: None ) –

  Receiver Url.

• version (str | None, default: None ) –

  Scanning API Version.

• radio (UpdateOrganizationWirelessLocationScanningReceiverRadio | None, default: None ) –

  Add scanning API Radio.

Add new broker config for wireless MQTT.

API documentation: updateOrganizationWirelessMqttSettings

Parameters:

• organization_id (str) –

  Organization ID.

• network (UpdateOrganizationWirelessMqttSettingsNetwork) –

  Add MQTT Settings for network.

• mqtt (UpdateOrganizationWirelessMqttSettingsMqtt) –

  MQTT Settings for network.

• ble (UpdateOrganizationWirelessMqttSettingsBle | None, default: None ) –

  MQTT BLE Settings for network.

• wifi (UpdateOrganizationWirelessMqttSettingsWifi | None, default: None ) –

  MQTT Wi-Fi Settings for network.

Update isolation allow list MAC entry info.

API documentation: updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry

Parameters:

• organization_id (str) –

  Organization ID.

• entry_id (str) –

  Entry ID.

• description (str | None, default: None ) –

  The description of mac address.

• client (UpdateOrganizationWirelessSsidsFirewallIsolationAllowlistEntryClient | None, default: None ) –

  The client of allowlist.

Endpoint to update zigbee gateways.

API documentation: updateOrganizationWirelessZigbeeDevice

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

• enrolled (bool) –

  Parameter to enroll or unenroll the zigbee devices.

• channel (str | None, default: None ) –

  The new channel for the zigbee device.

Endpoint to batch update door locks params.

API documentation: updateOrganizationWirelessZigbeeDoorLock

Parameters:

• organization_id (str) –

  Organization ID.

• door_lock_id (str) –

  Door lock ID.

• name (str | None, default: None ) –

  Door lock name to update.