Networks (Batch)

Schedule auto locate jobs for one or more floor plans in a network.

API documentation: batchNetworkFloorPlansAutoLocateJobs

Parameters:

• network_id (str) –

  Network ID.

• jobs (list[BatchNetworkFloorPlansAutoLocateJobsJobsItem]) –

  The list of auto locate jobs to be scheduled. Up to 100 jobs can be provided in a request.

Update floorplan assignments for a batch of devices.

API documentation: batchNetworkFloorPlansDevicesUpdate

Parameters:

• network_id (str) –

  Network ID.

• assignments (list[BatchNetworkFloorPlansDevicesUpdateAssignmentsItem]) –

  List of floorplan assignments to update. Up to 100 floor plan assignments can be provided in a request.

Bind a network to a template.

API documentation: bindNetwork

Parameters:

• network_id (str) –

  Network ID.

• config_template_id (str) –

  The ID of the template to which the network should be bound.

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

  Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. Defaults to false if left unspecified. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model.

Cancel a scheduled or running auto locate job.

API documentation: cancelNetworkFloorPlansAutoLocateJob

Parameters:

• network_id (str) –

  Network ID.

• job_id (str) –

  Job ID.

Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requests against that device to succeed).

API documentation: claimNetworkDevices

Parameters:

• network_id (str) –

  Network ID.

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

  Whether to claim devices atomically. If true, all devices will be claimed or none will be claimed. Default is true.

• serials (list[str]) –

  A list of serials of devices to claim.

• details_by_device (list[ClaimNetworkDevicesDetailsByDeviceItem] | None, default: None ) –

  Optional details for claimed devices (currently only used for Catalyst devices).

Rollback a Firmware Upgrade For A Network.

API documentation: createNetworkFirmwareUpgradesRollback

Parameters:

• network_id (str) –

  Network ID.

• product (CreateNetworkFirmwareUpgradesRollbackProduct | None, default: None ) –

  Product type to rollback (if the network is a combined network).

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

  Scheduled time for the rollback.

• reasons (list[CreateNetworkFirmwareUpgradesRollbackReasonsItem]) –

  Reasons for the rollback.

• to_version (CreateNetworkFirmwareUpgradesRollbackToVersion | None, default: None ) –

  Version to downgrade to (if the network has firmware flexibility).

• predownload (CreateNetworkFirmwareUpgradesRollbackPredownload | None, default: None ) –

  Predownload settings for the firmware upgrade.

Create a Staged Upgrade Group for a network.

API documentation: createNetworkFirmwareUpgradesStagedGroup

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  Name of the Staged Upgrade Group. Length must be 1 to 255 characters.

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

  Description of the Staged Upgrade Group. Length must be 1 to 255 characters.

• is_default (bool) –

  Boolean indicating the default Group. Any device that does not have a group explicitly assigned will upgrade with this group.

• assigned_devices (CreateNetworkFirmwareUpgradesStagedGroupAssignedDevices | None, default: None ) –

  The devices and Switch Stacks assigned to the Group.

Create a group policy.

API documentation: createNetworkGroupPolicy

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name for your group policy. Required.

• scheduling (CreateNetworkGroupPolicyScheduling | None, default: None ) –

  The schedule for the group policy. Schedules are applied to days of the week.

• bandwidth (CreateNetworkGroupPolicyBandwidth | None, default: None ) –

  The bandwidth settings for clients bound to your group policy.

• firewall_and_traffic_shaping (CreateNetworkGroupPolicyFirewallAndTrafficShaping | None, default: None ) –

  The firewall and traffic shaping rules and settings for your policy.

• content_filtering (CreateNetworkGroupPolicyContentFiltering | None, default: None ) –

  The content filtering settings for your group policy.

• splash_auth_settings (CreateNetworkGroupPolicySplashAuthSettings | None, default: None ) –

  Whether clients bound to your policy will bypass splash authorization or behave according to the network's rules. Can be one of 'network default' or 'bypass'. Only available if your network has a wireless configuration.

• vlan_tagging (CreateNetworkGroupPolicyVlanTagging | None, default: None ) –

  The VLAN tagging settings for your group policy. Only available if your network has a wireless configuration.

