Health

GET

/api/operate/namespaces/system/sites/{site}/vpm/debug/global/health

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/system/sites/example/vpm/debug/global/health';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/system/sites/example/vpm/debug/global/health \
  --header 'Authorization: <Authorization>'

GET VPM health information.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

site

required

string

Site Name Name of the site.

Query Parameters

console_user

string

Name of the console user who runs this command.

Responses

200

A successful response.

application/json

Health Response

Health response info from site.

object

fqdn

Node FQND

Node FQDN used during registration.

string

<= 1024 characters

hostname

Hostname

Hostname of the node.

string

<= 1024 characters

initial_password_changed

Factory Password Changed

If the factory password changed on host.

boolean format: boolean

lte_support

LTE Support

If the box has LTE support.

boolean format: boolean

os_info

object

bios

object

date

date

Information from /sys/class/dmi/ID/bios_date.

string

<= 1024 characters

vendor

vendor

Information from /sys/class/dmi/ID/bios_vendor.

string

<= 1024 characters

version

version

Information from /sys/class/dmi/ID/bios_version.

string

>= 1 characters <= 1024 characters

board

object

asset_tag

asset_tag

Information from /sys/class/dmi/ID/board_asset_tag.

string

<= 1024 characters

name

name

Information from /sys/class/dmi/ID/board_name.

string

>= 6 characters <= 1024 characters

serial

serial

Information from /sys/class/dmi/ID/board_serial.

string

<= 1024 characters

vendor

vendor

Information from /sys/class/dmi/ID/board_vendor.

string

<= 1024 characters

version

version

Information from /sys/class/dmi/ID/board_version.

string

>= 1 characters <= 1024 characters

chassis

object

asset_tag

asset_tag

Information from /sys/class/dmi/ID/chassis_asset_tag.

string

<= 1024 characters

serial

serial

Information from /sys/class/dmi/ID/chassis_serial.

string

<= 1024 characters

type

type

Information from /sys/class/dmi/ID/chassis_type.

integer format: int64

vendor

vendor

Information from /sys/class/dmi/ID/chassis_vendor.

string

<= 1024 characters

version

version

Information from /sys/class/dmi/ID/chassis_version.

string

>= 1 characters <= 1024 characters

cpu

object

cache

cache

CPU cache size in KB.

integer format: int64

cores

cores

Number of physical CPU cores.

integer format: int64

cpus

cpus

Number of physical CPUs.

integer format: int64

model

model

CPU model

string

<= 1024 characters

speed

speed

CPU clock rate in MHz.

integer format: int64

threads

threads

Number of logical (HT) CPU cores.

integer format: int64

vendor

vendor

CPU vendor.

string

<= 1024 characters

gpu

object

cuda_version

cudaVersion

GPU Cuda Version.

string

<= 1024 characters

driver_version

driverVersion

GPU Driver Version.

string

<= 1024 characters

gpu_device

GPUDevice

List of GPU devices in server.

Array<object>

GPUDevice

object

GPU ID

string

>= 1 <= 4094 <= 1024 characters

processes

processes

GPU Processes.

string

<= 1024 characters

product_name

productName

GPU Product Name.

string

<= 1024 characters

kernel

object

architecture

architecture

Kernel architecture.

string

<= 1024 characters

release

release

Kernel release.

string

<= 1024 characters

version

version

Kernel version.

string

>= 1 characters <= 1024 characters

memory

object

size_mb

size_mb

RAM size in MB.

integer format: int64

speed

speed

RAM data rate in MT/s.

integer format: int64

type

type

Type of memory, eg. DDR4.

string

<= 1024 characters

network

network

List of network devices in server.

Array<object>

Network Device Information

NetworkDevice information.

object

driver

driver

Driver of device, eg. E1000e.

string

<= 1024 characters

ip_address

ip_address

IP address on interface.

Array<string>

link_quality

string

default: QUALITY_UNKNOWN

Allowed values: QUALITY_UNKNOWN QUALITY_GOOD QUALITY_POOR QUALITY_DISABLED

link_type

string

default: LINK_TYPE_UNKNOWN

Allowed values: LINK_TYPE_UNKNOWN LINK_TYPE_ETHERNET LINK_TYPE_WIFI_802_11AC LINK_TYPE_WIFI_802_11BGN LINK_TYPE_4G LINK_TYPE_WIFI LINK_TYPE_WAN

mac_address

mac_address

MAC address on interface.

string

<= 1024 characters

name

name

Name of device, eg. Eth0.

string

>= 6 characters <= 1024 characters

port

port

Used port, eg. Tp.

string

>= 1 <= 65535 <= 1024 characters

speed

speed

Device max supported speed in Mbps.

integer format: int64

numa_nodes

NUMA Nodes Count

Non-uniform memory access (NUMA) nodes count.

