/v1/network/status/{id} | Qumulo Documentation

Endpoint

/v1/network/status/{id}
GET

This method retrieves the network configuration of the underlying system, including DHCP configuration, and status of any pending changes. This API is deprecated in favor of /v2/network/interfaces/1/status/{node_id}.
Parameters

Name	Description	Required
`id`	The unique ID of the node	Yes
Response

Codes

Code	Description
200	Return value on success
Schema

{
  "description": "api_network_status_response",
  "type": "object",
  "properties": {
    "id": {
      "description": "Node ID",
      "type": "number"
    },
    "node_name": {
      "description": "Node name",
      "type": "string"
    },
    "update_status": {
      "type": "string",
      "enum": [
        "CHANGES_APPLIED",
        "CHANGES_PENDING",
        "UNAVAILABLE"
      ],
      "description": "update_status:\n * `CHANGES_APPLIED` - UPDATE_STATUS_CHANGES_APPLIED,\n * `CHANGES_PENDING` - UPDATE_STATUS_CHANGES_PENDING,\n * `UNAVAILABLE` - UPDATE_STATUS_UNAVAILABLE"
    },
    "network_status": {
      "description": "network_status",
      "type": "object",
      "properties": {
        "id": {
          "description": "Node Id",
          "type": "number"
        },
        "assigned_by": {
          "type": "string",
          "enum": [
            "DHCP",
            "STATIC",
            "LINK_LOCAL"
          ],
          "description": "How to assign IP address, either DHCP or STATIC:\n * `DHCP` - NETWORK_ASSIGNED_BY_DHCP,\n * `LINK_LOCAL` - NETWORK_ASSIGNED_BY_LINK_LOCAL,\n * `STATIC` - NETWORK_ASSIGNED_BY_STATIC"
        },
        "address": {
          "description": "The IPv4 or IPv6 address in 0.0.0.0 or :: format",
          "type": "string"
        },
        "floating_addresses": {
          "type": "array",
          "items": {
            "description": "Floating IPv4 or IPv6 addresses in 0.0.0.0 or :: format",
            "type": "string"
          }
        },
        "netmask": {
          "description": "The IPv4 or IPv6 netmask in 0.0.0.0 or :: format, or the IPv4 or IPv6 subnet CIDR",
          "type": "string"
        },
        "gateway": {
          "description": "The IPv4 gateway in 0.0.0.0 format",
          "type": "string"
        },
        "gateway_ipv6": {
          "description": "The IPv6 gateway in :: format",
          "type": "string"
        },
        "dns_servers": {
          "type": "array",
          "items": {
            "description": "The list of DNS servers",
            "type": "string"
          }
        },
        "dns_search_domains": {
          "type": "array",
          "items": {
            "description": "The list of DNS search domains",
            "type": "string"
          }
        },
        "mtu": {
          "description": "The maximum transfer unit in bytes",
          "type": "number"
        },
        "bonding_mode": {
          "type": "string",
          "enum": [
            "ACTIVE_BACKUP",
            "IEEE_8023AD"
          ],
          "description": "Ethernet bonding mode (ACTIVE_BACKUP or IEEE_8023AD), if the interface is bonded.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"
        }
      }
    },
    "network_details": {
      "description": "network_details",
      "type": "object",
      "properties": {
        "speed": {
          "description": "Network card speed in Mbps.",
          "type": "number"
        },
        "bytes_sent": {
          "description": "Bytes sent over the interface.",
          "type": "string"
        },
        "bytes_received": {
          "description": "Bytes received over the interface.",
          "type": "string"
        },
        "cable_status": {
          "type": "string",
          "enum": [
            "CONNECTED",
            "DISCONNECTED",
            "UNKNOWN"
          ],
          "description": "Whether network card is connected via cable.:\n * `CONNECTED` - NETWORK_CABLE_CONNECTED,\n * `DISCONNECTED` - NETWORK_CABLE_DISCONNECTED,\n * `UNKNOWN` - NETWORK_CABLE_UNKNOWN"
        },
        "interface_status": {
          "type": "string",
          "enum": [
            "UP",
            "DOWN",
            "MISSING",
            "UNKNOWN",
            "NOTPRESENT",
            "LOWERLAYERDOWN",
            "TESTING",
            "DORMANT"
          ],
          "description": "Status of interface connection.:\n * `DORMANT` - NETWORK_INTERFACE_DORMANT,\n * `DOWN` - NETWORK_INTERFACE_DOWN,\n * `LOWERLAYERDOWN` - NETWORK_INTERFACE_LOWER_LAYER_DOWN,\n * `MISSING` - NETWORK_INTERFACE_MISSING,\n * `NOTPRESENT` - NETWORK_INTERFACE_NOT_PRESENT,\n * `TESTING` - NETWORK_INTERFACE_TESTING,\n * `UNKNOWN` - NETWORK_INTERFACE_UNKNOWN,\n * `UP` - NETWORK_INTERFACE_UP"
        },
        "mac_address": {
          "description": "MAC address.",
          "type": "string"
        },
        "timestamp": {
          "description": "UNIX epoch timestamp for when the network status was sampled.",
          "type": "string"
        }
      }
    }
  }
}