UplinkApi
UplinkApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkCellularGatewayUplink() : object
- Operation getNetworkCellularGatewayUplink
- getNetworkCellularGatewayUplinkAsync() : PromiseInterface
- Operation getNetworkCellularGatewayUplinkAsync
- getNetworkCellularGatewayUplinkAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkCellularGatewayUplinkAsyncWithHttpInfo
- getNetworkCellularGatewayUplinkWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkCellularGatewayUplinkWithHttpInfo
- getOrganizationApplianceUplinkStatuses() : object
- Operation getOrganizationApplianceUplinkStatuses
- getOrganizationApplianceUplinkStatusesAsync() : PromiseInterface
- Operation getOrganizationApplianceUplinkStatusesAsync
- getOrganizationApplianceUplinkStatusesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationApplianceUplinkStatusesAsyncWithHttpInfo
- getOrganizationApplianceUplinkStatusesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationApplianceUplinkStatusesWithHttpInfo
- getOrganizationCellularGatewayUplinkStatuses() : object
- Operation getOrganizationCellularGatewayUplinkStatuses
- getOrganizationCellularGatewayUplinkStatusesAsync() : PromiseInterface
- Operation getOrganizationCellularGatewayUplinkStatusesAsync
- getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo
- getOrganizationCellularGatewayUplinkStatusesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationCellularGatewayUplinkStatusesWithHttpInfo
- updateNetworkCellularGatewayUplink() : object
- Operation updateNetworkCellularGatewayUplink
- updateNetworkCellularGatewayUplinkAsync() : PromiseInterface
- Operation updateNetworkCellularGatewayUplinkAsync
- updateNetworkCellularGatewayUplinkAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkCellularGatewayUplinkAsyncWithHttpInfo
- updateNetworkCellularGatewayUplinkWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkCellularGatewayUplinkWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkCellularGatewayUplinkRequest() : Request
- Create request for operation 'getNetworkCellularGatewayUplink'
- getOrganizationApplianceUplinkStatusesRequest() : Request
- Create request for operation 'getOrganizationApplianceUplinkStatuses'
- getOrganizationCellularGatewayUplinkStatusesRequest() : Request
- Create request for operation 'getOrganizationCellularGatewayUplinkStatuses'
- updateNetworkCellularGatewayUplinkRequest() : Request
- Create request for operation 'updateNetworkCellularGatewayUplink'
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 —getNetworkCellularGatewayUplink()
Operation getNetworkCellularGatewayUplink
public
getNetworkCellularGatewayUplink(string $network_id) : object
Returns the uplink settings for your MG network.
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkCellularGatewayUplinkAsync()
Operation getNetworkCellularGatewayUplinkAsync
public
getNetworkCellularGatewayUplinkAsync(string $network_id) : PromiseInterface
Returns the uplink settings for your MG network.
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkCellularGatewayUplinkAsyncWithHttpInfo()
Operation getNetworkCellularGatewayUplinkAsyncWithHttpInfo
public
getNetworkCellularGatewayUplinkAsyncWithHttpInfo(string $network_id) : PromiseInterface
Returns the uplink settings for your MG network.
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkCellularGatewayUplinkWithHttpInfo()
Operation getNetworkCellularGatewayUplinkWithHttpInfo
public
getNetworkCellularGatewayUplinkWithHttpInfo(string $network_id) : array<string|int, mixed>
Returns the uplink settings for your MG network.
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationApplianceUplinkStatuses()
Operation getOrganizationApplianceUplinkStatuses
public
getOrganizationApplianceUplinkStatuses(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 and Z series appliances 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 —getOrganizationApplianceUplinkStatusesAsync()
Operation getOrganizationApplianceUplinkStatusesAsync
public
getOrganizationApplianceUplinkStatusesAsync(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 and Z series appliances 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 —getOrganizationApplianceUplinkStatusesAsyncWithHttpInfo()
Operation getOrganizationApplianceUplinkStatusesAsyncWithHttpInfo
public
getOrganizationApplianceUplinkStatusesAsyncWithHttpInfo(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 and Z series appliances 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 —getOrganizationApplianceUplinkStatusesWithHttpInfo()
Operation getOrganizationApplianceUplinkStatusesWithHttpInfo
public
getOrganizationApplianceUplinkStatusesWithHttpInfo(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 and Z series appliances 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)
getOrganizationCellularGatewayUplinkStatuses()
Operation getOrganizationCellularGatewayUplinkStatuses
public
getOrganizationCellularGatewayUplinkStatuses(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 MG cellular gateway 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 —getOrganizationCellularGatewayUplinkStatusesAsync()
Operation getOrganizationCellularGatewayUplinkStatusesAsync
public
getOrganizationCellularGatewayUplinkStatusesAsync(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 MG cellular gateway 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 —getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo()
Operation getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo
public
getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo(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 MG cellular gateway 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 —getOrganizationCellularGatewayUplinkStatusesWithHttpInfo()
Operation getOrganizationCellularGatewayUplinkStatusesWithHttpInfo
public
getOrganizationCellularGatewayUplinkStatusesWithHttpInfo(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 MG cellular gateway 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)
updateNetworkCellularGatewayUplink()
Operation updateNetworkCellularGatewayUplink
public
updateNetworkCellularGatewayUplink(string $network_id[, UpdateNetworkCellularGatewayUplink $update_network_cellular_gateway_uplink = null ]) : object
Updates the uplink settings for your MG network.
Parameters
- $network_id : string
-
network_id (required)
- $update_network_cellular_gateway_uplink : UpdateNetworkCellularGatewayUplink = null
-
update_network_cellular_gateway_uplink (optional)
Tags
Return values
object —updateNetworkCellularGatewayUplinkAsync()
Operation updateNetworkCellularGatewayUplinkAsync
public
updateNetworkCellularGatewayUplinkAsync(string $network_id[, UpdateNetworkCellularGatewayUplink $update_network_cellular_gateway_uplink = null ]) : PromiseInterface
Updates the uplink settings for your MG network.
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_uplink : UpdateNetworkCellularGatewayUplink = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkCellularGatewayUplinkAsyncWithHttpInfo()
Operation updateNetworkCellularGatewayUplinkAsyncWithHttpInfo
public
updateNetworkCellularGatewayUplinkAsyncWithHttpInfo(string $network_id[, UpdateNetworkCellularGatewayUplink $update_network_cellular_gateway_uplink = null ]) : PromiseInterface
Updates the uplink settings for your MG network.
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_uplink : UpdateNetworkCellularGatewayUplink = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkCellularGatewayUplinkWithHttpInfo()
Operation updateNetworkCellularGatewayUplinkWithHttpInfo
public
updateNetworkCellularGatewayUplinkWithHttpInfo(string $network_id[, UpdateNetworkCellularGatewayUplink $update_network_cellular_gateway_uplink = null ]) : array<string|int, mixed>
Updates the uplink settings for your MG network.
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_uplink : UpdateNetworkCellularGatewayUplink = null
-
(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
getNetworkCellularGatewayUplinkRequest()
Create request for operation 'getNetworkCellularGatewayUplink'
protected
getNetworkCellularGatewayUplinkRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —getOrganizationApplianceUplinkStatusesRequest()
Create request for operation 'getOrganizationApplianceUplinkStatuses'
protected
getOrganizationApplianceUplinkStatusesRequest(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)
Tags
Return values
Request —getOrganizationCellularGatewayUplinkStatusesRequest()
Create request for operation 'getOrganizationCellularGatewayUplinkStatuses'
protected
getOrganizationCellularGatewayUplinkStatusesRequest(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)
Tags
Return values
Request —updateNetworkCellularGatewayUplinkRequest()
Create request for operation 'updateNetworkCellularGatewayUplink'
protected
updateNetworkCellularGatewayUplinkRequest(string $network_id[, UpdateNetworkCellularGatewayUplink $update_network_cellular_gateway_uplink = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_uplink : UpdateNetworkCellularGatewayUplink = null
-
(optional)