Documentation

UpdateNetworkApplianceVlan implements ModelInterface, ArrayAccess

UpdateNetworkApplianceVlan 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

DHCP_HANDLING_DO_NOT_RESPOND_TO_DHCP_REQUESTS  = 'Do not respond to DHCP requests'
DHCP_HANDLING_RELAY_DHCP_TO_ANOTHER_SERVER  = 'Relay DHCP to another server'
DHCP_HANDLING_RUN_A_DHCP_SERVER  = 'Run a DHCP server'
DHCP_LEASE_TIME__12_HOURS  = '12 hours'
DHCP_LEASE_TIME__1_DAY  = '1 day'
DHCP_LEASE_TIME__1_HOUR  = '1 hour'
DHCP_LEASE_TIME__1_WEEK  = '1 week'
DHCP_LEASE_TIME__30_MINUTES  = '30 minutes'
DHCP_LEASE_TIME__4_HOURS  = '4 hours'
DISCRIMINATOR  = null
$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
getApplianceIp()  : string
Gets appliance_ip
getDhcpBootFilename()  : string
Gets dhcp_boot_filename
getDhcpBootNextServer()  : string
Gets dhcp_boot_next_server
getDhcpBootOptionsEnabled()  : bool
Gets dhcp_boot_options_enabled
getDhcpHandling()  : string
Gets dhcp_handling
getDhcpHandlingAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getDhcpLeaseTime()  : string
Gets dhcp_lease_time
getDhcpLeaseTimeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getDhcpOptions()  : array<string|int, NetworksnetworkIdappliancevlansvlanIdDhcpOptions>
Gets dhcp_options
getDhcpRelayServerIps()  : array<string|int, string>
Gets dhcp_relay_server_ips
getDnsNameservers()  : string
Gets dns_nameservers
getFixedIpAssignments()  : object
Gets fixed_ip_assignments
getGroupPolicyId()  : string
Gets group_policy_id
getModelName()  : string
The original name of the model.
getName()  : string
Gets name
getReservedIpRanges()  : array<string|int, NetworksnetworkIdappliancestaticRoutesstaticRouteIdReservedIpRanges>
Gets reserved_ip_ranges
getSubnet()  : string
Gets subnet
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getVpnNatSubnet()  : string
Gets vpn_nat_subnet
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.
setApplianceIp()  : $this
Sets appliance_ip
setDhcpBootFilename()  : $this
Sets dhcp_boot_filename
setDhcpBootNextServer()  : $this
Sets dhcp_boot_next_server
setDhcpBootOptionsEnabled()  : $this
Sets dhcp_boot_options_enabled
setDhcpHandling()  : $this
Sets dhcp_handling
setDhcpLeaseTime()  : $this
Sets dhcp_lease_time
setDhcpOptions()  : $this
Sets dhcp_options
setDhcpRelayServerIps()  : $this
Sets dhcp_relay_server_ips
setDnsNameservers()  : $this
Sets dns_nameservers
setFixedIpAssignments()  : $this
Sets fixed_ip_assignments
setGroupPolicyId()  : $this
Sets group_policy_id
setName()  : $this
Sets name
setReservedIpRanges()  : $this
Sets reserved_ip_ranges
setSubnet()  : $this
Sets subnet
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setVpnNatSubnet()  : $this
Sets vpn_nat_subnet
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

DHCP_HANDLING_DO_NOT_RESPOND_TO_DHCP_REQUESTS

public mixed DHCP_HANDLING_DO_NOT_RESPOND_TO_DHCP_REQUESTS = 'Do not respond to DHCP requests'

DHCP_HANDLING_RELAY_DHCP_TO_ANOTHER_SERVER

