Anapaya appliance configuration (interfaces only)

interfaces object

Top-level configuration and state for interfaces.

bonds object[]

Top-level configuration and state for the bond interfaces.

Array [

accept_raboolean

Whether to accept the route advertisements for the corresponding interface. (This is currently supported only for the interfaces that are using the Linux driver.)

Default value: false

addressesstring<ip-prefix>[]

The addresses configured on this interface. Each address must be a valid IP prefix in CIDR notation.

gateway object

The gateway for the network interface.

ipv4_gatewaystring<ipv4-address>

The gateway address for the IPv4 networking stack. Note that there must only be one IPv4 gateway configured across all the interfaces.

ipv6_gatewaystring<ipv6-address>

The gateway address for the IPv6 networking stack. Note that there must only be one IPv6 gateway configured across all the interfaces.

interfacesstring[]required

The list of interfaces that are part of this bond.

Possible values: >= 1

macstring<mac-address>

The MAC address to use on this interface. It is of the form XX:XX:XX:XX:XX:XX.

mtuinteger<uint16>

The MTU (Maximum Transmission Unit) to be used on this interface.

Default value: 1500

Example: 1472

namestringrequired

The name of the network interface.

neighbors object[]

The static neighbors configured on this network interface.

Array [

addressstring<ip-address>required

The IP address.

commentstring

An optional human-readable string to comment on this neighbor.

macstring<mac-address>

The MAC address corresponding to the address. It is of the form XX:XX:XX:XX:XX:XX.

sequence_idinteger<uint32>required

The sequence id determines the order of the neighbor entries.

Example: 3

]

routes object[]

The routes which are configured on this network interface.

Array [

commentstring

An optional human-readable string to comment on this route.

fromstring<ip-address>

The source IP address for traffic going through the route.

metricinteger<uint16>

The metric for the route. The lower its value, the higher its priority.

Default value: 10

sequence_idinteger<uint32>required

The sequence id determines the order of the route entries.

Example: 3

tostring<ip-prefix>required

The destination prefix in CIDR notation of this route.

viastring<ip-address>required

The next hop address which should be used for the prefix.

]

rx_queue_sizeinteger<uint16>

The number of descriptors in the receive queue. (This option is currently supported only for VPP interfaces.)

Default value: 1024

Example: 2048

tx_queue_sizeinteger<uint16>

The number of descriptors in the transmit queue. (This is currently supported only for VPP interfaces.)

Default value: 1024

Example: 2048

vrrp object[]

The VRRP (Virtual Router Redundancy Protocol) configurations for this interface.

Array [

addressesstring<ip-address>[]required

The list of virtual IP addresses. It must contain at least one IP address. Each sequence entry is in CIDR notation.

Possible values: >= 1

no_preemptboolean

If set to true, the preempt mode is disabled. This means that the router will not preempt the master even if it has a higher priority than the current master. If set to false, the router will preempt the master if it has a higher priority than the current master.

Default value: false

peersstring<ip-address>[]required

Optional list of IP addresses of the VRRP peers. If the list is empty, the router will send VRRP packets to the multicast address. If the list is not empty, the router will send VRRP packets to the unicast addresses specified in the list.

Possible values: >= 1

priorityinteger<uint8>

The priority value to be used by this VRRP router. Higher means higher priority and it ranges between 1 and 255 (decimal).

Default value: 1

Example: 17

vridinteger<uint8>required

The virtual router identifier, which ranges between 1 and 255 (decimal).

Example: 3

]

]

ethernets object[]

Top-level configuration and state for ethernet interfaces.

