Post

/clusters/wipe/

This endpoint stops the cluster s/w on all nodes.

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 .

Body parameters

Expand All

object

cnode_list

Array of object (CNode)

The list of C-Nodes

object

id

integer

CNode ID

guid

string

Global unique ID

name

string Required

title

string

new_name

string

Name

ip

string

The IP of the bond interface of ip1 and ip2.

ip1

string

1st of two IP addresses on the cluster's internal network

ip2

string

2nd of two IP addresses on the cluster's internal network

ipv6

string

External IPv6 Address

ipmi_ip

string

IP of IPMI

host_label

string

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

sn

string

The host serial number

state

string

State, e.g. active

display_state

string

State

led_status

string

LED status

platform_rdma_port

integer

port for internal use

platform_tcp_port

integer

port for internal use

position

string

position of CNode in CBox

data_rdma_port

integer

port for internal use

data_tcp_port

integer

port for internal use

enabled

boolean

True if the CNode is enabled

is_mgmt

boolean

True if the CNode is currently hosting VMS

cbox

string

Parent CBox

cbox_id

integer

Parent CBox ID

cluster

string

Parent Cluster

cluster_id

integer

Parent Cluster ID

os_version

string

VAST OS version

bios_version

string

BIOS version

bmc_fw_version

string

BMC FW version

bmc_state

string

BMC State

bmc_state_reason

string

BMC state reason

box_vendor

string

Parent box model description including hardware vendor

vms_preferred

boolean

VMS preferred CNode

vlan

string

VLAN ID

url

string

cores

integer

Number of CNode cores

build

string

mgmt_ip

string

IP address for management access

hostname

string

Host Name

host_opensm_master

string

If OpenSM master

opensm_state

boolean

opensm service state

sync

string

Synchronization state with leader

sync_time

string

Synchronization time with leader

turbo_boost

boolean

cpld

string

display_name

string

tpm_boot_dev_encryption_status

string

Boot encryption status

rpm

string

VAST Utils Version

dnode_list

Array of object (DNode)

The list of DNodes

object

id

integer

guid

string

name

string Required

title

string

new_name

string

ip

string

The IP of the bond interface of ip1 and ip2.

ip1

string

1st of two IP addresses on the cluster's internal network

ip2

string

2nd of two IP addresses on the cluster's internal network

ipmi_ip

string

IPMI IP

ipv6

string

External IPv6 Address

host_label

string

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

sn

string

The host serial number

state

string

led_status

string

enabled

boolean

True if Dnode is enabled

platform_rdma_port

integer

port for internal use

platform_tcp_port

integer

port for internal use

display_name

string

data_rdma_port

integer

port for internal use

data_tcp_port

integer

port for internal use

box_rdma_port

integer

port for internal use

dbox

string

Parent DBox

dbox_id

integer

ebox

string

Parent EBox

ebox_id

integer

dtray

string

Parent DTray

cluster

string

Parent Cluster

cluster_id

integer

os_version

string

Node OS version

bmc_fw_version

string

BMC FW version

url

string

build

string

bmc_state

string

bmc_state_reason

string

mgmt_ip

string

IP address for management access

hostname

string

Host Name

sync

string

Synchronization state with leader

sync_time

string

Synchronization time with leader

is_primary

boolean

Indicates if node is the primary, aka master, dnode.

position

string

cpld

string

arch_type

string

bios_version

string

rpm

string

VAST Utils Version

loopback

boolean

Loopback (single node) installation

loopback_ip

string

Loopback IP

loopback_user

string

Loopback User

Responses

200

Cluster wipe async response

Expand All

object

async_task

object

Creation Async task properties

Stop Cluster s/w on All Nodes