Get

/clusters/{id}/

This endpoint returns details of the cluster.

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

Cluster ID

Responses

200

Expand All

object

id

integer

Cluster ID

available_upgrade_version

object

Details of an upgrade package that has been uploaded and is available. Empty if there is no upgrade package uploaded.

build

string

sys_version

string

os_version

string

ssd_version

string

nvram_version

string

vms_bmc_fw_version

string

turbo_boost_flag

boolean

if enabled VMS will enable turbo boost during upgrade

s3_new_version

object

Details of a new upgrade package made available by Support at an S3 URL. Empty if there is no such upgrade package available.

guid

string

globally unique identifier

ip

string

IP of the cluster's Leader CNode

mgmt_vip

string

Management virtual IP. A single virtual IP configured on the management interfaces on all CNodes. VAST Management System (VMS) listens on this IP. It is used to access the VMS interfaces.

mgmt_cnode

string

Management CNode

mgmt_inner_vip

string

VMS inner vip. A virtual IP on the internal network used for mounting the VMS database.

mgmt_inner_vip_cnode

string

CNode hosting the VMS inner VIP

name

string

Name

psnt

string

The cluster's PSNT. A PSNT is an asset identifier that links the components of a cluster.

state

string

Cluster state. UNKNOWN state is displayed in the VMS GUI as disconnected.

Valid values[ "INIT", "ACTIVATING", "ONLINE", "OFFLINE", "FAILED", "UNKNOWN" ]

leader_state

string

Cluster Leader state

Valid values[ "UP", "DOWN", "UNKNOWN" ]

ssd_raid_rebuild_progress

integer

Percentage progress of SSD RAID rebuild, if in progress

nvram_raid_rebuild_progress

integer

Percentage progress of NVRAM RAID rebuild, if in progress

nvram_raid_rebuild_progress_fraction

string

Progress of SSD RAID rebuild expressed as a fraction, if in progress

rio_raid_rebuild_progress

integer

rio_raid_rebuild_progress_fraction

string

memory_raid_rebuild_progress

integer

raid_rebuild_progress

string

quotas_allocated_capacity

integer

quotas_used_capacity

integer

quotas_used_percent

number (float)

raid_drives_can_fail

integer

ssd_raid_state

string

nvram_raid_state

string

rio_nvram_state

string

nvram_size

integer

memory_raid_state

string

remaining_stripes_health

string

Valid values[ "HEALTHY", "LOW_RESOURCES", "EMPTY", "UNKNOWN" ]

replication_bw_mb

number (float)

replication_iops

number (float)

replication_latency_ms

number (float)

replication_rd_bw_mb

number (float)

replication_rd_iops

integer

replication_rd_latency_ms

number (float)

replication_wr_bw_mb

number (float)

replication_wr_iops

integer

replication_wr_latency_ms

number (float)

md_usage_health

string

Valid values[ "HEALTHY", "LOW_RESOURCES", "EMPTY", "UNKNOWN" ]

build

string

Cluster build

system_name

string

Internal guid string used by cluster s/w

physical_space

integer (int64)

The total physical capacity of the cluster with an 8% reduction for reserve overhead

physical_space_in_use

integer (int64)

Physical Space In Use

physical_space_wo_overhead

integer (int64)

The total physical capacity of the cluster.

usable_capacity_bytes

integer (int64)

The usable capacity of the cluster, in bytes. This is always smaller than the physical capacity due to an overhead introduced by data protection. VAST Cluster protects data with RAID stripes. The data protection overhead varies by size of stripe which in turn varies based upon the number of storage enclosures (DBoxes) in a cluster.

free_usable_capacity

integer (int64)

The amount of usable capacity that is not in use, in bytes.

usable_auxiliary_space_in_use

number (float)

This is usable data that has been deleted logically and may be held by snapshots. Data is either reflected as auxiliary data because it was deleted recently and its deletion is still being processed, or it is reflected as auxiliary data because it is held by snapshots. Prior to deletion, data is reflected as used. After the data is deleted, if one or more snapshots that include that data still remain, the data is held by snapshot(s). It is no longer reflected as used and is now reflected as auxiliary.

usable_capacity_tb

