Get edge node info (GET /v1/devices/name/{name}/status/info)

Get edge node info

curl --request GET \
  --url https://{apiHost}/api/v1/devices/name/{name}/status/info \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/devices/name/{name}/status/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "id": "<string>",
  "adminState": "ADMIN_STATE_UNSPECIFIED",
  "runState": "RUN_STATE_UNSPECIFIED",
  "upTime": "2023-11-07T05:31:56Z",
  "tags": {},
  "lastUpdate": "2023-11-07T05:31:56Z",
  "bootTime": "2023-11-07T05:31:56Z",
  "netStatusList": [
    {
      "up": true,
      "macAddr": "<string>",
      "ifName": "<string>",
      "ipAddrs": [
        "<string>"
      ],
      "defaultRouters": [
        "<string>"
      ],
      "dns": {
        "servers": [
          "<string>"
        ],
        "domain": "<string>",
        "search": [
          "<string>"
        ]
      },
      "location": {
        "underlayIP": "<string>",
        "hostname": "<string>",
        "city": "<string>",
        "region": "<string>",
        "country": "<string>",
        "loc": "<string>",
        "org": "<string>",
        "postal": "<string>",
        "latlong": "<string>",
        "freeloc": "<string>"
      },
      "uplink": true,
      "proxy": {
        "networkProxy": true,
        "proxies": [
          {
            "proto": "NETWORK_PROXY_PROTO_HTTP",
            "server": "<string>",
            "port": 123
          }
        ],
        "exceptions": "<string>",
        "pacfile": "<string>",
        "networkProxyURL": "<string>",
        "wpadProxyURL": "<string>"
      },
      "errInfo": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "gpsLocation": {
        "latitude": 123,
        "longitude": 123,
        "altitude": 123,
        "timestamp": {},
        "horizontalReliability": 123,
        "verticalReliability": 123,
        "horizontalUncertainty": 123,
        "verticalUncertainty": 123,
        "logicalLabel": "<string>"
      },
      "cellular": {
        "providers": [
          {
            "plmn": "<string>",
            "name": "<string>",
            "rat": "RADIO_ACCESS_TECHNOLOGY_UNSPECIFIED",
            "roaming": true,
            "connectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "modem": {
          "manufacturer": "<string>",
          "model": "<string>",
          "firmwareVersion": "<string>",
          "imei": "<string>",
          "operatingState": "Z_CELLULAR_OPERATING_STATE_UNSPECIFIED",
          "controlProtocol": "Z_CELLULAR_CONTROL_PROTOCOL_UNSPECIFIED"
        },
        "simCards": [
          {
            "slotNumber": 123,
            "slotActivated": true,
            "iccid": "<string>",
            "imsi": "<string>",
            "state": "<string>"
          }
        ]
      },
      "mtu": 123,
      "pnacStatus": {
        "enabled": true,
        "supplicantState": "PNAC_SUPPLICANT_STATE_UNSPECIFIED",
        "lastAuthTimestamp": "2023-11-07T05:31:56Z",
        "err": {
          "description": "<string>",
          "severity": "SEVERITY_UNSPECIFIED",
          "timestamp": {},
          "entities": [
            {
              "entity": "ENTITY_UNSPECIFIED",
              "entityId": "<string>",
              "entityName": "<string>"
            }
          ],
          "retryCondition": "<string>"
        }
      },
      "configSource": {
        "origin": "NETWORK_CONFIG_ORIGIN_UNSPECIFIED",
        "submittedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "dns": {
    "servers": [
      "<string>"
    ],
    "domain": "<string>",
    "search": [
      "<string>"
    ]
  },
  "ioStatusList": [
    {
      "type": "IO_TYPE_UNSPECIFIED",
      "name": "<string>",
      "members": [
        "<string>"
      ],
      "appName": "<string>",
      "lteInfo": {
        "simName": "<string>",
        "cellModuleName": "<string>",
        "imsi": "<string>",
        "iccid": "<string>",
        "simcardState": "SIMCARD_STATE_INVALID",
        "imei": "<string>",
        "firmwareVersion": "<string>"
      },
      "err": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "memberList": [
        {
          "name": "<string>",
          "ioAddress": {
            "macAddress": "<string>"
          }
        }
      ]
    }
  ],
  "storageList": [
    {
      "name": "<string>",
      "mountPath": "<string>",
      "sizeMB": "<string>",
      "partitionLabel": "<string>",
      "partitionTypeGuid": "<string>",
      "partitionUuid": "<string>"
    }
  ],
  "blobList": [
    {
      "hash": "<string>",
      "refCount": "<string>",
      "swState": "SW_STATE_UNSPECIFIED",
      "sizeMB": "<string>"
    }
  ],
  "netCounterList": [
    {
      "ifName": "<string>",
      "txBytes": 123,
      "rxBytes": 123,
      "txPkts": 123,
      "rxPkts": 123,
      "txErrors": 123,
      "rxErrors": 123,
      "txDrops": 123,
      "rxDrops": 123,
      "txAclDrops": 123,
      "rxAclDrops": 123,
      "txAclRateLimitDrops": 123,
      "rxAclRateLimitDrops": 123
    }
  ],
  "hostName": "<string>",
  "swInfo": [
    {
      "activated": true,
      "partitionLabel": "<string>",
      "partitionDevice": "<string>",
      "partitionState": "<string>",
      "status": "SW_STATE_UNSPECIFIED",
      "shortVersion": "<string>",
      "longVersion": "<string>",
      "swError": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "downloadProgress": 123,
      "swStatus": "DEVICE_SW_STATUS_UNSPECIFIED",
      "swSubStatus": "DEVICE_SW_SUB_STATUS_UNSPECIFIED",
      "swSubStatusStr": "<string>",
      "subStatusProgress": 123,
      "isLTS": true
    }
  ],
  "zcCounters": [
    {
      "ifName": "<string>",
      "failures": 123,
      "success": 123,
      "lastFailure": {},
      "lastSuccess": {}
    }
  ],
  "rawStatus": "<string>",
  "Memory": {
    "TotalMB": 123,
    "UsedMB": 123,
    "AllocatedMB": 123
  },
  "Storage": {
    "TotalMB": 123,
    "UsedMB": 123,
    "AllocatedMB": 123,
    "sharedStorageSummary": [
      {
        "Id": "<string>",
        "Name": "<string>",
        "AllocatedMB": 123,
        "UsedMB": 123
      }
    ],
    "Id": "<string>",
    "Name": "<string>"
  },
  "minfo": {
    "manufacturer": "<string>",
    "productName": "<string>",
    "version": "<string>",
    "serialNumber": "<string>",
    "uuid": "<string>",
    "compatible": "<string>",
    "biosVendor": "<string>",
    "biosVersion": "<string>",
    "biosReleaseDate": "<string>",
    "hSMStatus": "DEVICE_HW_SECURITY_MODULE_STATUS_UNSPECIFIED",
    "hSMInfo": "<string>",
    "endorsementKey": "<string>"
  },
  "dinfo": {
    "machineArch": "<string>",
    "cpuArch": "<string>",
    "platform": "<string>",
    "nCpu": 123,
    "memMB": "<string>",
    "storageMB": "<string>"
  },
  "Cpu": {
    "Utilization": 123
  },
  "lastRebootReason": "<string>",
  "lastRebootTime": "2023-11-07T05:31:56Z",
  "dataSecInfo": [
    {
      "status": "DEVICE_DATA_SECURITY_AT_REST_UNKNOWN",
      "name": "<string>",
      "errInfo": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      }
    }
  ],
  "devError": [
    {
      "description": "<string>",
      "severity": "SEVERITY_UNSPECIFIED",
      "timestamp": {},
      "entities": [
        {
          "entity": "ENTITY_UNSPECIFIED",
          "entityId": "<string>",
          "entityName": "<string>"
        }
      ],
      "retryCondition": "<string>"
    }
  ],
  "projectId": "<string>",
  "title": "<string>",
  "attestState": "ATTEST_STATE_UNSPECIFIED",
  "deviceRebootReason": "DEVICE_BOOT_REASON_UNSPECIFIED",
  "clusterID": "<string>",
  "memorySummary": {
    "deviceMemoryMB": 123,
    "allocatedAppsMB": 123,
    "allocatedEveMB": 123,
    "usedEveMB": 123,
    "availableForNewApps": 123
  },
  "capabilities": {
    "HWAssistedVirtualization": true,
    "IOVirtualization": true
  },
  "debugKnob": true,
  "debugKnobExpiryTime": "2023-11-07T05:31:56Z",
  "physicalStorage": [
    {
      "poolName": "<string>",
      "storageType": "PHYSICAL_STORAGE_TYPE_INFO_UNSPECIFIED",
      "storageState": "PHYSICAL_STORAGE_STATUS_UNSPECIFIED",
      "zfsVersion": "<string>",
      "countZvols": 123,
      "currentRaid": "PHYSICAL_STORAGE_RAID_TYPE_UNSPECIFIED",
      "compressionRatio": 123,
      "zpoolSize": "<string>",
      "disks": [
        {
          "disk": {
            "name": "<string>",
            "logicalName": "<string>",
            "serial": "<string>"
          },
          "status": "PHYSICAL_STORAGE_STATUS_UNSPECIFIED",
          "smartStatus": "<string>"
        }
      ],
      "poolStatusMsg": "<string>"
    }
  ],
  "zpoolMetrics": {
    "readErrors": 123,
    "writeErrors": 123,
    "checksumErrors": 123,
    "bytesRead": 123,
    "bytesWrite": 123
  },
  "cellularMetrics": [
    {
      "ifName": "<string>",
      "signalRSSI": 123,
      "signalRSRQ": 123,
      "signalRSRP": 123,
      "signalSNR": 123,
      "rxTotalPackets": 123,
      "rxDrops": 123,
      "rxTotalBytes": 123,
      "txTotalPackets": 123,
      "txDrops": 123,
      "txTotalBytes": 123
    }
  ],
  "ntpSources": {
    "source": [
      {
        "authenticated": true,
        "reachable": true,
        "reachability": 123,
        "state": "NTP_SOURCE_STATE_UNSPECIFIED",
        "mode": "NTP_SOURCE_MODE_UNSPECIFIED",
        "hostname": "<string>",
        "srcAddr": "<string>",
        "srcPort": 123,
        "dstAddr": "<string>",
        "dstPort": 123,
        "leap": 123,
        "stratum": 123,
        "precision": 123,
        "refId": "<string>",
        "refTime": "2023-11-07T05:31:56Z",
        "poll": 123,
        "flags": 123,
        "offset": 123,
        "delay": 123,
        "dispersion": 123,
        "jitter": 123,
        "rootDelay": 123,
        "rootDisp": 123
      }
    ]
  },
  "optionalCapabilities": {
    "hvTypeKubevirt": true,
    "etcdSnapshot": true
  },
  "clusterNodeStatus": {
    "age": 123,
    "internalIP": "<string>",
    "conditions": "<string>",
    "nodeType": "CLUSTER_NODE_TYPE_UNSPECIFIED"
  },
  "apiCapability": "API_CAPABILITY_UNSPECIFIED",
  "memoryReport": {
    "memoryControllers": [
      {
        "controllerName": "<string>",
        "ceCount": "<string>",
        "ueCount": "<string>",
        "ranks": [
          {
            "rankName": "<string>",
            "ceCount": "<string>",
            "ueCount": "<string>"
          }
        ]
      }
    ]
  },
  "hardwareInfo": {
    "disks": [
      {
        "diskName": "<string>",
        "wwn": "<string>",
        "serialNumber": "<string>",
        "model": "<string>",
        "collectorErrors": "<string>",
        "smartAttr": [
          {
            "id": 123,
            "value": "<string>",
            "worst": "<string>",
            "thresh": "<string>",
            "whenFailed": "<string>",
            "rawValue": "<string>",
            "type": "<string>",
            "attributeName": "<string>"
          }
        ]
      }
    ]
  },
  "memoryReportStatus": "ECC_MEMORY_REPORT_STATUS_NOT_APPLICABLE",
  "enrolledCerts": [
    {
      "certEnrollmentProfileName": "<string>",
      "subject": {
        "commonName": "<string>",
        "serialNumber": "<string>",
        "organization": [
          "<string>"
        ],
        "organizationalUnit": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "stateOrProvince": [
          "<string>"
        ],
        "locality": [
          "<string>"
        ]
      },
      "issuer": {
        "commonName": "<string>",
        "serialNumber": "<string>",
        "organization": [
          "<string>"
        ],
        "organizationalUnit": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "stateOrProvince": [
          "<string>"
        ],
        "locality": [
          "<string>"
        ]
      },
      "sanDns": [
        "<string>"
      ],
      "sanIp": [
        "<string>"
      ],
      "sanUri": [
        "<string>"
      ],
      "sanEmail": [
        "<string>"
      ],
      "issueTimestamp": "2023-11-07T05:31:56Z",
      "expirationTimestamp": "2023-11-07T05:31:56Z",
      "renewPeriodPercent": 123,
      "sha256Fingerprint": "<string>",
      "status": "ENROLLED_CERT_STATUS_UNSPECIFIED",
      "err": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      }
    }
  ],
  "pnacMetrics": [
    {
      "logicalLabel": "<string>",
      "eapolFramesRx": "<string>",
      "eapolFramesTx": "<string>",
      "eapolStartFramesTx": "<string>",
      "eapolLogoffFramesTx": "<string>",
      "eapolRespFramesTx": "<string>",
      "eapolReqIdFramesRx": "<string>",
      "eapolReqFramesRx": "<string>",
      "invalidEapolFramesRx": "<string>",
      "eapLengthErrorFramesRx": "<string>"
    }
  ],
  "remoteAccessDisabled": true
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Path Parameters

name

string

required

Response

A successful response.

name

string

adminState

enum<string>

default:ADMIN_STATE_UNSPECIFIED

ADMIN_STATE_CREATED: Entity Created in the controller
ADMIN_STATE_DELETED: Entity Deleted in the controller
ADMIN_STATE_ACTIVE: Entity Activated in the controller
ADMIN_STATE_INACTIVE: Entity Deactivated in the controller
ADMIN_STATE_REGISTERED: Specific to Edge-node - Edge-node Registered with the controller
ADMIN_STATE_ARCHIVED: Entity Archived in the controller
ADMIN_STATE_DELETION_PENDING: Entity was marked as Deleted but not yet deleted in the controller

Available options:

ADMIN_STATE_UNSPECIFIED,

ADMIN_STATE_CREATED,

ADMIN_STATE_DELETED,

ADMIN_STATE_ACTIVE,

ADMIN_STATE_INACTIVE,

ADMIN_STATE_REGISTERED,

ADMIN_STATE_ARCHIVED,

ADMIN_STATE_DELETION_PENDING

runState

enum<string>

default:RUN_STATE_UNSPECIFIED

RUN_STATE_ONLINE: Entity Online
RUN_STATE_HALTED: Entity Halted
RUN_STATE_INIT: Entity Initializing
RUN_STATE_REBOOTING: Entity Rebooting
RUN_STATE_OFFLINE: Entity Offline
RUN_STATE_UNKNOWN: Entity state Unknown
RUN_STATE_UNPROVISIONED: Entity Unprovisioned
RUN_STATE_PROVISIONED: Entity Provisioned
RUN_STATE_SUSPECT: Entity Suspect
RUN_STATE_DOWNLOADING: Edge-node downloading entity artifacts
RUN_STATE_RESTARTING: Entity Restarting
RUN_STATE_PURGING: Entity Purging
RUN_STATE_HALTING: Entity Halting
RUN_STATE_ERROR: Entity encountered an error
RUN_STATE_VERIFYING: Verification of downloaded Artifacts in Progress.
RUN_STATE_LOADING: Loading of Artifacts into local datastore in Progress.
RUN_STATE_CREATING_VOLUME: Volume creation from artifacts in Progress
RUN_STATE_BOOTING: Entity booting up
RUN_STATE_MAINTENANCE_MODE: Entity maintenance mode
RUN_STATE_START_DELAYED: Application start delayed as per configuration
RUN_STATE_BASEOS_UPDATING: Device BaseOs Update in Progress
RUN_STATE_PREPARING_POWEROFF: device preparing power off - shutting down all app instances
RUN_STATE_POWERING_OFF: device powering off from local profile server
RUN_STATE_PREPARED_POWEROFF: device prepared power off - all app instances are shut down

Available options:

RUN_STATE_UNSPECIFIED,

RUN_STATE_ONLINE,

RUN_STATE_HALTED,

RUN_STATE_INIT,

RUN_STATE_REBOOTING,

RUN_STATE_OFFLINE,

RUN_STATE_UNKNOWN,

RUN_STATE_UNPROVISIONED,

RUN_STATE_PROVISIONED,

RUN_STATE_SUSPECT,

RUN_STATE_DOWNLOADING,

RUN_STATE_RESTARTING,

RUN_STATE_PURGING,

RUN_STATE_HALTING,

RUN_STATE_ERROR,

RUN_STATE_VERIFYING,

RUN_STATE_LOADING,

RUN_STATE_CREATING_VOLUME,

RUN_STATE_BOOTING,

RUN_STATE_MAINTENANCE_MODE,

RUN_STATE_START_DELAYED,

RUN_STATE_BASEOS_UPDATING,

RUN_STATE_PREPARING_POWEROFF,

RUN_STATE_POWERING_OFF,

RUN_STATE_PREPARED_POWEROFF

upTime

string<date-time>

tags

deprecated = 6; · object

Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.

Show child attributes

lastUpdate

string<date-time>

bootTime

string<date-time>

netStatusList

NetworkStatus is used to store the Network Status · object[]

Show child attributes

dns

DNSInfo consists of DNS Configurations. · object

DNSInfo is used to store Domain Name Server configuration.

Show child attributes

ioStatusList

IoBundleStatus is used to store the status of the Input Output bundle · object[]

Show child attributes

storageList

object[]

Show child attributes

blobList

object[]

Show child attributes

netCounterList

NetworkCounter is used to store the Network Stats and Counters · object[]

Show child attributes

hostName

string

swInfo

object[]

Show child attributes

zcCounters

ZedcloudCounters is used to store the Zedcloud Stats and Counters · object[]

Show child attributes

rawStatus

string

Memory

Memory Summary · object

memory - OBSOLETE. Use memorySummary instead.

Show child attributes

Storage

Storage Summary · object

Storage Summary

Show child attributes

minfo

object

Show child attributes

dinfo

object

Show child attributes

Cpu

CPU Summary · object

CPU Summary

Show child attributes

lastRebootReason

string

lastRebootTime

string<date-time>

dataSecInfo

object[]

Show child attributes

devError

DeviceError is used to store the error details of the hardware. · object[]

Show child attributes

projectId

string

title

string

attestState

enum<string>

default:ATTEST_STATE_UNSPECIFIED

Available options:

ATTEST_STATE_UNSPECIFIED,

ATTEST_STATE_NONE,

ATTEST_STATE_FAIL,

ATTEST_STATE_PASS,

ATTEST_STATE_PASS_NO_PCR,

ATTEST_STATE_FAIL_NO_PCR

deviceRebootReason

enum<string>

default:DEVICE_BOOT_REASON_UNSPECIFIED

Available options:

DEVICE_BOOT_REASON_UNSPECIFIED,

DEVICE_BOOT_REASON_FIRST,

DEVICE_BOOT_REASON_REBOOT_CMD,

DEVICE_BOOT_REASON_UPDATE,

DEVICE_BOOT_REASON_FALLBACK,

DEVICE_BOOT_REASON_DISCONNECT,

DEVICE_BOOT_REASON_FATAL,

DEVICE_BOOT_REASON_OOM,

DEVICE_BOOT_REASON_WATCHDOG_HUNG,

DEVICE_BOOT_REASON_WATCHDOG_PID,

DEVICE_BOOT_REASON_KERNEL,

DEVICE_BOOT_REASON_POWER_FAIL,

DEVICE_BOOT_REASON_UNKNOWN,

DEVICE_BOOT_REASON_VAULT_FAILED,

DEVICE_BOOT_REASON_POWEROFF_CMD,

DEVICE_BOOT_REASON_PARSE_FAIL

clusterID

string

System defined universally unique clusterInstance ID, unique across the enterprise.

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

memorySummary

Device Memory Information message · object

Device memory Info

Show child attributes

capabilities

Information about hardware capabilities · object

Edge node virtualization capabilities.

Show child attributes

debugKnob

boolean

debugKnobExpiryTime

string<date-time>

physicalStorage

object[]

Show child attributes

zpoolMetrics

object

Last received counters for zpool metrics.

Show child attributes

cellularMetrics

CellularMetrics stores the Cellular Network Stats and Counters · object[]

Last received cellular metrics.

Show child attributes

ntpSources

object

List of peers describing to which NTP daemon (e.g. chronyd) is synchronized on EVE side

Show child attributes

optionalCapabilities

object

Optional capabilities of the device

Show child attributes

clusterNodeStatus

object

Cluster node status

Show child attributes

apiCapability

enum<string>

default:API_CAPABILITY_UNSPECIFIED

Capabilities indicates features in the EdgeDevConfig where there is no easy way to otherwise determine whether or not they are parsed and supported by EVE-OS A larger number indicates all lower numbers are also supported thus this works similar to a version field for the EdgeDevConfig support.

Available options:

API_CAPABILITY_UNSPECIFIED,

API_CAPABILITY_RETRY_UPDATE,

API_CAPABILITY_SHUTDOWN,

API_CAPABILITY_START_DELAY_IN_SECONDS,

API_CAPABILITY_EDGEVIEW,

API_CAPABILITY_VOLUME_SNAPSHOTS,

API_CAPABILITY_NETWORK_INSTANCE_ROUTING,

API_CAPABILITY_BOOT_MODE,

API_CAPABILITY_MTU,

API_CAPABILITY_ADAPTER_USER_LABELS,

API_CAPABILITY_ENFORCED_NET_INTERFACE_ORDER,

API_CAPABILITY_NTPS_FQDN,

API_CAPABILITY_WIN_LIC_PASSTHROUGH,

API_CAPABILITY_VOLUME_SNAPSHOTS_IMMEDIATE,

API_CAPABILITY_ENCRYPTED_PATCH_ENVELOPE,

API_CAPABILITY_SINGLE_STACK_IP_NETWORK,

API_CAPABILITY_CELLULAR_ATTACH_CONFIG,

API_CAPABILITY_EDGEVIEW_AUTHENTICATION,

API_CAPABILITY_DISABLE_VTPM,

API_CAPABILITY_LOC_REBOOT_COLLECT_INFO,

API_CAPABILITY_SMART_REPORT,

API_CAPABILITY_REPORT_TPM_EVENTLOG

memoryReport

A report for all memory controllers · object

Show child attributes

hardwareInfo

Information about the system that is sent once when the system boots · object

Show child attributes

memoryReportStatus

enum<string>

default:ECC_MEMORY_REPORT_STATUS_NOT_APPLICABLE

Available options:

ECC_MEMORY_REPORT_STATUS_NOT_APPLICABLE,

ECC_MEMORY_REPORT_STATUS_PASS,

ECC_MEMORY_REPORT_STATUS_DEGRADED,

ECC_MEMORY_REPORT_STATUS_FAILED

enrolledCerts

Certificates enrolled via SCEP · object[]

Certificates enrolled via SCEP on the device

Show child attributes

pnacMetrics

PNAC (802.1X) authentication metrics per port · object[]

PNAC 802.1X authentication metrics per network port

Show child attributes

remoteAccessDisabled

boolean

⌘I

Get edge node info

curl --request GET \
  --url https://{apiHost}/api/v1/devices/name/{name}/status/info \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/devices/name/{name}/status/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "id": "<string>",
  "adminState": "ADMIN_STATE_UNSPECIFIED",
  "runState": "RUN_STATE_UNSPECIFIED",
  "upTime": "2023-11-07T05:31:56Z",
  "tags": {},
  "lastUpdate": "2023-11-07T05:31:56Z",
  "bootTime": "2023-11-07T05:31:56Z",
  "netStatusList": [
    {
      "up": true,
      "macAddr": "<string>",
      "ifName": "<string>",
      "ipAddrs": [
        "<string>"
      ],
      "defaultRouters": [
        "<string>"
      ],
      "dns": {
        "servers": [
          "<string>"
        ],
        "domain": "<string>",
        "search": [
          "<string>"
        ]
      },
      "location": {
        "underlayIP": "<string>",
        "hostname": "<string>",
        "city": "<string>",
        "region": "<string>",
        "country": "<string>",
        "loc": "<string>",
        "org": "<string>",
        "postal": "<string>",
        "latlong": "<string>",
        "freeloc": "<string>"
      },
      "uplink": true,
      "proxy": {
        "networkProxy": true,
        "proxies": [
          {
            "proto": "NETWORK_PROXY_PROTO_HTTP",
            "server": "<string>",
            "port": 123
          }
        ],
        "exceptions": "<string>",
        "pacfile": "<string>",
        "networkProxyURL": "<string>",
        "wpadProxyURL": "<string>"
      },
      "errInfo": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "gpsLocation": {
        "latitude": 123,
        "longitude": 123,
        "altitude": 123,
        "timestamp": {},
        "horizontalReliability": 123,
        "verticalReliability": 123,
        "horizontalUncertainty": 123,
        "verticalUncertainty": 123,
        "logicalLabel": "<string>"
      },
      "cellular": {
        "providers": [
          {
            "plmn": "<string>",
            "name": "<string>",
            "rat": "RADIO_ACCESS_TECHNOLOGY_UNSPECIFIED",
            "roaming": true,
            "connectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "modem": {
          "manufacturer": "<string>",
          "model": "<string>",
          "firmwareVersion": "<string>",
          "imei": "<string>",
          "operatingState": "Z_CELLULAR_OPERATING_STATE_UNSPECIFIED",
          "controlProtocol": "Z_CELLULAR_CONTROL_PROTOCOL_UNSPECIFIED"
        },
        "simCards": [
          {
            "slotNumber": 123,
            "slotActivated": true,
            "iccid": "<string>",
            "imsi": "<string>",
            "state": "<string>"
          }
        ]
      },
      "mtu": 123,
      "pnacStatus": {
        "enabled": true,
        "supplicantState": "PNAC_SUPPLICANT_STATE_UNSPECIFIED",
        "lastAuthTimestamp": "2023-11-07T05:31:56Z",
        "err": {
          "description": "<string>",
          "severity": "SEVERITY_UNSPECIFIED",
          "timestamp": {},
          "entities": [
            {
              "entity": "ENTITY_UNSPECIFIED",
              "entityId": "<string>",
              "entityName": "<string>"
            }
          ],
          "retryCondition": "<string>"
        }
      },
      "configSource": {
        "origin": "NETWORK_CONFIG_ORIGIN_UNSPECIFIED",
        "submittedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "dns": {
    "servers": [
      "<string>"
    ],
    "domain": "<string>",
    "search": [
      "<string>"
    ]
  },
  "ioStatusList": [
    {
      "type": "IO_TYPE_UNSPECIFIED",
      "name": "<string>",
      "members": [
        "<string>"
      ],
      "appName": "<string>",
      "lteInfo": {
        "simName": "<string>",
        "cellModuleName": "<string>",
        "imsi": "<string>",
        "iccid": "<string>",
        "simcardState": "SIMCARD_STATE_INVALID",
        "imei": "<string>",
        "firmwareVersion": "<string>"
      },
      "err": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "memberList": [
        {
          "name": "<string>",
          "ioAddress": {
            "macAddress": "<string>"
          }
        }
      ]
    }
  ],
  "storageList": [
    {
      "name": "<string>",
      "mountPath": "<string>",
      "sizeMB": "<string>",
      "partitionLabel": "<string>",
      "partitionTypeGuid": "<string>",
      "partitionUuid": "<string>"
    }
  ],
  "blobList": [
    {
      "hash": "<string>",
      "refCount": "<string>",
      "swState": "SW_STATE_UNSPECIFIED",
      "sizeMB": "<string>"
    }
  ],
  "netCounterList": [
    {
      "ifName": "<string>",
      "txBytes": 123,
      "rxBytes": 123,
      "txPkts": 123,
      "rxPkts": 123,
      "txErrors": 123,
      "rxErrors": 123,
      "txDrops": 123,
      "rxDrops": 123,
      "txAclDrops": 123,
      "rxAclDrops": 123,
      "txAclRateLimitDrops": 123,
      "rxAclRateLimitDrops": 123
    }
  ],
  "hostName": "<string>",
  "swInfo": [
    {
      "activated": true,
      "partitionLabel": "<string>",
      "partitionDevice": "<string>",
      "partitionState": "<string>",
      "status": "SW_STATE_UNSPECIFIED",
      "shortVersion": "<string>",
      "longVersion": "<string>",
      "swError": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "downloadProgress": 123,
      "swStatus": "DEVICE_SW_STATUS_UNSPECIFIED",
      "swSubStatus": "DEVICE_SW_SUB_STATUS_UNSPECIFIED",
      "swSubStatusStr": "<string>",
      "subStatusProgress": 123,
      "isLTS": true
    }
  ],
  "zcCounters": [
    {
      "ifName": "<string>",
      "failures": 123,
      "success": 123,
      "lastFailure": {},
      "lastSuccess": {}
    }
  ],
  "rawStatus": "<string>",
  "Memory": {
    "TotalMB": 123,
    "UsedMB": 123,
    "AllocatedMB": 123
  },
  "Storage": {
    "TotalMB": 123,
    "UsedMB": 123,
    "AllocatedMB": 123,
    "sharedStorageSummary": [
      {
        "Id": "<string>",
        "Name": "<string>",
        "AllocatedMB": 123,
        "UsedMB": 123
      }
    ],
    "Id": "<string>",
    "Name": "<string>"
  },
  "minfo": {
    "manufacturer": "<string>",
    "productName": "<string>",
    "version": "<string>",
    "serialNumber": "<string>",
    "uuid": "<string>",
    "compatible": "<string>",
    "biosVendor": "<string>",
    "biosVersion": "<string>",
    "biosReleaseDate": "<string>",
    "hSMStatus": "DEVICE_HW_SECURITY_MODULE_STATUS_UNSPECIFIED",
    "hSMInfo": "<string>",
    "endorsementKey": "<string>"
  },
  "dinfo": {
    "machineArch": "<string>",
    "cpuArch": "<string>",
    "platform": "<string>",
    "nCpu": 123,
    "memMB": "<string>",
    "storageMB": "<string>"
  },
  "Cpu": {
    "Utilization": 123
  },
  "lastRebootReason": "<string>",
  "lastRebootTime": "2023-11-07T05:31:56Z",
  "dataSecInfo": [
    {
      "status": "DEVICE_DATA_SECURITY_AT_REST_UNKNOWN",
      "name": "<string>",
      "errInfo": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      }
    }
  ],
  "devError": [
    {
      "description": "<string>",
      "severity": "SEVERITY_UNSPECIFIED",
      "timestamp": {},
      "entities": [
        {
          "entity": "ENTITY_UNSPECIFIED",
          "entityId": "<string>",
          "entityName": "<string>"
        }
      ],
      "retryCondition": "<string>"
    }
  ],
  "projectId": "<string>",
  "title": "<string>",
  "attestState": "ATTEST_STATE_UNSPECIFIED",
  "deviceRebootReason": "DEVICE_BOOT_REASON_UNSPECIFIED",
  "clusterID": "<string>",
  "memorySummary": {
    "deviceMemoryMB": 123,
    "allocatedAppsMB": 123,
    "allocatedEveMB": 123,
    "usedEveMB": 123,
    "availableForNewApps": 123
  },
  "capabilities": {
    "HWAssistedVirtualization": true,
    "IOVirtualization": true
  },
  "debugKnob": true,
  "debugKnobExpiryTime": "2023-11-07T05:31:56Z",
  "physicalStorage": [
    {
      "poolName": "<string>",
      "storageType": "PHYSICAL_STORAGE_TYPE_INFO_UNSPECIFIED",
      "storageState": "PHYSICAL_STORAGE_STATUS_UNSPECIFIED",
      "zfsVersion": "<string>",
      "countZvols": 123,
      "currentRaid": "PHYSICAL_STORAGE_RAID_TYPE_UNSPECIFIED",
      "compressionRatio": 123,
      "zpoolSize": "<string>",
      "disks": [
        {
          "disk": {
            "name": "<string>",
            "logicalName": "<string>",
            "serial": "<string>"
          },
          "status": "PHYSICAL_STORAGE_STATUS_UNSPECIFIED",
          "smartStatus": "<string>"
        }
      ],
      "poolStatusMsg": "<string>"
    }
  ],
  "zpoolMetrics": {
    "readErrors": 123,
    "writeErrors": 123,
    "checksumErrors": 123,
    "bytesRead": 123,
    "bytesWrite": 123
  },
  "cellularMetrics": [
    {
      "ifName": "<string>",
      "signalRSSI": 123,
      "signalRSRQ": 123,
      "signalRSRP": 123,
      "signalSNR": 123,
      "rxTotalPackets": 123,
      "rxDrops": 123,
      "rxTotalBytes": 123,
      "txTotalPackets": 123,
      "txDrops": 123,
      "txTotalBytes": 123
    }
  ],
  "ntpSources": {
    "source": [
      {
        "authenticated": true,
        "reachable": true,
        "reachability": 123,
        "state": "NTP_SOURCE_STATE_UNSPECIFIED",
        "mode": "NTP_SOURCE_MODE_UNSPECIFIED",
        "hostname": "<string>",
        "srcAddr": "<string>",
        "srcPort": 123,
        "dstAddr": "<string>",
        "dstPort": 123,
        "leap": 123,
        "stratum": 123,
        "precision": 123,
        "refId": "<string>",
        "refTime": "2023-11-07T05:31:56Z",
        "poll": 123,
        "flags": 123,
        "offset": 123,
        "delay": 123,
        "dispersion": 123,
        "jitter": 123,
        "rootDelay": 123,
        "rootDisp": 123
      }
    ]
  },
  "optionalCapabilities": {
    "hvTypeKubevirt": true,
    "etcdSnapshot": true
  },
  "clusterNodeStatus": {
    "age": 123,
    "internalIP": "<string>",
    "conditions": "<string>",
    "nodeType": "CLUSTER_NODE_TYPE_UNSPECIFIED"
  },
  "apiCapability": "API_CAPABILITY_UNSPECIFIED",
  "memoryReport": {
    "memoryControllers": [
      {
        "controllerName": "<string>",
        "ceCount": "<string>",
        "ueCount": "<string>",
        "ranks": [
          {
            "rankName": "<string>",
            "ceCount": "<string>",
            "ueCount": "<string>"
          }
        ]
      }
    ]
  },
  "hardwareInfo": {
    "disks": [
      {
        "diskName": "<string>",
        "wwn": "<string>",
        "serialNumber": "<string>",
        "model": "<string>",
        "collectorErrors": "<string>",
        "smartAttr": [
          {
            "id": 123,
            "value": "<string>",
            "worst": "<string>",
            "thresh": "<string>",
            "whenFailed": "<string>",
            "rawValue": "<string>",
            "type": "<string>",
            "attributeName": "<string>"
          }
        ]
      }
    ]
  },
  "memoryReportStatus": "ECC_MEMORY_REPORT_STATUS_NOT_APPLICABLE",
  "enrolledCerts": [
    {
      "certEnrollmentProfileName": "<string>",
      "subject": {
        "commonName": "<string>",
        "serialNumber": "<string>",
        "organization": [
          "<string>"
        ],
        "organizationalUnit": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "stateOrProvince": [
          "<string>"
        ],
        "locality": [
          "<string>"
        ]
      },
      "issuer": {
        "commonName": "<string>",
        "serialNumber": "<string>",
        "organization": [
          "<string>"
        ],
        "organizationalUnit": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "stateOrProvince": [
          "<string>"
        ],
        "locality": [
          "<string>"
        ]
      },
      "sanDns": [
        "<string>"
      ],
      "sanIp": [
        "<string>"
      ],
      "sanUri": [
        "<string>"
      ],
      "sanEmail": [
        "<string>"
      ],
      "issueTimestamp": "2023-11-07T05:31:56Z",
      "expirationTimestamp": "2023-11-07T05:31:56Z",
      "renewPeriodPercent": 123,
      "sha256Fingerprint": "<string>",
      "status": "ENROLLED_CERT_STATUS_UNSPECIFIED",
      "err": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      }
    }
  ],
  "pnacMetrics": [
    {
      "logicalLabel": "<string>",
      "eapolFramesRx": "<string>",
      "eapolFramesTx": "<string>",
      "eapolStartFramesTx": "<string>",
      "eapolLogoffFramesTx": "<string>",
      "eapolRespFramesTx": "<string>",
      "eapolReqIdFramesRx": "<string>",
      "eapolReqFramesRx": "<string>",
      "invalidEapolFramesRx": "<string>",
      "eapLengthErrorFramesRx": "<string>"
    }
  ],
  "remoteAccessDisabled": true
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Get edge node info (GET /v1/devices/name/{name}/status/info)

Authorizations

Headers

Path Parameters

Response