WarmSpareApi
WarmSpareApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getDeviceSwitchWarmSpare() : object
- Operation getDeviceSwitchWarmSpare
- getDeviceSwitchWarmSpareAsync() : PromiseInterface
- Operation getDeviceSwitchWarmSpareAsync
- getDeviceSwitchWarmSpareAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceSwitchWarmSpareAsyncWithHttpInfo
- getDeviceSwitchWarmSpareWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceSwitchWarmSpareWithHttpInfo
- getNetworkApplianceWarmSpare() : object
- Operation getNetworkApplianceWarmSpare
- getNetworkApplianceWarmSpareAsync() : PromiseInterface
- Operation getNetworkApplianceWarmSpareAsync
- getNetworkApplianceWarmSpareAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkApplianceWarmSpareAsyncWithHttpInfo
- getNetworkApplianceWarmSpareWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkApplianceWarmSpareWithHttpInfo
- swapNetworkApplianceWarmSpare() : object
- Operation swapNetworkApplianceWarmSpare
- swapNetworkApplianceWarmSpareAsync() : PromiseInterface
- Operation swapNetworkApplianceWarmSpareAsync
- swapNetworkApplianceWarmSpareAsyncWithHttpInfo() : PromiseInterface
- Operation swapNetworkApplianceWarmSpareAsyncWithHttpInfo
- swapNetworkApplianceWarmSpareWithHttpInfo() : array<string|int, mixed>
- Operation swapNetworkApplianceWarmSpareWithHttpInfo
- updateDeviceSwitchWarmSpare() : object
- Operation updateDeviceSwitchWarmSpare
- updateDeviceSwitchWarmSpareAsync() : PromiseInterface
- Operation updateDeviceSwitchWarmSpareAsync
- updateDeviceSwitchWarmSpareAsyncWithHttpInfo() : PromiseInterface
- Operation updateDeviceSwitchWarmSpareAsyncWithHttpInfo
- updateDeviceSwitchWarmSpareWithHttpInfo() : array<string|int, mixed>
- Operation updateDeviceSwitchWarmSpareWithHttpInfo
- updateNetworkApplianceWarmSpare() : object
- Operation updateNetworkApplianceWarmSpare
- updateNetworkApplianceWarmSpareAsync() : PromiseInterface
- Operation updateNetworkApplianceWarmSpareAsync
- updateNetworkApplianceWarmSpareAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkApplianceWarmSpareAsyncWithHttpInfo
- updateNetworkApplianceWarmSpareWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkApplianceWarmSpareWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getDeviceSwitchWarmSpareRequest() : Request
- Create request for operation 'getDeviceSwitchWarmSpare'
- getNetworkApplianceWarmSpareRequest() : Request
- Create request for operation 'getNetworkApplianceWarmSpare'
- swapNetworkApplianceWarmSpareRequest() : Request
- Create request for operation 'swapNetworkApplianceWarmSpare'
- updateDeviceSwitchWarmSpareRequest() : Request
- Create request for operation 'updateDeviceSwitchWarmSpare'
- updateNetworkApplianceWarmSpareRequest() : Request
- Create request for operation 'updateNetworkApplianceWarmSpare'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getDeviceSwitchWarmSpare()
Operation getDeviceSwitchWarmSpare
public
getDeviceSwitchWarmSpare(string $serial) : object
Return warm spare configuration for a switch
Parameters
- $serial : string
-
serial (required)
Tags
Return values
object —getDeviceSwitchWarmSpareAsync()
Operation getDeviceSwitchWarmSpareAsync
public
getDeviceSwitchWarmSpareAsync(string $serial) : PromiseInterface
Return warm spare configuration for a switch
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceSwitchWarmSpareAsyncWithHttpInfo()
Operation getDeviceSwitchWarmSpareAsyncWithHttpInfo
public
getDeviceSwitchWarmSpareAsyncWithHttpInfo(string $serial) : PromiseInterface
Return warm spare configuration for a switch
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceSwitchWarmSpareWithHttpInfo()
Operation getDeviceSwitchWarmSpareWithHttpInfo
public
getDeviceSwitchWarmSpareWithHttpInfo(string $serial) : array<string|int, mixed>
Return warm spare configuration for a switch
Parameters
- $serial : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkApplianceWarmSpare()
Operation getNetworkApplianceWarmSpare
public
getNetworkApplianceWarmSpare(string $network_id) : object
Return MX warm spare settings
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkApplianceWarmSpareAsync()
Operation getNetworkApplianceWarmSpareAsync
public
getNetworkApplianceWarmSpareAsync(string $network_id) : PromiseInterface
Return MX warm spare settings
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceWarmSpareAsyncWithHttpInfo()
Operation getNetworkApplianceWarmSpareAsyncWithHttpInfo
public
getNetworkApplianceWarmSpareAsyncWithHttpInfo(string $network_id) : PromiseInterface
Return MX warm spare settings
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceWarmSpareWithHttpInfo()
Operation getNetworkApplianceWarmSpareWithHttpInfo
public
getNetworkApplianceWarmSpareWithHttpInfo(string $network_id) : array<string|int, mixed>
Return MX warm spare settings
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
swapNetworkApplianceWarmSpare()
Operation swapNetworkApplianceWarmSpare
public
swapNetworkApplianceWarmSpare(string $network_id) : object
Swap MX primary and warm spare appliances
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —swapNetworkApplianceWarmSpareAsync()
Operation swapNetworkApplianceWarmSpareAsync
public
swapNetworkApplianceWarmSpareAsync(string $network_id) : PromiseInterface
Swap MX primary and warm spare appliances
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —swapNetworkApplianceWarmSpareAsyncWithHttpInfo()
Operation swapNetworkApplianceWarmSpareAsyncWithHttpInfo
public
swapNetworkApplianceWarmSpareAsyncWithHttpInfo(string $network_id) : PromiseInterface
Swap MX primary and warm spare appliances
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —swapNetworkApplianceWarmSpareWithHttpInfo()
Operation swapNetworkApplianceWarmSpareWithHttpInfo
public
swapNetworkApplianceWarmSpareWithHttpInfo(string $network_id) : array<string|int, mixed>
Swap MX primary and warm spare appliances
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateDeviceSwitchWarmSpare()
Operation updateDeviceSwitchWarmSpare
public
updateDeviceSwitchWarmSpare(string $serial, UpdateDeviceSwitchWarmSpare $update_device_switch_warm_spare) : object
Update warm spare configuration for a switch
Parameters
- $serial : string
-
serial (required)
- $update_device_switch_warm_spare : UpdateDeviceSwitchWarmSpare
-
update_device_switch_warm_spare (required)
Tags
Return values
object —updateDeviceSwitchWarmSpareAsync()
Operation updateDeviceSwitchWarmSpareAsync
public
updateDeviceSwitchWarmSpareAsync(string $serial, UpdateDeviceSwitchWarmSpare $update_device_switch_warm_spare) : PromiseInterface
Update warm spare configuration for a switch
Parameters
- $serial : string
-
(required)
- $update_device_switch_warm_spare : UpdateDeviceSwitchWarmSpare
-
(required)
Tags
Return values
PromiseInterface —updateDeviceSwitchWarmSpareAsyncWithHttpInfo()
Operation updateDeviceSwitchWarmSpareAsyncWithHttpInfo
public
updateDeviceSwitchWarmSpareAsyncWithHttpInfo(string $serial, UpdateDeviceSwitchWarmSpare $update_device_switch_warm_spare) : PromiseInterface
Update warm spare configuration for a switch
Parameters
- $serial : string
-
(required)
- $update_device_switch_warm_spare : UpdateDeviceSwitchWarmSpare
-
(required)
Tags
Return values
PromiseInterface —updateDeviceSwitchWarmSpareWithHttpInfo()
Operation updateDeviceSwitchWarmSpareWithHttpInfo
public
updateDeviceSwitchWarmSpareWithHttpInfo(string $serial, UpdateDeviceSwitchWarmSpare $update_device_switch_warm_spare) : array<string|int, mixed>
Update warm spare configuration for a switch
Parameters
- $serial : string
-
(required)
- $update_device_switch_warm_spare : UpdateDeviceSwitchWarmSpare
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkApplianceWarmSpare()
Operation updateNetworkApplianceWarmSpare
public
updateNetworkApplianceWarmSpare(string $network_id, UpdateNetworkApplianceWarmSpare $update_network_appliance_warm_spare) : object
Update MX warm spare settings
Parameters
- $network_id : string
-
network_id (required)
- $update_network_appliance_warm_spare : UpdateNetworkApplianceWarmSpare
-
update_network_appliance_warm_spare (required)
Tags
Return values
object —updateNetworkApplianceWarmSpareAsync()
Operation updateNetworkApplianceWarmSpareAsync
public
updateNetworkApplianceWarmSpareAsync(string $network_id, UpdateNetworkApplianceWarmSpare $update_network_appliance_warm_spare) : PromiseInterface
Update MX warm spare settings
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_warm_spare : UpdateNetworkApplianceWarmSpare
-
(required)
Tags
Return values
PromiseInterface —updateNetworkApplianceWarmSpareAsyncWithHttpInfo()
Operation updateNetworkApplianceWarmSpareAsyncWithHttpInfo
public
updateNetworkApplianceWarmSpareAsyncWithHttpInfo(string $network_id, UpdateNetworkApplianceWarmSpare $update_network_appliance_warm_spare) : PromiseInterface
Update MX warm spare settings
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_warm_spare : UpdateNetworkApplianceWarmSpare
-
(required)
Tags
Return values
PromiseInterface —updateNetworkApplianceWarmSpareWithHttpInfo()
Operation updateNetworkApplianceWarmSpareWithHttpInfo
public
updateNetworkApplianceWarmSpareWithHttpInfo(string $network_id, UpdateNetworkApplianceWarmSpare $update_network_appliance_warm_spare) : array<string|int, mixed>
Update MX warm spare settings
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_warm_spare : UpdateNetworkApplianceWarmSpare
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
getDeviceSwitchWarmSpareRequest()
Create request for operation 'getDeviceSwitchWarmSpare'
protected
getDeviceSwitchWarmSpareRequest(string $serial) : Request
Parameters
- $serial : string
-
(required)
Tags
Return values
Request —getNetworkApplianceWarmSpareRequest()
Create request for operation 'getNetworkApplianceWarmSpare'
protected
getNetworkApplianceWarmSpareRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —swapNetworkApplianceWarmSpareRequest()
Create request for operation 'swapNetworkApplianceWarmSpare'
protected
swapNetworkApplianceWarmSpareRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —updateDeviceSwitchWarmSpareRequest()
Create request for operation 'updateDeviceSwitchWarmSpare'
protected
updateDeviceSwitchWarmSpareRequest(string $serial, UpdateDeviceSwitchWarmSpare $update_device_switch_warm_spare) : Request
Parameters
- $serial : string
-
(required)
- $update_device_switch_warm_spare : UpdateDeviceSwitchWarmSpare
-
(required)
Tags
Return values
Request —updateNetworkApplianceWarmSpareRequest()
Create request for operation 'updateNetworkApplianceWarmSpare'
protected
updateNetworkApplianceWarmSpareRequest(string $network_id, UpdateNetworkApplianceWarmSpare $update_network_appliance_warm_spare) : Request
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_warm_spare : UpdateNetworkApplianceWarmSpare
-
(required)