number (float)

The usable capacity of the cluster, in TB. This is always smaller than the physical capacity due to an overhead introduced by data protection. VAST Cluster protects data with RAID stripes. The data protection overhead varies by size of stripe which in turn varies based upon the number of storage enclosures (DBoxes) in a cluster.

free_usable_capacity_tb

number (float)

The amount of usable capacity that is not in use, in bytes, in TB.

physical_space_in_use_wo_overhead

integer (int64)

Usable Space In Use

logical_space

integer (int64)

The total estimated logical capacity, which is the amount of data estimated that can be written to the cluster.

logical_space_in_use

integer (int64)

The amount of logical data written to the cluster by data clients. This value doesn't include snapshots.

free_logical_space

number (float)

Free Logical Space

free_logical_space_tb

number (float)

The estimated effective free capacity remaining for writing data to the cluster, computed dynamically based upon the observed DRR and overhead impact.

free_physical_space

number (float)

Free Physical Space

free_physical_space_tb

number (float)

Free Physical Space

physical_space_tb

number (float)

Total Physical Space

free_physical_space_wo_overhead

number (float)

Free Usable Space

free_physical_space_wo_overhead_tb

number (float)

Free Usable Space, in TB

auxiliary_space_in_use

number (float)

Physical Snapshot Space In Use

auxiliary_space_in_use_tb

number (float)

Physical Snapshot Space In Use (TB)

logical_auxiliary_space_in_use

number (float)

The amount of logical data written to the cluster that was deleted and is being held as auxiliary data, either by snapshots or as deletion in process, in bytes

logical_auxiliary_space_in_use_tb

number (float)

The amount of logical data written to the cluster that was deleted and is being held as auxiliary data, either by snapshots or as deletion in process, in TB

estore_capacity_in_use_bytes

number (float)

Logical Space In Use

estore_capacity_in_use_tb

number (float)

Logical Space In Use (TB)

physical_space_in_use_tb

number (float)

Physical Space In Use

logical_space_tb

number (float)

Total Estimated Logical Space

logical_space_in_use_tb

number (float)

Logical Space In Use

physical_space_in_use_percent

number (float)

Physical space in use percentage

logical_space_in_use_percent

number (float)

Logical space in use percentage

logical_drr_percent

number (float)

Logical data reduction ratio percentage

logical_inodes_in_use_num

integer

Number of files and directories

physical_drr_percent

number (float)

Physical data reduction ratio percentage

drr

number (float)

Data reduction ratio (logical_space_in_use / physical_space_in_use)

drr_text

string

DRR presented as 1:5.6

rd_iops

integer (int64)

Read IOPS

wr_iops

integer (int64)

Write IOPS

ndb_bandwidth

number (float)

NDB query bandwidth total (MB)

ndb_bandwidth_read

number (float)

NDB query bandwidth read (MB)

ndb_bandwidth_write

number (float)

NDB query bandwidth write (MB)

ndb_number_of_running_queries

integer (int64)

NDB number of running queries

ndb_rows_scanned_per_second

integer (int64)

NDB rows scanned per second

nfs4_certificate

string (password)

Certificate file content of TLS certificate, used to enforce TLS encryption on NFSv4 client connections. TLS encryption is controlled by the view policy and provides an alternative to Kerberos encryption for environments where Active Directory is not used.

nfs4_private_key

string (password)

Private key file content of TLS certificate for NFSv4. See also nfs4_certificate.

iops

integer (int64)

IOPS

rd_md_iops

integer (int64)

Read Meta-data IOPS

wr_md_iops

integer (int64)

Write Meta-data IOPS

md_iops

integer (int64)

Meta-data IOPS

rd_bw

integer (int64)

Read Bandwidth

wr_bw

integer (int64)

Write Bandwidth

bw

integer (int64)

Bandwidth

rd_bw_mb

number (float)

Read Bandwidth

wr_bw_mb

integer

Write Bandwidth

bw_mb

integer

Bandwidth

rd_latency

integer (int64)

Read Latency

wr_latency

integer (int64)

Write Latency

latency

integer (int64)

Latency

rd_latency_ms

integer

Read Latency

wr_latency_ms

integer

