Python client library for Meraki Dashboard API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for merakiapi from gravatar.com merakiapi

Unverified details

These details have not been verified by PyPI
Project links
Meta

Project description

Getting started

The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.

What can the API be used for?

The Dashboard API can be used for many purposes. It’s meant to be an open-ended tool. Here are some examples of use cases:

  • Add new organizations, admins, networks, devices, VLANs, and more
  • Configure networks at scale
  • Automatically on-board and off-board new employees’ teleworker setups
  • Build your own dashboard for store managers, field techs, or unique use cases

Enabling the Dashboard API

  1. Begin by logging into Meraki Dashboard and navigating to Organization > Settings

  2. Locate the section titled Dashboard API access and select Enable Access, then Save your changes

  3. After enabling the API, choose your username at the top-right of the Meraki Dashboard and select my profile

  4. Locate the section titled Dashboard API access and select Generate new API key

Note: The API key is associated with a Dashboard administrator account. You can generate, revoke, and regenerate your API key on your profile.

Keep your API key safe as it provides authentication to all of your organizations with the API enabled. If your API key is shared, you can regenerate your API key at any time. This will revoke the existing API key.

Copy and store your API key in a safe place. Dashboard does not store API keys in plaintext for security reasons, so this is the only time you will be able to record it. If you lose or forget your API key, you will have to revoke it and generate a new one.

Every request must specify an API key via a request header.

The API key must be specified in the URL header. The API will return a 404 (rather than a 403) in response to a request with a missing or incorrect API key in order to prevent leaking the existence of resources to unauthorized users.

X-Cisco-Meraki-API-Key: <secret key>

Read more about API authorization

Versioning

Once an API version is released, we will make only backwards-compatible changes to it. Backwards-compatible changes include:

  • Adding new API resources

  • Adding new optional request parameters to existing API methods

  • Adding new properties to existing API responses

  • Changing the order of properties in existing API responses

Rate Limit

  • The Dashboard API is limited to 5 calls per second, per organization.
  • A burst of 5 additional calls are allowed in the first second, so a maximum of 15 calls in the first 2 seconds.
  • The rate limiting technique is based off of the token bucket model.
  • An error with a 429 status code will be returned when the rate limit has been exceeded.
  • Expect to backoff for 1 - 2 seconds if the limit has been exceeded. You may have to wait potentially longer if a large number of requests were made within this timeframe.

Additional Details

Identifiers in the API are opaque strings. A {networkId}, for example, might be the string “126043”, whereas an {orderId} might contain characters, such as “4S1234567”. Client applications must not try to parse them as numbers. Even identifiers that look like numbers might be too long to encode without loss of precision in Javascript, where the only numeric type is IEEE 754 floating point.

Verbs in the API follow the usual REST conventions:

GET returns the value of a resource or a list of resources, depending on whether an identifier is specified. For example, a GET of /v0/organizations returns a list of organizations, whereas a GET of /v0/organizations/{organizationId} returns a particular organization.

POST adds a new resource, as in a POST to /v0/organizations/{organizationId}/admins, or performs some other non-idempotent change.

PUT updates a resource. PUTs are idempotent; they update a resource, creating it first if it does not already exist. A PUT should specify all the fields of a resource; the API will revert omitted fields to their default value.

DELETE removes a resource.

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.

Building SDK - Step 1

How to Use

The following section explains how to use the Meraki 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.

Open project in PyCharm - Step 1

Click on Open in PyCharm to browse to your generated SDK directory and then click OK.

Open project in PyCharm - Step 2

The project files will be displayed in the side bar as follows:

Open project in PyCharm - Step 3

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Add a new project in PyCharm - Step 1

Name the directory as "test"

Add a new project in PyCharm - Step 2

Add a python file to this project with the name "testsdk"

Add a new project in PyCharm - Step 3

Name it "testsdk"

Add a new project in PyCharm - Step 4

In your python file you will be required to import the generated python library using the following code lines

from meraki_sdk.meraki_sdk_client import MerakiSdkClient

Add a new project in PyCharm - Step 4

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

Run Test Project - Step 1

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:

  1. From terminal/cmd navigate to the root directory of the SDK.
  2. Invoke pip install -r test-requirements.txt
  3. 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 Demo DevNet Sandbox

API client can be initialized as following.

# Configuration parameters and credentials
x_cisco_meraki_api_key = '15da0c6ffff295f16267f88f98694cf29a86ed87' # Demo DevNet Sandbox

client = MerakiSdkClient(x_cisco_meraki_api_key)

Class Reference

List of Controllers

Class: OrganizationsController

Get controller instance

An instance of the OrganizationsController class can be accessed from the API Client.

 organizations_controller = client.organizations

Method: get_organizations

List the organizations that the user has privileges on

def get_organizations(self)

Example Usage

result = organizations_controller.get_organizations()

Method: update_organization_third_party_vpn_peers

Update the third party VPN peers for an organization

def update_organization_third_party_vpn_peers(self,
                                                  options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
updateOrganizationThirdPartyVPNPeers Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

update_organization_third_party_vpn_peers = UpdateOrganizationThirdPartyVPNPeersModel()
collect['update_organization_third_party_vpn_peers'] = update_organization_third_party_vpn_peers


result = organizations_controller.update_organization_third_party_vpn_peers(collect)

Method: 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)

Method: 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,
                                                  options=dict())

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

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 171
collect['timespan'] = timespan

uplink = 'uplink'
collect['uplink'] = uplink

ip = 'ip'
collect['ip'] = ip


result = organizations_controller.get_organization_uplinks_loss_and_latency(collect)

Method: claim_organization

Claim a device, license key, or order 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. These three types of claims are mutually exclusive and cannot be performed in one request.

