FailedConnectionsApi
FailedConnectionsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkWirelessFailedConnections() : object
- Operation getNetworkWirelessFailedConnections
- getNetworkWirelessFailedConnectionsAsync() : PromiseInterface
- Operation getNetworkWirelessFailedConnectionsAsync
- getNetworkWirelessFailedConnectionsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWirelessFailedConnectionsAsyncWithHttpInfo
- getNetworkWirelessFailedConnectionsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWirelessFailedConnectionsWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkWirelessFailedConnectionsRequest() : Request
- Create request for operation 'getNetworkWirelessFailedConnections'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__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 —getNetworkWirelessFailedConnections()
Operation getNetworkWirelessFailedConnections
public
getNetworkWirelessFailedConnections(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 $serial = null ][, string $client_id = null ]) : object
List of all failed client connection events on this network in a given time range
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)
- $serial : string = null
-
Filter by AP (optional)
- $client_id : string = null
-
Filter by client MAC (optional)
Tags
Return values
object —getNetworkWirelessFailedConnectionsAsync()
Operation getNetworkWirelessFailedConnectionsAsync
public
getNetworkWirelessFailedConnectionsAsync(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 $serial = null ][, string $client_id = null ]) : PromiseInterface
List of all failed client connection events on this network in a given time range
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)
- $serial : string = null
-
Filter by AP (optional)
- $client_id : string = null
-
Filter by client MAC (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessFailedConnectionsAsyncWithHttpInfo()
Operation getNetworkWirelessFailedConnectionsAsyncWithHttpInfo
public
getNetworkWirelessFailedConnectionsAsyncWithHttpInfo(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 $serial = null ][, string $client_id = null ]) : PromiseInterface
List of all failed client connection events on this network in a given time range
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)
- $serial : string = null
-
Filter by AP (optional)
- $client_id : string = null
-
Filter by client MAC (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessFailedConnectionsWithHttpInfo()
Operation getNetworkWirelessFailedConnectionsWithHttpInfo
public
getNetworkWirelessFailedConnectionsWithHttpInfo(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 $serial = null ][, string $client_id = null ]) : array<string|int, mixed>
List of all failed client connection events on this network in a given time range
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)
- $serial : string = null
-
Filter by AP (optional)
- $client_id : string = null
-
Filter by client MAC (optional)
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
getNetworkWirelessFailedConnectionsRequest()
Create request for operation 'getNetworkWirelessFailedConnections'
protected
getNetworkWirelessFailedConnectionsRequest(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 $serial = null ][, string $client_id = 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)
- $serial : string = null
-
Filter by AP (optional)
- $client_id : string = null
-
Filter by client MAC (optional)