DHCP option number (1-254). Options 0 and 255 are reserved by RFC 2132. Options 3, 6, and 51 are not allowed because they conflict with connector-managed configuration.

maximum254

minimum1

type: "text" or "hex" or "ip" or 3 more

The type of the option value. text: a string (max 255 bytes). hex: colon-separated hex bytes (e.g. “01:04:aa:bb:cc”, max 255 bytes). ip: an IPv4 address (e.g. “10.20.30.40”). byte: an unsigned integer 0-255 (1 byte). short: an unsigned integer 0-65535 (2 bytes). integer: an unsigned integer 0-4294967295 (4 bytes).

One of the following:

"text"

"hex"

"ip"

"byte"

"short"

"integer"

value: string

The option value, interpreted according to the type field.

dhcp_pool_end: optional string

A valid IPv4 address.

dhcp_pool_start: optional string

A valid IPv4 address.

dns_server: optional string

A valid IPv4 address.

dns_servers: optional array of string

reservations: optional map[string]

Mapping of MAC addresses to IP addresses

LAN object { id, bond_id, ha_link, 9 more }

id: optional string

Identifier

maxLength32

bond_id: optional number

ha_link: optional boolean

mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.

is_breakout: optional boolean

mark true to use this LAN for source-based breakout traffic

is_prioritized: optional boolean

mark true to use this LAN for source-based prioritized traffic

name: optional string

nat: optional Nat { static_prefix }

physport: optional number

routed_subnets: optional array of RoutedSubnet { next_hop, prefix, nat }

next_hop: string

A valid IPv4 address.

prefix: string

A valid CIDR notation representing an IP range.

nat: optional Nat { static_prefix }

site_id: optional string

Identifier

maxLength32

static_addressing: optional LANStaticAddressing { address, dhcp_relay, dhcp_server, 2 more }

If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.

vlan_tag: optional number

VLAN ID. Use zero for untagged.

LANStaticAddressing object { address, dhcp_relay, dhcp_server, 2 more }

address: string

A valid CIDR notation representing an IP range.

dhcp_relay: optional DHCPRelay { server_addresses }

dhcp_server: optional DHCPServer { dhcp_options, dhcp_pool_end, dhcp_pool_start, 3 more }

secondary_address: optional string

A valid CIDR notation representing an IP range.

virtual_address: optional string

A valid CIDR notation representing an IP range.

Nat object { static_prefix }

static_prefix: optional string

A valid CIDR notation representing an IP range.

RoutedSubnet object { next_hop, prefix, nat }

next_hop: string

A valid IPv4 address.

prefix: string

A valid CIDR notation representing an IP range.

nat: optional Nat { static_prefix }