stcli cluster Commands

stcli cluster Command

HX Data Platform storage cluster operations.

stcli cluster [-h] {prepare | create | info | diag | refresh | shutdown | start | upgrade | upgrade-status | upgrade-kernel | version | create-config | recreate | reregister | get-data-replication-factor | get-cluster-access-policy | set-cluster-access-policy | enable-data-write-thru | disable-data-write-thru | storage-summary | get-zone | set-zone}

Syntax Description

Option

Required or Optional

Description
create

One of set required.

Creates a storage cluster with the name and the given nodes identified by IP addresses.
create-config

One of set required.

Creates a storage cluster from a configuration file.
diag

One of set required.

Provides diagnostic messages about the storage cluster.
disable-data-write-thru

One of set required.

Disables data write through on the storage cluster.
enable-data-write-thru

One of set required.

Enables data write through on the storage cluster.
get-cluster-access-policy

One of set required.

Gets storage cluster Cluster Access Policy.
get-data-replication-factor

One of set required.

Gets storage cluster Data Replication Factor.
info

One of set required.

Provides information about the currently configured storage cluster.
prepare

One of set required.

Prepares network configuration for storage cluster for the set of nodes identified by IP addresses.
recreate

One of set required.

Recreates an existing storage cluster with force option.
refresh

One of set required.

Refreshes storage cluster status.
reregister

One of set required.

Reregister an existing storage cluster from one vCenter to another.
set-cluster-access-policy

One of set required.

Sets storage cluster Cluster Access Policy.
shutdown

One of set required.

Shuts down storage cluster.
start

One of set required.

Starts the storage cluster
storage-summary

One of set required.

Provides storage summary about the currently configured storage cluster.
upgrade

One of set required.

Upgrades the storage cluster
upgrade-kernel

One of set required.

Provides transitional information about storage cluster upgrade kernel.
upgrade-status

One of set required.

Provides transitional information about storage cluster upgrade status.
version

One of set required.

Provides information about storage cluster version.
get-zone

One of set required

Gets the zone details. This option is used to check if the zone is enabled.
set-zone

One of set required

Enable or disable zone(s).

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli cluster command with one of the positional arguments enclosed in { }, or optional arguments enclosed in [ ].

stcli cluster create Command

Creates a storage cluster with the name and the given nodes identified by IP addresses.


Important

Please enter password when prompted.

stcli cluster create [-h] --name NAME --ip IP --mgmt-ip MGMTIP [--vcenter-datacenter DATACENTER] [--vcenter-cluster VCENTERCLUSTER] [--vcenter-url VCENTERURL] [--vcenter-sso-url VCENTERSSOURL] [--vcenter-user VCENTERUSER] --node-ips NODEIPS [NODEIPS . . .] --data-replication-factor {2 | 3} [--cluster-access-policy {strict | lenient}] [--zone { 0 | 1}] [--vdi-only-deployment] [-f] [--dryrun] [--esx-username ESXUSERNAME]

Table 1. Syntax Description

Option

Required or Optional

Description
--ip IP

Required

IP address of storage cluster node. The IP is listed in the stcli cluster info command.

--mgmt-ip MGMTIP

Required

IP of storage cluster management server.
--name NAME

Required

Name of storage cluster.
--node-ips NODEIPS [NODEIPS . . .]

Required

IPs of all converged nodes to add to storage cluster.
--vcenter-datacenter DATACENTER

Optional

Name of vCenter datacenter.
--vcenter-user VCENTERUSER

Optional

User name of vCenter administrator.

Enter vCenter administrator password when prompted.
--cluster-access-policy {strict, lenient}

Optional. Default lenient

Cluster Access Policy (strict or lenient).
--data-replication-factor {2, 3}

Optional. Default 3

Data Replication Factor (2 or 3). This can only be set during initial storage cluster creation.
--dryrun

Optional

Only validate input parameters.
--esx-username ESXUSERNAME

Optional

User name of ESX administrator.

Enter ESX administrator password when prompted.
-f, --force

Optional

Force create storage cluster. This ignores network configuration errors and creates the cluster with provided information.
--vcenter-cluster VCENTERCLUSTER

Optional

Name of vCenter cluster.
--vcenter-sso-url VCENTERSSOURL

Optional