Array [

accept_raboolean

Whether to accept the route advertisements for the corresponding interface. (This is currently supported only for the interfaces that are using the Linux driver.)

Default value: false

addressesstring<ip-prefix>[]

The addresses configured on this interface. Each address must be a valid IP prefix in CIDR notation.

driverstring

The driver which should be used for the interface.

Possible values: [LINUX, VPP, VPP_DPDK, VPP_VMXNET3, VPP_MEMIF, VPP_RDMA]

gateway object

The gateway for the network interface.

ipv4_gatewaystring<ipv4-address>

The gateway address for the IPv4 networking stack. Note that there must only be one IPv4 gateway configured across all the interfaces.

ipv6_gatewaystring<ipv6-address>

The gateway address for the IPv6 networking stack. Note that there must only be one IPv6 gateway configured across all the interfaces.

macstring<mac-address>

The MAC address to use on this interface. It is of the form XX:XX:XX:XX:XX:XX.

mtuinteger<uint16>

The MTU (Maximum Transmission Unit) to be used on this interface.

Default value: 1500

Example: 1472

namestringrequired

The name of the network interface.

neighbors object[]

The static neighbors configured on this network interface.

Array [

addressstring<ip-address>required

The IP address.

commentstring

An optional human-readable string to comment on this neighbor.

macstring<mac-address>

The MAC address corresponding to the address. It is of the form XX:XX:XX:XX:XX:XX.

sequence_idinteger<uint32>required

The sequence id determines the order of the neighbor entries.

Example: 3

]

routes object[]

The routes which are configured on this network interface.

Array [

commentstring

An optional human-readable string to comment on this route.

fromstring<ip-address>

The source IP address for traffic going through the route.

metricinteger<uint16>

The metric for the route. The lower its value, the higher its priority.

Default value: 10

sequence_idinteger<uint32>required

The sequence id determines the order of the route entries.

Example: 3

tostring<ip-prefix>required

The destination prefix in CIDR notation of this route.

viastring<ip-address>required

The next hop address which should be used for the prefix.

]

rx_queue_sizeinteger<uint16>

The number of descriptors in the receive queue. (This option is currently supported only for VPP interfaces.)

Default value: 1024

Example: 2048

tx_queue_sizeinteger<uint16>

The number of descriptors in the transmit queue. (This is currently supported only for VPP interfaces.)

Default value: 1024

Example: 2048

vpp object

The VPP driver specific configuration.

vlan_strip_offloadboolean

Whether vlan-strip-offload on should be added to the interface configuration of the VPP dataplane.

Default value: false

vrrp object[]

The VRRP (Virtual Router Redundancy Protocol) configurations for this interface.

Array [

addressesstring<ip-address>[]required

The list of virtual IP addresses. It must contain at least one IP address. Each sequence entry is in CIDR notation.

Possible values: >= 1

no_preemptboolean

If set to true, the preempt mode is disabled. This means that the router will not preempt the master even if it has a higher priority than the current master. If set to false, the router will preempt the master if it has a higher priority than the current master.

Default value: false

peersstring<ip-address>[]required

Optional list of IP addresses of the VRRP peers. If the list is empty, the router will send VRRP packets to the multicast address. If the list is not empty, the router will send VRRP packets to the unicast addresses specified in the list.

Possible values: >= 1

priorityinteger<uint8>

The priority value to be used by this VRRP router. Higher means higher priority and it ranges between 1 and 255 (decimal).

Default value: 1

Example: 17

vridinteger<uint8>required

The virtual router identifier, which ranges between 1 and 255 (decimal).

Example: 3

]

]

loopbacks object[]

Top-level configuration and state for loopback interfaces.

Array [

addressesstring<ip-prefix>[]

The list of addresses configured on the loopback interface.

namestringrequired

The name of the loopback interface, which must have a 'loop' prefix.

]

virtual_functions object[]

Top-level configuration and state for VF interfaces.