Write Latency

latency_ms

integer

Latency

shards

integer

Number of shards

dr_shards

integer

Number of DR shards

dr_wb_shards

integer

Number of DR write buffer shards

stripe_groups

integer

Number of stripe groups

micro_shards

integer

Number of shards

micro_dr_shards

integer

Number of DR shards

micro_dr_wb_shards

integer

Number of DR write buffer shards

micro_stripe_groups

integer

Number of stripe groups

mega_shards

integer

Number of shards

mega_dr_shards

integer

Number of DR shards

mega_dr_wb_shards

integer

Number of DR write buffer shards

mega_stripe_groups

integer

Number of stripe groups

cnode_cores

integer

Number of cnode cores

cluster_private_key

string

Private Key file content of a CA signed certificate, used for mTLS encryption of replication peer connections where secure mode is enabled in the replication peer configuration. A certificate and private key must be installed on each participating replication peer cluster, and the CA's root certificate must be installed on each peer.

cluster_certificate

string

Certificate (public key) file content of a CA signed certificate for mTLS encryption of replication peer connections where secure mode is enabled in the replication peer configuration. A certificate and private key must be installed on each participating replication peer cluster, and the CA's root certificate must be installed on each peer.

cnode_metrics

boolean

Enable cnode-level metrics collection

max_nvram_replication_factor

integer

Max NVRAM replication factor

max_performance

object

read_bw

integer

write_bw

number (float)

read_iops

integer

write_iops

integer

max_ssd_capacity_percent

integer

Max SSD capacity percent

max_nvram_capacity_percent

integer

Max NVRM capacity percent

dbox_ha_support

boolean

DBox HA support

failure_domains_support

boolean

Failure domains support

disable_dirsnap

boolean

True when directory snapshots are disabled

disable_metrics

boolean

True when internal developer metrics collection is disabled

triplication_enabled

boolean

Enables metadata triplication. Metadata triplication improves the resiliency of the cluster by allowing the loss of two metadata sections on SCM or DNode RAM at the same time without any loss of metadata or access. Enabling triplication improves resiliency at the cost of reducing the amount of metadata available to the system by 33%. In addition, enabling this feature increases write latency and reduces the max write IOPS of the system. Supported only on EBox clusters.

delete_snap_blocks_threshold

integer

loopback

boolean

Loopback (single node) installation

enabled

boolean

cluster enabled

perf_check

boolean

Check cluster performance

dmsetup

boolean

Mock NVMeoF devices with dmsetup devices

enable_dr

boolean

enable data reduction

enable_encryption

boolean

Enable data encryption

allow_encryption

boolean

True if External Key Manager (EKM) is configured

half_system

boolean

Is half system

used_handles_percent

number (float)

used_handles_count

integer

use_spdk

boolean

Should install spdk

deep_stripe

boolean

Is deep stripe system

dr_hash_size

integer

DR hash size in buckets

drive_pci_port_type

string

Cluster pci port type (dual, single)

drive_size

integer

Drive size for mocked devices

ssh_user

string

SSH User name

leader_cnode

string

Leader CNode

defrag_threshold

integer

Defrag Threshold

enable_smb

boolean

SMB protocol enabled

enable_s3

boolean

S3 protocol enabled

enable_similarity

boolean

Similarity enabled

enable_composite_table

boolean

Composite table enabled

format_drives

boolean

Format drives

expansion_state

string

expansion_phase

integer

expansion_phase_description

string

url

string

Endpoint URL for API operations on the cluster

uptime

string

Cluster uptime

online_start_time

string

Cluster online start time

deployment_time

string

Cluster deployment time

system_settings

object

upgrade_phase

string

Phase of a background running upgrade

upgrade_progress

object

cnodes

object

done

integer

total

integer

dnodes

object

done

integer

total

integer

upgrade_state

string

enable_trash

boolean

title

string

s3_allow_cors

boolean

s3_certificate

string (password)

Certificate file content of the SSL certificate used to enable client connection to the S3 service over HTTPS.

s3_private_key

string (password)

Private file content of the SSL certificate used to enable client connection to the S3 service over HTTPS.

allow_nfs3_over_udp

boolean