URL of vCenter SSO server. This is inferred from --vcenter-url, if not specified.

--vcenter-url VCENTERURL

Optional

URL of vCenter, <vcentername>. Where <vcentername> can be FQDN or IP.

--vdi-only-deployment

Optional. Default is VSI.

Set Workload Type as VDI.
-zone {0,1}

Optional

Enable (1) or Disable (0) zones.
Controller VM root user password Optional

All nodes must have the same password.

Enter controller VM password when prompted.

Command Default

None. See table for list of required and optional parameters.

Usage Guidelines

Accompany the stcli cluster create command with appropriate positional arguments.

stcli cluster create-config Command

Creates a storage cluster from a configuration file.


Important

Please enter password when prompted.

stcli cluster create-config [-h] [-f] [--dryrun] --vcenter-user VCENTERUSER [--esx-username ESXUSERNAME] config

Table 2. Syntax Description

Option

Required or Optional

Description
config

Required

Configuration storage cluster file.
--dryrun

Optional

Only validate input parameters.
--esx-username ESXUSERNAME

Optional

User name of ESX administrator.

Enter ESX administrator password when prompted.
-f, --force

Optional

Force create storage cluster. This ignores network configuration errors and creates the cluster with provided information.
--vcenter-user VCENTERUSER

Optional

User name of vCenter administrator.

Enter vCenter administrator password when prompted.
Controller VM root user password Optional

All nodes must have the same password.

Enter controller VM password when prompted.

Command Default

None. See table for list of required and optional parameters.

Usage Guidelines

Accompany the stcli cluster create-config command with the appropriate positional arguments.

See the Cisco HyperFlex Systems Installation Guide for VMware ESXi for requirements.

stcli cluster diag Command

Provides diagnostic messages about the cluster.

stcli cluster diag [-h] [--id ID | --ip NAME] [--type TYPE]

Syntax Description

Option

Required or Optional

Description
--id ID

Optional.

ID of storage cluster node. The ID is listed in the stcli cluster info command.

--ip NAME

Optional.

IP address of storage cluster node. The IP is listed in the stcli cluster info command.

--type TYPE

Optional.

Type of storage cluster node. Options are: converged or compute

Command Default

If no node is specified, default applies to all nodes in the storage cluster.

Usage Guidelines

Accompany the stcli cluster diag command with optionally, arguments enclosed in [ ].

stcli cluster disable-data-write-thru Command

Disable data write through on the storage cluster.

stcli cluster disable-data-write-thru [-h] [--id ID | --ip NAME]

Syntax Description

Option

Required or Optional

Description
--id ID

Optional.

ID of storage cluster node. The ID is listed in the stcli cluster info command.

--ip NAME

Optional.

IP address of storage cluster node. The IP is listed in the stcli cluster info command.

Command Default

If no node is specified, default applies to all nodes in the storage cluster.

Usage Guidelines

Accompany the stcli cluster disable-data-write-thru command with optionally positional arguments enclosed in [ ].

stcli cluster enable-data-write-thru Command

Enable data write through on the storage cluster.

stcli cluster enable-data-write-thru [-h] [--id ID | --ip NAME]

Syntax Description

Option

Required or Optional

Description
--id ID

Optional.

ID of storage cluster node. The ID is listed in the stcli cluster info command.

--ip NAME

Optional.

IP address of storage cluster node. The IP is listed in the stcli cluster info command.

Command Default

If no node is specified, default applies to all nodes in the storage cluster.

Usage Guidelines

Accompany the stcli cluster enable-data-write-thru command with optionally positional arguments enclosed in [ ].

stcli cluster get-cluster-access-policy Command

Gets storage cluster Cluster Access Policy.

stcli cluster get-cluster-access-policy [-h]

Command Default

Return cluster setting.

Usage Guidelines

Enter the stcli cluster get-cluster-access-policy command. 

# stcli cluster get-cluster-access-policy
lenient

stcli cluster get-data-replication-factor Command

Gets storage cluster Data Replication Factor.

stcli cluster get-data-replication-factor [-h]

Command Default

Returns cluster setting.

Usage Guidelines

Run the stcli cluster get-data-replication-factor command. 

# stcli cluster get-data-replication-factor
3

stcli cluster info Command

