Skip to main content
API Version:

Anapaya appliance configuration (shuttle_servers only)

shuttle_servers object

The necessary configuration data for Shuttle servers on the Anapaya appliance.

servers object[]

The necessary configuration data for Shuttle servers on the Anapaya appliance.

  • Array [
  • addressstring<ip-prefix>

    The IPv4/IPv6 address of the tunnel with a CIDR mask.

    advertised_routesstring<ip-prefix>[]

    A list of IPv4/IPv6 addresses with a CIDR mask. The prefixes in the list are advertised to all connected clients. Subsequently, the clients route all traffic to these prefixes via the shuttle server. Must be in the same family as the tunnel address. If empty, it is by default equal to allowed_destinations. It must not be empty if shuttle traffic is NATed. Catch all are expressed as 0.0.0.0/0 (IPv4) and ::/0 (IPv6)

    allowed_destinationsstring<ip-prefix>[]

    A list of IPv4/IPv6 addresses with a CIDR mask. The list indicates the networks that are reachable through the Shuttle server. All other destinations are disallowed. Must be in the same family as local tunnel address. The list is used to configure firewall forwarding rules on the appliance. Catch all are expressed as 0.0.0.0/0 (IPv4) and ::/0 (IPv6)

    clients object[]

    The list of Shuttle clients.

  • Array [
  • addressstring<ip-address>

    The IPv4/IPv6 address that will be assigned to the client tunnel interface upon successful connection. Without CIDR mask. Must be in the same family as local tunnel address.

    credentialstring

    A base64 encoded string that is used to authenticate the client.

  • ]
  • endpointstring<scion-port>

    The endpoint address on which the server is listening for connection requests from Shuttle clients. In two alternative forms [ISD-AS,IP]:port, or IP:port, where ISD-AS is an ISD-AS number, IP is an IPv4/IPv6 address

    Example: 127.0.0.1:443
    mtuinteger<uint16>

    The MTU (Maximum Transmission Unit) to be used on the shuttle interface. The user usually does not need to change this default value. The value is chosen to work in extreme circumstances.

    Default value: 1000
    namestring

    The name of the network interface.

  • ]
  • Config_ShuttleServers_Wrapped
    {
    "shuttle_servers": {
    "servers": [
    {
    "address": "string",
    "advertised_routes": [
    "string"
    ],
    "allowed_destinations": [
    "string"
    ],
    "clients": [
    {
    "address": "string",
    "credential": "string"
    }
    ],
    "endpoint": "127.0.0.1:443",
    "mtu": 1000,
    "name": "string"
    }
    ]
    }
    }