Get

/hosts/{id}/

This endpoint returns details of a host.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Responses

200

Expand All

object

id

integer

The ID of a host

cluster_id

integer

Cluster ID

install

boolean

True if selected for installation. False if excluded.

led_status

string

Status of host LED

name

string

Name of host

sn

string

Serial number

sw_defined

boolean

True if host is software defined model

system_name

string

Cluster GUID

title

string

Descriptive string including node type, IP address and node name.

guid

string

Globally unique identifier

vast_install_info

object (VastInstallInfo)

box_vendor

string

Model description, including vendor

vast_os

string

VAST OS version running on the host

node_type

string

Type of Node (CNode or DNode)

hostname

string

Hostname

ip

string

Management IP

position

string

Position of node in chassis

box_name

string

Name of parent CBox/DBox

box_uid

string

UID of the parent CBox/DBox

is_ceres

boolean

Whether the host is part of a CERES DBox

is_vms_host

boolean

Whether the host is the VMS CNode

is_ceres_v2

boolean

Whether the host is part of a CERES V2 DBox

ip

string

The IP of the host's bond interface on the internal data network

ip1

string

The host's 1st internal IP address

ip2

string

Ths host's 2nd internal IP address

ipv6

string

External IPv6 Address

host_label

string

Host label, used to label container, e.g. 11.0.0.1-4000

auto

boolean

auto or manually host (internal property)

hostname

string

Hostname

node_type

string

Node type: C-Node/D-Node

dbox_uid

string

Unique h/w identifier

loopback

boolean

True if loopback (single node) installation

perf_check

boolean

Internal property related to checking cluster performance

dmsetup

boolean

Mock NVMeoF devices with dmsetup devices

enable_dr

boolean

True if data reduction is enabled

half_system

boolean

Is half system

deep_stripe

boolean

Is deep stripe system

dr_hash_size

integer

DR hash size in buckets

nvram_size

integer

NVRAM size for mocked devices

drive_size

integer

Drive size for mocked devices

ssh_user

string

SSH User name

state

string

Node state

platform_rdma_port

integer

port for internal use

hw_info

object

General hardware info related to the host

platform_tcp_port

integer

port for internal use

data_rdma_port

integer

port for internal use

data_tcp_port

integer

port for internal use

box_rdma_port

integer

port for internal use

install_state

string

Node installation state

sw_version

string

The platform software version running on the node

os_version

string

The VAST OS version running on the node

build

string

Node build

cluster

string

The name of the cluster to which the host belongs

url

string

Endpoint URL for API operations

upgrade_state

string

Host upgrade state

node_guid

string

Hosts sibling node guid

single_nic

boolean

Host has single NIC

net_type

string

network type

Valid values[ "eth", "ib", "int_eth_ext_ib", "int_ib_ext_eth" ]

Return Details of a Host