Displays detailed information about the storage cluster and each node in the storage cluster.

stcli cluster info [-h] --summary

Syntax Description

Option

Required or Optional

Description
--summary

Optional.

Return summary of information only.

Command Default

Returns full cluster information.

Usage Guidelines

Accompany the stcli cluster info command with the optional positional argument enclosed in [ ] to return a summary of the cluster information.


Note
When vCenter or stMgr is down, the error message from stcli data protection operations may not be self-explanatory. Please validate that the vCenter connection is good and that the “stcli cluster info” command returns cluster healthy status before running stcli data protection operations. 
# stcli cluster info
about:
    serviceType: stMgr
    instanceUuid: 345258cf-12d4-4d71-ba9e-b91e47d15e49
    name: HyperFlex StorageController
    locale: English (United States)
    serialNumber: 
    apiVersion: 0.1
    modelNumber: X9DRT
    build: 2.0.1a-20569 (internal)
    displayVersion: 2.0(1a)
    fullName:  HyperFlex StorageController 2.0.1a
    productVersion: 2.0.1a-20569
vCluster:
    state: online
    boottime: 0
    entityRef:
        type: virtcluster
        id: domain-c876
        name: cs002-cl
    virtNodes:
        ----------------------------------------
        type: virtnode
        id: 00000000-0000-0000-0000-002590d423a4
        ----------------------------------------
        type: virtnode
        id: 00000000-0000-0000-0000-002590d42388
        ----------------------------------------
        type: virtnode
        id: 00000000-0000-0000-0000-002590d423b2
        ----------------------------------------
    virtDatastores:
upgradeState: ok
upgradeVersion: 2.0.1a-20569
cluster:
    allFlash: False
    healthState: healthy
    capacity: 5.0T
    state: online
    compliance: 1
    resiliencyInfo:
        nodeFailuresTolerable: 1
        state: 1
        messages:
            Storage cluster is healthy. 
        cachingDeviceFailuresTolerable: 1
        persistentDeviceFailuresTolerable: 1
    activeNodes: 3
    uptime: 18:53:15
    boottime: 1484703014
    entityRef:
        type: cluster
        id: 345258cf12d44d71:456146e1b82ea1b7
    downtime: 0:00:00
    healingInfo:
        inProgress: False
    freeCapacity: 5.0T
    usedCapacity: 55.0G
    config:
        clusterUuid: 345258cf12d44d71:456146e1b82ea1b7
        ip: 10.104.48.28
        dataReplicationFactor: 2
        clusterAccessPolicy: lenient
        size: 3
    nodes:
        ----------------------------------------
        type: pnode
        id: bf7a0223564d0db8:88974e15886ab3e0
        name: 10.104.48.27
        ----------------------------------------
        type: pnode
        id: d1b5bc18564da19b:bc1e977ebd9aafec
        name: 10.104.48.26
        ----------------------------------------
        type: pnode
        id: d8e6ec9a564de28a:9d870ca45456c471
        name: 10.104.48.24
        ----------------------------------------
    rawCapacity: 10.0T
state: online
stNodes:
    ----------------------------------------
    type: node
    id: 00000000-0000-0000-0000-002590d423b2
    name: cs-002a
    ----------------------------------------
    type: node
    id: 00000000-0000-0000-0000-002590d42388
    name: cs-002c
    ----------------------------------------
    type: node
    id: 00000000-0000-0000-0000-002590d423a4
    name: cs-002d
    ----------------------------------------
entityRef:
    type: cluster
    id: 3770173484459904369:4999354996629610935
    name: cs002-cl
config:
    clusterUuid: 3770173484459904369:4999354996629610935
    name: cs002-cl
    mgmtIp:
        addr: 10.104.32.32
        method: dhcp
    vCenterDatacenter: cs002-dc
    ip:
        addr: 10.104.48.28
        method: dhcp
    vCenterClusterName: cs002-cl
    dataReplicationFactor: 2
    workloadType: 2
    vCenterClusterId: domain-c876
    nodeIPSettings:
        cs-002d:
        cs-002c:
        cs-002a:
    vCenterDatacenterId: datacenter-871
    clusterAccessPolicy: lenient
    vCenterURL: cs-vc6
    dnsServers:
    size: 3

stcli cluster prepare Command

