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 —

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getDeviceClients()

Operation getDeviceClients


    public
                getDeviceClients(string $serial[, string $t0 = null ][, float $timespan = null ]) : object

List the clients of a device, up to a maximum of a month ago

Parameters

$serial : string: serial (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)

Tags

Return values

object —

getDeviceClientsAsync()

Operation getDeviceClientsAsync


    public
                getDeviceClientsAsync(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

List the clients of a device, up to a maximum of a month ago

Parameters

$serial : 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)

Tags

Return values

PromiseInterface —

getDeviceClientsAsyncWithHttpInfo()

Operation getDeviceClientsAsyncWithHttpInfo


    public
                getDeviceClientsAsyncWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

List the clients of a device, up to a maximum of a month ago

Parameters

$serial : 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)

Tags

Return values

PromiseInterface —

getDeviceClientsWithHttpInfo()

Operation getDeviceClientsWithHttpInfo


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

List the clients of a device, up to a maximum of a month ago

Parameters

$serial : 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)

Tags

Return values

array<string|int, mixed> —

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

getNetworkApplianceClientSecurityEvents()

Operation getNetworkApplianceClientSecurityEvents


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

List the security events for a client

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 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 791 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (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)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

object —

getNetworkApplianceClientSecurityEventsAsync()

Operation getNetworkApplianceClientSecurityEventsAsync


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

List the security events for a client

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 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 791 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (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)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

PromiseInterface —

getNetworkApplianceClientSecurityEventsAsyncWithHttpInfo()

Operation getNetworkApplianceClientSecurityEventsAsyncWithHttpInfo


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

List the security events for a client

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 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 791 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (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)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

PromiseInterface —

getNetworkApplianceClientSecurityEventsWithHttpInfo()

Operation getNetworkApplianceClientSecurityEventsWithHttpInfo


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

List the security events for a client

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 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 791 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (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)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (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)

getNetworkWirelessClientConnectionStats()

Operation getNetworkWirelessClientConnectionStats


    public
                getNetworkWirelessClientConnectionStats(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : object

Aggregated connectivity info for a given client on this network

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

object —

getNetworkWirelessClientConnectionStatsAsync()

Operation getNetworkWirelessClientConnectionStatsAsync


    public
                getNetworkWirelessClientConnectionStatsAsync(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientConnectionStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientConnectionStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientConnectionStatsAsyncWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientConnectionStatsWithHttpInfo()

Operation getNetworkWirelessClientConnectionStatsWithHttpInfo


    public
                getNetworkWirelessClientConnectionStatsWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : array<string|int, mixed>

Aggregated connectivity info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

array<string|int, mixed> —

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

getNetworkWirelessClientConnectivityEvents()

Operation getNetworkWirelessClientConnectivityEvents


    public
                getNetworkWirelessClientConnectivityEvents(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : object

List the wireless connectivity events for a client within a network in the timespan.

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)
$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)
$types : array<string|int, string> = null: A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
$included_severities : array<string|int, string> = null: A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

object —

getNetworkWirelessClientConnectivityEventsAsync()

Operation getNetworkWirelessClientConnectivityEventsAsync


    public
                getNetworkWirelessClientConnectivityEventsAsync(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : PromiseInterface

List the wireless connectivity events for a client within a network in the timespan.

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)
$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)
$types : array<string|int, string> = null: A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
$included_severities : array<string|int, string> = null: A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo()

Operation getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo


    public
                getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : PromiseInterface

List the wireless connectivity events for a client within a network in the timespan.

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)
$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)
$types : array<string|int, string> = null: A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
$included_severities : array<string|int, string> = null: A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientConnectivityEventsWithHttpInfo()

Operation getNetworkWirelessClientConnectivityEventsWithHttpInfo


    public
                getNetworkWirelessClientConnectivityEventsWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : array<string|int, mixed>

List the wireless connectivity events for a client within a network in the timespan.

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)
$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)
$types : array<string|int, string> = null: A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
$included_severities : array<string|int, string> = null: A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

array<string|int, mixed> —

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

getNetworkWirelessClientLatencyHistory()

Operation getNetworkWirelessClientLatencyHistory


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

Return the latency history for a client

Parameters

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

Tags

Return values

object —

getNetworkWirelessClientLatencyHistoryAsync()

Operation getNetworkWirelessClientLatencyHistoryAsync


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

Return the latency history for a client

Parameters

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

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo()

Operation getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo


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

Return the latency history for a client

Parameters

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

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyHistoryWithHttpInfo()

Operation getNetworkWirelessClientLatencyHistoryWithHttpInfo


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

Return the latency history for a client

Parameters

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

Tags

Return values

array<string|int, mixed> —

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

getNetworkWirelessClientLatencyStats()