def claim_organization(self,
                           options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
claimOrganization Optional TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

claim_organization = ClaimOrganizationModel()
collect['claim_organization'] = claim_organization


result = organizations_controller.claim_organization(collect)

Method: get_organization_device_statuses

List the status of every Meraki device in the organization

def get_organization_device_statuses(self,
                                         id)

Parameters

Parameter Tags Description
id Required TODO: Add a parameter description

Example Usage

id = 'id'

result = organizations_controller.get_organization_device_statuses(id)

Method: get_organization_inventory

Return the inventory for an organization

def get_organization_inventory(self,
                                   id)

Parameters

Parameter Tags Description
id Required TODO: Add a parameter description

Example Usage

id = 'id'

result = organizations_controller.get_organization_inventory(id)

Method: get_organization_license_state

Return the license state for an organization

def get_organization_license_state(self,
                                       id)

Parameters

Parameter Tags Description
id Required TODO: Add a parameter description

Example Usage

id = 'id'

result = organizations_controller.get_organization_license_state(id)

Method: clone_organization

Create a new organization by cloning the addressed organization

def clone_organization(self,
                           options=dict())

Parameters

Parameter Tags Description
id Required TODO: Add a parameter description
cloneOrganization Optional TODO: Add a parameter description

Example Usage

collect = {}

id = 'id'
collect['id'] = id

clone_organization = CloneOrganizationModel()
collect['clone_organization'] = clone_organization


result = organizations_controller.clone_organization(collect)

Method: update_organization

Update an organization

def update_organization(self,
                            options=dict())

Parameters

Parameter Tags Description
id Required TODO: Add a parameter description
updateOrganization Optional TODO: Add a parameter description

Example Usage

collect = {}

id = 'id'
collect['id'] = id

update_organization = UpdateOrganizationModel()
collect['update_organization'] = update_organization


result = organizations_controller.update_organization(collect)

Method: get_organization

Return an organization

def get_organization(self,
                         id)

Parameters

Parameter Tags Description
id Required TODO: Add a parameter description

Example Usage

id = 'id'

result = organizations_controller.get_organization(id)

Method: create_organization

Create a new organization

def create_organization(self,
                            create_organization=None)

Parameters

Parameter Tags Description
createOrganization Optional TODO: Add a parameter description

Example Usage

create_organization = CreateOrganizationModel()

result = organizations_controller.create_organization(create_organization)

Back to List of Controllers

Class: 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

Method: 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,
                                             options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkOneToManyNatRules Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_one_to_many_nat_rules = UpdateNetworkOneToManyNatRulesModel()
collect['update_network_one_to_many_nat_rules'] = update_network_one_to_many_nat_rules


result = mx1_many_nat_rules_controller.update_network_one_to_many_nat_rules(collect)

Method: 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 = mx1_many_nat_rules_controller.get_network_one_to_many_nat_rules(network_id)

Back to List of Controllers

Class: FirewalledServicesController

Get controller instance

An instance of the FirewalledServicesController class can be accessed from the API Client.

 firewalled_services_controller = client.firewalled_services

Method: update_network_firewalled_service

Updates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')

def update_network_firewalled_service(self,
                                          options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
service Required TODO: Add a parameter description
updateNetworkFirewalledService Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

service = 'service'
collect['service'] = service

update_network_firewalled_service = UpdateNetworkFirewalledServiceModel()
collect['update_network_firewalled_service'] = update_network_firewalled_service


result = firewalled_services_controller.update_network_firewalled_service(collect)

Method: get_network_firewalled_service

Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')

def get_network_firewalled_service(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
service Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

service = 'service'
collect['service'] = service


result = firewalled_services_controller.get_network_firewalled_service(collect)

Method: 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)

Back to List of Controllers

Class: TrafficShapingController

Get controller instance

An instance of the TrafficShapingController class can be accessed from the API Client.

 traffic_shaping_controller = client.traffic_shaping

Method: get_network_ssid_traffic_shaping

Display the traffic shaping settings for a SSID on an MR network

def get_network_ssid_traffic_shaping(self,
                                         options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
number Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

number = 'number'
collect['number'] = number


result = traffic_shaping_controller.get_network_ssid_traffic_shaping(collect)

Method: update_network_ssid_traffic_shaping

Update the traffic shaping settings for an SSID on an MR network

def update_network_ssid_traffic_shaping(self,
                                            options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

number = 'number'
collect['number'] = number

update_network_ssid_traffic_shaping = UpdateNetworkSsidTrafficShapingModel()
collect['update_network_ssid_traffic_shaping'] = update_network_ssid_traffic_shaping


result = traffic_shaping_controller.update_network_ssid_traffic_shaping(collect)

Method: 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)

Method: update_network_traffic_shaping

Update the traffic shaping settings for an MX network

def update_network_traffic_shaping(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkTrafficShaping Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_traffic_shaping = UpdateNetworkTrafficShapingModel()
collect['update_network_traffic_shaping'] = update_network_traffic_shaping


result = traffic_shaping_controller.update_network_traffic_shaping(collect)

Method: 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)

Method: 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)

Back to List of Controllers

Class: WirelessHealthController

Get controller instance

An instance of the WirelessHealthController class can be accessed from the API Client.

 wireless_health_controller = client.wireless_health

Method: 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,
                                            options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag


result = wireless_health_controller.get_network_client_connection_stats(collect)

Method: get_network_latency_stats

Aggregated latency info for this network

def get_network_latency_stats(self,
                                  options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag

fields = 'fields'
collect['fields'] = fields


result = wireless_health_controller.get_network_latency_stats(collect)

Method: get_network_devices_latency_stats

Aggregated latency info for this network, grouped by node

def get_network_devices_latency_stats(self,
                                          options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag

fields = 'fields'
collect['fields'] = fields


result = wireless_health_controller.get_network_devices_latency_stats(collect)

Method: get_network_device_latency_stats

Aggregated latency info for a given AP on this network

def get_network_device_latency_stats(self,
                                         options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag

fields = 'fields'
collect['fields'] = fields


result = wireless_health_controller.get_network_device_latency_stats(collect)

Method: get_network_clients_latency_stats

Aggregated latency info for this network, grouped by clients

def get_network_clients_latency_stats(self,
                                          options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag

fields = 'fields'
collect['fields'] = fields


result = wireless_health_controller.get_network_clients_latency_stats(collect)

Method: 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,
                                         options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag

fields = 'fields'
collect['fields'] = fields


result = wireless_health_controller.get_network_client_latency_stats(collect)

Method: 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,
                                       options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag

serial = 'serial'
collect['serial'] = serial

client_id = 'clientId'
collect['client_id'] = client_id


result = wireless_health_controller.get_network_failed_connections(collect)

Method: get_network_clients_connection_stats

Aggregated connectivity info for this network, grouped by clients

def get_network_clients_connection_stats(self,
                                             options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag


result = wireless_health_controller.get_network_clients_connection_stats(collect)

Method: get_network_device_connection_stats

Aggregated connectivity info for a given AP on this network

def get_network_device_connection_stats(self,
                                            options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag


result = wireless_health_controller.get_network_device_connection_stats(collect)

Method: get_network_devices_connection_stats

Aggregated connectivity info for this network, grouped by node

def get_network_devices_connection_stats(self,
                                             options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag


result = wireless_health_controller.get_network_devices_connection_stats(collect)

Method: get_network_connection_stats

Aggregated connectivity info for this network

def get_network_connection_stats(self,
                                     options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 129
collect['timespan'] = timespan

ssid = 129
collect['ssid'] = ssid

vlan = 129
collect['vlan'] = vlan

ap_tag = 'apTag'
collect['ap_tag'] = ap_tag


result = wireless_health_controller.get_network_connection_stats(collect)

Back to List of Controllers

Class: AlertSettingsController

Get controller instance

An instance of the AlertSettingsController class can be accessed from the API Client.

 alert_settings_controller = client.alert_settings

Method: 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)

Method: update_network_alert_settings

Update the alert configuration for this network

def update_network_alert_settings(self,
                                      options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkAlertSettings Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_alert_settings = UpdateNetworkAlertSettingsModel()
collect['update_network_alert_settings'] = update_network_alert_settings


result = alert_settings_controller.update_network_alert_settings(collect)

Back to List of Controllers

Class: AdminsController

Get controller instance

An instance of the AdminsController class can be accessed from the API Client.

 admins_controller = client.admins

Method: delete_organization_admin

Revoke all access for a dashboard administrator within this organization

def delete_organization_admin(self,
                                  options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

id = 'id'
collect['id'] = id


admins_controller.delete_organization_admin(collect)

Method: create_organization_admin

Create a new dashboard administrator

def create_organization_admin(self,
                                  options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
createOrganizationAdmin Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

create_organization_admin = CreateOrganizationAdminModel()
collect['create_organization_admin'] = create_organization_admin


result = admins_controller.create_organization_admin(collect)

Method: 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)

Method: update_organization_admin

Update an administrator

def update_organization_admin(self,
                                  options=dict())

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

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

id = 'id'
collect['id'] = id

update_organization_admin = UpdateOrganizationAdminModel()
collect['update_organization_admin'] = update_organization_admin


result = admins_controller.update_organization_admin(collect)

Back to List of Controllers

Class: ActionBatchesController

Get controller instance

An instance of the ActionBatchesController class can be accessed from the API Client.

 action_batches_controller = client.action_batches

Method: delete_organization_action_batch

Delete an action batch

def delete_organization_action_batch(self,
                                         options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

id = 'id'
collect['id'] = id


action_batches_controller.delete_organization_action_batch(collect)

Method: get_organization_action_batch

Return an action batch

def get_organization_action_batch(self,
                                      options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

id = 'id'
collect['id'] = id


result = action_batches_controller.get_organization_action_batch(collect)

Method: 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)

Method: create_organization_action_batch

Create an action batch

def create_organization_action_batch(self,
                                         options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
createOrganizationActionBatch Optional TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

create_organization_action_batch = CreateOrganizationActionBatchModel()
collect['create_organization_action_batch'] = create_organization_action_batch


result = action_batches_controller.create_organization_action_batch(collect)

Method: update_organization_action_batch

Update an action batch

def update_organization_action_batch(self,
                                         options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
id Required TODO: Add a parameter description
updateOrganizationActionBatch Optional TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

id = 'id'
collect['id'] = id

update_organization_action_batch = UpdateOrganizationActionBatchModel()
collect['update_organization_action_batch'] = update_organization_action_batch


result = action_batches_controller.update_organization_action_batch(collect)

Back to List of Controllers

Class: SwitchPortsController

Get controller instance

An instance of the SwitchPortsController class can be accessed from the API Client.

 switch_ports_controller = client.switch_ports

Method: update_device_switch_port

Update a switch port

def update_device_switch_port(self,
                                  options=dict())

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

collect = {}

serial = 'serial'
collect['serial'] = serial

number = 'number'
collect['number'] = number

update_device_switch_port = UpdateDeviceSwitchPortModel()
collect['update_device_switch_port'] = update_device_switch_port


result = switch_ports_controller.update_device_switch_port(collect)

Method: get_device_switch_port

Return a switch port

def get_device_switch_port(self,
                               options=dict())

Parameters

Parameter Tags Description
serial Required TODO: Add a parameter description
number Required TODO: Add a parameter description

Example Usage

collect = {}

serial = 'serial'
collect['serial'] = serial

number = 'number'
collect['number'] = number


result = switch_ports_controller.get_device_switch_port(collect)

Method: 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)

Back to List of Controllers

Class: SsidsController

Get controller instance

An instance of the SsidsController class can be accessed from the API Client.

 ssids_controller = client.ssids

Method: update_network_ssid

Update the attributes of an SSID

def update_network_ssid(self,
                            options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

number = 'number'
collect['number'] = number

update_network_ssid = UpdateNetworkSsidModel()
collect['update_network_ssid'] = update_network_ssid


result = ssids_controller.update_network_ssid(collect)

Method: get_network_ssid

Return a single SSID

def get_network_ssid(self,
                         options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
number Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

number = 'number'
collect['number'] = number


result = ssids_controller.get_network_ssid(collect)

Method: 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 = ssids_controller.get_network_ssids(network_id)

Back to List of Controllers

Class: SplashSettingsController

Get controller instance

An instance of the SplashSettingsController class can be accessed from the API Client.

 splash_settings_controller = client.splash_settings

Method: update_network_ssids_plash_settings

Modify the splash page settings for the given SSID

def update_network_ssids_plash_settings(self,
                                            options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
number Required TODO: Add a parameter description
updateNetwork_ssids_PlashSettings Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

number = 'number'
collect['number'] = number

update_network_ssids_plash_settings = UpdateNetworkSsidsPlashSettingsModel()
collect['update_network_ssids_plash_settings'] = update_network_ssids_plash_settings


result = splash_settings_controller.update_network_ssids_plash_settings(collect)

Method: get_network_ssids_plash_settings

Display the splash page settings for the given SSID

def get_network_ssids_plash_settings(self,
                                         options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
number Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

number = 'number'
collect['number'] = number


result = splash_settings_controller.get_network_ssids_plash_settings(collect)

Back to List of Controllers

Class: 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

Method: get_network_splash_login_attempts

List the splash login attempts for a network

def get_network_splash_login_attempts(self,
                                          options=dict())

Parameters

Parameter Tags Description
id 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

collect = {}

id = 'id'
collect['id'] = id

ssid_number = 'ssidNumber'
collect['ssid_number'] = ssid_number

login_identifier = 'loginIdentifier'
collect['login_identifier'] = login_identifier

timespan = 'timespan'
collect['timespan'] = timespan


result = splash_login_attempts_controller.get_network_splash_login_attempts(collect)

Back to List of Controllers

Class: SMController

Get controller instance

An instance of the SMController class can be accessed from the API Client.

 sm_controller = client.sm

Method: get_network_sm_softwares

Get a list of softwares associated with a device

def get_network_sm_softwares(self,
                                 options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
deviceId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

device_id = 'deviceId'
collect['device_id'] = device_id


result = sm_controller.get_network_sm_softwares(collect)

Method: get_network_sm_user_softwares

Get a list of softwares associated with a user

def get_network_sm_user_softwares(self,
                                      options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
userId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

user_id = 'userId'
collect['user_id'] = user_id


result = sm_controller.get_network_sm_user_softwares(collect)

Method: get_network_sm_users

List the owners in an SM network with various specified fields and filters

def get_network_sm_users(self,
                             options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

ids = 'ids'
collect['ids'] = ids

usernames = 'usernames'
collect['usernames'] = usernames

emails = 'emails'
collect['emails'] = emails

scope = 'scope'
collect['scope'] = scope


result = sm_controller.get_network_sm_users(collect)

Method: get_network_sm_connectivity

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

def get_network_sm_connectivity(self,
                                    options=dict())

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

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

id = 'id'
collect['id'] = id

per_page = 'perPage'
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = sm_controller.get_network_sm_connectivity(collect)

Method: 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,
                                           options=dict())

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

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

id = 'id'
collect['id'] = id

per_page = 'perPage'
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = sm_controller.get_network_sm_device_command_logs(collect)

Method: 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,
                                    options=dict())

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

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

id = 'id'
collect['id'] = id

per_page = 'perPage'
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = sm_controller.get_network_sm_desktop_logs(collect)

Method: get_network_sm_performance_history

Return historical records of various Systems Manager client metrics for desktop devices.

def get_network_sm_performance_history(self,
                                           options=dict())

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

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

id = 'id'
collect['id'] = id

per_page = 'perPage'
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = sm_controller.get_network_sm_performance_history(collect)

Method: 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,
                                              options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
deviceId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

device_id = 'deviceId'
collect['device_id'] = device_id


result = sm_controller.get_network_sm_cellular_usage_history(collect)

Method: 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)

Method: unenroll_network_sm_device

Unenroll a device

def unenroll_network_sm_device(self,
                                   options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
deviceId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

device_id = 'deviceId'
collect['device_id'] = device_id


result = sm_controller.unenroll_network_sm_device(collect)

Method: move_network_sm_devices

Move a set of devices to a new network

def move_network_sm_devices(self,
                                options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
moveNetworkSmDevices Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

move_network_sm_devices = MoveNetworkSmDevicesModel()
collect['move_network_sm_devices'] = move_network_sm_devices


result = sm_controller.move_network_sm_devices(collect)

Method: checkin_network_sm_devices

Force check-in a set of devices

def checkin_network_sm_devices(self,
                                   options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
checkinNetworkSmDevices Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

checkin_network_sm_devices = CheckinNetworkSmDevicesModel()
collect['checkin_network_sm_devices'] = checkin_network_sm_devices


result = sm_controller.checkin_network_sm_devices(collect)

Method: wipe_network_sm_device

Wipe a device

def wipe_network_sm_device(self,
                               options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
wipeNetworkSmDevice Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

wipe_network_sm_device = WipeNetworkSmDeviceModel()
collect['wipe_network_sm_device'] = wipe_network_sm_device


result = sm_controller.wipe_network_sm_device(collect)

Method: lock_network_sm_devices

Lock a set of devices

def lock_network_sm_devices(self,
                                options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
lockNetworkSmDevices Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

lock_network_sm_devices = LockNetworkSmDevicesModel()
collect['lock_network_sm_devices'] = lock_network_sm_devices


result = sm_controller.lock_network_sm_devices(collect)

Method: update_network_sm_device_fields

Modify the fields of a device

def update_network_sm_device_fields(self,
                                        options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkSmDeviceFields Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_sm_device_fields = UpdateNetworkSmDeviceFieldsModel()
collect['update_network_sm_device_fields'] = update_network_sm_device_fields


result = sm_controller.update_network_sm_device_fields(collect)

Method: update_network_sm_devices_tags

Add, delete, or update the tags of a set of devices

def update_network_sm_devices_tags(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkSmDevicesTags Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_sm_devices_tags = UpdateNetworkSmDevicesTagsModel()
collect['update_network_sm_devices_tags'] = update_network_sm_devices_tags


result = sm_controller.update_network_sm_devices_tags(collect)

Method: get_network_sm_certs

List the certs on a device

def get_network_sm_certs(self,
                             options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
deviceId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

device_id = 'deviceId'
collect['device_id'] = device_id


result = sm_controller.get_network_sm_certs(collect)

Method: get_network_sm_restrictions

List the restrictions on a device

def get_network_sm_restrictions(self,
                                    options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
deviceId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

device_id = 'deviceId'
collect['device_id'] = device_id


result = sm_controller.get_network_sm_restrictions(collect)

Method: get_network_sm_security_centers

List the security centers on a device

def get_network_sm_security_centers(self,
                                        options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
deviceId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

device_id = 'deviceId'
collect['device_id'] = device_id


result = sm_controller.get_network_sm_security_centers(collect)

Method: get_network_sm_wlan_lists

List the saved SSID names on a device

def get_network_sm_wlan_lists(self,
                                  options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
deviceId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

device_id = 'deviceId'
collect['device_id'] = device_id


result = sm_controller.get_network_sm_wlan_lists(collect)

Method: get_network_sm_network_adapters

List the network adapters of a device

def get_network_sm_network_adapters(self,
                                        options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
deviceId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

device_id = 'deviceId'
collect['device_id'] = device_id


result = sm_controller.get_network_sm_network_adapters(collect)

Method: get_network_sm_device_profiles

Get the profiles associated with a device

def get_network_sm_device_profiles(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
deviceId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

device_id = 'deviceId'
collect['device_id'] = device_id


result = sm_controller.get_network_sm_device_profiles(collect)

Method: get_network_sm_user_device_profiles

Get the profiles associated with a user

def get_network_sm_user_device_profiles(self,
                                            options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
userId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

user_id = 'userId'
collect['user_id'] = user_id


result = sm_controller.get_network_sm_user_device_profiles(collect)

Method: delete_network_sm_app_polaris

Delete a Cisco Polaris app

def delete_network_sm_app_polaris(self,
                                      options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
appId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

app_id = 'appId'
collect['app_id'] = app_id


sm_controller.delete_network_sm_app_polaris(collect)

Method: update_network_sm_app_polaris

Update an existing Polaris app

def update_network_sm_app_polaris(self,
                                      options=dict())

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

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

app_id = 'appId'
collect['app_id'] = app_id

update_network_sm_app_polaris = UpdateNetworkSmAppPolarisModel()
collect['update_network_sm_app_polaris'] = update_network_sm_app_polaris


result = sm_controller.update_network_sm_app_polaris(collect)

Method: get_network_sm_app_polaris

Get details for a Cisco Polaris app if it exists

def get_network_sm_app_polaris(self,
                                   options=dict())

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

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

bundle_id = 'bundleId'
collect['bundle_id'] = bundle_id


result = sm_controller.get_network_sm_app_polaris(collect)

Method: create_network_sm_app_polaris

Create a new Polaris app

def create_network_sm_app_polaris(self,
                                      options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkSmAppPolaris Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

create_network_sm_app_polaris = CreateNetworkSmAppPolarisModel()
collect['create_network_sm_app_polaris'] = create_network_sm_app_polaris


result = sm_controller.create_network_sm_app_polaris(collect)

Method: 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,
                                           options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
profileId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

profile_id = 'profileId'
collect['profile_id'] = profile_id


sm_controller.delete_network_sm_profile_umbrella(collect)

Method: get_network_sm_profile_umbrella

Get details for a Cisco Umbrella payload

def get_network_sm_profile_umbrella(self,
                                        options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
profileId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

profile_id = 'profileId'
collect['profile_id'] = profile_id


result = sm_controller.get_network_sm_profile_umbrella(collect)

Method: add_network_sm_profile_umbrella

Add a Cisco Umbrella payload to an existing profile

def add_network_sm_profile_umbrella(self,
                                        options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
profileId Required TODO: Add a parameter description
addNetworkSmProfileUmbrella Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

profile_id = 'profileId'
collect['profile_id'] = profile_id

add_network_sm_profile_umbrella = AddNetworkSmProfileUmbrellaModel()
collect['add_network_sm_profile_umbrella'] = add_network_sm_profile_umbrella


result = sm_controller.add_network_sm_profile_umbrella(collect)

Method: update_network_sm_profile_umbrella

Update an existing profile containing a Cisco Umbrella payload

def update_network_sm_profile_umbrella(self,
                                           options=dict())

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

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

profile_id = 'profileId'
collect['profile_id'] = profile_id

update_network_sm_profile_umbrella = UpdateNetworkSmProfileUmbrellaModel()
collect['update_network_sm_profile_umbrella'] = update_network_sm_profile_umbrella


result = sm_controller.update_network_sm_profile_umbrella(collect)

Method: create_network_sm_profile_umbrella

Create a new profile containing a Cisco Umbrella payload

def create_network_sm_profile_umbrella(self,
                                           options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkSmProfileUmbrella Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

create_network_sm_profile_umbrella = CreateNetworkSmProfileUmbrellaModel()
collect['create_network_sm_profile_umbrella'] = create_network_sm_profile_umbrella


result = sm_controller.create_network_sm_profile_umbrella(collect)

Method: 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,
                                          options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
profileId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

profile_id = 'profileId'
collect['profile_id'] = profile_id


sm_controller.delete_network_sm_profile_clarity(collect)

Method: get_network_sm_profile_clarity

Get details for a Cisco Clarity payload

def get_network_sm_profile_clarity(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
profileId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

profile_id = 'profileId'
collect['profile_id'] = profile_id


result = sm_controller.get_network_sm_profile_clarity(collect)

Method: add_network_sm_profile_clarity

Add a Cisco Clarity payload to an existing profile

def add_network_sm_profile_clarity(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
profileId Required TODO: Add a parameter description
addNetworkSmProfileClarity Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

profile_id = 'profileId'
collect['profile_id'] = profile_id

add_network_sm_profile_clarity = AddNetworkSmProfileClarityModel()
collect['add_network_sm_profile_clarity'] = add_network_sm_profile_clarity


result = sm_controller.add_network_sm_profile_clarity(collect)

Method: update_network_sm_profile_clarity

Update an existing profile containing a Cisco Clarity payload

def update_network_sm_profile_clarity(self,
                                          options=dict())

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

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

profile_id = 'profileId'
collect['profile_id'] = profile_id

update_network_sm_profile_clarity = UpdateNetworkSmProfileClarityModel()
collect['update_network_sm_profile_clarity'] = update_network_sm_profile_clarity


result = sm_controller.update_network_sm_profile_clarity(collect)

Method: create_network_sm_profile_clarity

Create a new profile containing a Cisco Clarity payload

def create_network_sm_profile_clarity(self,
                                          options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkSmProfileClarity Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'network_id'
collect['network_id'] = network_id

create_network_sm_profile_clarity = CreateNetworkSmProfileClarityModel()
collect['create_network_sm_profile_clarity'] = create_network_sm_profile_clarity


result = sm_controller.create_network_sm_profile_clarity(collect)

Method: get_network_sm_devices

List the devices enrolled in an SM network with various specified fields and filters

def get_network_sm_devices(self,
                               options=dict())

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. | | batchToken | Optional | On networks with more than 1000 devices, the device list will be limited to 1000 devices per query. If there are more devices to be seen, 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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

fields = 'fields'
collect['fields'] = fields

wifi_macs = 'wifiMacs'
collect['wifi_macs'] = wifi_macs

serials = 'serials'
collect['serials'] = serials

ids = 'ids'
collect['ids'] = ids

scope = 'scope'
collect['scope'] = scope

batch_token = 'batchToken'
collect['batch_token'] = batch_token


result = sm_controller.get_network_sm_devices(collect)

Back to List of Controllers

Class: 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

Method: get_network_sm_target_group

Return a target group

def get_network_sm_target_group(self,
                                    options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

target_group_id = 'targetGroupId'
collect['target_group_id'] = target_group_id

with_details = True
collect['with_details'] = with_details


result = named_tag_scope_controller.get_network_sm_target_group(collect)

Method: delete_network_sm_target_group

Delete a target group from a network

def delete_network_sm_target_group(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
targetGroupId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

target_group_id = 'targetGroupId'
collect['target_group_id'] = target_group_id


named_tag_scope_controller.delete_network_sm_target_group(collect)

Method: update_network_sm_target_group

Update a target group

def update_network_sm_target_group(self,
                                       options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

target_group_id = 'targetGroupId'
collect['target_group_id'] = target_group_id

update_network_sm_target_group = UpdateNetworkSmTargetGroupModel()
collect['update_network_sm_target_group'] = update_network_sm_target_group


result = named_tag_scope_controller.update_network_sm_target_group(collect)

Method: create_network_sm_target_group

Add a target group

def create_network_sm_target_group(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkSmTargetGroup Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

create_network_sm_target_group = CreateNetworkSmTargetGroupModel()
collect['create_network_sm_target_group'] = create_network_sm_target_group


result = named_tag_scope_controller.create_network_sm_target_group(collect)

Method: get_network_sm_target_groups

List the target groups in this network

def get_network_sm_target_groups(self,
                                     options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

with_details = True
collect['with_details'] = with_details


result = named_tag_scope_controller.get_network_sm_target_groups(collect)

Back to List of Controllers

Class: SAMLRolesController

Get controller instance

An instance of the SAMLRolesController class can be accessed from the API Client.

 saml_roles_controller = client.saml_roles

Method: update_organization_saml_role

Update a SAML role

def update_organization_saml_role(self,
                                      options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
id Required TODO: Add a parameter description
updateOrganizationSamlRole Optional TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

id = 'id'
collect['id'] = id

update_organization_saml_role = UpdateOrganizationSamlRoleModel()
collect['update_organization_saml_role'] = update_organization_saml_role


result = saml_roles_controller.update_organization_saml_role(collect)

Method: delete_organization_saml_role

Remove a SAML role

def delete_organization_saml_role(self,
                                      options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

id = 'id'
collect['id'] = id


saml_roles_controller.delete_organization_saml_role(collect)

Method: get_organization_saml_role

Return a SAML role

def get_organization_saml_role(self,
                                   options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

id = 'id'
collect['id'] = id


result = saml_roles_controller.get_organization_saml_role(collect)

Method: create_organization_saml_role

Create a SAML role

def create_organization_saml_role(self,
                                      options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
createOrganizationSamlRole Optional TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

create_organization_saml_role = CreateOrganizationSamlRoleModel()
collect['create_organization_saml_role'] = create_organization_saml_role


result = saml_roles_controller.create_organization_saml_role(collect)

Method: 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)

Back to List of Controllers

Class: PIIController

Get controller instance

An instance of the PIIController class can be accessed from the API Client.

 pii_controller = client.pii

Method: 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,
                                          options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
username Optional The username of a Systems Manager user
email 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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

username = 'username'
collect['username'] = username

email = 'email'
collect['email'] = email

mac = 'mac'
collect['mac'] = mac

serial = 'serial'
collect['serial'] = serial

imei = 'imei'
collect['imei'] = imei

bluetooth_mac = 'bluetoothMac'
collect['bluetooth_mac'] = bluetooth_mac


result = pii_controller.get_network_pii_sm_owners_for_key(collect)

Method: 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,
                                           options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
username Optional The username of a Systems Manager user
email 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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

username = 'username'
collect['username'] = username

email = 'email'
collect['email'] = email

mac = 'mac'
collect['mac'] = mac

serial = 'serial'
collect['serial'] = serial

imei = 'imei'
collect['imei'] = imei

bluetooth_mac = 'bluetoothMac'
collect['bluetooth_mac'] = bluetooth_mac


result = pii_controller.get_network_pii_sm_devices_for_key(collect)

Method: 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,
                                 options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
username Optional The username of a Systems Manager user
email 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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

username = 'username'
collect['username'] = username

email = 'email'
collect['email'] = email

mac = 'mac'
collect['mac'] = mac

serial = 'serial'
collect['serial'] = serial

imei = 'imei'
collect['imei'] = imei

bluetooth_mac = 'bluetoothMac'
collect['bluetooth_mac'] = bluetooth_mac


result = pii_controller.get_network_pii_pii_keys(collect)

Method: delete_network_pii_request

Delete a restrict processing PII request

ALTERNATE PATH

/organizations/{organizationId}/pii/requests/{requestId}

def delete_network_pii_request(self,
                                   options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
requestId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

request_id = 'requestId'
collect['request_id'] = request_id


pii_controller.delete_network_pii_request(collect)

Method: get_network_pii_request

Return a PII request

ALTERNATE PATH

/organizations/{organizationId}/pii/requests/{requestId}

def get_network_pii_request(self,
                                options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
requestId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

request_id = 'requestId'
collect['request_id'] = request_id


result = pii_controller.get_network_pii_request(collect)

Method: 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,
                                   options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkPiiRequest Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

create_network_pii_request = CreateNetworkPiiRequestModel()
collect['create_network_pii_request'] = create_network_pii_request


result = pii_controller.create_network_pii_request(collect)

Method: 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)

Back to List of Controllers

Class: 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

Method: 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)

Back to List of Controllers

Class: 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

Method: update_network_device_management_interface_settings

Update the management interface settings for a device

def update_network_device_management_interface_settings(self,
                                                            options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

update_network_device_management_interface_settings = UpdateNetworkDeviceManagementInterfaceSettingsModel()
collect['update_network_device_management_interface_settings'] = update_network_device_management_interface_settings


result = management_interface_settings_controller.update_network_device_management_interface_settings(collect)

Method: get_network_device_management_interface_settings

Return the management interface settings for a device

def get_network_device_management_interface_settings(self,
                                                         options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
serial Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial


result = management_interface_settings_controller.get_network_device_management_interface_settings(collect)

Back to List of Controllers

Class: MRL3FirewallController

Get controller instance

An instance of the MRL3FirewallController class can be accessed from the API Client.

 mr_l3_firewall_controller = client.mr_l3_firewall

Method: update_network_ssid_l3_firewall_rules

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

def update_network_ssid_l3_firewall_rules(self,
                                              options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

number = 'number'
collect['number'] = number

update_network_ssid_l3_firewall_rules = UpdateNetworkSsidL3FirewallRulesModel()
collect['update_network_ssid_l3_firewall_rules'] = update_network_ssid_l3_firewall_rules


result = mr_l3_firewall_controller.update_network_ssid_l3_firewall_rules(collect)

Method: get_network_ssid_l3_firewall_rules

Return the L3 firewall rules for an SSID on an MR network

def get_network_ssid_l3_firewall_rules(self,
                                           options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
number Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

number = 'number'
collect['number'] = number


result = mr_l3_firewall_controller.get_network_ssid_l3_firewall_rules(collect)

Back to List of Controllers

Class: MXL7FirewallController

Get controller instance

An instance of the MXL7FirewallController class can be accessed from the API Client.

 mx_l7_firewall_controller = client.mx_l7_firewall

Method: update_network_l7_firewall_rules

Update the MX L7 firewall rules for an MX network

def update_network_l7_firewall_rules(self,
                                         options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkL7FirewallRules Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_l7_firewall_rules = UpdateNetworkL7FirewallRulesModel()
collect['update_network_l7_firewall_rules'] = update_network_l7_firewall_rules


result = mx_l7_firewall_controller.update_network_l7_firewall_rules(collect)

Method: get_network_l7_firewall_rules

List the MX L7 firewall rules for an MX network

def get_network_l7_firewall_rules(self,
                                      network_id)

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description

Example Usage

network_id = 'networkId'

result = mx_l7_firewall_controller.get_network_l7_firewall_rules(network_id)

Back to List of Controllers

Class: GroupPoliciesController

Get controller instance

An instance of the GroupPoliciesController class can be accessed from the API Client.

 group_policies_controller = client.group_policies

Method: update_network_group_policy

Update a group policy

def update_network_group_policy(self,
                                    options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

group_policy_id = 'groupPolicyId'
collect['group_policy_id'] = group_policy_id

update_network_group_policy = UpdateNetworkGroupPolicyModel()
collect['update_network_group_policy'] = update_network_group_policy


result = group_policies_controller.update_network_group_policy(collect)

Method: delete_network_group_policy

Delete a group policy

def delete_network_group_policy(self,
                                    options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
groupPolicyId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

group_policy_id = 'groupPolicyId'
collect['group_policy_id'] = group_policy_id


group_policies_controller.delete_network_group_policy(collect)

Method: get_network_group_policy

Display a group policy

def get_network_group_policy(self,
                                 options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
groupPolicyId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

group_policy_id = 'groupPolicyId'
collect['group_policy_id'] = group_policy_id


result = group_policies_controller.get_network_group_policy(collect)

Method: create_network_group_policy

Create a group policy

def create_network_group_policy(self,
                                    options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkGroupPolicy Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

create_network_group_policy = CreateNetworkGroupPolicyModel()
collect['create_network_group_policy'] = create_network_group_policy


result = group_policies_controller.create_network_group_policy(collect)

Method: 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)

Back to List of Controllers

Class: NetworksController

Get controller instance

An instance of the NetworksController class can be accessed from the API Client.

 networks_controller = client.networks

Method: 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)

Method: create_organization_network

Create a network

def create_organization_network(self,
                                    options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
createOrganizationNetwork Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

create_organization_network = CreateOrganizationNetworkModel()
collect['create_organization_network'] = create_organization_network


result = networks_controller.create_organization_network(collect)

Method: get_organization_networks

List the networks in an organization

def get_organization_networks(self,
                                  options=dict())

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

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

config_template_id = 'configTemplateId'
collect['config_template_id'] = config_template_id


result = networks_controller.get_organization_networks(collect)

Method: update_network_bluetooth_settings

Update the Bluetooth settings for a network. See the docs page for Bluetooth settings.

def update_network_bluetooth_settings(self,
                                          options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkBluetoothSettings Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_bluetooth_settings = UpdateNetworkBluetoothSettingsModel()
collect['update_network_bluetooth_settings'] = update_network_bluetooth_settings


result = networks_controller.update_network_bluetooth_settings(collect)

Method: 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)

Method: 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)

Method: update_network

Update a network

def update_network(self,
                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetwork Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network = UpdateNetworkModel()
collect['update_network'] = update_network


result = networks_controller.update_network(collect)

Method: 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,
                                        options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkSiteToSiteVpn Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_site_to_site_vpn = UpdateNetworkSiteToSiteVpnModel()
collect['update_network_site_to_site_vpn'] = update_network_site_to_site_vpn


result = networks_controller.update_network_site_to_site_vpn(collect)

Method: 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)

Method: split_network

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

def split_network(self,
                      network_id)

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description

Example Usage

network_id = 'networkId'

result = networks_controller.split_network(network_id)

Method: combine_organization_networks

Combine multiple networks into a single network

def combine_organization_networks(self,
                                      options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
combineOrganizationNetworks Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

combine_organization_networks = CombineOrganizationNetworksModel()
collect['combine_organization_networks'] = combine_organization_networks


result = networks_controller.combine_organization_networks(collect)

Method: 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)

Method: unbind_network

Unbind a network from a template.

def unbind_network(self,
                       network_id)

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description

Example Usage

network_id = 'networkId'

result = networks_controller.unbind_network(network_id)

Method: bind_network

Bind a network to a template.

def bind_network(self,
                     options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
bindNetwork Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

bind_network = BindNetworkModel()
collect['bind_network'] = bind_network


result = networks_controller.bind_network(collect)

Method: get_network_air_marshal

List Air Marshal scan results from a network

def get_network_air_marshal(self,
                                options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

timespan = 15
collect['timespan'] = timespan


result = networks_controller.get_network_air_marshal(collect)

Method: get_network_traffic

The traffic analysis data for this network. Traffic Analysis with Hostname Visibility must be enabled on the network.

def get_network_traffic(self,
                            options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
timespan Required The timespan for the data. Must be an integer representing a duration in seconds between two hours and one month. (Mandatory.)
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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

timespan = 'timespan'
collect['timespan'] = timespan

device_type = 'deviceType'
collect['device_type'] = device_type


result = networks_controller.get_network_traffic(collect)

Back to List of Controllers

Class: MVSenseController

Get controller instance

An instance of the MVSenseController class can be accessed from the API Client.

 mv_sense_controller = client.mv_sense

Method: 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)

Method: get_device_camera_analytics_recent

Returns most recent record for analytics zones

def get_device_camera_analytics_recent(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_recent(serial)

Method: 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)

Method: get_device_camera_analytics_zone_history

Return historical records for analytic zones

def get_device_camera_analytics_zone_history(self,
                                                 options=dict())

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.

Example Usage

collect = {}

serial = 'serial'
collect['serial'] = serial

zone_id = 'zoneId'
collect['zone_id'] = zone_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 15
collect['timespan'] = timespan

resolution = 15
collect['resolution'] = resolution


result = mv_sense_controller.get_device_camera_analytics_zone_history(collect)

Method: get_device_camera_analytics_overview

Returns an overview of aggregate analytics data for a timespan

def get_device_camera_analytics_overview(self,
                                             options=dict())

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.

Example Usage

collect = {}

serial = 'serial'
collect['serial'] = serial

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 15
collect['timespan'] = timespan


result = mv_sense_controller.get_device_camera_analytics_overview(collect)

Back to List of Controllers

Class: VlansController

Get controller instance

An instance of the VlansController class can be accessed from the API Client.

 vlans_controller = client.vlans

Method: 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 = vlans_controller.get_network_vlans(network_id)

Method: 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 = vlans_controller.get_network_vlans_enabled_state(network_id)

Method: delete_network_vlan

Delete a VLAN from a network

def delete_network_vlan(self,
                            options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
vlanId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

vlan_id = 'vlanId'
collect['vlan_id'] = vlan_id


vlans_controller.delete_network_vlan(collect)

Method: create_network_vlan

Add a VLAN

def create_network_vlan(self,
                            options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkVlan Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

create_network_vlan = CreateNetworkVlanModel()
collect['create_network_vlan'] = create_network_vlan


result = vlans_controller.create_network_vlan(collect)

Method: update_network_vlans_enabled_state

Enable/Disable VLANs for the given network

def update_network_vlans_enabled_state(self,
                                           options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetwork_vlans_EnabledState Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_vlans_enabled_state = UpdateNetworkVlansEnabledStateModel()
collect['update_network_vlans_enabled_state'] = update_network_vlans_enabled_state


result = vlans_controller.update_network_vlans_enabled_state(collect)

Method: update_network_vlan

Update a VLAN

def update_network_vlan(self,
                            options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

vlan_id = 'vlanId'
collect['vlan_id'] = vlan_id

update_network_vlan = UpdateNetworkVlanModel()
collect['update_network_vlan'] = update_network_vlan


result = vlans_controller.update_network_vlan(collect)

Method: get_network_vlan

Return a VLAN

def get_network_vlan(self,
                         options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
vlanId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

vlan_id = 'vlanId'
collect['vlan_id'] = vlan_id


result = vlans_controller.get_network_vlan(collect)

Back to List of Controllers

Class: UplinkSettingsController

Get controller instance

An instance of the UplinkSettingsController class can be accessed from the API Client.

 uplink_settings_controller = client.uplink_settings

Method: update_network_uplink_settings

Updates the uplink settings for your MX network.

def update_network_uplink_settings(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkUplinkSettings Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_uplink_settings = UpdateNetworkUplinkSettingsModel()
collect['update_network_uplink_settings'] = update_network_uplink_settings


result = uplink_settings_controller.update_network_uplink_settings(collect)

Method: 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)

Back to List of Controllers

Class: StaticRoutesController

Get controller instance

An instance of the StaticRoutesController class can be accessed from the API Client.

 static_routes_controller = client.static_routes

Method: delete_network_static_route

Delete a static route from a network

def delete_network_static_route(self,
                                    options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
srId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

sr_id = 'srId'
collect['sr_id'] = sr_id


static_routes_controller.delete_network_static_route(collect)

Method: get_network_static_route

Return a static route

def get_network_static_route(self,
                                 options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
srId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

sr_id = 'srId'
collect['sr_id'] = sr_id


result = static_routes_controller.get_network_static_route(collect)

Method: create_network_static_route

Add a static route

def create_network_static_route(self,
                                    options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkStaticRoute Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

create_network_static_route = CreateNetworkStaticRouteModel()
collect['create_network_static_route'] = create_network_static_route


result = static_routes_controller.create_network_static_route(collect)

Method: get_network_static_routes

List the static routes for this 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 = static_routes_controller.get_network_static_routes(network_id)

Method: update_network_static_route

Update a static route

def update_network_static_route(self,
                                    options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

sr_id = 'srId'
collect['sr_id'] = sr_id

update_network_static_route = UpdateNetworkStaticRouteModel()
collect['update_network_static_route'] = update_network_static_route


result = static_routes_controller.update_network_static_route(collect)

Back to List of Controllers

Class: 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

Method: update_network_port_forwarding_rules

Update the port forwarding rules for an MX network

def update_network_port_forwarding_rules(self,
                                             options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkPortForwardingRules Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_port_forwarding_rules = UpdateNetworkPortForwardingRulesModel()
collect['update_network_port_forwarding_rules'] = update_network_port_forwarding_rules


result = mx_port_forwarding_rules_controller.update_network_port_forwarding_rules(collect)

Method: 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)

Back to List of Controllers

Class: 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

Method: 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 = mx11_nat_rules_controller.get_network_one_to_one_nat_rules(network_id)

Method: 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,
                                            options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkOneToOneNatRules Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_one_to_one_nat_rules = UpdateNetworkOneToOneNatRulesModel()
collect['update_network_one_to_one_nat_rules'] = update_network_one_to_one_nat_rules


result = mx11_nat_rules_controller.update_network_one_to_one_nat_rules(collect)

Back to List of Controllers

Class: 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

Method: update_network_content_filtering

Update the content filtering settings for an MX network

def update_network_content_filtering(self,
                                         options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkContentFiltering Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_content_filtering = UpdateNetworkContentFilteringModel()
collect['update_network_content_filtering'] = update_network_content_filtering


result = content_filtering_rules_controller.update_network_content_filtering(collect)

Method: 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)

Back to List of Controllers

Class: 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

Method: 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)

Back to List of Controllers

Class: SyslogServersController

Get controller instance

An instance of the SyslogServersController class can be accessed from the API Client.

 syslog_servers_controller = client.syslog_servers

Method: update_network_syslog_servers

Update the syslog servers for a network

def update_network_syslog_servers(self,
                                      options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkSyslogServers Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_syslog_servers = UpdateNetworkSyslogServersModel()
collect['update_network_syslog_servers'] = update_network_syslog_servers


result = syslog_servers_controller.update_network_syslog_servers(collect)

Method: 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)

Back to List of Controllers

Class: SwitchStacksController

Get controller instance

An instance of the SwitchStacksController class can be accessed from the API Client.

 switch_stacks_controller = client.switch_stacks

Method: remove_network_switch_stack

Remove a switch from a stack

def remove_network_switch_stack(self,
                                    options=dict())

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

collect = {}

network_id = 'networkID'
collect['network_id'] = network_id

switch_stack_id = 'switchStackId'
collect['switch_stack_id'] = switch_stack_id

remove_network_switch_stack = RemoveNetworkSwitchStackModel()
collect['remove_network_switch_stack'] = remove_network_switch_stack


result = switch_stacks_controller.remove_network_switch_stack(collect)

Method: add_network_switch_stack

Add a switch to a stack

def add_network_switch_stack(self,
                                 options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

switch_stack_id = 'switchStackId'
collect['switch_stack_id'] = switch_stack_id

add_network_switch_stack = AddNetworkSwitchStackModel()
collect['add_network_switch_stack'] = add_network_switch_stack


result = switch_stacks_controller.add_network_switch_stack(collect)

Method: delete_network_switch_stack

Delete a stack

def delete_network_switch_stack(self,
                                    options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
switchStackId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

switch_stack_id = 'switchStackId'
collect['switch_stack_id'] = switch_stack_id


switch_stacks_controller.delete_network_switch_stack(collect)

Method: get_network_switch_stack

Show a switch stack

def get_network_switch_stack(self,
                                 options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
switchStackId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

switch_stack_id = 'switchStackId'
collect['switch_stack_id'] = switch_stack_id


result = switch_stacks_controller.get_network_switch_stack(collect)

Method: create_network_switch_stack

Create a stack

def create_network_switch_stack(self,
                                    options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkSwitchStack Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

create_network_switch_stack = CreateNetworkSwitchStackModel()
collect['create_network_switch_stack'] = create_network_switch_stack


result = switch_stacks_controller.create_network_switch_stack(collect)

Method: 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)

Back to List of Controllers

Class: SwitchProfilesController

Get controller instance

An instance of the SwitchProfilesController class can be accessed from the API Client.

 switch_profiles_controller = client.switch_profiles

Method: get_organization_config_template_switch_profiles

List the switch profiles for your switch template configuration

def get_organization_config_template_switch_profiles(self,
                                                         options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
configTemplateId Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

config_template_id = 'configTemplateId'
collect['config_template_id'] = config_template_id


result = switch_profiles_controller.get_organization_config_template_switch_profiles(collect)

Back to List of Controllers

Class: SwitchSettingsController

Get controller instance

An instance of the SwitchSettingsController class can be accessed from the API Client.

 switch_settings_controller = client.switch_settings

Method: update_network_switch_settings

Update switch network settings

def update_network_switch_settings(self,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkSwitchSettings Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_switch_settings = UpdateNetworkSwitchSettingsModel()
collect['update_network_switch_settings'] = update_network_switch_settings


result = switch_settings_controller.update_network_switch_settings(collect)

Method: 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)

Back to List of Controllers

Class: SNMPSettingsController

Get controller instance

An instance of the SNMPSettingsController class can be accessed from the API Client.

 snmp_settings_controller = client.snmp_settings

Method: update_organization_snmp

Update the SNMP settings for an organization

def update_organization_snmp(self,
                                 options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
updateOrganizationSnmp Optional TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

update_organization_snmp = UpdateOrganizationSnmpModel()
collect['update_organization_snmp'] = update_organization_snmp


result = snmp_settings_controller.update_organization_snmp(collect)

Method: 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)

Method: update_network_snmp_settings

Update the SNMP settings for a network

def update_network_snmp_settings(self,
                                     options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkSnmpSettings Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_snmp_settings = UpdateNetworkSnmpSettingsModel()
collect['update_network_snmp_settings'] = update_network_snmp_settings


result = snmp_settings_controller.update_network_snmp_settings(collect)

Method: 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)

Back to List of Controllers

Class: MalwareSettingsController

Get controller instance

An instance of the MalwareSettingsController class can be accessed from the API Client.

 malware_settings_controller = client.malware_settings

Method: update_network_security_malware_settings

Set the supported malware settings for an MX network

def update_network_security_malware_settings(self,
                                                 options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkSecurityMalwareSettings Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_security_malware_settings = UpdateNetworkSecurityMalwareSettingsModel()
collect['update_network_security_malware_settings'] = update_network_security_malware_settings


result = malware_settings_controller.update_network_security_malware_settings(collect)

Method: 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)

Back to List of Controllers

Class: IntrusionSettingsController

Get controller instance

An instance of the IntrusionSettingsController class can be accessed from the API Client.

 intrusion_settings_controller = client.intrusion_settings

Method: update_organization_security_intrusion_settings

Sets supported intrusion settings for an organization

def update_organization_security_intrusion_settings(self,
                                                        options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
updateOrganizationSecurityIntrusionSettings Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

update_organization_security_intrusion_settings = UpdateOrganizationSecurityIntrusionSettingsModel()
collect['update_organization_security_intrusion_settings'] = update_organization_security_intrusion_settings


result = intrusion_settings_controller.update_organization_security_intrusion_settings(collect)

Method: 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)

Method: update_network_security_intrusion_settings

Set the supported instrusion settings for an MX network

def update_network_security_intrusion_settings(self,
                                                   options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkSecurityIntrusionSettings Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_security_intrusion_settings = UpdateNetworkSecurityIntrusionSettingsModel()
collect['update_network_security_intrusion_settings'] = update_network_security_intrusion_settings


result = intrusion_settings_controller.update_network_security_intrusion_settings(collect)

Method: 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)

Back to List of Controllers

Class: RadioSettingsController

Get controller instance

An instance of the RadioSettingsController class can be accessed from the API Client.

 radio_settings_controller = client.radio_settings

Method: get_network_wireless_rf_profiles

List the non-basic RF profiles for this network

def get_network_wireless_rf_profiles(self,
                                         options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

include_template_profiles = False
collect['include_template_profiles'] = include_template_profiles


result = radio_settings_controller.get_network_wireless_rf_profiles(collect)

Method: update_network_device_wireless_radio_settings

Update the radio settings of a device

def update_network_device_wireless_radio_settings(self,
                                                      options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

update_network_device_wireless_radio_settings = UpdateNetworkDeviceWirelessRadioSettingsModel()
collect['update_network_device_wireless_radio_settings'] = update_network_device_wireless_radio_settings


result = radio_settings_controller.update_network_device_wireless_radio_settings(collect)

Method: get_network_device_wireless_radio_settings

Return the radio settings of a device

def get_network_device_wireless_radio_settings(self,
                                                   options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
serial Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial


result = radio_settings_controller.get_network_device_wireless_radio_settings(collect)

Back to List of Controllers

Class: ClientsController

Get controller instance

An instance of the ClientsController class can be accessed from the API Client.

 clients_controller = client.clients

Method: 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,
                                           options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 15
collect['timespan'] = timespan

resolution = 15
collect['resolution'] = resolution


result = clients_controller.get_network_client_latency_history(collect)

Method: get_network_clients

List the clients that have used this network in the timespan

def get_network_clients(self,
                            options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

timespan = 15
collect['timespan'] = timespan

per_page = 15
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = clients_controller.get_network_clients(collect)

Method: get_network_client_splash_authorization_status

Return the splash authorization for a client, for each SSID they've associated with through splash. 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,
                                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
clientId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id


result = clients_controller.get_network_client_splash_authorization_status(collect)

Method: 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,
                                  options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
clientId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id


result = clients_controller.get_network_client_policy(collect)

Method: 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,
                                         options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
clientId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id


result = clients_controller.get_network_client_usage_history(collect)

Method: provision_network_clients

Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.

def provision_network_clients(self,
                                  options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
provisionNetworkClients Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

provision_network_clients = ProvisionNetworkClientsModel()
collect['provision_network_clients'] = provision_network_clients


result = clients_controller.provision_network_clients(collect)

Method: 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,
                                  options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id

per_page = 15
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = clients_controller.get_network_client_events(collect)

Method: 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,
                                           options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id

per_page = 15
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = clients_controller.get_network_client_traffic_history(collect)

Method: 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,
                           options=dict())

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

collect = {}

serial = 'serial'
collect['serial'] = serial

t0 = 't0'
collect['t0'] = t0

timespan = 15
collect['timespan'] = timespan


result = clients_controller.get_device_clients(collect)

Method: 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,
                                                          options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id

update_network_client_splash_authorization_status = UpdateNetworkClientSplashAuthorizationStatusModel()
collect['update_network_client_splash_authorization_status'] = update_network_client_splash_authorization_status


result = clients_controller.update_network_client_splash_authorization_status(collect)

Method: 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,
                                     options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id

update_network_client_policy = UpdateNetworkClientPolicyModel()
collect['update_network_client_policy'] = update_network_client_policy


result = clients_controller.update_network_client_policy(collect)

Method: 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,
                           options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
clientId Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id


result = clients_controller.get_network_client(collect)

Back to List of Controllers

Class: APIUsageController

Get controller instance

An instance of the APIUsageController class can be accessed from the API Client.

 api_usage_controller = client.api_usage

Method: get_organization_api_requests

List the API requests made by an organization

def get_organization_api_requests(self,
                                      options=dict())

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

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 15
collect['timespan'] = timespan

per_page = 15
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before

admin_id = 'adminId'
collect['admin_id'] = admin_id

path = 'path'
collect['path'] = path

method = 'method'
collect['method'] = method

response_code = 15
collect['response_code'] = response_code


result = api_usage_controller.get_organization_api_requests(collect)

Back to List of Controllers

Class: 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

Method: update_network_netflow_settings

Update the NetFlow traffic reporting settings for a network

def update_network_netflow_settings(self,
                                        options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkNetflowSettings Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_netflow_settings = UpdateNetworkNetflowSettingsModel()
collect['update_network_netflow_settings'] = update_network_netflow_settings


result = net_flow_settings_controller.update_network_netflow_settings(collect)

Method: 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)

Back to List of Controllers

Class: 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

Method: get_network_meraki_auth_user

Return the Meraki Auth splash or RADIUS user

def get_network_meraki_auth_user(self,
                                     options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

id = 'id'
collect['id'] = id


result = meraki_auth_users_controller.get_network_meraki_auth_user(collect)

Method: 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)

Back to List of Controllers

Class: HTTPServersController

Get controller instance

An instance of the HTTPServersController class can be accessed from the API Client.

 http_servers_controller = client.http_servers

Method: get_network_http_servers_webhook_test

Return the status of a webhook test

def get_network_http_servers_webhook_test(self,
                                              options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

id = 'id'
collect['id'] = id


result = http_servers_controller.get_network_http_servers_webhook_test(collect)

Method: create_network_http_servers_webhook_test

Send a test webhook

def create_network_http_servers_webhook_test(self,
                                                 options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkHttpServersWebhookTest Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

create_network_http_servers_webhook_test = CreateNetworkHttpServersWebhookTestModel()
collect['create_network_http_servers_webhook_test'] = create_network_http_servers_webhook_test


result = http_servers_controller.create_network_http_servers_webhook_test(collect)

Method: delete_network_http_server

Delete an HTTP server

def delete_network_http_server(self,
                                   options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

id = 'id'
collect['id'] = id


http_servers_controller.delete_network_http_server(collect)

Method: update_network_http_server

Update an HTTP server

def update_network_http_server(self,
                                   options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

id = 'id'
collect['id'] = id

update_network_http_server = UpdateNetworkHttpServerModel()
collect['update_network_http_server'] = update_network_http_server


result = http_servers_controller.update_network_http_server(collect)

Method: get_network_http_server

Return an HTTP server

def get_network_http_server(self,
                                options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

id = 'id'
collect['id'] = id


result = http_servers_controller.get_network_http_server(collect)

Method: create_network_http_server

Add an HTTP server

def create_network_http_server(self,
                                   options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
createNetworkHttpServer Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

create_network_http_server = CreateNetworkHttpServerModel()
collect['create_network_http_server'] = create_network_http_server


result = http_servers_controller.create_network_http_server(collect)

Method: 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)

Back to List of Controllers

Class: 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

Method: update_organization_vpn_firewall_rules

Update the firewall rules of an organization's site-to-site VPN

def update_organization_vpn_firewall_rules(self,
                                               options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
updateOrganizationVpnFirewallRules Optional TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

update_organization_vpn_firewall_rules = UpdateOrganizationVpnFirewallRulesModel()
collect['update_organization_vpn_firewall_rules'] = update_organization_vpn_firewall_rules


result = mx_vpn_firewall_controller.update_organization_vpn_firewall_rules(collect)

Method: 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)

Back to List of Controllers

Class: MXL7ApplicationCategoriesController

Get controller instance

An instance of the MXL7ApplicationCategoriesController class can be accessed from the API Client.

 mx_l7_application_categories_controller = client.mx_l7_application_categories

Method: get_network_l7_firewall_rules_application_categories

Return the L7 firewall application categories and their associated applications for an MX network

def get_network_l7_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_l7_application_categories_controller.get_network_l7_firewall_rules_application_categories(network_id)

Back to List of Controllers

Class: MXL3FirewallController

Get controller instance

An instance of the MXL3FirewallController class can be accessed from the API Client.

 mx_l3_firewall_controller = client.mx_l3_firewall

Method: update_network_l3_firewall_rules

Update the L3 firewall rules of an MX network

def update_network_l3_firewall_rules(self,
                                         options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkL3FirewallRules Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_l3_firewall_rules = UpdateNetworkL3FirewallRulesModel()
collect['update_network_l3_firewall_rules'] = update_network_l3_firewall_rules


result = mx_l3_firewall_controller.update_network_l3_firewall_rules(collect)

Method: get_network_l3_firewall_rules

Return the L3 firewall rules for an MX network

def get_network_l3_firewall_rules(self,
                                      network_id)

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description

Example Usage

network_id = 'networkId'

result = mx_l3_firewall_controller.get_network_l3_firewall_rules(network_id)

Back to List of Controllers

Class: 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

Method: update_network_cellular_firewall_rules

Update the cellular firewall rules of an MX network

def update_network_cellular_firewall_rules(self,
                                               options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
updateNetworkCellularFirewallRules Optional TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

update_network_cellular_firewall_rules = UpdateNetworkCellularFirewallRulesModel()
collect['update_network_cellular_firewall_rules'] = update_network_cellular_firewall_rules


result = mx_cellular_firewall_controller.update_network_cellular_firewall_rules(collect)

Method: 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)

Back to List of Controllers

Class: DevicesController

Get controller instance

An instance of the DevicesController class can be accessed from the API Client.

 devices_controller = client.devices

Method: blink_network_device_leds

Blink the LEDs on a device

def blink_network_device_leds(self,
                                  options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

blink_network_device_leds = BlinkNetworkDeviceLedsModel()
collect['blink_network_device_leds'] = blink_network_device_leds


result = devices_controller.blink_network_device_leds(collect)

Method: reboot_network_device

Reboot a device

def reboot_network_device(self,
                              options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
serial Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial


result = devices_controller.reboot_network_device(collect)

Method: remove_network_device

Remove a single device

def remove_network_device(self,
                              options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
serial Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial


result = devices_controller.remove_network_device(collect)

Method: claim_network_devices

Claim a device into a network

def claim_network_devices(self,
                              options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
claimNetworkDevices Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

claim_network_devices = ClaimNetworkDevicesModel()
collect['claim_network_devices'] = claim_network_devices


result = devices_controller.claim_network_devices(collect)

Method: get_network_device_uplink

Return the uplink information for a device.

def get_network_device_uplink(self,
                                  options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
serial Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial


result = devices_controller.get_network_device_uplink(collect)

Method: 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,
                                       options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
serial Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial


result = devices_controller.get_network_device_performance(collect)

Method: get_network_device

Return a single device

def get_network_device(self,
                           options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
serial Required TODO: Add a parameter description

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial


result = devices_controller.get_network_device(collect)

Method: 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)

Method: update_network_device

Update the attributes of a device

def update_network_device(self,
                              options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

update_network_device = UpdateNetworkDeviceModel()
collect['update_network_device'] = update_network_device


result = devices_controller.update_network_device(collect)

Method: get_organization_devices

List the devices in an organization

def get_organization_devices(self,
                                 options=dict())

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

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

per_page = 107
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = devices_controller.get_organization_devices(collect)

Method: get_network_device_lldp_cdp

List LLDP and CDP information for a device

def get_network_device_lldp_cdp(self,
                                    options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

timespan = 'timespan'
collect['timespan'] = timespan


result = devices_controller.get_network_device_lldp_cdp(collect)

Method: 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,
                                                    options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

ip = 'ip'
collect['ip'] = ip

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 107
collect['timespan'] = timespan

resolution = 107
collect['resolution'] = resolution

uplink = 'uplink'
collect['uplink'] = uplink


result = devices_controller.get_network_device_loss_and_latency_history(collect)

Back to List of Controllers

Class: ConfigTemplatesController

Get controller instance

An instance of the ConfigTemplatesController class can be accessed from the API Client.

 config_templates_controller = client.config_templates

Method: delete_organization_config_template

Remove a configuration template

def delete_organization_config_template(self,
                                            options=dict())

Parameters

Parameter Tags Description
organizationId Required TODO: Add a parameter description
id Required TODO: Add a parameter description

Example Usage

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

id = 'id'
collect['id'] = id


config_templates_controller.delete_organization_config_template(collect)

Method: 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)

Back to List of Controllers

Class: CamerasController

Get controller instance

An instance of the CamerasController class can be accessed from the API Client.

 cameras_controller = client.cameras

Method: generate_network_camera_snapshot

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

def generate_network_camera_snapshot(self,
                                         options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

generate_network_camera_snapshot = GenerateNetworkCameraSnapshotModel()
collect['generate_network_camera_snapshot'] = generate_network_camera_snapshot


result = cameras_controller.generate_network_camera_snapshot(collect)

Method: get_network_camera_video_link

Returns video link for the specified camera. If a timestamp supplied, it links to that time.

def get_network_camera_video_link(self,
                                      options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
serial Required TODO: Add a parameter description
timestamp Optional The video link will start at this timestamp. The timestamp is in UNIX Epoch time (milliseconds).

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

serial = 'serial'
collect['serial'] = serial

timestamp = 'timestamp'
collect['timestamp'] = timestamp


result = cameras_controller.get_network_camera_video_link(collect)

Back to List of Controllers

Class: BluetoothClientsController

Get controller instance

An instance of the BluetoothClientsController class can be accessed from the API Client.

 bluetooth_clients_controller = client.bluetooth_clients

Method: get_network_bluetooth_clients

List the Bluetooth clients seen by APs in this network

def get_network_bluetooth_clients(self,
                                      options=dict())

Parameters

Parameter Tags Description
networkId Required TODO: Add a parameter description
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.
timespan Optional The timespan, in seconds, used to look back from now for bluetooth clients
includeConnectivityHistory Optional Include the connectivity history for this client

Example Usage

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

per_page = 107
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before

timespan = 'timespan'
collect['timespan'] = timespan

include_connectivity_history = 'includeConnectivityHistory'
collect['include_connectivity_history'] = include_connectivity_history


result = bluetooth_clients_controller.get_network_bluetooth_clients(collect)

Method: 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,
                                     options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

bluetooth_client_id = 'bluetoothClientId'
collect['bluetooth_client_id'] = bluetooth_client_id

include_connectivity_history = 'includeConnectivityHistory'
collect['include_connectivity_history'] = include_connectivity_history

connectivity_history_timespan = 'connectivityHistoryTimespan'
collect['connectivity_history_timespan'] = connectivity_history_timespan


result = bluetooth_clients_controller.get_network_bluetooth_client(collect)

Back to List of Controllers

Class: SecurityEventsController

Get controller instance

An instance of the SecurityEventsController class can be accessed from the API Client.

 security_events_controller = client.security_events

Method: get_organization_security_events

List the security events for an organization

def get_organization_security_events(self,
                                         options=dict())

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

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 107
collect['timespan'] = timespan

per_page = 107
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = security_events_controller.get_organization_security_events(collect)

Method: get_network_security_events

List the security events for a network

def get_network_security_events(self,
                                    options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 107
collect['timespan'] = timespan

per_page = 107
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = security_events_controller.get_network_security_events(collect)

Method: 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,
                                           options=dict())

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

collect = {}

network_id = 'networkId'
collect['network_id'] = network_id

client_id = 'clientId'
collect['client_id'] = client_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 107
collect['timespan'] = timespan

per_page = 107
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before


result = security_events_controller.get_network_client_security_events(collect)

Back to List of Controllers

Class: WebhookLogsController

Get controller instance

An instance of the WebhookLogsController class can be accessed from the API Client.

 webhook_logs_controller = client.webhook_logs

Method: get_organization_webhook_logs

Return the log of webhook POSTs sent

def get_organization_webhook_logs(self,
                                      options=dict())

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

collect = {}

organization_id = 'organizationId'
collect['organization_id'] = organization_id

t0 = 't0'
collect['t0'] = t0

t1 = 't1'
collect['t1'] = t1

timespan = 107
collect['timespan'] = timespan

per_page = 107
collect['per_page'] = per_page

starting_after = 'startingAfter'
collect['starting_after'] = starting_after

ending_before = 'endingBefore'
collect['ending_before'] = ending_before

url = 'url'
collect['url'] = url


result = webhook_logs_controller.get_organization_webhook_logs(collect)

Back to List of Controllers

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for merakiapi from gravatar.com merakiapi

Unverified details

These details have not been verified by PyPI
Project links
Meta

Release history Release notifications | RSS feed

1.5.0

1.4.0

1.0.2

This version

1.0.1

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meraki-sdk-1.0.1.tar.gz (174.7 kB view hashes)

Uploaded Source

Built Distribution

meraki_sdk-1.0.1-py3-none-any.whl (305.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page