REST API - get
  1. Operations
  2. appliance
  3. networking

appliance networking: get

Get Networking information for all configured interfaces. This operation was added in vSphere API 6.7.

Request:

HTTP request

GET https://{server}/rest/appliance/networking
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "interfaces" : [
            {
                "value" : {
                    "ipv4" : {
                        "mode" : "DHCP",
                        "default_gateway" : "string",
                        "address" : "string",
                        "prefix" : 1,
                        "configurable" : true
                    },
                    "ipv6" : {
                        "default_gateway" : "string",
                        "addresses" : [
                            {
                                "address" : "string",
                                "prefix" : 1,
                                "origin" : "DHCP",
                                "status" : "TENTATIVE"
                            },
                            {
                                "address" : "string",
                                "prefix" : 1,
                                "origin" : "DHCP",
                                "status" : "TENTATIVE"
                            }
                        ],
                        "autoconf" : true,
                        "dhcp" : true,
                        "configurable" : true
                    },
                    "name" : "string",
                    "mac" : "string",
                    "status" : "down"
                },
                "key" : "obj-103"
            }
        ],
        "dns" : {
            "mode" : "DHCP",
            "hostname" : "string",
            "servers" : [
                "string",
                "string"
            ]
        }
    }
}

Response Type:

Name Type Description
bold = required
value info The Map of network configuration info for all interfaces.
value.dns DNS_info DNS configuration. This attribute was added in vSphere API 6.7.
value.dns.mode string DNS mode. This attribute was added in vSphere API 6.7.

Describes the source of DNS servers. This enumeration was added in vSphere API 6.7. Value is one of:
DHCP: The DNS servers addresses are obtained from a DHCP server. This constant was added in vSphere API 6.7.
STATIC: The DNS servers addresses are specified explicitly. This constant was added in vSphere API 6.7.
value.dns.hostname string Hostname. This attribute was added in vSphere API 6.7.
value.dns.servers string[] Servers. This attribute was added in vSphere API 6.7.
value.interfaces list Interface configuration as a key-value map where key is a network interface name, for example, "nic0". This attribute was added in vSphere API 6.7.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.appliance.networking.interfaces. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.appliance.networking.interfaces.List of {"key": string, "value": interface_info}

Errors:

HTTP Status Code Type Description
500 error Generic error.