Documentation

CreateNetworkSwitchAccessPolicy implements ModelInterface, ArrayAccess

CreateNetworkSwitchAccessPolicy Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes and Traits

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

ACCESS_POLICY_TYPE__8021X  = '802.1x'
ACCESS_POLICY_TYPE_HYBRID_AUTHENTICATION  = 'Hybrid authentication'
ACCESS_POLICY_TYPE_MAC_AUTHENTICATION_BYPASS  = 'MAC authentication bypass'
DISCRIMINATOR  = null
HOST_MODE_MULTI_AUTH  = 'Multi-Auth'
HOST_MODE_MULTI_DOMAIN  = 'Multi-Domain'
HOST_MODE_MULTI_HOST  = 'Multi-Host'
HOST_MODE_SINGLE_HOST  = 'Single-Host'
$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
getAccessPolicyType()  : string
Gets access_policy_type
getAccessPolicyTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getGuestVlanId()  : int
Gets guest_vlan_id
getHostMode()  : string
Gets host_mode
getHostModeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getIncreaseAccessSpeed()  : bool
Gets increase_access_speed
getModelName()  : string
The original name of the model.
getName()  : string
Gets name
getRadiusAccountingEnabled()  : bool
Gets radius_accounting_enabled
getRadiusAccountingServers()  : array<string|int, NetworksnetworkIdswitchaccessPoliciesRadiusAccountingServers>
Gets radius_accounting_servers
getRadiusCoaSupportEnabled()  : bool
Gets radius_coa_support_enabled
getRadiusGroupAttribute()  : string
Gets radius_group_attribute
getRadiusServers()  : array<string|int, NetworksnetworkIdswitchaccessPoliciesRadiusServers>
Gets radius_servers
getRadiusTestingEnabled()  : bool
Gets radius_testing_enabled
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrlRedirectWalledGardenEnabled()  : bool
Gets url_redirect_walled_garden_enabled
getUrlRedirectWalledGardenRanges()  : array<string|int, string>
Gets url_redirect_walled_garden_ranges
getVoiceVlanClients()  : bool
Gets voice_vlan_clients
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.
setAccessPolicyType()  : $this
Sets access_policy_type
setGuestVlanId()  : $this
Sets guest_vlan_id
setHostMode()  : $this
Sets host_mode
setIncreaseAccessSpeed()  : $this
Sets increase_access_speed
setName()  : $this
Sets name
setRadiusAccountingEnabled()  : $this
Sets radius_accounting_enabled
setRadiusAccountingServers()  : $this
Sets radius_accounting_servers
setRadiusCoaSupportEnabled()  : $this
Sets radius_coa_support_enabled
setRadiusGroupAttribute()  : $this
Sets radius_group_attribute
setRadiusServers()  : $this
Sets radius_servers
setRadiusTestingEnabled()  : $this
Sets radius_testing_enabled
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUrlRedirectWalledGardenEnabled()  : $this
Sets url_redirect_walled_garden_enabled
setUrlRedirectWalledGardenRanges()  : $this
Sets url_redirect_walled_garden_ranges
setVoiceVlanClients()  : $this
Sets voice_vlan_clients
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_MAC_AUTHENTICATION_BYPASS

