1. Types
  2. appliance
  3. networking
  4. interfaces

appliance networking interfaces: interface info

interface_info structure Structure that defines properties and status of a network interface.

Representation:

{
    "ipv4": {
        "address": "string",
        "configurable": true,
        "default_gateway": "string",
        "mode": "DHCP",
        "prefix": 1
    },
    "ipv6": {
        "addresses": [
            {
                "address": "string",
                "origin": "DHCP",
                "prefix": 1,
                "status": "TENTATIVE"
            },
            {
                "address": "string",
                "origin": "DHCP",
                "prefix": 1,
                "status": "TENTATIVE"
            }
        ],
        "autoconf": true,
        "configurable": true,
        "default_gateway": "string",
        "dhcp": true
    },
    "mac": "string",
    "name": "string",
    "status": "down"
}

Attributes:

Name Type Description
Required
name string Interface name, for example, "nic0", "nic1".
status string Interface status.

Defines interface status Value is one of:
down: The interface is down.
up: The interface is up.
mac string MAC address. For example 00:0C:29:94:BB:5A.
Optional
ipv4 info IPv4 Address information. This attribute was added in vSphere API 6.7

Optional. ipv4 This field will be unset if IPv4 is not enabled.
ipv6 info IPv6 Address information. This attribute was added in vSphere API 6.7

Optional. ipv6 This field will be unset if IPv6 is not enabled.