lbcli get cluster

AI Tools

Get information about the cluster. Note that this command is not available to users that have tenant-specific credentials.

Examples:

# Get cluster info available for cluster admins lbcli -J $JWT get cluster

Flag

Short

Type

Default

Description

--help

-h

bool


Help for cluster.

--parameter


string


Cluster Config parameter name.

This command returns the following fields for the cluster. The default output format is yaml. The JSON output format is also supported. The human-readable output only shows some of these fields.

Field

Description

UUID

The cluster UUID.

Subsystem NQN

Subsystem NQN that should be used by the hosts to connect to volumes on this server.

Supported Max Replicas

The maximum number of replicas that a volume can have, given the cluster’s installation parameters.

Current Max Replicas

The maximum number of replicas that a new volume can have, given the current state and healthiness of the nodes.

Statistics

  • Effective Physical Storage

  • Estimated Free Logical Storage

  • Free Physical Storage

  • Installed Physical Storage

  • Logical Storage

  • Logical Used Storage

  • Managed Physical Storage

  • Physical Used Storage

  • Physical Used Storage Including Parity

Health

State:

  • OK - the cluster is healthy.

  • Warning - The cluster has inactive nodes and/or degraded volumes.

  • Error - The cluster has volumes in Unavailable or Read Only state.

Number of inactive nodes.

Number of degraded/read-only/not-available/healthy volumes.

MinVersionInCluster

The minimum version used by one of the servers in the cluster.

MinAllowedVersion

Note: This field is for internal Lightbits use.

MaxAllowedVersion

The Lightbits version value that this cluster can be upgraded to.

apiEndpoints

A list of REST/gRPC endpoints - <ip>:<port> pairs that the API listen on. Example entries:- 192.168.16.16:80- 192.168.16.17:80

discoveryEndpoints

A list of TCP endpoints - <ip>:<port> pairs that the Discovery Service listen on. Example entries:- 192.168.16.16:8009- 192.168.16.17:8009

clusterName

The name of the cluster.

LastUpgrade/Status

3.3.1 and above

Current status of the upgrade. The possible values are:

  • None

  • Upgrading

  • UpgradeFailed

For a healthy upgrade flow, the upgrade should cycle through the following statuses:

None > Upgrading > None

LastUpgrade/StartTime

Start time of the upgrade on this cluster.

LastUpgrade/EndTime

End time of the upgrade on this cluster.

LastUpgrade/TargetVersion

Lightbits version the cluster is being upgraded to.

LastUpgrade/ErrorMessage

Detailed error message if the upgrade operation failed.

Note: ErrorMessage is limited to 40 characters, so in some cases long error messages will be concatenated.

LastUpgrade/ProgressStep

Progress of the upgrade operation (progress steps and total take into account the number of steps run on each server and the total number of servers for this upgrade operation).

LastUpgrade/ProgressTotal

Total steps in the upgrade operation (progress steps and total take into account the number of steps run on each server and the total number of servers for this upgrade operation).


On This Page
lbcli get cluster