public mixed ACCESS_POLICY_TYPE_MAC_AUTHENTICATION_BYPASS = 'MAC authentication bypass'

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', 'radius_servers' => 'radiusServers', 'radius_testing_enabled' => 'radiusTestingEnabled', 'radius_coa_support_enabled' => 'radiusCoaSupportEnabled', 'radius_accounting_enabled' => 'radiusAccountingEnabled', 'radius_accounting_servers' => 'radiusAccountingServers', 'radius_group_attribute' => 'radiusGroupAttribute', 'host_mode' => 'hostMode', 'access_policy_type' => 'accessPolicyType', 'increase_access_speed' => 'increaseAccessSpeed', 'guest_vlan_id' => 'guestVlanId', 'voice_vlan_clients' => 'voiceVlanClients', 'url_redirect_walled_garden_enabled' => 'urlRedirectWalledGardenEnabled', 'url_redirect_walled_garden_ranges' => 'urlRedirectWalledGardenRanges']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['name' => 'getName', 'radius_servers' => 'getRadiusServers', 'radius_testing_enabled' => 'getRadiusTestingEnabled', 'radius_coa_support_enabled' => 'getRadiusCoaSupportEnabled', 'radius_accounting_enabled' => 'getRadiusAccountingEnabled', 'radius_accounting_servers' => 'getRadiusAccountingServers', 'radius_group_attribute' => 'getRadiusGroupAttribute', 'host_mode' => 'getHostMode', 'access_policy_type' => 'getAccessPolicyType', 'increase_access_speed' => 'getIncreaseAccessSpeed', 'guest_vlan_id' => 'getGuestVlanId', 'voice_vlan_clients' => 'getVoiceVlanClients', 'url_redirect_walled_garden_enabled' => 'getUrlRedirectWalledGardenEnabled', 'url_redirect_walled_garden_ranges' => 'getUrlRedirectWalledGardenRanges']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['name' => 'setName', 'radius_servers' => 'setRadiusServers', 'radius_testing_enabled' => 'setRadiusTestingEnabled', 'radius_coa_support_enabled' => 'setRadiusCoaSupportEnabled', 'radius_accounting_enabled' => 'setRadiusAccountingEnabled', 'radius_accounting_servers' => 'setRadiusAccountingServers', 'radius_group_attribute' => 'setRadiusGroupAttribute', 'host_mode' => 'setHostMode', 'access_policy_type' => 'setAccessPolicyType', 'increase_access_speed' => 'setIncreaseAccessSpeed', 'guest_vlan_id' => 'setGuestVlanId', 'voice_vlan_clients' => 'setVoiceVlanClients', 'url_redirect_walled_garden_enabled' => 'setUrlRedirectWalledGardenEnabled', 'url_redirect_walled_garden_ranges' => 'setUrlRedirectWalledGardenRanges']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['name' => null, 'radius_servers' => null, 'radius_testing_enabled' => null, 'radius_coa_support_enabled' => null, 'radius_accounting_enabled' => null, 'radius_accounting_servers' => null, 'radius_group_attribute' => null, 'host_mode' => null, 'access_policy_type' => null, 'increase_access_speed' => null, 'guest_vlan_id' => null, 'voice_vlan_clients' => null, 'url_redirect_walled_garden_enabled' => null, 'url_redirect_walled_garden_ranges' => null]

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['name' => 'string', 'radius_servers' => '\Swagger\Client\Model\NetworksnetworkIdswitchaccessPoliciesRadiusServers[]', 'radius_testing_enabled' => 'bool', 'radius_coa_support_enabled' => 'bool', 'radius_accounting_enabled' => 'bool', 'radius_accounting_servers' => '\Swagger\Client\Model\NetworksnetworkIdswitchaccessPoliciesRadiusAccountingServers[]', 'radius_group_attribute' => 'string', 'host_mode' => 'string', 'access_policy_type' => 'string', 'increase_access_speed' => 'bool', 'guest_vlan_id' => 'int', 'voice_vlan_clients' => 'bool', 'url_redirect_walled_garden_enabled' => 'bool', 'url_redirect_walled_garden_ranges' => 'string[]']

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 —

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> —

getAccessPolicyTypeAllowableValues()

Gets allowable values of the enum

public getAccessPolicyTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getHostModeAllowableValues()

Gets allowable values of the enum

public getHostModeAllowableValues() : 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> —

getUrlRedirectWalledGardenEnabled()

Gets url_redirect_walled_garden_enabled

public getUrlRedirectWalledGardenEnabled() : bool
Return values
bool —

getUrlRedirectWalledGardenRanges()

Gets url_redirect_walled_garden_ranges

public getUrlRedirectWalledGardenRanges() : array<string|int, string>
Return values
array<string|int, string> —

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 —

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 —

