| Field | Type | Description | Value(s) |
|---|---|---|---|
name | string | Name of the VLAN link (interface) to be created. | |
vlanID | uint16 | VLAN ID to be used for the VLAN link. | |
vlanMode | VLANProtocol | Set the VLAN mode to use. If not set, defaults to ‘802.1q’. | 802.1q802.1ad |
parent | string | Name of the parent link (interface) on which the VLAN link will be created. Link aliases can be used here as well. | |
up | bool | Bring the link up or down. If not specified, the link will be brought up. | |
mtu | uint32 | Configure LinkMTU (Maximum Transmission Unit) for the link. If not specified, the system default LinkMTU will be used (usually 1500). | |
addresses | AddressConfig | Configure addresses to be statically assigned to the link. | |
routes | RouteConfig | Configure routes to be statically created via the link. | |
multicast | bool | Set the multicast capability of the link. |
addresses[]
AddressConfig represents a network address configuration.| Field | Type | Description | Value(s) |
|---|---|---|---|
address | Prefix | IP address to be assigned to the link. This field must include the network prefix length (e.g. /24 for IPv4, /64 for IPv6). | |
routePriority | uint32 | Configure the route priority (metric) for routes created for this address. If not specified, the system default route priority will be used. |
routes[]
RouteConfig represents a network route configuration.| Field | Type | Description | Value(s) |
|---|---|---|---|
destination | Prefix | The route’s destination as an address prefix. If not specified, a default route will be created for the address family of the gateway. | |
gateway | Addr | The route’s gateway (if empty, creates link scope route). | |
source | Addr | The route’s source address (optional). | |
metric | uint32 | The optional metric for the route. | |
mtu | uint32 | The optional MTU for the route. | |
table | RoutingTable | The routing table to use for the route. If not specified, the main routing table will be used. |