UpdateDeviceSwitchPort implements ModelInterface, ArrayAccess
UpdateDeviceSwitchPort Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- ACCESS_POLICY_TYPE_CUSTOM_ACCESS_POLICY = 'Custom access policy'
- ACCESS_POLICY_TYPE_MAC_ALLOW_LIST = 'MAC allow list'
- ACCESS_POLICY_TYPE_OPEN = 'Open'
- ACCESS_POLICY_TYPE_STICKY_MAC_ALLOW_LIST = 'Sticky MAC allow list'
- DISCRIMINATOR = null
- STP_GUARD_BPDU_GUARD = 'bpdu guard'
- STP_GUARD_DISABLED = 'disabled'
- STP_GUARD_LOOP_GUARD = 'loop guard'
- STP_GUARD_ROOT_GUARD = 'root guard'
- TYPE_ACCESS = 'access'
- TYPE_TRUNK = 'trunk'
- UDLD_ALERT_ONLY = 'Alert only'
- UDLD_ENFORCE = 'Enforce'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAccessPolicyNumber() : int
- Gets access_policy_number
- getAccessPolicyType() : string
- Gets access_policy_type
- getAccessPolicyTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getAllowedVlans() : string
- Gets allowed_vlans
- getEnabled() : bool
- Gets enabled
- getFlexibleStackingEnabled() : bool
- Gets flexible_stacking_enabled
- getIsolationEnabled() : bool
- Gets isolation_enabled
- getLinkNegotiation() : string
- Gets link_negotiation
- getMacAllowList() : array<string|int, string>
- Gets mac_allow_list
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getPoeEnabled() : bool
- Gets poe_enabled
- getPortScheduleId() : string
- Gets port_schedule_id
- getRstpEnabled() : bool
- Gets rstp_enabled
- getStickyMacAllowList() : array<string|int, string>
- Gets sticky_mac_allow_list
- getStickyMacAllowListLimit() : int
- Gets sticky_mac_allow_list_limit
- getStormControlEnabled() : bool
- Gets storm_control_enabled
- getStpGuard() : string
- Gets stp_guard
- getStpGuardAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTags() : array<string|int, string>
- Gets tags
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string
- Gets type
- getTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getUdld() : string
- Gets udld
- getUdldAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getVlan() : int
- Gets vlan
- getVoiceVlan() : int
- Gets voice_vlan
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setAccessPolicyNumber() : $this
- Sets access_policy_number
- setAccessPolicyType() : $this
- Sets access_policy_type
- setAllowedVlans() : $this
- Sets allowed_vlans
- setEnabled() : $this
- Sets enabled
- setFlexibleStackingEnabled() : $this
- Sets flexible_stacking_enabled
- setIsolationEnabled() : $this
- Sets isolation_enabled
- setLinkNegotiation() : $this
- Sets link_negotiation
- setMacAllowList() : $this
- Sets mac_allow_list
- setName() : $this
- Sets name
- setPoeEnabled() : $this
- Sets poe_enabled
- setPortScheduleId() : $this
- Sets port_schedule_id
- setRstpEnabled() : $this
- Sets rstp_enabled
- setStickyMacAllowList() : $this
- Sets sticky_mac_allow_list
- setStickyMacAllowListLimit() : $this
- Sets sticky_mac_allow_list_limit
- setStormControlEnabled() : $this
- Sets storm_control_enabled
- setStpGuard() : $this
- Sets stp_guard
- setTags() : $this
- Sets tags
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : $this
- Sets type
- setUdld() : $this
- Sets udld
- setVlan() : $this
- Sets vlan
- setVoiceVlan() : $this
- Sets voice_vlan
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
ACCESS_POLICY_TYPE_CUSTOM_ACCESS_POLICY
public
mixed
ACCESS_POLICY_TYPE_CUSTOM_ACCESS_POLICY
= 'Custom access policy'
ACCESS_POLICY_TYPE_MAC_ALLOW_LIST
public
mixed
ACCESS_POLICY_TYPE_MAC_ALLOW_LIST
= 'MAC allow list'
ACCESS_POLICY_TYPE_OPEN
public
mixed
ACCESS_POLICY_TYPE_OPEN
= 'Open'
ACCESS_POLICY_TYPE_STICKY_MAC_ALLOW_LIST
public
mixed
ACCESS_POLICY_TYPE_STICKY_MAC_ALLOW_LIST
= 'Sticky MAC allow list'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
STP_GUARD_BPDU_GUARD
public
mixed
STP_GUARD_BPDU_GUARD
= 'bpdu guard'
STP_GUARD_DISABLED
public
mixed
STP_GUARD_DISABLED
= 'disabled'
STP_GUARD_LOOP_GUARD
public
mixed
STP_GUARD_LOOP_GUARD
= 'loop guard'
STP_GUARD_ROOT_GUARD
public
mixed
STP_GUARD_ROOT_GUARD
= 'root guard'
TYPE_ACCESS
public
mixed
TYPE_ACCESS
= 'access'
TYPE_TRUNK
public
mixed
TYPE_TRUNK
= 'trunk'
UDLD_ALERT_ONLY
public
mixed
UDLD_ALERT_ONLY
= 'Alert only'
UDLD_ENFORCE
public
mixed
UDLD_ENFORCE
= 'Enforce'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['name' => 'name', 'tags' => 'tags', 'enabled' => 'enabled', 'type' => 'type', 'vlan' => 'vlan', 'voice_vlan' => 'voiceVlan', 'allowed_vlans' => 'allowedVlans', 'poe_enabled' => 'poeEnabled', 'isolation_enabled' => 'isolationEnabled', 'rstp_enabled' => 'rstpEnabled', 'stp_guard' => 'stpGuard', 'link_negotiation' => 'linkNegotiation', 'port_schedule_id' => 'portScheduleId', 'udld' => 'udld', 'access_policy_type' => 'accessPolicyType', 'access_policy_number' => 'accessPolicyNumber', 'mac_allow_list' => 'macAllowList', 'sticky_mac_allow_list' => 'stickyMacAllowList', 'sticky_mac_allow_list_limit' => 'stickyMacAllowListLimit', 'storm_control_enabled' => 'stormControlEnabled', 'flexible_stacking_enabled' => 'flexibleStackingEnabled']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['name' => 'getName', 'tags' => 'getTags', 'enabled' => 'getEnabled', 'type' => 'getType', 'vlan' => 'getVlan', 'voice_vlan' => 'getVoiceVlan', 'allowed_vlans' => 'getAllowedVlans', 'poe_enabled' => 'getPoeEnabled', 'isolation_enabled' => 'getIsolationEnabled', 'rstp_enabled' => 'getRstpEnabled', 'stp_guard' => 'getStpGuard', 'link_negotiation' => 'getLinkNegotiation', 'port_schedule_id' => 'getPortScheduleId', 'udld' => 'getUdld', 'access_policy_type' => 'getAccessPolicyType', 'access_policy_number' => 'getAccessPolicyNumber', 'mac_allow_list' => 'getMacAllowList', 'sticky_mac_allow_list' => 'getStickyMacAllowList', 'sticky_mac_allow_list_limit' => 'getStickyMacAllowListLimit', 'storm_control_enabled' => 'getStormControlEnabled', 'flexible_stacking_enabled' => 'getFlexibleStackingEnabled']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'tags' => 'setTags', 'enabled' => 'setEnabled', 'type' => 'setType', 'vlan' => 'setVlan', 'voice_vlan' => 'setVoiceVlan', 'allowed_vlans' => 'setAllowedVlans', 'poe_enabled' => 'setPoeEnabled', 'isolation_enabled' => 'setIsolationEnabled', 'rstp_enabled' => 'setRstpEnabled', 'stp_guard' => 'setStpGuard', 'link_negotiation' => 'setLinkNegotiation', 'port_schedule_id' => 'setPortScheduleId', 'udld' => 'setUdld', 'access_policy_type' => 'setAccessPolicyType', 'access_policy_number' => 'setAccessPolicyNumber', 'mac_allow_list' => 'setMacAllowList', 'sticky_mac_allow_list' => 'setStickyMacAllowList', 'sticky_mac_allow_list_limit' => 'setStickyMacAllowListLimit', 'storm_control_enabled' => 'setStormControlEnabled', 'flexible_stacking_enabled' => 'setFlexibleStackingEnabled']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['name' => null, 'tags' => null, 'enabled' => null, 'type' => null, 'vlan' => null, 'voice_vlan' => null, 'allowed_vlans' => null, 'poe_enabled' => null, 'isolation_enabled' => null, 'rstp_enabled' => null, 'stp_guard' => null, 'link_negotiation' => null, 'port_schedule_id' => null, 'udld' => null, 'access_policy_type' => null, 'access_policy_number' => null, 'mac_allow_list' => null, 'sticky_mac_allow_list' => null, 'sticky_mac_allow_list_limit' => null, 'storm_control_enabled' => null, 'flexible_stacking_enabled' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'updateDeviceSwitchPort'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['name' => 'string', 'tags' => 'string[]', 'enabled' => 'bool', 'type' => 'string', 'vlan' => 'int', 'voice_vlan' => 'int', 'allowed_vlans' => 'string', 'poe_enabled' => 'bool', 'isolation_enabled' => 'bool', 'rstp_enabled' => 'bool', 'stp_guard' => 'string', 'link_negotiation' => 'string', 'port_schedule_id' => 'string', 'udld' => 'string', 'access_policy_type' => 'string', 'access_policy_number' => 'int', 'mac_allow_list' => 'string[]', 'sticky_mac_allow_list' => 'string[]', 'sticky_mac_allow_list_limit' => 'int', 'storm_control_enabled' => 'bool', 'flexible_stacking_enabled' => 'bool']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAccessPolicyNumber()
Gets access_policy_number
public
getAccessPolicyNumber() : int
Return values
int —getAccessPolicyType()
Gets access_policy_type
public
getAccessPolicyType() : string
Return values
string —getAccessPolicyTypeAllowableValues()
Gets allowable values of the enum
public
getAccessPolicyTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getAllowedVlans()
Gets allowed_vlans
public
getAllowedVlans() : string
Return values
string —getEnabled()
Gets enabled
public
getEnabled() : bool
Return values
bool —getFlexibleStackingEnabled()
Gets flexible_stacking_enabled
public
getFlexibleStackingEnabled() : bool
Return values
bool —getIsolationEnabled()
Gets isolation_enabled
public
getIsolationEnabled() : bool
Return values
bool —getLinkNegotiation()
Gets link_negotiation
public
getLinkNegotiation() : string
Return values
string —getMacAllowList()
Gets mac_allow_list
public
getMacAllowList() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string
Return values
string —getPoeEnabled()
Gets poe_enabled
public
getPoeEnabled() : bool
Return values
bool —getPortScheduleId()
Gets port_schedule_id
public
getPortScheduleId() : string
Return values
string —getRstpEnabled()
Gets rstp_enabled
public
getRstpEnabled() : bool
Return values
bool —getStickyMacAllowList()
Gets sticky_mac_allow_list
public
getStickyMacAllowList() : array<string|int, string>
Return values
array<string|int, string> —getStickyMacAllowListLimit()
Gets sticky_mac_allow_list_limit
public
getStickyMacAllowListLimit() : int
Return values
int —getStormControlEnabled()
Gets storm_control_enabled
public
getStormControlEnabled() : bool
Return values
bool —getStpGuard()
Gets stp_guard
public
getStpGuard() : string
Return values
string —getStpGuardAllowableValues()
Gets allowable values of the enum
public
getStpGuardAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTags()
Gets tags
public
getTags() : array<string|int, string>
Return values
array<string|int, string> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getType()
Gets type
public
getType() : string
Return values
string —getTypeAllowableValues()
Gets allowable values of the enum
public
getTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getUdld()
Gets udld
public
getUdld() : string
Return values
string —getUdldAllowableValues()
Gets allowable values of the enum
public
getUdldAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getVlan()
Gets vlan
public
getVlan() : int
Return values
int —getVoiceVlan()
Gets voice_vlan
public
getVoiceVlan() : int
Return values
int —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setAccessPolicyNumber()
Sets access_policy_number
public
setAccessPolicyNumber(int $access_policy_number) : $this
Parameters
- $access_policy_number : int
-
The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'
Return values
$this —setAccessPolicyType()
Sets access_policy_type
public
setAccessPolicyType(string $access_policy_type) : $this
Parameters
- $access_policy_type : string
-
The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'
Return values
$this —setAllowedVlans()
Sets allowed_vlans
public
setAllowedVlans(string $allowed_vlans) : $this
Parameters
- $allowed_vlans : string
-
The VLANs allowed on the switch port. Only applicable to trunk ports.
Return values
$this —setEnabled()
Sets enabled
public
setEnabled(bool $enabled) : $this
Parameters
- $enabled : bool
-
The status of the switch port
Return values
$this —setFlexibleStackingEnabled()
Sets flexible_stacking_enabled
public
setFlexibleStackingEnabled(bool $flexible_stacking_enabled) : $this
Parameters
- $flexible_stacking_enabled : bool
-
For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
Return values
$this —setIsolationEnabled()
Sets isolation_enabled
public
setIsolationEnabled(bool $isolation_enabled) : $this
Parameters
- $isolation_enabled : bool
-
The isolation status of the switch port
Return values
$this —setLinkNegotiation()
Sets link_negotiation
public
setLinkNegotiation(string $link_negotiation) : $this
Parameters
- $link_negotiation : string
-
The link speed for the switch port
Return values
$this —setMacAllowList()
Sets mac_allow_list
public
setMacAllowList(array<string|int, string> $mac_allow_list) : $this
Parameters
- $mac_allow_list : array<string|int, string>
-
Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'
Return values
$this —setName()
Sets name
public
setName(string $name) : $this
Parameters
- $name : string
-
The name of the switch port
Return values
$this —setPoeEnabled()
Sets poe_enabled
public
setPoeEnabled(bool $poe_enabled) : $this
Parameters
- $poe_enabled : bool
-
The PoE status of the switch port
Return values
$this —setPortScheduleId()
Sets port_schedule_id
public
setPortScheduleId(string $port_schedule_id) : $this
Parameters
- $port_schedule_id : string
-
The ID of the port schedule. A value of null will clear the port schedule.
Return values
$this —setRstpEnabled()
Sets rstp_enabled
public
setRstpEnabled(bool $rstp_enabled) : $this
Parameters
- $rstp_enabled : bool
-
The rapid spanning tree protocol status
Return values
$this —setStickyMacAllowList()
Sets sticky_mac_allow_list
public
setStickyMacAllowList(array<string|int, string> $sticky_mac_allow_list) : $this
Parameters
- $sticky_mac_allow_list : array<string|int, string>
-
The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'
Return values
$this —setStickyMacAllowListLimit()
Sets sticky_mac_allow_list_limit
public
setStickyMacAllowListLimit(int $sticky_mac_allow_list_limit) : $this
Parameters
- $sticky_mac_allow_list_limit : int
-
The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'
Return values
$this —setStormControlEnabled()
Sets storm_control_enabled
public
setStormControlEnabled(bool $storm_control_enabled) : $this
Parameters
- $storm_control_enabled : bool
-
The storm control status of the switch port
Return values
$this —setStpGuard()
Sets stp_guard
public
setStpGuard(string $stp_guard) : $this
Parameters
- $stp_guard : string
-
The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard')
Return values
$this —setTags()
Sets tags
public
setTags(array<string|int, string> $tags) : $this
Parameters
- $tags : array<string|int, string>
-
The list of tags of the switch port
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setType()
Sets type
public
setType(string $type) : $this
Parameters
- $type : string
-
The type of the switch port ('trunk' or 'access')
Return values
$this —setUdld()
Sets udld
public
setUdld(string $udld) : $this
Parameters
- $udld : string
-
The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
Return values
$this —setVlan()
Sets vlan
public
setVlan(int $vlan) : $this
Parameters
- $vlan : int
-
The VLAN of the switch port. A null value will clear the value set for trunk ports.
Return values
$this —setVoiceVlan()
Sets voice_vlan
public
setVoiceVlan(int $voice_vlan) : $this
Parameters
- $voice_vlan : int
-
The voice VLAN of the switch port. Only applicable to access ports.
Return values
$this —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid