network/status

{
  "type": "array",
  "items": {
    "description": "api_node_network_status",
    "type": "object",
    "properties": {
      "node_id": {
        "description": "Unique identifier for the node.",
        "type": "number"
      },
      "node_name": {
        "description": "Human-readable name of the node.",
        "type": "string"
      },
      "managed_interface_statuses": {
        "type": "array",
        "items": {
          "description": "Status of all managed network interfaces on this node.",
          "type": "object",
          "properties": {
            "name": {
              "description": "Name of the interface.",
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "APPLIED",
                "PENDING",
                "FAILED"
              ],
              "description": "Current application status of the interface.:\n * `APPLIED` - APPLICATION_STATUS_APPLIED,\n * `FAILED` - APPLICATION_STATUS_FAILED,\n * `PENDING` - APPLICATION_STATUS_PENDING"
            },
            "details": {
              "description": "Additional details about the interface status.",
              "type": "string"
            }
          }
        }
      },
      "network_statuses": {
        "description": "Status of all network configurations on this node.",
        "type": "object",
        "properties": {},
        "additionalProperties": {
          "description": "Status of all network configurations on this node. value",
          "type": "object",
          "properties": {
            "name": {
              "description": "Human readable name of this network configuration.",
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "APPLIED",
                "PENDING",
                "FAILED"
              ],
              "description": "Current application status of the network configuration.:\n * `APPLIED` - APPLICATION_STATUS_APPLIED,\n * `FAILED` - APPLICATION_STATUS_FAILED,\n * `PENDING` - APPLICATION_STATUS_PENDING"
            },
            "details": {
              "description": "Additional details about the network configuration status.",
              "type": "string"
            }
          }
        }
      },
      "devices": {
        "type": "array",
        "items": {
          "description": "All detected network devices on this node.",
          "type": "object",
          "properties": {
            "name": {
              "description": "Name of the network device.",
              "type": "string"
            },
            "permanent_mac_address": {
              "description": "Permanent hardware MAC address of the device.",
              "type": "string"
            },
            "mac_address": {
              "description": "Current MAC address of the device.",
              "type": "string"
            },
            "speed": {
              "description": "Link speed in Mbps.",
              "type": "string"
            },
            "bytes_sent": {
              "description": "Total bytes transmitted on this device.",
              "type": "string"
            },
            "bytes_received": {
              "description": "Total bytes received on this device.",
              "type": "string"
            },
            "cable_status": {
              "type": "string",
              "enum": [
                "CONNECTED",
                "DISCONNECTED",
                "UNKNOWN"
              ],
              "description": "Cable connection status of the device.:\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": "Operational status of the network interface.:\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"
            },
            "mtu": {
              "description": "Maximum transmission unit in bytes.",
              "type": "number"
            },
            "bonding_mode": {
              "type": "string",
              "enum": [
                "ACTIVE_BACKUP",
                "IEEE_8023AD"
              ],
              "description": "Bonding mode if this device is part of a bond.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"
            },
            "vlan_id": {
              "description": "VLAN ID if this device is a VLAN interface.",
              "type": "number"
            },
            "timestamp": {
              "description": "Timestamp when this status was captured.",
              "type": "string"
            },
            "api_network_specific_fields": {
              "description": "api_network_specific_fields",
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "FRONTEND",
                    "BACKEND",
                    "FRONTEND_AND_BACKEND",
                    "UNDERLYING",
                    "NONE"
                  ],
                  "description": "use_for:\n * `BACKEND` - USE_FOR_BACKEND,\n * `FRONTEND` - USE_FOR_FRONTEND,\n * `FRONTEND_AND_BACKEND` - USE_FOR_FRONTEND_AND_BACKEND,\n * `NONE` - USE_FOR_NONE,\n * `UNDERLYING` - USE_FOR_UNDERLYING"
                },
                "qumulo_ip_addresses": {
                  "type": "array",
                  "items": {
                    "description": "Value present when type is USE_FOR_FRONTEND, USE_FOR_BACKEND, or USE_FOR_FRONTEND_AND_BACKEND.",
                    "type": "object",
                    "properties": {
                      "network_id": {
                        "description": "Unique identifier for this network configuration",
                        "type": "number"
                      },
                      "assigned_by": {
                        "type": "string",
                        "enum": [
                          "DHCP",
                          "STATIC",
                          "LINK_LOCAL",
                          "HOST"
                        ],
                        "description": "How networks are assigned: DHCP, STATIC, or HOST:\n * `DHCP` - NETWORK_ASSIGNED_BY_DHCP,\n * `HOST` - NETWORK_ASSIGNED_BY_HOST,\n * `LINK_LOCAL` - NETWORK_ASSIGNED_BY_LINK_LOCAL,\n * `STATIC` - NETWORK_ASSIGNED_BY_STATIC"
                      },
                      "netmask": {
                        "description": "The IPv4 or IPv6 netmask",
                        "type": "string"
                      },
                      "address": {
                        "description": "The IPv4 or IPv6 address assigned to this interface",
                        "type": "string"
                      },
                      "floating_addresses": {
                        "type": "array",
                        "items": {
                          "description": "Floating IP addresses in 0.0.0.0 or :: format",
                          "type": "string"
                        }
                      },
                      "gateway": {
                        "description": "Default gateway address for this network",
                        "type": "string"
                      }
                    }
                  }
                },
                "host_routable_ip_addresses": {
                  "type": "array",
                  "items": {
                    "description": "Value present when type is USE_FOR_FRONTEND, USE_FOR_BACKEND, or USE_FOR_FRONTEND_AND_BACKEND.",
                    "type": "string"
                  }
                },
                "upper_interface_name": {
                  "description": "Value present when type is USE_FOR_UNDERLYING.",
                  "type": "string"
                },
                "addresses": {
                  "type": "array",
                  "items": {
                    "description": "Value present when type is USE_FOR_NONE.",
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "environment": {
        "description": "Detected network environment settings.",
        "type": "object",
        "properties": {
          "dns_servers": {
            "type": "array",
            "items": {
              "description": "List of DNS server addresses.",
              "type": "string"
            }
          },
          "dns_search_domains": {
            "type": "array",
            "items": {
              "description": "List of DNS search domains.",
              "type": "string"
            }
          },
          "systemwide_default_gateways": {
            "type": "array",
            "items": {
              "description": "System-wide default gateway addresses.",
              "type": "string"
            }
          }
        }
      },
      "api_cloud_provider_status": {
        "description": "api_cloud_provider_status",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "AWS",
              "AZURE",
              "GCP"
            ],
            "description": "type:\n * `AWS` - AWS cloud provider,\n * `AZURE` - Azure cloud provider,\n * `GCP` - GCP cloud provider"
          },
          "aws_status": {
            "description": "Value present when type is API_CLOUD_PROVIDER_STATUS_AWS.",
            "type": "object",
            "properties": {
              "eni_id": {
                "description": "ID of the network interface.",
                "type": "string"
              },
              "device_number": {
                "description": "Device number of the interface.",
                "type": "number"
              },
              "private_ipv4_addresses": {
                "type": "array",
                "items": {
                  "description": "All private IP addresses associated with the interface.",
                  "type": "string"
                }
              },
              "subnet_id": {
                "description": "ID of the subnet for the interface.",
                "type": "string"
              },
              "subnet_mask": {
                "description": "Subnet mask of the interface.",
                "type": "string"
              },
              "vpc_id": {
                "description": "ID of the VPC for the interface.",
                "type": "string"
              },
              "security_groups": {
                "type": "array",
                "items": {
                  "description": "Names of the security groups applied.",
                  "type": "string"
                }
              }
            }
          },
          "azure_status": {
            "description": "Value present when type is API_CLOUD_PROVIDER_STATUS_AZURE.",
            "type": "object",
            "properties": {
              "private_ipv4_address": {
                "description": "Private IPv4 address of this instance.",
                "type": "string"
              },
              "network": {
                "description": "Azure network containing this instance.",
                "type": "string"
              },
              "subnet_mask": {
                "description": "Subnet mask of the instance's network.",
                "type": "string"
              }
            }
          },
          "gcp_status": {
            "description": "Value present when type is API_CLOUD_PROVIDER_STATUS_GCP.",
            "type": "object",
            "properties": {
              "private_ipv4_address": {
                "description": "Private IPv4 address of this instance.",
                "type": "string"
              },
              "ip_aliases": {
                "type": "array",
                "items": {
                  "description": "List of IP aliases associated with this instance.",
                  "type": "string"
                }
              },
              "network": {
                "description": "GCP network containing this instance.",
                "type": "string"
              },
              "subnet_mask": {
                "description": "Subnet mask of the instance's network.",
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}