Allow/deny NFS3 over UDP

enable_turbo_boost

boolean

Enable Turbo Boost

showmount_suppressed

boolean

Suppress Linux showmount command output on for NFSv3 users

showmount_hide_slash

boolean

Suppress Linux showmount command output including "/"

sw_defined

boolean

sw_version

string

leader_upgrade_state

string

provides_blocked

boolean

Block/Unblock all external providers

auto_logout_timeout

integer

Inactivity period for auto logout for VAST OS on all nodes (seconds)

motd

string

Custom Message of the Day text displayed by VAST OS on login

motd_append_to_default

boolean

Append custom motd to default motd

rewrite_status

object

Rewrite status summary

rewrite_phase

string

Current Rewrite phase

rewrite_progress

integer

Current Rewrite phase progress (%)

rewrite_type

Array of string

Current Rewrite types

string

root_certificate

string (password)

mTLS Root Certificate content. When a certificate and private key are installed on each participating replication peer cluster, and the CA's root certificate is installed on each peer, mTLS encryption can be enabled on replication connections between peer clusters. See also cluster_certificate and cluster_private_key.

cert_pass

string (password)

Provides the password that protects the private key of the replication certificate uploaded as cluster_private_key, if password protected. The password must be supplied when uploading cluster_private_key and must be re-entered when modifying the certificate.

audit_dir_name

string

Audit directory name, located under root directory. Protocol audit logs are saved to this directory.

read_access_users

Array of string

Enter users here to grant them read access to all files in the audit directory. To make the audit directory accessible to clients, create a view on the directory.

string

read_access_users_groups

Array of string

Enter groups here to grant them read access to all files in the audit directory. To make the audit directory accessible to clients, create a view on the directory.

string

max_file_size

integer

Maximum audit file size for each CNode core

max_handles_count

integer

Maximum supported number of handles

max_audit_dir_size

string

Maximum size of the audit directory. Specify the value with units of MB, GB, TB and so on. No default.

max_retention_period

integer

Max retention period for audit files

max_retention_timeunit

string

Max retention period timeunit for audit files

mio_raid_state

string

MIO raid state

protocols_audit

object

Global audit options that apply to all views. Settings that are disabled here can be enabled in the view policy.

read_data

boolean

Audit operations that read data

modify_data

boolean

Audit operations that modify data

log_username

boolean

Log username of requesting user. Disabled by default

read_data_md

boolean

Audit operations that read metadata

log_full_path

boolean

Log full Element Store path to the requested resource. Enabled by default. May affect performance. When disabled, the view path is recorded.

modify_data_md

boolean

Audit operations that modify data (including operations that change the file size) and metadata

session_create_close

boolean

Audit session creation and closing operations for sessions that use Kerberos 5 authentication (krb5, krb5i, or krb5p)

log_deleted_files_dirs

boolean

Log deleted files and directories

create_delete_files_dirs_objects

boolean

Audit operations that create or delete files, directories, or objects

protocols

Array of string

Array of globally audited protocols.

string

Valid values[ "NFSv3", "NFSv4.1", "SMB", "S3", "NDB" ]

enable_json_audit

boolean

If enabled, audit logs are saved in JSON format into a file in the directory specified as audit_dir_name. Can be enabled in addition to enable_vast_db_audit.

enable_vast_db_audit

boolean

If enabled, audit logs are saved in a VAST DataBase table. Can be enabled in addition to enable_json_audit.

vast_audit_log_state

string

State of Vast Audit Log table

Valid values[ "NONE", "IN_CREATION", "CREATED", "FAILED" ]

is_large_subnet

boolean

Cluster uses a large subnet

ekm_servers

string

List of additional EKM servers: 10.0.0.1:5696,11.0.0.1:5697

ekm_auth_domain

string

Applicable only when encryption_type=CIPHER_TRUST_KMIP. The CipherTrust authentication domain of the user. This is the domain where the user was created. The default is an empty string, which is equivalent to the root domain.

ekm_domain

string

Applicable only when encryption_type=CIPHER_TRUST_KMIP. A child domain name for use when logging in. New keys are created inside the domain.

ekm_proxy_address

string