Array [

accept_raboolean

Whether to accept the route advertisements for the corresponding interface. (This is currently supported only for the interfaces that are using the Linux driver.)

Default value: false

addressesstring<ip-prefix>[]

The addresses configured on this interface. Each address must be a valid IP prefix in CIDR notation.

gateway object

The gateway for the network interface.

ipv4_gatewaystring<ipv4-address>

The gateway address for the IPv4 networking stack. Note that there must only be one IPv4 gateway configured across all the interfaces.

ipv6_gatewaystring<ipv6-address>

The gateway address for the IPv6 networking stack. Note that there must only be one IPv6 gateway configured across all the interfaces.

linkstringrequired

The name of the network interface that is used as the parent on which the virtual function will be created.

macstring<mac-address>

The MAC address to use on this interface. It is of the form XX:XX:XX:XX:XX:XX.

mtuinteger<uint16>

The MTU (Maximum Transmission Unit) to be used on this interface.

Default value: 1500

Example: 1472

namestringrequired

The name of the network interface.

neighbors object[]

The static neighbors configured on this network interface.

Array [

addressstring<ip-address>required

The IP address.

commentstring

An optional human-readable string to comment on this neighbor.

macstring<mac-address>

The MAC address corresponding to the address. It is of the form XX:XX:XX:XX:XX:XX.

sequence_idinteger<uint32>required

The sequence id determines the order of the neighbor entries.

Example: 3

]

routes object[]

The routes which are configured on this network interface.

Array [

commentstring

An optional human-readable string to comment on this route.

fromstring<ip-address>

The source IP address for traffic going through the route.

metricinteger<uint16>

The metric for the route. The lower its value, the higher its priority.

Default value: 10

sequence_idinteger<uint32>required

The sequence id determines the order of the route entries.

Example: 3

tostring<ip-prefix>required

The destination prefix in CIDR notation of this route.

viastring<ip-address>required

The next hop address which should be used for the prefix.

]

rx_queue_sizeinteger<uint16>

The number of descriptors in the receive queue. (This option is currently supported only for VPP interfaces.)

Default value: 1024

Example: 2048

tx_queue_sizeinteger<uint16>

The number of descriptors in the transmit queue. (This is currently supported only for VPP interfaces.)

Default value: 1024

Example: 2048

vrrp object[]

The VRRP (Virtual Router Redundancy Protocol) configurations for this interface.

Array [

addressesstring<ip-address>[]required

The list of virtual IP addresses. It must contain at least one IP address. Each sequence entry is in CIDR notation.

Possible values: >= 1

no_preemptboolean

If set to true, the preempt mode is disabled. This means that the router will not preempt the master even if it has a higher priority than the current master. If set to false, the router will preempt the master if it has a higher priority than the current master.

Default value: false

peersstring<ip-address>[]required

Optional list of IP addresses of the VRRP peers. If the list is empty, the router will send VRRP packets to the multicast address. If the list is not empty, the router will send VRRP packets to the unicast addresses specified in the list.

Possible values: >= 1

priorityinteger<uint8>

The priority value to be used by this VRRP router. Higher means higher priority and it ranges between 1 and 255 (decimal).

Default value: 1

Example: 17

vridinteger<uint8>required

The virtual router identifier, which ranges between 1 and 255 (decimal).

Example: 3

]

]

vlans object[]

Top-level configuration and state for VLAN interfaces.