• bonjour_forwarding (CreateNetworkGroupPolicyBonjourForwarding | None, default: None ) –

  The Bonjour settings for your group policy. Only valid if your network has a wireless configuration.

Authorize a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap).

API documentation: createNetworkMerakiAuthUser

Parameters:

• network_id (str) –

  Network ID.

• email (str) –

  Email address of the user.

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

  Name of the user. Only required If the user is not a Dashboard administrator.

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

  The password for this user account. Only required If the user is not a Dashboard administrator.

• account_type (CreateNetworkMerakiAuthUserAccountType | None, default: None ) –

  Authorization type for user. Can be 'Guest' or '802.1X' for wireless networks, or 'Client VPN' for MX networks. Defaults to '802.1X'.

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

  Whether or not Meraki should email the password to user. Default is false.

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

  Whether or not the user is a Dashboard administrator.

• authorizations (list[CreateNetworkMerakiAuthUserAuthorizationsItem]) –

  Authorization zones and expiration dates for the user.

Add an MQTT broker.

API documentation: createNetworkMqttBroker

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  Name of the MQTT broker.

• host (str) –

  Host name/IP address where the MQTT broker runs.

• port (int) –

  Host port though which the MQTT broker can be reached.

• security (CreateNetworkMqttBrokerSecurity | None, default: None ) –

  Security settings of the MQTT broker.

• authentication (CreateNetworkMqttBrokerAuthentication | None, default: None ) –

  Authentication settings of the MQTT broker.

Create a VLAN profile for a network.

API documentation: createNetworkVlanProfile

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  Name of the profile, string length must be from 1 to 255 characters.

• vlan_names (list[CreateNetworkVlanProfileVlanNamesItem]) –

  An array of named VLANs.

• vlan_groups (list[CreateNetworkVlanProfileVlanGroupsItem]) –

  An array of VLAN groups.

• iname (str) –

  IName of the profile.

Create a webhook payload template for a network.

API documentation: createNetworkWebhooksPayloadTemplate

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name of the new template.

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

  The liquid template used for the body of the webhook message. Either body or bodyFile must be specified.

• headers (list[CreateNetworkWebhooksPayloadTemplateHeadersItem] | None, default: None ) –

  The liquid template used with the webhook headers.

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

  A Base64 encoded file containing liquid template used for the body of the webhook message. Either body or bodyFile must be specified.

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

  A Base64 encoded file containing the liquid template used with the webhook headers.

Delete a network.

API documentation: deleteNetwork

Parameters:

• network_id (str) –

  Network ID.

Delete a Staged Upgrade Group.

API documentation: deleteNetworkFirmwareUpgradesStagedGroup

Parameters:

• network_id (str) –

  Network ID.

• group_id (str) –

  Group ID.

Destroy a floor plan.

API documentation: deleteNetworkFloorPlan

Parameters:

• network_id (str) –

  Network ID.

• floor_plan_id (str) –

  Floor plan ID.

Delete a group policy.

API documentation: deleteNetworkGroupPolicy

Parameters:

• network_id (str) –

  Network ID.

• group_policy_id (str) –

  Group policy ID.

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

  If true, the system deletes the GP even if there are active clients using the GP. After deletion, active clients that were assigned to that Group Policy will be left without any policy applied. Default is false.

Delete an 802.1X RADIUS user, or deauthorize and optionally delete a splash guest or client VPN user.

API documentation: deleteNetworkMerakiAuthUser

Parameters:

• network_id (str) –

  Network ID.

• meraki_auth_user_id (str) –

  Meraki auth user ID.

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

  If the ID supplied is for a splash guest or client VPN user, and that user is not authorized for any other networks in the organization, then also delete the user. 802.1X RADIUS users are always deleted regardless of this optional attribute.

Delete an MQTT broker.

API documentation: deleteNetworkMqttBroker

Parameters:

• network_id (str) –

  Network ID.

• mqtt_broker_id (str) –

  Mqtt broker ID.

Delete a VLAN profile of a network.

API documentation: deleteNetworkVlanProfile

Parameters:

• network_id (str) –

  Network ID.

• iname (str) –

  Iname.

Destroy a webhook payload template for a network.

API documentation: deleteNetworkWebhooksPayloadTemplate

Parameters:

• network_id (str) –

  Network ID.