Prepares network configuration for the storage cluster for the set of nodes identified by IP addresses.


Note

The stcli cluster prepare command is only supported when the cluster is not yet deployed. Use the automated workflow for a running cluster.


Note

This is an advanced command. Do not use without TAC assistance.

stcli cluster prepare [-h] {--node-ips NODEIPS [NODEIPS . . .] | --config CONFIG} [--hypervisor-ips HYPERVISORIPS [HYPERVISORIPS . . .]] [--storefs-ips STORFSIPS [STORFSIPS . . .]] [--ipmi-ips IPMIIPS [IPMIIPS . . .]] [--vmotion-ips VMOTIONIPS [VMOTIONIPS . . .]] [--netmask NETMASK] [--gateway GATEWAY] [--vlan VLAN] [--netmask1 NETMASK1] [--gateway1 GATEWAY1] [--vlan1 VLAN1] [--dns DNS [DNS . . .]] [--ntp NTP [NTP . . .]] [--timezone TIMEZONE] [--smtp STMPSERVER] [--fromaddress FROMADDRESS] [--dryrun]

Syntax Description

Option

Required or Optional

Description
--config CONFIG

Require one from set.

Network configuration file.
--node-ips NODEIPS [NODEIPS . . .]

Require one from set.

IPs of storage cluster nodes to add to configuration. Separate multiple IPS with a space.
--dns DNS [DNS . . .]

Optional.

IPs of DNS server. Separate multiple IPS with a space.
--dryrun

Optional.

Only validate input parameters.
--fromaddress FROMADDRESS

Optional.

Address to send Auto Support emails from.
--gateway GATEWAY

Optional.

Default gateway.
--gateway1 GATEWAY1

Optional.

Default gateway1.

--hypervisor-ips HYPERVISORIPS [HYPERVISORIPS . . .]

Optional.

IPs of hypervisor to be applied. Separate multiple IPS with a space.
--ipmi-ips IPMIIPS [IPMIIPS . . .]

Optional.

IPs of IPMI to be applied. Separate multiple IPS with a space.
--netmask NETMASK

Optional.

Subnet mask.
--netmask1 NETMASK1

Optional.

Subnet mask1.
--ntp NTP [NTP . . .]

Optional.

IPs of NTP servers. Separate multiple server IDs with a space.
--smtp SMTPSERVER

Optional.

SMTP server.
--storefs-ips STORFSIPS [STORFSIPS . . .]

Optional.

IPs of storage cluster to be applied. Separate multiple IPS with a space.
--timezone TIMEZONE

Optional.

Timezone.
--vlan VLAN

Optional.

VLAN tag.
--vlan1 VLAN1

Optional.

VLAN tag1.
--vmotion-ips VMOTIONIPS [VMOTIONIPS . . .]

Optional.

IPs of vMotion to be applied. Separate multiple IPS with a space.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli cluster prepare command with one of the positional arguments enclosed in { } and optionally arguments enclosed in [ ].


Note

Do not use this command without TAC assistance.

stcli cluster recreate Command

Recreates an existing storage cluster with force option.


Important

Please enter password when prompted.

stcli cluster recreate [-h] --vcenter-user VCENTERUSER

Syntax Description

Option

Required or Optional

Description
--vcenter-user VCENTERUSER

Required

User name of vCenter administrator.

Enter vCenter administrator password when prompted.
Controller VM root user password

Optional

All nodes must have the same password.

Enter controller VM password when prompted.

Command Default

None.

Usage Guidelines

Accompany the stcli cluster recreate command with the positional argument and optionally arguments enclosed in [ ].

stcli cluster refresh Command

Refreshes storage cluster status.

stcli cluster refresh [-h]

Command Default

Returns refreshed cluster status.

Usage Guidelines

Run the stcli cluster refresh command to manually refresh the cluster status.

stcli cluster reregister Command

Shift registration of an existing storage cluster from one vCenter to another.


Important

  • vCenter must be up and running to complete this command.

  • Please enter password when prompted.

stcli cluster reregister [-h] --vcenter-datacenter NEWDATACENTER --vcenter-cluster NEWVCENTERCLUSTER --vcenter-url NEWVCENTERURLIP [--vcenter-sso-url NEWVCENTERSSOURL] --vcenter-user NEWVCENTERUSER

