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 —

blinkDeviceLeds()

Operation blinkDeviceLeds


    public
                blinkDeviceLeds(string $serial[, BlinkDeviceLeds $blink_device_leds = null ]) : object

Blink the LEDs on a device

Parameters

$serial : string: serial (required)
$blink_device_leds : BlinkDeviceLeds = null: blink_device_leds (optional)

Tags

Return values

object —

blinkDeviceLedsAsync()

Operation blinkDeviceLedsAsync


    public
                blinkDeviceLedsAsync(string $serial[, BlinkDeviceLeds $blink_device_leds = null ]) : PromiseInterface

Blink the LEDs on a device

Parameters

$serial : string: (required)
$blink_device_leds : BlinkDeviceLeds = null: (optional)

Tags

Return values

PromiseInterface —

blinkDeviceLedsAsyncWithHttpInfo()

Operation blinkDeviceLedsAsyncWithHttpInfo


    public
                blinkDeviceLedsAsyncWithHttpInfo(string $serial[, BlinkDeviceLeds $blink_device_leds = null ]) : PromiseInterface

Blink the LEDs on a device

Parameters

$serial : string: (required)
$blink_device_leds : BlinkDeviceLeds = null: (optional)

Tags

Return values

PromiseInterface —

blinkDeviceLedsWithHttpInfo()

Operation blinkDeviceLedsWithHttpInfo


    public
                blinkDeviceLedsWithHttpInfo(string $serial[, BlinkDeviceLeds $blink_device_leds = null ]) : array<string|int, mixed>

Blink the LEDs on a device

Parameters

$serial : string: (required)
$blink_device_leds : BlinkDeviceLeds = null: (optional)

Tags

Return values

array<string|int, mixed> —

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

checkinNetworkSmDevices()

Operation checkinNetworkSmDevices


    public
                checkinNetworkSmDevices(string $network_id[, CheckinNetworkSmDevices $checkin_network_sm_devices = null ]) : object

Force check-in a set of devices

Parameters

$network_id : string: network_id (required)
$checkin_network_sm_devices : CheckinNetworkSmDevices = null: checkin_network_sm_devices (optional)

Tags

Return values

object —

checkinNetworkSmDevicesAsync()

Operation checkinNetworkSmDevicesAsync


    public
                checkinNetworkSmDevicesAsync(string $network_id[, CheckinNetworkSmDevices $checkin_network_sm_devices = null ]) : PromiseInterface

Force check-in a set of devices

Parameters

$network_id : string: (required)
$checkin_network_sm_devices : CheckinNetworkSmDevices = null: (optional)

Tags

Return values

PromiseInterface —

checkinNetworkSmDevicesAsyncWithHttpInfo()

Operation checkinNetworkSmDevicesAsyncWithHttpInfo


    public
                checkinNetworkSmDevicesAsyncWithHttpInfo(string $network_id[, CheckinNetworkSmDevices $checkin_network_sm_devices = null ]) : PromiseInterface

Force check-in a set of devices

Parameters

$network_id : string: (required)
$checkin_network_sm_devices : CheckinNetworkSmDevices = null: (optional)

Tags

Return values

PromiseInterface —

checkinNetworkSmDevicesWithHttpInfo()

Operation checkinNetworkSmDevicesWithHttpInfo


    public
                checkinNetworkSmDevicesWithHttpInfo(string $network_id[, CheckinNetworkSmDevices $checkin_network_sm_devices = null ]) : array<string|int, mixed>

Force check-in a set of devices

Parameters

$network_id : string: (required)
$checkin_network_sm_devices : CheckinNetworkSmDevices = null: (optional)

Tags

Return values

array<string|int, mixed> —

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

claimNetworkDevices()

Operation claimNetworkDevices


    public
                claimNetworkDevices(string $network_id, ClaimNetworkDevices $claim_network_devices) : void

Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requsts against that device to succeed)

Parameters

$network_id : string: network_id (required)
$claim_network_devices : ClaimNetworkDevices: claim_network_devices (required)

Tags

Return values

void —

claimNetworkDevicesAsync()

Operation claimNetworkDevicesAsync


    public
                claimNetworkDevicesAsync(string $network_id, ClaimNetworkDevices $claim_network_devices) : PromiseInterface

Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requsts against that device to succeed)

Parameters

$network_id : string: (required)
$claim_network_devices : ClaimNetworkDevices: (required)

Tags

Return values

PromiseInterface —

claimNetworkDevicesAsyncWithHttpInfo()

Operation claimNetworkDevicesAsyncWithHttpInfo


    public
                claimNetworkDevicesAsyncWithHttpInfo(string $network_id, ClaimNetworkDevices $claim_network_devices) : PromiseInterface

Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requsts against that device to succeed)

Parameters

$network_id : string: (required)
$claim_network_devices : ClaimNetworkDevices: (required)

Tags

Return values

PromiseInterface —

claimNetworkDevicesWithHttpInfo()

Operation claimNetworkDevicesWithHttpInfo


    public
                claimNetworkDevicesWithHttpInfo(string $network_id, ClaimNetworkDevices $claim_network_devices) : array<string|int, mixed>

Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requsts against that device to succeed)

Parameters

$network_id : string: (required)
$claim_network_devices : ClaimNetworkDevices: (required)

Tags

Return values

array<string|int, mixed> —

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

cloneOrganizationSwitchDevices()

Operation cloneOrganizationSwitchDevices


    public
                cloneOrganizationSwitchDevices(string $organization_id, CloneOrganizationSwitchDevices $clone_organization_switch_devices) : object

Clone port-level and some switch-level configuration settings from a source switch to one or more target switches

Parameters

$organization_id : string: organization_id (required)
$clone_organization_switch_devices : CloneOrganizationSwitchDevices: clone_organization_switch_devices (required)

Tags

Return values

object —

cloneOrganizationSwitchDevicesAsync()

Operation cloneOrganizationSwitchDevicesAsync


    public
                cloneOrganizationSwitchDevicesAsync(string $organization_id, CloneOrganizationSwitchDevices $clone_organization_switch_devices) : PromiseInterface

Clone port-level and some switch-level configuration settings from a source switch to one or more target switches

Parameters

$organization_id : string: (required)
$clone_organization_switch_devices : CloneOrganizationSwitchDevices: (required)

Tags

Return values

PromiseInterface —

cloneOrganizationSwitchDevicesAsyncWithHttpInfo()

Operation cloneOrganizationSwitchDevicesAsyncWithHttpInfo


    public
                cloneOrganizationSwitchDevicesAsyncWithHttpInfo(string $organization_id, CloneOrganizationSwitchDevices $clone_organization_switch_devices) : PromiseInterface

Clone port-level and some switch-level configuration settings from a source switch to one or more target switches

Parameters

$organization_id : string: (required)
$clone_organization_switch_devices : CloneOrganizationSwitchDevices: (required)

Tags

Return values

PromiseInterface —

cloneOrganizationSwitchDevicesWithHttpInfo()

Operation cloneOrganizationSwitchDevicesWithHttpInfo


    public
                cloneOrganizationSwitchDevicesWithHttpInfo(string $organization_id, CloneOrganizationSwitchDevices $clone_organization_switch_devices) : array<string|int, mixed>

Clone port-level and some switch-level configuration settings from a source switch to one or more target switches

Parameters

$organization_id : string: (required)
$clone_organization_switch_devices : CloneOrganizationSwitchDevices: (required)

Tags

Return values

array<string|int, mixed> —

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

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getDevice()

Operation getDevice


    public
                getDevice(string $serial) : object

