Documentation

DevicesserialmanagementInterfaceWan2 implements ModelInterface, ArrayAccess

DevicesserialmanagementInterfaceWan2 Class Doc Comment

Tags
category

Class

description

WAN 2 settings (only for MX devices)

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

DISCRIMINATOR  = null
WAN_ENABLED_DISABLED  = 'disabled'
WAN_ENABLED_ENABLED  = 'enabled'
WAN_ENABLED_NOT_CONFIGURED  = 'not configured'
$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
getModelName()  : string
The original name of the model.
getStaticDns()  : array<string|int, string>
Gets static_dns
getStaticGatewayIp()  : string
Gets static_gateway_ip
getStaticIp()  : string
Gets static_ip
getStaticSubnetMask()  : string
Gets static_subnet_mask
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUsingStaticIp()  : bool
Gets using_static_ip
getVlan()  : int
Gets vlan
getWanEnabled()  : string
Gets wan_enabled
getWanEnabledAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
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.
setStaticDns()  : $this
Sets static_dns
setStaticGatewayIp()  : $this
Sets static_gateway_ip
setStaticIp()  : $this
Sets static_ip
setStaticSubnetMask()  : $this
Sets static_subnet_mask
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUsingStaticIp()  : $this
Sets using_static_ip
setVlan()  : $this
Sets vlan
setWanEnabled()  : $this
Sets wan_enabled
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

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 = ['wan_enabled' => 'wanEnabled', 'using_static_ip' => 'usingStaticIp', 'static_ip' => 'staticIp', 'static_gateway_ip' => 'staticGatewayIp', 'static_subnet_mask' => 'staticSubnetMask', 'static_dns' => 'staticDns', 'vlan' => 'vlan']

$getters

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

protected static array<string|int, string> $getters = ['wan_enabled' => 'getWanEnabled', 'using_static_ip' => 'getUsingStaticIp', 'static_ip' => 'getStaticIp', 'static_gateway_ip' => 'getStaticGatewayIp', 'static_subnet_mask' => 'getStaticSubnetMask', 'static_dns' => 'getStaticDns', 'vlan' => 'getVlan']

$setters

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

protected static array<string|int, string> $setters = ['wan_enabled' => 'setWanEnabled', 'using_static_ip' => 'setUsingStaticIp', 'static_ip' => 'setStaticIp', 'static_gateway_ip' => 'setStaticGatewayIp', 'static_subnet_mask' => 'setStaticSubnetMask', 'static_dns' => 'setStaticDns', 'vlan' => 'setVlan']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['wan_enabled' => null, 'using_static_ip' => null, 'static_ip' => null, 'static_gateway_ip' => null, 'static_subnet_mask' => null, 'static_dns' => null, 'vlan' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['wan_enabled' => 'string', 'using_static_ip' => 'bool', 'static_ip' => 'string', 'static_gateway_ip' => 'string', 'static_subnet_mask' => 'string', 'static_dns' => 'string[]', 'vlan' => 'int']

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

getters()

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

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getWanEnabledAllowableValues()

Gets allowable values of the enum

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

setStaticDns()

Sets static_dns

public setStaticDns(array<string|int, string> $static_dns) : $this
Parameters
$static_dns : array<string|int, string>

Up to two DNS IPs.

Return values
$this —

setStaticGatewayIp()

Sets static_gateway_ip

public setStaticGatewayIp(string $static_gateway_ip) : $this
Parameters
$static_gateway_ip : string

The IP of the gateway on the WAN.

Return values
$this —

setStaticIp()

Sets static_ip

public setStaticIp(string $static_ip) : $this
Parameters
$static_ip : string

The IP the device should use on the WAN.

Return values
$this —

setStaticSubnetMask()

Sets static_subnet_mask

public setStaticSubnetMask(string $static_subnet_mask) : $this
Parameters
$static_subnet_mask : string

The subnet mask for the WAN.

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

setUsingStaticIp()

Sets using_static_ip

public setUsingStaticIp(bool $using_static_ip) : $this
Parameters
$using_static_ip : bool

Configure the interface to have static IP settings or use DHCP.

Return values
$this —

setVlan()

Sets vlan

public setVlan(int $vlan) : $this
Parameters
$vlan : int

The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.

Return values
$this —

setWanEnabled()

Sets wan_enabled

public setWanEnabled(string $wan_enabled) : $this
Parameters
$wan_enabled : string

Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.

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