Syntax Description

Option

Required or Optional

Description
--vcenter-cluster NEWVCENTERCLUSTER

Required

Name of the new vCenter cluster.
--vcenter-datacenter NEWDATACENTER

Required

Name of the new vCenter datacenter.
--vcenter-sso-url NEWVCENTERSSOURL

Optional

URL of the new vCenter SSO server. This is inferred from --vcenter-url, if not specified.

--vcenter-url NEWVCENTERURLIP

Required

URL of the new vCenter, <vcentername>. Where <vcentername> can be IP or FQDN of new vCenter.

--vcenter-user NEWVCENTERUSER

Required

User name of the new vCenter administrator.

Enter vCenter administrator password when prompted.

Command Default

None.

Usage Guidelines

Accompany the stcli cluster reregister command with the required arguments and optional arguments enclosed in [ ], as needed.

Use when moving a storage cluster from one vCenter server to another vCenter server. Task includes moving the storage cluster, registering the storage cluster with the new vCenter, and unregistering the storage cluster from the old vCenter. See the Cisco HyperFlex Data Platform Administration Guide.

stcli cluster set-cluster-access-policy Command

Sets storage cluster Cluster Access Policy.

stcli cluster set-cluster-access-policy [-h] --name {strict | lenient}

Syntax Description

Option

Required or Optional

Description
--name {strict, lenient}

Required.

Select the storage cluster Cluster Access Policy.

  • Strict - Applies policies to protect against data loss.

  • Lenient - Applies policies to support longer storage cluster availability.

Command Default

No default using the stcli cluster set-cluster-access-policy command line. Using the HX Data Platform Installer, the default is lenient.

Usage Guidelines

Used to change the setting applied during storage cluster creation. Accompany the stcli cluster set-cluster-access-policy command with one of the positional arguments enclosed in { }.

This example shows setting the cluster Access Policy to strict. The command returns the applied setting.

# stcli cluster set-cluster-access-policy --name strict
strict

stcli cluster shutdown Command

Stops storage cluster operations and shuts it down.

stcli cluster shutdown [-h] [--formatchange]

Syntax Description

Option

Required or Optional

Description
--formatchange

Optional.

Enable disk format change after cluster shutdown.

Command Default

None.

Usage Guidelines

Run the stcli cluster shutdown command with optionally arguments enclosed in [ ].

stcli cluster start Command

Starts the storage cluster.

stcli cluster start [-h]

Command Default

None.

Usage Guidelines

The stcli cluster start command does not have any additional options.

stcli cluster storage-summary Command

Provides storage summary about the currently configured the storage cluster.

stcli cluster storage-summary [-h] [--]

Command Default

No additional options available.

Usage Guidelines

Run stcli cluster storage-summary command to display the result. 

# stcli cluster storage-summary
address: 10.104.48.28
name: cs002-cl
state: online
uptime: 0 days 19 hours 28 minutes 38 seconds
activeNodes: 3 of 3
compressionSavings: 83.2387622179
deduplicationSavings: 0.0
freeCapacity: 5.0T
healingInfo:
    inProgress: False
resiliencyInfo:
    messages:
        Storage cluster is healthy. 
    state: 1
    nodeFailuresTolerable: 1
    cachingDeviceFailuresTolerable: 1
    persistentDeviceFailuresTolerable: 1
spaceStatus: normal
totalCapacity: 5.0T
totalSavings: 83.2387622179
usedCapacity: 55.0G
clusterAccessPolicy: lenient
dataReplicationCompliance: compliant
dataReplicationFactor: 2

stcli cluster upgrade Command

Upgrades HX Data Platform software to the latest version.


Important

Enter password when prompted.

stcli cluster upgrade [-h] [--status] [--info] [--components COMPONENTS {hxdp | ucs-fw}] [--location LOCATION] [--hypervisor-bundle HYPERVISOR-BUNDLE] [--mgmt-only] [--vcenter-user VCENTERUSER] [--checksum CHECKSUM] [--ucsm-host UCSMHOST] [--ucsm-user UCSMUSER] [--ucsfw-version UCSFR-VERSION] [--ucsm5-fw-version UCSM5-FW-VERSION] [--dryrun]

Syntax Description

Option

Required or Optional