Return a single device

Parameters

$serial : string: serial (required)

Tags

Return values

object —

getDeviceAsync()

Operation getDeviceAsync


    public
                getDeviceAsync(string $serial) : PromiseInterface

Return a single device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceAsyncWithHttpInfo()

Operation getDeviceAsyncWithHttpInfo


    public
                getDeviceAsyncWithHttpInfo(string $serial) : PromiseInterface

Return a single device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

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)

getDeviceLldpCdp()

Operation getDeviceLldpCdp


    public
                getDeviceLldpCdp(string $serial) : object

List LLDP and CDP information for a device

Parameters

$serial : string: serial (required)

Tags

Return values

object —

getDeviceLldpCdpAsync()

Operation getDeviceLldpCdpAsync


    public
                getDeviceLldpCdpAsync(string $serial) : PromiseInterface

List LLDP and CDP information for a device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceLldpCdpAsyncWithHttpInfo()

Operation getDeviceLldpCdpAsyncWithHttpInfo


    public
                getDeviceLldpCdpAsyncWithHttpInfo(string $serial) : PromiseInterface

List LLDP and CDP information for a device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceLldpCdpWithHttpInfo()

Operation getDeviceLldpCdpWithHttpInfo


    public
                getDeviceLldpCdpWithHttpInfo(string $serial) : array<string|int, mixed>

List LLDP and CDP information for a device

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getDeviceLossAndLatencyHistory()