• payload_template_id (str) –

  Payload template ID.

Provisions a client with a name and policy.

API documentation: provisionNetworkClients

Parameters:

• network_id (str) –

  Network ID.

• clients (list[ProvisionNetworkClientsClientsItem]) –

  The array of clients to provision.

• device_policy (ProvisionNetworkClientsDevicePolicy) –

  The policy to apply to the specified client. Can be 'Group policy', 'Allowed', 'Blocked', 'Per connection' or 'Normal'. Required.

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

  The ID of the desired group policy to apply to the client. Required if 'devicePolicy' is set to "Group policy". Otherwise this is ignored.

• policies_by_security_appliance (ProvisionNetworkClientsPoliciesBySecurityAppliance | None, default: None ) –

  An object, describing what the policy-connection association is for the security appliance. (Only relevant if the security appliance is actually within the network).

• policies_by_ssid (ProvisionNetworkClientsPoliciesBySsid | None, default: None ) –

  An object, describing the policy-connection associations for each active SSID within the network. Keys should be the number of enabled SSIDs, mapping to an object describing the client's policy.

Update the status of a finished auto locate job to be published, and update device locations.

API documentation: publishNetworkFloorPlansAutoLocateJob

Parameters:

• network_id (str) –

  Network ID.

• job_id (str) –

  Job ID.

• devices (list[PublishNetworkFloorPlansAutoLocateJobDevicesItem] | None, default: None ) –

  The list of devices to publish positions for.

Trigger auto locate recalculation for a job, and optionally set anchors.

API documentation: recalculateNetworkFloorPlansAutoLocateJob

Parameters:

• network_id (str) –

  Network ID.

• job_id (str) –

  Job ID.

• devices (list[RecalculateNetworkFloorPlansAutoLocateJobDevicesItem] | None, default: None ) –

  The list of devices to update anchor positions for.

Remove a single device.

API documentation: removeNetworkDevices

Parameters:

• network_id (str) –

  Network ID.

• serial (str) –

  The serial of a device.

Split a combined network into individual networks for each type of device.

API documentation: splitNetwork

Parameters:

• network_id (str) –

  Network ID.

Unbind a network from a template.

API documentation: unbindNetwork

Parameters:

• network_id (str) –

  Network ID.

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

  Optional boolean to retain all the current configs given by the template.

Update a network.

API documentation: updateNetwork

Parameters:

• network_id (str) –

  Network ID.

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

  The name of the network.

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

  The timezone of the network. For a list of allowed timezones, please see the 'TZ' column in the table in this article..

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

  A list of tags to be applied to the network.

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

  A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break.

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

  Add any notes or additional information about this network here.

Update firmware upgrade information for a network.

API documentation: updateNetworkFirmwareUpgrades

Parameters:

• network_id (str) –

  Network ID.

• upgrade_window (UpdateNetworkFirmwareUpgradesUpgradeWindow | None, default: None ) –

  Upgrade window for devices in network.

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

  The timezone for the network.

• products (UpdateNetworkFirmwareUpgradesProducts | None, default: None ) –

  Contains information about the network to update.

Update a floor plan's geolocation and other meta data.

API documentation: updateNetworkFloorPlan

Parameters:

• network_id (str) –

  Network ID.

• floor_plan_id (str) –

  Floor plan ID.

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

  The name of your floor plan.

• center (UpdateNetworkFloorPlanCenter | None, default: None ) –

  The longitude and latitude of the center of your floor plan. If you want to change the geolocation data of your floor plan, either the 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.

• bottom_left_corner (UpdateNetworkFloorPlanBottomLeftCorner | None, default: None ) –

  The longitude and latitude of the bottom left corner of your floor plan.

• bottom_right_corner (UpdateNetworkFloorPlanBottomRightCorner | None, default: None ) –

  The longitude and latitude of the bottom right corner of your floor plan.

• top_left_corner (UpdateNetworkFloorPlanTopLeftCorner | None, default: None ) –

  The longitude and latitude of the top left corner of your floor plan.

• top_right_corner (UpdateNetworkFloorPlanTopRightCorner | None, default: None ) –

  The longitude and latitude of the top right corner of your floor plan.

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

  The floor number of the floors within the building.

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

  The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.