public mixed DHCP_HANDLING_RELAY_DHCP_TO_ANOTHER_SERVER = 'Relay DHCP to another server'

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', 'subnet' => 'subnet', 'appliance_ip' => 'applianceIp', 'group_policy_id' => 'groupPolicyId', 'vpn_nat_subnet' => 'vpnNatSubnet', 'dhcp_handling' => 'dhcpHandling', 'dhcp_relay_server_ips' => 'dhcpRelayServerIps', 'dhcp_lease_time' => 'dhcpLeaseTime', 'dhcp_boot_options_enabled' => 'dhcpBootOptionsEnabled', 'dhcp_boot_next_server' => 'dhcpBootNextServer', 'dhcp_boot_filename' => 'dhcpBootFilename', 'fixed_ip_assignments' => 'fixedIpAssignments', 'reserved_ip_ranges' => 'reservedIpRanges', 'dns_nameservers' => 'dnsNameservers', 'dhcp_options' => 'dhcpOptions']

$getters

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

protected static array<string|int, string> $getters = ['name' => 'getName', 'subnet' => 'getSubnet', 'appliance_ip' => 'getApplianceIp', 'group_policy_id' => 'getGroupPolicyId', 'vpn_nat_subnet' => 'getVpnNatSubnet', 'dhcp_handling' => 'getDhcpHandling', 'dhcp_relay_server_ips' => 'getDhcpRelayServerIps', 'dhcp_lease_time' => 'getDhcpLeaseTime', 'dhcp_boot_options_enabled' => 'getDhcpBootOptionsEnabled', 'dhcp_boot_next_server' => 'getDhcpBootNextServer', 'dhcp_boot_filename' => 'getDhcpBootFilename', 'fixed_ip_assignments' => 'getFixedIpAssignments', 'reserved_ip_ranges' => 'getReservedIpRanges', 'dns_nameservers' => 'getDnsNameservers', 'dhcp_options' => 'getDhcpOptions']

$setters

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

