LiveToolsApi
LiveToolsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- blinkDeviceLeds() : object
- Operation blinkDeviceLeds
- blinkDeviceLedsAsync() : PromiseInterface
- Operation blinkDeviceLedsAsync
- blinkDeviceLedsAsyncWithHttpInfo() : PromiseInterface
- Operation blinkDeviceLedsAsyncWithHttpInfo
- blinkDeviceLedsWithHttpInfo() : array<string|int, mixed>
- Operation blinkDeviceLedsWithHttpInfo
- cycleDeviceSwitchPorts() : object
- Operation cycleDeviceSwitchPorts
- cycleDeviceSwitchPortsAsync() : PromiseInterface
- Operation cycleDeviceSwitchPortsAsync
- cycleDeviceSwitchPortsAsyncWithHttpInfo() : PromiseInterface
- Operation cycleDeviceSwitchPortsAsyncWithHttpInfo
- cycleDeviceSwitchPortsWithHttpInfo() : array<string|int, mixed>
- Operation cycleDeviceSwitchPortsWithHttpInfo
- getConfig() : Configuration
- rebootDevice() : object
- Operation rebootDevice
- rebootDeviceAsync() : PromiseInterface
- Operation rebootDeviceAsync
- rebootDeviceAsyncWithHttpInfo() : PromiseInterface
- Operation rebootDeviceAsyncWithHttpInfo
- rebootDeviceWithHttpInfo() : array<string|int, mixed>
- Operation rebootDeviceWithHttpInfo
- blinkDeviceLedsRequest() : Request
- Create request for operation 'blinkDeviceLeds'
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- cycleDeviceSwitchPortsRequest() : Request
- Create request for operation 'cycleDeviceSwitchPorts'
- rebootDeviceRequest() : Request
- Create request for operation 'rebootDevice'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —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)
cycleDeviceSwitchPorts()
Operation cycleDeviceSwitchPorts
public
cycleDeviceSwitchPorts(string $serial, CycleDeviceSwitchPorts $cycle_device_switch_ports) : object
Cycle a set of switch ports
Parameters
- $serial : string
-
serial (required)
- $cycle_device_switch_ports : CycleDeviceSwitchPorts
-
cycle_device_switch_ports (required)
Tags
Return values
object —cycleDeviceSwitchPortsAsync()
Operation cycleDeviceSwitchPortsAsync
public
cycleDeviceSwitchPortsAsync(string $serial, CycleDeviceSwitchPorts $cycle_device_switch_ports) : PromiseInterface
Cycle a set of switch ports
Parameters
- $serial : string
-
(required)
- $cycle_device_switch_ports : CycleDeviceSwitchPorts
-
(required)
Tags
Return values
PromiseInterface —cycleDeviceSwitchPortsAsyncWithHttpInfo()
Operation cycleDeviceSwitchPortsAsyncWithHttpInfo
public
cycleDeviceSwitchPortsAsyncWithHttpInfo(string $serial, CycleDeviceSwitchPorts $cycle_device_switch_ports) : PromiseInterface
Cycle a set of switch ports
Parameters
- $serial : string
-
(required)
- $cycle_device_switch_ports : CycleDeviceSwitchPorts
-
(required)
Tags
Return values
PromiseInterface —cycleDeviceSwitchPortsWithHttpInfo()
Operation cycleDeviceSwitchPortsWithHttpInfo
public
cycleDeviceSwitchPortsWithHttpInfo(string $serial, CycleDeviceSwitchPorts $cycle_device_switch_ports) : array<string|int, mixed>
Cycle a set of switch ports
Parameters
- $serial : string
-
(required)
- $cycle_device_switch_ports : CycleDeviceSwitchPorts
-
(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 —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)
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 —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
cycleDeviceSwitchPortsRequest()
Create request for operation 'cycleDeviceSwitchPorts'
protected
cycleDeviceSwitchPortsRequest(string $serial, CycleDeviceSwitchPorts $cycle_device_switch_ports) : Request
Parameters
- $serial : string
-
(required)
- $cycle_device_switch_ports : CycleDeviceSwitchPorts
-
(required)
Tags
Return values
Request —rebootDeviceRequest()
Create request for operation 'rebootDevice'
protected
rebootDeviceRequest(string $serial) : Request
Parameters
- $serial : string
-
(required)