REST API - get
  1. Operations
  2. appliance
  3. techpreview
  4. networking
  5. ipv6

appliance techpreview networking ipv6: get

Get IPv6 network configuration for interfaces.

Request:

HTTP request

POST https://{server}/rest/appliance/techpreview/networking/ipv6/get

Request Body Structure:

{
    "interfaces" : [
        "string",
        "string"
    ]
}

Request Body Parameters:

Name Type Description
bold = required
interfaces string[] Network interfaces to query, for example, "nic0".

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "default_gateway" : "string",
            "updateable" : true,
            "addresses" : [
                {
                    "address" : "string",
                    "prefix" : 1,
                    "origin" : "dhcp",
                    "status" : "tentative"
                },
                {
                    "address" : "string",
                    "prefix" : 1,
                    "origin" : "dhcp",
                    "status" : "tentative"
                }
            ],
            "interface_name" : "string",
            "autoconf" : true,
            "dhcp" : true
        },
        {
            "default_gateway" : "string",
            "updateable" : true,
            "addresses" : [
                {
                    "address" : "string",
                    "prefix" : 1,
                    "origin" : "dhcp",
                    "status" : "tentative"
                },
                {
                    "address" : "string",
                    "prefix" : 1,
                    "origin" : "dhcp",
                    "status" : "tentative"
                }
            ],
            "interface_name" : "string",
            "autoconf" : true,
            "dhcp" : true
        }
    ]
}

Response Type:

Name Type Description
bold = required
value I_pv6_config_read_only[] IPv6 configuration.
value[].interface_name string Network interface, for example, "nic0" queried.
value[].dhcp boolean Address assigned by a DHCP server.
value[].autoconf boolean Address is assigned by Stateless Address Autoconfiguration (SLAAC).
value[].addresses I_pv6_address_read_only[] A list of all addresses assigned to this interface. The origin field of each address determines how the address was assigned, for example, statically, by DHCP, SLAAC.
value[].addresses[].address string IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a.
value[].addresses[].prefix long IPv6 CIDR prefix, for example, 64.
value[].addresses[].origin string Origin of the IPv6 address. For more information, see RFC 4293.

Defines IPv6 address origin values. Value is one of:
dhcp: The IPv6 address is assigned by a DHCP server. See RFC 4293.
random: The IPv6 address is assigned randomly by the system. See RFC 4293.
manual: The IPv6 address was manually configured to a specified address, for, example, by user configuration. See RFC 4293.
other: The IPv6 address is assigned by a mechanism other than manual, DHCP, SLAAC, or random. See RFC 4293.
linklayer: The IPv6 address is assigned by IPv6 Stateless Address Auto-configuration (SLAAC). See RFC 4293.
value[].addresses[].status string Status of the IPv6 address. For more information, see RFC 4293.

Defines IPv6 address status values. Value is one of:
tentative: This IPv6 address is in the process of being verified as unique. Do not use addresses in this state for general communication. You can use them to determine the uniqueness of the address. See RFC 4293.
unknown: The status of this address cannot be determined. See RFC 4293.
inaccessible: This IPv6 address is inaccessible because the interface to which this address is assigned is not operational. See RFC 4293.
invalid: This IPv6 address is not a valid address. It should not appear as the destination or source address of a packet. See RFC 4293.
duplicate: This IPv6 address is not unique on the link. Do use this IPv6 address. See RFC 4293.
preferred: This is a valid IPv6 address that can appear as the destination or source address of a packet. See RFC 4293.
deprecated: This is a valid but deprecated IPv6 address. Do not use this IPv6 address as a source address in new communications, although packets addressed to such an address are processed as expected. See RFC 4293.
optimistic: This IPv6 address is available for use, subject to restrictions, while its uniqueness on a link is being verified. See RFC 4293.
value[].default_gateway string Default gateway. This configures the global IPv6 default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces.
value[].updateable boolean This indicates if the network configuration can be updated for the interface.

Errors:

HTTP Status Code Type Description
500 error Generic error