Package: meraki-sdk
Getting startedThe Cisco Meraki Dashboard API is a modern REST API based on theOpenAPIspecification.What can the API be used for?The Dashboard API can be used for many purposes. It's meant to be an open-ended tool. Here are some examples of use cases:Add new organizations, admins, networks, devices, VLANs, and moreConfigure networks at scaleAutomatically on-board and off-board new employees' teleworker setupsBuild your own dashboard for store managers, field techs, or unique use casesEnabling the Dashboard APIBegin by logging intoMeraki Dashboardand navigating toOrganization > SettingsLocate the section titledDashboard API accessand selectEnable Access, thenSaveyour changesAfter enabling the API, choose your username at the top-right of the Meraki Dashboard and selectmy profileLocate the section titledDashboard API accessand selectGenerate new API keyNote: The API key is associated with a Dashboard administrator account. You can generate, revoke, and regenerate your API key on your profile.Keep your API key safe as it provides authentication to all of your organizations with the API enabled. If your API key is shared, you can regenerate your API key at any time. This will revoke the existing API key.Copy and store your API key in a safe place. Dashboard does not store API keys in plaintext for security reasons, so this is the only time you will be able to record it. If you lose or forget your API key, you will have to revoke it and generate a new one.Every request must specify an API key via a request header.The API key must be specified in the URL header. The API will return a 404 (rather than a 403) in response to a request with a missing or incorrect API key in order to prevent leaking the existence of resources to unauthorized users.X-Cisco-Meraki-API-Key: <secret key>Read more about APIauthorizationVersioningOnce an API version is released, we will make only backwards-compatible changes to it. Backwards-compatible changes include:Adding new API resourcesAdding new optional request parameters to existing API methodsAdding new properties to existing API responsesChanging the order of properties in existing API responsesRate LimitThe Dashboard API is limited to5 calls per second, per organization.A burst of 5 additional calls are allowed in the first second, so a maximum of 15 calls in the first 2 seconds.The rate limiting technique is based off of thetoken bucket model.An error with a429status code will be returned when the rate limit has been exceeded.Expect to backoff for 1 - 2 seconds if the limit has been exceeded. You may have to wait potentially longer if a large number of requests were made within this timeframe.Additional DetailsIdentifiers in the API are opaque strings. A{networkId}, for example, might be the string "126043", whereas an{orderId}might contain characters, such as "4S1234567". Client applications must not try to parse them as numbers. Even identifiers that look like numbers might be too long to encode without loss of precision in Javascript, where the only numeric type is IEEE 754 floating point.Verbs in the API follow the usual REST conventions:GETreturns the value of a resource or a list of resources, depending on whether an identifier is specified. For example, aGETof/organizationsreturns a list of organizations, whereas aGETof/organizations/{organizationId}returns a particular organization.POSTadds a new resource, as in aPOSTto/organizations/{organizationId}/admins, or performs some other non-idempotent change.PUTupdates a resource.PUTsare idempotent; they update a resource, creating it first if it does not already exist. APUTshould specify all the fields of a resource; the API will revert omitted fields to their default value.DELETEremoves a resource.How to BuildYou must have Python2 >=2.7.9or Python3 >=3.4installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc.
These dependencies are defined in therequirements.txtfile that comes with the SDK.
To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps athttps://pip.pypa.io/en/stable/installing/.Python and PIP executables should be defined in your PATH. Open command prompt and typepip --version.
This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.Using command line, navigate to the directory containing the generated files (includingrequirements.txt) for the SDK.Run the commandpip install -r requirements.txt. This should install all the required dependencies.How to UseThe following section explains how to use the Meraki SDK package in a new project.1. Open Project in an IDEOpen up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.Click onOpenin PyCharm to browse to your generated SDK directory and then clickOK.The project files will be displayed in the side bar as follows:2. Add a new Test ProjectCreate a new directory by right clicking on the solution name as shown below:Name the directory as "test"Add a python file to this project with the name "testsdk"Name it "testsdk"In your python file you will be required to import the generated python library using the following code linesfrommeraki_sdk.meraki_sdk_clientimportMerakiSdkClientAfter this you can write code to instantiate an API client object, get a controller object and  make API calls. Sample code is given in the subsequent sections.3. Run the Test ProjectTo run the file within your test project, right click on your Python file inside your Test project and click onRunHow to TestYou can test the generated SDK and the server with automatically generated test
cases. unittest is used as the testing framework and nose is used as the test
runner. You can run the tests as follows:From terminal/cmd navigate to the root directory of the SDK.Invokepip install -r test-requirements.txtInvokenosetestsInitializationAuthenticationIn order to setup authentication and initialization of the API client, you need the following information.ParameterDescriptionx_cisco_meraki_api_keyTODO: add a descriptionAPI client can be initialized as following.# Configuration parameters and credentialsx_cisco_meraki_api_key='x_cisco_meraki_api_key'client=MerakiSdkClient(x_cisco_meraki_api_key)Class ReferenceList of ControllersAPIUsageControllerActionBatchesControllerAdminsControllerAlertSettingsControllerBluetoothClientsControllerCamerasControllerClientsControllerConfigTemplatesControllerConnectivityMonitoringDestinationsControllerContentFilteringCategoriesControllerContentFilteringRulesControllerDashboardBrandingPoliciesControllerDevicesControllerEventsControllerFirewalledServicesControllerFloorplansControllerGroupPoliciesControllerHTTPServersControllerIntrusionSettingsControllerMRL3FirewallControllerMVSenseControllerMX11NATRulesControllerMX1ManyNATRulesControllerMXL3FirewallControllerMXL7ApplicationCategoriesControllerMXL7FirewallControllerMXVLANPortsControllerMXVPNFirewallControllerMXCellularFirewallControllerMXPortForwardingRulesControllerMXStaticRoutesControllerMXWarmSpareSettingsControllerMalwareSettingsControllerManagementInterfaceSettingsControllerMerakiAuthUsersControllerNamedTagScopeControllerNetflowSettingsControllerNetworksControllerOpenAPISpecControllerOrganizationsControllerPIIControllerRadioSettingsControllerSAMLRolesControllerSMControllerSNMPSettingsControllerSsidsControllerSecurityEventsControllerSplashLoginAttemptsControllerSplashSettingsControllerSwitchPortSchedulesControllerSwitchPortsControllerSwitchProfilesControllerSwitchSettingsControllerSwitchStacksControllerSyslogServersControllerTrafficAnalysisSettingsControllerTrafficShapingControllerUplinkSettingsControllerVlansControllerWebhookLogsControllerWirelessHealthControllerWirelessSettingsControllerAPIUsageControllerGet controller instanceAn instance of theAPIUsageControllerclass can be accessed from the API Client.api_usage_controller=client.api_usageget_organization_api_requestsList the API requests made by an organizationdefget_organization_api_requests(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 31 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 31 days after t0.timespanOptionalThe timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.perPageOptionalThe number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.startingAfterOptionalA 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.endingBeforeOptionalA 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.adminIdOptionalFilter the results by the ID of the admin who made the API requestspathOptionalFilter the results by the path of the API requestsmethodOptionalFilter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')responseCodeOptionalFilter the results by the response code of the API requestsExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=39.8749335202737collect['timespan']=timespanper_page=39collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeadmin_id='adminId'collect['admin_id']=admin_idpath='path'collect['path']=pathmethod='method'collect['method']=methodresponse_code=39collect['response_code']=response_coderesult=api_usage_controller.get_organization_api_requests(collect)Back to List of ControllersActionBatchesControllerGet controller instanceAn instance of theActionBatchesControllerclass can be accessed from the API Client.action_batches_controller=client.action_batchescreate_organization_action_batchCreate an action batchdefcreate_organization_action_batch(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptioncreateOrganizationActionBatchRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idcreate_organization_action_batch=CreateOrganizationActionBatchModel()collect['create_organization_action_batch']=create_organization_action_batchresult=action_batches_controller.create_organization_action_batch(collect)get_organization_action_batchesReturn the list of action batches in the organizationdefget_organization_action_batches(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=action_batches_controller.get_organization_action_batches(organization_id)get_organization_action_batchReturn an action batchdefget_organization_action_batch(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionactionBatchIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idaction_batch_id='actionBatchId'collect['action_batch_id']=action_batch_idresult=action_batches_controller.get_organization_action_batch(collect)delete_organization_action_batchDelete an action batchdefdelete_organization_action_batch(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionactionBatchIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idaction_batch_id='actionBatchId'collect['action_batch_id']=action_batch_idaction_batches_controller.delete_organization_action_batch(collect)update_organization_action_batchUpdate an action batchdefupdate_organization_action_batch(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionactionBatchIdRequiredTODO: Add a parameter descriptionupdateOrganizationActionBatchOptionalTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idaction_batch_id='actionBatchId'collect['action_batch_id']=action_batch_idupdate_organization_action_batch=UpdateOrganizationActionBatchModel()collect['update_organization_action_batch']=update_organization_action_batchresult=action_batches_controller.update_organization_action_batch(collect)Back to List of ControllersAdminsControllerGet controller instanceAn instance of theAdminsControllerclass can be accessed from the API Client.admins_controller=client.adminsget_organization_adminsList the dashboard administrators in this organizationdefget_organization_admins(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=admins_controller.get_organization_admins(organization_id)create_organization_adminCreate a new dashboard administratordefcreate_organization_admin(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptioncreateOrganizationAdminRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idcreate_organization_admin=CreateOrganizationAdminModel()collect['create_organization_admin']=create_organization_adminresult=admins_controller.create_organization_admin(collect)update_organization_adminUpdate an administratordefupdate_organization_admin(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionupdateOrganizationAdminOptionalTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idid='id'collect['id']=idupdate_organization_admin=UpdateOrganizationAdminModel()collect['update_organization_admin']=update_organization_adminresult=admins_controller.update_organization_admin(collect)delete_organization_adminRevoke all access for a dashboard administrator within this organizationdefdelete_organization_admin(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idid='id'collect['id']=idadmins_controller.delete_organization_admin(collect)Back to List of ControllersAlertSettingsControllerGet controller instanceAn instance of theAlertSettingsControllerclass can be accessed from the API Client.alert_settings_controller=client.alert_settingsget_network_alert_settingsReturn the alert configuration for this networkdefget_network_alert_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=alert_settings_controller.get_network_alert_settings(network_id)update_network_alert_settingsUpdate the alert configuration for this networkdefupdate_network_alert_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkAlertSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_alert_settings=UpdateNetworkAlertSettingsModel()collect['update_network_alert_settings']=update_network_alert_settingsresult=alert_settings_controller.update_network_alert_settings(collect)Back to List of ControllersBluetoothClientsControllerGet controller instanceAn instance of theBluetoothClientsControllerclass can be accessed from the API Client.bluetooth_clients_controller=client.bluetooth_clientsget_network_bluetooth_clientsList the Bluetooth clients seen by APs in this networkdefget_network_bluetooth_clients(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 7 days from today.timespanOptionalThe timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 7 days. The default is 1 day.perPageOptionalThe number of entries per page returned. Acceptable range is 5 - 1000. Default is 10.startingAfterOptionalA 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.endingBeforeOptionalA 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.includeConnectivityHistoryOptionalInclude the connectivity history for this clientExample Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0timespan=39.8749335202737collect['timespan']=timespanper_page=39collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeinclude_connectivity_history=Falsecollect['include_connectivity_history']=include_connectivity_historyresult=bluetooth_clients_controller.get_network_bluetooth_clients(collect)get_network_bluetooth_clientReturn a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.defget_network_bluetooth_client(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionbluetoothClientIdRequiredTODO: Add a parameter descriptionincludeConnectivityHistoryOptionalInclude the connectivity history for this clientconnectivityHistoryTimespanOptionalThe timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idbluetooth_client_id='bluetoothClientId'collect['bluetooth_client_id']=bluetooth_client_idinclude_connectivity_history=Falsecollect['include_connectivity_history']=include_connectivity_historyconnectivity_history_timespan=39collect['connectivity_history_timespan']=connectivity_history_timespanresult=bluetooth_clients_controller.get_network_bluetooth_client(collect)Back to List of ControllersCamerasControllerGet controller instanceAn instance of theCamerasControllerclass can be accessed from the API Client.cameras_controller=client.camerasgenerate_network_camera_snapshotGenerate a snapshot of what the camera sees at the specified time and return a link to that image.defgenerate_network_camera_snapshot(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptiongenerateNetworkCameraSnapshotOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialgenerate_network_camera_snapshot=GenerateNetworkCameraSnapshotModel()collect['generate_network_camera_snapshot']=generate_network_camera_snapshotresult=cameras_controller.generate_network_camera_snapshot(collect)get_network_camera_video_linkReturns video link to the specified camera. If a timestamp is supplied, it links to that timestamp.defget_network_camera_video_link(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptiontimestampOptional[optional] The video link will start at this timestamp. The timestamp is in UNIX Epoch time (milliseconds). If no timestamp is specified, we will assume current time.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialtimestamp='timestamp'collect['timestamp']=timestampresult=cameras_controller.get_network_camera_video_link(collect)Back to List of ControllersClientsControllerGet controller instanceAn instance of theClientsControllerclass can be accessed from the API Client.clients_controller=client.clientsget_device_clientsList the clients of a device, up to a maximum of a month ago. The usage of each client is returned in kilobytes. If the device is a switch, the switchport is returned; otherwise the switchport field is null.defget_device_clients(self,options=dict())ParametersParameterTagsDescriptionserialRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 31 days from today.timespanOptionalThe timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.Example Usagecollect={}serial='serial'collect['serial']=serialt_0='t0'collect['t_0']=t_0timespan=203.379651628611collect['timespan']=timespanresult=clients_controller.get_device_clients(collect)get_network_clientsList the clients that have used this network in the timespandefget_network_clients(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 31 days from today.timespanOptionalThe timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.perPageOptionalThe number of entries per page returned. Acceptable range is 3 - 1000. Default is 10.startingAfterOptionalA 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.endingBeforeOptionalA 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.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0timespan=203.379651628611collect['timespan']=timespanper_page=203collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=clients_controller.get_network_clients(collect)provision_network_clientsProvisions a client with a name and policy. Clients can be provisioned before they associate to the network.defprovision_network_clients(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionprovisionNetworkClientsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idprovision_network_clients=ProvisionNetworkClientsModel()collect['provision_network_clients']=provision_network_clientsresult=clients_controller.provision_network_clients(collect)get_network_clientReturn the client associated with the given identifier. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.defget_network_client(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idresult=clients_controller.get_network_client(collect)get_network_client_eventsReturn the events associated with this client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.defget_network_client_events(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptionperPageOptionalThe number of entries per page returned. Acceptable range is 3 - 100. Default is 100.startingAfterOptionalA 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.endingBeforeOptionalA 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.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idper_page=203collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=clients_controller.get_network_client_events(collect)get_network_client_latency_historyReturn the latency history for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. The latency data is from a sample of 2% of packets and is grouped into 4 traffic categories: background, best effort, video, voice. Within these categories the sampled packet counters are bucketed by latency in milliseconds.defget_network_client_latency_history(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 791 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 791 days after t0.timespanOptionalThe 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 791 days. The default is 1 day.resolutionOptionalThe time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=203.379651628611collect['timespan']=timespanresolution=203collect['resolution']=resolutionresult=clients_controller.get_network_client_latency_history(collect)get_network_client_policyReturn the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.defget_network_client_policy(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idresult=clients_controller.get_network_client_policy(collect)update_network_client_policyUpdate the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.defupdate_network_client_policy(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptionupdateNetworkClientPolicyOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idupdate_network_client_policy=UpdateNetworkClientPolicyModel()collect['update_network_client_policy']=update_network_client_policyresult=clients_controller.update_network_client_policy(collect)get_network_client_splash_authorization_statusReturn the splash authorization for a client, for each SSID they've associated with through splash. Only enabled SSIDs with Click-through splash enabled will be included. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.defget_network_client_splash_authorization_status(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idresult=clients_controller.get_network_client_splash_authorization_status(collect)update_network_client_splash_authorization_statusUpdate a client's splash authorization. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.defupdate_network_client_splash_authorization_status(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptionupdateNetworkClientSplashAuthorizationStatusOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idupdate_network_client_splash_authorization_status=UpdateNetworkClientSplashAuthorizationStatusModel()collect['update_network_client_splash_authorization_status']=update_network_client_splash_authorization_statusresult=clients_controller.update_network_client_splash_authorization_status(collect)get_network_client_traffic_historyReturn the client's network traffic data over time. Usage data is in kilobytes. This endpoint requires detailed traffic analysis to be enabled on the Network-wide > General page. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.defget_network_client_traffic_history(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptionperPageOptionalThe number of entries per page returned. Acceptable range is 3 - 1000.startingAfterOptionalA 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.endingBeforeOptionalA 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.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idper_page=203collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=clients_controller.get_network_client_traffic_history(collect)get_network_client_usage_historyReturn the client's daily usage history. Usage data is in kilobytes. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.defget_network_client_usage_history(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idresult=clients_controller.get_network_client_usage_history(collect)Back to List of ControllersConfigTemplatesControllerGet controller instanceAn instance of theConfigTemplatesControllerclass can be accessed from the API Client.config_templates_controller=client.config_templatesget_organization_config_templatesList the configuration templates for this organizationdefget_organization_config_templates(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=config_templates_controller.get_organization_config_templates(organization_id)delete_organization_config_templateRemove a configuration templatedefdelete_organization_config_template(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionconfigTemplateIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idconfig_template_id='configTemplateId'collect['config_template_id']=config_template_idconfig_templates_controller.delete_organization_config_template(collect)Back to List of ControllersConnectivityMonitoringDestinationsControllerGet controller instanceAn instance of theConnectivityMonitoringDestinationsControllerclass can be accessed from the API Client.connectivity_monitoring_destinations_controller=client.connectivity_monitoring_destinationsget_network_connectivity_monitoring_destinationsReturn the connectivity testing destinations for an MX networkdefget_network_connectivity_monitoring_destinations(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=connectivity_monitoring_destinations_controller.get_network_connectivity_monitoring_destinations(network_id)update_network_connectivity_monitoring_destinationsUpdate the connectivity testing destinations for an MX networkdefupdate_network_connectivity_monitoring_destinations(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkConnectivityMonitoringDestinationsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_connectivity_monitoring_destinations=UpdateNetworkConnectivityMonitoringDestinationsModel()collect['update_network_connectivity_monitoring_destinations']=update_network_connectivity_monitoring_destinationsresult=connectivity_monitoring_destinations_controller.update_network_connectivity_monitoring_destinations(collect)Back to List of ControllersContentFilteringCategoriesControllerGet controller instanceAn instance of theContentFilteringCategoriesControllerclass can be accessed from the API Client.content_filtering_categories_controller=client.content_filtering_categoriesget_network_content_filtering_categoriesList all available content filtering categories for an MX networkdefget_network_content_filtering_categories(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=content_filtering_categories_controller.get_network_content_filtering_categories(network_id)Back to List of ControllersContentFilteringRulesControllerGet controller instanceAn instance of theContentFilteringRulesControllerclass can be accessed from the API Client.content_filtering_rules_controller=client.content_filtering_rulesget_network_content_filteringReturn the content filtering settings for an MX networkdefget_network_content_filtering(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=content_filtering_rules_controller.get_network_content_filtering(network_id)update_network_content_filteringUpdate the content filtering settings for an MX networkdefupdate_network_content_filtering(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkContentFilteringOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_content_filtering=UpdateNetworkContentFilteringModel()collect['update_network_content_filtering']=update_network_content_filteringresult=content_filtering_rules_controller.update_network_content_filtering(collect)Back to List of ControllersDashboardBrandingPoliciesControllerGet controller instanceAn instance of theDashboardBrandingPoliciesControllerclass can be accessed from the API Client.dashboard_branding_policies_controller=client.dashboard_branding_policiesget_organization_branding_policiesList the branding policies of an organizationdefget_organization_branding_policies(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=dashboard_branding_policies_controller.get_organization_branding_policies(organization_id)create_organization_branding_policyAdd a new branding policy to an organizationdefcreate_organization_branding_policy(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptioncreateOrganizationBrandingPolicyRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idcreate_organization_branding_policy=CreateOrganizationBrandingPolicyModel()collect['create_organization_branding_policy']=create_organization_branding_policyresult=dashboard_branding_policies_controller.create_organization_branding_policy(collect)get_organization_branding_policies_prioritiesReturn the branding policy IDs of an organization in priority order. IDs are ordered in ascending order of priority (IDs later in the array have higher priority).defget_organization_branding_policies_priorities(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=dashboard_branding_policies_controller.get_organization_branding_policies_priorities(organization_id)update_organization_branding_policies_prioritiesUpdate the priority ordering of an organization's branding policies.defupdate_organization_branding_policies_priorities(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionupdateOrganizationBrandingPoliciesPrioritiesRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idupdate_organization_branding_policies_priorities=UpdateOrganizationBrandingPoliciesPrioritiesModel()collect['update_organization_branding_policies_priorities']=update_organization_branding_policies_prioritiesresult=dashboard_branding_policies_controller.update_organization_branding_policies_priorities(collect)get_organization_branding_policyReturn a branding policydefget_organization_branding_policy(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionbrandingPolicyIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idbranding_policy_id='brandingPolicyId'collect['branding_policy_id']=branding_policy_idresult=dashboard_branding_policies_controller.get_organization_branding_policy(collect)update_organization_branding_policyUpdate a branding policydefupdate_organization_branding_policy(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionbrandingPolicyIdRequiredTODO: Add a parameter descriptionupdateOrganizationBrandingPolicyOptionalTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idbranding_policy_id='brandingPolicyId'collect['branding_policy_id']=branding_policy_idupdate_organization_branding_policy=UpdateOrganizationBrandingPolicyModel()collect['update_organization_branding_policy']=update_organization_branding_policyresult=dashboard_branding_policies_controller.update_organization_branding_policy(collect)delete_organization_branding_policyDelete a branding policydefdelete_organization_branding_policy(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionbrandingPolicyIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idbranding_policy_id='brandingPolicyId'collect['branding_policy_id']=branding_policy_iddashboard_branding_policies_controller.delete_organization_branding_policy(collect)Back to List of ControllersDevicesControllerGet controller instanceAn instance of theDevicesControllerclass can be accessed from the API Client.devices_controller=client.devicesget_network_devicesList the devices in a networkdefget_network_devices(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=devices_controller.get_network_devices(network_id)claim_network_devicesClaim a device into a networkdefclaim_network_devices(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclaimNetworkDevicesRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idclaim_network_devices=ClaimNetworkDevicesModel()collect['claim_network_devices']=claim_network_devicesdevices_controller.claim_network_devices(collect)get_network_deviceReturn a single devicedefget_network_device(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialresult=devices_controller.get_network_device(collect)update_network_deviceUpdate the attributes of a devicedefupdate_network_device(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionupdateNetworkDeviceOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialupdate_network_device=UpdateNetworkDeviceModel()collect['update_network_device']=update_network_deviceresult=devices_controller.update_network_device(collect)blink_network_device_ledsBlink the LEDs on a devicedefblink_network_device_leds(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionblinkNetworkDeviceLedsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialblink_network_device_leds=BlinkNetworkDeviceLedsModel()collect['blink_network_device_leds']=blink_network_device_ledsresult=devices_controller.blink_network_device_leds(collect)get_network_device_lldp_cdpList LLDP and CDP information for a devicedefget_network_device_lldp_cdp(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptiontimespanOptionalThe timespan for which LLDP and CDP information will be fetched. Must be in seconds and less than or equal to a month (2592000 seconds). LLDP and CDP information is sent to the Meraki dashboard every 10 minutes. In instances where this LLDP and CDP information matches an existing entry in the Meraki dashboard, the data is updated once every two hours. Meraki recommends querying LLDP and CDP information at an interval slightly greater than two hours, to ensure that unchanged CDP / LLDP information can be queried consistently.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialtimespan=203collect['timespan']=timespanresult=devices_controller.get_network_device_lldp_cdp(collect)get_network_device_loss_and_latency_historyGet the uplink loss percentage and latency in milliseconds for a wired network device.defget_network_device_loss_and_latency_history(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionipRequiredThe destination IP used to obtain the requested stats. This is required.t0OptionalThe beginning of the timespan for the data. The maximum lookback period is 365 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 31 days after t0.timespanOptionalThe timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.resolutionOptionalThe time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60.uplinkOptionalThe WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialip='ip'collect['ip']=ipt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=203.379651628611collect['timespan']=timespanresolution=203collect['resolution']=resolutionuplink=UplinkEnum.WAN1collect['uplink']=uplinkresult=devices_controller.get_network_device_loss_and_latency_history(collect)get_network_device_performanceReturn the performance score for a single device. Only primary MX devices supported. If no data is available, a 204 error code is returned.defget_network_device_performance(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialresult=devices_controller.get_network_device_performance(collect)reboot_network_deviceReboot a devicedefreboot_network_device(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialresult=devices_controller.reboot_network_device(collect)remove_network_deviceRemove a single devicedefremove_network_device(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialdevices_controller.remove_network_device(collect)get_network_device_uplinkReturn the uplink information for a device.defget_network_device_uplink(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialresult=devices_controller.get_network_device_uplink(collect)get_organization_devicesList the devices in an organizationdefget_organization_devices(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionperPageOptionalThe number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.startingAfterOptionalA 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.endingBeforeOptionalA 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.Example Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idper_page=111collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=devices_controller.get_organization_devices(collect)Back to List of ControllersEventsControllerGet controller instanceAn instance of theEventsControllerclass can be accessed from the API Client.events_controller=client.eventsget_network_eventsList the events for the networkdefget_network_events(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionproductTypeOptionalThe product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, and cameraincludedEventTypesOptionalCollectionA list of event types. The returned events will be filtered to only include events with these types.excludedEventTypesOptionalCollectionA list of event types. The returned events will be filtered to exclude events with these types.deviceMacOptionalThe MAC address of the Meraki device which the list of events will be filtered withdeviceSerialOptionalThe serial of the Meraki device which the list of events will be filtered withdeviceNameOptionalThe name of the Meraki device which the list of events will be filtered withclientIpOptionalThe IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.clientMacOptionalThe MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.clientNameOptionalThe name, or partial name, of the client which the list of events will be filtered withsmDeviceMacOptionalThe MAC address of the Systems Manager device which the list of events will be filtered withsmDeviceNameOptionalThe name of the Systems Manager device which the list of events will be filtered withperPageOptionalThe number of entries per page returned. Acceptable range is 3 - 1000. Default is 10.startingAfterOptionalA 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.endingBeforeOptionalA 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.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idproduct_type='productType'collect['product_type']=product_typeincluded_event_types=['includedEventTypes']collect['included_event_types']=included_event_typesexcluded_event_types=['excludedEventTypes']collect['excluded_event_types']=excluded_event_typesdevice_mac='deviceMac'collect['device_mac']=device_macdevice_serial='deviceSerial'collect['device_serial']=device_serialdevice_name='deviceName'collect['device_name']=device_nameclient_ip='clientIp'collect['client_ip']=client_ipclient_mac='clientMac'collect['client_mac']=client_macclient_name='clientName'collect['client_name']=client_namesm_device_mac='smDeviceMac'collect['sm_device_mac']=sm_device_macsm_device_name='smDeviceName'collect['sm_device_name']=sm_device_nameper_page=111collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=events_controller.get_network_events(collect)get_network_events_event_typesList the event type to human-readable descriptiondefget_network_events_event_types(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=events_controller.get_network_events_event_types(network_id)Back to List of ControllersFirewalledServicesControllerGet controller instanceAn instance of theFirewalledServicesControllerclass can be accessed from the API Client.firewalled_services_controller=client.firewalled_servicesget_network_firewalled_servicesList the appliance services and their accessibility rulesdefget_network_firewalled_services(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=firewalled_services_controller.get_network_firewalled_services(network_id)get_network_firewalled_serviceReturn the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')defget_network_firewalled_service(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserviceRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idservice='service'collect['service']=serviceresult=firewalled_services_controller.get_network_firewalled_service(collect)update_network_firewalled_serviceUpdates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')defupdate_network_firewalled_service(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserviceRequiredTODO: Add a parameter descriptionupdateNetworkFirewalledServiceRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idservice='service'collect['service']=serviceupdate_network_firewalled_service=UpdateNetworkFirewalledServiceModel()collect['update_network_firewalled_service']=update_network_firewalled_serviceresult=firewalled_services_controller.update_network_firewalled_service(collect)Back to List of ControllersFloorplansControllerGet controller instanceAn instance of theFloorplansControllerclass can be accessed from the API Client.floorplans_controller=client.floorplansget_network_floor_plansList the floor plans that belong to your networkdefget_network_floor_plans(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=floorplans_controller.get_network_floor_plans(network_id)create_network_floor_planUpload a floor plandefcreate_network_floor_plan(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkFloorPlanRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_floor_plan=CreateNetworkFloorPlanModel()collect['create_network_floor_plan']=create_network_floor_planresult=floorplans_controller.create_network_floor_plan(collect)get_network_floor_planFind a floor plan by IDdefget_network_floor_plan(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionfloorPlanIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idfloor_plan_id='floorPlanId'collect['floor_plan_id']=floor_plan_idresult=floorplans_controller.get_network_floor_plan(collect)update_network_floor_planUpdate a floor plan's geolocation and other meta datadefupdate_network_floor_plan(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionfloorPlanIdRequiredTODO: Add a parameter descriptionupdateNetworkFloorPlanOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idfloor_plan_id='floorPlanId'collect['floor_plan_id']=floor_plan_idupdate_network_floor_plan=UpdateNetworkFloorPlanModel()collect['update_network_floor_plan']=update_network_floor_planresult=floorplans_controller.update_network_floor_plan(collect)delete_network_floor_planDestroy a floor plandefdelete_network_floor_plan(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionfloorPlanIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idfloor_plan_id='floorPlanId'collect['floor_plan_id']=floor_plan_idfloorplans_controller.delete_network_floor_plan(collect)Back to List of ControllersGroupPoliciesControllerGet controller instanceAn instance of theGroupPoliciesControllerclass can be accessed from the API Client.group_policies_controller=client.group_policiesget_network_group_policiesList the group policies in a networkdefget_network_group_policies(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=group_policies_controller.get_network_group_policies(network_id)create_network_group_policyCreate a group policydefcreate_network_group_policy(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkGroupPolicyRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_group_policy=CreateNetworkGroupPolicyModel()collect['create_network_group_policy']=create_network_group_policyresult=group_policies_controller.create_network_group_policy(collect)get_network_group_policyDisplay a group policydefget_network_group_policy(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiongroupPolicyIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idgroup_policy_id='groupPolicyId'collect['group_policy_id']=group_policy_idresult=group_policies_controller.get_network_group_policy(collect)update_network_group_policyUpdate a group policydefupdate_network_group_policy(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiongroupPolicyIdRequiredTODO: Add a parameter descriptionupdateNetworkGroupPolicyOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idgroup_policy_id='groupPolicyId'collect['group_policy_id']=group_policy_idupdate_network_group_policy=UpdateNetworkGroupPolicyModel()collect['update_network_group_policy']=update_network_group_policyresult=group_policies_controller.update_network_group_policy(collect)delete_network_group_policyDelete a group policydefdelete_network_group_policy(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiongroupPolicyIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idgroup_policy_id='groupPolicyId'collect['group_policy_id']=group_policy_idgroup_policies_controller.delete_network_group_policy(collect)Back to List of ControllersHTTPServersControllerGet controller instanceAn instance of theHTTPServersControllerclass can be accessed from the API Client.http_servers_controller=client.http_serversget_network_http_serversList the HTTP servers for a networkdefget_network_http_servers(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=http_servers_controller.get_network_http_servers(network_id)create_network_http_serverAdd an HTTP server to a networkdefcreate_network_http_server(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkHttpServerRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_http_server=CreateNetworkHttpServerModel()collect['create_network_http_server']=create_network_http_serverresult=http_servers_controller.create_network_http_server(collect)create_network_http_servers_webhook_testSend a test webhook for a networkdefcreate_network_http_servers_webhook_test(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkHttpServersWebhookTestRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_http_servers_webhook_test=CreateNetworkHttpServersWebhookTestModel()collect['create_network_http_servers_webhook_test']=create_network_http_servers_webhook_testresult=http_servers_controller.create_network_http_servers_webhook_test(collect)get_network_http_servers_webhook_testReturn the status of a webhook test for a networkdefget_network_http_servers_webhook_test(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idid='id'collect['id']=idresult=http_servers_controller.get_network_http_servers_webhook_test(collect)get_network_http_serverReturn an HTTP server for a networkdefget_network_http_server(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idid='id'collect['id']=idresult=http_servers_controller.get_network_http_server(collect)update_network_http_serverUpdate an HTTP serverdefupdate_network_http_server(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionupdateNetworkHttpServerOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idid='id'collect['id']=idupdate_network_http_server=UpdateNetworkHttpServerModel()collect['update_network_http_server']=update_network_http_serverresult=http_servers_controller.update_network_http_server(collect)delete_network_http_serverDelete an HTTP server from a networkdefdelete_network_http_server(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idid='id'collect['id']=idhttp_servers_controller.delete_network_http_server(collect)Back to List of ControllersIntrusionSettingsControllerGet controller instanceAn instance of theIntrusionSettingsControllerclass can be accessed from the API Client.intrusion_settings_controller=client.intrusion_settingsget_network_security_intrusion_settingsReturns all supported intrusion settings for an MX networkdefget_network_security_intrusion_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=intrusion_settings_controller.get_network_security_intrusion_settings(network_id)update_network_security_intrusion_settingsSet the supported intrusion settings for an MX networkdefupdate_network_security_intrusion_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSecurityIntrusionSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_security_intrusion_settings=UpdateNetworkSecurityIntrusionSettingsModel()collect['update_network_security_intrusion_settings']=update_network_security_intrusion_settingsresult=intrusion_settings_controller.update_network_security_intrusion_settings(collect)get_organization_security_intrusion_settingsReturns all supported intrusion settings for an organizationdefget_organization_security_intrusion_settings(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=intrusion_settings_controller.get_organization_security_intrusion_settings(organization_id)update_organization_security_intrusion_settingsSets supported intrusion settings for an organizationdefupdate_organization_security_intrusion_settings(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionupdateOrganizationSecurityIntrusionSettingsRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idupdate_organization_security_intrusion_settings=UpdateOrganizationSecurityIntrusionSettingsModel()collect['update_organization_security_intrusion_settings']=update_organization_security_intrusion_settingsresult=intrusion_settings_controller.update_organization_security_intrusion_settings(collect)Back to List of ControllersMRL3FirewallControllerGet controller instanceAn instance of theMRL3FirewallControllerclass can be accessed from the API Client.mr_l_3_firewall_controller=client.mr_l_3_firewallget_network_ssid_l_3_firewall_rulesReturn the L3 firewall rules for an SSID on an MR networkdefget_network_ssid_l_3_firewall_rules(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idnumber='number'collect['number']=numberresult=mr_l_3_firewall_controller.get_network_ssid_l_3_firewall_rules(collect)update_network_ssid_l_3_firewall_rulesUpdate the L3 firewall rules of an SSID on an MR networkdefupdate_network_ssid_l_3_firewall_rules(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionupdateNetworkSsidL3FirewallRulesOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idnumber='number'collect['number']=numberupdate_network_ssid_l_3_firewall_rules=UpdateNetworkSsidL3FirewallRulesModel()collect['update_network_ssid_l_3_firewall_rules']=update_network_ssid_l_3_firewall_rulesresult=mr_l_3_firewall_controller.update_network_ssid_l_3_firewall_rules(collect)Back to List of ControllersMVSenseControllerGet controller instanceAn instance of theMVSenseControllerclass can be accessed from the API Client.mv_sense_controller=client.mv_senseget_device_camera_analytics_liveReturns live state from camera of analytics zonesdefget_device_camera_analytics_live(self,serial)ParametersParameterTagsDescriptionserialRequiredTODO: Add a parameter descriptionExample Usageserial='serial'result=mv_sense_controller.get_device_camera_analytics_live(serial)get_device_camera_analytics_overviewReturns an overview of aggregate analytics data for a timespandefget_device_camera_analytics_overview(self,options=dict())ParametersParameterTagsDescriptionserialRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 365 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days. The default is 1 hour.objectTypeOptional[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].Example Usagecollect={}serial='serial'collect['serial']=serialt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=111.884369736949collect['timespan']=timespanobject_type=ObjectTypeEnum.PERSONcollect['object_type']=object_typeresult=mv_sense_controller.get_device_camera_analytics_overview(collect)get_device_camera_analytics_recentReturns most recent record for analytics zonesdefget_device_camera_analytics_recent(self,options=dict())ParametersParameterTagsDescriptionserialRequiredTODO: Add a parameter descriptionobjectTypeOptional[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].Example Usagecollect={}serial='serial'collect['serial']=serialobject_type=ObjectTypeEnum.PERSONcollect['object_type']=object_typeresult=mv_sense_controller.get_device_camera_analytics_recent(collect)get_device_camera_analytics_zonesReturns all configured analytic zones for this cameradefget_device_camera_analytics_zones(self,serial)ParametersParameterTagsDescriptionserialRequiredTODO: Add a parameter descriptionExample Usageserial='serial'result=mv_sense_controller.get_device_camera_analytics_zones(serial)get_device_camera_analytics_zone_historyReturn historical records for analytic zonesdefget_device_camera_analytics_zone_history(self,options=dict())ParametersParameterTagsDescriptionserialRequiredTODO: Add a parameter descriptionzoneIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 365 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 14 hours after t0.timespanOptionalThe 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 hours. The default is 1 hour.resolutionOptionalThe time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60.objectTypeOptional[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].Example Usagecollect={}serial='serial'collect['serial']=serialzone_id='zoneId'collect['zone_id']=zone_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=111.884369736949collect['timespan']=timespanresolution=111collect['resolution']=resolutionobject_type=ObjectTypeEnum.PERSONcollect['object_type']=object_typeresult=mv_sense_controller.get_device_camera_analytics_zone_history(collect)Back to List of ControllersMX11NATRulesControllerGet controller instanceAn instance of theMX11NATRulesControllerclass can be accessed from the API Client.mx_1_1_nat_rules_controller=client.mx_1_1_nat_rulesget_network_one_to_one_nat_rulesReturn the 1:1 NAT mapping rules for an MX networkdefget_network_one_to_one_nat_rules(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_11_nat_rules_controller.get_network_one_to_one_nat_rules(network_id)update_network_one_to_one_nat_rulesSet the 1:1 NAT mapping rules for an MX networkdefupdate_network_one_to_one_nat_rules(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkOneToOneNatRulesOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_one_to_one_nat_rules=UpdateNetworkOneToOneNatRulesModel()collect['update_network_one_to_one_nat_rules']=update_network_one_to_one_nat_rulesresult=mx_11_nat_rules_controller.update_network_one_to_one_nat_rules(collect)Back to List of ControllersMX1ManyNATRulesControllerGet controller instanceAn instance of theMX1ManyNATRulesControllerclass can be accessed from the API Client.mx_1_many_nat_rules_controller=client.mx_1_many_nat_rulesget_network_one_to_many_nat_rulesReturn the 1:Many NAT mapping rules for an MX networkdefget_network_one_to_many_nat_rules(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_1_many_nat_rules_controller.get_network_one_to_many_nat_rules(network_id)update_network_one_to_many_nat_rulesSet the 1:Many NAT mapping rules for an MX networkdefupdate_network_one_to_many_nat_rules(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkOneToManyNatRulesOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_one_to_many_nat_rules=UpdateNetworkOneToManyNatRulesModel()collect['update_network_one_to_many_nat_rules']=update_network_one_to_many_nat_rulesresult=mx_1_many_nat_rules_controller.update_network_one_to_many_nat_rules(collect)Back to List of ControllersMXL3FirewallControllerGet controller instanceAn instance of theMXL3FirewallControllerclass can be accessed from the API Client.mx_l_3_firewall_controller=client.mx_l_3_firewallget_network_l_3_firewall_rulesReturn the L3 firewall rules for an MX networkdefget_network_l_3_firewall_rules(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_l_3_firewall_controller.get_network_l_3_firewall_rules(network_id)update_network_l_3_firewall_rulesUpdate the L3 firewall rules of an MX networkdefupdate_network_l_3_firewall_rules(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkL3FirewallRulesOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_l_3_firewall_rules=UpdateNetworkL3FirewallRulesModel()collect['update_network_l_3_firewall_rules']=update_network_l_3_firewall_rulesresult=mx_l_3_firewall_controller.update_network_l_3_firewall_rules(collect)Back to List of ControllersMXL7ApplicationCategoriesControllerGet controller instanceAn instance of theMXL7ApplicationCategoriesControllerclass can be accessed from the API Client.mx_l_7_application_categories_controller=client.mx_l_7_application_categoriesget_network_l_7_firewall_rules_application_categoriesReturn the L7 firewall application categories and their associated applications for an MX networkdefget_network_l_7_firewall_rules_application_categories(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_l_7_application_categories_controller.get_network_l_7_firewall_rules_application_categories(network_id)Back to List of ControllersMXL7FirewallControllerGet controller instanceAn instance of theMXL7FirewallControllerclass can be accessed from the API Client.mx_l_7_firewall_controller=client.mx_l_7_firewallget_network_l_7_firewall_rulesList the MX L7 firewall rules for an MX networkdefget_network_l_7_firewall_rules(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_l_7_firewall_controller.get_network_l_7_firewall_rules(network_id)update_network_l_7_firewall_rulesUpdate the MX L7 firewall rules for an MX networkdefupdate_network_l_7_firewall_rules(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkL7FirewallRulesOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_l_7_firewall_rules=UpdateNetworkL7FirewallRulesModel()collect['update_network_l_7_firewall_rules']=update_network_l_7_firewall_rulesresult=mx_l_7_firewall_controller.update_network_l_7_firewall_rules(collect)Back to List of ControllersMXVLANPortsControllerGet controller instanceAn instance of theMXVLANPortsControllerclass can be accessed from the API Client.mx_vlan_ports_controller=client.mx_vlan_portsget_network_appliance_portsList per-port VLAN settings for all ports of a MX.defget_network_appliance_ports(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_vlan_ports_controller.get_network_appliance_ports(network_id)get_network_appliance_portReturn per-port VLAN settings for a single MX port.defget_network_appliance_port(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionappliancePortIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idappliance_port_id='appliancePortId'collect['appliance_port_id']=appliance_port_idresult=mx_vlan_ports_controller.get_network_appliance_port(collect)update_network_appliance_portUpdate the per-port VLAN settings for a single MX port.defupdate_network_appliance_port(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionappliancePortIdRequiredTODO: Add a parameter descriptionupdateNetworkAppliancePortOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idappliance_port_id='appliancePortId'collect['appliance_port_id']=appliance_port_idupdate_network_appliance_port=UpdateNetworkAppliancePortModel()collect['update_network_appliance_port']=update_network_appliance_portresult=mx_vlan_ports_controller.update_network_appliance_port(collect)Back to List of ControllersMXVPNFirewallControllerGet controller instanceAn instance of theMXVPNFirewallControllerclass can be accessed from the API Client.mx_vpn_firewall_controller=client.mx_vpn_firewallget_organization_vpn_firewall_rulesReturn the firewall rules for an organization's site-to-site VPNdefget_organization_vpn_firewall_rules(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=mx_vpn_firewall_controller.get_organization_vpn_firewall_rules(organization_id)update_organization_vpn_firewall_rulesUpdate the firewall rules of an organization's site-to-site VPNdefupdate_organization_vpn_firewall_rules(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionupdateOrganizationVpnFirewallRulesOptionalTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idupdate_organization_vpn_firewall_rules=UpdateOrganizationVpnFirewallRulesModel()collect['update_organization_vpn_firewall_rules']=update_organization_vpn_firewall_rulesresult=mx_vpn_firewall_controller.update_organization_vpn_firewall_rules(collect)Back to List of ControllersMXCellularFirewallControllerGet controller instanceAn instance of theMXCellularFirewallControllerclass can be accessed from the API Client.mx_cellular_firewall_controller=client.mx_cellular_firewallget_network_cellular_firewall_rulesReturn the cellular firewall rules for an MX networkdefget_network_cellular_firewall_rules(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_cellular_firewall_controller.get_network_cellular_firewall_rules(network_id)update_network_cellular_firewall_rulesUpdate the cellular firewall rules of an MX networkdefupdate_network_cellular_firewall_rules(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkCellularFirewallRulesOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_cellular_firewall_rules=UpdateNetworkCellularFirewallRulesModel()collect['update_network_cellular_firewall_rules']=update_network_cellular_firewall_rulesresult=mx_cellular_firewall_controller.update_network_cellular_firewall_rules(collect)Back to List of ControllersMXPortForwardingRulesControllerGet controller instanceAn instance of theMXPortForwardingRulesControllerclass can be accessed from the API Client.mx_port_forwarding_rules_controller=client.mx_port_forwarding_rulesget_network_port_forwarding_rulesReturn the port forwarding rules for an MX networkdefget_network_port_forwarding_rules(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_port_forwarding_rules_controller.get_network_port_forwarding_rules(network_id)update_network_port_forwarding_rulesUpdate the port forwarding rules for an MX networkdefupdate_network_port_forwarding_rules(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkPortForwardingRulesOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_port_forwarding_rules=UpdateNetworkPortForwardingRulesModel()collect['update_network_port_forwarding_rules']=update_network_port_forwarding_rulesresult=mx_port_forwarding_rules_controller.update_network_port_forwarding_rules(collect)Back to List of ControllersMXStaticRoutesControllerGet controller instanceAn instance of theMXStaticRoutesControllerclass can be accessed from the API Client.mx_static_routes_controller=client.mx_static_routesget_network_static_routesList the static routes for an MX or teleworker networkdefget_network_static_routes(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_static_routes_controller.get_network_static_routes(network_id)create_network_static_routeAdd a static route for an MX or teleworker networkdefcreate_network_static_route(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkStaticRouteOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_static_route=CreateNetworkStaticRouteModel()collect['create_network_static_route']=create_network_static_routeresult=mx_static_routes_controller.create_network_static_route(collect)get_network_static_routeReturn a static route for an MX or teleworker networkdefget_network_static_route(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionsrIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idsr_id='srId'collect['sr_id']=sr_idresult=mx_static_routes_controller.get_network_static_route(collect)update_network_static_routeUpdate a static route for an MX or teleworker networkdefupdate_network_static_route(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionsrIdRequiredTODO: Add a parameter descriptionupdateNetworkStaticRouteOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idsr_id='srId'collect['sr_id']=sr_idupdate_network_static_route=UpdateNetworkStaticRouteModel()collect['update_network_static_route']=update_network_static_routeresult=mx_static_routes_controller.update_network_static_route(collect)delete_network_static_routeDelete a static route from an MX or teleworker networkdefdelete_network_static_route(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionsrIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idsr_id='srId'collect['sr_id']=sr_idmx_static_routes_controller.delete_network_static_route(collect)Back to List of ControllersMXWarmSpareSettingsControllerGet controller instanceAn instance of theMXWarmSpareSettingsControllerclass can be accessed from the API Client.mx_warm_spare_settings_controller=client.mx_warm_spare_settingsswap_network_warmspareSwap MX primary and warm spare appliancesdefswap_network_warmspare(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_warm_spare_settings_controller.swap_network_warmspare(network_id)get_network_warm_spare_settingsReturn MX warm spare settingsdefget_network_warm_spare_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=mx_warm_spare_settings_controller.get_network_warm_spare_settings(network_id)update_network_warm_spare_settingsUpdate MX warm spare settingsdefupdate_network_warm_spare_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkWarmSpareSettingsRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_warm_spare_settings=UpdateNetworkWarmSpareSettingsModel()collect['update_network_warm_spare_settings']=update_network_warm_spare_settingsresult=mx_warm_spare_settings_controller.update_network_warm_spare_settings(collect)Back to List of ControllersMalwareSettingsControllerGet controller instanceAn instance of theMalwareSettingsControllerclass can be accessed from the API Client.malware_settings_controller=client.malware_settingsget_network_security_malware_settingsReturns all supported malware settings for an MX networkdefget_network_security_malware_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=malware_settings_controller.get_network_security_malware_settings(network_id)update_network_security_malware_settingsSet the supported malware settings for an MX networkdefupdate_network_security_malware_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSecurityMalwareSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_security_malware_settings=UpdateNetworkSecurityMalwareSettingsModel()collect['update_network_security_malware_settings']=update_network_security_malware_settingsresult=malware_settings_controller.update_network_security_malware_settings(collect)Back to List of ControllersManagementInterfaceSettingsControllerGet controller instanceAn instance of theManagementInterfaceSettingsControllerclass can be accessed from the API Client.management_interface_settings_controller=client.management_interface_settingsget_network_device_management_interface_settingsReturn the management interface settings for a devicedefget_network_device_management_interface_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialresult=management_interface_settings_controller.get_network_device_management_interface_settings(collect)update_network_device_management_interface_settingsUpdate the management interface settings for a devicedefupdate_network_device_management_interface_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionupdateNetworkDeviceManagementInterfaceSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialupdate_network_device_management_interface_settings=UpdateNetworkDeviceManagementInterfaceSettingsModel()collect['update_network_device_management_interface_settings']=update_network_device_management_interface_settingsresult=management_interface_settings_controller.update_network_device_management_interface_settings(collect)Back to List of ControllersMerakiAuthUsersControllerGet controller instanceAn instance of theMerakiAuthUsersControllerclass can be accessed from the API Client.meraki_auth_users_controller=client.meraki_auth_usersget_network_meraki_auth_usersList the splash or RADIUS users configured under Meraki Authentication for a networkdefget_network_meraki_auth_users(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=meraki_auth_users_controller.get_network_meraki_auth_users(network_id)get_network_meraki_auth_userReturn the Meraki Auth splash or RADIUS userdefget_network_meraki_auth_user(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionmerakiAuthUserIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idmeraki_auth_user_id='merakiAuthUserId'collect['meraki_auth_user_id']=meraki_auth_user_idresult=meraki_auth_users_controller.get_network_meraki_auth_user(collect)Back to List of ControllersNamedTagScopeControllerGet controller instanceAn instance of theNamedTagScopeControllerclass can be accessed from the API Client.named_tag_scope_controller=client.named_tag_scopeget_network_sm_target_groupsList the target groups in this networkdefget_network_sm_target_groups(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionwithDetailsOptionalBoolean indicating if the the ids of the devices or users scoped by the target group should be included in the responseExample Usagecollect={}network_id='networkId'collect['network_id']=network_idwith_details=Truecollect['with_details']=with_detailsresult=named_tag_scope_controller.get_network_sm_target_groups(collect)create_network_sm_target_groupAdd a target groupdefcreate_network_sm_target_group(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkSmTargetGroupOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_sm_target_group=CreateNetworkSmTargetGroupModel()collect['create_network_sm_target_group']=create_network_sm_target_groupresult=named_tag_scope_controller.create_network_sm_target_group(collect)get_network_sm_target_groupReturn a target groupdefget_network_sm_target_group(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiontargetGroupIdRequiredTODO: Add a parameter descriptionwithDetailsOptionalBoolean indicating if the the ids of the devices or users scoped by the target group should be included in the responseExample Usagecollect={}network_id='networkId'collect['network_id']=network_idtarget_group_id='targetGroupId'collect['target_group_id']=target_group_idwith_details=Truecollect['with_details']=with_detailsresult=named_tag_scope_controller.get_network_sm_target_group(collect)update_network_sm_target_groupUpdate a target groupdefupdate_network_sm_target_group(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiontargetGroupIdRequiredTODO: Add a parameter descriptionupdateNetworkSmTargetGroupOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idtarget_group_id='targetGroupId'collect['target_group_id']=target_group_idupdate_network_sm_target_group=UpdateNetworkSmTargetGroupModel()collect['update_network_sm_target_group']=update_network_sm_target_groupresult=named_tag_scope_controller.update_network_sm_target_group(collect)delete_network_sm_target_groupDelete a target group from a networkdefdelete_network_sm_target_group(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiontargetGroupIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idtarget_group_id='targetGroupId'collect['target_group_id']=target_group_idnamed_tag_scope_controller.delete_network_sm_target_group(collect)Back to List of ControllersNetflowSettingsControllerGet controller instanceAn instance of theNetflowSettingsControllerclass can be accessed from the API Client.netflow_settings_controller=client.netflow_settingsget_network_netflow_settingsReturn the NetFlow traffic reporting settings for a networkdefget_network_netflow_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=netflow_settings_controller.get_network_netflow_settings(network_id)update_network_netflow_settingsUpdate the NetFlow traffic reporting settings for a networkdefupdate_network_netflow_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetwork_netflow_SettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_netflow_settings=UpdateNetworkNetflowSettingsModel()collect['update_network_netflow_settings']=update_network_netflow_settingsresult=netflow_settings_controller.update_network_netflow_settings(collect)Back to List of ControllersNetworksControllerGet controller instanceAn instance of theNetworksControllerclass can be accessed from the API Client.networks_controller=client.networksget_networkReturn a networkdefget_network(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=networks_controller.get_network(network_id)update_networkUpdate a networkdefupdate_network(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network=UpdateNetworkModel()collect['update_network']=update_networkresult=networks_controller.update_network(collect)delete_networkDelete a networkdefdelete_network(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'networks_controller.delete_network(network_id)get_network_access_policiesList the access policies for this network. Only valid for MS networks.defget_network_access_policies(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=networks_controller.get_network_access_policies(network_id)get_network_air_marshalList Air Marshal scan results from a networkdefget_network_air_marshal(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 31 days from today.timespanOptionalThe timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0timespan=62.1122610718535collect['timespan']=timespanresult=networks_controller.get_network_air_marshal(collect)bind_networkBind a network to a template.defbind_network(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionbindNetworkRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idbind_network=BindNetworkModel()collect['bind_network']=bind_networknetworks_controller.bind_network(collect)get_network_bluetooth_settingsReturn the Bluetooth settings for a network.Bluetooth settingsmust be enabled on the network.defget_network_bluetooth_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=networks_controller.get_network_bluetooth_settings(network_id)update_network_bluetooth_settingsUpdate the Bluetooth settings for a network. See the docs page forBluetooth settings.defupdate_network_bluetooth_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkBluetoothSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_bluetooth_settings=UpdateNetworkBluetoothSettingsModel()collect['update_network_bluetooth_settings']=update_network_bluetooth_settingsresult=networks_controller.update_network_bluetooth_settings(collect)get_network_site_to_site_vpnReturn the site-to-site VPN settings of a network. Only valid for MX networks.defget_network_site_to_site_vpn(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=networks_controller.get_network_site_to_site_vpn(network_id)update_network_site_to_site_vpnUpdate the site-to-site VPN settings of a network. Only valid for MX networks in NAT mode.defupdate_network_site_to_site_vpn(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSiteToSiteVpnRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_site_to_site_vpn=UpdateNetworkSiteToSiteVpnModel()collect['update_network_site_to_site_vpn']=update_network_site_to_site_vpnresult=networks_controller.update_network_site_to_site_vpn(collect)split_networkSplit a combined network into individual networks for each type of devicedefsplit_network(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=networks_controller.split_network(network_id)get_network_trafficThe traffic analysis data for this network.
<a href="https://documentation.meraki.com/MR/Monitoring_and_Reporting/Hostname_Visibility">Traffic Analysis with Hostname Visibility</a> must be enabled on the network.defget_network_traffic(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 30 days from today.timespanOptionalThe timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days.deviceTypeOptionalFilter the data by device type: combined (default), wireless, switch, appliance.When using combined, for each rule the data will come from the device type with the most usage. |Example Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0timespan=62.1122610718535collect['timespan']=timespandevice_type='deviceType'collect['device_type']=device_typeresult=networks_controller.get_network_traffic(collect)unbind_networkUnbind a network from a template.defunbind_network(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'networks_controller.unbind_network(network_id)get_organization_networksList the networks in an organizationdefget_organization_networks(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionconfigTemplateIdOptionalAn optional parameter that is the ID of a config template. Will return all networks bound to that template.Example Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idconfig_template_id='configTemplateId'collect['config_template_id']=config_template_idresult=networks_controller.get_organization_networks(collect)create_organization_networkCreate a networkdefcreate_organization_network(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptioncreateOrganizationNetworkRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idcreate_organization_network=CreateOrganizationNetworkModel()collect['create_organization_network']=create_organization_networkresult=networks_controller.create_organization_network(collect)combine_organization_networksCombine multiple networks into a single networkdefcombine_organization_networks(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptioncombineOrganizationNetworksRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idcombine_organization_networks=CombineOrganizationNetworksModel()collect['combine_organization_networks']=combine_organization_networksresult=networks_controller.combine_organization_networks(collect)Back to List of ControllersOpenAPISpecControllerGet controller instanceAn instance of theOpenAPISpecControllerclass can be accessed from the API Client.open_api_spec_controller=client.open_api_specget_organization_openapi_specReturn the OpenAPI 2.0 Specification of the organization's API documentation in JSONdefget_organization_openapi_spec(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=open_api_spec_controller.get_organization_openapi_spec(organization_id)Back to List of ControllersOrganizationsControllerGet controller instanceAn instance of theOrganizationsControllerclass can be accessed from the API Client.organizations_controller=client.organizationsget_organizationsList the organizations that the user has privileges ondefget_organizations(self)Example Usageresult=organizations_controller.get_organizations()create_organizationCreate a new organizationdefcreate_organization(self,create_organization)ParametersParameterTagsDescriptioncreateOrganizationRequiredTODO: Add a parameter descriptionExample Usagecreate_organization=CreateOrganizationModel()result=organizations_controller.create_organization(create_organization)get_organizationReturn an organizationdefget_organization(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=organizations_controller.get_organization(organization_id)update_organizationUpdate an organizationdefupdate_organization(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionupdateOrganizationOptionalTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idupdate_organization=UpdateOrganizationModel()collect['update_organization']=update_organizationresult=organizations_controller.update_organization(collect)delete_organizationDelete an organizationdefdelete_organization(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'organizations_controller.delete_organization(organization_id)claim_organizationClaim a list of devices, licenses, and/or orders into an organization. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory.defclaim_organization(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionclaimOrganizationOptionalTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idclaim_organization=ClaimOrganizationModel()collect['claim_organization']=claim_organizationresult=organizations_controller.claim_organization(collect)clone_organizationCreate a new organization by cloning the addressed organizationdefclone_organization(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptioncloneOrganizationRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idclone_organization=CloneOrganizationModel()collect['clone_organization']=clone_organizationresult=organizations_controller.clone_organization(collect)get_organization_device_statusesList the status of every Meraki device in the organizationdefget_organization_device_statuses(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=organizations_controller.get_organization_device_statuses(organization_id)get_organization_inventoryReturn the inventory for an organizationdefget_organization_inventory(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=organizations_controller.get_organization_inventory(organization_id)get_organization_license_stateReturn the license state for an organizationdefget_organization_license_state(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=organizations_controller.get_organization_license_state(organization_id)get_organization_third_party_vpn_peersReturn the third party VPN peers for an organizationdefget_organization_third_party_vpn_peers(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=organizations_controller.get_organization_third_party_vpn_peers(organization_id)update_organization_third_party_vpn_peersUpdate the third party VPN peers for an organizationdefupdate_organization_third_party_vpn_peers(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionupdateOrganizationThirdPartyVPNPeersRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idupdate_organization_third_party_vpn_peers=UpdateOrganizationThirdPartyVPNPeersModel()collect['update_organization_third_party_vpn_peers']=update_organization_third_party_vpn_peersresult=organizations_controller.update_organization_third_party_vpn_peers(collect)get_organization_uplinks_loss_and_latencyReturn the uplink loss and latency for every MX in the organization from at latest 2 minutes agodefget_organization_uplinks_loss_and_latency(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 365 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past.timespanOptionalThe 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 5 minutes. The default is 5 minutes.uplinkOptionalOptional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks.ipOptionalOptional filter for a specific destination IP. Default will return all destination IPs.Example Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=62.1122610718535collect['timespan']=timespanuplink=UplinkEnum.WAN1collect['uplink']=uplinkip='ip'collect['ip']=ipresult=organizations_controller.get_organization_uplinks_loss_and_latency(collect)Back to List of ControllersPIIControllerGet controller instanceAn instance of thePIIControllerclass can be accessed from the API Client.pii_controller=client.piiget_network_pii_pii_keysList the keys required to access Personally Identifiable Information (PII) for a given identifier. Exactly one identifier will be accepted. If the organization contains org-wide Systems Manager users matching the key provided then there will be an entry with the key "0" containing the applicable keys.ALTERNATE PATH/organizations/{organizationId}/pii/piiKeysdefget_network_pii_pii_keys(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionusernameOptionalThe username of a Systems Manager useremailOptionalThe email of a network user account or a Systems Manager devicemacOptionalThe MAC of a network client device or a Systems Manager deviceserialOptionalThe serial of a Systems Manager deviceimeiOptionalThe IMEI of a Systems Manager devicebluetoothMacOptionalThe MAC of a Bluetooth clientExample Usagecollect={}network_id='networkId'collect['network_id']=network_idusername='username'collect['username']=usernameemail='email'collect['email']=emailmac='mac'collect['mac']=macserial='serial'collect['serial']=serialimei='imei'collect['imei']=imeibluetooth_mac='bluetoothMac'collect['bluetooth_mac']=bluetooth_macresult=pii_controller.get_network_pii_pii_keys(collect)get_network_pii_requestsList the PII requests for this network or organizationALTERNATE PATH/organizations/{organizationId}/pii/requestsdefget_network_pii_requests(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=pii_controller.get_network_pii_requests(network_id)create_network_pii_requestSubmit a new delete or restrict processing PII requestALTERNATE PATH/organizations/{organizationId}/pii/requestsdefcreate_network_pii_request(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkPiiRequestOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_pii_request=CreateNetworkPiiRequestModel()collect['create_network_pii_request']=create_network_pii_requestresult=pii_controller.create_network_pii_request(collect)get_network_pii_requestReturn a PII requestALTERNATE PATH/organizations/{organizationId}/pii/requests/{requestId}defget_network_pii_request(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionrequestIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idrequest_id='requestId'collect['request_id']=request_idresult=pii_controller.get_network_pii_request(collect)delete_network_pii_requestDelete a restrict processing PII requestALTERNATE PATH/organizations/{organizationId}/pii/requests/{requestId}defdelete_network_pii_request(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionrequestIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idrequest_id='requestId'collect['request_id']=request_idpii_controller.delete_network_pii_request(collect)get_network_pii_sm_devices_for_keyGiven a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier. These device IDs can be used with the Systems Manager API endpoints to retrieve device details. Exactly one identifier will be accepted.ALTERNATE PATH/organizations/{organizationId}/pii/smDevicesForKeydefget_network_pii_sm_devices_for_key(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionusernameOptionalThe username of a Systems Manager useremailOptionalThe email of a network user account or a Systems Manager devicemacOptionalThe MAC of a network client device or a Systems Manager deviceserialOptionalThe serial of a Systems Manager deviceimeiOptionalThe IMEI of a Systems Manager devicebluetoothMacOptionalThe MAC of a Bluetooth clientExample Usagecollect={}network_id='networkId'collect['network_id']=network_idusername='username'collect['username']=usernameemail='email'collect['email']=emailmac='mac'collect['mac']=macserial='serial'collect['serial']=serialimei='imei'collect['imei']=imeibluetooth_mac='bluetoothMac'collect['bluetooth_mac']=bluetooth_macresult=pii_controller.get_network_pii_sm_devices_for_key(collect)get_network_pii_sm_owners_for_keyGiven a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier. These owner IDs can be used with the Systems Manager API endpoints to retrieve owner details. Exactly one identifier will be accepted.ALTERNATE PATH/organizations/{organizationId}/pii/smOwnersForKeydefget_network_pii_sm_owners_for_key(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionusernameOptionalThe username of a Systems Manager useremailOptionalThe email of a network user account or a Systems Manager devicemacOptionalThe MAC of a network client device or a Systems Manager deviceserialOptionalThe serial of a Systems Manager deviceimeiOptionalThe IMEI of a Systems Manager devicebluetoothMacOptionalThe MAC of a Bluetooth clientExample Usagecollect={}network_id='networkId'collect['network_id']=network_idusername='username'collect['username']=usernameemail='email'collect['email']=emailmac='mac'collect['mac']=macserial='serial'collect['serial']=serialimei='imei'collect['imei']=imeibluetooth_mac='bluetoothMac'collect['bluetooth_mac']=bluetooth_macresult=pii_controller.get_network_pii_sm_owners_for_key(collect)Back to List of ControllersRadioSettingsControllerGet controller instanceAn instance of theRadioSettingsControllerclass can be accessed from the API Client.radio_settings_controller=client.radio_settingsget_network_device_wireless_radio_settingsReturn the radio settings of a devicedefget_network_device_wireless_radio_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialresult=radio_settings_controller.get_network_device_wireless_radio_settings(collect)update_network_device_wireless_radio_settingsUpdate the radio settings of a devicedefupdate_network_device_wireless_radio_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionupdateNetworkDeviceWirelessRadioSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialupdate_network_device_wireless_radio_settings=UpdateNetworkDeviceWirelessRadioSettingsModel()collect['update_network_device_wireless_radio_settings']=update_network_device_wireless_radio_settingsresult=radio_settings_controller.update_network_device_wireless_radio_settings(collect)get_network_wireless_rf_profilesList the non-basic RF profiles for this networkdefget_network_wireless_rf_profiles(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionincludeTemplateProfilesOptionalIf the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the templateshould be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false. |Example Usagecollect={}network_id='networkId'collect['network_id']=network_idinclude_template_profiles=Falsecollect['include_template_profiles']=include_template_profilesresult=radio_settings_controller.get_network_wireless_rf_profiles(collect)create_network_wireless_rf_profileCreates new RF profile for this networkdefcreate_network_wireless_rf_profile(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkWirelessRfProfileRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_wireless_rf_profile=CreateNetworkWirelessRfProfileModel()collect['create_network_wireless_rf_profile']=create_network_wireless_rf_profileresult=radio_settings_controller.create_network_wireless_rf_profile(collect)update_network_wireless_rf_profileUpdates specified RF profile for this networkdefupdate_network_wireless_rf_profile(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionrfProfileIdRequiredTODO: Add a parameter descriptionupdateNetworkWirelessRfProfileOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idrf_profile_id='rfProfileId'collect['rf_profile_id']=rf_profile_idupdate_network_wireless_rf_profile=UpdateNetworkWirelessRfProfileModel()collect['update_network_wireless_rf_profile']=update_network_wireless_rf_profileresult=radio_settings_controller.update_network_wireless_rf_profile(collect)delete_network_wireless_rf_profileDelete a RF Profiledefdelete_network_wireless_rf_profile(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionrfProfileIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idrf_profile_id='rfProfileId'collect['rf_profile_id']=rf_profile_idradio_settings_controller.delete_network_wireless_rf_profile(collect)get_network_wireless_rf_profileReturn a RF profiledefget_network_wireless_rf_profile(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionrfProfileIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idrf_profile_id='rfProfileId'collect['rf_profile_id']=rf_profile_idresult=radio_settings_controller.get_network_wireless_rf_profile(collect)Back to List of ControllersSAMLRolesControllerGet controller instanceAn instance of theSAMLRolesControllerclass can be accessed from the API Client.saml_roles_controller=client.saml_rolesget_organization_saml_rolesList the SAML roles for this organizationdefget_organization_saml_roles(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=saml_roles_controller.get_organization_saml_roles(organization_id)create_organization_saml_roleCreate a SAML roledefcreate_organization_saml_role(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptioncreateOrganizationSamlRoleOptionalTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idcreate_organization_saml_role=CreateOrganizationSamlRoleModel()collect['create_organization_saml_role']=create_organization_saml_roleresult=saml_roles_controller.create_organization_saml_role(collect)get_organization_saml_roleReturn a SAML roledefget_organization_saml_role(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idid='id'collect['id']=idresult=saml_roles_controller.get_organization_saml_role(collect)update_organization_saml_roleUpdate a SAML roledefupdate_organization_saml_role(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionupdateOrganizationSamlRoleOptionalTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idid='id'collect['id']=idupdate_organization_saml_role=UpdateOrganizationSamlRoleModel()collect['update_organization_saml_role']=update_organization_saml_roleresult=saml_roles_controller.update_organization_saml_role(collect)delete_organization_saml_roleRemove a SAML roledefdelete_organization_saml_role(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idid='id'collect['id']=idsaml_roles_controller.delete_organization_saml_role(collect)Back to List of ControllersSMControllerGet controller instanceAn instance of theSMControllerclass can be accessed from the API Client.sm_controller=client.smcreate_network_sm_app_polarisCreate a new Polaris appdefcreate_network_sm_app_polaris(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkSmAppPolarisRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_sm_app_polaris=CreateNetworkSmAppPolarisModel()collect['create_network_sm_app_polaris']=create_network_sm_app_polarisresult=sm_controller.create_network_sm_app_polaris(collect)get_network_sm_app_polarisGet details for a Cisco Polaris app if it existsdefget_network_sm_app_polaris(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionbundleIdOptionalThe bundle ID of the app to be found, defaults to com.cisco.ciscosecurity.appExample Usagecollect={}network_id='networkId'collect['network_id']=network_idbundle_id='bundleId'collect['bundle_id']=bundle_idresult=sm_controller.get_network_sm_app_polaris(collect)update_network_sm_app_polarisUpdate an existing Polaris appdefupdate_network_sm_app_polaris(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionappIdRequiredTODO: Add a parameter descriptionupdateNetworkSmAppPolarisOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idapp_id='appId'collect['app_id']=app_idupdate_network_sm_app_polaris=UpdateNetworkSmAppPolarisModel()collect['update_network_sm_app_polaris']=update_network_sm_app_polarisresult=sm_controller.update_network_sm_app_polaris(collect)delete_network_sm_app_polarisDelete a Cisco Polaris appdefdelete_network_sm_app_polaris(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionappIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idapp_id='appId'collect['app_id']=app_idresult=sm_controller.delete_network_sm_app_polaris(collect)create_network_sm_bypass_activation_lock_attemptBypass activation lock attemptdefcreate_network_sm_bypass_activation_lock_attempt(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkSmBypassActivationLockAttemptRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_sm_bypass_activation_lock_attempt=CreateNetworkSmBypassActivationLockAttemptModel()collect['create_network_sm_bypass_activation_lock_attempt']=create_network_sm_bypass_activation_lock_attemptresult=sm_controller.create_network_sm_bypass_activation_lock_attempt(collect)get_network_sm_bypass_activation_lock_attemptBypass activation lock attempt statusdefget_network_sm_bypass_activation_lock_attempt(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionattemptIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idattempt_id='attemptId'collect['attempt_id']=attempt_idresult=sm_controller.get_network_sm_bypass_activation_lock_attempt(collect)update_network_sm_device_fieldsModify the fields of a devicedefupdate_network_sm_device_fields(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSmDeviceFieldsRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_sm_device_fields=UpdateNetworkSmDeviceFieldsModel()collect['update_network_sm_device_fields']=update_network_sm_device_fieldsresult=sm_controller.update_network_sm_device_fields(collect)wipe_network_sm_deviceWipe a devicedefwipe_network_sm_device(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionwipeNetworkSmDeviceOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idwipe_network_sm_device=WipeNetworkSmDeviceModel()collect['wipe_network_sm_device']=wipe_network_sm_deviceresult=sm_controller.wipe_network_sm_device(collect)refresh_network_sm_device_detailsRefresh the details of a devicedefrefresh_network_sm_device_details(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idsm_controller.refresh_network_sm_device_details(collect)get_network_sm_devicesList the devices enrolled in an SM network with various specified fields and filtersdefget_network_sm_devices(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionfieldsOptionalAdditional fields that will be displayed for each device. Multiple fields can be passed in as comma separated values.The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip,
systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser,
ownerEmail, ownerUsername, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid,
simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName,
isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled,
hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, and androidSecurityPatchVersion. || wifiMacs |Optional| Filter devices by wifi mac(s). Multiple wifi macs can be passed in as comma separated values. |
| serials |Optional| Filter devices by serial(s). Multiple serials can be passed in as comma separated values. |
| ids |Optional| Filter devices by id(s). Multiple ids can be passed in as comma separated values. |
| scope |Optional| Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags as comma separated values. |
| batchSize |Optional| Number of devices to return, 1000 is the default as well as the max. |
| batchToken |Optional| If the network has more devices than the batch size, a batch token will be returned
as a part of the device list. To see the remainder of the devices, pass in the batchToken as a parameter in the next request.
Requests made with the batchToken do not require additional parameters as the batchToken includes the parameters passed in
with the original request. Additional parameters passed in with the batchToken will be ignored. |Example Usagecollect={}network_id='networkId'collect['network_id']=network_idfields='fields'collect['fields']=fieldswifi_macs='wifiMacs'collect['wifi_macs']=wifi_macsserials='serials'collect['serials']=serialsids='ids'collect['ids']=idsscope='scope'collect['scope']=scopebatch_size=225collect['batch_size']=batch_sizebatch_token='batchToken'collect['batch_token']=batch_tokenresult=sm_controller.get_network_sm_devices(collect)checkin_network_sm_devicesForce check-in a set of devicesdefcheckin_network_sm_devices(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncheckinNetworkSmDevicesOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcheckin_network_sm_devices=CheckinNetworkSmDevicesModel()collect['checkin_network_sm_devices']=checkin_network_sm_devicesresult=sm_controller.checkin_network_sm_devices(collect)move_network_sm_devicesMove a set of devices to a new networkdefmove_network_sm_devices(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionmoveNetworkSmDevicesRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idmove_network_sm_devices=MoveNetworkSmDevicesModel()collect['move_network_sm_devices']=move_network_sm_devicesresult=sm_controller.move_network_sm_devices(collect)update_network_sm_devices_tagsAdd, delete, or update the tags of a set of devicesdefupdate_network_sm_devices_tags(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSmDevicesTagsRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_sm_devices_tags=UpdateNetworkSmDevicesTagsModel()collect['update_network_sm_devices_tags']=update_network_sm_devices_tagsresult=sm_controller.update_network_sm_devices_tags(collect)unenroll_network_sm_deviceUnenroll a devicedefunenroll_network_sm_device(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idresult=sm_controller.unenroll_network_sm_device(collect)create_network_sm_profile_clarityCreate a new profile containing a Cisco Clarity payloaddefcreate_network_sm_profile_clarity(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkSmProfileClarityRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_sm_profile_clarity=CreateNetworkSmProfileClarityModel()collect['create_network_sm_profile_clarity']=create_network_sm_profile_clarityresult=sm_controller.create_network_sm_profile_clarity(collect)update_network_sm_profile_clarityUpdate an existing profile containing a Cisco Clarity payloaddefupdate_network_sm_profile_clarity(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionprofileIdRequiredTODO: Add a parameter descriptionupdateNetworkSmProfileClarityOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idprofile_id='profileId'collect['profile_id']=profile_idupdate_network_sm_profile_clarity=UpdateNetworkSmProfileClarityModel()collect['update_network_sm_profile_clarity']=update_network_sm_profile_clarityresult=sm_controller.update_network_sm_profile_clarity(collect)add_network_sm_profile_clarityAdd a Cisco Clarity payload to an existing profiledefadd_network_sm_profile_clarity(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionprofileIdRequiredTODO: Add a parameter descriptionaddNetworkSmProfileClarityRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idprofile_id='profileId'collect['profile_id']=profile_idadd_network_sm_profile_clarity=AddNetworkSmProfileClarityModel()collect['add_network_sm_profile_clarity']=add_network_sm_profile_clarityresult=sm_controller.add_network_sm_profile_clarity(collect)get_network_sm_profile_clarityGet details for a Cisco Clarity payloaddefget_network_sm_profile_clarity(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionprofileIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idprofile_id='profileId'collect['profile_id']=profile_idresult=sm_controller.get_network_sm_profile_clarity(collect)delete_network_sm_profile_clarityDelete a Cisco Clarity payload. Deletes the entire profile if it's empty after removing the payload.defdelete_network_sm_profile_clarity(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionprofileIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idprofile_id='profileId'collect['profile_id']=profile_idresult=sm_controller.delete_network_sm_profile_clarity(collect)create_network_sm_profile_umbrellaCreate a new profile containing a Cisco Umbrella payloaddefcreate_network_sm_profile_umbrella(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkSmProfileUmbrellaRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_sm_profile_umbrella=CreateNetworkSmProfileUmbrellaModel()collect['create_network_sm_profile_umbrella']=create_network_sm_profile_umbrellaresult=sm_controller.create_network_sm_profile_umbrella(collect)update_network_sm_profile_umbrellaUpdate an existing profile containing a Cisco Umbrella payloaddefupdate_network_sm_profile_umbrella(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionprofileIdRequiredTODO: Add a parameter descriptionupdateNetworkSmProfileUmbrellaOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idprofile_id='profileId'collect['profile_id']=profile_idupdate_network_sm_profile_umbrella=UpdateNetworkSmProfileUmbrellaModel()collect['update_network_sm_profile_umbrella']=update_network_sm_profile_umbrellaresult=sm_controller.update_network_sm_profile_umbrella(collect)add_network_sm_profile_umbrellaAdd a Cisco Umbrella payload to an existing profiledefadd_network_sm_profile_umbrella(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionprofileIdRequiredTODO: Add a parameter descriptionaddNetworkSmProfileUmbrellaRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idprofile_id='profileId'collect['profile_id']=profile_idadd_network_sm_profile_umbrella=AddNetworkSmProfileUmbrellaModel()collect['add_network_sm_profile_umbrella']=add_network_sm_profile_umbrellaresult=sm_controller.add_network_sm_profile_umbrella(collect)get_network_sm_profile_umbrellaGet details for a Cisco Umbrella payloaddefget_network_sm_profile_umbrella(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionprofileIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idprofile_id='profileId'collect['profile_id']=profile_idresult=sm_controller.get_network_sm_profile_umbrella(collect)delete_network_sm_profile_umbrellaDelete a Cisco Umbrella payload. Deletes the entire profile if it's empty after removing the payloaddefdelete_network_sm_profile_umbrella(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionprofileIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idprofile_id='profileId'collect['profile_id']=profile_idresult=sm_controller.delete_network_sm_profile_umbrella(collect)get_network_sm_profilesList all the profiles in the networkdefget_network_sm_profiles(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=sm_controller.get_network_sm_profiles(network_id)get_network_sm_user_device_profilesGet the profiles associated with a userdefget_network_sm_user_device_profiles(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionuserIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iduser_id='userId'collect['user_id']=user_idresult=sm_controller.get_network_sm_user_device_profiles(collect)get_network_sm_user_softwaresGet a list of softwares associated with a userdefget_network_sm_user_softwares(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionuserIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iduser_id='userId'collect['user_id']=user_idresult=sm_controller.get_network_sm_user_softwares(collect)get_network_sm_usersList the owners in an SM network with various specified fields and filtersdefget_network_sm_users(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionidsOptionalFilter users by id(s). Multiple ids can be passed in as comma separated values.usernamesOptionalFilter users by username(s). Multiple usernames can be passed in as comma separated values.emailsOptionalFilter users by email(s). Multiple emails can be passed in as comma separated values.scopeOptionalSpecifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags as comma separated values.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idids='ids'collect['ids']=idsusernames='usernames'collect['usernames']=usernamesemails='emails'collect['emails']=emailsscope='scope'collect['scope']=scoperesult=sm_controller.get_network_sm_users(collect)get_network_sm_cellular_usage_historyReturn the client's daily cellular data usage history. Usage data is in kilobytes.defget_network_sm_cellular_usage_history(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idresult=sm_controller.get_network_sm_cellular_usage_history(collect)get_network_sm_certsList the certs on a devicedefget_network_sm_certs(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idresult=sm_controller.get_network_sm_certs(collect)get_network_sm_device_profilesGet the profiles associated with a devicedefget_network_sm_device_profiles(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idresult=sm_controller.get_network_sm_device_profiles(collect)get_network_sm_network_adaptersList the network adapters of a devicedefget_network_sm_network_adapters(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idresult=sm_controller.get_network_sm_network_adapters(collect)get_network_sm_restrictionsList the restrictions on a devicedefget_network_sm_restrictions(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idresult=sm_controller.get_network_sm_restrictions(collect)get_network_sm_security_centersList the security centers on a devicedefget_network_sm_security_centers(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idresult=sm_controller.get_network_sm_security_centers(collect)get_network_sm_softwaresGet a list of softwares associated with a devicedefget_network_sm_softwares(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idresult=sm_controller.get_network_sm_softwares(collect)get_network_sm_wlan_listsList the saved SSID names on a devicedefget_network_sm_wlan_lists(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiondeviceIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_iddevice_id='deviceId'collect['device_id']=device_idresult=sm_controller.get_network_sm_wlan_lists(collect)lock_network_sm_devicesLock a set of devicesdeflock_network_sm_devices(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionlockNetworkSmDevicesOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='network_id'collect['network_id']=network_idlock_network_sm_devices=LockNetworkSmDevicesModel()collect['lock_network_sm_devices']=lock_network_sm_devicesresult=sm_controller.lock_network_sm_devices(collect)get_network_sm_connectivityReturns historical connectivity data (whether a device is regularly checking in to Dashboard).defget_network_sm_connectivity(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionperPageOptionalThe number of entries per page returnedstartingAfterOptionalA 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, next or prev page in the HTTP Link header should define it.endingBeforeOptionalA 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, next or prev page in the HTTP Link header should define it.Example Usagecollect={}network_id='network_id'collect['network_id']=network_idid='id'collect['id']=idper_page='perPage'collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=sm_controller.get_network_sm_connectivity(collect)get_network_sm_desktop_logsReturn historical records of various Systems Manager network connection details for desktop devices.defget_network_sm_desktop_logs(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionperPageOptionalThe number of entries per page returnedstartingAfterOptionalA 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, next or prev page in the HTTP Link header should define it.endingBeforeOptionalA 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, next or prev page in the HTTP Link header should define it.Example Usagecollect={}network_id='network_id'collect['network_id']=network_idid='id'collect['id']=idper_page='perPage'collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=sm_controller.get_network_sm_desktop_logs(collect)get_network_sm_device_command_logsReturn historical records of commands sent to Systems Manager devices.
<p>Note that this will include the name of the Dashboard user who initiated the command if it was generated
by a Dashboard admin rather than the automatic behavior of the system; you may wish to filter this out
of any reports.</p>defget_network_sm_device_command_logs(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionperPageOptionalThe number of entries per page returnedstartingAfterOptionalA 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, next or prev page in the HTTP Link header should define it.endingBeforeOptionalA 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, next or prev page in the HTTP Link header should define it.Example Usagecollect={}network_id='network_id'collect['network_id']=network_idid='id'collect['id']=idper_page='perPage'collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=sm_controller.get_network_sm_device_command_logs(collect)get_network_sm_performance_historyReturn historical records of various Systems Manager client metrics for desktop devices.defget_network_sm_performance_history(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionidRequiredTODO: Add a parameter descriptionperPageOptionalThe number of entries per page returnedstartingAfterOptionalA 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, next or prev page in the HTTP Link header should define it.endingBeforeOptionalA 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, next or prev page in the HTTP Link header should define it.Example Usagecollect={}network_id='network_id'collect['network_id']=network_idid='id'collect['id']=idper_page='perPage'collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=sm_controller.get_network_sm_performance_history(collect)Back to List of ControllersSNMPSettingsControllerGet controller instanceAn instance of theSNMPSettingsControllerclass can be accessed from the API Client.snmp_settings_controller=client.snmp_settingsget_network_snmp_settingsReturn the SNMP settings for a networkdefget_network_snmp_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=snmp_settings_controller.get_network_snmp_settings(network_id)update_network_snmp_settingsUpdate the SNMP settings for a networkdefupdate_network_snmp_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSnmpSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_snmp_settings=UpdateNetworkSnmpSettingsModel()collect['update_network_snmp_settings']=update_network_snmp_settingsresult=snmp_settings_controller.update_network_snmp_settings(collect)get_organization_snmpReturn the SNMP settings for an organizationdefget_organization_snmp(self,organization_id)ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionExample Usageorganization_id='organizationId'result=snmp_settings_controller.get_organization_snmp(organization_id)update_organization_snmpUpdate the SNMP settings for an organizationdefupdate_organization_snmp(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionupdateOrganizationSnmpOptionalTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idupdate_organization_snmp=UpdateOrganizationSnmpModel()collect['update_organization_snmp']=update_organization_snmpresult=snmp_settings_controller.update_organization_snmp(collect)Back to List of ControllersSsidsControllerGet controller instanceAn instance of theSsidsControllerclass can be accessed from the API Client.ssids_controller=client.ssidsget_network_device_wireless_statusReturn the SSID statuses of an access pointdefget_network_device_wireless_status(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialresult=ssids_controller.get_network_device_wireless_status(collect)get_network_ssidsList the SSIDs in a network. Supports networks with access points or wireless-enabled security appliances and teleworker gateways.defget_network_ssids(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=ssids_controller.get_network_ssids(network_id)get_network_ssidReturn a single SSIDdefget_network_ssid(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idnumber='number'collect['number']=numberresult=ssids_controller.get_network_ssid(collect)update_network_ssidUpdate the attributes of an SSIDdefupdate_network_ssid(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionupdateNetworkSsidOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idnumber='number'collect['number']=numberupdate_network_ssid=UpdateNetworkSsidModel()collect['update_network_ssid']=update_network_ssidresult=ssids_controller.update_network_ssid(collect)Back to List of ControllersSecurityEventsControllerGet controller instanceAn instance of theSecurityEventsControllerclass can be accessed from the API Client.security_events_controller=client.security_eventsget_network_client_security_eventsList the security events for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.defget_network_client_security_events(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 791 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 791 days after t0.timespanOptionalThe 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 791 days. The default is 31 days.perPageOptionalThe number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.startingAfterOptionalA 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.endingBeforeOptionalA 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.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=12.3401524067578collect['timespan']=timespanper_page=12collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=security_events_controller.get_network_client_security_events(collect)get_network_security_eventsList the security events for a networkdefget_network_security_events(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 365 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 365 days after t0.timespanOptionalThe 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 365 days. The default is 31 days.perPageOptionalThe number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.startingAfterOptionalA 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.endingBeforeOptionalA 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.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=12.3401524067578collect['timespan']=timespanper_page=12collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=security_events_controller.get_network_security_events(collect)get_organization_security_eventsList the security events for an organizationdefget_organization_security_events(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 365 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 365 days after t0.timespanOptionalThe 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 365 days. The default is 31 days.perPageOptionalThe number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.startingAfterOptionalA 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.endingBeforeOptionalA 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.Example Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=12.3401524067578collect['timespan']=timespanper_page=12collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeresult=security_events_controller.get_organization_security_events(collect)Back to List of ControllersSplashLoginAttemptsControllerGet controller instanceAn instance of theSplashLoginAttemptsControllerclass can be accessed from the API Client.splash_login_attempts_controller=client.splash_login_attemptsget_network_splash_login_attemptsList the splash login attempts for a networkdefget_network_splash_login_attempts(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionssidNumberOptionalOnly return the login attempts for the specified SSIDloginIdentifierOptionalThe username, email, or phone number used during logintimespanOptionalThe timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 monthsExample Usagecollect={}network_id='networkId'collect['network_id']=network_idssid_number=SsidNumberEnum.ENUM_0collect['ssid_number']=ssid_numberlogin_identifier='loginIdentifier'collect['login_identifier']=login_identifiertimespan=12collect['timespan']=timespanresult=splash_login_attempts_controller.get_network_splash_login_attempts(collect)Back to List of ControllersSplashSettingsControllerGet controller instanceAn instance of theSplashSettingsControllerclass can be accessed from the API Client.splash_settings_controller=client.splash_settingsget_network_ssids_plash_settingsDisplay the splash page settings for the given SSIDdefget_network_ssids_plash_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idnumber='number'collect['number']=numberresult=splash_settings_controller.get_network_ssids_plash_settings(collect)update_network_ssids_plash_settingsModify the splash page settings for the given SSIDdefupdate_network_ssids_plash_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionupdateNetwork_ssids_PlashSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idnumber='number'collect['number']=numberupdate_network_ssids_plash_settings=UpdateNetworkSsidsPlashSettingsModel()collect['update_network_ssids_plash_settings']=update_network_ssids_plash_settingsresult=splash_settings_controller.update_network_ssids_plash_settings(collect)Back to List of ControllersSwitchPortSchedulesControllerGet controller instanceAn instance of theSwitchPortSchedulesControllerclass can be accessed from the API Client.switch_port_schedules_controller=client.switch_port_schedulesget_network_switch_port_schedulesList switch port schedulesdefget_network_switch_port_schedules(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=switch_port_schedules_controller.get_network_switch_port_schedules(network_id)create_network_switch_port_scheduleAdd a switch port scheduledefcreate_network_switch_port_schedule(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkSwitchPortScheduleRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_switch_port_schedule=CreateNetworkSwitchPortScheduleModel()collect['create_network_switch_port_schedule']=create_network_switch_port_scheduleresult=switch_port_schedules_controller.create_network_switch_port_schedule(collect)delete_network_switch_port_scheduleDelete a switch port scheduledefdelete_network_switch_port_schedule(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionportScheduleIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idport_schedule_id='portScheduleId'collect['port_schedule_id']=port_schedule_idswitch_port_schedules_controller.delete_network_switch_port_schedule(collect)update_network_switch_port_scheduleUpdate a switch port scheduledefupdate_network_switch_port_schedule(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionportScheduleIdRequiredTODO: Add a parameter descriptionupdateNetworkSwitchPortScheduleOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idport_schedule_id='portScheduleId'collect['port_schedule_id']=port_schedule_idupdate_network_switch_port_schedule=UpdateNetworkSwitchPortScheduleModel()collect['update_network_switch_port_schedule']=update_network_switch_port_scheduleresult=switch_port_schedules_controller.update_network_switch_port_schedule(collect)Back to List of ControllersSwitchPortsControllerGet controller instanceAn instance of theSwitchPortsControllerclass can be accessed from the API Client.switch_ports_controller=client.switch_portsget_device_switch_portsList the switch ports for a switchdefget_device_switch_ports(self,serial)ParametersParameterTagsDescriptionserialRequiredTODO: Add a parameter descriptionExample Usageserial='serial'result=switch_ports_controller.get_device_switch_ports(serial)get_device_switch_portReturn a switch portdefget_device_switch_port(self,options=dict())ParametersParameterTagsDescriptionserialRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionExample Usagecollect={}serial='serial'collect['serial']=serialnumber='number'collect['number']=numberresult=switch_ports_controller.get_device_switch_port(collect)update_device_switch_portUpdate a switch portdefupdate_device_switch_port(self,options=dict())ParametersParameterTagsDescriptionserialRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionupdateDeviceSwitchPortOptionalTODO: Add a parameter descriptionExample Usagecollect={}serial='serial'collect['serial']=serialnumber='number'collect['number']=numberupdate_device_switch_port=UpdateDeviceSwitchPortModel()collect['update_device_switch_port']=update_device_switch_portresult=switch_ports_controller.update_device_switch_port(collect)Back to List of ControllersSwitchProfilesControllerGet controller instanceAn instance of theSwitchProfilesControllerclass can be accessed from the API Client.switch_profiles_controller=client.switch_profilesget_organization_config_template_switch_profilesList the switch profiles for your switch template configurationdefget_organization_config_template_switch_profiles(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptionconfigTemplateIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idconfig_template_id='configTemplateId'collect['config_template_id']=config_template_idresult=switch_profiles_controller.get_organization_config_template_switch_profiles(collect)Back to List of ControllersSwitchSettingsControllerGet controller instanceAn instance of theSwitchSettingsControllerclass can be accessed from the API Client.switch_settings_controller=client.switch_settingsget_network_switch_settingsReturns the switch network settingsdefget_network_switch_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=switch_settings_controller.get_network_switch_settings(network_id)update_network_switch_settingsUpdate switch network settingsdefupdate_network_switch_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSwitchSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_switch_settings=UpdateNetworkSwitchSettingsModel()collect['update_network_switch_settings']=update_network_switch_settingsresult=switch_settings_controller.update_network_switch_settings(collect)get_network_switch_settings_mtuReturn the MTU configurationdefget_network_switch_settings_mtu(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=switch_settings_controller.get_network_switch_settings_mtu(network_id)update_network_switch_settings_mtuUpdate the MTU configurationdefupdate_network_switch_settings_mtu(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSwitchSettingsMtuOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_switch_settings_mtu=UpdateNetworkSwitchSettingsMtuModel()collect['update_network_switch_settings_mtu']=update_network_switch_settings_mturesult=switch_settings_controller.update_network_switch_settings_mtu(collect)get_network_switch_settings_qos_rulesList quality of service rulesdefget_network_switch_settings_qos_rules(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=switch_settings_controller.get_network_switch_settings_qos_rules(network_id)create_network_switch_settings_qos_ruleAdd a quality of service ruledefcreate_network_switch_settings_qos_rule(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkSwitchSettingsQosRuleRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_switch_settings_qos_rule=CreateNetworkSwitchSettingsQosRuleModel()collect['create_network_switch_settings_qos_rule']=create_network_switch_settings_qos_ruleresult=switch_settings_controller.create_network_switch_settings_qos_rule(collect)get_network_switch_settings_qos_rules_orderReturn the quality of service rule IDs by order in which they will be processed by the switchdefget_network_switch_settings_qos_rules_order(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=switch_settings_controller.get_network_switch_settings_qos_rules_order(network_id)update_network_switch_settings_qos_rules_orderUpdate the order in which the rules should be processed by the switchdefupdate_network_switch_settings_qos_rules_order(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSwitchSettingsQosRulesOrderRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_switch_settings_qos_rules_order=UpdateNetworkSwitchSettingsQosRulesOrderModel()collect['update_network_switch_settings_qos_rules_order']=update_network_switch_settings_qos_rules_orderresult=switch_settings_controller.update_network_switch_settings_qos_rules_order(collect)get_network_switch_settings_qos_ruleReturn a quality of service ruledefget_network_switch_settings_qos_rule(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionqosRuleIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idqos_rule_id='qosRuleId'collect['qos_rule_id']=qos_rule_idresult=switch_settings_controller.get_network_switch_settings_qos_rule(collect)delete_network_switch_settings_qos_ruleDelete a quality of service ruledefdelete_network_switch_settings_qos_rule(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionqosRuleIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idqos_rule_id='qosRuleId'collect['qos_rule_id']=qos_rule_idswitch_settings_controller.delete_network_switch_settings_qos_rule(collect)update_network_switch_settings_qos_ruleUpdate a quality of service ruledefupdate_network_switch_settings_qos_rule(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionqosRuleIdRequiredTODO: Add a parameter descriptionupdateNetworkSwitchSettingsQosRuleOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idqos_rule_id='qosRuleId'collect['qos_rule_id']=qos_rule_idupdate_network_switch_settings_qos_rule=UpdateNetworkSwitchSettingsQosRuleModel()collect['update_network_switch_settings_qos_rule']=update_network_switch_settings_qos_ruleresult=switch_settings_controller.update_network_switch_settings_qos_rule(collect)get_network_switch_settings_storm_controlReturn the global enhanced storm control configurationdefget_network_switch_settings_storm_control(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=switch_settings_controller.get_network_switch_settings_storm_control(network_id)update_network_switch_settings_storm_controlUpdate the global enhanced storm control configurationdefupdate_network_switch_settings_storm_control(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSwitchSettingsStormControlOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_switch_settings_storm_control=UpdateNetworkSwitchSettingsStormControlModel()collect['update_network_switch_settings_storm_control']=update_network_switch_settings_storm_controlresult=switch_settings_controller.update_network_switch_settings_storm_control(collect)get_network_switch_settings_stpReturns STP settingsdefget_network_switch_settings_stp(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=switch_settings_controller.get_network_switch_settings_stp(network_id)update_network_switch_settings_stpUpdates STP settingsdefupdate_network_switch_settings_stp(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSwitchSettingsStpOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_switch_settings_stp=UpdateNetworkSwitchSettingsStpModel()collect['update_network_switch_settings_stp']=update_network_switch_settings_stpresult=switch_settings_controller.update_network_switch_settings_stp(collect)Back to List of ControllersSwitchStacksControllerGet controller instanceAn instance of theSwitchStacksControllerclass can be accessed from the API Client.switch_stacks_controller=client.switch_stacksget_network_switch_stacksList the switch stacks in a networkdefget_network_switch_stacks(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=switch_stacks_controller.get_network_switch_stacks(network_id)create_network_switch_stackCreate a stackdefcreate_network_switch_stack(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkSwitchStackRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_switch_stack=CreateNetworkSwitchStackModel()collect['create_network_switch_stack']=create_network_switch_stackresult=switch_stacks_controller.create_network_switch_stack(collect)get_network_switch_stackShow a switch stackdefget_network_switch_stack(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionswitchStackIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idswitch_stack_id='switchStackId'collect['switch_stack_id']=switch_stack_idresult=switch_stacks_controller.get_network_switch_stack(collect)delete_network_switch_stackDelete a stackdefdelete_network_switch_stack(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionswitchStackIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idswitch_stack_id='switchStackId'collect['switch_stack_id']=switch_stack_idswitch_stacks_controller.delete_network_switch_stack(collect)add_network_switch_stackAdd a switch to a stackdefadd_network_switch_stack(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionswitchStackIdRequiredTODO: Add a parameter descriptionaddNetworkSwitchStackRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idswitch_stack_id='switchStackId'collect['switch_stack_id']=switch_stack_idadd_network_switch_stack=AddNetworkSwitchStackModel()collect['add_network_switch_stack']=add_network_switch_stackresult=switch_stacks_controller.add_network_switch_stack(collect)remove_network_switch_stackRemove a switch from a stackdefremove_network_switch_stack(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionswitchStackIdRequiredTODO: Add a parameter descriptionremoveNetworkSwitchStackRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idswitch_stack_id='switchStackId'collect['switch_stack_id']=switch_stack_idremove_network_switch_stack=RemoveNetworkSwitchStackModel()collect['remove_network_switch_stack']=remove_network_switch_stackresult=switch_stacks_controller.remove_network_switch_stack(collect)Back to List of ControllersSyslogServersControllerGet controller instanceAn instance of theSyslogServersControllerclass can be accessed from the API Client.syslog_servers_controller=client.syslog_serversget_network_syslog_serversList the syslog servers for a networkdefget_network_syslog_servers(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=syslog_servers_controller.get_network_syslog_servers(network_id)update_network_syslog_serversUpdate the syslog servers for a networkdefupdate_network_syslog_servers(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkSyslogServersRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_syslog_servers=UpdateNetworkSyslogServersModel()collect['update_network_syslog_servers']=update_network_syslog_serversresult=syslog_servers_controller.update_network_syslog_servers(collect)Back to List of ControllersTrafficAnalysisSettingsControllerGet controller instanceAn instance of theTrafficAnalysisSettingsControllerclass can be accessed from the API Client.traffic_analysis_settings_controller=client.traffic_analysis_settingsget_network_traffic_analysis_settingsReturn the traffic analysis settings for a networkdefget_network_traffic_analysis_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=traffic_analysis_settings_controller.get_network_traffic_analysis_settings(network_id)update_network_traffic_analysis_settingsUpdate the traffic analysis settings for a networkdefupdate_network_traffic_analysis_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkTrafficAnalysisSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_traffic_analysis_settings=UpdateNetworkTrafficAnalysisSettingsModel()collect['update_network_traffic_analysis_settings']=update_network_traffic_analysis_settingsresult=traffic_analysis_settings_controller.update_network_traffic_analysis_settings(collect)Back to List of ControllersTrafficShapingControllerGet controller instanceAn instance of theTrafficShapingControllerclass can be accessed from the API Client.traffic_shaping_controller=client.traffic_shapingupdate_network_ssid_traffic_shapingUpdate the traffic shaping settings for an SSID on an MR networkdefupdate_network_ssid_traffic_shaping(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionupdateNetworkSsidTrafficShapingOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idnumber='number'collect['number']=numberupdate_network_ssid_traffic_shaping=UpdateNetworkSsidTrafficShapingModel()collect['update_network_ssid_traffic_shaping']=update_network_ssid_traffic_shapingresult=traffic_shaping_controller.update_network_ssid_traffic_shaping(collect)get_network_ssid_traffic_shapingDisplay the traffic shaping settings for a SSID on an MR networkdefget_network_ssid_traffic_shaping(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionnumberRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idnumber='number'collect['number']=numberresult=traffic_shaping_controller.get_network_ssid_traffic_shaping(collect)update_network_traffic_shapingUpdate the traffic shaping settings for an MX networkdefupdate_network_traffic_shaping(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkTrafficShapingOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_traffic_shaping=UpdateNetworkTrafficShapingModel()collect['update_network_traffic_shaping']=update_network_traffic_shapingresult=traffic_shaping_controller.update_network_traffic_shaping(collect)get_network_traffic_shapingDisplay the traffic shaping settings for an MX networkdefget_network_traffic_shaping(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=traffic_shaping_controller.get_network_traffic_shaping(network_id)get_network_traffic_shaping_application_categoriesReturns the application categories for traffic shaping rules.defget_network_traffic_shaping_application_categories(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=traffic_shaping_controller.get_network_traffic_shaping_application_categories(network_id)get_network_traffic_shaping_dscp_tagging_optionsReturns the available DSCP tagging options for your traffic shaping rules.defget_network_traffic_shaping_dscp_tagging_options(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=traffic_shaping_controller.get_network_traffic_shaping_dscp_tagging_options(network_id)Back to List of ControllersUplinkSettingsControllerGet controller instanceAn instance of theUplinkSettingsControllerclass can be accessed from the API Client.uplink_settings_controller=client.uplink_settingsget_network_uplink_settingsReturns the uplink settings for your MX network.defget_network_uplink_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=uplink_settings_controller.get_network_uplink_settings(network_id)update_network_uplink_settingsUpdates the uplink settings for your MX network.defupdate_network_uplink_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkUplinkSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_uplink_settings=UpdateNetworkUplinkSettingsModel()collect['update_network_uplink_settings']=update_network_uplink_settingsresult=uplink_settings_controller.update_network_uplink_settings(collect)Back to List of ControllersVlansControllerGet controller instanceAn instance of theVlansControllerclass can be accessed from the API Client.vlans_controller=client.vlansget_network_vlansList the VLANs for an MX networkdefget_network_vlans(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=vlans_controller.get_network_vlans(network_id)create_network_vlanAdd a VLANdefcreate_network_vlan(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptioncreateNetworkVlanRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idcreate_network_vlan=CreateNetworkVlanModel()collect['create_network_vlan']=create_network_vlanresult=vlans_controller.create_network_vlan(collect)get_network_vlanReturn a VLANdefget_network_vlan(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionvlanIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idvlan_id='vlanId'collect['vlan_id']=vlan_idresult=vlans_controller.get_network_vlan(collect)update_network_vlanUpdate a VLANdefupdate_network_vlan(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionvlanIdRequiredTODO: Add a parameter descriptionupdateNetworkVlanOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idvlan_id='vlanId'collect['vlan_id']=vlan_idupdate_network_vlan=UpdateNetworkVlanModel()collect['update_network_vlan']=update_network_vlanresult=vlans_controller.update_network_vlan(collect)delete_network_vlanDelete a VLAN from a networkdefdelete_network_vlan(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionvlanIdRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idvlan_id='vlanId'collect['vlan_id']=vlan_idvlans_controller.delete_network_vlan(collect)get_network_vlans_enabled_stateReturns the enabled status of VLANs for the networkdefget_network_vlans_enabled_state(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=vlans_controller.get_network_vlans_enabled_state(network_id)update_network_vlans_enabled_stateEnable/Disable VLANs for the given networkdefupdate_network_vlans_enabled_state(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetwork_vlans_EnabledStateRequiredTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_vlans_enabled_state=UpdateNetworkVlansEnabledStateModel()collect['update_network_vlans_enabled_state']=update_network_vlans_enabled_stateresult=vlans_controller.update_network_vlans_enabled_state(collect)Back to List of ControllersWebhookLogsControllerGet controller instanceAn instance of theWebhookLogsControllerclass can be accessed from the API Client.webhook_logs_controller=client.webhook_logsget_organization_webhook_logsReturn the log of webhook POSTs sentdefget_organization_webhook_logs(self,options=dict())ParametersParameterTagsDescriptionorganizationIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 90 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 31 days after t0.timespanOptionalThe timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.perPageOptionalThe number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.startingAfterOptionalA 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.endingBeforeOptionalA 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.urlOptionalThe URL the webhook was sent toExample Usagecollect={}organization_id='organizationId'collect['organization_id']=organization_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanper_page=175collect['per_page']=per_pagestarting_after='startingAfter'collect['starting_after']=starting_afterending_before='endingBefore'collect['ending_before']=ending_beforeurl='url'collect['url']=urlresult=webhook_logs_controller.get_organization_webhook_logs(collect)Back to List of ControllersWirelessHealthControllerGet controller instanceAn instance of theWirelessHealthControllerclass can be accessed from the API Client.wireless_health_controller=client.wireless_healthget_network_clients_connection_statsAggregated connectivity info for this network, grouped by clientsdefget_network_clients_connection_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagExample Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagresult=wireless_health_controller.get_network_clients_connection_stats(collect)get_network_clients_latency_statsAggregated latency info for this network, grouped by clientsdefget_network_clients_latency_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagfieldsOptionalPartial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagfields='fields'collect['fields']=fieldsresult=wireless_health_controller.get_network_clients_latency_stats(collect)get_network_client_connection_statsAggregated connectivity info for a given client on this network. Clients are identified by their MAC.defget_network_client_connection_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagExample Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagresult=wireless_health_controller.get_network_client_connection_stats(collect)get_network_client_latency_statsAggregated latency info for a given client on this network. Clients are identified by their MAC.defget_network_client_latency_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionclientIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagfieldsOptionalPartial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idclient_id='clientId'collect['client_id']=client_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagfields='fields'collect['fields']=fieldsresult=wireless_health_controller.get_network_client_latency_stats(collect)get_network_connection_statsAggregated connectivity info for this networkdefget_network_connection_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagExample Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagresult=wireless_health_controller.get_network_connection_stats(collect)get_network_devices_connection_statsAggregated connectivity info for this network, grouped by nodedefget_network_devices_connection_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagExample Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagresult=wireless_health_controller.get_network_devices_connection_stats(collect)get_network_devices_latency_statsAggregated latency info for this network, grouped by nodedefget_network_devices_latency_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagfieldsOptionalPartial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagfields='fields'collect['fields']=fieldsresult=wireless_health_controller.get_network_devices_latency_stats(collect)get_network_device_connection_statsAggregated connectivity info for a given AP on this networkdefget_network_device_connection_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagExample Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagresult=wireless_health_controller.get_network_device_connection_stats(collect)get_network_device_latency_statsAggregated latency info for a given AP on this networkdefget_network_device_latency_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionserialRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagfieldsOptionalPartial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idserial='serial'collect['serial']=serialt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagfields='fields'collect['fields']=fieldsresult=wireless_health_controller.get_network_device_latency_stats(collect)get_network_failed_connectionsList of all failed client connection events on this network in a given time rangedefget_network_failed_connections(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagserialOptionalFilter by APclientIdOptionalFilter by client MACExample Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=175.844870515095collect['timespan']=timespanssid=175collect['ssid']=ssidvlan=175collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagserial='serial'collect['serial']=serialclient_id='clientId'collect['client_id']=client_idresult=wireless_health_controller.get_network_failed_connections(collect)get_network_latency_statsAggregated latency info for this networkdefget_network_latency_stats(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptiont0OptionalThe beginning of the timespan for the data. The maximum lookback period is 180 days from today.t1OptionalThe end of the timespan for the data. t1 can be a maximum of 7 days after t0.timespanOptionalThe 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 7 days.ssidOptionalFilter results by SSIDvlanOptionalFilter results by VLANapTagOptionalFilter results by AP TagfieldsOptionalPartial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.Example Usagecollect={}network_id='networkId'collect['network_id']=network_idt_0='t0'collect['t_0']=t_0t_1='t1'collect['t_1']=t_1timespan=217.568043741662collect['timespan']=timespanssid=217collect['ssid']=ssidvlan=217collect['vlan']=vlanap_tag='apTag'collect['ap_tag']=ap_tagfields='fields'collect['fields']=fieldsresult=wireless_health_controller.get_network_latency_stats(collect)Back to List of ControllersWirelessSettingsControllerGet controller instanceAn instance of theWirelessSettingsControllerclass can be accessed from the API Client.wireless_settings_controller=client.wireless_settingsget_network_wireless_settingsReturn the wireless settings for a networkdefget_network_wireless_settings(self,network_id)ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionExample Usagenetwork_id='networkId'result=wireless_settings_controller.get_network_wireless_settings(network_id)update_network_wireless_settingsUpdate the wireless settings for a networkdefupdate_network_wireless_settings(self,options=dict())ParametersParameterTagsDescriptionnetworkIdRequiredTODO: Add a parameter descriptionupdateNetworkWirelessSettingsOptionalTODO: Add a parameter descriptionExample Usagecollect={}network_id='networkId'collect['network_id']=network_idupdate_network_wireless_settings=UpdateNetworkWirelessSettingsModel()collect['update_network_wireless_settings']=update_network_wireless_settingsresult=wireless_settings_controller.update_network_wireless_settings(collect)Back to List of Controllers