integer format: int32

object

architecture

architecture

Architecture of OS.

string

<= 1024 characters

name

name

Name of OS.

string

>= 6 characters <= 1024 characters

release

release

Release of the OS.

string

<= 1024 characters

vendor

vendor

Vendor of OS.

string

<= 1024 characters

version

version

Version of OS.

string

>= 1 characters <= 1024 characters

product

object

name

name

Product name, eg. For AWS m5a.xlarge. Info taken from /sys/class/dmi/ID/product_name.

string

>= 6 characters <= 1024 characters

serial

serial

Serial number, eg. For AWS ec254b6d-9676-1a51-8b10-21370dbdc3e5. Info taken from /sys/class/dmi/ID/product_serial.

string

<= 1024 characters

vendor

vendor

Vendor name, eg. For AWS Amazon EC2. Info taken from /sys/class/dmi/ID/product_vendor.

string

<= 1024 characters

version

version

Version name. Info taken from /sys/class/dmi/ID/product_version.

string

>= 1 characters <= 1024 characters

storage

storage

List of storage devices in server.

Array<object>

Storage Information

StorageDevice information.

object

driver

driver

Driver of device.

string

<= 1024 characters

model

model

Model of device.

string

<= 1024 characters

name

name

Name of device, eg. Nvme0n1.

string

>= 6 characters <= 1024 characters

serial

serial

Serial of device.

string

<= 1024 characters

size_gb

size_gb

Device size in GB.

integer format: int64

vendor

vendor

Vendor of device.

string

<= 1024 characters

usb

USBDevice

List of USB devices in server.

Array<object>

USB device

Information about USB device.

object

address

address

Address of the device on the bus in decimal.

integer format: int64

b_device_class

b_device_class

The class of this device.

string

<= 1024 characters

b_device_protocol

b_device_protocol

The protocol (within the sub-class) of this device.

string

<= 1024 characters

b_device_sub_class

b_device_sub_class

The sub-class (within the class) of this device.

string

<= 1024 characters

b_max_packet_size

b_max_packet_size

Maximum size of the control transfer.

integer format: int64

bcd_device

bcd_device

The device version.

string

<= 1024 characters

bcd_usb

bcd_usb

USB Specification Release Number.

string

<= 1024 characters

bus

bus

The bus on which the device was detected in decimal.

integer format: int64

description

description

Device description.

string

>= 21 characters <= 1024 characters

i_manufacturer

i_manufacturer

Manufacturer name.

string

<= 1024 characters

i_product

i_product

Product name reported by device.

string

<= 1024 characters

i_serial

i_serial_number

Index of Serial Number String Descriptor.

string

<= 1024 characters

id_product

id_product

Product ID (Assigned by Manufacturer) in hex.

string

<= 1024 characters

id_vendor

id_vendor

Vendor ID (Assigned by USB Org) in hex.

string

<= 1024 characters

port

port

Port on which the device was detected in decimal.

integer format: int64

>= 1 <= 65535

product_name

product_name

Product ID translated to name (if available)

string

<= 1024 characters

speed

speed

The negotiated operating speed for the device.

string

<= 1024 characters

usb_type

string

default: UNKNOWN_USB

Allowed values: UNKNOWN_USB INTERNAL REGISTERED CONFIGURABLE

vendor_name

vendor_name

Vendor ID translated to name (if available)

string

<= 1024 characters

os_version

OS Version

OS version on host.

string

<= 1024 characters

public_ip

Public IP

Public IP gives vhost0 or other primary IP.

string

<= 1024 characters

roles

Roles

If node is worker node.

Array<string>

software_version

Software Version

F5 Distributed Cloud software version.

string

<= 1024 characters

state

string

default: WAITING_FOR_CONFIG

Allowed values: WAITING_FOR_CONFIG WAITING_FOR_APPROVAL PROVISIONING PROVISIONED FAILED RESETTING

version

VPM Version

VPM version running on host.

string

>= 1 characters <= 1024 characters

wifi_support

WIFI Support

If the box has WIFI support.

boolean format: boolean

vesop_ssh_enabled

F5 SSH Access Enabled

Indicates whether F5 (vesop) SSH access is currently enabled on the site.

boolean format: boolean

vesop_ssh_remaining_time

F5 SSH Expiry Time

Displays the remaining time until F5 (vesop) SSH access is enabled. Empty if SSH is disabled or permanently enabled.

string

<= 1024 characters

Example

{
  "os_info": {
    "network": [
      {
        "link_quality": "QUALITY_UNKNOWN",
        "link_type": "LINK_TYPE_UNKNOWN"
      }
    ],
    "usb": [
      {
        "usb_type": "UNKNOWN_USB"
      }
    ]
  },
  "state": "WAITING_FOR_CONFIG"
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

Health

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated