SubInterface Schema

Data structure for Sub Interface objects.

Fields

Field	Type	Required	Description	Notes
`address`	stringCollection	No	-	-
`admin`	string	No	-	-
`carp`	Carp	No	-	-
`description`	string	No	-	-
`destination`	string	No	-	-
`dhcp_server`	DhcpServer	No	-	API field: `dhcp_server`
`gateway`	string	No	-	-
`interface_type`	string	No	-	API field: `interface_type`
`metric`	string	No	-	-
`mtu`	string	No	-	-
`name`	string	Yes	-	-
`subnets`	SubnetCollection	No	-	-
`type`	string	No	-	-
`uplink_mode`	string	No	-	API field: `uplink_mode`
`vlan`	boolean	No	-	-
`vlan_id`	string	No	-	API field: `vlan_id`
`vlan_link`	string	No	-	API field: `vlan_link`
`wan_traffic_distribution`	string	No	-	API field: `wan_traffic_distribution`

Example

{
  "address": [
    "value"
  ],
  "admin": "string",
  "carp": {
    "address": "string",
    "advbase": "string",
    "advskew": "string"
  },
  "description": "string",
  "destination": "string",
  "dhcp_server": {
    "failover_peer": "string",
    "fixed_hosts": [
      {
        "fixed_address": "string",
        "host": "string",
        "mac_address": "string"
      }
    ],
    "globals": {
      "default_lease_time": "string",
      "max_lease_time": "string"
    }
  },
  "gateway": "string",
  "interface_type": "string"
}
// ... more fields

Fields​

Example​

Fields

Example