Networking_Interfaces_InterfaceInfo

Networking_Interfaces_InterfaceInfo
Networking_Interfaces_InterfaceInfo

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

JSON Example
{
    "name": "string",
    "status": "string",
    "mac": "string",
    "ipv4": {
        "configurable": false,
        "mode": "string",
        "address": "string",
        "prefix": 0,
        "default_gateway": "string"
    },
    "ipv6": {
        "dhcp": false,
        "autoconf": false,
        "addresses": [
            {
                "origin": "string",
                "status": "string",
                "address": "string",
                "prefix": 0
            }
        ],
        "default_gateway": "string",
        "configurable": false
    }
}
string
name
Required

Interface name, for example, "nic0", "nic1".

status
Required

Interfaces.InterfaceStatus enumerated type Defines interface status
down : The interface is down.
up : The interface is up.

string
mac
Required

MAC address. For example 00:0C:29:94:BB:5A.

ipv4
Optional

The Ipv4.Info structure defines current IPv4 configuration state of a network interface.

ipv6
Optional

The Ipv6.Info structure provides the structure that defines an existing IPv6 configuration on a particular interface. This structure is read only.