Applicable only when encryption_type=CIPHER_TRUST_KMIP. A proxy address for connection to the Thales CipherTrust Manager via proxy.

encryption_type

string

Encryption type used to manage encryption keys for new encryption groups, if encryption of data at rest is enabled on the cluster. INTERNAL = keys are managed internally. CIPHER_TRUST_KMIP=Keys are stored and managed on Thales Group CipherTrust Data Security Platform, FORTANIX_KMIP=Keys are stored and managed on Fortanix DSM, HASHICORP_KMIP=Keys are stored and managed on HashiCorp Vault Enterprise, ENTRUST_KMIP=Keys are stored and managed on Entrust KeyControl, UTAMICO_KMIP=Keys are stored and managed on the Utamico platform, AKEYLESS_KMIP=Keys are stored and managed on the Akeyless platform.

Valid values[ "INTERNAL", "CIPHER_TRUST_KMIP", "FORTANIX_KMIP", "HASHICORP_KMIP", "ENTRUST_KMIP", "UTAMICO_KMIP", "AKEYLESS_KMIP" ]

supported_drives

object

Drives compatible with the cluster. When adding a new drive to the cluster as part of the cluster expansion or field replacement procedure, VMS checks the drive against a list of supported drives and raises an alarm if the new drive is not found on the list.

gn_max_size

string

Quota capacity limit for the cluster's global namespace. The limit is shared between all global access source paths on the cluster.

gn_max_inode_count

string

Quota limit on the number of files and directories in the cluster's global namespace. The limit is shared between all global access source paths on the cluster.

gn_used_size

string

Amount of capacity in use for global namespace. Combination of all capacity used by all global access source paths on the cluster.

gn_used_inode_count

integer

Number of files and directories in use in the cluster's global namespace. Summed across all global access source paths on the cluster.

wb_raid_layout

string

Current WB RAID layout of the cluster

is_wb_raid_enabled

boolean

True if wb_raid_layout value means WBR is enabled

voc

boolean

vast on cloud cluster

block_ipmi

boolean

IPMI/BMC access is blocked on this system

s3_enable_v2_authentication

boolean

If true, version 2 authentication is blocked for S3 client API requests. Disabled by default.

use_flash_write_buffers

boolean

Whether to use Write Buffers on Flash (Spillover)

enable_bucket_replication

boolean

True if bucket replication is enabled

enable_bucket_db_replication

boolean

True if bucket DB replication is enabled

max_number_mtls_certs_per_ca

integer

The maximum number of mTLS certificates per CA

qos

object (TruncatedQOS)

static_limits

object (TruncatedQOSStaticLimits)

max_reads_bw_mbps

integer

Maximal amount of performance to provide when there is no resource contention

Minimum0

Default0

max_writes_bw_mbps

integer

Maximal amount of performance to provide when there is no resource contention

Minimum0

Default0

max_reads_iops

integer

Maximal amount of performance to provide when there is no resource contention

Minimum0

Default0

max_writes_iops

integer

Maximal amount of performance to provide when there is no resource contention

Minimum0

Default0

burst_reads_bw_mb

integer

Burst reads BW Mb

Minimum0

Default0

burst_writes_bw_mb

integer

Burst writes BW Mb

Minimum0

Default0

burst_reads_loan_mb

integer

Burst reads loan Mb

Minimum0

Default0

burst_writes_loan_mb

integer

Burst writes loan Mb

Minimum0

Default0

burst_reads_iops

integer

Burst reads IOPS

Minimum0

Default0

burst_writes_iops

integer

Burst writes IOPS

Minimum0

Default0

burst_reads_loan_iops

integer

Burst reads loan IOPS

Minimum0

Default0

burst_writes_loan_iops

integer

Burst writes loan IOPS

Minimum0

Default0

access_ip_ranges

Array of string

string

max_cluster_write_bw_mb

integer

Maximum cluster write bandwidth in MB/s

max_cluster_read_bw_mb

integer

Maximum cluster read bandwidth in MB/s

max_performance_metrics

object (ArbitraryFloatsObject)

property*

number (float) additionalProperties

cloud_provider

string

Cloud provider for VOC system, null for on-prem systems.

Detail Cluster Properties