Array [

accept_raboolean

Whether to accept the route advertisements for the corresponding interface. (This is currently supported only for the interfaces that are using the Linux driver.)

Default value: false

addressesstring<ip-prefix>[]

The addresses configured on this interface. Each address must be a valid IP prefix in CIDR notation.

gateway object

The gateway for the network interface.

ipv4_gatewaystring<ipv4-address>

The gateway address for the IPv4 networking stack. Note that there must only be one IPv4 gateway configured across all the interfaces.

ipv6_gatewaystring<ipv6-address>

The gateway address for the IPv6 networking stack. Note that there must only be one IPv6 gateway configured across all the interfaces.

idinteger<uint16>required

The VLAN ID of the VLAN interface. It ranges between 0 and 4095.

Possible values: <= 4095

linkstringrequired

The name of the physical interface used for this VLAN.

macstring<mac-address>

The MAC address to use on this interface. It is of the form XX:XX:XX:XX:XX:XX.

mtuinteger<uint16>

The MTU (Maximum Transmission Unit) to be used on this interface.

Default value: 1500

Example: 1472

namestringrequired

The name of the network interface.

neighbors object[]

The static neighbors configured on this network interface.

Array [

addressstring<ip-address>required

The IP address.

commentstring

An optional human-readable string to comment on this neighbor.

macstring<mac-address>

The MAC address corresponding to the address. It is of the form XX:XX:XX:XX:XX:XX.

sequence_idinteger<uint32>required

The sequence id determines the order of the neighbor entries.

Example: 3

]

routes object[]

The routes which are configured on this network interface.

Array [

commentstring

An optional human-readable string to comment on this route.

fromstring<ip-address>

The source IP address for traffic going through the route.

metricinteger<uint16>

The metric for the route. The lower its value, the higher its priority.

Default value: 10

sequence_idinteger<uint32>required

The sequence id determines the order of the route entries.

Example: 3

tostring<ip-prefix>required

The destination prefix in CIDR notation of this route.

viastring<ip-address>required

The next hop address which should be used for the prefix.

]

rx_queue_sizeinteger<uint16>

The number of descriptors in the receive queue. (This option is currently supported only for VPP interfaces.)

Default value: 1024

Example: 2048

tx_queue_sizeinteger<uint16>

The number of descriptors in the transmit queue. (This is currently supported only for VPP interfaces.)

Default value: 1024

Example: 2048

vrrp object[]

The VRRP (Virtual Router Redundancy Protocol) configurations for this interface.

Array [

addressesstring<ip-address>[]required

The list of virtual IP addresses. It must contain at least one IP address. Each sequence entry is in CIDR notation.

Possible values: >= 1

no_preemptboolean

If set to true, the preempt mode is disabled. This means that the router will not preempt the master even if it has a higher priority than the current master. If set to false, the router will preempt the master if it has a higher priority than the current master.

Default value: false

peersstring<ip-address>[]required

Optional list of IP addresses of the VRRP peers. If the list is empty, the router will send VRRP packets to the multicast address. If the list is not empty, the router will send VRRP packets to the unicast addresses specified in the list.

Possible values: >= 1

priorityinteger<uint8>

The priority value to be used by this VRRP router. Higher means higher priority and it ranges between 1 and 255 (decimal).

Default value: 1

Example: 17

vridinteger<uint8>required

The virtual router identifier, which ranges between 1 and 255 (decimal).

Example: 3

]

]

wireguards object[]

Top-level configuration and state for Wireguard interfaces.

Array [

addressesstring<ip-prefix>[]

The addresses configured on this interface. Each address must be a valid IP prefix in CIDR notation.

gateway object

The gateway for the network interface.

ipv4_gatewaystring<ipv4-address>

The gateway address for the IPv4 networking stack. Note that there must only be one IPv4 gateway configured across all the interfaces.

ipv6_gatewaystring<ipv6-address>

The gateway address for the IPv6 networking stack. Note that there must only be one IPv6 gateway configured across all the interfaces.

mtuinteger<uint16>

The MTU (Maximum Transmission Unit) to be used on this interface.

Default value: 1420

namestringrequired

The name of the network interface.

peers object[]

The list of Wireguard peers.

Array [

allowed_ipsstring[]

A list of IPv4/IPv6 addresses with a CIDR mask. The list indicates the addresses from which the peer is allowed to connect. Catch all are expressed as 0.0.0.0/0 (IPv4) and ::/0 (IPv6)

endpointstringrequired

Remote endpoint of the Wireguard tunnel. In the form host:port where host can be an IPv4/IPv6 address or a hostname, and port is a port number.

public_keystringrequired

The base64 encoded public key of the Wireguard peer.

]

pointopointstring<ip-address>

This enables the point-to-point mode on the interface, meaning that it is a direct link between two machines with nobody else listening on it.

portinteger<uint16>required

The port to listen on.

routes object[]

The routes for the network interface.

Array [

commentstring

An optional human-readable string to comment on this route.

fromstring<ip-address>

The source IP address for traffic going through the route.

metricinteger<uint16>

The metric for the route. The lower its value, the higher its priority.

Default value: 10

sequence_idinteger<uint32>required

The sequence id determines the order of the route entries.

Example: 3

tostring<ip-prefix>required

The destination prefix in CIDR notation of this route.

viastring<ip-address>required

The next hop address which should be used for the prefix.

]

]

Config_Interfaces_Wrapped

