Python client library for Meraki Dashboard API
Project description
Getting started
Version 0.6.0
The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.
Date: 02 December, 2019
How to Build
You must have Python 2 >=2.7.9 or Python 3 >=3.4 installed 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 the requirements.txt file that comes with the SDK.
To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.
Python and PIP executables should be defined in your PATH. Open command prompt and type pip --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 (including
requirements.txt) for the SDK. - Run the command
pip install -r requirements.txt. This should install all the required dependencies.
How to Use
The following section explains how to use the TestMeraki SDK package in a new project.
1. Open Project in an IDE
Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on Open in PyCharm to browse to your generated SDK directory and then click OK.
The project files will be displayed in the side bar as follows:
2. Add a new Test Project
Create 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 lines
from test_meraki.test_meraki_client import TestMerakiClient
After 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 Project
To run the file within your test project, right click on your Python file inside your Test project and click on Run
How to Test
You 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.
- Invoke
pip install -r test-requirements.txt - Invoke
nosetests
Initialization
Authentication
In order to setup authentication and initialization of the API client, you need the following information.
| Parameter | Description |
|---|---|
| x_cisco_meraki_api_key | TODO: add a description |
API client can be initialized as following.
# Configuration parameters and credentials
x_cisco_meraki_api_key = 'x_cisco_meraki_api_key'
client = TestMerakiClient(x_cisco_meraki_api_key)
Class Reference
List of Controllers
- APIUsageController
- ActionBatchesController
- AdminsController
- AlertSettingsController
- BluetoothClientsController
- CamerasController
- ClientsController
- ConfigTemplatesController
- ConnectivityMonitoringDestinationsController
- ContentFilteringCategoriesController
- ContentFilteringRulesController
- DashboardBrandingPoliciesController
- DevicesController
- EventsController
- FirewalledServicesController
- FloorplansController
- GroupPoliciesController
- HTTPServersController
- IntrusionSettingsController
- LicensesController
- MRL3FirewallController
- MVSenseController
- MX11NATRulesController
- MX1ManyNATRulesController
- MXL3FirewallController
- MXL7ApplicationCategoriesController
- MXL7FirewallController
- MXVLANPortsController
- MXVPNFirewallController
- MXCellularFirewallController
- MXPortForwardingRulesController
- MXStaticRoutesController
- MXWarmSpareSettingsController
- MalwareSettingsController
- ManagementInterfaceSettingsController
- MerakiAuthUsersController
- NamedTagScopeController
- NetFlowSettingsController
- NetworksController
- OpenAPISpecController
- OrganizationsController
- PIIController
- RadioSettingsController
- SAMLRolesController
- SMController
- SNMPSettingsController
- SSIDsController
- SecurityEventsController
- SplashLoginAttemptsController
- SplashSettingsController
- SwitchACLsController
- SwitchPortSchedulesController
- SwitchPortsController
- SwitchProfilesController
- SwitchSettingsController
- SwitchStacksController
- SyslogServersController
- TrafficAnalysisSettingsController
- TrafficShapingController
- UplinkSettingsController
- VLANsController
- WebhookLogsController
- WirelessHealthController
- WirelessSettingsController
APIUsageController
Get controller instance
An instance of the APIUsageController class can be accessed from the API Client.
api_usage_controller = client.api_usage
get_organization_api_requests
List the API requests made by an organization
def get_organization_api_requests(self,
organization_id,
t_0=None,
t_1=None,
timespan=None,
per_page=None,
starting_after=None,
ending_before=None,
admin_id=None,
path=None,
method=None,
response_code=None,
source_ip=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| adminId | Optional |
Filter the results by the ID of the admin who made the API requests |
| path | Optional |
Filter the results by the path of the API requests |
| method | Optional |
Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') |
| responseCode | Optional |
Filter the results by the response code of the API requests |
| sourceIp | Optional |
Filter the results by the IP address of the originating API request |
Example Usage
organization_id = 'organizationId'
t_0 = 't0'
t_1 = 't1'
timespan = 63.6292780137757
per_page = 63
starting_after = 'startingAfter'
ending_before = 'endingBefore'
admin_id = 'adminId'
path = 'path'
method = 'method'
response_code = 63
source_ip = 'sourceIp'
result = api_usage_controller.get_organization_api_requests(organization_id, t_0, t_1, timespan, per_page, starting_after, ending_before, admin_id, path, method, response_code, source_ip)
ActionBatchesController
Get controller instance
An instance of the ActionBatchesController class can be accessed from the API Client.
action_batches_controller = client.action_batches
create_organization_action_batch
Create an action batch
def create_organization_action_batch(self,
organization_id,
create_organization_action_batch)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| createOrganizationActionBatch | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
create_organization_action_batch = CreateOrganizationActionBatch()
result = action_batches_controller.create_organization_action_batch(organization_id, create_organization_action_batch)
get_organization_action_batches
Return the list of action batches in the organization
def get_organization_action_batches(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = action_batches_controller.get_organization_action_batches(organization_id)
get_organization_action_batch
Return an action batch
def get_organization_action_batch(self,
organization_id,
action_batch_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| actionBatchId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
action_batch_id = 'actionBatchId'
result = action_batches_controller.get_organization_action_batch(organization_id, action_batch_id)
delete_organization_action_batch
Delete an action batch
def delete_organization_action_batch(self,
organization_id,
action_batch_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| actionBatchId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
action_batch_id = 'actionBatchId'
action_batches_controller.delete_organization_action_batch(organization_id, action_batch_id)
update_organization_action_batch
Update an action batch
def update_organization_action_batch(self,
organization_id,
action_batch_id,
update_organization_action_batch=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| actionBatchId | Required |
TODO: Add a parameter description |
| updateOrganizationActionBatch | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
action_batch_id = 'actionBatchId'
update_organization_action_batch = UpdateOrganizationActionBatch()
result = action_batches_controller.update_organization_action_batch(organization_id, action_batch_id, update_organization_action_batch)
AdminsController
Get controller instance
An instance of the AdminsController class can be accessed from the API Client.
admins_controller = client.admins
get_organization_admins
List the dashboard administrators in this organization
def get_organization_admins(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = admins_controller.get_organization_admins(organization_id)
create_organization_admin
Create a new dashboard administrator
def create_organization_admin(self,
organization_id,
create_organization_admin)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| createOrganizationAdmin | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
create_organization_admin = CreateOrganizationAdmin()
result = admins_controller.create_organization_admin(organization_id, create_organization_admin)
update_organization_admin
Update an administrator
def update_organization_admin(self,
organization_id,
id,
update_organization_admin=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
| updateOrganizationAdmin | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
id = 'id'
update_organization_admin = UpdateOrganizationAdmin()
result = admins_controller.update_organization_admin(organization_id, id, update_organization_admin)
delete_organization_admin
Revoke all access for a dashboard administrator within this organization
def delete_organization_admin(self,
organization_id,
id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
id = 'id'
admins_controller.delete_organization_admin(organization_id, id)
AlertSettingsController
Get controller instance
An instance of the AlertSettingsController class can be accessed from the API Client.
alert_settings_controller = client.alert_settings
get_network_alert_settings
Return the alert configuration for this network
def get_network_alert_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = alert_settings_controller.get_network_alert_settings(network_id)
update_network_alert_settings
Update the alert configuration for this network
def update_network_alert_settings(self,
network_id,
update_network_alert_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkAlertSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_alert_settings = UpdateNetworkAlertSettings()
result = alert_settings_controller.update_network_alert_settings(network_id, update_network_alert_settings)
BluetoothClientsController
Get controller instance
An instance of the BluetoothClientsController class can be accessed from the API Client.
bluetooth_clients_controller = client.bluetooth_clients
get_network_bluetooth_clients
List the Bluetooth clients seen by APs in this network
def get_network_bluetooth_clients(self,
network_id,
t_0=None,
timespan=None,
per_page=None,
starting_after=None,
ending_before=None,
include_connectivity_history=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 7 days from today. |
| timespan | Optional |
The 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. |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| includeConnectivityHistory | Optional |
Include the connectivity history for this client |
Example Usage
network_id = 'networkId'
t_0 = 't0'
timespan = 63.6292780137757
per_page = 63
starting_after = 'startingAfter'
ending_before = 'endingBefore'
include_connectivity_history = False
result = bluetooth_clients_controller.get_network_bluetooth_clients(network_id, t_0, timespan, per_page, starting_after, ending_before, include_connectivity_history)
get_network_bluetooth_client
Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.
def get_network_bluetooth_client(self,
network_id,
bluetooth_client_id,
include_connectivity_history=None,
connectivity_history_timespan=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| bluetoothClientId | Required |
TODO: Add a parameter description |
| includeConnectivityHistory | Optional |
Include the connectivity history for this client |
| connectivityHistoryTimespan | Optional |
The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. |
Example Usage
network_id = 'networkId'
bluetooth_client_id = 'bluetoothClientId'
include_connectivity_history = False
connectivity_history_timespan = 63
result = bluetooth_clients_controller.get_network_bluetooth_client(network_id, bluetooth_client_id, include_connectivity_history, connectivity_history_timespan)
CamerasController
Get controller instance
An instance of the CamerasController class can be accessed from the API Client.
cameras_controller = client.cameras
create_generate_network_camera_snapshot
Generate a snapshot of what the camera sees at the specified time and return a link to that image.
def create_generate_network_camera_snapshot(self,
network_id,
serial,
generate_network_camera_snapshot=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| generateNetworkCameraSnapshot | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
generate_network_camera_snapshot = GenerateNetworkCameraSnapshot()
result = cameras_controller.create_generate_network_camera_snapshot(network_id, serial, generate_network_camera_snapshot)
get_network_camera_video_link
Returns video link to the specified camera. If a timestamp is supplied, it links to that timestamp.
def get_network_camera_video_link(self,
network_id,
serial,
timestamp=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| timestamp | Optional |
[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 Usage
network_id = 'networkId'
serial = 'serial'
timestamp = 'timestamp'
result = cameras_controller.get_network_camera_video_link(network_id, serial, timestamp)
ClientsController
Get controller instance
An instance of the ClientsController class can be accessed from the API Client.
clients_controller = client.clients
get_device_clients
List 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.
def get_device_clients(self,
serial,
t_0=None,
timespan=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| serial | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. |
| timespan | Optional |
The 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 Usage
serial = 'serial'
t_0 = 't0'
timespan = 63.6292780137757
result = clients_controller.get_device_clients(serial, t_0, timespan)
get_network_clients
List the clients that have used this network in the timespan
def get_network_clients(self,
network_id,
t_0=None,
timespan=None,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. |
| timespan | Optional |
The 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. |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
Example Usage
network_id = 'networkId'
t_0 = 't0'
timespan = 63.6292780137757
per_page = 63
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = clients_controller.get_network_clients(network_id, t_0, timespan, per_page, starting_after, ending_before)
create_provision_network_clients
Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.
def create_provision_network_clients(self,
network_id,
provision_network_clients=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| provisionNetworkClients | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
provision_network_clients = ProvisionNetworkClients()
result = clients_controller.create_provision_network_clients(network_id, provision_network_clients)
get_network_client
Return 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.
def get_network_client(self,
network_id,
client_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
result = clients_controller.get_network_client(network_id, client_id)
get_network_client_events
Return 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.
def get_network_client_events(self,
network_id,
client_id,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 100. Default is 100. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
per_page = 63
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = clients_controller.get_network_client_events(network_id, client_id, per_page, starting_after, ending_before)
get_network_client_latency_history
Return 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.
def get_network_client_latency_history(self,
network_id,
client_id,
t_0=None,
t_1=None,
timespan=None,
resolution=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 791 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 791 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 1 day. |
| resolution | Optional |
The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
t_0 = 't0'
t_1 = 't1'
timespan = 63.6292780137757
resolution = 63
result = clients_controller.get_network_client_latency_history(network_id, client_id, t_0, t_1, timespan, resolution)
get_network_client_policy
Return 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.
def get_network_client_policy(self,
network_id,
client_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
result = clients_controller.get_network_client_policy(network_id, client_id)
update_network_client_policy
Update 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.
def update_network_client_policy(self,
network_id,
client_id,
update_network_client_policy=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
| updateNetworkClientPolicy | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
update_network_client_policy = UpdateNetworkClientPolicy()
result = clients_controller.update_network_client_policy(network_id, client_id, update_network_client_policy)
get_network_client_splash_authorization_status
Return 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.
def get_network_client_splash_authorization_status(self,
network_id,
client_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
result = clients_controller.get_network_client_splash_authorization_status(network_id, client_id)
update_network_client_splash_authorization_status
Update 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.
def update_network_client_splash_authorization_status(self,
network_id,
client_id,
update_network_client_splash_authorization_status=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
| updateNetworkClientSplashAuthorizationStatus | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
update_network_client_splash_authorization_status = UpdateNetworkClientSplashAuthorizationStatus()
result = clients_controller.update_network_client_splash_authorization_status(network_id, client_id, update_network_client_splash_authorization_status)
get_network_client_traffic_history
Return 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.
def get_network_client_traffic_history(self,
network_id,
client_id,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
per_page = 63
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = clients_controller.get_network_client_traffic_history(network_id, client_id, per_page, starting_after, ending_before)
get_network_client_usage_history
Return 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.
def get_network_client_usage_history(self,
network_id,
client_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
result = clients_controller.get_network_client_usage_history(network_id, client_id)
ConfigTemplatesController
Get controller instance
An instance of the ConfigTemplatesController class can be accessed from the API Client.
config_templates_controller = client.config_templates
get_organization_config_templates
List the configuration templates for this organization
def get_organization_config_templates(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = config_templates_controller.get_organization_config_templates(organization_id)
delete_organization_config_template
Remove a configuration template
def delete_organization_config_template(self,
organization_id,
config_template_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| configTemplateId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
config_template_id = 'configTemplateId'
config_templates_controller.delete_organization_config_template(organization_id, config_template_id)
ConnectivityMonitoringDestinationsController
Get controller instance
An instance of the ConnectivityMonitoringDestinationsController class can be accessed from the API Client.
connectivity_monitoring_destinations_controller = client.connectivity_monitoring_destinations
get_network_connectivity_monitoring_destinations
Return the connectivity testing destinations for an MX network
def get_network_connectivity_monitoring_destinations(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = connectivity_monitoring_destinations_controller.get_network_connectivity_monitoring_destinations(network_id)
update_network_connectivity_monitoring_destinations
Update the connectivity testing destinations for an MX network
def update_network_connectivity_monitoring_destinations(self,
network_id,
update_network_connectivity_monitoring_destinations=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkConnectivityMonitoringDestinations | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_connectivity_monitoring_destinations = UpdateNetworkConnectivityMonitoringDestinations()
result = connectivity_monitoring_destinations_controller.update_network_connectivity_monitoring_destinations(network_id, update_network_connectivity_monitoring_destinations)
ContentFilteringCategoriesController
Get controller instance
An instance of the ContentFilteringCategoriesController class can be accessed from the API Client.
content_filtering_categories_controller = client.content_filtering_categories
get_network_content_filtering_categories
List all available content filtering categories for an MX network
def get_network_content_filtering_categories(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = content_filtering_categories_controller.get_network_content_filtering_categories(network_id)
ContentFilteringRulesController
Get controller instance
An instance of the ContentFilteringRulesController class can be accessed from the API Client.
content_filtering_rules_controller = client.content_filtering_rules
get_network_content_filtering
Return the content filtering settings for an MX network
def get_network_content_filtering(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = content_filtering_rules_controller.get_network_content_filtering(network_id)
update_network_content_filtering
Update the content filtering settings for an MX network
def update_network_content_filtering(self,
network_id,
update_network_content_filtering=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkContentFiltering | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_content_filtering = UpdateNetworkContentFiltering()
result = content_filtering_rules_controller.update_network_content_filtering(network_id, update_network_content_filtering)
DashboardBrandingPoliciesController
Get controller instance
An instance of the DashboardBrandingPoliciesController class can be accessed from the API Client.
dashboard_branding_policies_controller = client.dashboard_branding_policies
get_organization_branding_policies
List the branding policies of an organization
def get_organization_branding_policies(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = dashboard_branding_policies_controller.get_organization_branding_policies(organization_id)
create_organization_branding_policy
Add a new branding policy to an organization
def create_organization_branding_policy(self,
organization_id,
create_organization_branding_policy)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| createOrganizationBrandingPolicy | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
create_organization_branding_policy = CreateOrganizationBrandingPolicy()
result = dashboard_branding_policies_controller.create_organization_branding_policy(organization_id, create_organization_branding_policy)
get_organization_branding_policies_priorities
Return 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).
def get_organization_branding_policies_priorities(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = dashboard_branding_policies_controller.get_organization_branding_policies_priorities(organization_id)
update_organization_branding_policies_priorities
Update the priority ordering of an organization's branding policies.
def update_organization_branding_policies_priorities(self,
organization_id,
update_organization_branding_policies_priorities)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| updateOrganizationBrandingPoliciesPriorities | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
update_organization_branding_policies_priorities = UpdateOrganizationBrandingPoliciesPriorities()
result = dashboard_branding_policies_controller.update_organization_branding_policies_priorities(organization_id, update_organization_branding_policies_priorities)
get_organization_branding_policy
Return a branding policy
def get_organization_branding_policy(self,
organization_id,
branding_policy_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| brandingPolicyId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
branding_policy_id = 'brandingPolicyId'
result = dashboard_branding_policies_controller.get_organization_branding_policy(organization_id, branding_policy_id)
update_organization_branding_policy
Update a branding policy
def update_organization_branding_policy(self,
organization_id,
branding_policy_id,
update_organization_branding_policy=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| brandingPolicyId | Required |
TODO: Add a parameter description |
| updateOrganizationBrandingPolicy | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
branding_policy_id = 'brandingPolicyId'
update_organization_branding_policy = UpdateOrganizationBrandingPolicy()
result = dashboard_branding_policies_controller.update_organization_branding_policy(organization_id, branding_policy_id, update_organization_branding_policy)
delete_organization_branding_policy
Delete a branding policy
def delete_organization_branding_policy(self,
organization_id,
branding_policy_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| brandingPolicyId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
branding_policy_id = 'brandingPolicyId'
dashboard_branding_policies_controller.delete_organization_branding_policy(organization_id, branding_policy_id)
DevicesController
Get controller instance
An instance of the DevicesController class can be accessed from the API Client.
devices_controller = client.devices
get_network_devices
List the devices in a network
def get_network_devices(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = devices_controller.get_network_devices(network_id)
create_claim_network_devices
Claim a device into a network
def create_claim_network_devices(self,
network_id,
claim_network_devices)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| claimNetworkDevices | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
claim_network_devices = ClaimNetworkDevices()
devices_controller.create_claim_network_devices(network_id, claim_network_devices)
get_network_device
Return a single device
def get_network_device(self,
network_id,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
result = devices_controller.get_network_device(network_id, serial)
update_network_device
Update the attributes of a device
def update_network_device(self,
network_id,
serial,
update_network_device=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| updateNetworkDevice | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
update_network_device = UpdateNetworkDevice()
result = devices_controller.update_network_device(network_id, serial, update_network_device)
create_blink_network_device_leds
Blink the LEDs on a device
def create_blink_network_device_leds(self,
network_id,
serial,
blink_network_device_leds=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| blinkNetworkDeviceLeds | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
blink_network_device_leds = BlinkNetworkDeviceLeds()
result = devices_controller.create_blink_network_device_leds(network_id, serial, blink_network_device_leds)
get_network_device_lldp_cdp
List LLDP and CDP information for a device
def get_network_device_lldp_cdp(self,
network_id,
serial,
timespan=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| timespan | Optional |
The 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 Usage
network_id = 'networkId'
serial = 'serial'
timespan = 155
result = devices_controller.get_network_device_lldp_cdp(network_id, serial, timespan)
get_network_device_loss_and_latency_history
Get the uplink loss percentage and latency in milliseconds for a wired network device.
def get_network_device_loss_and_latency_history(self,
network_id,
serial,
ip,
t_0=None,
t_1=None,
timespan=None,
resolution=None,
uplink=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| ip | Required |
The destination IP used to obtain the requested stats. This is required. |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. |
| resolution | Optional |
The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. |
| uplink | Optional |
The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. |
Example Usage
network_id = 'networkId'
serial = 'serial'
ip = 'ip'
t_0 = 't0'
t_1 = 't1'
timespan = 155.124559905438
resolution = 155
uplink = UplinkEnum.WAN1
result = devices_controller.get_network_device_loss_and_latency_history(network_id, serial, ip, t_0, t_1, timespan, resolution, uplink)
get_network_device_performance
Return the performance score for a single device. Only primary MX devices supported. If no data is available, a 204 error code is returned.
def get_network_device_performance(self,
network_id,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
result = devices_controller.get_network_device_performance(network_id, serial)
create_reboot_network_device
Reboot a device
def create_reboot_network_device(self,
network_id,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
result = devices_controller.create_reboot_network_device(network_id, serial)
create_remove_network_device
Remove a single device
def create_remove_network_device(self,
network_id,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
devices_controller.create_remove_network_device(network_id, serial)
get_network_device_uplink
Return the uplink information for a device.
def get_network_device_uplink(self,
network_id,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
result = devices_controller.get_network_device_uplink(network_id, serial)
get_organization_devices
List the devices in an organization
def get_organization_devices(self,
organization_id,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
Example Usage
organization_id = 'organizationId'
per_page = 155
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = devices_controller.get_organization_devices(organization_id, per_page, starting_after, ending_before)
EventsController
Get controller instance
An instance of the EventsController class can be accessed from the API Client.
events_controller = client.events
get_network_events
List the events for the network
def get_network_events(self,
network_id,
product_type=None,
included_event_types=None,
excluded_event_types=None,
device_mac=None,
device_serial=None,
device_name=None,
client_ip=None,
client_mac=None,
client_name=None,
sm_device_mac=None,
sm_device_name=None,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| productType | Optional |
The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, and camera |
| includedEventTypes | Optional Collection |
A list of event types. The returned events will be filtered to only include events with these types. |
| excludedEventTypes | Optional Collection |
A list of event types. The returned events will be filtered to exclude events with these types. |
| deviceMac | Optional |
The MAC address of the Meraki device which the list of events will be filtered with |
| deviceSerial | Optional |
The serial of the Meraki device which the list of events will be filtered with |
| deviceName | Optional |
The name of the Meraki device which the list of events will be filtered with |
| clientIp | Optional |
The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. |
| clientMac | Optional |
The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. |
| clientName | Optional |
The name, or partial name, of the client which the list of events will be filtered with |
| smDeviceMac | Optional |
The MAC address of the Systems Manager device which the list of events will be filtered with |
| smDeviceName | Optional |
The name of the Systems Manager device which the list of events will be filtered with |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
Example Usage
network_id = 'networkId'
product_type = 'productType'
included_event_types = ['includedEventTypes']
excluded_event_types = ['excludedEventTypes']
device_mac = 'deviceMac'
device_serial = 'deviceSerial'
device_name = 'deviceName'
client_ip = 'clientIp'
client_mac = 'clientMac'
client_name = 'clientName'
sm_device_mac = 'smDeviceMac'
sm_device_name = 'smDeviceName'
per_page = 155
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = events_controller.get_network_events(network_id, product_type, included_event_types, excluded_event_types, device_mac, device_serial, device_name, client_ip, client_mac, client_name, sm_device_mac, sm_device_name, per_page, starting_after, ending_before)
get_network_events_event_types
List the event type to human-readable description
def get_network_events_event_types(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = events_controller.get_network_events_event_types(network_id)
FirewalledServicesController
Get controller instance
An instance of the FirewalledServicesController class can be accessed from the API Client.
firewalled_services_controller = client.firewalled_services
get_network_firewalled_services
List the appliance services and their accessibility rules
def get_network_firewalled_services(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = firewalled_services_controller.get_network_firewalled_services(network_id)
get_network_firewalled_service
Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')
def get_network_firewalled_service(self,
network_id,
service)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| service | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
service = 'service'
result = firewalled_services_controller.get_network_firewalled_service(network_id, service)
update_network_firewalled_service
Updates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')
def update_network_firewalled_service(self,
network_id,
service,
update_network_firewalled_service)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| service | Required |
TODO: Add a parameter description |
| updateNetworkFirewalledService | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
service = 'service'
update_network_firewalled_service = UpdateNetworkFirewalledService()
result = firewalled_services_controller.update_network_firewalled_service(network_id, service, update_network_firewalled_service)
FloorplansController
Get controller instance
An instance of the FloorplansController class can be accessed from the API Client.
floorplans_controller = client.floorplans
get_network_floor_plans
List the floor plans that belong to your network
def get_network_floor_plans(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = floorplans_controller.get_network_floor_plans(network_id)
create_network_floor_plan
Upload a floor plan
def create_network_floor_plan(self,
network_id,
create_network_floor_plan)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkFloorPlan | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_floor_plan = CreateNetworkFloorPlan()
result = floorplans_controller.create_network_floor_plan(network_id, create_network_floor_plan)
get_network_floor_plan
Find a floor plan by ID
def get_network_floor_plan(self,
network_id,
floor_plan_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| floorPlanId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
floor_plan_id = 'floorPlanId'
result = floorplans_controller.get_network_floor_plan(network_id, floor_plan_id)
update_network_floor_plan
Update a floor plan's geolocation and other meta data
def update_network_floor_plan(self,
network_id,
floor_plan_id,
update_network_floor_plan=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| floorPlanId | Required |
TODO: Add a parameter description |
| updateNetworkFloorPlan | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
floor_plan_id = 'floorPlanId'
update_network_floor_plan = UpdateNetworkFloorPlan()
result = floorplans_controller.update_network_floor_plan(network_id, floor_plan_id, update_network_floor_plan)
delete_network_floor_plan
Destroy a floor plan
def delete_network_floor_plan(self,
network_id,
floor_plan_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| floorPlanId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
floor_plan_id = 'floorPlanId'
floorplans_controller.delete_network_floor_plan(network_id, floor_plan_id)
GroupPoliciesController
Get controller instance
An instance of the GroupPoliciesController class can be accessed from the API Client.
group_policies_controller = client.group_policies
get_network_group_policies
List the group policies in a network
def get_network_group_policies(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = group_policies_controller.get_network_group_policies(network_id)
create_network_group_policy
Create a group policy
def create_network_group_policy(self,
network_id,
create_network_group_policy)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkGroupPolicy | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_group_policy = CreateNetworkGroupPolicy()
result = group_policies_controller.create_network_group_policy(network_id, create_network_group_policy)
get_network_group_policy
Display a group policy
def get_network_group_policy(self,
network_id,
group_policy_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| groupPolicyId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
group_policy_id = 'groupPolicyId'
result = group_policies_controller.get_network_group_policy(network_id, group_policy_id)
update_network_group_policy
Update a group policy
def update_network_group_policy(self,
network_id,
group_policy_id,
update_network_group_policy=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| groupPolicyId | Required |
TODO: Add a parameter description |
| updateNetworkGroupPolicy | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
group_policy_id = 'groupPolicyId'
update_network_group_policy = UpdateNetworkGroupPolicy()
result = group_policies_controller.update_network_group_policy(network_id, group_policy_id, update_network_group_policy)
delete_network_group_policy
Delete a group policy
def delete_network_group_policy(self,
network_id,
group_policy_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| groupPolicyId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
group_policy_id = 'groupPolicyId'
group_policies_controller.delete_network_group_policy(network_id, group_policy_id)
HTTPServersController
Get controller instance
An instance of the HTTPServersController class can be accessed from the API Client.
http_servers_controller = client.http_servers
get_network_http_servers
List the HTTP servers for a network
def get_network_http_servers(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = http_servers_controller.get_network_http_servers(network_id)
create_network_http_server
Add an HTTP server to a network
def create_network_http_server(self,
network_id,
create_network_http_server)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkHttpServer | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_http_server = CreateNetworkHttpServer()
result = http_servers_controller.create_network_http_server(network_id, create_network_http_server)
create_network_http_servers_webhook_test
Send a test webhook for a network
def create_network_http_servers_webhook_test(self,
network_id,
create_network_http_servers_webhook_test)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkHttpServersWebhookTest | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_http_servers_webhook_test = CreateNetworkHttpServersWebhookTest()
result = http_servers_controller.create_network_http_servers_webhook_test(network_id, create_network_http_servers_webhook_test)
get_network_http_servers_webhook_test
Return the status of a webhook test for a network
def get_network_http_servers_webhook_test(self,
network_id,
id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
id = 'id'
result = http_servers_controller.get_network_http_servers_webhook_test(network_id, id)
get_network_http_server
Return an HTTP server for a network
def get_network_http_server(self,
network_id,
id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
id = 'id'
result = http_servers_controller.get_network_http_server(network_id, id)
update_network_http_server
Update an HTTP server
def update_network_http_server(self,
network_id,
id,
update_network_http_server=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
| updateNetworkHttpServer | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
id = 'id'
update_network_http_server = UpdateNetworkHttpServer()
result = http_servers_controller.update_network_http_server(network_id, id, update_network_http_server)
delete_network_http_server
Delete an HTTP server from a network
def delete_network_http_server(self,
network_id,
id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
id = 'id'
http_servers_controller.delete_network_http_server(network_id, id)
IntrusionSettingsController
Get controller instance
An instance of the IntrusionSettingsController class can be accessed from the API Client.
intrusion_settings_controller = client.intrusion_settings
get_network_security_intrusion_settings
Returns all supported intrusion settings for an MX network
def get_network_security_intrusion_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = intrusion_settings_controller.get_network_security_intrusion_settings(network_id)
update_network_security_intrusion_settings
Set the supported intrusion settings for an MX network
def update_network_security_intrusion_settings(self,
network_id,
update_network_security_intrusion_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSecurityIntrusionSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_security_intrusion_settings = UpdateNetworkSecurityIntrusionSettings()
result = intrusion_settings_controller.update_network_security_intrusion_settings(network_id, update_network_security_intrusion_settings)
get_organization_security_intrusion_settings
Returns all supported intrusion settings for an organization
def get_organization_security_intrusion_settings(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = intrusion_settings_controller.get_organization_security_intrusion_settings(organization_id)
update_organization_security_intrusion_settings
Sets supported intrusion settings for an organization
def update_organization_security_intrusion_settings(self,
organization_id,
update_organization_security_intrusion_settings)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| updateOrganizationSecurityIntrusionSettings | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
update_organization_security_intrusion_settings = UpdateOrganizationSecurityIntrusionSettings()
result = intrusion_settings_controller.update_organization_security_intrusion_settings(organization_id, update_organization_security_intrusion_settings)
LicensesController
Get controller instance
An instance of the LicensesController class can be accessed from the API Client.
licenses_controller = client.licenses
get_organization_licenses
List the licenses for an organization
def get_organization_licenses(self,
organization_id,
per_page=None,
starting_after=None,
ending_before=None,
device_serial=None,
network_id=None,
state=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| deviceSerial | Optional |
Filter the licenses to those assigned to a particular device |
| networkId | Optional |
Filter the licenses to those assigned in a particular network |
| state | Optional |
Filter the licenses to those in a particular state. Can be one of 'active', 'expired', 'expiring', 'unused', 'unusedActive' or 'recentlyQueued' |
Example Usage
organization_id = 'organizationId'
per_page = 246
starting_after = 'startingAfter'
ending_before = 'endingBefore'
device_serial = 'deviceSerial'
network_id = 'networkId'
state = StateEnum.ACTIVE
result = licenses_controller.get_organization_licenses(organization_id, per_page, starting_after, ending_before, device_serial, network_id, state)
create_assign_organization_licenses_seats
Assign SM seats to a network. This will increase the managed SM device limit of the network
def create_assign_organization_licenses_seats(self,
organization_id,
assign_organization_licenses_seats)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| assignOrganizationLicensesSeats | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
assign_organization_licenses_seats = AssignOrganizationLicensesSeats()
result = licenses_controller.create_assign_organization_licenses_seats(organization_id, assign_organization_licenses_seats)
create_move_organization_licenses
Move licenses to another organization. This will also move any devices that the licenses are assigned to
def create_move_organization_licenses(self,
organization_id,
move_organization_licenses)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| moveOrganizationLicenses | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
move_organization_licenses = MoveOrganizationLicenses()
result = licenses_controller.create_move_organization_licenses(organization_id, move_organization_licenses)
create_move_organization_licenses_seats
Move SM seats to another organization
def create_move_organization_licenses_seats(self,
organization_id,
move_organization_licenses_seats)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| moveOrganizationLicensesSeats | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
move_organization_licenses_seats = MoveOrganizationLicensesSeats()
result = licenses_controller.create_move_organization_licenses_seats(organization_id, move_organization_licenses_seats)
create_renew_organization_licenses_seats
Renew SM seats of a license. This will extend the license expiration date of managed SM devices covered by this license
def create_renew_organization_licenses_seats(self,
organization_id,
renew_organization_licenses_seats)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| renewOrganizationLicensesSeats | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
renew_organization_licenses_seats = RenewOrganizationLicensesSeats()
result = licenses_controller.create_renew_organization_licenses_seats(organization_id, renew_organization_licenses_seats)
get_organization_license
Display a license
def get_organization_license(self,
organization_id,
license_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| licenseId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
license_id = 'licenseId'
result = licenses_controller.get_organization_license(organization_id, license_id)
update_organization_license
Update a license
def update_organization_license(self,
organization_id,
license_id,
update_organization_license=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| licenseId | Required |
TODO: Add a parameter description |
| updateOrganizationLicense | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
license_id = 'licenseId'
update_organization_license = UpdateOrganizationLicense()
result = licenses_controller.update_organization_license(organization_id, license_id, update_organization_license)
MRL3FirewallController
Get controller instance
An instance of the MRL3FirewallController class can be accessed from the API Client.
mr_l_3_firewall_controller = client.mr_l_3_firewall
get_network_ssid_l_3_firewall_rules
Return the L3 firewall rules for an SSID on an MR network
def get_network_ssid_l_3_firewall_rules(self,
network_id,
number)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
number = 'number'
result = mr_l_3_firewall_controller.get_network_ssid_l_3_firewall_rules(network_id, number)
update_network_ssid_l_3_firewall_rules
Update the L3 firewall rules of an SSID on an MR network
def update_network_ssid_l_3_firewall_rules(self,
network_id,
number,
update_network_ssid_l_3_firewall_rules=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
| updateNetworkSsidL3FirewallRules | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
number = 'number'
update_network_ssid_l_3_firewall_rules = UpdateNetworkSsidL3FirewallRules()
result = mr_l_3_firewall_controller.update_network_ssid_l_3_firewall_rules(network_id, number, update_network_ssid_l_3_firewall_rules)
MVSenseController
Get controller instance
An instance of the MVSenseController class can be accessed from the API Client.
mv_sense_controller = client.mv_sense
get_device_camera_analytics_live
Returns live state from camera of analytics zones
def get_device_camera_analytics_live(self,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| serial | Required |
TODO: Add a parameter description |
Example Usage
serial = 'serial'
result = mv_sense_controller.get_device_camera_analytics_live(serial)
get_device_camera_analytics_overview
Returns an overview of aggregate analytics data for a timespan
def get_device_camera_analytics_overview(self,
serial,
t_0=None,
t_1=None,
timespan=None,
object_type=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| serial | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 1 hour. |
| objectType | Optional |
[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. |
Example Usage
serial = 'serial'
t_0 = 't0'
t_1 = 't1'
timespan = 246.6198417971
object_type = ObjectTypeEnum.PERSON
result = mv_sense_controller.get_device_camera_analytics_overview(serial, t_0, t_1, timespan, object_type)
get_device_camera_analytics_recent
Returns most recent record for analytics zones
def get_device_camera_analytics_recent(self,
serial,
object_type=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| serial | Required |
TODO: Add a parameter description |
| objectType | Optional |
[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. |
Example Usage
serial = 'serial'
object_type = ObjectTypeEnum.PERSON
result = mv_sense_controller.get_device_camera_analytics_recent(serial, object_type)
get_device_camera_analytics_zones
Returns all configured analytic zones for this camera
def get_device_camera_analytics_zones(self,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| serial | Required |
TODO: Add a parameter description |
Example Usage
serial = 'serial'
result = mv_sense_controller.get_device_camera_analytics_zones(serial)
get_device_camera_analytics_zone_history
Return historical records for analytic zones
def get_device_camera_analytics_zone_history(self,
serial,
zone_id,
t_0=None,
t_1=None,
timespan=None,
resolution=None,
object_type=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| serial | Required |
TODO: Add a parameter description |
| zoneId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 14 hours. The default is 1 hour. |
| resolution | Optional |
The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. |
| objectType | Optional |
[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. |
Example Usage
serial = 'serial'
zone_id = 'zoneId'
t_0 = 't0'
t_1 = 't1'
timespan = 246.6198417971
resolution = 246
object_type = ObjectTypeEnum.PERSON
result = mv_sense_controller.get_device_camera_analytics_zone_history(serial, zone_id, t_0, t_1, timespan, resolution, object_type)
MX11NATRulesController
Get controller instance
An instance of the MX11NATRulesController class can be accessed from the API Client.
mx_1_1_nat_rules_controller = client.mx_1_1_nat_rules
get_network_one_to_one_nat_rules
Return the 1:1 NAT mapping rules for an MX network
def get_network_one_to_one_nat_rules(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_11_nat_rules_controller.get_network_one_to_one_nat_rules(network_id)
update_network_one_to_one_nat_rules
Set the 1:1 NAT mapping rules for an MX network
def update_network_one_to_one_nat_rules(self,
network_id,
update_network_one_to_one_nat_rules=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkOneToOneNatRules | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_one_to_one_nat_rules = UpdateNetworkOneToOneNatRules()
result = mx_11_nat_rules_controller.update_network_one_to_one_nat_rules(network_id, update_network_one_to_one_nat_rules)
MX1ManyNATRulesController
Get controller instance
An instance of the MX1ManyNATRulesController class can be accessed from the API Client.
mx_1_many_nat_rules_controller = client.mx_1_many_nat_rules
get_network_one_to_many_nat_rules
Return the 1:Many NAT mapping rules for an MX network
def get_network_one_to_many_nat_rules(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_1_many_nat_rules_controller.get_network_one_to_many_nat_rules(network_id)
update_network_one_to_many_nat_rules
Set the 1:Many NAT mapping rules for an MX network
def update_network_one_to_many_nat_rules(self,
network_id,
update_network_one_to_many_nat_rules=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkOneToManyNatRules | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_one_to_many_nat_rules = UpdateNetworkOneToManyNatRules()
result = mx_1_many_nat_rules_controller.update_network_one_to_many_nat_rules(network_id, update_network_one_to_many_nat_rules)
MXL3FirewallController
Get controller instance
An instance of the MXL3FirewallController class can be accessed from the API Client.
mx_l_3_firewall_controller = client.mx_l_3_firewall
get_network_l_3_firewall_rules
Return the L3 firewall rules for an MX network
def get_network_l_3_firewall_rules(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_l_3_firewall_controller.get_network_l_3_firewall_rules(network_id)
update_network_l_3_firewall_rules
Update the L3 firewall rules of an MX network
def update_network_l_3_firewall_rules(self,
network_id,
update_network_l_3_firewall_rules=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkL3FirewallRules | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_l_3_firewall_rules = UpdateNetworkL3FirewallRules()
result = mx_l_3_firewall_controller.update_network_l_3_firewall_rules(network_id, update_network_l_3_firewall_rules)
MXL7ApplicationCategoriesController
Get controller instance
An instance of the MXL7ApplicationCategoriesController class can be accessed from the API Client.
mx_l_7_application_categories_controller = client.mx_l_7_application_categories
get_network_l_7_firewall_rules_application_categories
Return the L7 firewall application categories and their associated applications for an MX network
def get_network_l_7_firewall_rules_application_categories(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_l_7_application_categories_controller.get_network_l_7_firewall_rules_application_categories(network_id)
MXL7FirewallController
Get controller instance
An instance of the MXL7FirewallController class can be accessed from the API Client.
mx_l_7_firewall_controller = client.mx_l_7_firewall
get_network_l_7_firewall_rules
List the MX L7 firewall rules for an MX network
def get_network_l_7_firewall_rules(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_l_7_firewall_controller.get_network_l_7_firewall_rules(network_id)
update_network_l_7_firewall_rules
Update the MX L7 firewall rules for an MX network
def update_network_l_7_firewall_rules(self,
network_id,
update_network_l_7_firewall_rules=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkL7FirewallRules | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_l_7_firewall_rules = UpdateNetworkL7FirewallRules()
result = mx_l_7_firewall_controller.update_network_l_7_firewall_rules(network_id, update_network_l_7_firewall_rules)
MXVLANPortsController
Get controller instance
An instance of the MXVLANPortsController class can be accessed from the API Client.
mx_vlan_ports_controller = client.mx_vlan_ports
get_network_appliance_ports
List per-port VLAN settings for all ports of a MX.
def get_network_appliance_ports(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_vlan_ports_controller.get_network_appliance_ports(network_id)
get_network_appliance_port
Return per-port VLAN settings for a single MX port.
def get_network_appliance_port(self,
network_id,
appliance_port_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| appliancePortId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
appliance_port_id = 'appliancePortId'
result = mx_vlan_ports_controller.get_network_appliance_port(network_id, appliance_port_id)
update_network_appliance_port
Update the per-port VLAN settings for a single MX port.
def update_network_appliance_port(self,
network_id,
appliance_port_id,
update_network_appliance_port=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| appliancePortId | Required |
TODO: Add a parameter description |
| updateNetworkAppliancePort | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
appliance_port_id = 'appliancePortId'
update_network_appliance_port = UpdateNetworkAppliancePort()
result = mx_vlan_ports_controller.update_network_appliance_port(network_id, appliance_port_id, update_network_appliance_port)
MXVPNFirewallController
Get controller instance
An instance of the MXVPNFirewallController class can be accessed from the API Client.
mx_vpn_firewall_controller = client.mx_vpn_firewall
get_organization_vpn_firewall_rules
Return the firewall rules for an organization's site-to-site VPN
def get_organization_vpn_firewall_rules(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = mx_vpn_firewall_controller.get_organization_vpn_firewall_rules(organization_id)
update_organization_vpn_firewall_rules
Update the firewall rules of an organization's site-to-site VPN
def update_organization_vpn_firewall_rules(self,
organization_id,
update_organization_vpn_firewall_rules=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| updateOrganizationVpnFirewallRules | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
update_organization_vpn_firewall_rules = UpdateOrganizationVpnFirewallRules()
result = mx_vpn_firewall_controller.update_organization_vpn_firewall_rules(organization_id, update_organization_vpn_firewall_rules)
MXCellularFirewallController
Get controller instance
An instance of the MXCellularFirewallController class can be accessed from the API Client.
mx_cellular_firewall_controller = client.mx_cellular_firewall
get_network_cellular_firewall_rules
Return the cellular firewall rules for an MX network
def get_network_cellular_firewall_rules(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_cellular_firewall_controller.get_network_cellular_firewall_rules(network_id)
update_network_cellular_firewall_rules
Update the cellular firewall rules of an MX network
def update_network_cellular_firewall_rules(self,
network_id,
update_network_cellular_firewall_rules=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkCellularFirewallRules | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_cellular_firewall_rules = UpdateNetworkCellularFirewallRules()
result = mx_cellular_firewall_controller.update_network_cellular_firewall_rules(network_id, update_network_cellular_firewall_rules)
MXPortForwardingRulesController
Get controller instance
An instance of the MXPortForwardingRulesController class can be accessed from the API Client.
mx_port_forwarding_rules_controller = client.mx_port_forwarding_rules
get_network_port_forwarding_rules
Return the port forwarding rules for an MX network
def get_network_port_forwarding_rules(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_port_forwarding_rules_controller.get_network_port_forwarding_rules(network_id)
update_network_port_forwarding_rules
Update the port forwarding rules for an MX network
def update_network_port_forwarding_rules(self,
network_id,
update_network_port_forwarding_rules=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkPortForwardingRules | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_port_forwarding_rules = UpdateNetworkPortForwardingRules()
result = mx_port_forwarding_rules_controller.update_network_port_forwarding_rules(network_id, update_network_port_forwarding_rules)
MXStaticRoutesController
Get controller instance
An instance of the MXStaticRoutesController class can be accessed from the API Client.
mx_static_routes_controller = client.mx_static_routes
get_network_static_routes
List the static routes for an MX or teleworker network
def get_network_static_routes(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_static_routes_controller.get_network_static_routes(network_id)
create_network_static_route
Add a static route for an MX or teleworker network
def create_network_static_route(self,
network_id,
create_network_static_route=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkStaticRoute | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_static_route = CreateNetworkStaticRoute()
result = mx_static_routes_controller.create_network_static_route(network_id, create_network_static_route)
get_network_static_route
Return a static route for an MX or teleworker network
def get_network_static_route(self,
network_id,
sr_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| srId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
sr_id = 'srId'
result = mx_static_routes_controller.get_network_static_route(network_id, sr_id)
update_network_static_route
Update a static route for an MX or teleworker network
def update_network_static_route(self,
network_id,
sr_id,
update_network_static_route=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| srId | Required |
TODO: Add a parameter description |
| updateNetworkStaticRoute | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
sr_id = 'srId'
update_network_static_route = UpdateNetworkStaticRoute()
result = mx_static_routes_controller.update_network_static_route(network_id, sr_id, update_network_static_route)
delete_network_static_route
Delete a static route from an MX or teleworker network
def delete_network_static_route(self,
network_id,
sr_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| srId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
sr_id = 'srId'
mx_static_routes_controller.delete_network_static_route(network_id, sr_id)
MXWarmSpareSettingsController
Get controller instance
An instance of the MXWarmSpareSettingsController class can be accessed from the API Client.
mx_warm_spare_settings_controller = client.mx_warm_spare_settings
create_swap_network_warmspare
Swap MX primary and warm spare appliances
def create_swap_network_warmspare(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_warm_spare_settings_controller.create_swap_network_warmspare(network_id)
get_network_warm_spare_settings
Return MX warm spare settings
def get_network_warm_spare_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = mx_warm_spare_settings_controller.get_network_warm_spare_settings(network_id)
update_network_warm_spare_settings
Update MX warm spare settings
def update_network_warm_spare_settings(self,
network_id,
update_network_warm_spare_settings)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkWarmSpareSettings | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_warm_spare_settings = UpdateNetworkWarmSpareSettings()
result = mx_warm_spare_settings_controller.update_network_warm_spare_settings(network_id, update_network_warm_spare_settings)
MalwareSettingsController
Get controller instance
An instance of the MalwareSettingsController class can be accessed from the API Client.
malware_settings_controller = client.malware_settings
get_network_security_malware_settings
Returns all supported malware settings for an MX network
def get_network_security_malware_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = malware_settings_controller.get_network_security_malware_settings(network_id)
update_network_security_malware_settings
Set the supported malware settings for an MX network
def update_network_security_malware_settings(self,
network_id,
update_network_security_malware_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSecurityMalwareSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_security_malware_settings = UpdateNetworkSecurityMalwareSettings()
result = malware_settings_controller.update_network_security_malware_settings(network_id, update_network_security_malware_settings)
ManagementInterfaceSettingsController
Get controller instance
An instance of the ManagementInterfaceSettingsController class can be accessed from the API Client.
management_interface_settings_controller = client.management_interface_settings
get_network_device_management_interface_settings
Return the management interface settings for a device
def get_network_device_management_interface_settings(self,
network_id,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
result = management_interface_settings_controller.get_network_device_management_interface_settings(network_id, serial)
update_network_device_management_interface_settings
Update the management interface settings for a device
def update_network_device_management_interface_settings(self,
network_id,
serial,
update_network_device_management_interface_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| updateNetworkDeviceManagementInterfaceSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
update_network_device_management_interface_settings = UpdateNetworkDeviceManagementInterfaceSettings()
result = management_interface_settings_controller.update_network_device_management_interface_settings(network_id, serial, update_network_device_management_interface_settings)
MerakiAuthUsersController
Get controller instance
An instance of the MerakiAuthUsersController class can be accessed from the API Client.
meraki_auth_users_controller = client.meraki_auth_users
get_network_meraki_auth_users
List the splash or RADIUS users configured under Meraki Authentication for a network
def get_network_meraki_auth_users(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = meraki_auth_users_controller.get_network_meraki_auth_users(network_id)
get_network_meraki_auth_user
Return the Meraki Auth splash or RADIUS user
def get_network_meraki_auth_user(self,
network_id,
meraki_auth_user_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| merakiAuthUserId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
meraki_auth_user_id = 'merakiAuthUserId'
result = meraki_auth_users_controller.get_network_meraki_auth_user(network_id, meraki_auth_user_id)
NamedTagScopeController
Get controller instance
An instance of the NamedTagScopeController class can be accessed from the API Client.
named_tag_scope_controller = client.named_tag_scope
get_network_sm_target_groups
List the target groups in this network
def get_network_sm_target_groups(self,
network_id,
with_details=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| withDetails | Optional |
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response |
Example Usage
network_id = 'networkId'
with_details = True
result = named_tag_scope_controller.get_network_sm_target_groups(network_id, with_details)
create_network_sm_target_group
Add a target group
def create_network_sm_target_group(self,
network_id,
create_network_sm_target_group=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkSmTargetGroup | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_sm_target_group = CreateNetworkSmTargetGroup()
result = named_tag_scope_controller.create_network_sm_target_group(network_id, create_network_sm_target_group)
get_network_sm_target_group
Return a target group
def get_network_sm_target_group(self,
network_id,
target_group_id,
with_details=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| targetGroupId | Required |
TODO: Add a parameter description |
| withDetails | Optional |
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response |
Example Usage
network_id = 'networkId'
target_group_id = 'targetGroupId'
with_details = True
result = named_tag_scope_controller.get_network_sm_target_group(network_id, target_group_id, with_details)
update_network_sm_target_group
Update a target group
def update_network_sm_target_group(self,
network_id,
target_group_id,
update_network_sm_target_group=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| targetGroupId | Required |
TODO: Add a parameter description |
| updateNetworkSmTargetGroup | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
target_group_id = 'targetGroupId'
update_network_sm_target_group = UpdateNetworkSmTargetGroup()
result = named_tag_scope_controller.update_network_sm_target_group(network_id, target_group_id, update_network_sm_target_group)
delete_network_sm_target_group
Delete a target group from a network
def delete_network_sm_target_group(self,
network_id,
target_group_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| targetGroupId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
target_group_id = 'targetGroupId'
named_tag_scope_controller.delete_network_sm_target_group(network_id, target_group_id)
NetFlowSettingsController
Get controller instance
An instance of the NetFlowSettingsController class can be accessed from the API Client.
net_flow_settings_controller = client.net_flow_settings
get_network_netflow_settings
Return the NetFlow traffic reporting settings for a network
def get_network_netflow_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = net_flow_settings_controller.get_network_netflow_settings(network_id)
update_network_netflow_settings
Update the NetFlow traffic reporting settings for a network
def update_network_netflow_settings(self,
network_id,
update_network_netflow_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkNetflowSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_netflow_settings = UpdateNetworkNetflowSettings()
result = net_flow_settings_controller.update_network_netflow_settings(network_id, update_network_netflow_settings)
NetworksController
Get controller instance
An instance of the NetworksController class can be accessed from the API Client.
networks_controller = client.networks
get_network
Return a network
def get_network(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = networks_controller.get_network(network_id)
update_network
Update a network
def update_network(self,
network_id,
update_network=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetwork | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network = UpdateNetwork()
result = networks_controller.update_network(network_id, update_network)
delete_network
Delete a network
def delete_network(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
networks_controller.delete_network(network_id)
get_network_access_policies
List the access policies for this network. Only valid for MS networks.
def get_network_access_policies(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = networks_controller.get_network_access_policies(network_id)
get_network_air_marshal
List Air Marshal scan results from a network
def get_network_air_marshal(self,
network_id,
t_0=None,
timespan=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. |
| timespan | Optional |
The 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 Usage
network_id = 'networkId'
t_0 = 't0'
timespan = 204.896668570534
result = networks_controller.get_network_air_marshal(network_id, t_0, timespan)
create_bind_network
Bind a network to a template.
def create_bind_network(self,
network_id,
bind_network)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| bindNetwork | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
bind_network = BindNetwork()
networks_controller.create_bind_network(network_id, bind_network)
get_network_bluetooth_settings
Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.
def get_network_bluetooth_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = networks_controller.get_network_bluetooth_settings(network_id)
update_network_bluetooth_settings
Update the Bluetooth settings for a network. See the docs page for Bluetooth settings.
def update_network_bluetooth_settings(self,
network_id,
update_network_bluetooth_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkBluetoothSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_bluetooth_settings = UpdateNetworkBluetoothSettings()
result = networks_controller.update_network_bluetooth_settings(network_id, update_network_bluetooth_settings)
get_network_site_to_site_vpn
Return the site-to-site VPN settings of a network. Only valid for MX networks.
def get_network_site_to_site_vpn(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = networks_controller.get_network_site_to_site_vpn(network_id)
update_network_site_to_site_vpn
Update the site-to-site VPN settings of a network. Only valid for MX networks in NAT mode.
def update_network_site_to_site_vpn(self,
network_id,
update_network_site_to_site_vpn)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSiteToSiteVpn | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_site_to_site_vpn = UpdateNetworkSiteToSiteVpn()
result = networks_controller.update_network_site_to_site_vpn(network_id, update_network_site_to_site_vpn)
create_split_network
Split a combined network into individual networks for each type of device
def create_split_network(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = networks_controller.create_split_network(network_id)
get_network_traffic
The 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.
def get_network_traffic(self,
network_id,
t_0=None,
timespan=None,
device_type=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 30 days from today. |
| timespan | Optional |
The 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. |
| deviceType | Optional |
Filter 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 Usage
network_id = 'networkId'
t_0 = 't0'
timespan = 204.896668570534
device_type = 'deviceType'
result = networks_controller.get_network_traffic(network_id, t_0, timespan, device_type)
create_unbind_network
Unbind a network from a template.
def create_unbind_network(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
networks_controller.create_unbind_network(network_id)
get_organization_networks
List the networks in an organization
def get_organization_networks(self,
organization_id,
config_template_id=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| configTemplateId | Optional |
An optional parameter that is the ID of a config template. Will return all networks bound to that template. |
Example Usage
organization_id = 'organizationId'
config_template_id = 'configTemplateId'
result = networks_controller.get_organization_networks(organization_id, config_template_id)
create_organization_network
Create a network
def create_organization_network(self,
organization_id,
create_organization_network)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| createOrganizationNetwork | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
create_organization_network = CreateOrganizationNetwork()
result = networks_controller.create_organization_network(organization_id, create_organization_network)
create_combine_organization_networks
Combine multiple networks into a single network
def create_combine_organization_networks(self,
organization_id,
combine_organization_networks)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| combineOrganizationNetworks | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
combine_organization_networks = CombineOrganizationNetworks()
result = networks_controller.create_combine_organization_networks(organization_id, combine_organization_networks)
OpenAPISpecController
Get controller instance
An instance of the OpenAPISpecController class can be accessed from the API Client.
open_api_spec_controller = client.open_api_spec
get_organization_openapi_spec
Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON
def get_organization_openapi_spec(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = open_api_spec_controller.get_organization_openapi_spec(organization_id)
OrganizationsController
Get controller instance
An instance of the OrganizationsController class can be accessed from the API Client.
organizations_controller = client.organizations
get_organizations
List the organizations that the user has privileges on
def get_organizations(self)
Example Usage
result = organizations_controller.get_organizations()
create_organization
Create a new organization
def create_organization(self,
create_organization)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| createOrganization | Required |
TODO: Add a parameter description |
Example Usage
create_organization = CreateOrganization()
result = organizations_controller.create_organization(create_organization)
get_organization
Return an organization
def get_organization(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = organizations_controller.get_organization(organization_id)
update_organization
Update an organization
def update_organization(self,
organization_id,
update_organization=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| updateOrganization | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
update_organization = UpdateOrganization()
result = organizations_controller.update_organization(organization_id, update_organization)
delete_organization
Delete an organization
def delete_organization(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
organizations_controller.delete_organization(organization_id)
create_claim_organization
Claim 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.
def create_claim_organization(self,
organization_id,
claim_organization=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| claimOrganization | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
claim_organization = ClaimOrganization()
result = organizations_controller.create_claim_organization(organization_id, claim_organization)
create_clone_organization
Create a new organization by cloning the addressed organization
def create_clone_organization(self,
organization_id,
clone_organization)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| cloneOrganization | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
clone_organization = CloneOrganization()
result = organizations_controller.create_clone_organization(organization_id, clone_organization)
get_organization_device_statuses
List the status of every Meraki device in the organization
def get_organization_device_statuses(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = organizations_controller.get_organization_device_statuses(organization_id)
get_organization_inventory
Return the inventory for an organization
def get_organization_inventory(self,
organization_id,
include_license_info=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| includeLicenseInfo | Optional |
When this parameter is true, each entity in the response will include the license expiration date of the device (if any). Only applies to organizations that support per-device licensing. Defaults to false. |
Example Usage
organization_id = 'organizationId'
include_license_info = False
result = organizations_controller.get_organization_inventory(organization_id, include_license_info)
get_organization_license_state
Return the license state for an organization
def get_organization_license_state(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = organizations_controller.get_organization_license_state(organization_id)
get_organization_third_party_vpn_peers
Return the third party VPN peers for an organization
def get_organization_third_party_vpn_peers(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = organizations_controller.get_organization_third_party_vpn_peers(organization_id)
update_organization_third_party_vpn_peers
Update the third party VPN peers for an organization
def update_organization_third_party_vpn_peers(self,
organization_id,
update_organization_third_party_vpn_peers)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| updateOrganizationThirdPartyVPNPeers | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
update_organization_third_party_vpn_peers = UpdateOrganizationThirdPartyVPNPeers()
result = organizations_controller.update_organization_third_party_vpn_peers(organization_id, update_organization_third_party_vpn_peers)
get_organization_uplinks_loss_and_latency
Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago
def get_organization_uplinks_loss_and_latency(self,
organization_id,
t_0=None,
t_1=None,
timespan=None,
uplink=None,
ip=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. |
| t1 | Optional |
The 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. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes. |
| uplink | Optional |
Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. |
| ip | Optional |
Optional filter for a specific destination IP. Default will return all destination IPs. |
Example Usage
organization_id = 'organizationId'
t_0 = 't0'
t_1 = 't1'
timespan = 41.391950462196
uplink = UplinkEnum.WAN1
ip = 'ip'
result = organizations_controller.get_organization_uplinks_loss_and_latency(organization_id, t_0, t_1, timespan, uplink, ip)
PIIController
Get controller instance
An instance of the PIIController class can be accessed from the API Client.
pii_controller = client.pii
get_network_pii_pii_keys
List 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/piiKeys
def get_network_pii_pii_keys(self,
network_id,
username=None,
email=None,
mac=None,
serial=None,
imei=None,
bluetooth_mac=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| username | Optional |
The username of a Systems Manager user |
Optional |
The email of a network user account or a Systems Manager device | |
| mac | Optional |
The MAC of a network client device or a Systems Manager device |
| serial | Optional |
The serial of a Systems Manager device |
| imei | Optional |
The IMEI of a Systems Manager device |
| bluetoothMac | Optional |
The MAC of a Bluetooth client |
Example Usage
network_id = 'networkId'
username = 'username'
email = 'email'
mac = 'mac'
serial = 'serial'
imei = 'imei'
bluetooth_mac = 'bluetoothMac'
result = pii_controller.get_network_pii_pii_keys(network_id, username, email, mac, serial, imei, bluetooth_mac)
get_network_pii_requests
List the PII requests for this network or organization
ALTERNATE PATH
/organizations/{organizationId}/pii/requests
def get_network_pii_requests(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = pii_controller.get_network_pii_requests(network_id)
create_network_pii_request
Submit a new delete or restrict processing PII request
ALTERNATE PATH
/organizations/{organizationId}/pii/requests
def create_network_pii_request(self,
network_id,
create_network_pii_request=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkPiiRequest | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_pii_request = CreateNetworkPiiRequest()
result = pii_controller.create_network_pii_request(network_id, create_network_pii_request)
get_network_pii_request
Return a PII request
ALTERNATE PATH
/organizations/{organizationId}/pii/requests/{requestId}
def get_network_pii_request(self,
network_id,
request_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| requestId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
request_id = 'requestId'
result = pii_controller.get_network_pii_request(network_id, request_id)
delete_network_pii_request
Delete a restrict processing PII request
ALTERNATE PATH
/organizations/{organizationId}/pii/requests/{requestId}
def delete_network_pii_request(self,
network_id,
request_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| requestId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
request_id = 'requestId'
pii_controller.delete_network_pii_request(network_id, request_id)
get_network_pii_sm_devices_for_key
Given 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/smDevicesForKey
def get_network_pii_sm_devices_for_key(self,
network_id,
username=None,
email=None,
mac=None,
serial=None,
imei=None,
bluetooth_mac=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| username | Optional |
The username of a Systems Manager user |
Optional |
The email of a network user account or a Systems Manager device | |
| mac | Optional |
The MAC of a network client device or a Systems Manager device |
| serial | Optional |
The serial of a Systems Manager device |
| imei | Optional |
The IMEI of a Systems Manager device |
| bluetoothMac | Optional |
The MAC of a Bluetooth client |
Example Usage
network_id = 'networkId'
username = 'username'
email = 'email'
mac = 'mac'
serial = 'serial'
imei = 'imei'
bluetooth_mac = 'bluetoothMac'
result = pii_controller.get_network_pii_sm_devices_for_key(network_id, username, email, mac, serial, imei, bluetooth_mac)
get_network_pii_sm_owners_for_key
Given 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/smOwnersForKey
def get_network_pii_sm_owners_for_key(self,
network_id,
username=None,
email=None,
mac=None,
serial=None,
imei=None,
bluetooth_mac=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| username | Optional |
The username of a Systems Manager user |
Optional |
The email of a network user account or a Systems Manager device | |
| mac | Optional |
The MAC of a network client device or a Systems Manager device |
| serial | Optional |
The serial of a Systems Manager device |
| imei | Optional |
The IMEI of a Systems Manager device |
| bluetoothMac | Optional |
The MAC of a Bluetooth client |
Example Usage
network_id = 'networkId'
username = 'username'
email = 'email'
mac = 'mac'
serial = 'serial'
imei = 'imei'
bluetooth_mac = 'bluetoothMac'
result = pii_controller.get_network_pii_sm_owners_for_key(network_id, username, email, mac, serial, imei, bluetooth_mac)
RadioSettingsController
Get controller instance
An instance of the RadioSettingsController class can be accessed from the API Client.
radio_settings_controller = client.radio_settings
get_network_device_wireless_radio_settings
Return the radio settings of a device
def get_network_device_wireless_radio_settings(self,
network_id,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
result = radio_settings_controller.get_network_device_wireless_radio_settings(network_id, serial)
update_network_device_wireless_radio_settings
Update the radio settings of a device
def update_network_device_wireless_radio_settings(self,
network_id,
serial,
update_network_device_wireless_radio_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| updateNetworkDeviceWirelessRadioSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
update_network_device_wireless_radio_settings = UpdateNetworkDeviceWirelessRadioSettings()
result = radio_settings_controller.update_network_device_wireless_radio_settings(network_id, serial, update_network_device_wireless_radio_settings)
get_network_wireless_rf_profiles
List the non-basic RF profiles for this network
def get_network_wireless_rf_profiles(self,
network_id,
include_template_profiles=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| includeTemplateProfiles | Optional |
If the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the template |
should be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false. |
Example Usage
network_id = 'networkId'
include_template_profiles = False
result = radio_settings_controller.get_network_wireless_rf_profiles(network_id, include_template_profiles)
create_network_wireless_rf_profile
Creates new RF profile for this network
def create_network_wireless_rf_profile(self,
network_id,
create_network_wireless_rf_profile)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkWirelessRfProfile | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_wireless_rf_profile = CreateNetworkWirelessRfProfile()
result = radio_settings_controller.create_network_wireless_rf_profile(network_id, create_network_wireless_rf_profile)
update_network_wireless_rf_profile
Updates specified RF profile for this network
def update_network_wireless_rf_profile(self,
network_id,
rf_profile_id,
update_network_wireless_rf_profile=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| rfProfileId | Required |
TODO: Add a parameter description |
| updateNetworkWirelessRfProfile | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
rf_profile_id = 'rfProfileId'
update_network_wireless_rf_profile = UpdateNetworkWirelessRfProfile()
result = radio_settings_controller.update_network_wireless_rf_profile(network_id, rf_profile_id, update_network_wireless_rf_profile)
delete_network_wireless_rf_profile
Delete a RF Profile
def delete_network_wireless_rf_profile(self,
network_id,
rf_profile_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| rfProfileId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
rf_profile_id = 'rfProfileId'
radio_settings_controller.delete_network_wireless_rf_profile(network_id, rf_profile_id)
get_network_wireless_rf_profile
Return a RF profile
def get_network_wireless_rf_profile(self,
network_id,
rf_profile_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| rfProfileId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
rf_profile_id = 'rfProfileId'
result = radio_settings_controller.get_network_wireless_rf_profile(network_id, rf_profile_id)
SAMLRolesController
Get controller instance
An instance of the SAMLRolesController class can be accessed from the API Client.
saml_roles_controller = client.saml_roles
get_organization_saml_roles
List the SAML roles for this organization
def get_organization_saml_roles(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = saml_roles_controller.get_organization_saml_roles(organization_id)
create_organization_saml_role
Create a SAML role
def create_organization_saml_role(self,
organization_id,
create_organization_saml_role=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| createOrganizationSamlRole | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
create_organization_saml_role = CreateOrganizationSamlRole()
result = saml_roles_controller.create_organization_saml_role(organization_id, create_organization_saml_role)
get_organization_saml_role
Return a SAML role
def get_organization_saml_role(self,
organization_id,
saml_role_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| samlRoleId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
saml_role_id = 'samlRoleId'
result = saml_roles_controller.get_organization_saml_role(organization_id, saml_role_id)
update_organization_saml_role
Update a SAML role
def update_organization_saml_role(self,
organization_id,
saml_role_id,
update_organization_saml_role=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| samlRoleId | Required |
TODO: Add a parameter description |
| updateOrganizationSamlRole | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
saml_role_id = 'samlRoleId'
update_organization_saml_role = UpdateOrganizationSamlRole()
result = saml_roles_controller.update_organization_saml_role(organization_id, saml_role_id, update_organization_saml_role)
delete_organization_saml_role
Remove a SAML role
def delete_organization_saml_role(self,
organization_id,
saml_role_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| samlRoleId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
saml_role_id = 'samlRoleId'
saml_roles_controller.delete_organization_saml_role(organization_id, saml_role_id)
SMController
Get controller instance
An instance of the SMController class can be accessed from the API Client.
sm_controller = client.sm
create_network_sm_app_polaris
Create a new Polaris app
def create_network_sm_app_polaris(self,
network_id,
create_network_sm_app_polaris)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkSmAppPolaris | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_sm_app_polaris = CreateNetworkSmAppPolaris()
result = sm_controller.create_network_sm_app_polaris(network_id, create_network_sm_app_polaris)
get_network_sm_app_polaris
Get details for a Cisco Polaris app if it exists
def get_network_sm_app_polaris(self,
network_id,
bundle_id=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| bundleId | Optional |
The bundle ID of the app to be found, defaults to com.cisco.ciscosecurity.app |
Example Usage
network_id = 'networkId'
bundle_id = 'bundleId'
result = sm_controller.get_network_sm_app_polaris(network_id, bundle_id)
update_network_sm_app_polaris
Update an existing Polaris app
def update_network_sm_app_polaris(self,
network_id,
app_id,
update_network_sm_app_polaris=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| appId | Required |
TODO: Add a parameter description |
| updateNetworkSmAppPolaris | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
app_id = 'appId'
update_network_sm_app_polaris = UpdateNetworkSmAppPolaris()
result = sm_controller.update_network_sm_app_polaris(network_id, app_id, update_network_sm_app_polaris)
delete_network_sm_app_polaris
Delete a Cisco Polaris app
def delete_network_sm_app_polaris(self,
network_id,
app_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| appId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
app_id = 'appId'
result = sm_controller.delete_network_sm_app_polaris(network_id, app_id)
create_network_sm_bypass_activation_lock_attempt
Bypass activation lock attempt
def create_network_sm_bypass_activation_lock_attempt(self,
network_id,
create_network_sm_bypass_activation_lock_attempt)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkSmBypassActivationLockAttempt | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_sm_bypass_activation_lock_attempt = CreateNetworkSmBypassActivationLockAttempt()
result = sm_controller.create_network_sm_bypass_activation_lock_attempt(network_id, create_network_sm_bypass_activation_lock_attempt)
get_network_sm_bypass_activation_lock_attempt
Bypass activation lock attempt status
def get_network_sm_bypass_activation_lock_attempt(self,
network_id,
attempt_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| attemptId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
attempt_id = 'attemptId'
result = sm_controller.get_network_sm_bypass_activation_lock_attempt(network_id, attempt_id)
update_network_sm_device_fields
Modify the fields of a device
def update_network_sm_device_fields(self,
network_id,
update_network_sm_device_fields)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSmDeviceFields | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_sm_device_fields = UpdateNetworkSmDeviceFields()
result = sm_controller.update_network_sm_device_fields(network_id, update_network_sm_device_fields)
update_wipe_network_sm_device
Wipe a device
def update_wipe_network_sm_device(self,
network_id,
wipe_network_sm_device=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| wipeNetworkSmDevice | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
wipe_network_sm_device = WipeNetworkSmDevice()
result = sm_controller.update_wipe_network_sm_device(network_id, wipe_network_sm_device)
create_refresh_network_sm_device_details
Refresh the details of a device
def create_refresh_network_sm_device_details(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
sm_controller.create_refresh_network_sm_device_details(network_id, device_id)
get_network_sm_devices
List the devices enrolled in an SM network with various specified fields and filters
def get_network_sm_devices(self,
network_id,
fields=None,
wifi_macs=None,
serials=None,
ids=None,
scope=None,
batch_size=None,
batch_token=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| fields | Optional |
Additional 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 Usage
network_id = 'networkId'
fields = 'fields'
wifi_macs = 'wifiMacs'
serials = 'serials'
ids = 'ids'
scope = 'scope'
batch_size = 254
batch_token = 'batchToken'
result = sm_controller.get_network_sm_devices(network_id, fields, wifi_macs, serials, ids, scope, batch_size, batch_token)
update_checkin_network_sm_devices
Force check-in a set of devices
def update_checkin_network_sm_devices(self,
network_id,
checkin_network_sm_devices=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| checkinNetworkSmDevices | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
checkin_network_sm_devices = CheckinNetworkSmDevices()
result = sm_controller.update_checkin_network_sm_devices(network_id, checkin_network_sm_devices)
update_move_network_sm_devices
Move a set of devices to a new network
def update_move_network_sm_devices(self,
network_id,
move_network_sm_devices)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| moveNetworkSmDevices | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
move_network_sm_devices = MoveNetworkSmDevices()
result = sm_controller.update_move_network_sm_devices(network_id, move_network_sm_devices)
update_network_sm_devices_tags
Add, delete, or update the tags of a set of devices
def update_network_sm_devices_tags(self,
network_id,
update_network_sm_devices_tags)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSmDevicesTags | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_sm_devices_tags = UpdateNetworkSmDevicesTags()
result = sm_controller.update_network_sm_devices_tags(network_id, update_network_sm_devices_tags)
create_unenroll_network_sm_device
Unenroll a device
def create_unenroll_network_sm_device(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
result = sm_controller.create_unenroll_network_sm_device(network_id, device_id)
create_network_sm_profile_clarity
Create a new profile containing a Cisco Clarity payload
def create_network_sm_profile_clarity(self,
network_id,
create_network_sm_profile_clarity)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkSmProfileClarity | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_sm_profile_clarity = CreateNetworkSmProfileClarity()
result = sm_controller.create_network_sm_profile_clarity(network_id, create_network_sm_profile_clarity)
update_network_sm_profile_clarity
Update an existing profile containing a Cisco Clarity payload
def update_network_sm_profile_clarity(self,
network_id,
profile_id,
update_network_sm_profile_clarity=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| profileId | Required |
TODO: Add a parameter description |
| updateNetworkSmProfileClarity | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
profile_id = 'profileId'
update_network_sm_profile_clarity = UpdateNetworkSmProfileClarity()
result = sm_controller.update_network_sm_profile_clarity(network_id, profile_id, update_network_sm_profile_clarity)
add_network_sm_profile_clarity
Add a Cisco Clarity payload to an existing profile
def add_network_sm_profile_clarity(self,
network_id,
profile_id,
add_network_sm_profile_clarity)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| profileId | Required |
TODO: Add a parameter description |
| addNetworkSmProfileClarity | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
profile_id = 'profileId'
add_network_sm_profile_clarity = AddNetworkSmProfileClarity()
result = sm_controller.add_network_sm_profile_clarity(network_id, profile_id, add_network_sm_profile_clarity)
get_network_sm_profile_clarity
Get details for a Cisco Clarity payload
def get_network_sm_profile_clarity(self,
network_id,
profile_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| profileId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
profile_id = 'profileId'
result = sm_controller.get_network_sm_profile_clarity(network_id, profile_id)
delete_network_sm_profile_clarity
Delete a Cisco Clarity payload. Deletes the entire profile if it's empty after removing the payload.
def delete_network_sm_profile_clarity(self,
network_id,
profile_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| profileId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
profile_id = 'profileId'
result = sm_controller.delete_network_sm_profile_clarity(network_id, profile_id)
create_network_sm_profile_umbrella
Create a new profile containing a Cisco Umbrella payload
def create_network_sm_profile_umbrella(self,
network_id,
create_network_sm_profile_umbrella)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkSmProfileUmbrella | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_sm_profile_umbrella = CreateNetworkSmProfileUmbrella()
result = sm_controller.create_network_sm_profile_umbrella(network_id, create_network_sm_profile_umbrella)
update_network_sm_profile_umbrella
Update an existing profile containing a Cisco Umbrella payload
def update_network_sm_profile_umbrella(self,
network_id,
profile_id,
update_network_sm_profile_umbrella=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| profileId | Required |
TODO: Add a parameter description |
| updateNetworkSmProfileUmbrella | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
profile_id = 'profileId'
update_network_sm_profile_umbrella = UpdateNetworkSmProfileUmbrella()
result = sm_controller.update_network_sm_profile_umbrella(network_id, profile_id, update_network_sm_profile_umbrella)
add_network_sm_profile_umbrella
Add a Cisco Umbrella payload to an existing profile
def add_network_sm_profile_umbrella(self,
network_id,
profile_id,
add_network_sm_profile_umbrella)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| profileId | Required |
TODO: Add a parameter description |
| addNetworkSmProfileUmbrella | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
profile_id = 'profileId'
add_network_sm_profile_umbrella = AddNetworkSmProfileUmbrella()
result = sm_controller.add_network_sm_profile_umbrella(network_id, profile_id, add_network_sm_profile_umbrella)
get_network_sm_profile_umbrella
Get details for a Cisco Umbrella payload
def get_network_sm_profile_umbrella(self,
network_id,
profile_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| profileId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
profile_id = 'profileId'
result = sm_controller.get_network_sm_profile_umbrella(network_id, profile_id)
delete_network_sm_profile_umbrella
Delete a Cisco Umbrella payload. Deletes the entire profile if it's empty after removing the payload
def delete_network_sm_profile_umbrella(self,
network_id,
profile_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| profileId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
profile_id = 'profileId'
result = sm_controller.delete_network_sm_profile_umbrella(network_id, profile_id)
get_network_sm_profiles
List all the profiles in the network
def get_network_sm_profiles(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = sm_controller.get_network_sm_profiles(network_id)
get_network_sm_user_device_profiles
Get the profiles associated with a user
def get_network_sm_user_device_profiles(self,
network_id,
user_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| userId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
user_id = 'userId'
result = sm_controller.get_network_sm_user_device_profiles(network_id, user_id)
get_network_sm_user_softwares
Get a list of softwares associated with a user
def get_network_sm_user_softwares(self,
network_id,
user_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| userId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
user_id = 'userId'
result = sm_controller.get_network_sm_user_softwares(network_id, user_id)
get_network_sm_users
List the owners in an SM network with various specified fields and filters
def get_network_sm_users(self,
network_id,
ids=None,
usernames=None,
emails=None,
scope=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| ids | Optional |
Filter users by id(s). Multiple ids can be passed in as comma separated values. |
| usernames | Optional |
Filter users by username(s). Multiple usernames can be passed in as comma separated values. |
| emails | Optional |
Filter users by email(s). Multiple emails can be passed in as comma separated values. |
| scope | Optional |
Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags as comma separated values. |
Example Usage
network_id = 'networkId'
ids = 'ids'
usernames = 'usernames'
emails = 'emails'
scope = 'scope'
result = sm_controller.get_network_sm_users(network_id, ids, usernames, emails, scope)
get_network_sm_cellular_usage_history
Return the client's daily cellular data usage history. Usage data is in kilobytes.
def get_network_sm_cellular_usage_history(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
result = sm_controller.get_network_sm_cellular_usage_history(network_id, device_id)
get_network_sm_certs
List the certs on a device
def get_network_sm_certs(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
result = sm_controller.get_network_sm_certs(network_id, device_id)
get_network_sm_device_profiles
Get the profiles associated with a device
def get_network_sm_device_profiles(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
result = sm_controller.get_network_sm_device_profiles(network_id, device_id)
get_network_sm_network_adapters
List the network adapters of a device
def get_network_sm_network_adapters(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
result = sm_controller.get_network_sm_network_adapters(network_id, device_id)
get_network_sm_restrictions
List the restrictions on a device
def get_network_sm_restrictions(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
result = sm_controller.get_network_sm_restrictions(network_id, device_id)
get_network_sm_security_centers
List the security centers on a device
def get_network_sm_security_centers(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
result = sm_controller.get_network_sm_security_centers(network_id, device_id)
get_network_sm_softwares
Get a list of softwares associated with a device
def get_network_sm_softwares(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
result = sm_controller.get_network_sm_softwares(network_id, device_id)
get_network_sm_wlan_lists
List the saved SSID names on a device
def get_network_sm_wlan_lists(self,
network_id,
device_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| deviceId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
device_id = 'deviceId'
result = sm_controller.get_network_sm_wlan_lists(network_id, device_id)
update_lock_network_sm_devices
Lock a set of devices
def update_lock_network_sm_devices(self,
network_id,
lock_network_sm_devices=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| lockNetworkSmDevices | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'network_id'
lock_network_sm_devices = LockNetworkSmDevices()
result = sm_controller.update_lock_network_sm_devices(network_id, lock_network_sm_devices)
get_network_sm_connectivity
Returns historical connectivity data (whether a device is regularly checking in to Dashboard).
def get_network_sm_connectivity(self,
network_id,
id,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
| perPage | Optional |
The number of entries per page returned |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, next or prev page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, next or prev page in the HTTP Link header should define it. |
Example Usage
network_id = 'network_id'
id = 'id'
per_page = 'perPage'
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = sm_controller.get_network_sm_connectivity(network_id, id, per_page, starting_after, ending_before)
get_network_sm_desktop_logs
Return historical records of various Systems Manager network connection details for desktop devices.
def get_network_sm_desktop_logs(self,
network_id,
id,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
| perPage | Optional |
The number of entries per page returned |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, next or prev page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, next or prev page in the HTTP Link header should define it. |
Example Usage
network_id = 'network_id'
id = 'id'
per_page = 'perPage'
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = sm_controller.get_network_sm_desktop_logs(network_id, id, per_page, starting_after, ending_before)
get_network_sm_device_command_logs
Return 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>
def get_network_sm_device_command_logs(self,
network_id,
id,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
| perPage | Optional |
The number of entries per page returned |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, next or prev page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, next or prev page in the HTTP Link header should define it. |
Example Usage
network_id = 'network_id'
id = 'id'
per_page = 'perPage'
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = sm_controller.get_network_sm_device_command_logs(network_id, id, per_page, starting_after, ending_before)
get_network_sm_performance_history
Return historical records of various Systems Manager client metrics for desktop devices.
def get_network_sm_performance_history(self,
network_id,
id,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| id | Required |
TODO: Add a parameter description |
| perPage | Optional |
The number of entries per page returned |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, next or prev page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, next or prev page in the HTTP Link header should define it. |
Example Usage
network_id = 'network_id'
id = 'id'
per_page = 'perPage'
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = sm_controller.get_network_sm_performance_history(network_id, id, per_page, starting_after, ending_before)
SNMPSettingsController
Get controller instance
An instance of the SNMPSettingsController class can be accessed from the API Client.
snmp_settings_controller = client.snmp_settings
get_network_snmp_settings
Return the SNMP settings for a network
def get_network_snmp_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = snmp_settings_controller.get_network_snmp_settings(network_id)
update_network_snmp_settings
Update the SNMP settings for a network
def update_network_snmp_settings(self,
network_id,
update_network_snmp_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSnmpSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_snmp_settings = UpdateNetworkSnmpSettings()
result = snmp_settings_controller.update_network_snmp_settings(network_id, update_network_snmp_settings)
get_organization_snmp
Return the SNMP settings for an organization
def get_organization_snmp(self,
organization_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
result = snmp_settings_controller.get_organization_snmp(organization_id)
update_organization_snmp
Update the SNMP settings for an organization
def update_organization_snmp(self,
organization_id,
update_organization_snmp=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| updateOrganizationSnmp | Optional |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
update_organization_snmp = UpdateOrganizationSnmp()
result = snmp_settings_controller.update_organization_snmp(organization_id, update_organization_snmp)
SSIDsController
Get controller instance
An instance of the SSIDsController class can be accessed from the API Client.
ssi_ds_controller = client.ssi_ds
get_network_device_wireless_status
Return the SSID statuses of an access point
def get_network_device_wireless_status(self,
network_id,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
serial = 'serial'
result = ssi_ds_controller.get_network_device_wireless_status(network_id, serial)
get_network_ssids
List the SSIDs in a network. Supports networks with access points or wireless-enabled security appliances and teleworker gateways.
def get_network_ssids(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = ssi_ds_controller.get_network_ssids(network_id)
get_network_ssid
Return a single SSID
def get_network_ssid(self,
network_id,
number)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
number = 'number'
result = ssi_ds_controller.get_network_ssid(network_id, number)
update_network_ssid
Update the attributes of an SSID
def update_network_ssid(self,
network_id,
number,
update_network_ssid=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
| updateNetworkSsid | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
number = 'number'
update_network_ssid = UpdateNetworkSsid()
result = ssi_ds_controller.update_network_ssid(network_id, number, update_network_ssid)
SecurityEventsController
Get controller instance
An instance of the SecurityEventsController class can be accessed from the API Client.
security_events_controller = client.security_events
get_network_client_security_events
List 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.
def get_network_client_security_events(self,
network_id,
client_id,
t_0=None,
t_1=None,
timespan=None,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 791 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 791 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 31 days. |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
t_0 = 't0'
t_1 = 't1'
timespan = 91.1640591272917
per_page = 91
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = security_events_controller.get_network_client_security_events(network_id, client_id, t_0, t_1, timespan, per_page, starting_after, ending_before)
get_network_security_events
List the security events for a network
def get_network_security_events(self,
network_id,
t_0=None,
t_1=None,
timespan=None,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 365 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 31 days. |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
Example Usage
network_id = 'networkId'
t_0 = 't0'
t_1 = 't1'
timespan = 91.1640591272917
per_page = 91
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = security_events_controller.get_network_security_events(network_id, t_0, t_1, timespan, per_page, starting_after, ending_before)
get_organization_security_events
List the security events for an organization
def get_organization_security_events(self,
organization_id,
t_0=None,
t_1=None,
timespan=None,
per_page=None,
starting_after=None,
ending_before=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 365 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 31 days. |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
Example Usage
organization_id = 'organizationId'
t_0 = 't0'
t_1 = 't1'
timespan = 91.1640591272917
per_page = 91
starting_after = 'startingAfter'
ending_before = 'endingBefore'
result = security_events_controller.get_organization_security_events(organization_id, t_0, t_1, timespan, per_page, starting_after, ending_before)
SplashLoginAttemptsController
Get controller instance
An instance of the SplashLoginAttemptsController class can be accessed from the API Client.
splash_login_attempts_controller = client.splash_login_attempts
get_network_splash_login_attempts
List the splash login attempts for a network
def get_network_splash_login_attempts(self,
network_id,
ssid_number=None,
login_identifier=None,
timespan=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| ssidNumber | Optional |
Only return the login attempts for the specified SSID |
| loginIdentifier | Optional |
The username, email, or phone number used during login |
| timespan | Optional |
The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months |
Example Usage
network_id = 'networkId'
ssid_number = SsidNumberEnum.ENUM_0
login_identifier = 'loginIdentifier'
timespan = 182
result = splash_login_attempts_controller.get_network_splash_login_attempts(network_id, ssid_number, login_identifier, timespan)
SplashSettingsController
Get controller instance
An instance of the SplashSettingsController class can be accessed from the API Client.
splash_settings_controller = client.splash_settings
get_network_ssid_splash_settings
Display the splash page settings for the given SSID
def get_network_ssid_splash_settings(self,
network_id,
number)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
number = 'number'
result = splash_settings_controller.get_network_ssid_splash_settings(network_id, number)
update_network_ssid_splash_settings
Modify the splash page settings for the given SSID
def update_network_ssid_splash_settings(self,
network_id,
number,
update_network_ssid_splash_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
| updateNetworkSsidSplashSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
number = 'number'
update_network_ssid_splash_settings = UpdateNetworkSsidSplashSettings()
result = splash_settings_controller.update_network_ssid_splash_settings(network_id, number, update_network_ssid_splash_settings)
SwitchACLsController
Get controller instance
An instance of the SwitchACLsController class can be accessed from the API Client.
switch_ac_ls_controller = client.switch_ac_ls
get_network_switch_access_control_lists
Return the access control lists for a MS network
def get_network_switch_access_control_lists(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_ac_ls_controller.get_network_switch_access_control_lists(network_id)
update_network_switch_access_control_lists
Update the access control lists for a MS network
def update_network_switch_access_control_lists(self,
network_id,
update_network_switch_access_control_lists)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchAccessControlLists | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_switch_access_control_lists = UpdateNetworkSwitchAccessControlLists()
result = switch_ac_ls_controller.update_network_switch_access_control_lists(network_id, update_network_switch_access_control_lists)
SwitchPortSchedulesController
Get controller instance
An instance of the SwitchPortSchedulesController class can be accessed from the API Client.
switch_port_schedules_controller = client.switch_port_schedules
get_network_switch_port_schedules
List switch port schedules
def get_network_switch_port_schedules(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_port_schedules_controller.get_network_switch_port_schedules(network_id)
create_network_switch_port_schedule
Add a switch port schedule
def create_network_switch_port_schedule(self,
network_id,
create_network_switch_port_schedule)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkSwitchPortSchedule | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_switch_port_schedule = CreateNetworkSwitchPortSchedule()
result = switch_port_schedules_controller.create_network_switch_port_schedule(network_id, create_network_switch_port_schedule)
delete_network_switch_port_schedule
Delete a switch port schedule
def delete_network_switch_port_schedule(self,
network_id,
port_schedule_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| portScheduleId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
port_schedule_id = 'portScheduleId'
switch_port_schedules_controller.delete_network_switch_port_schedule(network_id, port_schedule_id)
update_network_switch_port_schedule
Update a switch port schedule
def update_network_switch_port_schedule(self,
network_id,
port_schedule_id,
update_network_switch_port_schedule=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| portScheduleId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchPortSchedule | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
port_schedule_id = 'portScheduleId'
update_network_switch_port_schedule = UpdateNetworkSwitchPortSchedule()
result = switch_port_schedules_controller.update_network_switch_port_schedule(network_id, port_schedule_id, update_network_switch_port_schedule)
SwitchPortsController
Get controller instance
An instance of the SwitchPortsController class can be accessed from the API Client.
switch_ports_controller = client.switch_ports
get_device_switch_ports
List the switch ports for a switch
def get_device_switch_ports(self,
serial)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| serial | Required |
TODO: Add a parameter description |
Example Usage
serial = 'serial'
result = switch_ports_controller.get_device_switch_ports(serial)
get_device_switch_port
Return a switch port
def get_device_switch_port(self,
serial,
number)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| serial | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
Example Usage
serial = 'serial'
number = 'number'
result = switch_ports_controller.get_device_switch_port(serial, number)
update_device_switch_port
Update a switch port
def update_device_switch_port(self,
serial,
number,
update_device_switch_port=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| serial | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
| updateDeviceSwitchPort | Optional |
TODO: Add a parameter description |
Example Usage
serial = 'serial'
number = 'number'
update_device_switch_port = UpdateDeviceSwitchPort()
result = switch_ports_controller.update_device_switch_port(serial, number, update_device_switch_port)
SwitchProfilesController
Get controller instance
An instance of the SwitchProfilesController class can be accessed from the API Client.
switch_profiles_controller = client.switch_profiles
get_organization_config_template_switch_profiles
List the switch profiles for your switch template configuration
def get_organization_config_template_switch_profiles(self,
organization_id,
config_template_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| configTemplateId | Required |
TODO: Add a parameter description |
Example Usage
organization_id = 'organizationId'
config_template_id = 'configTemplateId'
result = switch_profiles_controller.get_organization_config_template_switch_profiles(organization_id, config_template_id)
SwitchSettingsController
Get controller instance
An instance of the SwitchSettingsController class can be accessed from the API Client.
switch_settings_controller = client.switch_settings
get_network_switch_settings
Returns the switch network settings
def get_network_switch_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_settings_controller.get_network_switch_settings(network_id)
update_network_switch_settings
Update switch network settings
def update_network_switch_settings(self,
network_id,
update_network_switch_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_switch_settings = UpdateNetworkSwitchSettings()
result = switch_settings_controller.update_network_switch_settings(network_id, update_network_switch_settings)
get_network_switch_settings_dhcp_server_policy
Return the DHCP server policy
def get_network_switch_settings_dhcp_server_policy(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_settings_controller.get_network_switch_settings_dhcp_server_policy(network_id)
update_network_switch_settings_dhcp_server_policy
Update the DHCP server policy
def update_network_switch_settings_dhcp_server_policy(self,
network_id,
update_network_switch_settings_dhcp_server_policy=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchSettingsDhcpServerPolicy | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_switch_settings_dhcp_server_policy = UpdateNetworkSwitchSettingsDhcpServerPolicy()
result = switch_settings_controller.update_network_switch_settings_dhcp_server_policy(network_id, update_network_switch_settings_dhcp_server_policy)
get_network_switch_settings_dscp_to_cos_mappings
Return the DSCP to CoS mappings
def get_network_switch_settings_dscp_to_cos_mappings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_settings_controller.get_network_switch_settings_dscp_to_cos_mappings(network_id)
update_network_switch_settings_dscp_to_cos_mappings
Update the DSCP to CoS mappings
def update_network_switch_settings_dscp_to_cos_mappings(self,
network_id,
update_network_switch_settings_dscp_to_cos_mappings)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchSettingsDscpToCosMappings | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_switch_settings_dscp_to_cos_mappings = UpdateNetworkSwitchSettingsDscpToCosMappings()
result = switch_settings_controller.update_network_switch_settings_dscp_to_cos_mappings(network_id, update_network_switch_settings_dscp_to_cos_mappings)
get_network_switch_settings_mtu
Return the MTU configuration
def get_network_switch_settings_mtu(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_settings_controller.get_network_switch_settings_mtu(network_id)
update_network_switch_settings_mtu
Update the MTU configuration
def update_network_switch_settings_mtu(self,
network_id,
update_network_switch_settings_mtu=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchSettingsMtu | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_switch_settings_mtu = UpdateNetworkSwitchSettingsMtu()
result = switch_settings_controller.update_network_switch_settings_mtu(network_id, update_network_switch_settings_mtu)
get_network_switch_settings_qos_rules
List quality of service rules
def get_network_switch_settings_qos_rules(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_settings_controller.get_network_switch_settings_qos_rules(network_id)
create_network_switch_settings_qos_rule
Add a quality of service rule
def create_network_switch_settings_qos_rule(self,
network_id,
create_network_switch_settings_qos_rule)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkSwitchSettingsQosRule | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_switch_settings_qos_rule = CreateNetworkSwitchSettingsQosRule()
result = switch_settings_controller.create_network_switch_settings_qos_rule(network_id, create_network_switch_settings_qos_rule)
get_network_switch_settings_qos_rules_order
Return the quality of service rule IDs by order in which they will be processed by the switch
def get_network_switch_settings_qos_rules_order(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_settings_controller.get_network_switch_settings_qos_rules_order(network_id)
update_network_switch_settings_qos_rules_order
Update the order in which the rules should be processed by the switch
def update_network_switch_settings_qos_rules_order(self,
network_id,
update_network_switch_settings_qos_rules_order)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchSettingsQosRulesOrder | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_switch_settings_qos_rules_order = UpdateNetworkSwitchSettingsQosRulesOrder()
result = switch_settings_controller.update_network_switch_settings_qos_rules_order(network_id, update_network_switch_settings_qos_rules_order)
get_network_switch_settings_qos_rule
Return a quality of service rule
def get_network_switch_settings_qos_rule(self,
network_id,
qos_rule_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| qosRuleId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
qos_rule_id = 'qosRuleId'
result = switch_settings_controller.get_network_switch_settings_qos_rule(network_id, qos_rule_id)
delete_network_switch_settings_qos_rule
Delete a quality of service rule
def delete_network_switch_settings_qos_rule(self,
network_id,
qos_rule_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| qosRuleId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
qos_rule_id = 'qosRuleId'
switch_settings_controller.delete_network_switch_settings_qos_rule(network_id, qos_rule_id)
update_network_switch_settings_qos_rule
Update a quality of service rule
def update_network_switch_settings_qos_rule(self,
network_id,
qos_rule_id,
update_network_switch_settings_qos_rule=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| qosRuleId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchSettingsQosRule | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
qos_rule_id = 'qosRuleId'
update_network_switch_settings_qos_rule = UpdateNetworkSwitchSettingsQosRule()
result = switch_settings_controller.update_network_switch_settings_qos_rule(network_id, qos_rule_id, update_network_switch_settings_qos_rule)
get_network_switch_settings_storm_control
Return the global enhanced storm control configuration
def get_network_switch_settings_storm_control(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_settings_controller.get_network_switch_settings_storm_control(network_id)
update_network_switch_settings_storm_control
Update the global enhanced storm control configuration
def update_network_switch_settings_storm_control(self,
network_id,
update_network_switch_settings_storm_control=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchSettingsStormControl | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_switch_settings_storm_control = UpdateNetworkSwitchSettingsStormControl()
result = switch_settings_controller.update_network_switch_settings_storm_control(network_id, update_network_switch_settings_storm_control)
get_network_switch_settings_stp
Returns STP settings
def get_network_switch_settings_stp(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_settings_controller.get_network_switch_settings_stp(network_id)
update_network_switch_settings_stp
Updates STP settings
def update_network_switch_settings_stp(self,
network_id,
update_network_switch_settings_stp=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSwitchSettingsStp | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_switch_settings_stp = UpdateNetworkSwitchSettingsStp()
result = switch_settings_controller.update_network_switch_settings_stp(network_id, update_network_switch_settings_stp)
SwitchStacksController
Get controller instance
An instance of the SwitchStacksController class can be accessed from the API Client.
switch_stacks_controller = client.switch_stacks
get_network_switch_stacks
List the switch stacks in a network
def get_network_switch_stacks(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = switch_stacks_controller.get_network_switch_stacks(network_id)
create_network_switch_stack
Create a stack
def create_network_switch_stack(self,
network_id,
create_network_switch_stack)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkSwitchStack | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_switch_stack = CreateNetworkSwitchStack()
result = switch_stacks_controller.create_network_switch_stack(network_id, create_network_switch_stack)
get_network_switch_stack
Show a switch stack
def get_network_switch_stack(self,
network_id,
switch_stack_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| switchStackId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
switch_stack_id = 'switchStackId'
result = switch_stacks_controller.get_network_switch_stack(network_id, switch_stack_id)
delete_network_switch_stack
Delete a stack
def delete_network_switch_stack(self,
network_id,
switch_stack_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| switchStackId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
switch_stack_id = 'switchStackId'
switch_stacks_controller.delete_network_switch_stack(network_id, switch_stack_id)
add_network_switch_stack
Add a switch to a stack
def add_network_switch_stack(self,
network_id,
switch_stack_id,
add_network_switch_stack)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| switchStackId | Required |
TODO: Add a parameter description |
| addNetworkSwitchStack | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
switch_stack_id = 'switchStackId'
add_network_switch_stack = AddNetworkSwitchStack()
result = switch_stacks_controller.add_network_switch_stack(network_id, switch_stack_id, add_network_switch_stack)
create_remove_network_switch_stack
Remove a switch from a stack
def create_remove_network_switch_stack(self,
network_id,
switch_stack_id,
remove_network_switch_stack)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| switchStackId | Required |
TODO: Add a parameter description |
| removeNetworkSwitchStack | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
switch_stack_id = 'switchStackId'
remove_network_switch_stack = RemoveNetworkSwitchStack()
result = switch_stacks_controller.create_remove_network_switch_stack(network_id, switch_stack_id, remove_network_switch_stack)
SyslogServersController
Get controller instance
An instance of the SyslogServersController class can be accessed from the API Client.
syslog_servers_controller = client.syslog_servers
get_network_syslog_servers
List the syslog servers for a network
def get_network_syslog_servers(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = syslog_servers_controller.get_network_syslog_servers(network_id)
update_network_syslog_servers
Update the syslog servers for a network
def update_network_syslog_servers(self,
network_id,
update_network_syslog_servers)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkSyslogServers | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_syslog_servers = UpdateNetworkSyslogServers()
result = syslog_servers_controller.update_network_syslog_servers(network_id, update_network_syslog_servers)
TrafficAnalysisSettingsController
Get controller instance
An instance of the TrafficAnalysisSettingsController class can be accessed from the API Client.
traffic_analysis_settings_controller = client.traffic_analysis_settings
get_network_traffic_analysis_settings
Return the traffic analysis settings for a network
def get_network_traffic_analysis_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = traffic_analysis_settings_controller.get_network_traffic_analysis_settings(network_id)
update_network_traffic_analysis_settings
Update the traffic analysis settings for a network
def update_network_traffic_analysis_settings(self,
network_id,
update_network_traffic_analysis_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkTrafficAnalysisSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_traffic_analysis_settings = UpdateNetworkTrafficAnalysisSettings()
result = traffic_analysis_settings_controller.update_network_traffic_analysis_settings(network_id, update_network_traffic_analysis_settings)
TrafficShapingController
Get controller instance
An instance of the TrafficShapingController class can be accessed from the API Client.
traffic_shaping_controller = client.traffic_shaping
update_network_ssid_traffic_shaping
Update the traffic shaping settings for an SSID on an MR network
def update_network_ssid_traffic_shaping(self,
network_id,
number,
update_network_ssid_traffic_shaping=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
| updateNetworkSsidTrafficShaping | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
number = 'number'
update_network_ssid_traffic_shaping = UpdateNetworkSsidTrafficShaping()
result = traffic_shaping_controller.update_network_ssid_traffic_shaping(network_id, number, update_network_ssid_traffic_shaping)
get_network_ssid_traffic_shaping
Display the traffic shaping settings for a SSID on an MR network
def get_network_ssid_traffic_shaping(self,
network_id,
number)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| number | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
number = 'number'
result = traffic_shaping_controller.get_network_ssid_traffic_shaping(network_id, number)
update_network_traffic_shaping
Update the traffic shaping settings for an MX network
def update_network_traffic_shaping(self,
network_id,
update_network_traffic_shaping=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkTrafficShaping | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_traffic_shaping = UpdateNetworkTrafficShaping()
result = traffic_shaping_controller.update_network_traffic_shaping(network_id, update_network_traffic_shaping)
get_network_traffic_shaping
Display the traffic shaping settings for an MX network
def get_network_traffic_shaping(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = traffic_shaping_controller.get_network_traffic_shaping(network_id)
get_network_traffic_shaping_application_categories
Returns the application categories for traffic shaping rules.
def get_network_traffic_shaping_application_categories(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = traffic_shaping_controller.get_network_traffic_shaping_application_categories(network_id)
get_network_traffic_shaping_dscp_tagging_options
Returns the available DSCP tagging options for your traffic shaping rules.
def get_network_traffic_shaping_dscp_tagging_options(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = traffic_shaping_controller.get_network_traffic_shaping_dscp_tagging_options(network_id)
UplinkSettingsController
Get controller instance
An instance of the UplinkSettingsController class can be accessed from the API Client.
uplink_settings_controller = client.uplink_settings
get_network_uplink_settings
Returns the uplink settings for your MX network.
def get_network_uplink_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = uplink_settings_controller.get_network_uplink_settings(network_id)
update_network_uplink_settings
Updates the uplink settings for your MX network.
def update_network_uplink_settings(self,
network_id,
update_network_uplink_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkUplinkSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_uplink_settings = UpdateNetworkUplinkSettings()
result = uplink_settings_controller.update_network_uplink_settings(network_id, update_network_uplink_settings)
VLANsController
Get controller instance
An instance of the VLANsController class can be accessed from the API Client.
vla_ns_controller = client.vla_ns
get_network_vlans
List the VLANs for an MX network
def get_network_vlans(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = vla_ns_controller.get_network_vlans(network_id)
create_network_vlan
Add a VLAN
def create_network_vlan(self,
network_id,
create_network_vlan)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| createNetworkVlan | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
create_network_vlan = CreateNetworkVlan()
result = vla_ns_controller.create_network_vlan(network_id, create_network_vlan)
get_network_vlan
Return a VLAN
def get_network_vlan(self,
network_id,
vlan_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| vlanId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
vlan_id = 'vlanId'
result = vla_ns_controller.get_network_vlan(network_id, vlan_id)
update_network_vlan
Update a VLAN
def update_network_vlan(self,
network_id,
vlan_id,
update_network_vlan=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| vlanId | Required |
TODO: Add a parameter description |
| updateNetworkVlan | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
vlan_id = 'vlanId'
update_network_vlan = UpdateNetworkVlan()
result = vla_ns_controller.update_network_vlan(network_id, vlan_id, update_network_vlan)
delete_network_vlan
Delete a VLAN from a network
def delete_network_vlan(self,
network_id,
vlan_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| vlanId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
vlan_id = 'vlanId'
vla_ns_controller.delete_network_vlan(network_id, vlan_id)
get_network_vlans_enabled_state
Returns the enabled status of VLANs for the network
def get_network_vlans_enabled_state(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = vla_ns_controller.get_network_vlans_enabled_state(network_id)
update_network_vlans_enabled_state
Enable/Disable VLANs for the given network
def update_network_vlans_enabled_state(self,
network_id,
update_network_vlans_enabled_state)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkVlansEnabledState | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_vlans_enabled_state = UpdateNetworkVlansEnabledState()
result = vla_ns_controller.update_network_vlans_enabled_state(network_id, update_network_vlans_enabled_state)
WebhookLogsController
Get controller instance
An instance of the WebhookLogsController class can be accessed from the API Client.
webhook_logs_controller = client.webhook_logs
get_organization_webhook_logs
Return the log of webhook POSTs sent
def get_organization_webhook_logs(self,
organization_id,
t_0=None,
t_1=None,
timespan=None,
per_page=None,
starting_after=None,
ending_before=None,
url=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| organizationId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 90 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. |
| perPage | Optional |
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. |
| startingAfter | Optional |
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| endingBefore | Optional |
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| url | Optional |
The URL the webhook was sent to |
Example Usage
organization_id = 'organizationId'
t_0 = 't0'
t_1 = 't1'
timespan = 140.936167792387
per_page = 140
starting_after = 'startingAfter'
ending_before = 'endingBefore'
url = 'url'
result = webhook_logs_controller.get_organization_webhook_logs(organization_id, t_0, t_1, timespan, per_page, starting_after, ending_before, url)
WirelessHealthController
Get controller instance
An instance of the WirelessHealthController class can be accessed from the API Client.
wireless_health_controller = client.wireless_health
get_network_clients_connection_stats
Aggregated connectivity info for this network, grouped by clients
def get_network_clients_connection_stats(self,
network_id,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
Example Usage
network_id = 'networkId'
t_0 = 't0'
t_1 = 't1'
timespan = 140.936167792387
ssid = 140
vlan = 140
ap_tag = 'apTag'
result = wireless_health_controller.get_network_clients_connection_stats(network_id, t_0, t_1, timespan, ssid, vlan, ap_tag)
get_network_clients_latency_stats
Aggregated latency info for this network, grouped by clients
def get_network_clients_latency_stats(self,
network_id,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None,
fields=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
| fields | Optional |
Partial 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 Usage
network_id = 'networkId'
t_0 = 't0'
t_1 = 't1'
timespan = 140.936167792387
ssid = 140
vlan = 140
ap_tag = 'apTag'
fields = 'fields'
result = wireless_health_controller.get_network_clients_latency_stats(network_id, t_0, t_1, timespan, ssid, vlan, ap_tag, fields)
get_network_client_connection_stats
Aggregated connectivity info for a given client on this network. Clients are identified by their MAC.
def get_network_client_connection_stats(self,
network_id,
client_id,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
Example Usage
network_id = 'networkId'
client_id = 'clientId'
t_0 = 't0'
t_1 = 't1'
timespan = 140.936167792387
ssid = 140
vlan = 140
ap_tag = 'apTag'
result = wireless_health_controller.get_network_client_connection_stats(network_id, client_id, t_0, t_1, timespan, ssid, vlan, ap_tag)
get_network_client_latency_stats
Aggregated latency info for a given client on this network. Clients are identified by their MAC.
def get_network_client_latency_stats(self,
network_id,
client_id,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None,
fields=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| clientId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
| fields | Optional |
Partial 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 Usage
network_id = 'networkId'
client_id = 'clientId'
t_0 = 't0'
t_1 = 't1'
timespan = 140.936167792387
ssid = 140
vlan = 140
ap_tag = 'apTag'
fields = 'fields'
result = wireless_health_controller.get_network_client_latency_stats(network_id, client_id, t_0, t_1, timespan, ssid, vlan, ap_tag, fields)
get_network_connection_stats
Aggregated connectivity info for this network
def get_network_connection_stats(self,
network_id,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
Example Usage
network_id = 'networkId'
t_0 = 't0'
t_1 = 't1'
timespan = 232.43144968405
ssid = 232
vlan = 232
ap_tag = 'apTag'
result = wireless_health_controller.get_network_connection_stats(network_id, t_0, t_1, timespan, ssid, vlan, ap_tag)
get_network_devices_connection_stats
Aggregated connectivity info for this network, grouped by node
def get_network_devices_connection_stats(self,
network_id,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
Example Usage
network_id = 'networkId'
t_0 = 't0'
t_1 = 't1'
timespan = 232.43144968405
ssid = 232
vlan = 232
ap_tag = 'apTag'
result = wireless_health_controller.get_network_devices_connection_stats(network_id, t_0, t_1, timespan, ssid, vlan, ap_tag)
get_network_devices_latency_stats
Aggregated latency info for this network, grouped by node
def get_network_devices_latency_stats(self,
network_id,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None,
fields=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
| fields | Optional |
Partial 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 Usage
network_id = 'networkId'
t_0 = 't0'
t_1 = 't1'
timespan = 232.43144968405
ssid = 232
vlan = 232
ap_tag = 'apTag'
fields = 'fields'
result = wireless_health_controller.get_network_devices_latency_stats(network_id, t_0, t_1, timespan, ssid, vlan, ap_tag, fields)
get_network_device_connection_stats
Aggregated connectivity info for a given AP on this network
def get_network_device_connection_stats(self,
network_id,
serial,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
Example Usage
network_id = 'networkId'
serial = 'serial'
t_0 = 't0'
t_1 = 't1'
timespan = 232.43144968405
ssid = 232
vlan = 232
ap_tag = 'apTag'
result = wireless_health_controller.get_network_device_connection_stats(network_id, serial, t_0, t_1, timespan, ssid, vlan, ap_tag)
get_network_device_latency_stats
Aggregated latency info for a given AP on this network
def get_network_device_latency_stats(self,
network_id,
serial,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None,
fields=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| serial | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
| fields | Optional |
Partial 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 Usage
network_id = 'networkId'
serial = 'serial'
t_0 = 't0'
t_1 = 't1'
timespan = 232.43144968405
ssid = 232
vlan = 232
ap_tag = 'apTag'
fields = 'fields'
result = wireless_health_controller.get_network_device_latency_stats(network_id, serial, t_0, t_1, timespan, ssid, vlan, ap_tag, fields)
get_network_failed_connections
List of all failed client connection events on this network in a given time range
def get_network_failed_connections(self,
network_id,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None,
serial=None,
client_id=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
| serial | Optional |
Filter by AP |
| clientId | Optional |
Filter by client MAC |
Example Usage
network_id = 'networkId'
t_0 = 't0'
t_1 = 't1'
timespan = 232.43144968405
ssid = 232
vlan = 232
ap_tag = 'apTag'
serial = 'serial'
client_id = 'clientId'
result = wireless_health_controller.get_network_failed_connections(network_id, t_0, t_1, timespan, ssid, vlan, ap_tag, serial, client_id)
get_network_latency_stats
Aggregated latency info for this network
def get_network_latency_stats(self,
network_id,
t_0=None,
t_1=None,
timespan=None,
ssid=None,
vlan=None,
ap_tag=None,
fields=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| t0 | Optional |
The beginning of the timespan for the data. The maximum lookback period is 180 days from today. |
| t1 | Optional |
The end of the timespan for the data. t1 can be a maximum of 7 days after t0. |
| timespan | Optional |
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. |
| ssid | Optional |
Filter results by SSID |
| vlan | Optional |
Filter results by VLAN |
| apTag | Optional |
Filter results by AP Tag |
| fields | Optional |
Partial 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 Usage
network_id = 'networkId'
t_0 = 't0'
t_1 = 't1'
timespan = 232.43144968405
ssid = 232
vlan = 232
ap_tag = 'apTag'
fields = 'fields'
result = wireless_health_controller.get_network_latency_stats(network_id, t_0, t_1, timespan, ssid, vlan, ap_tag, fields)
WirelessSettingsController
Get controller instance
An instance of the WirelessSettingsController class can be accessed from the API Client.
wireless_settings_controller = client.wireless_settings
get_network_wireless_settings
Return the wireless settings for a network
def get_network_wireless_settings(self,
network_id)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
result = wireless_settings_controller.get_network_wireless_settings(network_id)
update_network_wireless_settings
Update the wireless settings for a network
def update_network_wireless_settings(self,
network_id,
update_network_wireless_settings=None)
Parameters
| Parameter | Tags | Description |
|---|---|---|
| networkId | Required |
TODO: Add a parameter description |
| updateNetworkWirelessSettings | Optional |
TODO: Add a parameter description |
Example Usage
network_id = 'networkId'
update_network_wireless_settings = UpdateNetworkWirelessSettings()
result = wireless_settings_controller.update_network_wireless_settings(network_id, update_network_wireless_settings)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
test-meraki-1.0.tar.gz
(227.4 kB
view details)
Built Distribution
test_meraki-1.0-py3-none-any.whl
(407.9 kB
view details)
File details
Details for the file test-meraki-1.0.tar.gz.
File metadata
- Download URL: test-meraki-1.0.tar.gz
- Upload date:
- Size: 227.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 35db3a2f2cd6f37d970cccf0011922c0b01db5e697429050ef3761459e1b5d5e |
|
| MD5 | bf85a6567e77b4bee75381b55b217dce |
|
| BLAKE2b-256 | 0b994ea00e370143efbe472b24f4ee996168c9d6a3f430b50b9788168d8f19df |
File details
Details for the file test_meraki-1.0-py3-none-any.whl.
File metadata
- Download URL: test_meraki-1.0-py3-none-any.whl
- Upload date:
- Size: 407.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e4489d4168987bfc6c8a3b09b2329ec503b95001d6b068e673ee3fbed8022d72 |
|
| MD5 | 6ccaa3bce3d6f32372538dc47f490a72 |
|
| BLAKE2b-256 | bc70e0c3a7e27322df4f145ca126a384b0278f31a5589946998503d0f84338da |