setAccessPolicyType()

Sets access_policy_type

public setAccessPolicyType(string $access_policy_type) : $this
Parameters
$access_policy_type : string

Access Type of the policy. Automatically 'Hybrid authentication' when hostMode is 'Multi-Domain'.

Return values
$this —

setGuestVlanId()

Sets guest_vlan_id

public setGuestVlanId(int $guest_vlan_id) : $this
Parameters
$guest_vlan_id : int

ID for the guest VLAN allow unauthorized devices access to limited network resources

Return values
$this —

setHostMode()

Sets host_mode

public setHostMode(string $host_mode) : $this
Parameters
$host_mode : string

Choose the Host Mode for the access policy.

Return values
$this —

setIncreaseAccessSpeed()

Sets increase_access_speed

public setIncreaseAccessSpeed(bool $increase_access_speed) : $this
Parameters
$increase_access_speed : bool

Enabling this option will make switches execute 802.1X and MAC-bypass authentication simultaneously so that clients authenticate faster. Only required when accessPolicyType is 'Hybrid Authentication.

Return values
$this —

setName()

Sets name

public setName(string $name) : $this
Parameters
$name : string

Name of the access policy

Return values
$this —

setRadiusAccountingEnabled()

Sets radius_accounting_enabled

public setRadiusAccountingEnabled(bool $radius_accounting_enabled) : $this
Parameters
$radius_accounting_enabled : bool

Enable to send start, interim-update and stop messages to a configured RADIUS accounting server for tracking connected clients

Return values
$this —

setRadiusAccountingServers()

Sets radius_accounting_servers

public setRadiusAccountingServers(array<string|int, NetworksnetworkIdswitchaccessPoliciesRadiusAccountingServers> $radius_accounting_servers) : $this
Parameters
$radius_accounting_servers : array<string|int, NetworksnetworkIdswitchaccessPoliciesRadiusAccountingServers>

List of RADIUS accounting servers to require connecting devices to authenticate against before granting network access

Return values
$this —

setRadiusCoaSupportEnabled()

Sets radius_coa_support_enabled

public setRadiusCoaSupportEnabled(bool $radius_coa_support_enabled) : $this
Parameters
$radius_coa_support_enabled : bool

Change of authentication for RADIUS re-authentication and disconnection

Return values
$this —

setRadiusGroupAttribute()

Sets radius_group_attribute

public setRadiusGroupAttribute(string $radius_group_attribute) : $this
Parameters
$radius_group_attribute : string

Acceptable values are \"\" for None, or \"11\" for Group Policies ACL

Return values
$this —

setRadiusTestingEnabled()

Sets radius_testing_enabled

public setRadiusTestingEnabled(bool $radius_testing_enabled) : $this
Parameters
$radius_testing_enabled : bool

If enabled, Meraki devices will periodically send access-request messages to these RADIUS servers

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> —

setUrlRedirectWalledGardenEnabled()

Sets url_redirect_walled_garden_enabled

public setUrlRedirectWalledGardenEnabled(bool $url_redirect_walled_garden_enabled) : $this
Parameters
$url_redirect_walled_garden_enabled : bool

Enable to restrict access for clients to a specific set of IP addresses or hostnames prior to authentication

Return values
$this —

setUrlRedirectWalledGardenRanges()

Sets url_redirect_walled_garden_ranges

public setUrlRedirectWalledGardenRanges(array<string|int, string> $url_redirect_walled_garden_ranges) : $this
Parameters
$url_redirect_walled_garden_ranges : array<string|int, string>

IP address ranges, in CIDR notation, to restrict access for clients to a specific set of IP addresses or hostnames prior to authentication

Return values
$this —

setVoiceVlanClients()

Sets voice_vlan_clients

public setVoiceVlanClients(bool $voice_vlan_clients) : $this
Parameters
$voice_vlan_clients : bool

CDP/LLDP capable voice clients will be able to use this VLAN. Automatically true when hostMode is 'Multi-Domain'.

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

Search results