Operation getDeviceLossAndLatencyHistory


    public
                getDeviceLossAndLatencyHistory(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : object

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

Parameters

$serial : string: serial (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 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: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

object —

getDeviceLossAndLatencyHistoryAsync()

Operation getDeviceLossAndLatencyHistoryAsync


    public
                getDeviceLossAndLatencyHistoryAsync(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : PromiseInterface

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

Parameters

$serial : string: (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 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: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

PromiseInterface —

getDeviceLossAndLatencyHistoryAsyncWithHttpInfo()

Operation getDeviceLossAndLatencyHistoryAsyncWithHttpInfo


    public
                getDeviceLossAndLatencyHistoryAsyncWithHttpInfo(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : PromiseInterface

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

Parameters

$serial : string: (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 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: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

PromiseInterface —

getDeviceLossAndLatencyHistoryWithHttpInfo()

Operation getDeviceLossAndLatencyHistoryWithHttpInfo


    public
                getDeviceLossAndLatencyHistoryWithHttpInfo(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : array<string|int, mixed>

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

Parameters

$serial : string: (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 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: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

array<string|int, mixed> —

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

getDeviceManagementInterface()

Operation getDeviceManagementInterface


    public
                getDeviceManagementInterface(string $serial) : object

Return the management interface settings for a device

Parameters

$serial : string: serial (required)

Tags

Return values

object —

getDeviceManagementInterfaceAsync()

Operation getDeviceManagementInterfaceAsync


    public
                getDeviceManagementInterfaceAsync(string $serial) : PromiseInterface

Return the management interface settings for a device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceManagementInterfaceAsyncWithHttpInfo()

Operation getDeviceManagementInterfaceAsyncWithHttpInfo


    public
                getDeviceManagementInterfaceAsyncWithHttpInfo(string $serial) : PromiseInterface

Return the management interface settings for a device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceManagementInterfaceWithHttpInfo()

Operation getDeviceManagementInterfaceWithHttpInfo


    public
                getDeviceManagementInterfaceWithHttpInfo(string $serial) : array<string|int, mixed>

Return the management interface settings for a device

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getDeviceWithHttpInfo()

Operation getDeviceWithHttpInfo


    public
                getDeviceWithHttpInfo(string $serial) : array<string|int, mixed>

Return a single device

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkDevices()

Operation getNetworkDevices


    public
                getNetworkDevices(string $network_id) : object

List the devices in a network

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkDevicesAsync()

Operation getNetworkDevicesAsync


    public
                getNetworkDevicesAsync(string $network_id) : PromiseInterface

List the devices in a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkDevicesAsyncWithHttpInfo()

Operation getNetworkDevicesAsyncWithHttpInfo


    public
                getNetworkDevicesAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the devices in a network

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkDevicesWithHttpInfo()

Operation getNetworkDevicesWithHttpInfo


    public
                getNetworkDevicesWithHttpInfo(string $network_id) : array<string|int, mixed>

List the devices in a network

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceCellularUsageHistory()

Operation getNetworkSmDeviceCellularUsageHistory


    public
                getNetworkSmDeviceCellularUsageHistory(string $network_id, string $device_id) : object

Return the client's daily cellular data usage history

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

getNetworkSmDeviceCellularUsageHistoryAsync()

Operation getNetworkSmDeviceCellularUsageHistoryAsync


    public
                getNetworkSmDeviceCellularUsageHistoryAsync(string $network_id, string $device_id) : PromiseInterface

Return the client's daily cellular data usage history

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceCellularUsageHistoryAsyncWithHttpInfo()

Operation getNetworkSmDeviceCellularUsageHistoryAsyncWithHttpInfo


    public
                getNetworkSmDeviceCellularUsageHistoryAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

Return the client's daily cellular data usage history

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceCellularUsageHistoryWithHttpInfo()

Operation getNetworkSmDeviceCellularUsageHistoryWithHttpInfo


    public
                getNetworkSmDeviceCellularUsageHistoryWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

Return the client's daily cellular data usage history

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceCerts()

Operation getNetworkSmDeviceCerts


    public
                getNetworkSmDeviceCerts(string $network_id, string $device_id) : object

List the certs on a device

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

getNetworkSmDeviceCertsAsync()

Operation getNetworkSmDeviceCertsAsync


    public
                getNetworkSmDeviceCertsAsync(string $network_id, string $device_id) : PromiseInterface

List the certs on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceCertsAsyncWithHttpInfo()

Operation getNetworkSmDeviceCertsAsyncWithHttpInfo


    public
                getNetworkSmDeviceCertsAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

List the certs on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceCertsWithHttpInfo()

Operation getNetworkSmDeviceCertsWithHttpInfo


    public
                getNetworkSmDeviceCertsWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

List the certs on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceConnectivity()

Operation getNetworkSmDeviceConnectivity


    public
                getNetworkSmDeviceConnectivity(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

Parameters

$network_id : string: network_id (required)
$device_id : string: device_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)

Tags

Return values

object —

getNetworkSmDeviceConnectivityAsync()

Operation getNetworkSmDeviceConnectivityAsync


    public
                getNetworkSmDeviceConnectivityAsync(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceConnectivityAsyncWithHttpInfo()

Operation getNetworkSmDeviceConnectivityAsyncWithHttpInfo


    public
                getNetworkSmDeviceConnectivityAsyncWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceConnectivityWithHttpInfo()

Operation getNetworkSmDeviceConnectivityWithHttpInfo


    public
                getNetworkSmDeviceConnectivityWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceDesktopLogs()

Operation getNetworkSmDeviceDesktopLogs


    public
                getNetworkSmDeviceDesktopLogs(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Return historical records of various Systems Manager network connection details for desktop devices.

Parameters

$network_id : string: network_id (required)
$device_id : string: device_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)

Tags

Return values

object —

getNetworkSmDeviceDesktopLogsAsync()

Operation getNetworkSmDeviceDesktopLogsAsync


    public
                getNetworkSmDeviceDesktopLogsAsync(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of various Systems Manager network connection details for desktop devices.

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDesktopLogsAsyncWithHttpInfo()

Operation getNetworkSmDeviceDesktopLogsAsyncWithHttpInfo


    public
                getNetworkSmDeviceDesktopLogsAsyncWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of various Systems Manager network connection details for desktop devices.

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDesktopLogsWithHttpInfo()

Operation getNetworkSmDeviceDesktopLogsWithHttpInfo


    public
                getNetworkSmDeviceDesktopLogsWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Return historical records of various Systems Manager network connection details for desktop devices.

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceDeviceCommandLogs()

Operation getNetworkSmDeviceDeviceCommandLogs


    public
                getNetworkSmDeviceDeviceCommandLogs(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Return historical records of commands sent to Systems Manager devices

Parameters

$network_id : string: network_id (required)
$device_id : string: device_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)

Tags

Return values

object —

getNetworkSmDeviceDeviceCommandLogsAsync()

Operation getNetworkSmDeviceDeviceCommandLogsAsync


    public
                getNetworkSmDeviceDeviceCommandLogsAsync(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of commands sent to Systems Manager devices

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDeviceCommandLogsAsyncWithHttpInfo()

Operation getNetworkSmDeviceDeviceCommandLogsAsyncWithHttpInfo


    public
                getNetworkSmDeviceDeviceCommandLogsAsyncWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of commands sent to Systems Manager devices

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDeviceCommandLogsWithHttpInfo()

Operation getNetworkSmDeviceDeviceCommandLogsWithHttpInfo


    public
                getNetworkSmDeviceDeviceCommandLogsWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Return historical records of commands sent to Systems Manager devices

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceDeviceProfiles()

Operation getNetworkSmDeviceDeviceProfiles


    public
                getNetworkSmDeviceDeviceProfiles(string $network_id, string $device_id) : object

Get the profiles associated with a device

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

getNetworkSmDeviceDeviceProfilesAsync()

Operation getNetworkSmDeviceDeviceProfilesAsync


    public
                getNetworkSmDeviceDeviceProfilesAsync(string $network_id, string $device_id) : PromiseInterface

Get the profiles associated with a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDeviceProfilesAsyncWithHttpInfo()

Operation getNetworkSmDeviceDeviceProfilesAsyncWithHttpInfo


    public
                getNetworkSmDeviceDeviceProfilesAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

Get the profiles associated with a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDeviceProfilesWithHttpInfo()

Operation getNetworkSmDeviceDeviceProfilesWithHttpInfo


    public
                getNetworkSmDeviceDeviceProfilesWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

Get the profiles associated with a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceNetworkAdapters()

Operation getNetworkSmDeviceNetworkAdapters


    public
                getNetworkSmDeviceNetworkAdapters(string $network_id, string $device_id) : object

List the network adapters of a device

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

getNetworkSmDeviceNetworkAdaptersAsync()

Operation getNetworkSmDeviceNetworkAdaptersAsync


    public
                getNetworkSmDeviceNetworkAdaptersAsync(string $network_id, string $device_id) : PromiseInterface

List the network adapters of a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceNetworkAdaptersAsyncWithHttpInfo()

Operation getNetworkSmDeviceNetworkAdaptersAsyncWithHttpInfo


    public
                getNetworkSmDeviceNetworkAdaptersAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

List the network adapters of a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceNetworkAdaptersWithHttpInfo()

Operation getNetworkSmDeviceNetworkAdaptersWithHttpInfo


    public
                getNetworkSmDeviceNetworkAdaptersWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

List the network adapters of a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDevicePerformanceHistory()

Operation getNetworkSmDevicePerformanceHistory


    public
                getNetworkSmDevicePerformanceHistory(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Return historical records of various Systems Manager client metrics for desktop devices.

Parameters

$network_id : string: network_id (required)
$device_id : string: device_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)

Tags

Return values

object —

getNetworkSmDevicePerformanceHistoryAsync()

Operation getNetworkSmDevicePerformanceHistoryAsync


    public
                getNetworkSmDevicePerformanceHistoryAsync(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of various Systems Manager client metrics for desktop devices.

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

PromiseInterface —

getNetworkSmDevicePerformanceHistoryAsyncWithHttpInfo()

Operation getNetworkSmDevicePerformanceHistoryAsyncWithHttpInfo


    public
                getNetworkSmDevicePerformanceHistoryAsyncWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of various Systems Manager client metrics for desktop devices.

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

PromiseInterface —

getNetworkSmDevicePerformanceHistoryWithHttpInfo()

Operation getNetworkSmDevicePerformanceHistoryWithHttpInfo


    public
                getNetworkSmDevicePerformanceHistoryWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Return historical records of various Systems Manager client metrics for desktop devices.

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceRestrictions()

Operation getNetworkSmDeviceRestrictions


    public
                getNetworkSmDeviceRestrictions(string $network_id, string $device_id) : object

List the restrictions on a device

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

getNetworkSmDeviceRestrictionsAsync()

Operation getNetworkSmDeviceRestrictionsAsync


    public
                getNetworkSmDeviceRestrictionsAsync(string $network_id, string $device_id) : PromiseInterface

List the restrictions on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceRestrictionsAsyncWithHttpInfo()

Operation getNetworkSmDeviceRestrictionsAsyncWithHttpInfo


    public
                getNetworkSmDeviceRestrictionsAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

List the restrictions on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceRestrictionsWithHttpInfo()

Operation getNetworkSmDeviceRestrictionsWithHttpInfo


    public
                getNetworkSmDeviceRestrictionsWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

List the restrictions on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDevices()

Operation getNetworkSmDevices


    public
                getNetworkSmDevices(string $network_id[, array<string|int, string> $fields = null ][, array<string|int, string> $wifi_macs = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $ids = null ][, array<string|int, string> $scope = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

List the devices enrolled in an SM network with various specified fields and filters

Parameters

$network_id : string: network_id (required)
$fields : array<string|int, string> = null: Additional fields that will be displayed for each device. The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip, systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser, ownerEmail, ownerUsername, osBuild, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid, simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName, isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled, hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, and androidSecurityPatchVersion. (optional)
$wifi_macs : array<string|int, string> = null: Filter devices by wifi mac(s). (optional)
$serials : array<string|int, string> = null: Filter devices by serial(s). (optional)
$ids : array<string|int, string> = null: Filter devices by id(s). (optional)
$scope : array<string|int, string> = null: Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags. (optional)
$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)

Tags

Return values

object —

getNetworkSmDevicesAsync()

Operation getNetworkSmDevicesAsync


    public
                getNetworkSmDevicesAsync(string $network_id[, array<string|int, string> $fields = null ][, array<string|int, string> $wifi_macs = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $ids = null ][, array<string|int, string> $scope = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the devices enrolled in an SM network with various specified fields and filters

Parameters

$network_id : string: (required)
$fields : array<string|int, string> = null: Additional fields that will be displayed for each device. The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip, systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser, ownerEmail, ownerUsername, osBuild, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid, simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName, isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled, hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, and androidSecurityPatchVersion. (optional)
$wifi_macs : array<string|int, string> = null: Filter devices by wifi mac(s). (optional)
$serials : array<string|int, string> = null: Filter devices by serial(s). (optional)
$ids : array<string|int, string> = null: Filter devices by id(s). (optional)
$scope : array<string|int, string> = null: Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags. (optional)
$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)

Tags

Return values

PromiseInterface —

getNetworkSmDevicesAsyncWithHttpInfo()

Operation getNetworkSmDevicesAsyncWithHttpInfo


    public
                getNetworkSmDevicesAsyncWithHttpInfo(string $network_id[, array<string|int, string> $fields = null ][, array<string|int, string> $wifi_macs = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $ids = null ][, array<string|int, string> $scope = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the devices enrolled in an SM network with various specified fields and filters

Parameters

$network_id : string: (required)
$fields : array<string|int, string> = null: Additional fields that will be displayed for each device. The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip, systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser, ownerEmail, ownerUsername, osBuild, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid, simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName, isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled, hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, and androidSecurityPatchVersion. (optional)
$wifi_macs : array<string|int, string> = null: Filter devices by wifi mac(s). (optional)
$serials : array<string|int, string> = null: Filter devices by serial(s). (optional)
$ids : array<string|int, string> = null: Filter devices by id(s). (optional)
$scope : array<string|int, string> = null: Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags. (optional)
$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)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceSecurityCenters()

Operation getNetworkSmDeviceSecurityCenters


    public
                getNetworkSmDeviceSecurityCenters(string $network_id, string $device_id) : object

List the security centers on a device

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

getNetworkSmDeviceSecurityCentersAsync()

Operation getNetworkSmDeviceSecurityCentersAsync


    public
                getNetworkSmDeviceSecurityCentersAsync(string $network_id, string $device_id) : PromiseInterface

List the security centers on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceSecurityCentersAsyncWithHttpInfo()

Operation getNetworkSmDeviceSecurityCentersAsyncWithHttpInfo


    public
                getNetworkSmDeviceSecurityCentersAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

List the security centers on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceSecurityCentersWithHttpInfo()

Operation getNetworkSmDeviceSecurityCentersWithHttpInfo


    public
                getNetworkSmDeviceSecurityCentersWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

List the security centers on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceSoftwares()

Operation getNetworkSmDeviceSoftwares


    public
                getNetworkSmDeviceSoftwares(string $network_id, string $device_id) : object

Get a list of softwares associated with a device

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

getNetworkSmDeviceSoftwaresAsync()

Operation getNetworkSmDeviceSoftwaresAsync


    public
                getNetworkSmDeviceSoftwaresAsync(string $network_id, string $device_id) : PromiseInterface

Get a list of softwares associated with a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceSoftwaresAsyncWithHttpInfo()

Operation getNetworkSmDeviceSoftwaresAsyncWithHttpInfo


    public
                getNetworkSmDeviceSoftwaresAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

Get a list of softwares associated with a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceSoftwaresWithHttpInfo()

Operation getNetworkSmDeviceSoftwaresWithHttpInfo


    public
                getNetworkSmDeviceSoftwaresWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

Get a list of softwares associated with a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDevicesWithHttpInfo()

Operation getNetworkSmDevicesWithHttpInfo


    public
                getNetworkSmDevicesWithHttpInfo(string $network_id[, array<string|int, string> $fields = null ][, array<string|int, string> $wifi_macs = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $ids = null ][, array<string|int, string> $scope = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

List the devices enrolled in an SM network with various specified fields and filters

Parameters

$network_id : string: (required)
$fields : array<string|int, string> = null: Additional fields that will be displayed for each device. The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip, systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser, ownerEmail, ownerUsername, osBuild, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid, simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName, isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled, hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, and androidSecurityPatchVersion. (optional)
$wifi_macs : array<string|int, string> = null: Filter devices by wifi mac(s). (optional)
$serials : array<string|int, string> = null: Filter devices by serial(s). (optional)
$ids : array<string|int, string> = null: Filter devices by id(s). (optional)
$scope : array<string|int, string> = null: Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags. (optional)
$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)

Tags

Return values

array<string|int, mixed> —

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

getNetworkSmDeviceWlanLists()

Operation getNetworkSmDeviceWlanLists


    public
                getNetworkSmDeviceWlanLists(string $network_id, string $device_id) : object

List the saved SSID names on a device

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

getNetworkSmDeviceWlanListsAsync()

Operation getNetworkSmDeviceWlanListsAsync


    public
                getNetworkSmDeviceWlanListsAsync(string $network_id, string $device_id) : PromiseInterface

List the saved SSID names on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceWlanListsAsyncWithHttpInfo()

Operation getNetworkSmDeviceWlanListsAsyncWithHttpInfo


    public
                getNetworkSmDeviceWlanListsAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

List the saved SSID names on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceWlanListsWithHttpInfo()

Operation getNetworkSmDeviceWlanListsWithHttpInfo


    public
                getNetworkSmDeviceWlanListsWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

List the saved SSID names on a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

getNetworkWirelessDevicesConnectionStats()

Operation getNetworkWirelessDevicesConnectionStats


    public
                getNetworkWirelessDevicesConnectionStats(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 node

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 —

getNetworkWirelessDevicesConnectionStatsAsync()

Operation getNetworkWirelessDevicesConnectionStatsAsync


    public
                getNetworkWirelessDevicesConnectionStatsAsync(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 node

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 —

getNetworkWirelessDevicesConnectionStatsAsyncWithHttpInfo()

Operation getNetworkWirelessDevicesConnectionStatsAsyncWithHttpInfo


    public
                getNetworkWirelessDevicesConnectionStatsAsyncWithHttpInfo(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 node

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 —

getNetworkWirelessDevicesConnectionStatsWithHttpInfo()

Operation getNetworkWirelessDevicesConnectionStatsWithHttpInfo


    public
                getNetworkWirelessDevicesConnectionStatsWithHttpInfo(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 node

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)

getNetworkWirelessDevicesLatencyStats()

Operation getNetworkWirelessDevicesLatencyStats


    public
                getNetworkWirelessDevicesLatencyStats(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 node

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 —

getNetworkWirelessDevicesLatencyStatsAsync()

Operation getNetworkWirelessDevicesLatencyStatsAsync


    public
                getNetworkWirelessDevicesLatencyStatsAsync(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 node

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 —

getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo(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 node

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 —

getNetworkWirelessDevicesLatencyStatsWithHttpInfo()

Operation getNetworkWirelessDevicesLatencyStatsWithHttpInfo


    public
                getNetworkWirelessDevicesLatencyStatsWithHttpInfo(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 node

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)

getOrganizationDevices()

Operation getOrganizationDevices


    public
                getOrganizationDevices(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $configuration_updated_after = null ]) : object

List the devices in an 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)
$configuration_updated_after : string = null: Filter results by whether or not the device's configuration has been updated after the given timestamp (optional)

Tags

Return values

object —

getOrganizationDevicesAsync()

Operation getOrganizationDevicesAsync


    public
                getOrganizationDevicesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $configuration_updated_after = null ]) : PromiseInterface

List the devices in an 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)
$configuration_updated_after : string = null: Filter results by whether or not the device's configuration has been updated after the given timestamp (optional)

Tags

Return values

PromiseInterface —

getOrganizationDevicesAsyncWithHttpInfo()

Operation getOrganizationDevicesAsyncWithHttpInfo


    public
                getOrganizationDevicesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $configuration_updated_after = null ]) : PromiseInterface

List the devices in an 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)
$configuration_updated_after : string = null: Filter results by whether or not the device's configuration has been updated after the given timestamp (optional)

Tags

Return values

PromiseInterface —

getOrganizationDevicesStatuses()

Operation getOrganizationDevicesStatuses


    public
                getOrganizationDevicesStatuses(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

List the status of every Meraki device 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)

Tags

Return values

object —

getOrganizationDevicesStatusesAsync()

Operation getOrganizationDevicesStatusesAsync


    public
                getOrganizationDevicesStatusesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the status of every Meraki device 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)

Tags

Return values

PromiseInterface —

getOrganizationDevicesStatusesAsyncWithHttpInfo()

Operation getOrganizationDevicesStatusesAsyncWithHttpInfo


    public
                getOrganizationDevicesStatusesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the status of every Meraki device 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)

Tags

Return values

PromiseInterface —

getOrganizationDevicesStatusesWithHttpInfo()

Operation getOrganizationDevicesStatusesWithHttpInfo


    public
                getOrganizationDevicesStatusesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

List the status of every Meraki device 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)

Tags

Return values

array<string|int, mixed> —

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

getOrganizationDevicesUplinksLossAndLatency()

Operation getOrganizationDevicesUplinksLossAndLatency


    public
                getOrganizationDevicesUplinksLossAndLatency(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : object

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

Parameters

$organization_id : string: organization_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

object —

getOrganizationDevicesUplinksLossAndLatencyAsync()

Operation getOrganizationDevicesUplinksLossAndLatencyAsync


    public
                getOrganizationDevicesUplinksLossAndLatencyAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : PromiseInterface

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo()

Operation getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo


    public
                getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : PromiseInterface

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo()

Operation getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo


    public
                getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : array<string|int, mixed>

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

array<string|int, mixed> —

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

getOrganizationDevicesWithHttpInfo()

Operation getOrganizationDevicesWithHttpInfo


    public
                getOrganizationDevicesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $configuration_updated_after = null ]) : array<string|int, mixed>

List the devices in an 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)
$configuration_updated_after : string = null: Filter results by whether or not the device's configuration has been updated after the given timestamp (optional)

Tags

Return values

array<string|int, mixed> —

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

lockNetworkSmDevices()

Operation lockNetworkSmDevices


    public
                lockNetworkSmDevices(string $network_id[, LockNetworkSmDevices $lock_network_sm_devices = null ]) : object

Lock a set of devices

Parameters

$network_id : string: network_id (required)
$lock_network_sm_devices : LockNetworkSmDevices = null: lock_network_sm_devices (optional)

Tags

Return values

object —

lockNetworkSmDevicesAsync()

Operation lockNetworkSmDevicesAsync


    public
                lockNetworkSmDevicesAsync(string $network_id[, LockNetworkSmDevices $lock_network_sm_devices = null ]) : PromiseInterface

Lock a set of devices

Parameters

$network_id : string: (required)
$lock_network_sm_devices : LockNetworkSmDevices = null: (optional)

Tags

Return values

PromiseInterface —

lockNetworkSmDevicesAsyncWithHttpInfo()

Operation lockNetworkSmDevicesAsyncWithHttpInfo


    public
                lockNetworkSmDevicesAsyncWithHttpInfo(string $network_id[, LockNetworkSmDevices $lock_network_sm_devices = null ]) : PromiseInterface

Lock a set of devices

Parameters

$network_id : string: (required)
$lock_network_sm_devices : LockNetworkSmDevices = null: (optional)

Tags

Return values

PromiseInterface —

lockNetworkSmDevicesWithHttpInfo()

Operation lockNetworkSmDevicesWithHttpInfo


    public
                lockNetworkSmDevicesWithHttpInfo(string $network_id[, LockNetworkSmDevices $lock_network_sm_devices = null ]) : array<string|int, mixed>

Lock a set of devices

Parameters

$network_id : string: (required)
$lock_network_sm_devices : LockNetworkSmDevices = null: (optional)

Tags

Return values

array<string|int, mixed> —

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

modifyNetworkSmDevicesTags()

Operation modifyNetworkSmDevicesTags


    public
                modifyNetworkSmDevicesTags(string $network_id, ModifyNetworkSmDevicesTags $modify_network_sm_devices_tags) : object

Add, delete, or update the tags of a set of devices

Parameters

$network_id : string: network_id (required)
$modify_network_sm_devices_tags : ModifyNetworkSmDevicesTags: modify_network_sm_devices_tags (required)

Tags

Return values

object —

modifyNetworkSmDevicesTagsAsync()

Operation modifyNetworkSmDevicesTagsAsync


    public
                modifyNetworkSmDevicesTagsAsync(string $network_id, ModifyNetworkSmDevicesTags $modify_network_sm_devices_tags) : PromiseInterface

Add, delete, or update the tags of a set of devices

Parameters

$network_id : string: (required)
$modify_network_sm_devices_tags : ModifyNetworkSmDevicesTags: (required)

Tags

Return values

PromiseInterface —

modifyNetworkSmDevicesTagsAsyncWithHttpInfo()

Operation modifyNetworkSmDevicesTagsAsyncWithHttpInfo


    public
                modifyNetworkSmDevicesTagsAsyncWithHttpInfo(string $network_id, ModifyNetworkSmDevicesTags $modify_network_sm_devices_tags) : PromiseInterface

Add, delete, or update the tags of a set of devices

Parameters

$network_id : string: (required)
$modify_network_sm_devices_tags : ModifyNetworkSmDevicesTags: (required)

Tags

Return values

PromiseInterface —

modifyNetworkSmDevicesTagsWithHttpInfo()

Operation modifyNetworkSmDevicesTagsWithHttpInfo


    public
                modifyNetworkSmDevicesTagsWithHttpInfo(string $network_id, ModifyNetworkSmDevicesTags $modify_network_sm_devices_tags) : array<string|int, mixed>

Add, delete, or update the tags of a set of devices

Parameters

$network_id : string: (required)
$modify_network_sm_devices_tags : ModifyNetworkSmDevicesTags: (required)

Tags

Return values

array<string|int, mixed> —

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

moveNetworkSmDevices()

Operation moveNetworkSmDevices


    public
                moveNetworkSmDevices(string $network_id, MoveNetworkSmDevices $move_network_sm_devices) : object

Move a set of devices to a new network

Parameters

$network_id : string: network_id (required)
$move_network_sm_devices : MoveNetworkSmDevices: move_network_sm_devices (required)

Tags

Return values

object —

moveNetworkSmDevicesAsync()

Operation moveNetworkSmDevicesAsync


    public
                moveNetworkSmDevicesAsync(string $network_id, MoveNetworkSmDevices $move_network_sm_devices) : PromiseInterface

Move a set of devices to a new network

Parameters

$network_id : string: (required)
$move_network_sm_devices : MoveNetworkSmDevices: (required)

Tags

Return values

PromiseInterface —

moveNetworkSmDevicesAsyncWithHttpInfo()

Operation moveNetworkSmDevicesAsyncWithHttpInfo


    public
                moveNetworkSmDevicesAsyncWithHttpInfo(string $network_id, MoveNetworkSmDevices $move_network_sm_devices) : PromiseInterface

Move a set of devices to a new network

Parameters

$network_id : string: (required)
$move_network_sm_devices : MoveNetworkSmDevices: (required)

Tags

Return values

PromiseInterface —

moveNetworkSmDevicesWithHttpInfo()

Operation moveNetworkSmDevicesWithHttpInfo


    public
                moveNetworkSmDevicesWithHttpInfo(string $network_id, MoveNetworkSmDevices $move_network_sm_devices) : array<string|int, mixed>

Move a set of devices to a new network

Parameters

$network_id : string: (required)
$move_network_sm_devices : MoveNetworkSmDevices: (required)

Tags

Return values

array<string|int, mixed> —

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

rebootDevice()

Operation rebootDevice


    public
                rebootDevice(string $serial) : object

Reboot a device

Parameters

$serial : string: serial (required)

Tags

Return values

object —

rebootDeviceAsync()

Operation rebootDeviceAsync


    public
                rebootDeviceAsync(string $serial) : PromiseInterface

Reboot a device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

rebootDeviceAsyncWithHttpInfo()

Operation rebootDeviceAsyncWithHttpInfo


    public
                rebootDeviceAsyncWithHttpInfo(string $serial) : PromiseInterface

Reboot a device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

rebootDeviceWithHttpInfo()

Operation rebootDeviceWithHttpInfo


    public
                rebootDeviceWithHttpInfo(string $serial) : array<string|int, mixed>

Reboot a device

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

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

refreshNetworkSmDeviceDetails()

Operation refreshNetworkSmDeviceDetails


    public
                refreshNetworkSmDeviceDetails(string $network_id, string $device_id) : void

Refresh the details of a device

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

void —

refreshNetworkSmDeviceDetailsAsync()

Operation refreshNetworkSmDeviceDetailsAsync


    public
                refreshNetworkSmDeviceDetailsAsync(string $network_id, string $device_id) : PromiseInterface

Refresh the details of a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

refreshNetworkSmDeviceDetailsAsyncWithHttpInfo()

Operation refreshNetworkSmDeviceDetailsAsyncWithHttpInfo


    public
                refreshNetworkSmDeviceDetailsAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

Refresh the details of a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

refreshNetworkSmDeviceDetailsWithHttpInfo()

Operation refreshNetworkSmDeviceDetailsWithHttpInfo


    public
                refreshNetworkSmDeviceDetailsWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

Refresh the details of a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

removeNetworkDevices()

Operation removeNetworkDevices


    public
                removeNetworkDevices(string $network_id, RemoveNetworkDevices $remove_network_devices) : void

Remove a single device

Parameters

$network_id : string: network_id (required)
$remove_network_devices : RemoveNetworkDevices: remove_network_devices (required)

Tags

Return values

void —

removeNetworkDevicesAsync()

Operation removeNetworkDevicesAsync


    public
                removeNetworkDevicesAsync(string $network_id, RemoveNetworkDevices $remove_network_devices) : PromiseInterface

Remove a single device

Parameters

$network_id : string: (required)
$remove_network_devices : RemoveNetworkDevices: (required)

Tags

Return values

PromiseInterface —

removeNetworkDevicesAsyncWithHttpInfo()

Operation removeNetworkDevicesAsyncWithHttpInfo


    public
                removeNetworkDevicesAsyncWithHttpInfo(string $network_id, RemoveNetworkDevices $remove_network_devices) : PromiseInterface

Remove a single device

Parameters

$network_id : string: (required)
$remove_network_devices : RemoveNetworkDevices: (required)

Tags

Return values

PromiseInterface —

removeNetworkDevicesWithHttpInfo()

Operation removeNetworkDevicesWithHttpInfo


    public
                removeNetworkDevicesWithHttpInfo(string $network_id, RemoveNetworkDevices $remove_network_devices) : array<string|int, mixed>

Remove a single device

Parameters

$network_id : string: (required)
$remove_network_devices : RemoveNetworkDevices: (required)

Tags

Return values

array<string|int, mixed> —

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

unenrollNetworkSmDevice()

Operation unenrollNetworkSmDevice


    public
                unenrollNetworkSmDevice(string $network_id, string $device_id) : object

Unenroll a device

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

unenrollNetworkSmDeviceAsync()

Operation unenrollNetworkSmDeviceAsync


    public
                unenrollNetworkSmDeviceAsync(string $network_id, string $device_id) : PromiseInterface

Unenroll a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

unenrollNetworkSmDeviceAsyncWithHttpInfo()

Operation unenrollNetworkSmDeviceAsyncWithHttpInfo


    public
                unenrollNetworkSmDeviceAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

Unenroll a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

unenrollNetworkSmDeviceWithHttpInfo()

Operation unenrollNetworkSmDeviceWithHttpInfo


    public
                unenrollNetworkSmDeviceWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

Unenroll a device

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

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

updateDevice()

Operation updateDevice


    public
                updateDevice(string $serial[, UpdateDevice $update_device = null ]) : object

Update the attributes of a device

Parameters

$serial : string: serial (required)
$update_device : UpdateDevice = null: update_device (optional)

Tags

Return values

object —

updateDeviceAsync()

Operation updateDeviceAsync


    public
                updateDeviceAsync(string $serial[, UpdateDevice $update_device = null ]) : PromiseInterface

Update the attributes of a device

Parameters

$serial : string: (required)
$update_device : UpdateDevice = null: (optional)

Tags

Return values

PromiseInterface —

updateDeviceAsyncWithHttpInfo()

Operation updateDeviceAsyncWithHttpInfo


    public
                updateDeviceAsyncWithHttpInfo(string $serial[, UpdateDevice $update_device = null ]) : PromiseInterface

Update the attributes of a device

Parameters

$serial : string: (required)
$update_device : UpdateDevice = null: (optional)

Tags

Return values

PromiseInterface —

updateDeviceManagementInterface()

Operation updateDeviceManagementInterface


    public
                updateDeviceManagementInterface(string $serial[, UpdateDeviceManagementInterface $update_device_management_interface = null ]) : object

Update the management interface settings for a device

Parameters

$serial : string: serial (required)
$update_device_management_interface : UpdateDeviceManagementInterface = null: update_device_management_interface (optional)

Tags

Return values

object —

updateDeviceManagementInterfaceAsync()

Operation updateDeviceManagementInterfaceAsync


    public
                updateDeviceManagementInterfaceAsync(string $serial[, UpdateDeviceManagementInterface $update_device_management_interface = null ]) : PromiseInterface

Update the management interface settings for a device

Parameters

$serial : string: (required)
$update_device_management_interface : UpdateDeviceManagementInterface = null: (optional)

Tags

Return values

PromiseInterface —

updateDeviceManagementInterfaceAsyncWithHttpInfo()

Operation updateDeviceManagementInterfaceAsyncWithHttpInfo


    public
                updateDeviceManagementInterfaceAsyncWithHttpInfo(string $serial[, UpdateDeviceManagementInterface $update_device_management_interface = null ]) : PromiseInterface

Update the management interface settings for a device

Parameters

$serial : string: (required)
$update_device_management_interface : UpdateDeviceManagementInterface = null: (optional)

Tags

Return values

PromiseInterface —

updateDeviceManagementInterfaceWithHttpInfo()

Operation updateDeviceManagementInterfaceWithHttpInfo


    public
                updateDeviceManagementInterfaceWithHttpInfo(string $serial[, UpdateDeviceManagementInterface $update_device_management_interface = null ]) : array<string|int, mixed>

Update the management interface settings for a device

Parameters

$serial : string: (required)
$update_device_management_interface : UpdateDeviceManagementInterface = null: (optional)

Tags

Return values

array<string|int, mixed> —

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

updateDeviceWithHttpInfo()

Operation updateDeviceWithHttpInfo


    public
                updateDeviceWithHttpInfo(string $serial[, UpdateDevice $update_device = null ]) : array<string|int, mixed>

Update the attributes of a device

Parameters

$serial : string: (required)
$update_device : UpdateDevice = null: (optional)

Tags

Return values

array<string|int, mixed> —

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

updateNetworkSmDevicesFields()

Operation updateNetworkSmDevicesFields


    public
                updateNetworkSmDevicesFields(string $network_id, UpdateNetworkSmDevicesFields $update_network_sm_devices_fields) : object

Modify the fields of a device

Parameters

$network_id : string: network_id (required)
$update_network_sm_devices_fields : UpdateNetworkSmDevicesFields: update_network_sm_devices_fields (required)

Tags

Return values

object —

updateNetworkSmDevicesFieldsAsync()

Operation updateNetworkSmDevicesFieldsAsync


    public
                updateNetworkSmDevicesFieldsAsync(string $network_id, UpdateNetworkSmDevicesFields $update_network_sm_devices_fields) : PromiseInterface

Modify the fields of a device

Parameters

$network_id : string: (required)
$update_network_sm_devices_fields : UpdateNetworkSmDevicesFields: (required)

Tags

Return values

PromiseInterface —

updateNetworkSmDevicesFieldsAsyncWithHttpInfo()

Operation updateNetworkSmDevicesFieldsAsyncWithHttpInfo


    public
                updateNetworkSmDevicesFieldsAsyncWithHttpInfo(string $network_id, UpdateNetworkSmDevicesFields $update_network_sm_devices_fields) : PromiseInterface

Modify the fields of a device

Parameters

$network_id : string: (required)
$update_network_sm_devices_fields : UpdateNetworkSmDevicesFields: (required)

Tags

Return values

PromiseInterface —

updateNetworkSmDevicesFieldsWithHttpInfo()

Operation updateNetworkSmDevicesFieldsWithHttpInfo


    public
                updateNetworkSmDevicesFieldsWithHttpInfo(string $network_id, UpdateNetworkSmDevicesFields $update_network_sm_devices_fields) : array<string|int, mixed>

Modify the fields of a device

Parameters

$network_id : string: (required)
$update_network_sm_devices_fields : UpdateNetworkSmDevicesFields: (required)

Tags

Return values

array<string|int, mixed> —

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

wipeNetworkSmDevices()

Operation wipeNetworkSmDevices


    public
                wipeNetworkSmDevices(string $network_id[, WipeNetworkSmDevices $wipe_network_sm_devices = null ]) : object

Wipe a device

Parameters

$network_id : string: network_id (required)
$wipe_network_sm_devices : WipeNetworkSmDevices = null: wipe_network_sm_devices (optional)

Tags

Return values

object —

wipeNetworkSmDevicesAsync()

Operation wipeNetworkSmDevicesAsync


    public
                wipeNetworkSmDevicesAsync(string $network_id[, WipeNetworkSmDevices $wipe_network_sm_devices = null ]) : PromiseInterface

Wipe a device

Parameters

$network_id : string: (required)
$wipe_network_sm_devices : WipeNetworkSmDevices = null: (optional)

Tags

Return values

PromiseInterface —

wipeNetworkSmDevicesAsyncWithHttpInfo()

Operation wipeNetworkSmDevicesAsyncWithHttpInfo


    public
                wipeNetworkSmDevicesAsyncWithHttpInfo(string $network_id[, WipeNetworkSmDevices $wipe_network_sm_devices = null ]) : PromiseInterface

Wipe a device

Parameters

$network_id : string: (required)
$wipe_network_sm_devices : WipeNetworkSmDevices = null: (optional)

Tags

Return values

PromiseInterface —

wipeNetworkSmDevicesWithHttpInfo()

Operation wipeNetworkSmDevicesWithHttpInfo


    public
                wipeNetworkSmDevicesWithHttpInfo(string $network_id[, WipeNetworkSmDevices $wipe_network_sm_devices = null ]) : array<string|int, mixed>

Wipe a device

Parameters

$network_id : string: (required)
$wipe_network_sm_devices : WipeNetworkSmDevices = null: (optional)

Tags

Return values

array<string|int, mixed> —

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

blinkDeviceLedsRequest()

Create request for operation 'blinkDeviceLeds'


    protected
                blinkDeviceLedsRequest(string $serial[, BlinkDeviceLeds $blink_device_leds = null ]) : Request

Parameters

$serial : string: (required)
$blink_device_leds : BlinkDeviceLeds = null: (optional)

Tags

Return values

Request —

checkinNetworkSmDevicesRequest()

Create request for operation 'checkinNetworkSmDevices'


    protected
                checkinNetworkSmDevicesRequest(string $network_id[, CheckinNetworkSmDevices $checkin_network_sm_devices = null ]) : Request

Parameters

$network_id : string: (required)
$checkin_network_sm_devices : CheckinNetworkSmDevices = null: (optional)

Tags

Return values

Request —

claimNetworkDevicesRequest()

Create request for operation 'claimNetworkDevices'


    protected
                claimNetworkDevicesRequest(string $network_id, ClaimNetworkDevices $claim_network_devices) : Request

Parameters

$network_id : string: (required)
$claim_network_devices : ClaimNetworkDevices: (required)

Tags

Return values

Request —

cloneOrganizationSwitchDevicesRequest()

Create request for operation 'cloneOrganizationSwitchDevices'


    protected
                cloneOrganizationSwitchDevicesRequest(string $organization_id, CloneOrganizationSwitchDevices $clone_organization_switch_devices) : Request

Parameters

$organization_id : string: (required)
$clone_organization_switch_devices : CloneOrganizationSwitchDevices: (required)

Tags

Return values

Request —

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 —

getDeviceLldpCdpRequest()

Create request for operation 'getDeviceLldpCdp'


    protected
                getDeviceLldpCdpRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

getDeviceLossAndLatencyHistoryRequest()

Create request for operation 'getDeviceLossAndLatencyHistory'


    protected
                getDeviceLossAndLatencyHistoryRequest(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : Request

Parameters

$serial : string: (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 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: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

Request —

getDeviceManagementInterfaceRequest()

Create request for operation 'getDeviceManagementInterface'


    protected
                getDeviceManagementInterfaceRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

getDeviceRequest()

Create request for operation 'getDevice'


    protected
                getDeviceRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

getNetworkDevicesRequest()

Create request for operation 'getNetworkDevices'


    protected
                getNetworkDevicesRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkSmDeviceCellularUsageHistoryRequest()

Create request for operation 'getNetworkSmDeviceCellularUsageHistory'


    protected
                getNetworkSmDeviceCellularUsageHistoryRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

getNetworkSmDeviceCertsRequest()

Create request for operation 'getNetworkSmDeviceCerts'


    protected
                getNetworkSmDeviceCertsRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

getNetworkSmDeviceConnectivityRequest()

Create request for operation 'getNetworkSmDeviceConnectivity'


    protected
                getNetworkSmDeviceConnectivityRequest(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

Request —

getNetworkSmDeviceDesktopLogsRequest()

Create request for operation 'getNetworkSmDeviceDesktopLogs'


    protected
                getNetworkSmDeviceDesktopLogsRequest(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

Request —

getNetworkSmDeviceDeviceCommandLogsRequest()

Create request for operation 'getNetworkSmDeviceDeviceCommandLogs'


    protected
                getNetworkSmDeviceDeviceCommandLogsRequest(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

Request —

getNetworkSmDeviceDeviceProfilesRequest()

Create request for operation 'getNetworkSmDeviceDeviceProfiles'


    protected
                getNetworkSmDeviceDeviceProfilesRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

getNetworkSmDeviceNetworkAdaptersRequest()

Create request for operation 'getNetworkSmDeviceNetworkAdapters'


    protected
                getNetworkSmDeviceNetworkAdaptersRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

getNetworkSmDevicePerformanceHistoryRequest()

Create request for operation 'getNetworkSmDevicePerformanceHistory'


    protected
                getNetworkSmDevicePerformanceHistoryRequest(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$device_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)

Tags

Return values

Request —

getNetworkSmDeviceRestrictionsRequest()

Create request for operation 'getNetworkSmDeviceRestrictions'


    protected
                getNetworkSmDeviceRestrictionsRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

getNetworkSmDeviceSecurityCentersRequest()

Create request for operation 'getNetworkSmDeviceSecurityCenters'


    protected
                getNetworkSmDeviceSecurityCentersRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

getNetworkSmDeviceSoftwaresRequest()

Create request for operation 'getNetworkSmDeviceSoftwares'


    protected
                getNetworkSmDeviceSoftwaresRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

getNetworkSmDevicesRequest()

Create request for operation 'getNetworkSmDevices'


    protected
                getNetworkSmDevicesRequest(string $network_id[, array<string|int, string> $fields = null ][, array<string|int, string> $wifi_macs = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $ids = null ][, array<string|int, string> $scope = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$fields : array<string|int, string> = null: Additional fields that will be displayed for each device. The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip, systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser, ownerEmail, ownerUsername, osBuild, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid, simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName, isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled, hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, and androidSecurityPatchVersion. (optional)
$wifi_macs : array<string|int, string> = null: Filter devices by wifi mac(s). (optional)
$serials : array<string|int, string> = null: Filter devices by serial(s). (optional)
$ids : array<string|int, string> = null: Filter devices by id(s). (optional)
$scope : array<string|int, string> = null: Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags. (optional)
$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)

Tags

Return values

Request —

getNetworkSmDeviceWlanListsRequest()

Create request for operation 'getNetworkSmDeviceWlanLists'


    protected
                getNetworkSmDeviceWlanListsRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

getNetworkWirelessDevicesConnectionStatsRequest()

Create request for operation 'getNetworkWirelessDevicesConnectionStats'


    protected
                getNetworkWirelessDevicesConnectionStatsRequest(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 —

getNetworkWirelessDevicesLatencyStatsRequest()

Create request for operation 'getNetworkWirelessDevicesLatencyStats'


    protected
                getNetworkWirelessDevicesLatencyStatsRequest(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 —

getOrganizationDevicesRequest()

Create request for operation 'getOrganizationDevices'


    protected
                getOrganizationDevicesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $configuration_updated_after = 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)
$configuration_updated_after : string = null: Filter results by whether or not the device's configuration has been updated after the given timestamp (optional)

Tags

Return values

Request —

getOrganizationDevicesStatusesRequest()

Create request for operation 'getOrganizationDevicesStatuses'


    protected
                getOrganizationDevicesStatusesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = 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)

Tags

Return values

Request —

getOrganizationDevicesUplinksLossAndLatencyRequest()

Create request for operation 'getOrganizationDevicesUplinksLossAndLatency'


    protected
                getOrganizationDevicesUplinksLossAndLatencyRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : Request

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

Request —

lockNetworkSmDevicesRequest()

Create request for operation 'lockNetworkSmDevices'


    protected
                lockNetworkSmDevicesRequest(string $network_id[, LockNetworkSmDevices $lock_network_sm_devices = null ]) : Request

Parameters

$network_id : string: (required)
$lock_network_sm_devices : LockNetworkSmDevices = null: (optional)

Tags

Return values

Request —

modifyNetworkSmDevicesTagsRequest()

Create request for operation 'modifyNetworkSmDevicesTags'


    protected
                modifyNetworkSmDevicesTagsRequest(string $network_id, ModifyNetworkSmDevicesTags $modify_network_sm_devices_tags) : Request

Parameters

$network_id : string: (required)
$modify_network_sm_devices_tags : ModifyNetworkSmDevicesTags: (required)

Tags

Return values

Request —

moveNetworkSmDevicesRequest()

Create request for operation 'moveNetworkSmDevices'


    protected
                moveNetworkSmDevicesRequest(string $network_id, MoveNetworkSmDevices $move_network_sm_devices) : Request

Parameters

$network_id : string: (required)
$move_network_sm_devices : MoveNetworkSmDevices: (required)

Tags

Return values

Request —

rebootDeviceRequest()

Create request for operation 'rebootDevice'


    protected
                rebootDeviceRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

refreshNetworkSmDeviceDetailsRequest()

Create request for operation 'refreshNetworkSmDeviceDetails'


    protected
                refreshNetworkSmDeviceDetailsRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

removeNetworkDevicesRequest()

Create request for operation 'removeNetworkDevices'


    protected
                removeNetworkDevicesRequest(string $network_id, RemoveNetworkDevices $remove_network_devices) : Request

Parameters

$network_id : string: (required)
$remove_network_devices : RemoveNetworkDevices: (required)

Tags

Return values

Request —

unenrollNetworkSmDeviceRequest()

Create request for operation 'unenrollNetworkSmDevice'


    protected
                unenrollNetworkSmDeviceRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

updateDeviceManagementInterfaceRequest()

Create request for operation 'updateDeviceManagementInterface'


    protected
                updateDeviceManagementInterfaceRequest(string $serial[, UpdateDeviceManagementInterface $update_device_management_interface = null ]) : Request

Parameters

$serial : string: (required)
$update_device_management_interface : UpdateDeviceManagementInterface = null: (optional)

Tags

Return values

Request —

updateDeviceRequest()

Create request for operation 'updateDevice'


    protected
                updateDeviceRequest(string $serial[, UpdateDevice $update_device = null ]) : Request

Parameters

$serial : string: (required)
$update_device : UpdateDevice = null: (optional)

Tags

Return values

Request —

updateNetworkSmDevicesFieldsRequest()

Create request for operation 'updateNetworkSmDevicesFields'


    protected
                updateNetworkSmDevicesFieldsRequest(string $network_id, UpdateNetworkSmDevicesFields $update_network_sm_devices_fields) : Request

Parameters

$network_id : string: (required)
$update_network_sm_devices_fields : UpdateNetworkSmDevicesFields: (required)

Tags

Return values

Request —

wipeNetworkSmDevicesRequest()

Create request for operation 'wipeNetworkSmDevices'


    protected
                wipeNetworkSmDevicesRequest(string $network_id[, WipeNetworkSmDevices $wipe_network_sm_devices = null ]) : Request

DevicesApi

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

blinkDeviceLeds()

Parameters

Tags

Return values

blinkDeviceLedsAsync()

Parameters

Tags

Return values

blinkDeviceLedsAsyncWithHttpInfo()

Parameters

Tags

Return values

blinkDeviceLedsWithHttpInfo()

Parameters

Tags

Return values

checkinNetworkSmDevices()

Parameters

Tags

Return values

checkinNetworkSmDevicesAsync()

Parameters

Tags

Return values

checkinNetworkSmDevicesAsyncWithHttpInfo()

Parameters

Tags

Return values

checkinNetworkSmDevicesWithHttpInfo()

Parameters

Tags

Return values

claimNetworkDevices()

Parameters

Tags

Return values

claimNetworkDevicesAsync()

Parameters

Tags

Return values

claimNetworkDevicesAsyncWithHttpInfo()

Parameters

Tags

Return values

claimNetworkDevicesWithHttpInfo()

Parameters

Tags

Return values

cloneOrganizationSwitchDevices()

Parameters

Tags

Return values

cloneOrganizationSwitchDevicesAsync()

Parameters

Tags

Return values

cloneOrganizationSwitchDevicesAsyncWithHttpInfo()

Parameters

Tags

Return values

cloneOrganizationSwitchDevicesWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getDevice()

Parameters

Tags