{
  "interfaces": {
    "bonds": [
      {
        "accept_ra": false,
        "addresses": [
          "string"
        ],
        "gateway": {
          "ipv4_gateway": "string",
          "ipv6_gateway": "string"
        },
        "interfaces": [
          "string"
        ],
        "mac": "string",
        "mtu": 1472,
        "name": "string",
        "neighbors": [
          {
            "address": "string",
            "comment": "string",
            "mac": "string",
            "sequence_id": 3
          }
        ],
        "routes": [
          {
            "comment": "string",
            "from": "string",
            "metric": 10,
            "sequence_id": 3,
            "to": "string",
            "via": "string"
          }
        ],
        "rx_queue_size": 2048,
        "tx_queue_size": 2048,
        "vrrp": [
          {
            "addresses": [
              "string"
            ],
            "no_preempt": false,
            "peers": [
              "string"
            ],
            "priority": 17,
            "vrid": 3
          }
        ]
      }
    ],
    "ethernets": [
      {
        "accept_ra": false,
        "addresses": [
          "string"
        ],
        "driver": "LINUX",
        "gateway": {
          "ipv4_gateway": "string",
          "ipv6_gateway": "string"
        },
        "mac": "string",
        "mtu": 1472,
        "name": "string",
        "neighbors": [
          {
            "address": "string",
            "comment": "string",
            "mac": "string",
            "sequence_id": 3
          }
        ],
        "routes": [
          {
            "comment": "string",
            "from": "string",
            "metric": 10,
            "sequence_id": 3,
            "to": "string",
            "via": "string"
          }
        ],
        "rx_queue_size": 2048,
        "tx_queue_size": 2048,
        "vpp": {
          "vlan_strip_offload": false
        },
        "vrrp": [
          {
            "addresses": [
              "string"
            ],
            "no_preempt": false,
            "peers": [
              "string"
            ],
            "priority": 17,
            "vrid": 3
          }
        ]
      }
    ],
    "loopbacks": [
      {
        "addresses": [
          "string"
        ],
        "name": "string"
      }
    ],
    "virtual_functions": [
      {
        "accept_ra": false,
        "addresses": [
          "string"
        ],
        "gateway": {
          "ipv4_gateway": "string",
          "ipv6_gateway": "string"
        },
        "link": "string",
        "mac": "string",
        "mtu": 1472,
        "name": "string",
        "neighbors": [
          {
            "address": "string",
            "comment": "string",
            "mac": "string",
            "sequence_id": 3
          }
        ],
        "routes": [
          {
            "comment": "string",
            "from": "string",
            "metric": 10,
            "sequence_id": 3,
            "to": "string",
            "via": "string"
          }
        ],
        "rx_queue_size": 2048,
        "tx_queue_size": 2048,
        "vrrp": [
          {
            "addresses": [
              "string"
            ],
            "no_preempt": false,
            "peers": [
              "string"
            ],
            "priority": 17,
            "vrid": 3
          }
        ]
      }
    ],
    "vlans": [
      {
        "accept_ra": false,
        "addresses": [
          "string"
        ],
        "gateway": {
          "ipv4_gateway": "string",
          "ipv6_gateway": "string"
        },
        "id": 0,
        "link": "string",
        "mac": "string",
        "mtu": 1472,
        "name": "string",
        "neighbors": [
          {
            "address": "string",
            "comment": "string",
            "mac": "string",
            "sequence_id": 3
          }
        ],
        "routes": [
          {
            "comment": "string",
            "from": "string",
            "metric": 10,
            "sequence_id": 3,
            "to": "string",
            "via": "string"
          }
        ],
        "rx_queue_size": 2048,
        "tx_queue_size": 2048,
        "vrrp": [
          {
            "addresses": [
              "string"
            ],
            "no_preempt": false,
            "peers": [
              "string"
            ],
            "priority": 17,
            "vrid": 3
          }
        ]
      }
    ],
    "wireguards": [
      {
        "addresses": [
          "string"
        ],
        "gateway": {
          "ipv4_gateway": "string",
          "ipv6_gateway": "string"
        },
        "mtu": 1420,
        "name": "string",
        "peers": [
          {
            "allowed_ips": [
              "string"
            ],
            "endpoint": "string",
            "public_key": "string"
          }
        ],
        "pointopoint": "string",
        "port": 0,
        "routes": [
          {
            "comment": "string",
            "from": "string",
            "metric": 10,
            "sequence_id": 3,
            "to": "string",
            "via": "string"
          }
        ]
      }
    ]
  }
}