Documentation

__construct()


    public
                __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null

Return values

mixed —

bindNetwork()

Operation bindNetwork


    public
                bindNetwork(string $network_id, BindNetwork $bind_network) : object

Bind a network to a template.

Parameters

$network_id : string: network_id (required)
$bind_network : BindNetwork: bind_network (required)

Tags

Return values

object —

bindNetworkAsync()

Operation bindNetworkAsync


    public
                bindNetworkAsync(string $network_id, BindNetwork $bind_network) : PromiseInterface

Bind a network to a template.

Parameters

$network_id : string: (required)
$bind_network : BindNetwork: (required)

Tags

Return values

PromiseInterface —

bindNetworkAsyncWithHttpInfo()

Operation bindNetworkAsyncWithHttpInfo


    public
                bindNetworkAsyncWithHttpInfo(string $network_id, BindNetwork $bind_network) : PromiseInterface

Bind a network to a template.

Parameters

$network_id : string: (required)
$bind_network : BindNetwork: (required)

Tags

Return values

PromiseInterface —

bindNetworkWithHttpInfo()

Operation bindNetworkWithHttpInfo


    public
                bindNetworkWithHttpInfo(string $network_id, BindNetwork $bind_network) : array<string|int, mixed>

Bind a network to a template.

Parameters

$network_id : string: (required)
$bind_network : BindNetwork: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

claimNetworkDevices()

Operation claimNetworkDevices


    public
                claimNetworkDevices(string $network_id, ClaimNetworkDevices $claim_network_devices) : void

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

Parameters

$network_id : string: network_id (required)
$claim_network_devices : ClaimNetworkDevices: claim_network_devices (required)

Tags

Return values

void —

claimNetworkDevicesAsync()

Operation claimNetworkDevicesAsync


    public
                claimNetworkDevicesAsync(string $network_id, ClaimNetworkDevices $claim_network_devices) : PromiseInterface

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

Parameters

$network_id : string: (required)
$claim_network_devices : ClaimNetworkDevices: (required)

Tags

Return values

PromiseInterface —

claimNetworkDevicesAsyncWithHttpInfo()

Operation claimNetworkDevicesAsyncWithHttpInfo


    public
                claimNetworkDevicesAsyncWithHttpInfo(string $network_id, ClaimNetworkDevices $claim_network_devices) : PromiseInterface

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

Parameters

$network_id : string: (required)
$claim_network_devices : ClaimNetworkDevices: (required)

Tags

Return values

PromiseInterface —

claimNetworkDevicesWithHttpInfo()

Operation claimNetworkDevicesWithHttpInfo


    public
                claimNetworkDevicesWithHttpInfo(string $network_id, ClaimNetworkDevices $claim_network_devices) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)
$claim_network_devices : ClaimNetworkDevices: (required)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

combineOrganizationNetworks()

Operation combineOrganizationNetworks


    public
                combineOrganizationNetworks(string $organization_id, CombineOrganizationNetworks $combine_organization_networks) : object

Combine multiple networks into a single network

Parameters

$organization_id : string: organization_id (required)
$combine_organization_networks : CombineOrganizationNetworks: combine_organization_networks (required)

Tags

Return values

object —

combineOrganizationNetworksAsync()

Operation combineOrganizationNetworksAsync


    public
                combineOrganizationNetworksAsync(string $organization_id, CombineOrganizationNetworks $combine_organization_networks) : PromiseInterface

Combine multiple networks into a single network

Parameters

$organization_id : string: (required)
$combine_organization_networks : CombineOrganizationNetworks: (required)

Tags

Return values

PromiseInterface —

combineOrganizationNetworksAsyncWithHttpInfo()

Operation combineOrganizationNetworksAsyncWithHttpInfo


    public
                combineOrganizationNetworksAsyncWithHttpInfo(string $organization_id, CombineOrganizationNetworks $combine_organization_networks) : PromiseInterface

Combine multiple networks into a single network

Parameters

$organization_id : string: (required)
$combine_organization_networks : CombineOrganizationNetworks: (required)

Tags

Return values

PromiseInterface —

combineOrganizationNetworksWithHttpInfo()

Operation combineOrganizationNetworksWithHttpInfo


    public
                combineOrganizationNetworksWithHttpInfo(string $organization_id, CombineOrganizationNetworks $combine_organization_networks) : array<string|int, mixed>

Combine multiple networks into a single network

Parameters

$organization_id : string: (required)
$combine_organization_networks : CombineOrganizationNetworks: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createNetworkFirmwareUpgradesRollback()

Operation createNetworkFirmwareUpgradesRollback


    public
                createNetworkFirmwareUpgradesRollback(string $network_id, CreateNetworkFirmwareUpgradesRollback $create_network_firmware_upgrades_rollback) : object

Rollback a Firmware Upgrade For A Network

Parameters

$network_id : string: network_id (required)
$create_network_firmware_upgrades_rollback : CreateNetworkFirmwareUpgradesRollback: create_network_firmware_upgrades_rollback (required)

Tags

Return values

object —

createNetworkFirmwareUpgradesRollbackAsync()

Operation createNetworkFirmwareUpgradesRollbackAsync


    public
                createNetworkFirmwareUpgradesRollbackAsync(string $network_id, CreateNetworkFirmwareUpgradesRollback $create_network_firmware_upgrades_rollback) : PromiseInterface

Rollback a Firmware Upgrade For A Network

Parameters

$network_id : string: (required)
$create_network_firmware_upgrades_rollback : CreateNetworkFirmwareUpgradesRollback: (required)

Tags

Return values

PromiseInterface —

createNetworkFirmwareUpgradesRollbackAsyncWithHttpInfo()

Operation createNetworkFirmwareUpgradesRollbackAsyncWithHttpInfo


    public
                createNetworkFirmwareUpgradesRollbackAsyncWithHttpInfo(string $network_id, CreateNetworkFirmwareUpgradesRollback $create_network_firmware_upgrades_rollback) : PromiseInterface

Rollback a Firmware Upgrade For A Network

Parameters

$network_id : string: (required)
$create_network_firmware_upgrades_rollback : CreateNetworkFirmwareUpgradesRollback: (required)

Tags

Return values

PromiseInterface —

createNetworkFirmwareUpgradesRollbackWithHttpInfo()

Operation createNetworkFirmwareUpgradesRollbackWithHttpInfo


    public
                createNetworkFirmwareUpgradesRollbackWithHttpInfo(string $network_id, CreateNetworkFirmwareUpgradesRollback $create_network_firmware_upgrades_rollback) : array<string|int, mixed>

Rollback a Firmware Upgrade For A Network

Parameters

$network_id : string: (required)
$create_network_firmware_upgrades_rollback : CreateNetworkFirmwareUpgradesRollback: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createNetworkFloorPlan()

