VlansApi
VlansApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createNetworkApplianceVlan() : object
- Operation createNetworkApplianceVlan
- createNetworkApplianceVlanAsync() : PromiseInterface
- Operation createNetworkApplianceVlanAsync
- createNetworkApplianceVlanAsyncWithHttpInfo() : PromiseInterface
- Operation createNetworkApplianceVlanAsyncWithHttpInfo
- createNetworkApplianceVlanWithHttpInfo() : array<string|int, mixed>
- Operation createNetworkApplianceVlanWithHttpInfo
- deleteNetworkApplianceVlan() : void
- Operation deleteNetworkApplianceVlan
- deleteNetworkApplianceVlanAsync() : PromiseInterface
- Operation deleteNetworkApplianceVlanAsync
- deleteNetworkApplianceVlanAsyncWithHttpInfo() : PromiseInterface
- Operation deleteNetworkApplianceVlanAsyncWithHttpInfo
- deleteNetworkApplianceVlanWithHttpInfo() : array<string|int, mixed>
- Operation deleteNetworkApplianceVlanWithHttpInfo
- getConfig() : Configuration
- getNetworkApplianceVlan() : object
- Operation getNetworkApplianceVlan
- getNetworkApplianceVlanAsync() : PromiseInterface
- Operation getNetworkApplianceVlanAsync
- getNetworkApplianceVlanAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkApplianceVlanAsyncWithHttpInfo
- getNetworkApplianceVlans() : object
- Operation getNetworkApplianceVlans
- getNetworkApplianceVlansAsync() : PromiseInterface
- Operation getNetworkApplianceVlansAsync
- getNetworkApplianceVlansAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkApplianceVlansAsyncWithHttpInfo
- getNetworkApplianceVlansSettings() : object
- Operation getNetworkApplianceVlansSettings
- getNetworkApplianceVlansSettingsAsync() : PromiseInterface
- Operation getNetworkApplianceVlansSettingsAsync
- getNetworkApplianceVlansSettingsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkApplianceVlansSettingsAsyncWithHttpInfo
- getNetworkApplianceVlansSettingsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkApplianceVlansSettingsWithHttpInfo
- getNetworkApplianceVlansWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkApplianceVlansWithHttpInfo
- getNetworkApplianceVlanWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkApplianceVlanWithHttpInfo
- updateNetworkApplianceVlan() : object
- Operation updateNetworkApplianceVlan
- updateNetworkApplianceVlanAsync() : PromiseInterface
- Operation updateNetworkApplianceVlanAsync
- updateNetworkApplianceVlanAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkApplianceVlanAsyncWithHttpInfo
- updateNetworkApplianceVlansSettings() : object
- Operation updateNetworkApplianceVlansSettings
- updateNetworkApplianceVlansSettingsAsync() : PromiseInterface
- Operation updateNetworkApplianceVlansSettingsAsync
- updateNetworkApplianceVlansSettingsAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkApplianceVlansSettingsAsyncWithHttpInfo
- updateNetworkApplianceVlansSettingsWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkApplianceVlansSettingsWithHttpInfo
- updateNetworkApplianceVlanWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkApplianceVlanWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createNetworkApplianceVlanRequest() : Request
- Create request for operation 'createNetworkApplianceVlan'
- deleteNetworkApplianceVlanRequest() : Request
- Create request for operation 'deleteNetworkApplianceVlan'
- getNetworkApplianceVlanRequest() : Request
- Create request for operation 'getNetworkApplianceVlan'
- getNetworkApplianceVlansRequest() : Request
- Create request for operation 'getNetworkApplianceVlans'
- getNetworkApplianceVlansSettingsRequest() : Request
- Create request for operation 'getNetworkApplianceVlansSettings'
- updateNetworkApplianceVlanRequest() : Request
- Create request for operation 'updateNetworkApplianceVlan'
- updateNetworkApplianceVlansSettingsRequest() : Request
- Create request for operation 'updateNetworkApplianceVlansSettings'
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 —createNetworkApplianceVlan()
Operation createNetworkApplianceVlan
public
createNetworkApplianceVlan(string $network_id, CreateNetworkApplianceVlan $create_network_appliance_vlan) : object
Add a VLAN
Parameters
- $network_id : string
-
network_id (required)
- $create_network_appliance_vlan : CreateNetworkApplianceVlan
-
create_network_appliance_vlan (required)
Tags
Return values
object —createNetworkApplianceVlanAsync()
Operation createNetworkApplianceVlanAsync
public
createNetworkApplianceVlanAsync(string $network_id, CreateNetworkApplianceVlan $create_network_appliance_vlan) : PromiseInterface
Add a VLAN
Parameters
- $network_id : string
-
(required)
- $create_network_appliance_vlan : CreateNetworkApplianceVlan
-
(required)
Tags
Return values
PromiseInterface —createNetworkApplianceVlanAsyncWithHttpInfo()
Operation createNetworkApplianceVlanAsyncWithHttpInfo
public
createNetworkApplianceVlanAsyncWithHttpInfo(string $network_id, CreateNetworkApplianceVlan $create_network_appliance_vlan) : PromiseInterface
Add a VLAN
Parameters
- $network_id : string
-
(required)
- $create_network_appliance_vlan : CreateNetworkApplianceVlan
-
(required)
Tags
Return values
PromiseInterface —createNetworkApplianceVlanWithHttpInfo()
Operation createNetworkApplianceVlanWithHttpInfo
public
createNetworkApplianceVlanWithHttpInfo(string $network_id, CreateNetworkApplianceVlan $create_network_appliance_vlan) : array<string|int, mixed>
Add a VLAN
Parameters
- $network_id : string
-
(required)
- $create_network_appliance_vlan : CreateNetworkApplianceVlan
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteNetworkApplianceVlan()
Operation deleteNetworkApplianceVlan
public
deleteNetworkApplianceVlan(string $network_id, string $vlan_id) : void
Delete a VLAN from a network
Parameters
- $network_id : string
-
network_id (required)
- $vlan_id : string
-
vlan_id (required)
Tags
Return values
void —deleteNetworkApplianceVlanAsync()
Operation deleteNetworkApplianceVlanAsync
public
deleteNetworkApplianceVlanAsync(string $network_id, string $vlan_id) : PromiseInterface
Delete a VLAN from a network
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkApplianceVlanAsyncWithHttpInfo()
Operation deleteNetworkApplianceVlanAsyncWithHttpInfo
public
deleteNetworkApplianceVlanAsyncWithHttpInfo(string $network_id, string $vlan_id) : PromiseInterface
Delete a VLAN from a network
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkApplianceVlanWithHttpInfo()
Operation deleteNetworkApplianceVlanWithHttpInfo
public
deleteNetworkApplianceVlanWithHttpInfo(string $network_id, string $vlan_id) : array<string|int, mixed>
Delete a VLAN from a network
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkApplianceVlan()
Operation getNetworkApplianceVlan
public
getNetworkApplianceVlan(string $network_id, string $vlan_id) : object
Return a VLAN
Parameters
- $network_id : string
-
network_id (required)
- $vlan_id : string
-
vlan_id (required)
Tags
Return values
object —getNetworkApplianceVlanAsync()
Operation getNetworkApplianceVlanAsync
public
getNetworkApplianceVlanAsync(string $network_id, string $vlan_id) : PromiseInterface
Return a VLAN
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceVlanAsyncWithHttpInfo()
Operation getNetworkApplianceVlanAsyncWithHttpInfo
public
getNetworkApplianceVlanAsyncWithHttpInfo(string $network_id, string $vlan_id) : PromiseInterface
Return a VLAN
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceVlans()
Operation getNetworkApplianceVlans
public
getNetworkApplianceVlans(string $network_id) : object
List the VLANs for an MX network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkApplianceVlansAsync()
Operation getNetworkApplianceVlansAsync
public
getNetworkApplianceVlansAsync(string $network_id) : PromiseInterface
List the VLANs for an MX network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceVlansAsyncWithHttpInfo()
Operation getNetworkApplianceVlansAsyncWithHttpInfo
public
getNetworkApplianceVlansAsyncWithHttpInfo(string $network_id) : PromiseInterface
List the VLANs for an MX network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceVlansSettings()
Operation getNetworkApplianceVlansSettings
public
getNetworkApplianceVlansSettings(string $network_id) : object
Returns the enabled status of VLANs for the network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkApplianceVlansSettingsAsync()
Operation getNetworkApplianceVlansSettingsAsync
public
getNetworkApplianceVlansSettingsAsync(string $network_id) : PromiseInterface
Returns the enabled status of VLANs for the network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceVlansSettingsAsyncWithHttpInfo()
Operation getNetworkApplianceVlansSettingsAsyncWithHttpInfo
public
getNetworkApplianceVlansSettingsAsyncWithHttpInfo(string $network_id) : PromiseInterface
Returns the enabled status of VLANs for the network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceVlansSettingsWithHttpInfo()
Operation getNetworkApplianceVlansSettingsWithHttpInfo
public
getNetworkApplianceVlansSettingsWithHttpInfo(string $network_id) : array<string|int, mixed>
Returns the enabled status of VLANs for the network
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkApplianceVlansWithHttpInfo()
Operation getNetworkApplianceVlansWithHttpInfo
public
getNetworkApplianceVlansWithHttpInfo(string $network_id) : array<string|int, mixed>
List the VLANs for an MX network
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkApplianceVlanWithHttpInfo()
Operation getNetworkApplianceVlanWithHttpInfo
public
getNetworkApplianceVlanWithHttpInfo(string $network_id, string $vlan_id) : array<string|int, mixed>
Return a VLAN
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkApplianceVlan()
Operation updateNetworkApplianceVlan
public
updateNetworkApplianceVlan(string $network_id, string $vlan_id[, UpdateNetworkApplianceVlan $update_network_appliance_vlan = null ]) : object
Update a VLAN
Parameters
- $network_id : string
-
network_id (required)
- $vlan_id : string
-
vlan_id (required)
- $update_network_appliance_vlan : UpdateNetworkApplianceVlan = null
-
update_network_appliance_vlan (optional)
Tags
Return values
object —updateNetworkApplianceVlanAsync()
Operation updateNetworkApplianceVlanAsync
public
updateNetworkApplianceVlanAsync(string $network_id, string $vlan_id[, UpdateNetworkApplianceVlan $update_network_appliance_vlan = null ]) : PromiseInterface
Update a VLAN
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
- $update_network_appliance_vlan : UpdateNetworkApplianceVlan = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkApplianceVlanAsyncWithHttpInfo()
Operation updateNetworkApplianceVlanAsyncWithHttpInfo
public
updateNetworkApplianceVlanAsyncWithHttpInfo(string $network_id, string $vlan_id[, UpdateNetworkApplianceVlan $update_network_appliance_vlan = null ]) : PromiseInterface
Update a VLAN
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
- $update_network_appliance_vlan : UpdateNetworkApplianceVlan = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkApplianceVlansSettings()
Operation updateNetworkApplianceVlansSettings
public
updateNetworkApplianceVlansSettings(string $network_id[, UpdateNetworkApplianceVlansSettings $update_network_appliance_vlans_settings = null ]) : object
Enable/Disable VLANs for the given network
Parameters
- $network_id : string
-
network_id (required)
- $update_network_appliance_vlans_settings : UpdateNetworkApplianceVlansSettings = null
-
update_network_appliance_vlans_settings (optional)
Tags
Return values
object —updateNetworkApplianceVlansSettingsAsync()
Operation updateNetworkApplianceVlansSettingsAsync
public
updateNetworkApplianceVlansSettingsAsync(string $network_id[, UpdateNetworkApplianceVlansSettings $update_network_appliance_vlans_settings = null ]) : PromiseInterface
Enable/Disable VLANs for the given network
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_vlans_settings : UpdateNetworkApplianceVlansSettings = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkApplianceVlansSettingsAsyncWithHttpInfo()
Operation updateNetworkApplianceVlansSettingsAsyncWithHttpInfo
public
updateNetworkApplianceVlansSettingsAsyncWithHttpInfo(string $network_id[, UpdateNetworkApplianceVlansSettings $update_network_appliance_vlans_settings = null ]) : PromiseInterface
Enable/Disable VLANs for the given network
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_vlans_settings : UpdateNetworkApplianceVlansSettings = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkApplianceVlansSettingsWithHttpInfo()
Operation updateNetworkApplianceVlansSettingsWithHttpInfo
public
updateNetworkApplianceVlansSettingsWithHttpInfo(string $network_id[, UpdateNetworkApplianceVlansSettings $update_network_appliance_vlans_settings = null ]) : array<string|int, mixed>
Enable/Disable VLANs for the given network
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_vlans_settings : UpdateNetworkApplianceVlansSettings = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkApplianceVlanWithHttpInfo()
Operation updateNetworkApplianceVlanWithHttpInfo
public
updateNetworkApplianceVlanWithHttpInfo(string $network_id, string $vlan_id[, UpdateNetworkApplianceVlan $update_network_appliance_vlan = null ]) : array<string|int, mixed>
Update a VLAN
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
- $update_network_appliance_vlan : UpdateNetworkApplianceVlan = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
createNetworkApplianceVlanRequest()
Create request for operation 'createNetworkApplianceVlan'
protected
createNetworkApplianceVlanRequest(string $network_id, CreateNetworkApplianceVlan $create_network_appliance_vlan) : Request
Parameters
- $network_id : string
-
(required)
- $create_network_appliance_vlan : CreateNetworkApplianceVlan
-
(required)
Tags
Return values
Request —deleteNetworkApplianceVlanRequest()
Create request for operation 'deleteNetworkApplianceVlan'
protected
deleteNetworkApplianceVlanRequest(string $network_id, string $vlan_id) : Request
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
Tags
Return values
Request —getNetworkApplianceVlanRequest()
Create request for operation 'getNetworkApplianceVlan'
protected
getNetworkApplianceVlanRequest(string $network_id, string $vlan_id) : Request
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
Tags
Return values
Request —getNetworkApplianceVlansRequest()
Create request for operation 'getNetworkApplianceVlans'
protected
getNetworkApplianceVlansRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —getNetworkApplianceVlansSettingsRequest()
Create request for operation 'getNetworkApplianceVlansSettings'
protected
getNetworkApplianceVlansSettingsRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —updateNetworkApplianceVlanRequest()
Create request for operation 'updateNetworkApplianceVlan'
protected
updateNetworkApplianceVlanRequest(string $network_id, string $vlan_id[, UpdateNetworkApplianceVlan $update_network_appliance_vlan = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $vlan_id : string
-
(required)
- $update_network_appliance_vlan : UpdateNetworkApplianceVlan = null
-
(optional)
Tags
Return values
Request —updateNetworkApplianceVlansSettingsRequest()
Create request for operation 'updateNetworkApplianceVlansSettings'
protected
updateNetworkApplianceVlansSettingsRequest(string $network_id[, UpdateNetworkApplianceVlansSettings $update_network_appliance_vlans_settings = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_vlans_settings : UpdateNetworkApplianceVlansSettings = null
-
(optional)