Operation getNetworkWirelessClientLatencyStats


    public
                getNetworkWirelessClientLatencyStats(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for a given client on this network

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

object —

getNetworkWirelessClientLatencyStatsAsync()

Operation getNetworkWirelessClientLatencyStatsAsync


    public
                getNetworkWirelessClientLatencyStatsAsync(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyStatsWithHttpInfo()

Operation getNetworkWirelessClientLatencyStatsWithHttpInfo


    public
                getNetworkWirelessClientLatencyStatsWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

array<string|int, mixed> —

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

getNetworkWirelessClientsConnectionStats()

Operation getNetworkWirelessClientsConnectionStats


    public
                getNetworkWirelessClientsConnectionStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : object

Aggregated connectivity info for this network, grouped by clients

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

object —

getNetworkWirelessClientsConnectionStatsAsync()

Operation getNetworkWirelessClientsConnectionStatsAsync


    public
                getNetworkWirelessClientsConnectionStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsConnectionStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientsConnectionStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientsConnectionStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsConnectionStatsWithHttpInfo()

Operation getNetworkWirelessClientsConnectionStatsWithHttpInfo


    public
                getNetworkWirelessClientsConnectionStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : array<string|int, mixed>

Aggregated connectivity info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

array<string|int, mixed> —

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

getNetworkWirelessClientsLatencyStats()

Operation getNetworkWirelessClientsLatencyStats


    public
                getNetworkWirelessClientsLatencyStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

object —

getNetworkWirelessClientsLatencyStatsAsync()

Operation getNetworkWirelessClientsLatencyStatsAsync


    public
                getNetworkWirelessClientsLatencyStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsLatencyStatsWithHttpInfo()

Operation getNetworkWirelessClientsLatencyStatsWithHttpInfo


    public
                getNetworkWirelessClientsLatencyStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (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)

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)

createHttpClientOption()

Create http client option


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

Tags

Return values

array<string|int, mixed> —

of http client options

getDeviceClientsRequest()

Create request for operation 'getDeviceClients'


    protected
                getDeviceClientsRequest(string $serial[, string $t0 = null ][, float $timespan = null ]) : Request

Parameters

$serial : 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)

Tags

Return values

Request —

getNetworkApplianceClientSecurityEventsRequest()

Create request for operation 'getNetworkApplianceClientSecurityEvents'


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

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 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 791 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (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)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (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 —

getNetworkWirelessClientConnectionStatsRequest()

Create request for operation 'getNetworkWirelessClientConnectionStats'


    protected
                getNetworkWirelessClientConnectionStatsRequest(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

Request —

getNetworkWirelessClientConnectivityEventsRequest()

Create request for operation 'getNetworkWirelessClientConnectivityEvents'


    protected
                getNetworkWirelessClientConnectivityEventsRequest(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = 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)
$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)
$types : array<string|int, string> = null: A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'. (optional)
$included_severities : array<string|int, string> = null: A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

Request —

getNetworkWirelessClientLatencyHistoryRequest()

Create request for operation 'getNetworkWirelessClientLatencyHistory'


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

Parameters

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

Tags

Return values

Request —

getNetworkWirelessClientLatencyStatsRequest()

Create request for operation 'getNetworkWirelessClientLatencyStats'


    protected
                getNetworkWirelessClientLatencyStatsRequest(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

Request —

getNetworkWirelessClientsConnectionStatsRequest()

Create request for operation 'getNetworkWirelessClientsConnectionStats'


    protected
                getNetworkWirelessClientsConnectionStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

Request —

getNetworkWirelessClientsLatencyStatsRequest()

Create request for operation 'getNetworkWirelessClientsLatencyStats'


    protected
                getNetworkWirelessClientsLatencyStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (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 —

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 —

ClientsApi

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

getConfig()

Return values

getDeviceClients()

Parameters

Tags

Return values

getDeviceClientsAsync()

Parameters

Tags

Return values

getDeviceClientsAsyncWithHttpInfo()

Parameters

Tags

Return values

getDeviceClientsWithHttpInfo()

Parameters

Tags

Return values

getNetworkApplianceClientSecurityEvents()

Parameters

Tags

Return values

getNetworkApplianceClientSecurityEventsAsync()

Parameters

Tags

Return values

getNetworkApplianceClientSecurityEventsAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkApplianceClientSecurityEventsWithHttpInfo()

Parameters

Tags

Return values

getNetworkClient()

Parameters

Tags

Return values

getNetworkClientAsync()

Parameters

Tags

Return values

getNetworkClientAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkClientPolicy()

Parameters

Tags

Return values

getNetworkClientPolicyAsync()

Parameters

Tags

Return values

getNetworkClientPolicyAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkClientPolicyWithHttpInfo()

Parameters

Tags

Return values

getNetworkClients()

Parameters

Tags

Return values

getNetworkClientsApplicationUsage()

Parameters

Tags