Operation createNetworkFloorPlan


    public
                createNetworkFloorPlan(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : object

Upload a floor plan

Parameters

$network_id : string: network_id (required)
$create_network_floor_plan : CreateNetworkFloorPlan: create_network_floor_plan (required)

Tags

Return values

object —

createNetworkFloorPlanAsync()

Operation createNetworkFloorPlanAsync


    public
                createNetworkFloorPlanAsync(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : PromiseInterface

Upload a floor plan

Parameters

$network_id : string: (required)
$create_network_floor_plan : CreateNetworkFloorPlan: (required)

Tags

Return values

PromiseInterface —

createNetworkFloorPlanAsyncWithHttpInfo()

Operation createNetworkFloorPlanAsyncWithHttpInfo


    public
                createNetworkFloorPlanAsyncWithHttpInfo(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : PromiseInterface

Upload a floor plan

Parameters

$network_id : string: (required)
$create_network_floor_plan : CreateNetworkFloorPlan: (required)

Tags

Return values

PromiseInterface —

createNetworkFloorPlanWithHttpInfo()

Operation createNetworkFloorPlanWithHttpInfo


    public
                createNetworkFloorPlanWithHttpInfo(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : array<string|int, mixed>

Upload a floor plan

Parameters

$network_id : string: (required)
$create_network_floor_plan : CreateNetworkFloorPlan: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createNetworkGroupPolicy()

Operation createNetworkGroupPolicy


    public
                createNetworkGroupPolicy(string $network_id, CreateNetworkGroupPolicy $create_network_group_policy) : object

Create a group policy

Parameters

$network_id : string: network_id (required)
$create_network_group_policy : CreateNetworkGroupPolicy: create_network_group_policy (required)

Tags

Return values

object —

createNetworkGroupPolicyAsync()

Operation createNetworkGroupPolicyAsync


    public
                createNetworkGroupPolicyAsync(string $network_id, CreateNetworkGroupPolicy $create_network_group_policy) : PromiseInterface

Create a group policy

Parameters

$network_id : string: (required)
$create_network_group_policy : CreateNetworkGroupPolicy: (required)

Tags

Return values

PromiseInterface —

createNetworkGroupPolicyAsyncWithHttpInfo()

Operation createNetworkGroupPolicyAsyncWithHttpInfo


    public
                createNetworkGroupPolicyAsyncWithHttpInfo(string $network_id, CreateNetworkGroupPolicy $create_network_group_policy) : PromiseInterface

Create a group policy

Parameters

$network_id : string: (required)
$create_network_group_policy : CreateNetworkGroupPolicy: (required)

Tags

Return values

PromiseInterface —

createNetworkGroupPolicyWithHttpInfo()

Operation createNetworkGroupPolicyWithHttpInfo


    public
                createNetworkGroupPolicyWithHttpInfo(string $network_id, CreateNetworkGroupPolicy $create_network_group_policy) : array<string|int, mixed>

Create a group policy

Parameters

$network_id : string: (required)
$create_network_group_policy : CreateNetworkGroupPolicy: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createNetworkMerakiAuthUser()

Operation createNetworkMerakiAuthUser


    public
                createNetworkMerakiAuthUser(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : object

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

Parameters

$network_id : string: network_id (required)
$create_network_meraki_auth_user : CreateNetworkMerakiAuthUser: create_network_meraki_auth_user (required)

Tags

Return values

object —

createNetworkMerakiAuthUserAsync()

Operation createNetworkMerakiAuthUserAsync


    public
                createNetworkMerakiAuthUserAsync(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : PromiseInterface

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

Parameters

$network_id : string: (required)
$create_network_meraki_auth_user : CreateNetworkMerakiAuthUser: (required)

Tags

Return values

PromiseInterface —

createNetworkMerakiAuthUserAsyncWithHttpInfo()

Operation createNetworkMerakiAuthUserAsyncWithHttpInfo


    public
                createNetworkMerakiAuthUserAsyncWithHttpInfo(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : PromiseInterface

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

Parameters

$network_id : string: (required)
$create_network_meraki_auth_user : CreateNetworkMerakiAuthUser: (required)

Tags

Return values

PromiseInterface —

createNetworkMerakiAuthUserWithHttpInfo()

Operation createNetworkMerakiAuthUserWithHttpInfo


    public
                createNetworkMerakiAuthUserWithHttpInfo(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)
$create_network_meraki_auth_user : CreateNetworkMerakiAuthUser: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createNetworkMqttBroker()

Operation createNetworkMqttBroker


    public
                createNetworkMqttBroker(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : object

Add an MQTT broker

Parameters

$network_id : string: network_id (required)
$create_network_mqtt_broker : CreateNetworkMqttBroker: create_network_mqtt_broker (required)

Tags

Return values

object —

createNetworkMqttBrokerAsync()

Operation createNetworkMqttBrokerAsync


    public
                createNetworkMqttBrokerAsync(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : PromiseInterface

Add an MQTT broker

Parameters

$network_id : string: (required)
$create_network_mqtt_broker : CreateNetworkMqttBroker: (required)

Tags

Return values

PromiseInterface —

createNetworkMqttBrokerAsyncWithHttpInfo()

Operation createNetworkMqttBrokerAsyncWithHttpInfo


    public
                createNetworkMqttBrokerAsyncWithHttpInfo(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : PromiseInterface

Add an MQTT broker

Parameters

$network_id : string: (required)
$create_network_mqtt_broker : CreateNetworkMqttBroker: (required)

Tags

Return values

PromiseInterface —

createNetworkMqttBrokerWithHttpInfo()

Operation createNetworkMqttBrokerWithHttpInfo


    public
                createNetworkMqttBrokerWithHttpInfo(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : array<string|int, mixed>

Add an MQTT broker

Parameters

$network_id : string: (required)
$create_network_mqtt_broker : CreateNetworkMqttBroker: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createNetworkPiiRequest()

Operation createNetworkPiiRequest


    public
                createNetworkPiiRequest(string $network_id[, CreateNetworkPiiRequest $create_network_pii_request = null ]) : object

Submit a new delete or restrict processing PII request

Parameters

$network_id : string: network_id (required)
$create_network_pii_request : CreateNetworkPiiRequest = null: create_network_pii_request (optional)

Tags

Return values

object —

createNetworkPiiRequestAsync()

Operation createNetworkPiiRequestAsync


    public
                createNetworkPiiRequestAsync(string $network_id[, CreateNetworkPiiRequest $create_network_pii_request = null ]) : PromiseInterface

Submit a new delete or restrict processing PII request

Parameters

$network_id : string: (required)
$create_network_pii_request : CreateNetworkPiiRequest = null: (optional)

Tags

Return values

PromiseInterface —

createNetworkPiiRequestAsyncWithHttpInfo()

Operation createNetworkPiiRequestAsyncWithHttpInfo


    public
                createNetworkPiiRequestAsyncWithHttpInfo(string $network_id[, CreateNetworkPiiRequest $create_network_pii_request = null ]) : PromiseInterface

Submit a new delete or restrict processing PII request

Parameters

$network_id : string: (required)
$create_network_pii_request : CreateNetworkPiiRequest = null: (optional)

Tags

Return values

PromiseInterface —

createNetworkPiiRequestWithHttpInfo()

Operation createNetworkPiiRequestWithHttpInfo


    public
                createNetworkPiiRequestWithHttpInfo(string $network_id[, CreateNetworkPiiRequest $create_network_pii_request = null ]) : array<string|int, mixed>

Submit a new delete or restrict processing PII request

Parameters

$network_id : string: (required)
$create_network_pii_request : CreateNetworkPiiRequest = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createNetworkWebhooksHttpServer()

Operation createNetworkWebhooksHttpServer


    public
                createNetworkWebhooksHttpServer(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : object

Add an HTTP server to a network

Parameters

$network_id : string: network_id (required)
$create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer: create_network_webhooks_http_server (required)

Tags

Return values

object —

createNetworkWebhooksHttpServerAsync()

Operation createNetworkWebhooksHttpServerAsync


    public
                createNetworkWebhooksHttpServerAsync(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : PromiseInterface

Add an HTTP server to a network

Parameters

$network_id : string: (required)
$create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer: (required)

Tags

Return values

PromiseInterface —

createNetworkWebhooksHttpServerAsyncWithHttpInfo()

Operation createNetworkWebhooksHttpServerAsyncWithHttpInfo


    public
                createNetworkWebhooksHttpServerAsyncWithHttpInfo(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : PromiseInterface

Add an HTTP server to a network

Parameters

$network_id : string: (required)
$create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer: (required)

Tags

Return values

PromiseInterface —

createNetworkWebhooksHttpServerWithHttpInfo()

Operation createNetworkWebhooksHttpServerWithHttpInfo


    public
                createNetworkWebhooksHttpServerWithHttpInfo(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : array<string|int, mixed>

Add an HTTP server to a network

Parameters

$network_id : string: (required)
$create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createNetworkWebhooksWebhookTest()

Operation createNetworkWebhooksWebhookTest


    public
                createNetworkWebhooksWebhookTest(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : object

Send a test webhook for a network

Parameters

$network_id : string: network_id (required)
$create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest: create_network_webhooks_webhook_test (required)

Tags

Return values

object —

createNetworkWebhooksWebhookTestAsync()

Operation createNetworkWebhooksWebhookTestAsync


    public
                createNetworkWebhooksWebhookTestAsync(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : PromiseInterface

Send a test webhook for a network

Parameters

$network_id : string: (required)
$create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest: (required)

Tags

Return values

PromiseInterface —

createNetworkWebhooksWebhookTestAsyncWithHttpInfo()

Operation createNetworkWebhooksWebhookTestAsyncWithHttpInfo


    public
                createNetworkWebhooksWebhookTestAsyncWithHttpInfo(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : PromiseInterface

Send a test webhook for a network

Parameters

$network_id : string: (required)
$create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest: (required)

Tags

Return values

PromiseInterface —

createNetworkWebhooksWebhookTestWithHttpInfo()

Operation createNetworkWebhooksWebhookTestWithHttpInfo


    public
                createNetworkWebhooksWebhookTestWithHttpInfo(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : array<string|int, mixed>

Send a test webhook for a network

Parameters

$network_id : string: (required)
$create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createOrganizationNetwork()

Operation createOrganizationNetwork


    public
                createOrganizationNetwork(string $organization_id, CreateOrganizationNetwork $create_organization_network) : object

Create a network

Parameters

$organization_id : string: organization_id (required)
$create_organization_network : CreateOrganizationNetwork: create_organization_network (required)

Tags

Return values

object —

createOrganizationNetworkAsync()

Operation createOrganizationNetworkAsync


    public
                createOrganizationNetworkAsync(string $organization_id, CreateOrganizationNetwork $create_organization_network) : PromiseInterface

Create a network

Parameters

$organization_id : string: (required)
$create_organization_network : CreateOrganizationNetwork: (required)

Tags

Return values

PromiseInterface —

createOrganizationNetworkAsyncWithHttpInfo()

Operation createOrganizationNetworkAsyncWithHttpInfo


    public
                createOrganizationNetworkAsyncWithHttpInfo(string $organization_id, CreateOrganizationNetwork $create_organization_network) : PromiseInterface

Create a network

Parameters

$organization_id : string: (required)
$create_organization_network : CreateOrganizationNetwork: (required)

Tags

Return values

PromiseInterface —

createOrganizationNetworkWithHttpInfo()

Operation createOrganizationNetworkWithHttpInfo


    public
                createOrganizationNetworkWithHttpInfo(string $organization_id, CreateOrganizationNetwork $create_organization_network) : array<string|int, mixed>

Create a network

Parameters

$organization_id : string: (required)
$create_organization_network : CreateOrganizationNetwork: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

deleteNetwork()

Operation deleteNetwork


    public
                deleteNetwork(string $network_id) : void

Delete a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

void —

deleteNetworkAsync()

Operation deleteNetworkAsync


    public
                deleteNetworkAsync(string $network_id) : PromiseInterface

Delete a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkAsyncWithHttpInfo()

Operation deleteNetworkAsyncWithHttpInfo


    public
                deleteNetworkAsyncWithHttpInfo(string $network_id) : PromiseInterface

Delete a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkFloorPlan()

Operation deleteNetworkFloorPlan


    public
                deleteNetworkFloorPlan(string $network_id, string $floor_plan_id) : void

Destroy a floor plan

Parameters

$network_id : string: network_id (required)
$floor_plan_id : string: floor_plan_id (required)

Tags

Return values

void —

deleteNetworkFloorPlanAsync()

Operation deleteNetworkFloorPlanAsync


    public
                deleteNetworkFloorPlanAsync(string $network_id, string $floor_plan_id) : PromiseInterface

Destroy a floor plan

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkFloorPlanAsyncWithHttpInfo()

Operation deleteNetworkFloorPlanAsyncWithHttpInfo


    public
                deleteNetworkFloorPlanAsyncWithHttpInfo(string $network_id, string $floor_plan_id) : PromiseInterface

Destroy a floor plan

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkFloorPlanWithHttpInfo()

Operation deleteNetworkFloorPlanWithHttpInfo


    public
                deleteNetworkFloorPlanWithHttpInfo(string $network_id, string $floor_plan_id) : array<string|int, mixed>

Destroy a floor plan

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteNetworkGroupPolicy()

Operation deleteNetworkGroupPolicy


    public
                deleteNetworkGroupPolicy(string $network_id, string $group_policy_id) : void

Delete a group policy

Parameters

$network_id : string: network_id (required)
$group_policy_id : string: group_policy_id (required)

Tags

Return values

void —

deleteNetworkGroupPolicyAsync()

Operation deleteNetworkGroupPolicyAsync


    public
                deleteNetworkGroupPolicyAsync(string $network_id, string $group_policy_id) : PromiseInterface

Delete a group policy

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkGroupPolicyAsyncWithHttpInfo()

Operation deleteNetworkGroupPolicyAsyncWithHttpInfo


    public
                deleteNetworkGroupPolicyAsyncWithHttpInfo(string $network_id, string $group_policy_id) : PromiseInterface

Delete a group policy

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkGroupPolicyWithHttpInfo()

Operation deleteNetworkGroupPolicyWithHttpInfo


    public
                deleteNetworkGroupPolicyWithHttpInfo(string $network_id, string $group_policy_id) : array<string|int, mixed>

Delete a group policy

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteNetworkMerakiAuthUser()

Operation deleteNetworkMerakiAuthUser


    public
                deleteNetworkMerakiAuthUser(string $network_id, string $meraki_auth_user_id) : void

Deauthorize a user

Parameters

$network_id : string: network_id (required)
$meraki_auth_user_id : string: meraki_auth_user_id (required)

Tags

Return values

void —

deleteNetworkMerakiAuthUserAsync()

Operation deleteNetworkMerakiAuthUserAsync


    public
                deleteNetworkMerakiAuthUserAsync(string $network_id, string $meraki_auth_user_id) : PromiseInterface

Deauthorize a user

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkMerakiAuthUserAsyncWithHttpInfo()

Operation deleteNetworkMerakiAuthUserAsyncWithHttpInfo


    public
                deleteNetworkMerakiAuthUserAsyncWithHttpInfo(string $network_id, string $meraki_auth_user_id) : PromiseInterface

Deauthorize a user

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkMerakiAuthUserWithHttpInfo()

Operation deleteNetworkMerakiAuthUserWithHttpInfo


    public
                deleteNetworkMerakiAuthUserWithHttpInfo(string $network_id, string $meraki_auth_user_id) : array<string|int, mixed>

Deauthorize a user

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteNetworkMqttBroker()

Operation deleteNetworkMqttBroker


    public
                deleteNetworkMqttBroker(string $network_id, string $mqtt_broker_id) : void

Delete an MQTT broker

Parameters

$network_id : string: network_id (required)
$mqtt_broker_id : string: mqtt_broker_id (required)

Tags

Return values

void —

deleteNetworkMqttBrokerAsync()

Operation deleteNetworkMqttBrokerAsync


    public
                deleteNetworkMqttBrokerAsync(string $network_id, string $mqtt_broker_id) : PromiseInterface

Delete an MQTT broker

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkMqttBrokerAsyncWithHttpInfo()

Operation deleteNetworkMqttBrokerAsyncWithHttpInfo


    public
                deleteNetworkMqttBrokerAsyncWithHttpInfo(string $network_id, string $mqtt_broker_id) : PromiseInterface

Delete an MQTT broker

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkMqttBrokerWithHttpInfo()

Operation deleteNetworkMqttBrokerWithHttpInfo


    public
                deleteNetworkMqttBrokerWithHttpInfo(string $network_id, string $mqtt_broker_id) : array<string|int, mixed>

Delete an MQTT broker

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteNetworkPiiRequest()

Operation deleteNetworkPiiRequest


    public
                deleteNetworkPiiRequest(string $network_id, string $request_id) : void

Delete a restrict processing PII request

Parameters

$network_id : string: network_id (required)
$request_id : string: request_id (required)

Tags

Return values

void —

deleteNetworkPiiRequestAsync()

Operation deleteNetworkPiiRequestAsync


    public
                deleteNetworkPiiRequestAsync(string $network_id, string $request_id) : PromiseInterface

Delete a restrict processing PII request

Parameters

$network_id : string: (required)
$request_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkPiiRequestAsyncWithHttpInfo()

Operation deleteNetworkPiiRequestAsyncWithHttpInfo


    public
                deleteNetworkPiiRequestAsyncWithHttpInfo(string $network_id, string $request_id) : PromiseInterface

Delete a restrict processing PII request

Parameters

$network_id : string: (required)
$request_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkPiiRequestWithHttpInfo()

Operation deleteNetworkPiiRequestWithHttpInfo


    public
                deleteNetworkPiiRequestWithHttpInfo(string $network_id, string $request_id) : array<string|int, mixed>

Delete a restrict processing PII request

Parameters

$network_id : string: (required)
$request_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteNetworkWebhooksHttpServer()

Operation deleteNetworkWebhooksHttpServer


    public
                deleteNetworkWebhooksHttpServer(string $network_id, string $http_server_id) : void

Delete an HTTP server from a network

Parameters

$network_id : string: network_id (required)
$http_server_id : string: http_server_id (required)

Tags

Return values

void —

deleteNetworkWebhooksHttpServerAsync()

Operation deleteNetworkWebhooksHttpServerAsync


    public
                deleteNetworkWebhooksHttpServerAsync(string $network_id, string $http_server_id) : PromiseInterface

Delete an HTTP server from a network

Parameters

$network_id : string: (required)
$http_server_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkWebhooksHttpServerAsyncWithHttpInfo()

Operation deleteNetworkWebhooksHttpServerAsyncWithHttpInfo


    public
                deleteNetworkWebhooksHttpServerAsyncWithHttpInfo(string $network_id, string $http_server_id) : PromiseInterface

Delete an HTTP server from a network

Parameters

$network_id : string: (required)
$http_server_id : string: (required)

Tags

Return values

PromiseInterface —

deleteNetworkWebhooksHttpServerWithHttpInfo()

Operation deleteNetworkWebhooksHttpServerWithHttpInfo


    public
                deleteNetworkWebhooksHttpServerWithHttpInfo(string $network_id, string $http_server_id) : array<string|int, mixed>

Delete an HTTP server from a network

Parameters

$network_id : string: (required)
$http_server_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteNetworkWithHttpInfo()

Operation deleteNetworkWithHttpInfo


    public
                deleteNetworkWithHttpInfo(string $network_id) : array<string|int, mixed>

Delete a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getNetwork()

Operation getNetwork


    public
                getNetwork(string $network_id) : object

Return a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkAlertsSettings()

Operation getNetworkAlertsSettings


    public
                getNetworkAlertsSettings(string $network_id) : object

Return the alert configuration for this network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkAlertsSettingsAsync()

Operation getNetworkAlertsSettingsAsync


    public
                getNetworkAlertsSettingsAsync(string $network_id) : PromiseInterface

Return the alert configuration for this network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkAlertsSettingsAsyncWithHttpInfo()

Operation getNetworkAlertsSettingsAsyncWithHttpInfo


    public
                getNetworkAlertsSettingsAsyncWithHttpInfo(string $network_id) : PromiseInterface

Return the alert configuration for this network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkAlertsSettingsWithHttpInfo()

Operation getNetworkAlertsSettingsWithHttpInfo


    public
                getNetworkAlertsSettingsWithHttpInfo(string $network_id) : array<string|int, mixed>

Return the alert configuration for this network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkAsync()

Operation getNetworkAsync


    public
                getNetworkAsync(string $network_id) : PromiseInterface

Return a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkAsyncWithHttpInfo()

Operation getNetworkAsyncWithHttpInfo


    public
                getNetworkAsyncWithHttpInfo(string $network_id) : PromiseInterface

Return a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkBluetoothClient()

Operation getNetworkBluetoothClient


    public
                getNetworkBluetoothClient(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : object

Return a Bluetooth client

Parameters

$network_id : string: network_id (required)
$bluetooth_client_id : string: bluetooth_client_id (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

object —

getNetworkBluetoothClientAsync()

Operation getNetworkBluetoothClientAsync


    public
                getNetworkBluetoothClientAsync(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : PromiseInterface

Return a Bluetooth client

Parameters

$network_id : string: (required)
$bluetooth_client_id : string: (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

PromiseInterface —

getNetworkBluetoothClientAsyncWithHttpInfo()

Operation getNetworkBluetoothClientAsyncWithHttpInfo


    public
                getNetworkBluetoothClientAsyncWithHttpInfo(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : PromiseInterface

Return a Bluetooth client

Parameters

$network_id : string: (required)
$bluetooth_client_id : string: (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

PromiseInterface —

getNetworkBluetoothClients()

Operation getNetworkBluetoothClients


    public
                getNetworkBluetoothClients(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : object

List the Bluetooth clients seen by APs in this network

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

object —

getNetworkBluetoothClientsAsync()

Operation getNetworkBluetoothClientsAsync


    public
                getNetworkBluetoothClientsAsync(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : PromiseInterface

List the Bluetooth clients seen by APs in this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

PromiseInterface —

getNetworkBluetoothClientsAsyncWithHttpInfo()

Operation getNetworkBluetoothClientsAsyncWithHttpInfo


    public
                getNetworkBluetoothClientsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : PromiseInterface

List the Bluetooth clients seen by APs in this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

PromiseInterface —

getNetworkBluetoothClientsWithHttpInfo()

Operation getNetworkBluetoothClientsWithHttpInfo


    public
                getNetworkBluetoothClientsWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : array<string|int, mixed>

List the Bluetooth clients seen by APs in this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkBluetoothClientWithHttpInfo()

Operation getNetworkBluetoothClientWithHttpInfo


    public
                getNetworkBluetoothClientWithHttpInfo(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : array<string|int, mixed>

Return a Bluetooth client

Parameters

$network_id : string: (required)
$bluetooth_client_id : string: (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClient()

Operation getNetworkClient


    public
                getNetworkClient(string $network_id, string $client_id) : object

Return the client associated with the given identifier

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)

Tags

Return values

object —

getNetworkClientAsync()

Operation getNetworkClientAsync


    public
                getNetworkClientAsync(string $network_id, string $client_id) : PromiseInterface

Return the client associated with the given identifier

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientAsyncWithHttpInfo()

Operation getNetworkClientAsyncWithHttpInfo


    public
                getNetworkClientAsyncWithHttpInfo(string $network_id, string $client_id) : PromiseInterface

Return the client associated with the given identifier

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientPolicy()

Operation getNetworkClientPolicy


    public
                getNetworkClientPolicy(string $network_id, string $client_id) : object

Return the policy assigned to a client on the network

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)

Tags

Return values

object —

getNetworkClientPolicyAsync()

Operation getNetworkClientPolicyAsync


    public
                getNetworkClientPolicyAsync(string $network_id, string $client_id) : PromiseInterface

Return the policy assigned to a client on the network

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientPolicyAsyncWithHttpInfo()

Operation getNetworkClientPolicyAsyncWithHttpInfo


    public
                getNetworkClientPolicyAsyncWithHttpInfo(string $network_id, string $client_id) : PromiseInterface

Return the policy assigned to a client on the network

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientPolicyWithHttpInfo()

Operation getNetworkClientPolicyWithHttpInfo


    public
                getNetworkClientPolicyWithHttpInfo(string $network_id, string $client_id) : array<string|int, mixed>

Return the policy assigned to a client on the network

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClients()

Operation getNetworkClients


    public
                getNetworkClients(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : object

List the clients that have used this network in the timespan

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

object —

getNetworkClientsApplicationUsage()

Operation getNetworkClientsApplicationUsage


    public
                getNetworkClientsApplicationUsage(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : object

Return the application usage data for clients

Parameters

$network_id : string: network_id (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

object —

getNetworkClientsApplicationUsageAsync()

Operation getNetworkClientsApplicationUsageAsync


    public
                getNetworkClientsApplicationUsageAsync(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return the application usage data for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsApplicationUsageAsyncWithHttpInfo()

Operation getNetworkClientsApplicationUsageAsyncWithHttpInfo


    public
                getNetworkClientsApplicationUsageAsyncWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return the application usage data for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsApplicationUsageWithHttpInfo()

Operation getNetworkClientsApplicationUsageWithHttpInfo


    public
                getNetworkClientsApplicationUsageWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : array<string|int, mixed>

Return the application usage data for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientsAsync()

Operation getNetworkClientsAsync


    public
                getNetworkClientsAsync(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : PromiseInterface

List the clients that have used this network in the timespan

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsAsyncWithHttpInfo()

Operation getNetworkClientsAsyncWithHttpInfo


    public
                getNetworkClientsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : PromiseInterface

List the clients that have used this network in the timespan

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsOverview()

Operation getNetworkClientsOverview


    public
                getNetworkClientsOverview(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : object

Return overview statistics for network clients

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

object —

getNetworkClientsOverviewAsync()

Operation getNetworkClientsOverviewAsync


    public
                getNetworkClientsOverviewAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface

Return overview statistics for network clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsOverviewAsyncWithHttpInfo()

Operation getNetworkClientsOverviewAsyncWithHttpInfo


    public
                getNetworkClientsOverviewAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface

Return overview statistics for network clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsOverviewWithHttpInfo()

Operation getNetworkClientsOverviewWithHttpInfo


    public
                getNetworkClientsOverviewWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : array<string|int, mixed>

Return overview statistics for network clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientSplashAuthorizationStatus()

Operation getNetworkClientSplashAuthorizationStatus


    public
                getNetworkClientSplashAuthorizationStatus(string $network_id, string $client_id) : object

Return the splash authorization for a client, for each SSID they've associated with through splash

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)

Tags

Return values

object —

getNetworkClientSplashAuthorizationStatusAsync()

Operation getNetworkClientSplashAuthorizationStatusAsync


    public
                getNetworkClientSplashAuthorizationStatusAsync(string $network_id, string $client_id) : PromiseInterface

Return the splash authorization for a client, for each SSID they've associated with through splash

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientSplashAuthorizationStatusAsyncWithHttpInfo()

Operation getNetworkClientSplashAuthorizationStatusAsyncWithHttpInfo


    public
                getNetworkClientSplashAuthorizationStatusAsyncWithHttpInfo(string $network_id, string $client_id) : PromiseInterface

Return the splash authorization for a client, for each SSID they've associated with through splash

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientSplashAuthorizationStatusWithHttpInfo()

Operation getNetworkClientSplashAuthorizationStatusWithHttpInfo


    public
                getNetworkClientSplashAuthorizationStatusWithHttpInfo(string $network_id, string $client_id) : array<string|int, mixed>

Return the splash authorization for a client, for each SSID they've associated with through splash

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientsUsageHistories()

Operation getNetworkClientsUsageHistories


    public
                getNetworkClientsUsageHistories(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : object

Return the usage histories for clients

Parameters

$network_id : string: network_id (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

object —

getNetworkClientsUsageHistoriesAsync()

Operation getNetworkClientsUsageHistoriesAsync


    public
                getNetworkClientsUsageHistoriesAsync(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return the usage histories for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsUsageHistoriesAsyncWithHttpInfo()

Operation getNetworkClientsUsageHistoriesAsyncWithHttpInfo


    public
                getNetworkClientsUsageHistoriesAsyncWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return the usage histories for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsUsageHistoriesWithHttpInfo()

Operation getNetworkClientsUsageHistoriesWithHttpInfo


    public
                getNetworkClientsUsageHistoriesWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : array<string|int, mixed>

Return the usage histories for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientsWithHttpInfo()

Operation getNetworkClientsWithHttpInfo


    public
                getNetworkClientsWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : array<string|int, mixed>

List the clients that have used this network in the timespan

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientTrafficHistory()

Operation getNetworkClientTrafficHistory


    public
                getNetworkClientTrafficHistory(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Return the client's network traffic data over time

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkClientTrafficHistoryAsync()

Operation getNetworkClientTrafficHistoryAsync


    public
                getNetworkClientTrafficHistoryAsync(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return the client's network traffic data over time

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientTrafficHistoryAsyncWithHttpInfo()

Operation getNetworkClientTrafficHistoryAsyncWithHttpInfo


    public
                getNetworkClientTrafficHistoryAsyncWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return the client's network traffic data over time

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientTrafficHistoryWithHttpInfo()

Operation getNetworkClientTrafficHistoryWithHttpInfo


    public
                getNetworkClientTrafficHistoryWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Return the client's network traffic data over time

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientUsageHistory()

Operation getNetworkClientUsageHistory


    public
                getNetworkClientUsageHistory(string $network_id, string $client_id) : object

Return the client's daily usage history

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)

Tags

Return values

object —

getNetworkClientUsageHistoryAsync()

Operation getNetworkClientUsageHistoryAsync


    public
                getNetworkClientUsageHistoryAsync(string $network_id, string $client_id) : PromiseInterface

Return the client's daily usage history

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientUsageHistoryAsyncWithHttpInfo()

Operation getNetworkClientUsageHistoryAsyncWithHttpInfo


    public
                getNetworkClientUsageHistoryAsyncWithHttpInfo(string $network_id, string $client_id) : PromiseInterface

Return the client's daily usage history

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientUsageHistoryWithHttpInfo()

Operation getNetworkClientUsageHistoryWithHttpInfo


    public
                getNetworkClientUsageHistoryWithHttpInfo(string $network_id, string $client_id) : array<string|int, mixed>

Return the client's daily usage history

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientWithHttpInfo()

Operation getNetworkClientWithHttpInfo


    public
                getNetworkClientWithHttpInfo(string $network_id, string $client_id) : array<string|int, mixed>

Return the client associated with the given identifier

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkDevices()

Operation getNetworkDevices


    public
                getNetworkDevices(string $network_id) : object

List the devices in a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkDevicesAsync()

Operation getNetworkDevicesAsync


    public
                getNetworkDevicesAsync(string $network_id) : PromiseInterface

List the devices in a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkDevicesAsyncWithHttpInfo()

Operation getNetworkDevicesAsyncWithHttpInfo


    public
                getNetworkDevicesAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the devices in a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkDevicesWithHttpInfo()

Operation getNetworkDevicesWithHttpInfo


    public
                getNetworkDevicesWithHttpInfo(string $network_id) : array<string|int, mixed>

List the devices in a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkEvents()

Operation getNetworkEvents


    public
                getNetworkEvents(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

List the events for the network

Parameters

$network_id : string: network_id (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkEventsAsync()

Operation getNetworkEventsAsync


    public
                getNetworkEventsAsync(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the events for the network

Parameters

$network_id : string: (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkEventsAsyncWithHttpInfo()

Operation getNetworkEventsAsyncWithHttpInfo


    public
                getNetworkEventsAsyncWithHttpInfo(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the events for the network

Parameters

$network_id : string: (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkEventsEventTypes()

Operation getNetworkEventsEventTypes


    public
                getNetworkEventsEventTypes(string $network_id) : object

List the event type to human-readable description

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkEventsEventTypesAsync()

Operation getNetworkEventsEventTypesAsync


    public
                getNetworkEventsEventTypesAsync(string $network_id) : PromiseInterface

List the event type to human-readable description

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkEventsEventTypesAsyncWithHttpInfo()

Operation getNetworkEventsEventTypesAsyncWithHttpInfo


    public
                getNetworkEventsEventTypesAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the event type to human-readable description

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkEventsEventTypesWithHttpInfo()

Operation getNetworkEventsEventTypesWithHttpInfo


    public
                getNetworkEventsEventTypesWithHttpInfo(string $network_id) : array<string|int, mixed>

List the event type to human-readable description

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkEventsWithHttpInfo()

Operation getNetworkEventsWithHttpInfo


    public
                getNetworkEventsWithHttpInfo(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

List the events for the network

Parameters

$network_id : string: (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkFirmwareUpgrades()

Operation getNetworkFirmwareUpgrades


    public
                getNetworkFirmwareUpgrades(string $network_id) : object

Get firmware upgrade information for a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkFirmwareUpgradesAsync()

Operation getNetworkFirmwareUpgradesAsync


    public
                getNetworkFirmwareUpgradesAsync(string $network_id) : PromiseInterface

Get firmware upgrade information for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkFirmwareUpgradesAsyncWithHttpInfo()

Operation getNetworkFirmwareUpgradesAsyncWithHttpInfo


    public
                getNetworkFirmwareUpgradesAsyncWithHttpInfo(string $network_id) : PromiseInterface

Get firmware upgrade information for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkFirmwareUpgradesWithHttpInfo()

Operation getNetworkFirmwareUpgradesWithHttpInfo


    public
                getNetworkFirmwareUpgradesWithHttpInfo(string $network_id) : array<string|int, mixed>

Get firmware upgrade information for a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkFloorPlan()

Operation getNetworkFloorPlan


    public
                getNetworkFloorPlan(string $network_id, string $floor_plan_id) : object

Find a floor plan by ID

Parameters

$network_id : string: network_id (required)
$floor_plan_id : string: floor_plan_id (required)

Tags

Return values

object —

getNetworkFloorPlanAsync()

Operation getNetworkFloorPlanAsync


    public
                getNetworkFloorPlanAsync(string $network_id, string $floor_plan_id) : PromiseInterface

Find a floor plan by ID

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkFloorPlanAsyncWithHttpInfo()

Operation getNetworkFloorPlanAsyncWithHttpInfo


    public
                getNetworkFloorPlanAsyncWithHttpInfo(string $network_id, string $floor_plan_id) : PromiseInterface

Find a floor plan by ID

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkFloorPlans()

Operation getNetworkFloorPlans


    public
                getNetworkFloorPlans(string $network_id) : object

List the floor plans that belong to your network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkFloorPlansAsync()

Operation getNetworkFloorPlansAsync


    public
                getNetworkFloorPlansAsync(string $network_id) : PromiseInterface

List the floor plans that belong to your network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkFloorPlansAsyncWithHttpInfo()

Operation getNetworkFloorPlansAsyncWithHttpInfo


    public
                getNetworkFloorPlansAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the floor plans that belong to your network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkFloorPlansWithHttpInfo()

Operation getNetworkFloorPlansWithHttpInfo


    public
                getNetworkFloorPlansWithHttpInfo(string $network_id) : array<string|int, mixed>

List the floor plans that belong to your network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkFloorPlanWithHttpInfo()

Operation getNetworkFloorPlanWithHttpInfo


    public
                getNetworkFloorPlanWithHttpInfo(string $network_id, string $floor_plan_id) : array<string|int, mixed>

Find a floor plan by ID

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkGroupPolicies()

Operation getNetworkGroupPolicies


    public
                getNetworkGroupPolicies(string $network_id) : object

List the group policies in a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkGroupPoliciesAsync()

Operation getNetworkGroupPoliciesAsync


    public
                getNetworkGroupPoliciesAsync(string $network_id) : PromiseInterface

List the group policies in a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkGroupPoliciesAsyncWithHttpInfo()

Operation getNetworkGroupPoliciesAsyncWithHttpInfo


    public
                getNetworkGroupPoliciesAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the group policies in a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkGroupPoliciesWithHttpInfo()

Operation getNetworkGroupPoliciesWithHttpInfo


    public
                getNetworkGroupPoliciesWithHttpInfo(string $network_id) : array<string|int, mixed>

List the group policies in a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkGroupPolicy()

Operation getNetworkGroupPolicy


    public
                getNetworkGroupPolicy(string $network_id, string $group_policy_id) : object

Display a group policy

Parameters

$network_id : string: network_id (required)
$group_policy_id : string: group_policy_id (required)

Tags

Return values

object —

getNetworkGroupPolicyAsync()

Operation getNetworkGroupPolicyAsync


    public
                getNetworkGroupPolicyAsync(string $network_id, string $group_policy_id) : PromiseInterface

Display a group policy

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkGroupPolicyAsyncWithHttpInfo()

Operation getNetworkGroupPolicyAsyncWithHttpInfo


    public
                getNetworkGroupPolicyAsyncWithHttpInfo(string $network_id, string $group_policy_id) : PromiseInterface

Display a group policy

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkGroupPolicyWithHttpInfo()

Operation getNetworkGroupPolicyWithHttpInfo


    public
                getNetworkGroupPolicyWithHttpInfo(string $network_id, string $group_policy_id) : array<string|int, mixed>

Display a group policy

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkMerakiAuthUser()

Operation getNetworkMerakiAuthUser


    public
                getNetworkMerakiAuthUser(string $network_id, string $meraki_auth_user_id) : object

Return the Meraki Auth splash guest, RADIUS, or client VPN user

Parameters

$network_id : string: network_id (required)
$meraki_auth_user_id : string: meraki_auth_user_id (required)

Tags

Return values

object —

getNetworkMerakiAuthUserAsync()

Operation getNetworkMerakiAuthUserAsync


    public
                getNetworkMerakiAuthUserAsync(string $network_id, string $meraki_auth_user_id) : PromiseInterface

Return the Meraki Auth splash guest, RADIUS, or client VPN user

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkMerakiAuthUserAsyncWithHttpInfo()

Operation getNetworkMerakiAuthUserAsyncWithHttpInfo


    public
                getNetworkMerakiAuthUserAsyncWithHttpInfo(string $network_id, string $meraki_auth_user_id) : PromiseInterface

Return the Meraki Auth splash guest, RADIUS, or client VPN user

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkMerakiAuthUsers()

Operation getNetworkMerakiAuthUsers


    public
                getNetworkMerakiAuthUsers(string $network_id) : object

List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkMerakiAuthUsersAsync()

Operation getNetworkMerakiAuthUsersAsync


    public
                getNetworkMerakiAuthUsersAsync(string $network_id) : PromiseInterface

List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkMerakiAuthUsersAsyncWithHttpInfo()

Operation getNetworkMerakiAuthUsersAsyncWithHttpInfo


    public
                getNetworkMerakiAuthUsersAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkMerakiAuthUsersWithHttpInfo()

Operation getNetworkMerakiAuthUsersWithHttpInfo


    public
                getNetworkMerakiAuthUsersWithHttpInfo(string $network_id) : array<string|int, mixed>

List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkMerakiAuthUserWithHttpInfo()

Operation getNetworkMerakiAuthUserWithHttpInfo


    public
                getNetworkMerakiAuthUserWithHttpInfo(string $network_id, string $meraki_auth_user_id) : array<string|int, mixed>

Return the Meraki Auth splash guest, RADIUS, or client VPN user

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkMqttBroker()

Operation getNetworkMqttBroker


    public
                getNetworkMqttBroker(string $network_id, string $mqtt_broker_id) : object

Return an MQTT broker

Parameters

$network_id : string: network_id (required)
$mqtt_broker_id : string: mqtt_broker_id (required)

Tags

Return values

object —

getNetworkMqttBrokerAsync()

Operation getNetworkMqttBrokerAsync


    public
                getNetworkMqttBrokerAsync(string $network_id, string $mqtt_broker_id) : PromiseInterface

Return an MQTT broker

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkMqttBrokerAsyncWithHttpInfo()

Operation getNetworkMqttBrokerAsyncWithHttpInfo


    public
                getNetworkMqttBrokerAsyncWithHttpInfo(string $network_id, string $mqtt_broker_id) : PromiseInterface

Return an MQTT broker

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkMqttBrokers()

Operation getNetworkMqttBrokers


    public
                getNetworkMqttBrokers(string $network_id) : object

List the MQTT brokers for this network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkMqttBrokersAsync()

Operation getNetworkMqttBrokersAsync


    public
                getNetworkMqttBrokersAsync(string $network_id) : PromiseInterface

List the MQTT brokers for this network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkMqttBrokersAsyncWithHttpInfo()

Operation getNetworkMqttBrokersAsyncWithHttpInfo


    public
                getNetworkMqttBrokersAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the MQTT brokers for this network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkMqttBrokersWithHttpInfo()

Operation getNetworkMqttBrokersWithHttpInfo


    public
                getNetworkMqttBrokersWithHttpInfo(string $network_id) : array<string|int, mixed>

List the MQTT brokers for this network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkMqttBrokerWithHttpInfo()

Operation getNetworkMqttBrokerWithHttpInfo


    public
                getNetworkMqttBrokerWithHttpInfo(string $network_id, string $mqtt_broker_id) : array<string|int, mixed>

Return an MQTT broker

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkNetflow()

Operation getNetworkNetflow


    public
                getNetworkNetflow(string $network_id) : object

Return the NetFlow traffic reporting settings for a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkNetflowAsync()

Operation getNetworkNetflowAsync


    public
                getNetworkNetflowAsync(string $network_id) : PromiseInterface

Return the NetFlow traffic reporting settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkNetflowAsyncWithHttpInfo()

Operation getNetworkNetflowAsyncWithHttpInfo


    public
                getNetworkNetflowAsyncWithHttpInfo(string $network_id) : PromiseInterface

Return the NetFlow traffic reporting settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkNetflowWithHttpInfo()

Operation getNetworkNetflowWithHttpInfo


    public
                getNetworkNetflowWithHttpInfo(string $network_id) : array<string|int, mixed>

Return the NetFlow traffic reporting settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkNetworkHealthChannelUtilization()

Operation getNetworkNetworkHealthChannelUtilization


    public
                getNetworkNetworkHealthChannelUtilization(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Get the channel utilization over each radio for all APs in a network.

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkNetworkHealthChannelUtilizationAsync()

Operation getNetworkNetworkHealthChannelUtilizationAsync


    public
                getNetworkNetworkHealthChannelUtilizationAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Get the channel utilization over each radio for all APs in a network.

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo()

Operation getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo


    public
                getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Get the channel utilization over each radio for all APs in a network.

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkNetworkHealthChannelUtilizationWithHttpInfo()

Operation getNetworkNetworkHealthChannelUtilizationWithHttpInfo


    public
                getNetworkNetworkHealthChannelUtilizationWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Get the channel utilization over each radio for all APs in a network.

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkPiiPiiKeys()

Operation getNetworkPiiPiiKeys


    public
                getNetworkPiiPiiKeys(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : object

List the keys required to access Personally Identifiable Information (PII) for a given identifier

Parameters

$network_id : string: network_id (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

object —

getNetworkPiiPiiKeysAsync()

Operation getNetworkPiiPiiKeysAsync


    public
                getNetworkPiiPiiKeysAsync(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : PromiseInterface

List the keys required to access Personally Identifiable Information (PII) for a given identifier

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

PromiseInterface —

getNetworkPiiPiiKeysAsyncWithHttpInfo()

Operation getNetworkPiiPiiKeysAsyncWithHttpInfo


    public
                getNetworkPiiPiiKeysAsyncWithHttpInfo(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : PromiseInterface

List the keys required to access Personally Identifiable Information (PII) for a given identifier

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

PromiseInterface —

getNetworkPiiPiiKeysWithHttpInfo()

Operation getNetworkPiiPiiKeysWithHttpInfo


    public
                getNetworkPiiPiiKeysWithHttpInfo(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : array<string|int, mixed>

List the keys required to access Personally Identifiable Information (PII) for a given identifier

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkPiiRequest()

Operation getNetworkPiiRequest


    public
                getNetworkPiiRequest(string $network_id, string $request_id) : object

Return a PII request

Parameters

$network_id : string: network_id (required)
$request_id : string: request_id (required)

Tags

Return values

object —

getNetworkPiiRequestAsync()

Operation getNetworkPiiRequestAsync


    public
                getNetworkPiiRequestAsync(string $network_id, string $request_id) : PromiseInterface

Return a PII request

Parameters

$network_id : string: (required)
$request_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkPiiRequestAsyncWithHttpInfo()

Operation getNetworkPiiRequestAsyncWithHttpInfo


    public
                getNetworkPiiRequestAsyncWithHttpInfo(string $network_id, string $request_id) : PromiseInterface

Return a PII request

Parameters

$network_id : string: (required)
$request_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkPiiRequests()

Operation getNetworkPiiRequests


    public
                getNetworkPiiRequests(string $network_id) : object

List the PII requests for this network or organization

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkPiiRequestsAsync()

Operation getNetworkPiiRequestsAsync


    public
                getNetworkPiiRequestsAsync(string $network_id) : PromiseInterface

List the PII requests for this network or organization

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkPiiRequestsAsyncWithHttpInfo()

Operation getNetworkPiiRequestsAsyncWithHttpInfo


    public
                getNetworkPiiRequestsAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the PII requests for this network or organization

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkPiiRequestsWithHttpInfo()

Operation getNetworkPiiRequestsWithHttpInfo


    public
                getNetworkPiiRequestsWithHttpInfo(string $network_id) : array<string|int, mixed>

List the PII requests for this network or organization

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkPiiRequestWithHttpInfo()

Operation getNetworkPiiRequestWithHttpInfo


    public
                getNetworkPiiRequestWithHttpInfo(string $network_id, string $request_id) : array<string|int, mixed>

Return a PII request

Parameters

$network_id : string: (required)
$request_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkPiiSmDevicesForKey()

Operation getNetworkPiiSmDevicesForKey


    public
                getNetworkPiiSmDevicesForKey(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : object

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier

Parameters

$network_id : string: network_id (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

object —

getNetworkPiiSmDevicesForKeyAsync()

Operation getNetworkPiiSmDevicesForKeyAsync


    public
                getNetworkPiiSmDevicesForKeyAsync(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : PromiseInterface

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

PromiseInterface —

getNetworkPiiSmDevicesForKeyAsyncWithHttpInfo()

Operation getNetworkPiiSmDevicesForKeyAsyncWithHttpInfo


    public
                getNetworkPiiSmDevicesForKeyAsyncWithHttpInfo(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : PromiseInterface

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

PromiseInterface —

getNetworkPiiSmDevicesForKeyWithHttpInfo()

Operation getNetworkPiiSmDevicesForKeyWithHttpInfo


    public
                getNetworkPiiSmDevicesForKeyWithHttpInfo(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : array<string|int, mixed>

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkPiiSmOwnersForKey()

Operation getNetworkPiiSmOwnersForKey


    public
                getNetworkPiiSmOwnersForKey(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : object

Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier

Parameters

$network_id : string: network_id (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

object —

getNetworkPiiSmOwnersForKeyAsync()

Operation getNetworkPiiSmOwnersForKeyAsync


    public
                getNetworkPiiSmOwnersForKeyAsync(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : PromiseInterface

Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

PromiseInterface —

getNetworkPiiSmOwnersForKeyAsyncWithHttpInfo()

Operation getNetworkPiiSmOwnersForKeyAsyncWithHttpInfo


    public
                getNetworkPiiSmOwnersForKeyAsyncWithHttpInfo(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : PromiseInterface

Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

PromiseInterface —

getNetworkPiiSmOwnersForKeyWithHttpInfo()

Operation getNetworkPiiSmOwnersForKeyWithHttpInfo


    public
                getNetworkPiiSmOwnersForKeyWithHttpInfo(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : array<string|int, mixed>

Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSettings()

Operation getNetworkSettings


    public
                getNetworkSettings(string $network_id) : object

Return the settings for a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkSettingsAsync()

Operation getNetworkSettingsAsync


    public
                getNetworkSettingsAsync(string $network_id) : PromiseInterface

Return the settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSettingsAsyncWithHttpInfo()

Operation getNetworkSettingsAsyncWithHttpInfo


    public
                getNetworkSettingsAsyncWithHttpInfo(string $network_id) : PromiseInterface

Return the settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSettingsWithHttpInfo()

Operation getNetworkSettingsWithHttpInfo


    public
                getNetworkSettingsWithHttpInfo(string $network_id) : array<string|int, mixed>

Return the settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSnmp()

Operation getNetworkSnmp


    public
                getNetworkSnmp(string $network_id) : object

Return the SNMP settings for a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkSnmpAsync()

Operation getNetworkSnmpAsync


    public
                getNetworkSnmpAsync(string $network_id) : PromiseInterface

Return the SNMP settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSnmpAsyncWithHttpInfo()

Operation getNetworkSnmpAsyncWithHttpInfo


    public
                getNetworkSnmpAsyncWithHttpInfo(string $network_id) : PromiseInterface

Return the SNMP settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSnmpWithHttpInfo()

Operation getNetworkSnmpWithHttpInfo


    public
                getNetworkSnmpWithHttpInfo(string $network_id) : array<string|int, mixed>

Return the SNMP settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSplashLoginAttempts()

Operation getNetworkSplashLoginAttempts


    public
                getNetworkSplashLoginAttempts(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : object

List the splash login attempts for a network

Parameters

$network_id : string: network_id (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

object —

getNetworkSplashLoginAttemptsAsync()

Operation getNetworkSplashLoginAttemptsAsync


    public
                getNetworkSplashLoginAttemptsAsync(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : PromiseInterface

List the splash login attempts for a network

Parameters

$network_id : string: (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

PromiseInterface —

getNetworkSplashLoginAttemptsAsyncWithHttpInfo()

Operation getNetworkSplashLoginAttemptsAsyncWithHttpInfo


    public
                getNetworkSplashLoginAttemptsAsyncWithHttpInfo(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : PromiseInterface

List the splash login attempts for a network

Parameters

$network_id : string: (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

PromiseInterface —

getNetworkSplashLoginAttemptsWithHttpInfo()

Operation getNetworkSplashLoginAttemptsWithHttpInfo


    public
                getNetworkSplashLoginAttemptsWithHttpInfo(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : array<string|int, mixed>

List the splash login attempts for a network

Parameters

$network_id : string: (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSyslogServers()

Operation getNetworkSyslogServers


    public
                getNetworkSyslogServers(string $network_id) : object

List the syslog servers for a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkSyslogServersAsync()

Operation getNetworkSyslogServersAsync


    public
                getNetworkSyslogServersAsync(string $network_id) : PromiseInterface

List the syslog servers for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSyslogServersAsyncWithHttpInfo()

Operation getNetworkSyslogServersAsyncWithHttpInfo


    public
                getNetworkSyslogServersAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the syslog servers for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSyslogServersWithHttpInfo()

Operation getNetworkSyslogServersWithHttpInfo


    public
                getNetworkSyslogServersWithHttpInfo(string $network_id) : array<string|int, mixed>

List the syslog servers for a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkTraffic()

Operation getNetworkTraffic


    public
                getNetworkTraffic(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : object

Return the traffic analysis data for this network

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

object —

getNetworkTrafficAnalysis()

Operation getNetworkTrafficAnalysis


    public
                getNetworkTrafficAnalysis(string $network_id) : object

Return the traffic analysis settings for a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkTrafficAnalysisAsync()

Operation getNetworkTrafficAnalysisAsync


    public
                getNetworkTrafficAnalysisAsync(string $network_id) : PromiseInterface

Return the traffic analysis settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkTrafficAnalysisAsyncWithHttpInfo()

Operation getNetworkTrafficAnalysisAsyncWithHttpInfo


    public
                getNetworkTrafficAnalysisAsyncWithHttpInfo(string $network_id) : PromiseInterface

Return the traffic analysis settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkTrafficAnalysisWithHttpInfo()

Operation getNetworkTrafficAnalysisWithHttpInfo


    public
                getNetworkTrafficAnalysisWithHttpInfo(string $network_id) : array<string|int, mixed>

Return the traffic analysis settings for a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkTrafficAsync()

Operation getNetworkTrafficAsync


    public
                getNetworkTrafficAsync(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : PromiseInterface

Return the traffic analysis data for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

PromiseInterface —

getNetworkTrafficAsyncWithHttpInfo()

Operation getNetworkTrafficAsyncWithHttpInfo


    public
                getNetworkTrafficAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : PromiseInterface

Return the traffic analysis data for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

PromiseInterface —

getNetworkTrafficShapingApplicationCategories()

Operation getNetworkTrafficShapingApplicationCategories


    public
                getNetworkTrafficShapingApplicationCategories(string $network_id) : object

Returns the application categories for traffic shaping rules.

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkTrafficShapingApplicationCategoriesAsync()

Operation getNetworkTrafficShapingApplicationCategoriesAsync


    public
                getNetworkTrafficShapingApplicationCategoriesAsync(string $network_id) : PromiseInterface

Returns the application categories for traffic shaping rules.

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkTrafficShapingApplicationCategoriesAsyncWithHttpInfo()

Operation getNetworkTrafficShapingApplicationCategoriesAsyncWithHttpInfo


    public
                getNetworkTrafficShapingApplicationCategoriesAsyncWithHttpInfo(string $network_id) : PromiseInterface

Returns the application categories for traffic shaping rules.

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkTrafficShapingApplicationCategoriesWithHttpInfo()

Operation getNetworkTrafficShapingApplicationCategoriesWithHttpInfo


    public
                getNetworkTrafficShapingApplicationCategoriesWithHttpInfo(string $network_id) : array<string|int, mixed>

Returns the application categories for traffic shaping rules.

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkTrafficShapingDscpTaggingOptions()

Operation getNetworkTrafficShapingDscpTaggingOptions


    public
                getNetworkTrafficShapingDscpTaggingOptions(string $network_id) : object

Returns the available DSCP tagging options for your traffic shaping rules.

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkTrafficShapingDscpTaggingOptionsAsync()

Operation getNetworkTrafficShapingDscpTaggingOptionsAsync


    public
                getNetworkTrafficShapingDscpTaggingOptionsAsync(string $network_id) : PromiseInterface

Returns the available DSCP tagging options for your traffic shaping rules.

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkTrafficShapingDscpTaggingOptionsAsyncWithHttpInfo()

Operation getNetworkTrafficShapingDscpTaggingOptionsAsyncWithHttpInfo


    public
                getNetworkTrafficShapingDscpTaggingOptionsAsyncWithHttpInfo(string $network_id) : PromiseInterface

Returns the available DSCP tagging options for your traffic shaping rules.

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkTrafficShapingDscpTaggingOptionsWithHttpInfo()

Operation getNetworkTrafficShapingDscpTaggingOptionsWithHttpInfo


    public
                getNetworkTrafficShapingDscpTaggingOptionsWithHttpInfo(string $network_id) : array<string|int, mixed>

Returns the available DSCP tagging options for your traffic shaping rules.

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkTrafficWithHttpInfo()

Operation getNetworkTrafficWithHttpInfo


    public
                getNetworkTrafficWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : array<string|int, mixed>

Return the traffic analysis data for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWebhooksHttpServer()

Operation getNetworkWebhooksHttpServer


    public
                getNetworkWebhooksHttpServer(string $network_id, string $http_server_id) : object

Return an HTTP server for a network

Parameters

$network_id : string: network_id (required)
$http_server_id : string: http_server_id (required)

Tags

Return values

object —

getNetworkWebhooksHttpServerAsync()

Operation getNetworkWebhooksHttpServerAsync


    public
                getNetworkWebhooksHttpServerAsync(string $network_id, string $http_server_id) : PromiseInterface

Return an HTTP server for a network

Parameters

$network_id : string: (required)
$http_server_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkWebhooksHttpServerAsyncWithHttpInfo()

Operation getNetworkWebhooksHttpServerAsyncWithHttpInfo


    public
                getNetworkWebhooksHttpServerAsyncWithHttpInfo(string $network_id, string $http_server_id) : PromiseInterface

Return an HTTP server for a network

Parameters

$network_id : string: (required)
$http_server_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkWebhooksHttpServers()

Operation getNetworkWebhooksHttpServers


    public
                getNetworkWebhooksHttpServers(string $network_id) : object

List the HTTP servers for a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkWebhooksHttpServersAsync()

Operation getNetworkWebhooksHttpServersAsync


    public
                getNetworkWebhooksHttpServersAsync(string $network_id) : PromiseInterface

List the HTTP servers for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkWebhooksHttpServersAsyncWithHttpInfo()

Operation getNetworkWebhooksHttpServersAsyncWithHttpInfo


    public
                getNetworkWebhooksHttpServersAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the HTTP servers for a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkWebhooksHttpServersWithHttpInfo()

Operation getNetworkWebhooksHttpServersWithHttpInfo


    public
                getNetworkWebhooksHttpServersWithHttpInfo(string $network_id) : array<string|int, mixed>

List the HTTP servers for a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWebhooksHttpServerWithHttpInfo()

Operation getNetworkWebhooksHttpServerWithHttpInfo


    public
                getNetworkWebhooksHttpServerWithHttpInfo(string $network_id, string $http_server_id) : array<string|int, mixed>

Return an HTTP server for a network

Parameters

$network_id : string: (required)
$http_server_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWebhooksWebhookTest()

Operation getNetworkWebhooksWebhookTest


    public
                getNetworkWebhooksWebhookTest(string $network_id, string $webhook_test_id) : object

Return the status of a webhook test for a network

Parameters

$network_id : string: network_id (required)
$webhook_test_id : string: webhook_test_id (required)

Tags

Return values

object —

getNetworkWebhooksWebhookTestAsync()

Operation getNetworkWebhooksWebhookTestAsync


    public
                getNetworkWebhooksWebhookTestAsync(string $network_id, string $webhook_test_id) : PromiseInterface

Return the status of a webhook test for a network

Parameters

$network_id : string: (required)
$webhook_test_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkWebhooksWebhookTestAsyncWithHttpInfo()

Operation getNetworkWebhooksWebhookTestAsyncWithHttpInfo


    public
                getNetworkWebhooksWebhookTestAsyncWithHttpInfo(string $network_id, string $webhook_test_id) : PromiseInterface

Return the status of a webhook test for a network

Parameters

$network_id : string: (required)
$webhook_test_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkWebhooksWebhookTestWithHttpInfo()

Operation getNetworkWebhooksWebhookTestWithHttpInfo


    public
                getNetworkWebhooksWebhookTestWithHttpInfo(string $network_id, string $webhook_test_id) : array<string|int, mixed>

Return the status of a webhook test for a network

Parameters

$network_id : string: (required)
$webhook_test_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWithHttpInfo()

Operation getNetworkWithHttpInfo


    public
                getNetworkWithHttpInfo(string $network_id) : array<string|int, mixed>

Return a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationNetworks()

Operation getOrganizationNetworks


    public
                getOrganizationNetworks(string $organization_id[, string $config_template_id = null ][, array<string|int, string> $tags = null ][, string $tags_filter_type = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

List the networks that the user has privileges on in an organization

Parameters

$organization_id : string: organization_id (required)
$config_template_id : string = null: An optional parameter that is the ID of a config template. Will return all networks bound to that template. (optional)
$tags : array<string|int, string> = null: An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). (optional)
$tags_filter_type : string = null: An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getOrganizationNetworksAsync()

Operation getOrganizationNetworksAsync


    public
                getOrganizationNetworksAsync(string $organization_id[, string $config_template_id = null ][, array<string|int, string> $tags = null ][, string $tags_filter_type = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the networks that the user has privileges on in an organization

Parameters

$organization_id : string: (required)
$config_template_id : string = null: An optional parameter that is the ID of a config template. Will return all networks bound to that template. (optional)
$tags : array<string|int, string> = null: An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). (optional)
$tags_filter_type : string = null: An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getOrganizationNetworksAsyncWithHttpInfo()

Operation getOrganizationNetworksAsyncWithHttpInfo


    public
                getOrganizationNetworksAsyncWithHttpInfo(string $organization_id[, string $config_template_id = null ][, array<string|int, string> $tags = null ][, string $tags_filter_type = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the networks that the user has privileges on in an organization

Parameters

$organization_id : string: (required)
$config_template_id : string = null: An optional parameter that is the ID of a config template. Will return all networks bound to that template. (optional)
$tags : array<string|int, string> = null: An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). (optional)
$tags_filter_type : string = null: An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getOrganizationNetworksWithHttpInfo()

Operation getOrganizationNetworksWithHttpInfo


    public
                getOrganizationNetworksWithHttpInfo(string $organization_id[, string $config_template_id = null ][, array<string|int, string> $tags = null ][, string $tags_filter_type = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

List the networks that the user has privileges on in an organization

Parameters

$organization_id : string: (required)
$config_template_id : string = null: An optional parameter that is the ID of a config template. Will return all networks bound to that template. (optional)
$tags : array<string|int, string> = null: An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). (optional)
$tags_filter_type : string = null: An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

provisionNetworkClients()

Operation provisionNetworkClients


    public
                provisionNetworkClients(string $network_id, ProvisionNetworkClients $provision_network_clients) : object

Provisions a client with a name and policy

Parameters

$network_id : string: network_id (required)
$provision_network_clients : ProvisionNetworkClients: provision_network_clients (required)

Tags

Return values

object —

provisionNetworkClientsAsync()

Operation provisionNetworkClientsAsync


    public
                provisionNetworkClientsAsync(string $network_id, ProvisionNetworkClients $provision_network_clients) : PromiseInterface

Provisions a client with a name and policy

Parameters

$network_id : string: (required)
$provision_network_clients : ProvisionNetworkClients: (required)

Tags

Return values

PromiseInterface —

provisionNetworkClientsAsyncWithHttpInfo()

Operation provisionNetworkClientsAsyncWithHttpInfo


    public
                provisionNetworkClientsAsyncWithHttpInfo(string $network_id, ProvisionNetworkClients $provision_network_clients) : PromiseInterface

Provisions a client with a name and policy

Parameters

$network_id : string: (required)
$provision_network_clients : ProvisionNetworkClients: (required)

Tags

Return values

PromiseInterface —

provisionNetworkClientsWithHttpInfo()

Operation provisionNetworkClientsWithHttpInfo


    public
                provisionNetworkClientsWithHttpInfo(string $network_id, ProvisionNetworkClients $provision_network_clients) : array<string|int, mixed>

Provisions a client with a name and policy

Parameters

$network_id : string: (required)
$provision_network_clients : ProvisionNetworkClients: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

removeNetworkDevices()

Operation removeNetworkDevices


    public
                removeNetworkDevices(string $network_id, RemoveNetworkDevices $remove_network_devices) : void

Remove a single device

Parameters

$network_id : string: network_id (required)
$remove_network_devices : RemoveNetworkDevices: remove_network_devices (required)

Tags

Return values

void —

removeNetworkDevicesAsync()

Operation removeNetworkDevicesAsync


    public
                removeNetworkDevicesAsync(string $network_id, RemoveNetworkDevices $remove_network_devices) : PromiseInterface

Remove a single device

Parameters

$network_id : string: (required)
$remove_network_devices : RemoveNetworkDevices: (required)

Tags

Return values

PromiseInterface —

removeNetworkDevicesAsyncWithHttpInfo()

Operation removeNetworkDevicesAsyncWithHttpInfo


    public
                removeNetworkDevicesAsyncWithHttpInfo(string $network_id, RemoveNetworkDevices $remove_network_devices) : PromiseInterface

Remove a single device

Parameters

$network_id : string: (required)
$remove_network_devices : RemoveNetworkDevices: (required)

Tags

Return values

PromiseInterface —

removeNetworkDevicesWithHttpInfo()

Operation removeNetworkDevicesWithHttpInfo


    public
                removeNetworkDevicesWithHttpInfo(string $network_id, RemoveNetworkDevices $remove_network_devices) : array<string|int, mixed>

Remove a single device

Parameters

$network_id : string: (required)
$remove_network_devices : RemoveNetworkDevices: (required)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

splitNetwork()

Operation splitNetwork


    public
                splitNetwork(string $network_id) : object

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

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

splitNetworkAsync()

Operation splitNetworkAsync


    public
                splitNetworkAsync(string $network_id) : PromiseInterface

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

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

splitNetworkAsyncWithHttpInfo()

Operation splitNetworkAsyncWithHttpInfo


    public
                splitNetworkAsyncWithHttpInfo(string $network_id) : PromiseInterface

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

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

splitNetworkWithHttpInfo()

Operation splitNetworkWithHttpInfo


    public
                splitNetworkWithHttpInfo(string $network_id) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

unbindNetwork()

Operation unbindNetwork


    public
                unbindNetwork(string $network_id) : object

Unbind a network from a template.

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

unbindNetworkAsync()

Operation unbindNetworkAsync


    public
                unbindNetworkAsync(string $network_id) : PromiseInterface

Unbind a network from a template.

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

unbindNetworkAsyncWithHttpInfo()

Operation unbindNetworkAsyncWithHttpInfo


    public
                unbindNetworkAsyncWithHttpInfo(string $network_id) : PromiseInterface

Unbind a network from a template.

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

unbindNetworkWithHttpInfo()

Operation unbindNetworkWithHttpInfo


    public
                unbindNetworkWithHttpInfo(string $network_id) : array<string|int, mixed>

Unbind a network from a template.

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetwork()

Operation updateNetwork


    public
                updateNetwork(string $network_id[, UpdateNetwork $update_network = null ]) : object

Update a network

Parameters

$network_id : string: network_id (required)
$update_network : UpdateNetwork = null: update_network (optional)

Tags

Return values

object —

updateNetworkAlertsSettings()

Operation updateNetworkAlertsSettings


    public
                updateNetworkAlertsSettings(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : object

Update the alert configuration for this network

Parameters

$network_id : string: network_id (required)
$update_network_alerts_settings : UpdateNetworkAlertsSettings = null: update_network_alerts_settings (optional)

Tags

Return values

object —

updateNetworkAlertsSettingsAsync()

Operation updateNetworkAlertsSettingsAsync


    public
                updateNetworkAlertsSettingsAsync(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : PromiseInterface

Update the alert configuration for this network

Parameters

$network_id : string: (required)
$update_network_alerts_settings : UpdateNetworkAlertsSettings = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkAlertsSettingsAsyncWithHttpInfo()

Operation updateNetworkAlertsSettingsAsyncWithHttpInfo


    public
                updateNetworkAlertsSettingsAsyncWithHttpInfo(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : PromiseInterface

Update the alert configuration for this network

Parameters

$network_id : string: (required)
$update_network_alerts_settings : UpdateNetworkAlertsSettings = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkAlertsSettingsWithHttpInfo()

Operation updateNetworkAlertsSettingsWithHttpInfo


    public
                updateNetworkAlertsSettingsWithHttpInfo(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : array<string|int, mixed>

Update the alert configuration for this network

Parameters

$network_id : string: (required)
$update_network_alerts_settings : UpdateNetworkAlertsSettings = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkAsync()

Operation updateNetworkAsync


    public
                updateNetworkAsync(string $network_id[, UpdateNetwork $update_network = null ]) : PromiseInterface

Update a network

Parameters

$network_id : string: (required)
$update_network : UpdateNetwork = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkAsyncWithHttpInfo()

Operation updateNetworkAsyncWithHttpInfo


    public
                updateNetworkAsyncWithHttpInfo(string $network_id[, UpdateNetwork $update_network = null ]) : PromiseInterface

Update a network

Parameters

$network_id : string: (required)
$update_network : UpdateNetwork = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkClientPolicy()

Operation updateNetworkClientPolicy


    public
                updateNetworkClientPolicy(string $network_id, string $client_id, UpdateNetworkClientPolicy $update_network_client_policy) : object

Update the policy assigned to a client on the network

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$update_network_client_policy : UpdateNetworkClientPolicy: update_network_client_policy (required)

Tags

Return values

object —

updateNetworkClientPolicyAsync()

Operation updateNetworkClientPolicyAsync


    public
                updateNetworkClientPolicyAsync(string $network_id, string $client_id, UpdateNetworkClientPolicy $update_network_client_policy) : PromiseInterface

Update the policy assigned to a client on the network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$update_network_client_policy : UpdateNetworkClientPolicy: (required)

Tags

Return values

PromiseInterface —

updateNetworkClientPolicyAsyncWithHttpInfo()

Operation updateNetworkClientPolicyAsyncWithHttpInfo


    public
                updateNetworkClientPolicyAsyncWithHttpInfo(string $network_id, string $client_id, UpdateNetworkClientPolicy $update_network_client_policy) : PromiseInterface

Update the policy assigned to a client on the network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$update_network_client_policy : UpdateNetworkClientPolicy: (required)

Tags

Return values

PromiseInterface —

updateNetworkClientPolicyWithHttpInfo()

Operation updateNetworkClientPolicyWithHttpInfo


    public
                updateNetworkClientPolicyWithHttpInfo(string $network_id, string $client_id, UpdateNetworkClientPolicy $update_network_client_policy) : array<string|int, mixed>

Update the policy assigned to a client on the network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$update_network_client_policy : UpdateNetworkClientPolicy: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkClientSplashAuthorizationStatus()

Operation updateNetworkClientSplashAuthorizationStatus


    public
                updateNetworkClientSplashAuthorizationStatus(string $network_id, string $client_id, UpdateNetworkClientSplashAuthorizationStatus $update_network_client_splash_authorization_status) : object

Update a client's splash authorization

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$update_network_client_splash_authorization_status : UpdateNetworkClientSplashAuthorizationStatus: update_network_client_splash_authorization_status (required)

Tags

Return values

object —

updateNetworkClientSplashAuthorizationStatusAsync()

Operation updateNetworkClientSplashAuthorizationStatusAsync


    public
                updateNetworkClientSplashAuthorizationStatusAsync(string $network_id, string $client_id, UpdateNetworkClientSplashAuthorizationStatus $update_network_client_splash_authorization_status) : PromiseInterface

Update a client's splash authorization

Parameters

$network_id : string: (required)
$client_id : string: (required)
$update_network_client_splash_authorization_status : UpdateNetworkClientSplashAuthorizationStatus: (required)

Tags

Return values

PromiseInterface —

updateNetworkClientSplashAuthorizationStatusAsyncWithHttpInfo()

Operation updateNetworkClientSplashAuthorizationStatusAsyncWithHttpInfo


    public
                updateNetworkClientSplashAuthorizationStatusAsyncWithHttpInfo(string $network_id, string $client_id, UpdateNetworkClientSplashAuthorizationStatus $update_network_client_splash_authorization_status) : PromiseInterface

Update a client's splash authorization

Parameters

$network_id : string: (required)
$client_id : string: (required)
$update_network_client_splash_authorization_status : UpdateNetworkClientSplashAuthorizationStatus: (required)

Tags

Return values

PromiseInterface —

updateNetworkClientSplashAuthorizationStatusWithHttpInfo()

Operation updateNetworkClientSplashAuthorizationStatusWithHttpInfo


    public
                updateNetworkClientSplashAuthorizationStatusWithHttpInfo(string $network_id, string $client_id, UpdateNetworkClientSplashAuthorizationStatus $update_network_client_splash_authorization_status) : array<string|int, mixed>

Update a client's splash authorization

Parameters

$network_id : string: (required)
$client_id : string: (required)
$update_network_client_splash_authorization_status : UpdateNetworkClientSplashAuthorizationStatus: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkFirmwareUpgrades()

Operation updateNetworkFirmwareUpgrades


    public
                updateNetworkFirmwareUpgrades(string $network_id[, UpdateNetworkFirmwareUpgrades $update_network_firmware_upgrades = null ]) : object

Update firmware upgrade information for a network

Parameters

$network_id : string: network_id (required)
$update_network_firmware_upgrades : UpdateNetworkFirmwareUpgrades = null: update_network_firmware_upgrades (optional)

Tags

Return values

object —

updateNetworkFirmwareUpgradesAsync()

Operation updateNetworkFirmwareUpgradesAsync


    public
                updateNetworkFirmwareUpgradesAsync(string $network_id[, UpdateNetworkFirmwareUpgrades $update_network_firmware_upgrades = null ]) : PromiseInterface

Update firmware upgrade information for a network

Parameters

$network_id : string: (required)
$update_network_firmware_upgrades : UpdateNetworkFirmwareUpgrades = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkFirmwareUpgradesAsyncWithHttpInfo()

Operation updateNetworkFirmwareUpgradesAsyncWithHttpInfo


    public
                updateNetworkFirmwareUpgradesAsyncWithHttpInfo(string $network_id[, UpdateNetworkFirmwareUpgrades $update_network_firmware_upgrades = null ]) : PromiseInterface

Update firmware upgrade information for a network

Parameters

$network_id : string: (required)
$update_network_firmware_upgrades : UpdateNetworkFirmwareUpgrades = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkFirmwareUpgradesWithHttpInfo()

Operation updateNetworkFirmwareUpgradesWithHttpInfo


    public
                updateNetworkFirmwareUpgradesWithHttpInfo(string $network_id[, UpdateNetworkFirmwareUpgrades $update_network_firmware_upgrades = null ]) : array<string|int, mixed>

Update firmware upgrade information for a network

Parameters

$network_id : string: (required)
$update_network_firmware_upgrades : UpdateNetworkFirmwareUpgrades = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkFloorPlan()

Operation updateNetworkFloorPlan


    public
                updateNetworkFloorPlan(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : object

Update a floor plan's geolocation and other meta data

Parameters

$network_id : string: network_id (required)
$floor_plan_id : string: floor_plan_id (required)
$update_network_floor_plan : UpdateNetworkFloorPlan = null: update_network_floor_plan (optional)

Tags

Return values

object —

updateNetworkFloorPlanAsync()

Operation updateNetworkFloorPlanAsync


    public
                updateNetworkFloorPlanAsync(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : PromiseInterface

Update a floor plan's geolocation and other meta data

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)
$update_network_floor_plan : UpdateNetworkFloorPlan = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkFloorPlanAsyncWithHttpInfo()

Operation updateNetworkFloorPlanAsyncWithHttpInfo


    public
                updateNetworkFloorPlanAsyncWithHttpInfo(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : PromiseInterface

Update a floor plan's geolocation and other meta data

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)
$update_network_floor_plan : UpdateNetworkFloorPlan = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkFloorPlanWithHttpInfo()

Operation updateNetworkFloorPlanWithHttpInfo


    public
                updateNetworkFloorPlanWithHttpInfo(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : array<string|int, mixed>

Update a floor plan's geolocation and other meta data

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)
$update_network_floor_plan : UpdateNetworkFloorPlan = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkGroupPolicy()

Operation updateNetworkGroupPolicy


    public
                updateNetworkGroupPolicy(string $network_id, string $group_policy_id[, UpdateNetworkGroupPolicy $update_network_group_policy = null ]) : object

Update a group policy

Parameters

$network_id : string: network_id (required)
$group_policy_id : string: group_policy_id (required)
$update_network_group_policy : UpdateNetworkGroupPolicy = null: update_network_group_policy (optional)

Tags

Return values

object —

updateNetworkGroupPolicyAsync()

Operation updateNetworkGroupPolicyAsync


    public
                updateNetworkGroupPolicyAsync(string $network_id, string $group_policy_id[, UpdateNetworkGroupPolicy $update_network_group_policy = null ]) : PromiseInterface

Update a group policy

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)
$update_network_group_policy : UpdateNetworkGroupPolicy = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkGroupPolicyAsyncWithHttpInfo()

Operation updateNetworkGroupPolicyAsyncWithHttpInfo


    public
                updateNetworkGroupPolicyAsyncWithHttpInfo(string $network_id, string $group_policy_id[, UpdateNetworkGroupPolicy $update_network_group_policy = null ]) : PromiseInterface

Update a group policy

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)
$update_network_group_policy : UpdateNetworkGroupPolicy = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkGroupPolicyWithHttpInfo()

Operation updateNetworkGroupPolicyWithHttpInfo


    public
                updateNetworkGroupPolicyWithHttpInfo(string $network_id, string $group_policy_id[, UpdateNetworkGroupPolicy $update_network_group_policy = null ]) : array<string|int, mixed>

Update a group policy

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)
$update_network_group_policy : UpdateNetworkGroupPolicy = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkMerakiAuthUser()

Operation updateNetworkMerakiAuthUser


    public
                updateNetworkMerakiAuthUser(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : object

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

Parameters

$network_id : string: network_id (required)
$meraki_auth_user_id : string: meraki_auth_user_id (required)
$update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null: update_network_meraki_auth_user (optional)

Tags

Return values

object —

updateNetworkMerakiAuthUserAsync()

Operation updateNetworkMerakiAuthUserAsync


    public
                updateNetworkMerakiAuthUserAsync(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)
$update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkMerakiAuthUserAsyncWithHttpInfo()

Operation updateNetworkMerakiAuthUserAsyncWithHttpInfo


    public
                updateNetworkMerakiAuthUserAsyncWithHttpInfo(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)
$update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkMerakiAuthUserWithHttpInfo()

Operation updateNetworkMerakiAuthUserWithHttpInfo


    public
                updateNetworkMerakiAuthUserWithHttpInfo(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)
$update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkMqttBroker()

Operation updateNetworkMqttBroker


    public
                updateNetworkMqttBroker(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : object

Update an MQTT broker

Parameters

$network_id : string: network_id (required)
$mqtt_broker_id : string: mqtt_broker_id (required)
$update_network_mqtt_broker : UpdateNetworkMqttBroker = null: update_network_mqtt_broker (optional)

Tags

Return values

object —

updateNetworkMqttBrokerAsync()

Operation updateNetworkMqttBrokerAsync


    public
                updateNetworkMqttBrokerAsync(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : PromiseInterface

Update an MQTT broker

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)
$update_network_mqtt_broker : UpdateNetworkMqttBroker = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkMqttBrokerAsyncWithHttpInfo()

Operation updateNetworkMqttBrokerAsyncWithHttpInfo


    public
                updateNetworkMqttBrokerAsyncWithHttpInfo(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : PromiseInterface

Update an MQTT broker

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)
$update_network_mqtt_broker : UpdateNetworkMqttBroker = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkMqttBrokerWithHttpInfo()

Operation updateNetworkMqttBrokerWithHttpInfo


    public
                updateNetworkMqttBrokerWithHttpInfo(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : array<string|int, mixed>

Update an MQTT broker

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)
$update_network_mqtt_broker : UpdateNetworkMqttBroker = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkNetflow()

Operation updateNetworkNetflow


    public
                updateNetworkNetflow(string $network_id[, UpdateNetworkNetflow $update_network_netflow = null ]) : object

Update the NetFlow traffic reporting settings for a network

Parameters

$network_id : string: network_id (required)
$update_network_netflow : UpdateNetworkNetflow = null: update_network_netflow (optional)

Tags

Return values

object —

updateNetworkNetflowAsync()

Operation updateNetworkNetflowAsync


    public
                updateNetworkNetflowAsync(string $network_id[, UpdateNetworkNetflow $update_network_netflow = null ]) : PromiseInterface

Update the NetFlow traffic reporting settings for a network

Parameters

$network_id : string: (required)
$update_network_netflow : UpdateNetworkNetflow = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkNetflowAsyncWithHttpInfo()

Operation updateNetworkNetflowAsyncWithHttpInfo


    public
                updateNetworkNetflowAsyncWithHttpInfo(string $network_id[, UpdateNetworkNetflow $update_network_netflow = null ]) : PromiseInterface

Update the NetFlow traffic reporting settings for a network

Parameters

$network_id : string: (required)
$update_network_netflow : UpdateNetworkNetflow = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkNetflowWithHttpInfo()

Operation updateNetworkNetflowWithHttpInfo


    public
                updateNetworkNetflowWithHttpInfo(string $network_id[, UpdateNetworkNetflow $update_network_netflow = null ]) : array<string|int, mixed>

Update the NetFlow traffic reporting settings for a network

Parameters

$network_id : string: (required)
$update_network_netflow : UpdateNetworkNetflow = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkSettings()

Operation updateNetworkSettings


    public
                updateNetworkSettings(string $network_id[, UpdateNetworkSettings $update_network_settings = null ]) : object

Update the settings for a network

Parameters

$network_id : string: network_id (required)
$update_network_settings : UpdateNetworkSettings = null: update_network_settings (optional)

Tags

Return values

object —

updateNetworkSettingsAsync()

Operation updateNetworkSettingsAsync


    public
                updateNetworkSettingsAsync(string $network_id[, UpdateNetworkSettings $update_network_settings = null ]) : PromiseInterface

Update the settings for a network

Parameters

$network_id : string: (required)
$update_network_settings : UpdateNetworkSettings = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkSettingsAsyncWithHttpInfo()

Operation updateNetworkSettingsAsyncWithHttpInfo


    public
                updateNetworkSettingsAsyncWithHttpInfo(string $network_id[, UpdateNetworkSettings $update_network_settings = null ]) : PromiseInterface

Update the settings for a network

Parameters

$network_id : string: (required)
$update_network_settings : UpdateNetworkSettings = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkSettingsWithHttpInfo()

Operation updateNetworkSettingsWithHttpInfo


    public
                updateNetworkSettingsWithHttpInfo(string $network_id[, UpdateNetworkSettings $update_network_settings = null ]) : array<string|int, mixed>

Update the settings for a network

Parameters

$network_id : string: (required)
$update_network_settings : UpdateNetworkSettings = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkSnmp()

Operation updateNetworkSnmp


    public
                updateNetworkSnmp(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : object

Update the SNMP settings for a network

Parameters

$network_id : string: network_id (required)
$update_network_snmp : UpdateNetworkSnmp = null: update_network_snmp (optional)

Tags

Return values

object —

updateNetworkSnmpAsync()

Operation updateNetworkSnmpAsync


    public
                updateNetworkSnmpAsync(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : PromiseInterface

Update the SNMP settings for a network

Parameters

$network_id : string: (required)
$update_network_snmp : UpdateNetworkSnmp = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkSnmpAsyncWithHttpInfo()

Operation updateNetworkSnmpAsyncWithHttpInfo


    public
                updateNetworkSnmpAsyncWithHttpInfo(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : PromiseInterface

Update the SNMP settings for a network

Parameters

$network_id : string: (required)
$update_network_snmp : UpdateNetworkSnmp = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkSnmpWithHttpInfo()

Operation updateNetworkSnmpWithHttpInfo


    public
                updateNetworkSnmpWithHttpInfo(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : array<string|int, mixed>

Update the SNMP settings for a network

Parameters

$network_id : string: (required)
$update_network_snmp : UpdateNetworkSnmp = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkSyslogServers()

Operation updateNetworkSyslogServers


    public
                updateNetworkSyslogServers(string $network_id, UpdateNetworkSyslogServers $update_network_syslog_servers) : object

Update the syslog servers for a network

Parameters

$network_id : string: network_id (required)
$update_network_syslog_servers : UpdateNetworkSyslogServers: update_network_syslog_servers (required)

Tags

Return values

object —

updateNetworkSyslogServersAsync()

Operation updateNetworkSyslogServersAsync


    public
                updateNetworkSyslogServersAsync(string $network_id, UpdateNetworkSyslogServers $update_network_syslog_servers) : PromiseInterface

Update the syslog servers for a network

Parameters

$network_id : string: (required)
$update_network_syslog_servers : UpdateNetworkSyslogServers: (required)

Tags

Return values

PromiseInterface —

updateNetworkSyslogServersAsyncWithHttpInfo()

Operation updateNetworkSyslogServersAsyncWithHttpInfo


    public
                updateNetworkSyslogServersAsyncWithHttpInfo(string $network_id, UpdateNetworkSyslogServers $update_network_syslog_servers) : PromiseInterface

Update the syslog servers for a network

Parameters

$network_id : string: (required)
$update_network_syslog_servers : UpdateNetworkSyslogServers: (required)

Tags

Return values

PromiseInterface —

updateNetworkSyslogServersWithHttpInfo()

Operation updateNetworkSyslogServersWithHttpInfo


    public
                updateNetworkSyslogServersWithHttpInfo(string $network_id, UpdateNetworkSyslogServers $update_network_syslog_servers) : array<string|int, mixed>

Update the syslog servers for a network

Parameters

$network_id : string: (required)
$update_network_syslog_servers : UpdateNetworkSyslogServers: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkTrafficAnalysis()

Operation updateNetworkTrafficAnalysis


    public
                updateNetworkTrafficAnalysis(string $network_id[, UpdateNetworkTrafficAnalysis $update_network_traffic_analysis = null ]) : object

Update the traffic analysis settings for a network

Parameters

$network_id : string: network_id (required)
$update_network_traffic_analysis : UpdateNetworkTrafficAnalysis = null: update_network_traffic_analysis (optional)

Tags

Return values

object —

updateNetworkTrafficAnalysisAsync()

Operation updateNetworkTrafficAnalysisAsync


    public
                updateNetworkTrafficAnalysisAsync(string $network_id[, UpdateNetworkTrafficAnalysis $update_network_traffic_analysis = null ]) : PromiseInterface

Update the traffic analysis settings for a network

Parameters

$network_id : string: (required)
$update_network_traffic_analysis : UpdateNetworkTrafficAnalysis = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkTrafficAnalysisAsyncWithHttpInfo()

Operation updateNetworkTrafficAnalysisAsyncWithHttpInfo


    public
                updateNetworkTrafficAnalysisAsyncWithHttpInfo(string $network_id[, UpdateNetworkTrafficAnalysis $update_network_traffic_analysis = null ]) : PromiseInterface

Update the traffic analysis settings for a network

Parameters

$network_id : string: (required)
$update_network_traffic_analysis : UpdateNetworkTrafficAnalysis = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkTrafficAnalysisWithHttpInfo()

Operation updateNetworkTrafficAnalysisWithHttpInfo


    public
                updateNetworkTrafficAnalysisWithHttpInfo(string $network_id[, UpdateNetworkTrafficAnalysis $update_network_traffic_analysis = null ]) : array<string|int, mixed>

Update the traffic analysis settings for a network

Parameters

$network_id : string: (required)
$update_network_traffic_analysis : UpdateNetworkTrafficAnalysis = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkWebhooksHttpServer()

Operation updateNetworkWebhooksHttpServer


    public
                updateNetworkWebhooksHttpServer(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : object

Update an HTTP server

Parameters

$network_id : string: network_id (required)
$http_server_id : string: http_server_id (required)
$update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null: update_network_webhooks_http_server (optional)

Tags

Return values

object —

updateNetworkWebhooksHttpServerAsync()

Operation updateNetworkWebhooksHttpServerAsync


    public
                updateNetworkWebhooksHttpServerAsync(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : PromiseInterface

Update an HTTP server

Parameters

$network_id : string: (required)
$http_server_id : string: (required)
$update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkWebhooksHttpServerAsyncWithHttpInfo()

Operation updateNetworkWebhooksHttpServerAsyncWithHttpInfo


    public
                updateNetworkWebhooksHttpServerAsyncWithHttpInfo(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : PromiseInterface

Update an HTTP server

Parameters

$network_id : string: (required)
$http_server_id : string: (required)
$update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null: (optional)

Tags

Return values

PromiseInterface —

updateNetworkWebhooksHttpServerWithHttpInfo()

Operation updateNetworkWebhooksHttpServerWithHttpInfo


    public
                updateNetworkWebhooksHttpServerWithHttpInfo(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : array<string|int, mixed>

Update an HTTP server

Parameters

$network_id : string: (required)
$http_server_id : string: (required)
$update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkWithHttpInfo()

Operation updateNetworkWithHttpInfo


    public
                updateNetworkWithHttpInfo(string $network_id[, UpdateNetwork $update_network = null ]) : array<string|int, mixed>

Update a network

Parameters

$network_id : string: (required)
$update_network : UpdateNetwork = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

bindNetworkRequest()

Create request for operation 'bindNetwork'


    protected
                bindNetworkRequest(string $network_id, BindNetwork $bind_network) : Request

Parameters

$network_id : string: (required)
$bind_network : BindNetwork: (required)

Tags

Return values

Request —

claimNetworkDevicesRequest()

Create request for operation 'claimNetworkDevices'


    protected
                claimNetworkDevicesRequest(string $network_id, ClaimNetworkDevices $claim_network_devices) : Request

Parameters

$network_id : string: (required)
$claim_network_devices : ClaimNetworkDevices: (required)

Tags

Return values

Request —

combineOrganizationNetworksRequest()

Create request for operation 'combineOrganizationNetworks'


    protected
                combineOrganizationNetworksRequest(string $organization_id, CombineOrganizationNetworks $combine_organization_networks) : Request

Parameters

$organization_id : string: (required)
$combine_organization_networks : CombineOrganizationNetworks: (required)

Tags

Return values

Request —

createHttpClientOption()

Create http client option


    protected
                createHttpClientOption() : array<string|int, mixed>

Tags

Return values

array<string|int, mixed> —

of http client options

createNetworkFirmwareUpgradesRollbackRequest()

Create request for operation 'createNetworkFirmwareUpgradesRollback'


    protected
                createNetworkFirmwareUpgradesRollbackRequest(string $network_id, CreateNetworkFirmwareUpgradesRollback $create_network_firmware_upgrades_rollback) : Request

Parameters

$network_id : string: (required)
$create_network_firmware_upgrades_rollback : CreateNetworkFirmwareUpgradesRollback: (required)

Tags

Return values

Request —

createNetworkFloorPlanRequest()

Create request for operation 'createNetworkFloorPlan'


    protected
                createNetworkFloorPlanRequest(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : Request

Parameters

$network_id : string: (required)
$create_network_floor_plan : CreateNetworkFloorPlan: (required)

Tags

Return values

Request —

createNetworkGroupPolicyRequest()

Create request for operation 'createNetworkGroupPolicy'


    protected
                createNetworkGroupPolicyRequest(string $network_id, CreateNetworkGroupPolicy $create_network_group_policy) : Request

Parameters

$network_id : string: (required)
$create_network_group_policy : CreateNetworkGroupPolicy: (required)

Tags

Return values

Request —

createNetworkMerakiAuthUserRequest()

Create request for operation 'createNetworkMerakiAuthUser'


    protected
                createNetworkMerakiAuthUserRequest(string $network_id, CreateNetworkMerakiAuthUser $create_network_meraki_auth_user) : Request

Parameters

$network_id : string: (required)
$create_network_meraki_auth_user : CreateNetworkMerakiAuthUser: (required)

Tags

Return values

Request —

createNetworkMqttBrokerRequest()

Create request for operation 'createNetworkMqttBroker'


    protected
                createNetworkMqttBrokerRequest(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : Request

Parameters

$network_id : string: (required)
$create_network_mqtt_broker : CreateNetworkMqttBroker: (required)

Tags

Return values

Request —

createNetworkPiiRequestRequest()

Create request for operation 'createNetworkPiiRequest'


    protected
                createNetworkPiiRequestRequest(string $network_id[, CreateNetworkPiiRequest $create_network_pii_request = null ]) : Request

Parameters

$network_id : string: (required)
$create_network_pii_request : CreateNetworkPiiRequest = null: (optional)

Tags

Return values

Request —

createNetworkWebhooksHttpServerRequest()

Create request for operation 'createNetworkWebhooksHttpServer'


    protected
                createNetworkWebhooksHttpServerRequest(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : Request

Parameters

$network_id : string: (required)
$create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer: (required)

Tags

Return values

Request —

createNetworkWebhooksWebhookTestRequest()

Create request for operation 'createNetworkWebhooksWebhookTest'


    protected
                createNetworkWebhooksWebhookTestRequest(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : Request

Parameters

$network_id : string: (required)
$create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest: (required)

Tags

Return values

Request —

createOrganizationNetworkRequest()

Create request for operation 'createOrganizationNetwork'


    protected
                createOrganizationNetworkRequest(string $organization_id, CreateOrganizationNetwork $create_organization_network) : Request

Parameters

$organization_id : string: (required)
$create_organization_network : CreateOrganizationNetwork: (required)

Tags

Return values

Request —

deleteNetworkFloorPlanRequest()

Create request for operation 'deleteNetworkFloorPlan'


    protected
                deleteNetworkFloorPlanRequest(string $network_id, string $floor_plan_id) : Request

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)

Tags

Return values

Request —

deleteNetworkGroupPolicyRequest()

Create request for operation 'deleteNetworkGroupPolicy'


    protected
                deleteNetworkGroupPolicyRequest(string $network_id, string $group_policy_id) : Request

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)

Tags

Return values

Request —

deleteNetworkMerakiAuthUserRequest()

Create request for operation 'deleteNetworkMerakiAuthUser'


    protected
                deleteNetworkMerakiAuthUserRequest(string $network_id, string $meraki_auth_user_id) : Request

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)

Tags

Return values

Request —

deleteNetworkMqttBrokerRequest()

Create request for operation 'deleteNetworkMqttBroker'


    protected
                deleteNetworkMqttBrokerRequest(string $network_id, string $mqtt_broker_id) : Request

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)

Tags

Return values

Request —

deleteNetworkPiiRequestRequest()

Create request for operation 'deleteNetworkPiiRequest'


    protected
                deleteNetworkPiiRequestRequest(string $network_id, string $request_id) : Request

Parameters

$network_id : string: (required)
$request_id : string: (required)

Tags

Return values

Request —

deleteNetworkRequest()

Create request for operation 'deleteNetwork'


    protected
                deleteNetworkRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

deleteNetworkWebhooksHttpServerRequest()

Create request for operation 'deleteNetworkWebhooksHttpServer'


    protected
                deleteNetworkWebhooksHttpServerRequest(string $network_id, string $http_server_id) : Request

Parameters

$network_id : string: (required)
$http_server_id : string: (required)

Tags

Return values

Request —

getNetworkAlertsSettingsRequest()

Create request for operation 'getNetworkAlertsSettings'


    protected
                getNetworkAlertsSettingsRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkBluetoothClientRequest()

Create request for operation 'getNetworkBluetoothClient'


    protected
                getNetworkBluetoothClientRequest(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : Request

Parameters

$network_id : string: (required)
$bluetooth_client_id : string: (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

Request —

getNetworkBluetoothClientsRequest()

Create request for operation 'getNetworkBluetoothClients'


    protected
                getNetworkBluetoothClientsRequest(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

Request —

getNetworkClientPolicyRequest()

Create request for operation 'getNetworkClientPolicy'


    protected
                getNetworkClientPolicyRequest(string $network_id, string $client_id) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

Request —

getNetworkClientRequest()

Create request for operation 'getNetworkClient'


    protected
                getNetworkClientRequest(string $network_id, string $client_id) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

Request —

getNetworkClientsApplicationUsageRequest()

Create request for operation 'getNetworkClientsApplicationUsage'


    protected
                getNetworkClientsApplicationUsageRequest(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : Request

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

Request —

getNetworkClientsOverviewRequest()

Create request for operation 'getNetworkClientsOverview'


    protected
                getNetworkClientsOverviewRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

Request —

getNetworkClientSplashAuthorizationStatusRequest()

Create request for operation 'getNetworkClientSplashAuthorizationStatus'


    protected
                getNetworkClientSplashAuthorizationStatusRequest(string $network_id, string $client_id) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

Request —

getNetworkClientsRequest()

Create request for operation 'getNetworkClients'


    protected
                getNetworkClientsRequest(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

Request —

getNetworkClientsUsageHistoriesRequest()

Create request for operation 'getNetworkClientsUsageHistories'


    protected
                getNetworkClientsUsageHistoriesRequest(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : Request

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

Request —

getNetworkClientTrafficHistoryRequest()

Create request for operation 'getNetworkClientTrafficHistory'


    protected
                getNetworkClientTrafficHistoryRequest(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkClientUsageHistoryRequest()

Create request for operation 'getNetworkClientUsageHistory'


    protected
                getNetworkClientUsageHistoryRequest(string $network_id, string $client_id) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

Request —

getNetworkDevicesRequest()

Create request for operation 'getNetworkDevices'


    protected
                getNetworkDevicesRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkEventsEventTypesRequest()

Create request for operation 'getNetworkEventsEventTypes'


    protected
                getNetworkEventsEventTypesRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkEventsRequest()

Create request for operation 'getNetworkEvents'


    protected
                getNetworkEventsRequest(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkFirmwareUpgradesRequest()

Create request for operation 'getNetworkFirmwareUpgrades'


    protected
                getNetworkFirmwareUpgradesRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkFloorPlanRequest()

Create request for operation 'getNetworkFloorPlan'


    protected
                getNetworkFloorPlanRequest(string $network_id, string $floor_plan_id) : Request

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)

Tags

Return values

Request —

getNetworkFloorPlansRequest()

Create request for operation 'getNetworkFloorPlans'


    protected
                getNetworkFloorPlansRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkGroupPoliciesRequest()

Create request for operation 'getNetworkGroupPolicies'


    protected
                getNetworkGroupPoliciesRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkGroupPolicyRequest()

Create request for operation 'getNetworkGroupPolicy'


    protected
                getNetworkGroupPolicyRequest(string $network_id, string $group_policy_id) : Request

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)

Tags

Return values

Request —

getNetworkMerakiAuthUserRequest()

Create request for operation 'getNetworkMerakiAuthUser'


    protected
                getNetworkMerakiAuthUserRequest(string $network_id, string $meraki_auth_user_id) : Request

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)

Tags

Return values

Request —

getNetworkMerakiAuthUsersRequest()

Create request for operation 'getNetworkMerakiAuthUsers'


    protected
                getNetworkMerakiAuthUsersRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkMqttBrokerRequest()

Create request for operation 'getNetworkMqttBroker'


    protected
                getNetworkMqttBrokerRequest(string $network_id, string $mqtt_broker_id) : Request

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)

Tags

Return values

Request —

getNetworkMqttBrokersRequest()

Create request for operation 'getNetworkMqttBrokers'


    protected
                getNetworkMqttBrokersRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkNetflowRequest()

Create request for operation 'getNetworkNetflow'


    protected
                getNetworkNetflowRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkNetworkHealthChannelUtilizationRequest()

Create request for operation 'getNetworkNetworkHealthChannelUtilization'


    protected
                getNetworkNetworkHealthChannelUtilizationRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkPiiPiiKeysRequest()

Create request for operation 'getNetworkPiiPiiKeys'


    protected
                getNetworkPiiPiiKeysRequest(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : Request

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

Request —

getNetworkPiiRequestRequest()

Create request for operation 'getNetworkPiiRequest'


    protected
                getNetworkPiiRequestRequest(string $network_id, string $request_id) : Request

Parameters

$network_id : string: (required)
$request_id : string: (required)

Tags

Return values

Request —

getNetworkPiiRequestsRequest()

Create request for operation 'getNetworkPiiRequests'


    protected
                getNetworkPiiRequestsRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkPiiSmDevicesForKeyRequest()

Create request for operation 'getNetworkPiiSmDevicesForKey'


    protected
                getNetworkPiiSmDevicesForKeyRequest(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : Request

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

Request —

getNetworkPiiSmOwnersForKeyRequest()

Create request for operation 'getNetworkPiiSmOwnersForKey'


    protected
                getNetworkPiiSmOwnersForKeyRequest(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : Request

Parameters

$network_id : string: (required)
$username : string = null: The username of a Systems Manager user (optional)
$email : string = null: The email of a network user account or a Systems Manager device (optional)
$mac : string = null: The MAC of a network client device or a Systems Manager device (optional)
$serial : string = null: The serial of a Systems Manager device (optional)
$imei : string = null: The IMEI of a Systems Manager device (optional)
$bluetooth_mac : string = null: The MAC of a Bluetooth client (optional)

Tags

Return values

Request —

getNetworkRequest()

Create request for operation 'getNetwork'


    protected
                getNetworkRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkSettingsRequest()

Create request for operation 'getNetworkSettings'


    protected
                getNetworkSettingsRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkSnmpRequest()

Create request for operation 'getNetworkSnmp'


    protected
                getNetworkSnmpRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkSplashLoginAttemptsRequest()

Create request for operation 'getNetworkSplashLoginAttempts'


    protected
                getNetworkSplashLoginAttemptsRequest(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : Request

Parameters

$network_id : string: (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

Request —

getNetworkSyslogServersRequest()

Create request for operation 'getNetworkSyslogServers'


    protected
                getNetworkSyslogServersRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkTrafficAnalysisRequest()

Create request for operation 'getNetworkTrafficAnalysis'


    protected
                getNetworkTrafficAnalysisRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkTrafficRequest()

Create request for operation 'getNetworkTraffic'


    protected
                getNetworkTrafficRequest(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

Request —

getNetworkTrafficShapingApplicationCategoriesRequest()

Create request for operation 'getNetworkTrafficShapingApplicationCategories'


    protected
                getNetworkTrafficShapingApplicationCategoriesRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkTrafficShapingDscpTaggingOptionsRequest()

Create request for operation 'getNetworkTrafficShapingDscpTaggingOptions'


    protected
                getNetworkTrafficShapingDscpTaggingOptionsRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkWebhooksHttpServerRequest()

Create request for operation 'getNetworkWebhooksHttpServer'


    protected
                getNetworkWebhooksHttpServerRequest(string $network_id, string $http_server_id) : Request

Parameters

$network_id : string: (required)
$http_server_id : string: (required)

Tags

Return values

Request —

getNetworkWebhooksHttpServersRequest()

Create request for operation 'getNetworkWebhooksHttpServers'


    protected
                getNetworkWebhooksHttpServersRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkWebhooksWebhookTestRequest()

Create request for operation 'getNetworkWebhooksWebhookTest'


    protected
                getNetworkWebhooksWebhookTestRequest(string $network_id, string $webhook_test_id) : Request

Parameters

$network_id : string: (required)
$webhook_test_id : string: (required)

Tags

Return values

Request —

getOrganizationNetworksRequest()

Create request for operation 'getOrganizationNetworks'


    protected
                getOrganizationNetworksRequest(string $organization_id[, string $config_template_id = null ][, array<string|int, string> $tags = null ][, string $tags_filter_type = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$organization_id : string: (required)
$config_template_id : string = null: An optional parameter that is the ID of a config template. Will return all networks bound to that template. (optional)
$tags : array<string|int, string> = null: An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). (optional)
$tags_filter_type : string = null: An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

provisionNetworkClientsRequest()

Create request for operation 'provisionNetworkClients'


    protected
                provisionNetworkClientsRequest(string $network_id, ProvisionNetworkClients $provision_network_clients) : Request

Parameters

$network_id : string: (required)
$provision_network_clients : ProvisionNetworkClients: (required)

Tags

Return values

Request —

removeNetworkDevicesRequest()

Create request for operation 'removeNetworkDevices'


    protected
                removeNetworkDevicesRequest(string $network_id, RemoveNetworkDevices $remove_network_devices) : Request

Parameters

$network_id : string: (required)
$remove_network_devices : RemoveNetworkDevices: (required)

Tags

Return values

Request —

splitNetworkRequest()

Create request for operation 'splitNetwork'


    protected
                splitNetworkRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

unbindNetworkRequest()

Create request for operation 'unbindNetwork'


    protected
                unbindNetworkRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

updateNetworkAlertsSettingsRequest()

Create request for operation 'updateNetworkAlertsSettings'


    protected
                updateNetworkAlertsSettingsRequest(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : Request

Parameters

$network_id : string: (required)
$update_network_alerts_settings : UpdateNetworkAlertsSettings = null: (optional)

Tags

Return values

Request —

updateNetworkClientPolicyRequest()

Create request for operation 'updateNetworkClientPolicy'


    protected
                updateNetworkClientPolicyRequest(string $network_id, string $client_id, UpdateNetworkClientPolicy $update_network_client_policy) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$update_network_client_policy : UpdateNetworkClientPolicy: (required)

Tags

Return values

Request —

updateNetworkClientSplashAuthorizationStatusRequest()

Create request for operation 'updateNetworkClientSplashAuthorizationStatus'


    protected
                updateNetworkClientSplashAuthorizationStatusRequest(string $network_id, string $client_id, UpdateNetworkClientSplashAuthorizationStatus $update_network_client_splash_authorization_status) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$update_network_client_splash_authorization_status : UpdateNetworkClientSplashAuthorizationStatus: (required)

Tags

Return values

Request —

updateNetworkFirmwareUpgradesRequest()

Create request for operation 'updateNetworkFirmwareUpgrades'


    protected
                updateNetworkFirmwareUpgradesRequest(string $network_id[, UpdateNetworkFirmwareUpgrades $update_network_firmware_upgrades = null ]) : Request

Parameters

$network_id : string: (required)
$update_network_firmware_upgrades : UpdateNetworkFirmwareUpgrades = null: (optional)

Tags

Return values

Request —

updateNetworkFloorPlanRequest()

Create request for operation 'updateNetworkFloorPlan'


    protected
                updateNetworkFloorPlanRequest(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : Request

Parameters

$network_id : string: (required)
$floor_plan_id : string: (required)
$update_network_floor_plan : UpdateNetworkFloorPlan = null: (optional)

Tags

Return values

Request —

updateNetworkGroupPolicyRequest()

Create request for operation 'updateNetworkGroupPolicy'


    protected
                updateNetworkGroupPolicyRequest(string $network_id, string $group_policy_id[, UpdateNetworkGroupPolicy $update_network_group_policy = null ]) : Request

Parameters

$network_id : string: (required)
$group_policy_id : string: (required)
$update_network_group_policy : UpdateNetworkGroupPolicy = null: (optional)

Tags

Return values

Request —

updateNetworkMerakiAuthUserRequest()

Create request for operation 'updateNetworkMerakiAuthUser'


    protected
                updateNetworkMerakiAuthUserRequest(string $network_id, string $meraki_auth_user_id[, UpdateNetworkMerakiAuthUser $update_network_meraki_auth_user = null ]) : Request

Parameters

$network_id : string: (required)
$meraki_auth_user_id : string: (required)
$update_network_meraki_auth_user : UpdateNetworkMerakiAuthUser = null: (optional)

Tags

Return values

Request —

updateNetworkMqttBrokerRequest()

Create request for operation 'updateNetworkMqttBroker'


    protected
                updateNetworkMqttBrokerRequest(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : Request

Parameters

$network_id : string: (required)
$mqtt_broker_id : string: (required)
$update_network_mqtt_broker : UpdateNetworkMqttBroker = null: (optional)

Tags

Return values

Request —

updateNetworkNetflowRequest()

Create request for operation 'updateNetworkNetflow'


    protected
                updateNetworkNetflowRequest(string $network_id[, UpdateNetworkNetflow $update_network_netflow = null ]) : Request

Parameters

$network_id : string: (required)
$update_network_netflow : UpdateNetworkNetflow = null: (optional)

Tags

Return values

Request —

updateNetworkRequest()

Create request for operation 'updateNetwork'


    protected
                updateNetworkRequest(string $network_id[, UpdateNetwork $update_network = null ]) : Request

Parameters

$network_id : string: (required)
$update_network : UpdateNetwork = null: (optional)

Tags

Return values

Request —

updateNetworkSettingsRequest()

Create request for operation 'updateNetworkSettings'


    protected
                updateNetworkSettingsRequest(string $network_id[, UpdateNetworkSettings $update_network_settings = null ]) : Request

Parameters

$network_id : string: (required)
$update_network_settings : UpdateNetworkSettings = null: (optional)

Tags

Return values

Request —

updateNetworkSnmpRequest()

Create request for operation 'updateNetworkSnmp'


    protected
                updateNetworkSnmpRequest(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : Request

Parameters

$network_id : string: (required)
$update_network_snmp : UpdateNetworkSnmp = null: (optional)

Tags

Return values

Request —

updateNetworkSyslogServersRequest()

Create request for operation 'updateNetworkSyslogServers'


    protected
                updateNetworkSyslogServersRequest(string $network_id, UpdateNetworkSyslogServers $update_network_syslog_servers) : Request

Parameters

$network_id : string: (required)
$update_network_syslog_servers : UpdateNetworkSyslogServers: (required)

Tags

Return values

Request —

updateNetworkTrafficAnalysisRequest()

Create request for operation 'updateNetworkTrafficAnalysis'


    protected
                updateNetworkTrafficAnalysisRequest(string $network_id[, UpdateNetworkTrafficAnalysis $update_network_traffic_analysis = null ]) : Request

Parameters

$network_id : string: (required)
$update_network_traffic_analysis : UpdateNetworkTrafficAnalysis = null: (optional)

Tags

Return values

Request —

updateNetworkWebhooksHttpServerRequest()

Create request for operation 'updateNetworkWebhooksHttpServer'


    protected
                updateNetworkWebhooksHttpServerRequest(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : Request

Parameters

$network_id : string: (required)
$http_server_id : string: (required)
$update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null: (optional)

Tags

Return values

Request —

NetworksApi

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

bindNetwork()

Parameters

Tags

Return values

bindNetworkAsync()

Parameters

Tags

Return values

bindNetworkAsyncWithHttpInfo()

Parameters

Tags

Return values

bindNetworkWithHttpInfo()

Parameters

Tags

Return values

claimNetworkDevices()

Parameters

Tags

Return values

claimNetworkDevicesAsync()

Parameters

Tags

Return values

claimNetworkDevicesAsyncWithHttpInfo()

Parameters

Tags

Return values

claimNetworkDevicesWithHttpInfo()

Parameters

Tags

Return values

combineOrganizationNetworks()

Parameters

Tags

Return values

combineOrganizationNetworksAsync()

Parameters

Tags

Return values

combineOrganizationNetworksAsyncWithHttpInfo()

Parameters

Tags

Return values

combineOrganizationNetworksWithHttpInfo()

Parameters

Tags

Return values

createNetworkFirmwareUpgradesRollback()

Parameters

Tags

Return values

createNetworkFirmwareUpgradesRollbackAsync()

Parameters

Tags

Return values

createNetworkFirmwareUpgradesRollbackAsyncWithHttpInfo()

Parameters

Tags

Return values

createNetworkFirmwareUpgradesRollbackWithHttpInfo()

Parameters

Tags

Return values

createNetworkFloorPlan()

Parameters

Tags

Return values

createNetworkFloorPlanAsync()