UplinksApi
UplinksApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getOrganizationUplinksStatuses() : object
- Operation getOrganizationUplinksStatuses
- getOrganizationUplinksStatusesAsync() : PromiseInterface
- Operation getOrganizationUplinksStatusesAsync
- getOrganizationUplinksStatusesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationUplinksStatusesAsyncWithHttpInfo
- getOrganizationUplinksStatusesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationUplinksStatusesWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getOrganizationUplinksStatusesRequest() : Request
- Create request for operation 'getOrganizationUplinksStatuses'
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 —getOrganizationUplinksStatuses()
Operation getOrganizationUplinksStatuses
public
getOrganizationUplinksStatuses(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : object
List the uplink status of every Meraki MX, MG and Z series devices in the organization
Parameters
- $organization_id : string
-
organization_id (required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
- $iccids : array<string|int, string> = null
-
A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)
Tags
Return values
object —getOrganizationUplinksStatusesAsync()
Operation getOrganizationUplinksStatusesAsync
public
getOrganizationUplinksStatusesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : PromiseInterface
List the uplink status of every Meraki MX, MG and Z series devices in the organization
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
- $iccids : array<string|int, string> = null
-
A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)
Tags
Return values
PromiseInterface —getOrganizationUplinksStatusesAsyncWithHttpInfo()
Operation getOrganizationUplinksStatusesAsyncWithHttpInfo
public
getOrganizationUplinksStatusesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : PromiseInterface
List the uplink status of every Meraki MX, MG and Z series devices in the organization
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
- $iccids : array<string|int, string> = null
-
A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)
Tags
Return values
PromiseInterface —getOrganizationUplinksStatusesWithHttpInfo()
Operation getOrganizationUplinksStatusesWithHttpInfo
public
getOrganizationUplinksStatusesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : array<string|int, mixed>
List the uplink status of every Meraki MX, MG and Z series devices in the organization
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
- $iccids : array<string|int, string> = null
-
A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (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
getOrganizationUplinksStatusesRequest()
Create request for operation 'getOrganizationUplinksStatuses'
protected
getOrganizationUplinksStatusesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
- $iccids : array<string|int, string> = null
-
A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)