LANs

List Site LANs

client.magicTransit.sites.lans.list(, , ?): SinglePage<LAN { id, bond_id, ha_link, 9 more } >

GET/accounts/{account_id}/magic/sites/{site_id}/lans

Site LAN Details

client.magicTransit.sites.lans.get(, , ?): LAN { id, bond_id, ha_link, 9 more }

GET/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Create a new Site LAN

client.magicTransit.sites.lans.create(, , ?): SinglePage<LAN { id, bond_id, ha_link, 9 more } >

POST/accounts/{account_id}/magic/sites/{site_id}/lans

Update Site LAN

client.magicTransit.sites.lans.update(, , ?): LAN { id, bond_id, ha_link, 9 more }

PUT/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Patch Site LAN

client.magicTransit.sites.lans.edit(, , ?): LAN { id, bond_id, ha_link, 9 more }

PATCH/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Delete Site LAN

client.magicTransit.sites.lans.delete(, , ?): LAN { id, bond_id, ha_link, 9 more }

DELETE/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

ModelsExpand Collapse

DHCPRelay { server_addresses }

server_addresses?: Array<string>

List of DHCP server IPs.

DHCPServer { dhcp_options, dhcp_pool_end, dhcp_pool_start, 3 more }

dhcp_options?: Array<DHCPOption>

Optional list of custom DHCP options to include in DHCP responses. Only valid when DHCP server is enabled.

code: number

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" | "hex" | "ip" | 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?: string

A valid IPv4 address.

dhcp_pool_start?: string

A valid IPv4 address.

Deprecateddns_server?: string

A valid IPv4 address.

dns_servers?: Array<string>

reservations?: Record<string, string>

Mapping of MAC addresses to IP addresses

LAN { id, bond_id, ha_link, 9 more }

id?: string

Identifier

maxLength32

bond_id?: number

ha_link?: 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?: boolean

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

is_prioritized?: boolean

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

name?: string

nat?: Nat { static_prefix }

physport?: number

routed_subnets?: Array<RoutedSubnet { next_hop, prefix, nat } >

next_hop: string

A valid IPv4 address.

prefix: string

A valid CIDR notation representing an IP range.

nat?: Nat { static_prefix }

site_id?: string

Identifier

maxLength32

static_addressing?: 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?: number

VLAN ID. Use zero for untagged.

LANStaticAddressing { address, dhcp_relay, dhcp_server, 2 more }

address: string

A valid CIDR notation representing an IP range.

dhcp_relay?: DHCPRelay { server_addresses }

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

secondary_address?: string

A valid CIDR notation representing an IP range.

virtual_address?: string

A valid CIDR notation representing an IP range.

Nat { static_prefix }

static_prefix?: string

A valid CIDR notation representing an IP range.

RoutedSubnet { next_hop, prefix, nat }

next_hop: string

A valid IPv4 address.

prefix: string

A valid CIDR notation representing an IP range.

nat?: Nat { static_prefix }