PortsApi
PortsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- cycleDeviceSwitchPorts() : object
- Operation cycleDeviceSwitchPorts
- cycleDeviceSwitchPortsAsync() : PromiseInterface
- Operation cycleDeviceSwitchPortsAsync
- cycleDeviceSwitchPortsAsyncWithHttpInfo() : PromiseInterface
- Operation cycleDeviceSwitchPortsAsyncWithHttpInfo
- cycleDeviceSwitchPortsWithHttpInfo() : array<string|int, mixed>
- Operation cycleDeviceSwitchPortsWithHttpInfo
- getConfig() : Configuration
- getDeviceSwitchPort() : object
- Operation getDeviceSwitchPort
- getDeviceSwitchPortAsync() : PromiseInterface
- Operation getDeviceSwitchPortAsync
- getDeviceSwitchPortAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceSwitchPortAsyncWithHttpInfo
- getDeviceSwitchPorts() : object
- Operation getDeviceSwitchPorts
- getDeviceSwitchPortsAsync() : PromiseInterface
- Operation getDeviceSwitchPortsAsync
- getDeviceSwitchPortsAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceSwitchPortsAsyncWithHttpInfo
- getDeviceSwitchPortsStatuses() : object
- Operation getDeviceSwitchPortsStatuses
- getDeviceSwitchPortsStatusesAsync() : PromiseInterface
- Operation getDeviceSwitchPortsStatusesAsync
- getDeviceSwitchPortsStatusesAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceSwitchPortsStatusesAsyncWithHttpInfo
- getDeviceSwitchPortsStatusesPackets() : object
- Operation getDeviceSwitchPortsStatusesPackets
- getDeviceSwitchPortsStatusesPacketsAsync() : PromiseInterface
- Operation getDeviceSwitchPortsStatusesPacketsAsync
- getDeviceSwitchPortsStatusesPacketsAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceSwitchPortsStatusesPacketsAsyncWithHttpInfo
- getDeviceSwitchPortsStatusesPacketsWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceSwitchPortsStatusesPacketsWithHttpInfo
- getDeviceSwitchPortsStatusesWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceSwitchPortsStatusesWithHttpInfo
- getDeviceSwitchPortsWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceSwitchPortsWithHttpInfo
- getDeviceSwitchPortWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceSwitchPortWithHttpInfo
- getNetworkAppliancePort() : object
- Operation getNetworkAppliancePort
- getNetworkAppliancePortAsync() : PromiseInterface
- Operation getNetworkAppliancePortAsync
- getNetworkAppliancePortAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkAppliancePortAsyncWithHttpInfo
- getNetworkAppliancePorts() : object
- Operation getNetworkAppliancePorts
- getNetworkAppliancePortsAsync() : PromiseInterface
- Operation getNetworkAppliancePortsAsync
- getNetworkAppliancePortsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkAppliancePortsAsyncWithHttpInfo
- getNetworkAppliancePortsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkAppliancePortsWithHttpInfo
- getNetworkAppliancePortWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkAppliancePortWithHttpInfo
- getOrganizationConfigTemplateSwitchProfilePort() : object
- Operation getOrganizationConfigTemplateSwitchProfilePort
- getOrganizationConfigTemplateSwitchProfilePortAsync() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilePortAsync
- getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo
- getOrganizationConfigTemplateSwitchProfilePorts() : object
- Operation getOrganizationConfigTemplateSwitchProfilePorts
- getOrganizationConfigTemplateSwitchProfilePortsAsync() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilePortsAsync
- getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo
- getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo
- getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo
- updateDeviceSwitchPort() : object
- Operation updateDeviceSwitchPort
- updateDeviceSwitchPortAsync() : PromiseInterface
- Operation updateDeviceSwitchPortAsync
- updateDeviceSwitchPortAsyncWithHttpInfo() : PromiseInterface
- Operation updateDeviceSwitchPortAsyncWithHttpInfo
- updateDeviceSwitchPortWithHttpInfo() : array<string|int, mixed>
- Operation updateDeviceSwitchPortWithHttpInfo
- updateNetworkAppliancePort() : object
- Operation updateNetworkAppliancePort
- updateNetworkAppliancePortAsync() : PromiseInterface
- Operation updateNetworkAppliancePortAsync
- updateNetworkAppliancePortAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkAppliancePortAsyncWithHttpInfo
- updateNetworkAppliancePortWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkAppliancePortWithHttpInfo
- updateOrganizationConfigTemplateSwitchProfilePort() : object
- Operation updateOrganizationConfigTemplateSwitchProfilePort
- updateOrganizationConfigTemplateSwitchProfilePortAsync() : PromiseInterface
- Operation updateOrganizationConfigTemplateSwitchProfilePortAsync
- updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo
- updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- cycleDeviceSwitchPortsRequest() : Request
- Create request for operation 'cycleDeviceSwitchPorts'
- getDeviceSwitchPortRequest() : Request
- Create request for operation 'getDeviceSwitchPort'
- getDeviceSwitchPortsRequest() : Request
- Create request for operation 'getDeviceSwitchPorts'
- getDeviceSwitchPortsStatusesPacketsRequest() : Request
- Create request for operation 'getDeviceSwitchPortsStatusesPackets'
- getDeviceSwitchPortsStatusesRequest() : Request
- Create request for operation 'getDeviceSwitchPortsStatuses'
- getNetworkAppliancePortRequest() : Request
- Create request for operation 'getNetworkAppliancePort'
- getNetworkAppliancePortsRequest() : Request
- Create request for operation 'getNetworkAppliancePorts'
- getOrganizationConfigTemplateSwitchProfilePortRequest() : Request
- Create request for operation 'getOrganizationConfigTemplateSwitchProfilePort'
- getOrganizationConfigTemplateSwitchProfilePortsRequest() : Request
- Create request for operation 'getOrganizationConfigTemplateSwitchProfilePorts'
- updateDeviceSwitchPortRequest() : Request
- Create request for operation 'updateDeviceSwitchPort'
- updateNetworkAppliancePortRequest() : Request
- Create request for operation 'updateNetworkAppliancePort'
- updateOrganizationConfigTemplateSwitchProfilePortRequest() : Request
- Create request for operation 'updateOrganizationConfigTemplateSwitchProfilePort'
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 —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 —getDeviceSwitchPort()
Operation getDeviceSwitchPort
public
getDeviceSwitchPort(string $serial, string $port_id) : object
Return a switch port
Parameters
- $serial : string
-
serial (required)
- $port_id : string
-
port_id (required)
Tags
Return values
object —getDeviceSwitchPortAsync()
Operation getDeviceSwitchPortAsync
public
getDeviceSwitchPortAsync(string $serial, string $port_id) : PromiseInterface
Return a switch port
Parameters
- $serial : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceSwitchPortAsyncWithHttpInfo()
Operation getDeviceSwitchPortAsyncWithHttpInfo
public
getDeviceSwitchPortAsyncWithHttpInfo(string $serial, string $port_id) : PromiseInterface
Return a switch port
Parameters
- $serial : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceSwitchPorts()
Operation getDeviceSwitchPorts
public
getDeviceSwitchPorts(string $serial) : object
List the switch ports for a switch
Parameters
- $serial : string
-
serial (required)
Tags
Return values
object —getDeviceSwitchPortsAsync()
Operation getDeviceSwitchPortsAsync
public
getDeviceSwitchPortsAsync(string $serial) : PromiseInterface
List the switch ports for a switch
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceSwitchPortsAsyncWithHttpInfo()
Operation getDeviceSwitchPortsAsyncWithHttpInfo
public
getDeviceSwitchPortsAsyncWithHttpInfo(string $serial) : PromiseInterface
List the switch ports for a switch
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceSwitchPortsStatuses()
Operation getDeviceSwitchPortsStatuses
public
getDeviceSwitchPortsStatuses(string $serial[, string $t0 = null ][, float $timespan = null ]) : object
Return the status for all the ports of a switch
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 —getDeviceSwitchPortsStatusesAsync()
Operation getDeviceSwitchPortsStatusesAsync
public
getDeviceSwitchPortsStatusesAsync(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface
Return the status for all the ports of a switch
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 —getDeviceSwitchPortsStatusesAsyncWithHttpInfo()
Operation getDeviceSwitchPortsStatusesAsyncWithHttpInfo
public
getDeviceSwitchPortsStatusesAsyncWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface
Return the status for all the ports of a switch
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 —getDeviceSwitchPortsStatusesPackets()
Operation getDeviceSwitchPortsStatusesPackets
public
getDeviceSwitchPortsStatusesPackets(string $serial[, string $t0 = null ][, float $timespan = null ]) : object
Return the packet counters for all the ports of a switch
Parameters
- $serial : string
-
serial (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 1 day 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 1 day. The default is 1 day. (optional)
Tags
Return values
object —getDeviceSwitchPortsStatusesPacketsAsync()
Operation getDeviceSwitchPortsStatusesPacketsAsync
public
getDeviceSwitchPortsStatusesPacketsAsync(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface
Return the packet counters for all the ports of a switch
Parameters
- $serial : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 1 day 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 1 day. The default is 1 day. (optional)
Tags
Return values
PromiseInterface —getDeviceSwitchPortsStatusesPacketsAsyncWithHttpInfo()
Operation getDeviceSwitchPortsStatusesPacketsAsyncWithHttpInfo
public
getDeviceSwitchPortsStatusesPacketsAsyncWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface
Return the packet counters for all the ports of a switch
Parameters
- $serial : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 1 day 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 1 day. The default is 1 day. (optional)
Tags
Return values
PromiseInterface —getDeviceSwitchPortsStatusesPacketsWithHttpInfo()
Operation getDeviceSwitchPortsStatusesPacketsWithHttpInfo
public
getDeviceSwitchPortsStatusesPacketsWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : array<string|int, mixed>
Return the packet counters for all the ports of a switch
Parameters
- $serial : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 1 day 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 1 day. The default is 1 day. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getDeviceSwitchPortsStatusesWithHttpInfo()
Operation getDeviceSwitchPortsStatusesWithHttpInfo
public
getDeviceSwitchPortsStatusesWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : array<string|int, mixed>
Return the status for all the ports of a switch
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)
getDeviceSwitchPortsWithHttpInfo()
Operation getDeviceSwitchPortsWithHttpInfo
public
getDeviceSwitchPortsWithHttpInfo(string $serial) : array<string|int, mixed>
List the switch ports 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)
getDeviceSwitchPortWithHttpInfo()
Operation getDeviceSwitchPortWithHttpInfo
public
getDeviceSwitchPortWithHttpInfo(string $serial, string $port_id) : array<string|int, mixed>
Return a switch port
Parameters
- $serial : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkAppliancePort()
Operation getNetworkAppliancePort
public
getNetworkAppliancePort(string $network_id, string $port_id) : object
Return per-port VLAN settings for a single MX port.
Parameters
- $network_id : string
-
network_id (required)
- $port_id : string
-
port_id (required)
Tags
Return values
object —getNetworkAppliancePortAsync()
Operation getNetworkAppliancePortAsync
public
getNetworkAppliancePortAsync(string $network_id, string $port_id) : PromiseInterface
Return per-port VLAN settings for a single MX port.
Parameters
- $network_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkAppliancePortAsyncWithHttpInfo()
Operation getNetworkAppliancePortAsyncWithHttpInfo
public
getNetworkAppliancePortAsyncWithHttpInfo(string $network_id, string $port_id) : PromiseInterface
Return per-port VLAN settings for a single MX port.
Parameters
- $network_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkAppliancePorts()
Operation getNetworkAppliancePorts
public
getNetworkAppliancePorts(string $network_id) : object
List per-port VLAN settings for all ports of a MX.
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkAppliancePortsAsync()
Operation getNetworkAppliancePortsAsync
public
getNetworkAppliancePortsAsync(string $network_id) : PromiseInterface
List per-port VLAN settings for all ports of a MX.
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkAppliancePortsAsyncWithHttpInfo()
Operation getNetworkAppliancePortsAsyncWithHttpInfo
public
getNetworkAppliancePortsAsyncWithHttpInfo(string $network_id) : PromiseInterface
List per-port VLAN settings for all ports of a MX.
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkAppliancePortsWithHttpInfo()
Operation getNetworkAppliancePortsWithHttpInfo
public
getNetworkAppliancePortsWithHttpInfo(string $network_id) : array<string|int, mixed>
List per-port VLAN settings for all ports of a MX.
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkAppliancePortWithHttpInfo()
Operation getNetworkAppliancePortWithHttpInfo
public
getNetworkAppliancePortWithHttpInfo(string $network_id, string $port_id) : array<string|int, mixed>
Return per-port VLAN settings for a single MX port.
Parameters
- $network_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationConfigTemplateSwitchProfilePort()
Operation getOrganizationConfigTemplateSwitchProfilePort
public
getOrganizationConfigTemplateSwitchProfilePort(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : object
Return a switch profile port
Parameters
- $organization_id : string
-
organization_id (required)
- $config_template_id : string
-
config_template_id (required)
- $profile_id : string
-
profile_id (required)
- $port_id : string
-
port_id (required)
Tags
Return values
object —getOrganizationConfigTemplateSwitchProfilePortAsync()
Operation getOrganizationConfigTemplateSwitchProfilePortAsync
public
getOrganizationConfigTemplateSwitchProfilePortAsync(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : PromiseInterface
Return a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : PromiseInterface
Return a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilePorts()
Operation getOrganizationConfigTemplateSwitchProfilePorts
public
getOrganizationConfigTemplateSwitchProfilePorts(string $organization_id, string $config_template_id, string $profile_id) : object
Return all the ports of a switch profile
Parameters
- $organization_id : string
-
organization_id (required)
- $config_template_id : string
-
config_template_id (required)
- $profile_id : string
-
profile_id (required)
Tags
Return values
object —getOrganizationConfigTemplateSwitchProfilePortsAsync()
Operation getOrganizationConfigTemplateSwitchProfilePortsAsync
public
getOrganizationConfigTemplateSwitchProfilePortsAsync(string $organization_id, string $config_template_id, string $profile_id) : PromiseInterface
Return all the ports of a switch profile
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id) : PromiseInterface
Return all the ports of a switch profile
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id) : array<string|int, mixed>
Return all the ports of a switch profile
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : array<string|int, mixed>
Return a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateDeviceSwitchPort()
Operation updateDeviceSwitchPort
public
updateDeviceSwitchPort(string $serial, string $port_id[, UpdateDeviceSwitchPort $update_device_switch_port = null ]) : object
Update a switch port
Parameters
- $serial : string
-
serial (required)
- $port_id : string
-
port_id (required)
- $update_device_switch_port : UpdateDeviceSwitchPort = null
-
update_device_switch_port (optional)
Tags
Return values
object —updateDeviceSwitchPortAsync()
Operation updateDeviceSwitchPortAsync
public
updateDeviceSwitchPortAsync(string $serial, string $port_id[, UpdateDeviceSwitchPort $update_device_switch_port = null ]) : PromiseInterface
Update a switch port
Parameters
- $serial : string
-
(required)
- $port_id : string
-
(required)
- $update_device_switch_port : UpdateDeviceSwitchPort = null
-
(optional)
Tags
Return values
PromiseInterface —updateDeviceSwitchPortAsyncWithHttpInfo()
Operation updateDeviceSwitchPortAsyncWithHttpInfo
public
updateDeviceSwitchPortAsyncWithHttpInfo(string $serial, string $port_id[, UpdateDeviceSwitchPort $update_device_switch_port = null ]) : PromiseInterface
Update a switch port
Parameters
- $serial : string
-
(required)
- $port_id : string
-
(required)
- $update_device_switch_port : UpdateDeviceSwitchPort = null
-
(optional)
Tags
Return values
PromiseInterface —updateDeviceSwitchPortWithHttpInfo()
Operation updateDeviceSwitchPortWithHttpInfo
public
updateDeviceSwitchPortWithHttpInfo(string $serial, string $port_id[, UpdateDeviceSwitchPort $update_device_switch_port = null ]) : array<string|int, mixed>
Update a switch port
Parameters
- $serial : string
-
(required)
- $port_id : string
-
(required)
- $update_device_switch_port : UpdateDeviceSwitchPort = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkAppliancePort()
Operation updateNetworkAppliancePort
public
updateNetworkAppliancePort(string $network_id, string $port_id[, UpdateNetworkAppliancePort $update_network_appliance_port = null ]) : object
Update the per-port VLAN settings for a single MX port.
Parameters
- $network_id : string
-
network_id (required)
- $port_id : string
-
port_id (required)
- $update_network_appliance_port : UpdateNetworkAppliancePort = null
-
update_network_appliance_port (optional)
Tags
Return values
object —updateNetworkAppliancePortAsync()
Operation updateNetworkAppliancePortAsync
public
updateNetworkAppliancePortAsync(string $network_id, string $port_id[, UpdateNetworkAppliancePort $update_network_appliance_port = null ]) : PromiseInterface
Update the per-port VLAN settings for a single MX port.
Parameters
- $network_id : string
-
(required)
- $port_id : string
-
(required)
- $update_network_appliance_port : UpdateNetworkAppliancePort = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkAppliancePortAsyncWithHttpInfo()
Operation updateNetworkAppliancePortAsyncWithHttpInfo
public
updateNetworkAppliancePortAsyncWithHttpInfo(string $network_id, string $port_id[, UpdateNetworkAppliancePort $update_network_appliance_port = null ]) : PromiseInterface
Update the per-port VLAN settings for a single MX port.
Parameters
- $network_id : string
-
(required)
- $port_id : string
-
(required)
- $update_network_appliance_port : UpdateNetworkAppliancePort = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkAppliancePortWithHttpInfo()
Operation updateNetworkAppliancePortWithHttpInfo
public
updateNetworkAppliancePortWithHttpInfo(string $network_id, string $port_id[, UpdateNetworkAppliancePort $update_network_appliance_port = null ]) : array<string|int, mixed>
Update the per-port VLAN settings for a single MX port.
Parameters
- $network_id : string
-
(required)
- $port_id : string
-
(required)
- $update_network_appliance_port : UpdateNetworkAppliancePort = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationConfigTemplateSwitchProfilePort()
Operation updateOrganizationConfigTemplateSwitchProfilePort
public
updateOrganizationConfigTemplateSwitchProfilePort(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : object
Update a switch profile port
Parameters
- $organization_id : string
-
organization_id (required)
- $config_template_id : string
-
config_template_id (required)
- $profile_id : string
-
profile_id (required)
- $port_id : string
-
port_id (required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = null
-
update_organization_config_template_switch_profile_port (optional)
Tags
Return values
object —updateOrganizationConfigTemplateSwitchProfilePortAsync()
Operation updateOrganizationConfigTemplateSwitchProfilePortAsync
public
updateOrganizationConfigTemplateSwitchProfilePortAsync(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : PromiseInterface
Update a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo()
Operation updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo
public
updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : PromiseInterface
Update a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo()
Operation updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo
public
updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : array<string|int, mixed>
Update a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = 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
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 —getDeviceSwitchPortRequest()
Create request for operation 'getDeviceSwitchPort'
protected
getDeviceSwitchPortRequest(string $serial, string $port_id) : Request
Parameters
- $serial : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
Request —getDeviceSwitchPortsRequest()
Create request for operation 'getDeviceSwitchPorts'
protected
getDeviceSwitchPortsRequest(string $serial) : Request
Parameters
- $serial : string
-
(required)
Tags
Return values
Request —getDeviceSwitchPortsStatusesPacketsRequest()
Create request for operation 'getDeviceSwitchPortsStatusesPackets'
protected
getDeviceSwitchPortsStatusesPacketsRequest(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 1 day 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 1 day. The default is 1 day. (optional)
Tags
Return values
Request —getDeviceSwitchPortsStatusesRequest()
Create request for operation 'getDeviceSwitchPortsStatuses'
protected
getDeviceSwitchPortsStatusesRequest(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 —getNetworkAppliancePortRequest()
Create request for operation 'getNetworkAppliancePort'
protected
getNetworkAppliancePortRequest(string $network_id, string $port_id) : Request
Parameters
- $network_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
Request —getNetworkAppliancePortsRequest()
Create request for operation 'getNetworkAppliancePorts'
protected
getNetworkAppliancePortsRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —getOrganizationConfigTemplateSwitchProfilePortRequest()
Create request for operation 'getOrganizationConfigTemplateSwitchProfilePort'
protected
getOrganizationConfigTemplateSwitchProfilePortRequest(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : Request
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
Request —getOrganizationConfigTemplateSwitchProfilePortsRequest()
Create request for operation 'getOrganizationConfigTemplateSwitchProfilePorts'
protected
getOrganizationConfigTemplateSwitchProfilePortsRequest(string $organization_id, string $config_template_id, string $profile_id) : Request
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
Tags
Return values
Request —updateDeviceSwitchPortRequest()
Create request for operation 'updateDeviceSwitchPort'
protected
updateDeviceSwitchPortRequest(string $serial, string $port_id[, UpdateDeviceSwitchPort $update_device_switch_port = null ]) : Request
Parameters
- $serial : string
-
(required)
- $port_id : string
-
(required)
- $update_device_switch_port : UpdateDeviceSwitchPort = null
-
(optional)
Tags
Return values
Request —updateNetworkAppliancePortRequest()
Create request for operation 'updateNetworkAppliancePort'
protected
updateNetworkAppliancePortRequest(string $network_id, string $port_id[, UpdateNetworkAppliancePort $update_network_appliance_port = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $port_id : string
-
(required)
- $update_network_appliance_port : UpdateNetworkAppliancePort = null
-
(optional)
Tags
Return values
Request —updateOrganizationConfigTemplateSwitchProfilePortRequest()
Create request for operation 'updateOrganizationConfigTemplateSwitchProfilePort'
protected
updateOrganizationConfigTemplateSwitchProfilePortRequest(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = null
-
(optional)