Description
--checksum CHECKSUM

Optional

Checksum of the installer.
--components COMPONENTS

Required

Comma separated upgrade components {hxdp, ucs-fw, mgmt-only, hypervisor}

--dryrun

Optional

Validate cluster upgrade can be possible.
--info

Optional

Check for upgrade information.
--location LOCATION

Optional

Location of the upgrade package. Best case use /tmp on the controller VM.

  • Download the upgrade package to your computer.

  • Upload it (using scp or a similar tool) to the controller VM of the appliance on which you run the upgrade command.

--hypervisor-bundle HYPERVISOR-BUNDLE

Optional

Location of the ESXi offline bundle. Best case use /tmp on the controller VM.

  • Download the upgrade package to your computer.

  • Upload it (using scp or a similar tool) to the controller VM of the appliance on which you run the upgrade command.

--mgmt-only

Optional

Check for auto-bootstrap (management packages upgrade) status.
--status

Optional

Check for upgrade status.
--ucsfw-version UCSFW-VERSION

Optional

UCS Server Firmware target version.
--ucsm5-fw-version UCSM5-FW-VERSION

Optional

UCS Server Firmware target version for M5 servers.
--ucsm6-fw-version UCSM6-FW-VERSION

Optional

UCS Server Firmware target version for M6 servers.
--ucsm-host UCSMHOST

Optional

Hostname or IP of UCS Manager server.
--ucsm-user UCSMUSER

Conditionally required

User name of UCS Manager server.

Required only if upgrading the UCS Manager component.
--vcenter-user VCENTERUSER

Conditionally required

User name of vCenter administrator. Required only if upgrading the vCenter component.

Enter vCenter administrator password when prompted.
--vcenter-password VCENTERPWD

Conditionally required

Password for vCenter server.

Required only if upgrading the vCenter component.

Command Default

Assumes settings of existing storage cluster if additional options are not provided.

Usage Guidelines

Accompany the stcli cluster upgrade command with one or more of the optional arguments enclosed enclosed in [ ].

See the Cisco HyperFlex Systems Upgrade Guide.

stcli cluster upgrade-kernel Command


Note

This command is not supported. .

stcli cluster upgrade-status Command

Displays the last known upgrade status of the HX Data Platform software. If the upgrade is in progress, transitional status is listed. Once the upgrade is complete, the status lists the most recent upgrade. This also lists if an upgrade is available or you are due for an upgrade.

stcli cluster upgrade-status [-h]

Command Default

No available options.

Usage Guidelines

Accompany the stcli cluster upgrade-status command.

This example shows : 

# stcli cluster upgrade-status
Nodes up to date: [cs-002a(10.104.32.21), cs-002c(10.104.32.25), cs-002d(10.104.32.27)]
Cluster upgrade succeeded.

stcli cluster version Command

Displays the version number of each node in the storage cluster.

stcli cluster version [-h]

Command Default

No options available.

Usage Guidelines

Run the stcli cluster version command.

This example shows : 

# stcli cluster version
Cluster version: 2.0(1a)
Node cs-002c version: 2.0(1a)
Node cs-002a version: 2.0(1a)
Node cs-002d version: 2.0(1a)

stcli cluster get-zone Command

Gets the zone details. This option is used to check if the zone is enabled.

stcli cluster get-zone

Command Default

No user input is required.

Usage Guidelines

The stcli cluster get-zone command does not have any additional options.

stcli cluster set-zone Command

Enable or disable zone(s).

stcli cluster set-zone < --zone option_arg {1:enable, 0:disable}> [--numzones option_arg]

Command Default

If the option < --numzones> is not specified, storfs will automatically decide on the number of zones to be configured based on the active number of nodes in the cluster at the point of invocation.

Usage Guidelines

Accompany the stcli cluster set-zone command with the zone option to enable or disable zone(s). 

stcli cluster set-zone --zone 0 (to disable a zone)

stcli cluster set-zone --zone 1 (to enable and create default number of zones)

stcli cluster set-zone --zone 1 –numzones <integer-value> (to enable zones and create a specific number of zones)

stcli rebalance start (you must execute the rebalance start command after you enable and create zones)

Warning

Support for the stcli rebalancecommand is limited to Cisco Tech support only. General use is not supported.