protected static array<string|int, string> $setters = ['name' => 'setName', 'subnet' => 'setSubnet', 'appliance_ip' => 'setApplianceIp', 'group_policy_id' => 'setGroupPolicyId', 'vpn_nat_subnet' => 'setVpnNatSubnet', 'dhcp_handling' => 'setDhcpHandling', 'dhcp_relay_server_ips' => 'setDhcpRelayServerIps', 'dhcp_lease_time' => 'setDhcpLeaseTime', 'dhcp_boot_options_enabled' => 'setDhcpBootOptionsEnabled', 'dhcp_boot_next_server' => 'setDhcpBootNextServer', 'dhcp_boot_filename' => 'setDhcpBootFilename', 'fixed_ip_assignments' => 'setFixedIpAssignments', 'reserved_ip_ranges' => 'setReservedIpRanges', 'dns_nameservers' => 'setDnsNameservers', 'dhcp_options' => 'setDhcpOptions']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['name' => null, 'subnet' => null, 'appliance_ip' => null, 'group_policy_id' => null, 'vpn_nat_subnet' => null, 'dhcp_handling' => null, 'dhcp_relay_server_ips' => null, 'dhcp_lease_time' => null, 'dhcp_boot_options_enabled' => null, 'dhcp_boot_next_server' => null, 'dhcp_boot_filename' => null, 'fixed_ip_assignments' => null, 'reserved_ip_ranges' => null, 'dns_nameservers' => null, 'dhcp_options' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'updateNetworkApplianceVlan'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['name' => 'string', 'subnet' => 'string', 'appliance_ip' => 'string', 'group_policy_id' => 'string', 'vpn_nat_subnet' => 'string', 'dhcp_handling' => 'string', 'dhcp_relay_server_ips' => 'string[]', 'dhcp_lease_time' => 'string', 'dhcp_boot_options_enabled' => 'bool', 'dhcp_boot_next_server' => 'string', 'dhcp_boot_filename' => 'string', 'fixed_ip_assignments' => 'object', 'reserved_ip_ranges' => '\Swagger\Client\Model\NetworksnetworkIdappliancestaticRoutesstaticRouteIdReservedIpRanges[]', 'dns_nameservers' => 'string', 'dhcp_options' => '\Swagger\Client\Model\NetworksnetworkIdappliancevlansvlanIdDhcpOptions[]']

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>

getDhcpBootNextServer()

Gets dhcp_boot_next_server

public getDhcpBootNextServer() : string
Return values
string

getDhcpBootOptionsEnabled()

Gets dhcp_boot_options_enabled

public getDhcpBootOptionsEnabled() : bool
Return values
bool

getDhcpHandlingAllowableValues()

Gets allowable values of the enum

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

getDhcpLeaseTimeAllowableValues()

Gets allowable values of the enum

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

getDhcpRelayServerIps()

Gets dhcp_relay_server_ips

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

getFixedIpAssignments()

Gets fixed_ip_assignments

public getFixedIpAssignments() : object
Return values
object

getters()

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

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

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

setApplianceIp()

Sets appliance_ip

public setApplianceIp(string $appliance_ip) : $this
Parameters
$appliance_ip : string

The local IP of the appliance on the VLAN

Return values
$this

setDhcpBootFilename()

Sets dhcp_boot_filename

public setDhcpBootFilename(string $dhcp_boot_filename) : $this
Parameters
$dhcp_boot_filename : string

DHCP boot option for boot filename

Return values
$this

setDhcpBootNextServer()

Sets dhcp_boot_next_server

public setDhcpBootNextServer(string $dhcp_boot_next_server) : $this
Parameters
$dhcp_boot_next_server : string

DHCP boot option to direct boot clients to the server to load the boot file from

Return values
$this

setDhcpBootOptionsEnabled()

Sets dhcp_boot_options_enabled

public setDhcpBootOptionsEnabled(bool $dhcp_boot_options_enabled) : $this
Parameters
$dhcp_boot_options_enabled : bool

Use DHCP boot options specified in other properties

Return values
$this

setDhcpHandling()

Sets dhcp_handling

public setDhcpHandling(string $dhcp_handling) : $this
Parameters
$dhcp_handling : string

The appliance's handling of DHCP requests on this VLAN. One of: 'Run a DHCP server', 'Relay DHCP to another server' or 'Do not respond to DHCP requests'

Return values
$this

setDhcpLeaseTime()

Sets dhcp_lease_time

public setDhcpLeaseTime(string $dhcp_lease_time) : $this
Parameters
$dhcp_lease_time : string

The term of DHCP leases if the appliance is running a DHCP server on this VLAN. One of: '30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week'

Return values
$this

setDhcpRelayServerIps()

Sets dhcp_relay_server_ips

public setDhcpRelayServerIps(array<string|int, string> $dhcp_relay_server_ips) : $this
Parameters
$dhcp_relay_server_ips : array<string|int, string>

The IPs of the DHCP servers that DHCP requests should be relayed to

Return values
$this

setDnsNameservers()

Sets dns_nameservers

public setDnsNameservers(string $dns_nameservers) : $this
Parameters
$dns_nameservers : string

The DNS nameservers used for DHCP responses, either "upstream_dns", "google_dns", "opendns", or a newline seperated string of IP addresses or domain names

Return values
$this

setFixedIpAssignments()

Sets fixed_ip_assignments

public setFixedIpAssignments(object $fixed_ip_assignments) : $this
Parameters
$fixed_ip_assignments : object

The DHCP fixed IP assignments on the VLAN. This should be an object that contains mappings from MAC addresses to objects that themselves each contain "ip" and "name" string fields. See the sample request/response for more details.

Return values
$this

setGroupPolicyId()

Sets group_policy_id

public setGroupPolicyId(string $group_policy_id) : $this
Parameters
$group_policy_id : string

The id of the desired group policy to apply to the VLAN

Return values
$this

setName()

Sets name

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

The name of the VLAN

Return values
$this

setSubnet()

Sets subnet

public setSubnet(string $subnet) : $this
Parameters
$subnet : string

The subnet of the VLAN

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>

setVpnNatSubnet()

Sets vpn_nat_subnet

public setVpnNatSubnet(string $vpn_nat_subnet) : $this
Parameters
$vpn_nat_subnet : string

The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN

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