Update a group policy.

API documentation: updateNetworkGroupPolicy

Parameters:

• network_id (str) –

  Network ID.

• group_policy_id (str) –

  Group policy ID.

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

  The name for your group policy.

• scheduling (UpdateNetworkGroupPolicyScheduling | None, default: None ) –

  The schedule for the group policy. Schedules are applied to days of the week.

• bandwidth (UpdateNetworkGroupPolicyBandwidth | None, default: None ) –

  The bandwidth settings for clients bound to your group policy.

• firewall_and_traffic_shaping (UpdateNetworkGroupPolicyFirewallAndTrafficShaping | None, default: None ) –

  The firewall and traffic shaping rules and settings for your policy.

• content_filtering (UpdateNetworkGroupPolicyContentFiltering | None, default: None ) –

  The content filtering settings for your group policy.

• splash_auth_settings (UpdateNetworkGroupPolicySplashAuthSettings | None, default: None ) –

  Whether clients bound to your policy will bypass splash authorization or behave according to the network's rules. Can be one of 'network default' or 'bypass'. Only available if your network has a wireless configuration.

• vlan_tagging (UpdateNetworkGroupPolicyVlanTagging | None, default: None ) –

  The VLAN tagging settings for your group policy. Only available if your network has a wireless configuration.

• bonjour_forwarding (UpdateNetworkGroupPolicyBonjourForwarding | None, default: None ) –

  The Bonjour settings for your group policy. Only valid if your network has a wireless configuration.

Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be updated).

API documentation: updateNetworkMerakiAuthUser

Parameters:

• network_id (str) –

  Network ID.

• meraki_auth_user_id (str) –

  Meraki auth user ID.

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

  Name of the user. Only allowed If the user is not Dashboard administrator.

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

  The password for this user account. Only allowed If the user is not Dashboard administrator.

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

  Whether or not Meraki should email the password to user. Default is false.

• authorizations (list[UpdateNetworkMerakiAuthUserAuthorizationsItem] | None, default: None ) –

  Authorization zones and expiration dates for the user.

Update an MQTT broker.

API documentation: updateNetworkMqttBroker

Parameters:

• network_id (str) –

  Network ID.

• mqtt_broker_id (str) –

  Mqtt broker ID.

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

  Name of the MQTT broker.

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

  Host name/IP address where the MQTT broker runs.

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

  Host port though which the MQTT broker can be reached.

• security (UpdateNetworkMqttBrokerSecurity | None, default: None ) –

  Security settings of the MQTT broker.

• authentication (UpdateNetworkMqttBrokerAuthentication | None, default: None ) –

  Authentication settings of the MQTT broker.

Update the settings for a network.

API documentation: updateNetworkSettings

Parameters:

• network_id (str) –

  Network ID.

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

  Enables / disables the local device status pages (my.meraki.com, ap.meraki.com, switch.meraki.com, wired.meraki.com). Optional (defaults to false).

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

  Enables / disables access to the device status page (http://[device's LAN IP]). Optional. Can only be set if localStatusPageEnabled is set to true.

• local_status_page (UpdateNetworkSettingsLocalStatusPage | None, default: None ) –

  A hash of Local Status page(s)' authentication options applied to the Network.

• secure_port (UpdateNetworkSettingsSecurePort | None, default: None ) –

  A hash of SecureConnect options applied to the Network.

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

  A hash of Named VLANs options applied to the Network.

Update a webhook payload template for a network.

API documentation: updateNetworkWebhooksPayloadTemplate

Parameters:

• network_id (str) –

  Network ID.

• payload_template_id (str) –

  Payload template ID.

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

  The name of the template.

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

  The liquid template used for the body of the webhook message.

• headers (list[UpdateNetworkWebhooksPayloadTemplateHeadersItem] | None, default: None ) –

  The liquid template used with the webhook headers.

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

  A file containing liquid template used for the body of the webhook message.

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

  A file containing the liquid template used with the webhook headers.

Claim a vMX into a network.

API documentation: vmxNetworkDevicesClaim

Parameters:

• network_id (str) –

  Network ID.

• size (VmxNetworkDevicesClaimSize) –

  The size of the vMX you claim. It can be one of: small, medium, large, xlarge, 100.