CellularGatewayApi
CellularGatewayApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getDeviceCellularGatewayLan() : object
- Operation getDeviceCellularGatewayLan
- getDeviceCellularGatewayLanAsync() : PromiseInterface
- Operation getDeviceCellularGatewayLanAsync
- getDeviceCellularGatewayLanAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceCellularGatewayLanAsyncWithHttpInfo
- getDeviceCellularGatewayLanWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceCellularGatewayLanWithHttpInfo
- getDeviceCellularGatewayPortForwardingRules() : object
- Operation getDeviceCellularGatewayPortForwardingRules
- getDeviceCellularGatewayPortForwardingRulesAsync() : PromiseInterface
- Operation getDeviceCellularGatewayPortForwardingRulesAsync
- getDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo
- getDeviceCellularGatewayPortForwardingRulesWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceCellularGatewayPortForwardingRulesWithHttpInfo
- getNetworkCellularGatewayConnectivityMonitoringDestinations() : object
- Operation getNetworkCellularGatewayConnectivityMonitoringDestinations
- getNetworkCellularGatewayConnectivityMonitoringDestinationsAsync() : PromiseInterface
- Operation getNetworkCellularGatewayConnectivityMonitoringDestinationsAsync
- getNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo
- getNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo
- getNetworkCellularGatewayDhcp() : object
- Operation getNetworkCellularGatewayDhcp
- getNetworkCellularGatewayDhcpAsync() : PromiseInterface
- Operation getNetworkCellularGatewayDhcpAsync
- getNetworkCellularGatewayDhcpAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkCellularGatewayDhcpAsyncWithHttpInfo
- getNetworkCellularGatewayDhcpWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkCellularGatewayDhcpWithHttpInfo
- getNetworkCellularGatewaySubnetPool() : object
- Operation getNetworkCellularGatewaySubnetPool
- getNetworkCellularGatewaySubnetPoolAsync() : PromiseInterface
- Operation getNetworkCellularGatewaySubnetPoolAsync
- getNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo
- getNetworkCellularGatewaySubnetPoolWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkCellularGatewaySubnetPoolWithHttpInfo
- getNetworkCellularGatewayUplink() : object
- Operation getNetworkCellularGatewayUplink
- getNetworkCellularGatewayUplinkAsync() : PromiseInterface
- Operation getNetworkCellularGatewayUplinkAsync
- getNetworkCellularGatewayUplinkAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkCellularGatewayUplinkAsyncWithHttpInfo
- getNetworkCellularGatewayUplinkWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkCellularGatewayUplinkWithHttpInfo
- getOrganizationCellularGatewayUplinkStatuses() : object
- Operation getOrganizationCellularGatewayUplinkStatuses
- getOrganizationCellularGatewayUplinkStatusesAsync() : PromiseInterface
- Operation getOrganizationCellularGatewayUplinkStatusesAsync
- getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo
- getOrganizationCellularGatewayUplinkStatusesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationCellularGatewayUplinkStatusesWithHttpInfo
- updateDeviceCellularGatewayLan() : object
- Operation updateDeviceCellularGatewayLan
- updateDeviceCellularGatewayLanAsync() : PromiseInterface
- Operation updateDeviceCellularGatewayLanAsync
- updateDeviceCellularGatewayLanAsyncWithHttpInfo() : PromiseInterface
- Operation updateDeviceCellularGatewayLanAsyncWithHttpInfo
- updateDeviceCellularGatewayLanWithHttpInfo() : array<string|int, mixed>
- Operation updateDeviceCellularGatewayLanWithHttpInfo
- updateDeviceCellularGatewayPortForwardingRules() : object
- Operation updateDeviceCellularGatewayPortForwardingRules
- updateDeviceCellularGatewayPortForwardingRulesAsync() : PromiseInterface
- Operation updateDeviceCellularGatewayPortForwardingRulesAsync
- updateDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo() : PromiseInterface
- Operation updateDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo
- updateDeviceCellularGatewayPortForwardingRulesWithHttpInfo() : array<string|int, mixed>
- Operation updateDeviceCellularGatewayPortForwardingRulesWithHttpInfo
- updateNetworkCellularGatewayConnectivityMonitoringDestinations() : object
- Operation updateNetworkCellularGatewayConnectivityMonitoringDestinations
- updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsync() : PromiseInterface
- Operation updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsync
- updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo
- updateNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo
- updateNetworkCellularGatewayDhcp() : object
- Operation updateNetworkCellularGatewayDhcp
- updateNetworkCellularGatewayDhcpAsync() : PromiseInterface
- Operation updateNetworkCellularGatewayDhcpAsync
- updateNetworkCellularGatewayDhcpAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkCellularGatewayDhcpAsyncWithHttpInfo
- updateNetworkCellularGatewayDhcpWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkCellularGatewayDhcpWithHttpInfo
- updateNetworkCellularGatewaySubnetPool() : object
- Operation updateNetworkCellularGatewaySubnetPool
- updateNetworkCellularGatewaySubnetPoolAsync() : PromiseInterface
- Operation updateNetworkCellularGatewaySubnetPoolAsync
- updateNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo
- updateNetworkCellularGatewaySubnetPoolWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkCellularGatewaySubnetPoolWithHttpInfo
- 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
- getDeviceCellularGatewayLanRequest() : Request
- Create request for operation 'getDeviceCellularGatewayLan'
- getDeviceCellularGatewayPortForwardingRulesRequest() : Request
- Create request for operation 'getDeviceCellularGatewayPortForwardingRules'
- getNetworkCellularGatewayConnectivityMonitoringDestinationsRequest() : Request
- Create request for operation 'getNetworkCellularGatewayConnectivityMonitoringDestinations'
- getNetworkCellularGatewayDhcpRequest() : Request
- Create request for operation 'getNetworkCellularGatewayDhcp'
- getNetworkCellularGatewaySubnetPoolRequest() : Request
- Create request for operation 'getNetworkCellularGatewaySubnetPool'
- getNetworkCellularGatewayUplinkRequest() : Request
- Create request for operation 'getNetworkCellularGatewayUplink'
- getOrganizationCellularGatewayUplinkStatusesRequest() : Request
- Create request for operation 'getOrganizationCellularGatewayUplinkStatuses'
- updateDeviceCellularGatewayLanRequest() : Request
- Create request for operation 'updateDeviceCellularGatewayLan'
- updateDeviceCellularGatewayPortForwardingRulesRequest() : Request
- Create request for operation 'updateDeviceCellularGatewayPortForwardingRules'
- updateNetworkCellularGatewayConnectivityMonitoringDestinationsRequest() : Request
- Create request for operation 'updateNetworkCellularGatewayConnectivityMonitoringDestinations'
- updateNetworkCellularGatewayDhcpRequest() : Request
- Create request for operation 'updateNetworkCellularGatewayDhcp'
- updateNetworkCellularGatewaySubnetPoolRequest() : Request
- Create request for operation 'updateNetworkCellularGatewaySubnetPool'
- 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 —getDeviceCellularGatewayLan()
Operation getDeviceCellularGatewayLan
public
getDeviceCellularGatewayLan(string $serial) : object
Show the LAN Settings of a MG
Parameters
- $serial : string
-
serial (required)
Tags
Return values
object —getDeviceCellularGatewayLanAsync()
Operation getDeviceCellularGatewayLanAsync
public
getDeviceCellularGatewayLanAsync(string $serial) : PromiseInterface
Show the LAN Settings of a MG
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceCellularGatewayLanAsyncWithHttpInfo()
Operation getDeviceCellularGatewayLanAsyncWithHttpInfo
public
getDeviceCellularGatewayLanAsyncWithHttpInfo(string $serial) : PromiseInterface
Show the LAN Settings of a MG
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceCellularGatewayLanWithHttpInfo()
Operation getDeviceCellularGatewayLanWithHttpInfo
public
getDeviceCellularGatewayLanWithHttpInfo(string $serial) : array<string|int, mixed>
Show the LAN Settings of a MG
Parameters
- $serial : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getDeviceCellularGatewayPortForwardingRules()
Operation getDeviceCellularGatewayPortForwardingRules
public
getDeviceCellularGatewayPortForwardingRules(string $serial) : object
Returns the port forwarding rules for a single MG.
Parameters
- $serial : string
-
serial (required)
Tags
Return values
object —getDeviceCellularGatewayPortForwardingRulesAsync()
Operation getDeviceCellularGatewayPortForwardingRulesAsync
public
getDeviceCellularGatewayPortForwardingRulesAsync(string $serial) : PromiseInterface
Returns the port forwarding rules for a single MG.
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo()
Operation getDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo
public
getDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo(string $serial) : PromiseInterface
Returns the port forwarding rules for a single MG.
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceCellularGatewayPortForwardingRulesWithHttpInfo()
Operation getDeviceCellularGatewayPortForwardingRulesWithHttpInfo
public
getDeviceCellularGatewayPortForwardingRulesWithHttpInfo(string $serial) : array<string|int, mixed>
Returns the port forwarding rules for a single MG.
Parameters
- $serial : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkCellularGatewayConnectivityMonitoringDestinations()
Operation getNetworkCellularGatewayConnectivityMonitoringDestinations
public
getNetworkCellularGatewayConnectivityMonitoringDestinations(string $network_id) : object
Return the connectivity testing destinations for an MG network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkCellularGatewayConnectivityMonitoringDestinationsAsync()
Operation getNetworkCellularGatewayConnectivityMonitoringDestinationsAsync
public
getNetworkCellularGatewayConnectivityMonitoringDestinationsAsync(string $network_id) : PromiseInterface
Return the connectivity testing destinations for an MG network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo()
Operation getNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo
public
getNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo(string $network_id) : PromiseInterface
Return the connectivity testing destinations for an MG network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo()
Operation getNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo
public
getNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo(string $network_id) : array<string|int, mixed>
Return the connectivity testing destinations for an 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)
getNetworkCellularGatewayDhcp()
Operation getNetworkCellularGatewayDhcp
public
getNetworkCellularGatewayDhcp(string $network_id) : object
List common DHCP settings of MGs
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkCellularGatewayDhcpAsync()
Operation getNetworkCellularGatewayDhcpAsync
public
getNetworkCellularGatewayDhcpAsync(string $network_id) : PromiseInterface
List common DHCP settings of MGs
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkCellularGatewayDhcpAsyncWithHttpInfo()
Operation getNetworkCellularGatewayDhcpAsyncWithHttpInfo
public
getNetworkCellularGatewayDhcpAsyncWithHttpInfo(string $network_id) : PromiseInterface
List common DHCP settings of MGs
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkCellularGatewayDhcpWithHttpInfo()
Operation getNetworkCellularGatewayDhcpWithHttpInfo
public
getNetworkCellularGatewayDhcpWithHttpInfo(string $network_id) : array<string|int, mixed>
List common DHCP settings of MGs
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkCellularGatewaySubnetPool()
Operation getNetworkCellularGatewaySubnetPool
public
getNetworkCellularGatewaySubnetPool(string $network_id) : object
Return the subnet pool and mask configured for MGs in the network.
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkCellularGatewaySubnetPoolAsync()
Operation getNetworkCellularGatewaySubnetPoolAsync
public
getNetworkCellularGatewaySubnetPoolAsync(string $network_id) : PromiseInterface
Return the subnet pool and mask configured for MGs in the network.
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo()
Operation getNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo
public
getNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo(string $network_id) : PromiseInterface
Return the subnet pool and mask configured for MGs in the network.
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkCellularGatewaySubnetPoolWithHttpInfo()
Operation getNetworkCellularGatewaySubnetPoolWithHttpInfo
public
getNetworkCellularGatewaySubnetPoolWithHttpInfo(string $network_id) : array<string|int, mixed>
Return the subnet pool and mask configured for MGs in the network.
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
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)
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)
updateDeviceCellularGatewayLan()
Operation updateDeviceCellularGatewayLan
public
updateDeviceCellularGatewayLan(string $serial[, UpdateDeviceCellularGatewayLan $update_device_cellular_gateway_lan = null ]) : object
Update the LAN Settings for a single MG.
Parameters
- $serial : string
-
serial (required)
- $update_device_cellular_gateway_lan : UpdateDeviceCellularGatewayLan = null
-
update_device_cellular_gateway_lan (optional)
Tags
Return values
object —updateDeviceCellularGatewayLanAsync()
Operation updateDeviceCellularGatewayLanAsync
public
updateDeviceCellularGatewayLanAsync(string $serial[, UpdateDeviceCellularGatewayLan $update_device_cellular_gateway_lan = null ]) : PromiseInterface
Update the LAN Settings for a single MG.
Parameters
- $serial : string
-
(required)
- $update_device_cellular_gateway_lan : UpdateDeviceCellularGatewayLan = null
-
(optional)
Tags
Return values
PromiseInterface —updateDeviceCellularGatewayLanAsyncWithHttpInfo()
Operation updateDeviceCellularGatewayLanAsyncWithHttpInfo
public
updateDeviceCellularGatewayLanAsyncWithHttpInfo(string $serial[, UpdateDeviceCellularGatewayLan $update_device_cellular_gateway_lan = null ]) : PromiseInterface
Update the LAN Settings for a single MG.
Parameters
- $serial : string
-
(required)
- $update_device_cellular_gateway_lan : UpdateDeviceCellularGatewayLan = null
-
(optional)
Tags
Return values
PromiseInterface —updateDeviceCellularGatewayLanWithHttpInfo()
Operation updateDeviceCellularGatewayLanWithHttpInfo
public
updateDeviceCellularGatewayLanWithHttpInfo(string $serial[, UpdateDeviceCellularGatewayLan $update_device_cellular_gateway_lan = null ]) : array<string|int, mixed>
Update the LAN Settings for a single MG.
Parameters
- $serial : string
-
(required)
- $update_device_cellular_gateway_lan : UpdateDeviceCellularGatewayLan = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateDeviceCellularGatewayPortForwardingRules()
Operation updateDeviceCellularGatewayPortForwardingRules
public
updateDeviceCellularGatewayPortForwardingRules(string $serial[, UpdateDeviceCellularGatewayPortForwardingRules $update_device_cellular_gateway_port_forwarding_rules = null ]) : object
Updates the port forwarding rules for a single MG.
Parameters
- $serial : string
-
serial (required)
- $update_device_cellular_gateway_port_forwarding_rules : UpdateDeviceCellularGatewayPortForwardingRules = null
-
update_device_cellular_gateway_port_forwarding_rules (optional)
Tags
Return values
object —updateDeviceCellularGatewayPortForwardingRulesAsync()
Operation updateDeviceCellularGatewayPortForwardingRulesAsync
public
updateDeviceCellularGatewayPortForwardingRulesAsync(string $serial[, UpdateDeviceCellularGatewayPortForwardingRules $update_device_cellular_gateway_port_forwarding_rules = null ]) : PromiseInterface
Updates the port forwarding rules for a single MG.
Parameters
- $serial : string
-
(required)
- $update_device_cellular_gateway_port_forwarding_rules : UpdateDeviceCellularGatewayPortForwardingRules = null
-
(optional)
Tags
Return values
PromiseInterface —updateDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo()
Operation updateDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo
public
updateDeviceCellularGatewayPortForwardingRulesAsyncWithHttpInfo(string $serial[, UpdateDeviceCellularGatewayPortForwardingRules $update_device_cellular_gateway_port_forwarding_rules = null ]) : PromiseInterface
Updates the port forwarding rules for a single MG.
Parameters
- $serial : string
-
(required)
- $update_device_cellular_gateway_port_forwarding_rules : UpdateDeviceCellularGatewayPortForwardingRules = null
-
(optional)
Tags
Return values
PromiseInterface —updateDeviceCellularGatewayPortForwardingRulesWithHttpInfo()
Operation updateDeviceCellularGatewayPortForwardingRulesWithHttpInfo
public
updateDeviceCellularGatewayPortForwardingRulesWithHttpInfo(string $serial[, UpdateDeviceCellularGatewayPortForwardingRules $update_device_cellular_gateway_port_forwarding_rules = null ]) : array<string|int, mixed>
Updates the port forwarding rules for a single MG.
Parameters
- $serial : string
-
(required)
- $update_device_cellular_gateway_port_forwarding_rules : UpdateDeviceCellularGatewayPortForwardingRules = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkCellularGatewayConnectivityMonitoringDestinations()
Operation updateNetworkCellularGatewayConnectivityMonitoringDestinations
public
updateNetworkCellularGatewayConnectivityMonitoringDestinations(string $network_id[, UpdateNetworkCellularGatewayConnectivityMonitoringDestinations $update_network_cellular_gateway_connectivity_monitoring_destinations = null ]) : object
Update the connectivity testing destinations for an MG network
Parameters
- $network_id : string
-
network_id (required)
- $update_network_cellular_gateway_connectivity_monitoring_destinations : UpdateNetworkCellularGatewayConnectivityMonitoringDestinations = null
-
update_network_cellular_gateway_connectivity_monitoring_destinations (optional)
Tags
Return values
object —updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsync()
Operation updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsync
public
updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsync(string $network_id[, UpdateNetworkCellularGatewayConnectivityMonitoringDestinations $update_network_cellular_gateway_connectivity_monitoring_destinations = null ]) : PromiseInterface
Update the connectivity testing destinations for an MG network
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_connectivity_monitoring_destinations : UpdateNetworkCellularGatewayConnectivityMonitoringDestinations = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo()
Operation updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo
public
updateNetworkCellularGatewayConnectivityMonitoringDestinationsAsyncWithHttpInfo(string $network_id[, UpdateNetworkCellularGatewayConnectivityMonitoringDestinations $update_network_cellular_gateway_connectivity_monitoring_destinations = null ]) : PromiseInterface
Update the connectivity testing destinations for an MG network
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_connectivity_monitoring_destinations : UpdateNetworkCellularGatewayConnectivityMonitoringDestinations = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo()
Operation updateNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo
public
updateNetworkCellularGatewayConnectivityMonitoringDestinationsWithHttpInfo(string $network_id[, UpdateNetworkCellularGatewayConnectivityMonitoringDestinations $update_network_cellular_gateway_connectivity_monitoring_destinations = null ]) : array<string|int, mixed>
Update the connectivity testing destinations for an MG network
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_connectivity_monitoring_destinations : UpdateNetworkCellularGatewayConnectivityMonitoringDestinations = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkCellularGatewayDhcp()
Operation updateNetworkCellularGatewayDhcp
public
updateNetworkCellularGatewayDhcp(string $network_id[, UpdateNetworkCellularGatewayDhcp $update_network_cellular_gateway_dhcp = null ]) : object
Update common DHCP settings of MGs
Parameters
- $network_id : string
-
network_id (required)
- $update_network_cellular_gateway_dhcp : UpdateNetworkCellularGatewayDhcp = null
-
update_network_cellular_gateway_dhcp (optional)
Tags
Return values
object —updateNetworkCellularGatewayDhcpAsync()
Operation updateNetworkCellularGatewayDhcpAsync
public
updateNetworkCellularGatewayDhcpAsync(string $network_id[, UpdateNetworkCellularGatewayDhcp $update_network_cellular_gateway_dhcp = null ]) : PromiseInterface
Update common DHCP settings of MGs
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_dhcp : UpdateNetworkCellularGatewayDhcp = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkCellularGatewayDhcpAsyncWithHttpInfo()
Operation updateNetworkCellularGatewayDhcpAsyncWithHttpInfo
public
updateNetworkCellularGatewayDhcpAsyncWithHttpInfo(string $network_id[, UpdateNetworkCellularGatewayDhcp $update_network_cellular_gateway_dhcp = null ]) : PromiseInterface
Update common DHCP settings of MGs
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_dhcp : UpdateNetworkCellularGatewayDhcp = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkCellularGatewayDhcpWithHttpInfo()
Operation updateNetworkCellularGatewayDhcpWithHttpInfo
public
updateNetworkCellularGatewayDhcpWithHttpInfo(string $network_id[, UpdateNetworkCellularGatewayDhcp $update_network_cellular_gateway_dhcp = null ]) : array<string|int, mixed>
Update common DHCP settings of MGs
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_dhcp : UpdateNetworkCellularGatewayDhcp = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkCellularGatewaySubnetPool()
Operation updateNetworkCellularGatewaySubnetPool
public
updateNetworkCellularGatewaySubnetPool(string $network_id[, UpdateNetworkCellularGatewaySubnetPool $update_network_cellular_gateway_subnet_pool = null ]) : object
Update the subnet pool and mask configuration for MGs in the network.
Parameters
- $network_id : string
-
network_id (required)
- $update_network_cellular_gateway_subnet_pool : UpdateNetworkCellularGatewaySubnetPool = null
-
update_network_cellular_gateway_subnet_pool (optional)
Tags
Return values
object —updateNetworkCellularGatewaySubnetPoolAsync()
Operation updateNetworkCellularGatewaySubnetPoolAsync
public
updateNetworkCellularGatewaySubnetPoolAsync(string $network_id[, UpdateNetworkCellularGatewaySubnetPool $update_network_cellular_gateway_subnet_pool = null ]) : PromiseInterface
Update the subnet pool and mask configuration for MGs in the network.
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_subnet_pool : UpdateNetworkCellularGatewaySubnetPool = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo()
Operation updateNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo
public
updateNetworkCellularGatewaySubnetPoolAsyncWithHttpInfo(string $network_id[, UpdateNetworkCellularGatewaySubnetPool $update_network_cellular_gateway_subnet_pool = null ]) : PromiseInterface
Update the subnet pool and mask configuration for MGs in the network.
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_subnet_pool : UpdateNetworkCellularGatewaySubnetPool = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkCellularGatewaySubnetPoolWithHttpInfo()
Operation updateNetworkCellularGatewaySubnetPoolWithHttpInfo
public
updateNetworkCellularGatewaySubnetPoolWithHttpInfo(string $network_id[, UpdateNetworkCellularGatewaySubnetPool $update_network_cellular_gateway_subnet_pool = null ]) : array<string|int, mixed>
Update the subnet pool and mask configuration for MGs in the network.
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_subnet_pool : UpdateNetworkCellularGatewaySubnetPool = null
-
(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
getDeviceCellularGatewayLanRequest()
Create request for operation 'getDeviceCellularGatewayLan'
protected
getDeviceCellularGatewayLanRequest(string $serial) : Request
Parameters
- $serial : string
-
(required)
Tags
Return values
Request —getDeviceCellularGatewayPortForwardingRulesRequest()
Create request for operation 'getDeviceCellularGatewayPortForwardingRules'
protected
getDeviceCellularGatewayPortForwardingRulesRequest(string $serial) : Request
Parameters
- $serial : string
-
(required)
Tags
Return values
Request —getNetworkCellularGatewayConnectivityMonitoringDestinationsRequest()
Create request for operation 'getNetworkCellularGatewayConnectivityMonitoringDestinations'
protected
getNetworkCellularGatewayConnectivityMonitoringDestinationsRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —getNetworkCellularGatewayDhcpRequest()
Create request for operation 'getNetworkCellularGatewayDhcp'
protected
getNetworkCellularGatewayDhcpRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —getNetworkCellularGatewaySubnetPoolRequest()
Create request for operation 'getNetworkCellularGatewaySubnetPool'
protected
getNetworkCellularGatewaySubnetPoolRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —getNetworkCellularGatewayUplinkRequest()
Create request for operation 'getNetworkCellularGatewayUplink'
protected
getNetworkCellularGatewayUplinkRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
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 —updateDeviceCellularGatewayLanRequest()
Create request for operation 'updateDeviceCellularGatewayLan'
protected
updateDeviceCellularGatewayLanRequest(string $serial[, UpdateDeviceCellularGatewayLan $update_device_cellular_gateway_lan = null ]) : Request
Parameters
- $serial : string
-
(required)
- $update_device_cellular_gateway_lan : UpdateDeviceCellularGatewayLan = null
-
(optional)
Tags
Return values
Request —updateDeviceCellularGatewayPortForwardingRulesRequest()
Create request for operation 'updateDeviceCellularGatewayPortForwardingRules'
protected
updateDeviceCellularGatewayPortForwardingRulesRequest(string $serial[, UpdateDeviceCellularGatewayPortForwardingRules $update_device_cellular_gateway_port_forwarding_rules = null ]) : Request
Parameters
- $serial : string
-
(required)
- $update_device_cellular_gateway_port_forwarding_rules : UpdateDeviceCellularGatewayPortForwardingRules = null
-
(optional)
Tags
Return values
Request —updateNetworkCellularGatewayConnectivityMonitoringDestinationsRequest()
Create request for operation 'updateNetworkCellularGatewayConnectivityMonitoringDestinations'
protected
updateNetworkCellularGatewayConnectivityMonitoringDestinationsRequest(string $network_id[, UpdateNetworkCellularGatewayConnectivityMonitoringDestinations $update_network_cellular_gateway_connectivity_monitoring_destinations = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_connectivity_monitoring_destinations : UpdateNetworkCellularGatewayConnectivityMonitoringDestinations = null
-
(optional)
Tags
Return values
Request —updateNetworkCellularGatewayDhcpRequest()
Create request for operation 'updateNetworkCellularGatewayDhcp'
protected
updateNetworkCellularGatewayDhcpRequest(string $network_id[, UpdateNetworkCellularGatewayDhcp $update_network_cellular_gateway_dhcp = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_dhcp : UpdateNetworkCellularGatewayDhcp = null
-
(optional)
Tags
Return values
Request —updateNetworkCellularGatewaySubnetPoolRequest()
Create request for operation 'updateNetworkCellularGatewaySubnetPool'
protected
updateNetworkCellularGatewaySubnetPoolRequest(string $network_id[, UpdateNetworkCellularGatewaySubnetPool $update_network_cellular_gateway_subnet_pool = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $update_network_cellular_gateway_subnet_pool : UpdateNetworkCellularGatewaySubnetPool = null
-
(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)