Cisco HyperFlex Data Platform CLI Guide, 5.0

hxcli Commands

HX Data Platform Command Line Interface (CLI) commands all begin with hxcli .

hxcli [-h] {about | cluster | dataprotection | datastore | disk | encryption | events | node | security | services | tasks | iscsi | vcenter | version}

Table 1. Syntax Description
Option	Required or Optional	Description
iscsi	One of set required.	Commands supported in the iSCSI namespace.

Note

hxcli iscsi commands are located in this guide. For details on other hxcli commands, see the HX CLI Reference.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the hxcli command with one of the positional arguments enclosed in { } or optionally, arguments enclosed in [ ].

hxcli cluster Command

Displays the list of commands available in the cluster namespace.

hxcli cluster {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for cluster.

Table 2. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli cluster command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli cluster about Command

Displays information about the server version and the product details for each node in the storage cluster.

hxcli cluster about {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for cluster about.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 3. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli cluster about command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli cluster detail Command

Displays detailed configuration information for each node in the storage cluster.

hxcli cluster detail {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for cluster detail.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 4. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli cluster detail command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli cluster health Command

Displays the resiliency health of the storage cluster.

hxcli cluster health {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for cluster health.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 5. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli cluster health command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli cluster info Command

Displays detailed configuration, capacity, health, and disks information for each node in the storage cluster.

hxcli cluster info {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for cluster info.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 6. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli cluster info command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli cluster shutdown Command

Shuts down the HyperFlex storage cluster.

hxcli cluster shutdown {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for cluster shutdown.

Table 7. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli cluster shutdown command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli cluster start Command

Starts the HyperFlex cluster.

hxcli cluster start {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for cluster start.

Table 8. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli cluster start command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli cluster stats Command

Displays information related to cluster space savings and capacity statistics.

hxcli cluster stats {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for cluster stats.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 9. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli cluster stats command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli cluster Command

Displays the list of commands available in the cluster namespace.

hxcli cluster {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for cluster.

Table 10. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli cluster command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection Command

Attention

Support for this CLI ends with HXDP Release 5.5(1a).

Commands supported in the Data Protection namespace.

hxcli dataprotection {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection

Table 11. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).
5.5(1a)	Support for this CLI ends.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection network Command

Attention

Support for this CLI ends with HXDP Release 5.5(1a).

Commands supported in the Data Protection network namespace.

hxcli dataprotection network {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection network.

Table 12. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).
5.5(1a)	Support for this CLI ends.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection network command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection network edit Command

Attention

Support for this CLI ends with HXDP Release 5.5(1a).

Provides means to the edit the range of IPs and set the replication bandwidth limit for a storage cluster that has replication configured.

hxcli dataprotection network edit {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection network edit
-b, --bandwidth int		Replication incoming and outgoing bandwidth (Mbits/s). (default -1)
-s, --beginAddress string		Replication IP pool begin address.
-e, --endAddress string		Replication IP pool end address.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 13. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).
5.5(1a)	Support for this CLI ends.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the stcli services asup command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection network info Command

Attention

Support for this CLI ends with HXDP Release 5.5(1a).

Displays detailed information about the replication network that is configured on the storage cluster.

hxcli dataprotection network info {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection network info
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 14. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).
5.5(1a)	Support for this CLI ends.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection network info command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup Command

Commands supported in the Data Protection svgroup namespace.

hxcli dataprotection svgroup {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection svgroup.

Table 15. Command History
HX Release	Modification
5.0	This command was introduced in Cisco HX Release 5.0.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup create Command

Creates a Storage Volume Group of HX iSCSI LUNs.

hxcli dataprotection svgroup create {flags}

Alias

You can also use the alias "cr" as a shortcut to specify create.

hxcli dataprotection svgroup cr [flags]

Syntax Description

Option

Required or Optional

Description

-h, --help

Help for dataprotection svgroup create.

-d, --description string

Description of the group.

-m, --members string

Members of the group. Comma(,) separated list of HX iSCSI LUN serial numbers.

-n, --name string

Name of the group.

-q, --quiesce

Quiesce

Note

Not supported in Cisco HX Release 5.0(x) and later.

-r, --replicationIntervalInMinutes

Replication interval in minutes.

Note

Not supported in Cisco HX Release 5.0(x) and later.

-s, --snapshotRetentionCount int

Snapshot retention limit (default 32)

-t, --targetName string

Name of the target.

Table 16. Command History

HX Release

Modification

5.0

This command was introduced in Cisco HX Release 5.0.

Note

The -r, --replicationIntervalInMinutes and -q, --quiesce keywords are not supported in this release.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup create command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup delete Command

Deletes a Storage Volume Group of HX iSCSI LUNs

hxcli dataprotection svgroup delete {flags}

Alias

You can also use the alias "del", "remove", "rm" as a shortcut to specify create.

hxcli dataprotection svgroup del [flags]

hxcli dataprotection svgroup rm [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection svgroup delete.
-g, --group-id string		ID of the group.

Table 17. Command History
HX Release	Modification
5.0	Not supported in Cisco HX Release 5.0(x) and later.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup delete command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup list Command

Lists all Storage Volume Groups with detailed information about each group.

hxcli dataprotection svgroup list {flags}

Alias

You can also use the alias "ls", "li" as a shortcut to specify create.

hxcli dataprotection svgroup ls [flags]

hxcli dataprotection svgroup li [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection svgroup list.
-g, --group-id string		ID of the group
-n, --group-name string		Name of the group.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")
--no header		When using the default or custom-column output format, don't print headers (default print headers).

Table 18. Command History
HX Release	Modification
5.0	This command was introduced in Cisco HX Release 5.0.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup snapshot Command

Commands supported in the Data Protection svgroup namespace.

hxcli dataprotection svgroup snapshot {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection svgroup snapshot.

Table 19. Command History
HX Release	Modification
5.0	This command was introduced in Cisco HX Release 5.0.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup snapshot command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup snapshot create Command

Create a Storage Volume Group snapshot.

hxcli dataprotection svgroup snapshot create {flags}

Alias

You can also use the alias "cr" as a shortcut to specify create.

hxcli dataprotection snapshot svgroup cr [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection svgroup snapshot create.
-d, --description string		Description of the snapshot.
-g, --group-id string		ID of the group.
-q, --quiesce		Quiesce
-s, --snap-name string		Name of the snapshot.

Table 20. Command History
HX Release	Modification
5.0	This command was introduced in Cisco HX Release 5.0.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup snapshot create command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup snapshot prepare Command

Prepare for Storage Volume Group snapshot.

hxcli dataprotection svgroup snapshot prepare {flags}

Alias

You can also use the alias "pre" as a shortcut to specify prepare.

hxcli dataprotection svgroup snapshot pre [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection svgroup snapshot prepare.
-g, --group-id string		ID of the group.
-s, --snap-name string		Name of the snapshot.

Table 21. Command History
HX Release	Modification
5.0	This command was introduced in Cisco HX Release 5.0.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup snapshot prepare command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup snapshot delete Command

Deletes a Storage Volume Group of HX iSCSI LUNs

hxcli dataprotection svgroup snapshot delete {flags}

Alias

You can also use the alias "del", "remove", "rm" as a shortcut to specify delete.

hxcli dataprotection svgroup snapshot del [flags]

hxcli dataprotection svgroup snapshot rm [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection svgroup delete.
-g, --group-id string		ID of the group.
-s, --snap-id string		ID of the snapshot.

Table 22. Command History
HX Release	Modification
5.0	This command was introduced in Cisco HX Release 5.0.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup snapshot delete command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup snapshot list Command

Lists Storage Volume Group snapshots.

hxcli dataprotection svgroup snapshot list {flags}

Alias

You can also use the alias "ls", "li" as a shortcut to specify list.

hxcli dataprotection svgroup snapshot ls [flags]

hxcli dataprotection svgroup snapshot li [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for list.
-g, --group-id string		ID of the group.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")
-s, --snapshot-id string		ID of the snapshot.
-n, --snapshot-name string		Name of the snapshot.
--no header		When using the default or custom-column output format, don't print headers (default print headers).

Table 23. Command History
HX Release	Modification
5.0	This command was introduced in Cisco HX Release 5.0.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup snapshot list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli dataprotection svgroup snapshot export Command

Export a Storage Volume Group snapshot.

hxcli dataprotection svgroup snapshot export {flags}

Alias

You can also use the alias "exp" as a shortcut to specify export.

hxcli dataprotection snapshot svgroup exp [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help		Help for dataprotection svgroup snapshot export.
-g, --group-id string		ID of the group.
-s, --snap-id string		ID of the snapshot.
-t, --target-name string		Name of the target.

Table 24. Command History
HX Release	Modification
5.0	This command was introduced in Cisco HX Release 5.0.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli dataprotection svgroup snapshot export command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli datastore Command

Displays the list of commands available in the datastore namespace.

datastore {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for datastore create.

Table 25. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli datastore command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli datastore create Command

Creates a logical container used by the HX Data Platform plug-in to manage your storage use and the storage resources.

datastore create {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for datastore create command.
-b, --block-size string		Block size. One of [4K\|8K] (default "8K")
-n, --name string		New name of the datastore
-s, --size int		Size of the datastore
-u, --unit string		Unit. One of [tb\|gb]
-e, --unit string	Optional	Creates an encrypted datastore if this option is provided.

Table 26. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli datastore create command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli datastore delete Command

Deletes the selected datastore.

datastore delete {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for datastore delete command.
-i, --id string		ID of the datastore
-n, --name string		New name of the datastore

Table 27. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli datastore delete command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli datastore edit Command

Provides means to edit the name or capacity of the selected datastore.

datastore edit {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for datastore edit command.
-b, --block-size string		Block size. One of [4K\|8K] (default "8K")
-i, --id string		ID of the datastore
-n, --name string		New name of the datastore
-s, --size int		Size of the datastore
-u, --unit string		Unit. One of [tb\|gb]

Table 28. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli datastore edit command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli datastore info Command

Displays detailed information about the name of the datastore, mount summary, status, size, and free space for the specified datastore.

datastore info {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for datastore info command.
-i, --id string		ID of the datastore
-n, --name string		New name of the datastore
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 29. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli datastore info command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli datastore list Command

Lists the storage cluster datastores. Displays detailed information about the mount summary, status, size, and free space for the datastores.

datastore list {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for datastore list command.
--no-header		When using the default or custom-column output format, do not print headers (default print headers).
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 30. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli datastore list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli datastore mount Command

Mounts the specified storage cluster datastore.

datastore mount {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for datastore mount command.
-i, --id string		ID of the datastore
-n, --name string		New name of the datastore

Table 31. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli datastore mount command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli datastore unmount Command

Unmounts the specified storage cluster datastore.

datastore unmount {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for datastore unmount command.
-i, --id string		ID of the datastore
-n, --name string		New name of the datastore

Table 32. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli datastore unmount command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli disk Command

Displays the list of commands available in the disks namespace.

hxcli disk {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for disk commands.

Table 33. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli disk command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli disk list Command

Lists the storage cluster disks in the node. Displays detailed information about the name of the disk, type, status, slot, capacity and usage for the disks.

hxcli disk list {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for disk list command.
-h, --no-header		When using the default or custom-column output format, do not print headers (default print headers).
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")
-s, --sort int		Sorts the list by index. Starts from 0

Table 34. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli disk list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli encryption backup-keys

Performs a keys back-up to safeguard against any corruption and eventually loss of data, after successfully configuring software-encryption on the cluster.

Note

It is recommended to backup DEK after HX Software Encryption is enabled and after every Rekey. A preivously backed-up DEK cannot be restored after you perform a Rekey on your cluster.

To restore encrypted DEK configuration to the cluster when lost or corrupted from a previously saved back-up, contact TAC.

Note

After performing the backup, you need to scp/download the file from the node for storage off cluster.

hxcli encryption backup-keys {flags}

Syntax Description

Option

Required or Optional

Description

-h, --help

Displays help for encryption back-up keys.

-f, --filename string

Filename path.

Note

Filename path should start with "/home/admin".

Note

It is highly recommended to save the DEK backup file to a secure location outside the HX CVM.

Table 35. Command History
HX Release	Modification
5.0(1b)	This command was introduced in Cisco HX Release 5.0(1b).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli encryption backup-keys -f <path to file name> command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli encryption info

Displays configuration status of the software-encryption on the cluster.

hxcli encryption info {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for encryption info.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 36. Command History
HX Release	Modification
5.0(1b)	This command was introduced in Cisco HX Release 5.0(1b).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli encryption info command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli encryption support

Indicates whether software-encryption is supported on the cluster.

hxcli encryption supported

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for encryption info.

Table 37. Command History
HX Release	Modification
5.0(1b)	This command was introduced in Cisco HX Release 5.0(1b).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli encryption supported command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli events Command

Displays the list of commands available in the events namespace.

hxcli events {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for events commands.

Table 38. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli events command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli events list Command

Displays information related to state changes resulting from user actions and system actions that occur on the HyperFlex storage cluster.

hxcli events list {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for events list command.
-t, --eventType string		Event type. One of: [cluster\|node\|virtualmachine\|all] (default "all")
-l, --limit int		Limit of the number of events (default 10)
--no-header		When using the default or custom-column output format, don't print headers (default print headers).
-f, --offset int		Offset of the events
-r, --order string		Ascending or descending order of events. One of [ASCEND\|DESCEND] (default "DESCEND")
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")
-v, --severity string		Event severity. One of: [info\|warning\|error\|critical\|all] (default "all")

Table 39. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli events list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi Command

Displays the list of commands available in the iSCSI namespace.

hxcli iscsi [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for iSCSI commands.

Table 40. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

Note

Command line interface for iSCSI is supported only in hxcli. There is no planned support for iSCSI in stcli.

hxcli iscsi network Command

Displays detailed configuration information for your iSCSI network.

hxcli iscsi network [-h] {edit | info}

Syntax Description


Option	Required or Optional	Description
edit	Required	Provides means to edit the selected network.
delete	Required	Provides means to delete the selected network.
info	Required	Displays detailed information about the selected network.

Table 41. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi network command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi network info Command

Detailed information about iscsi network configuration.

hxcli iscsi network info [-h] [--output string]

Syntax Description


Option	Required or Optional	Description
-o, --output string	Required	Output format. One of: [json\|yaml\|wide]. The default is `wide`.

Table 42. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi network command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi network create Command

iSCSI network configuration.

hxcli iscsi network create [-h] {--output string | --payload string |--ucs-host string | --user-name string }

Syntax Description


Option	Required or Optional	Description
-o, --output string		Output format. Valid values: json, yaml, and wide. The default is wide.
-p, --payload string		Payload for create Network.
-n, --ucs-host string		UCS Manager Host IP or FQDN.
-u, --user-name string		User name for authentication with UCS.

Table 43. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi network command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi network edit Command

iSCSI network configuration.

hxcli iscsi network edit [-h] {--output string | --payload string |--ucs-host string | --user-name string }

Table 44. Syntax Description
Option	Required or Optional	Description
-o, --output string		Output format. Valid values: json, yaml, and wide. The default is wide.
-p, --payload string		Payload for create Network.
-n, --ucs-host string		UCS Manager Host IP or FQDN.
-u, --user-name string		User name for authentication with UCS.

Table 45. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi network command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi network delete Command

iSCSI network configuration.

hxcli iscsi network delete [-h] {--output string | --payload string |--ucs-host string | --user-name string }

Table 46. Syntax Description
Option	Required or Optional	Description
-o, --output string		Output format. Valid values: json, yaml, and wide. The default is wide.
-p, --payload string		Payload for create Network.
-n, --ucs-host string		UCS Manager Host IP or FQDN.
-u, --user-name string		User name for authentication with UCS.

Table 47. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi network command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi target Command

Displays the list of commands available in the iSCSI Target command.

hxcli iscsi target [flags]

Alias

You can also use the alias "tgt" or "targets" as a shortcut to specify target.

hxcli iscsi tgt [flags]

hxcli iscsi targets [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for iSCSI Target commands.

Table 48. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi target command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi target info Command

Displays detailed information about the name of the target, authentication method, initiator groups and LUNs.

hxcli iscsi target info [-h] {--name string | --output string | --targetUuid string }

Syntax Description


Option	Required or Optional	Description
-n, --name string		Target name
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")
-t, --targetUuid string		Target ID

Table 49. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi target command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi target list Command

Lists the iSCSI targets in the cluster. Displays detailed information about the name, IQN, and Auth Method for the targets.

hxcli iscsi target list [-h] { --limit int | --offset int | --order string | --output string }

Syntax Description


Option	Required or Optional	Description
-l, --limit int	Required	Limit of the number of list. The default value is `10`.
-f, --offset int	Required	Offset of the list
-r, --order string	Required	Ascending or descending order of list. One of [ASCEND\|DESCEND]. The defaulr value is `DECEND`.
-o, --output string	Required	Output format. One of: [json\|yaml\|wide]. The default value is `wide`

Table 50. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi target command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi target create Command

Creates an iSCSI target.

hxcli iscsi target create [flags]

Alias

You can also use the alias "cr" as a shortcut to specify create.

hxcli iscsi target cr [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help	Required	Help for create.
-p, --payload string	Required	Payload for Target.

Table 51. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi target command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi target edit Command

Provides means to edit the name or authentication of the selected target.

hxcli iscsi target edit [-h] {--payload string | --targetUuid string}

Syntax Description


Option	Required or Optional	Description
-p, --payload string		Target payload
-t, --targetUuid string		Target ID

Table 52. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi target command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi target delete Command

Deletes the selected target.

hxcli iscsi target delete [-h] {--name string | --targetUuid string}

Syntax Description


Option	Required or Optional	Description
-n, --name string		Target name
-t, --targetUuid string		Target ID

Table 53. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi target command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi initiator-group Command

Displays configuration information for iSCSI Initiator Groups..

hxcli iscsi initiator-group [-h] {create | delete | edit | info | list }

Alias

You can also use the alias "ig", "igroup", or "igroups" as a shortcut to specify initiator-group.

hxcli iscsi ig [-h] {create | delete | edit | info | list }

hxcli iscsi igroup [-h] {create | delete | edit | info | list }

hxcli iscsi igroups [-h] {create | delete | edit | info | list }

Syntax Description


Option	Required or Optional	Description
create	Required	Create an iSCSI Initiator Group
delete	Required	Delete an iSCSI Initiator Group
edit	Required	Edit data for an iSCSI Initiator Group
info	Required	Displays information about a specified iSCSI Initiator Group
list	Required	Lists iSCSI Initiator Groups on a network.

Table 54. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi initiatior-group command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi initiator-group info Command

Displays detailed information of an initiator group with name and initiator count.

hxcli iscsi initiator-group info [-h] { --initiator-group-uuid string | --name string | --output string }

Syntax Description


Option	Required or Optional	Description
-i, --initiator-group-uuid string	required/optional	ID of the Initiator group
-n, --name string	required/optional	Initiator group name
-o, --output string	required/optional	Output format. Valid values: json, yaml, and wide. The default is wide.

Table 55. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi initiatior-group command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi initiator-group list Command

Lists the iSCSI initiator groups in the cluster. Displays detailed information about the name, IQN, and IPs for the initiator groups.

hxcli iscsi initiator-group list [-h] { --limit int | --offset int | --order string | --output string}

Syntax Description


Option	Required or Optional	Description
-l, --limit int		Limit of the number of list The default value is: 10
-f, --offset int		Offset of the list.
-r, --order string		Ascending or descending order of list. Valid Values: ASCEND, DESCEND. The default value is: DESCEND
-o, --output string		Output format. Valid values: json, yaml, and wide. The default is wide.

Table 56. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi initiatior-group command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi initiator-group create Command

Creates an initiator group with name and initiators.

hxcli iscsi initiator-group create [-h] {--payload string}

Syntax Description


Option	Required or Optional	Description
-p, --payload string	Required	Initiator group payload.

Table 57. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi initiatior-group command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi initiator-group edit Command

Provides the ability to edit the name, iqn and IPs of an initiator group.

hxcli iscsi initiator-group edit [-h] {--initiator-group-uuid string | --payload string}

Syntax Description


Option	Required or Optional	Description
-i, --initiator-group-uuid string	required/optional	ID of the Initiator group
-p, --payload string	required/optional	Payload for Initiator group

Table 58. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi initiatior-group command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi initiator-group delete Command

Deletes an initiator group.

hxcli iscsi initiator-group delete [-h] { --initiator-group-uuid | --name string }

Syntax Description


Option	Required or Optional	Description
-i, --initiator-group-uuid string		ID of the Initiator group.
-n, --name string		Name for the Initiator Group

Table 59. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi initiatior-group command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi allowlist Command

Displays the list of commands available in the iSCSI allowlist namespace.

hxcli iscsi allowlist [flags]

Aliases

You can also use the alias "al" as a shortcut to specify allowlist.

hxcli iscsi al [flags]

Table 60. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for iSCSI allowlist commands.

Table 61. Command History
Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi allowlist command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi allowlist add Command

Allows you to add IPs to iSCSI allow list.

hxcli iscsi allowlist add [flags]

Table 62. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for iSCSI allowlist add command.
-p, --ips stringArray		Displays the list of IPs to be allowed
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 63. Command History
Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi allowlist add command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi allowlist clear Command

Allows you to clear IPs on the iSCSI allow list.

hxcli iscsi allowlist clear [flags]

Table 64. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for iSCSI allowlist clear command.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 65. Command History
Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi allowlist clear command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi allowlist remove Command

Allows you to remove IPs to iSCSI allow list.

hxcli iscsi allowlist remove [flags]

Table 66. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for iSCSI allowlist remove command.
-p, --ips stringArray		Displays list of the IPs to be removed
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 67. Command History
Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi allowlist remove command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi allowlist show Command

Displays list of IPs on the iSCSI allow list.

hxcli iscsi allowlist show [flags]

Table 68. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for iSCSI allowlist show command.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 69. Command History
Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi allowlist show command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi lun Command

Displays the configuration information for the iSCSI LUN command.

hxcli iscsi lun [-h] {clone | create | delete | edit | info | list }

Syntax Description


Option	Required or Optional	Description
clone	Required	Clones an existing iSCSI LUN.
create	Required	Creates a new iSCSI LUN.
delete	Required	Deletes an existing iSCSI LUN.
edit	Required	Provides means to edit the name or size of the selected LUN.
info	Required	Displays configuration info about an existing iSCSI LUN
list	Required	Lists iSCSI LUNs on the network.

Table 70. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi lun command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi lun info Command

Displays detailed information about the name of the LUN, status, LUN ID, and size, available and used space for the specified LUN.

hxcli iscsi lun info [-h] { --lunUuid string | --output string | --targetUuid string }

Syntax Description


Option	Required or Optional	Description
-l, --lunUuid string		LUN uuid.
-o, --output string		Output format. Valid values: json, yaml, and wide. The default is wide.
-t, --targetUuid string		Target uuid.

Table 71. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi lun command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi lun list Command

Displays information about LUNS on the target.

hxcli iscsi lun list [-h] { --limit int| --offset int | --order string | --output string | --targetUuid string}

Syntax Description


Option	Required or Optional	Description
-l, --limit int		Limit of the number of list. The default is 10.
-f, --offset int		Offset of the list.
-r, --order string		Ascending or descending order of list. Valid values: ASCEND, DESCEND. The default is DESCEND.
-o, --output string		Output format. Valid values: json, yaml, and wide. The default is wide.
-t, --targetUuid string		Target uuid.

Table 72. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi lun command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi lun create Command

Creates an iSCSI LUN.

hxcli iscsi lun clone [-h] [--payload string | --targetUuid string]

Syntax Description


Option	Required or Optional	Description
-p, --payload string		Payload for the LUN.
-t, --targetUuid string		Defines the target UUID.

Table 73. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi lun create command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi lun edit Command

Provides means to edit the name or size of the selected LUN.

hxcli iscsi lun edit [-h] { --lunUuid string | --output string | --payload string | --targetUuid string}

Syntax Description


Option	Required or Optional	Description
-l, --lunUuid string		LUN uuid
-o, --output string		Output format. Valid values: json, yaml, and wide. The default is wide.
-p, --payload string		Payload for create LUN.
-t, --targetUuid string		Target uuid.

Table 74. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi lun command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi lun delete Command

Deletes the selected LUN.

hxcli iscsi lun delete [-h] {--lunUuid string | --targetUuid string}

Syntax Description


Option	Required or Optional	Description
-l, --lunUuid string		LUN uuid
-t, --targetUuid string		Target uuid

Table 75. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi lun command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli iscsi lun clone Command

Use this command to clone iSCSI LUNs.

hxcli iscsi lun clone [-h] [--payload | --vss-username string]

Syntax Description


Option	Required or Optional	Description
-p, --payload string		iSCSI LUNs payload.
-u, --vss-username string		Username used to authenticate with Volume Shadow copy Service.

Table 76. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli iscsi lun clone command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli volume Command

Displays the list of commands available in the volume namespace.

hxcli volume [flags]

Table 77. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for volume commands.

Table 78. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli volume command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli volume info Command

Displays detailed information about the name of the datastore, namespace, capacity, target details, datastore id of the specified volume.

hxcli volume info [flags]

Table 79. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for volume info command.
-n, --name string		Displays the Volume name.
-t, --clientid string		Displays the Client ID.
-i, --id string		Displays the Volume ID.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 80. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli volume info command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli volume list Command

Lists information about the volume including the volume id, namespace, capacity, target details, datastore id.

hxcli volume list [flags]

Table 81. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for volume list command.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 82. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli volume list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli volume stats Command

Displays volume capacity and space savings.

hxcli volume stats [flags]

Table 83. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for volume stats command.
-t, --clientid string		Displays the Client ID
-i, --id string		Displays the Volume id
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 84. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command default

None.

Usage Guidelines

Accompany the hxcli volume stats command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli volume edit Command

Allows you to reconfigure the size of a volume.

hxcli volume edit [flags]

Table 85. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for volume edit command.
-c, --capacity int		Displays the capacity of the datastore in Bytes.
-t, ----clientid string		Displays the Client ID.
-i, --id string		Displays the Volume ID.
-n, --name string		Displays the new name of the volume.
-s, --namespace string		Displays the namespace of the volume.
-r, --serialNo string		Displays the LUN serial number.
-t, --targetName string		Displays the Target Name.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 86. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli volume edit command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli volume delete Command

Allows you to delete the selected volume.

hxcli volume delete [flags]

Table 87. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for volume delete command.
-t, --clientid string		Displays the Client ID.
-i, --id string		Displays the Volume ID.
-n, --name string		Displays the name of the volume.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 88. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli volume delete command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli volume allowlist Command

Allows you to grant access for the IP.

hxcli volume allowlist [flags]

Table 89. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for volume allowlist command.

Table 90. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli volume allowlist command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli volume allowlist create Command

Allows you to add IPs to allow list to grant access.

hxcli volume allowlist create [flags]

Table 91. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for volume allowlist create command.
-c, --clientid string		Displays the Client ID.
-u, --payload string		Displays the Payload for granting access to IP.
-t, --task string		Allows you to ADD or REMOVE IP from the allow list. The default value is ADD.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 92. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli volume allowlist create command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli node Command

Displays the list of commands available in the node namespace.

hxcli node {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for node commands.

Table 93. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli node command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli node info Command

Displays detailed information about the specified node in the storage cluster.

hxcli node info {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for the node info command.
-i, --ip string		Node UUID
-p, --ip-address string		Hypervisor Address
-n, --name string		Node name
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 94. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli node info command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli node list Command

Lists the nodes in the storage cluster. Displays detailed information about the name of the node, hypervisor address and status, controller address and status, and the model.

hxcli node list {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for the node list command.
--no-header		When using the default or custom-column output format, don't print headers (default print headers).
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 95. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli node list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli security Command

Displays the list of commands available in the security namespace.

hxcli security {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for security commands.

Table 96. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli security command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli security password Command

Displays the list of commands available in the security namespace.

hxcli security password {flags}

Syntax Description


Option	Required or Optional	Description
-h, --help		Displays help for the security password command.

Table 97. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli security password command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli security password set Command

Sets user password for all the controller VMs in the storage cluster.

hxcli security password set [-h][--user string][--user diag]

Syntax Description


Option	Required or Optional	Description
-h, --help	Optional	Displays help for the security password set command.
--user string	Optional	User name (default "root").
--user diag	Optional	Admin user account with escalated privileges designed for troubleshooting

Table 98. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).
5.0(2a)	This command was modified. The diag keyword was added.

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli security password set command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services Command

Displays the list of commands available in the services namespace.

hxcli services [flags]

Table 99. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for services commands.

Table 100. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli services command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services asup Command

Displays the list of all ASUP commands.

hxcli services asup [flags]

Table 101. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for ASUP commands.

Table 102. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli services asup command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services asup list Command

Displays extended ASUP info - RecipientList (if enabled)

hxcli services asup list [flags]

Table 103. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for the ASUP list command.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 104. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli services asup list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services dns Command

Displays the list of commands available in the DNS namespace.

hxcli services dns [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for dns		Displays help for the services dns command.

Table 105. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli services dns command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services dns list Command

Lists the DNS servers available in the storage cluster.

hxcli services dns list [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for list		Displays help for the services dns list command.
-o, --output string Output format. One of: [json\|yaml\|wide] (default "wide")		The output format. One of: [json\|yaml\|wide] (default "wide").

Table 106. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli services dns list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services dns add Command

Adds servers to the DNS server list.

Note

Use this command when the cluster is offine.

hxcli services dns add [<space seperated ip addresses>] [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for add		Displays help for the services dns add command.

Table 107. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli services dns add command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services dns clear Command

Use the command to remove one or more, or all DNS servers from the existing list of servers in the DNS server list.

Note

Use this command when the cluster is offine.

hxcli services dns clear [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for clear		Displays help for the services dns clear command.

Table 108. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli services dns clear command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services dns set Command

Deletes and replaces the existing list of servers in the DNS server list.

Note

Use this command when the cluster is offine.

hxcli services dns set [<space seperated ip addresses>] [flags]

Table 109. Syntax Description
Option	Required or Optional	Description
-h, --help help for set		Displays help for services dns set command.

Table 110. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli services dns set command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services ntp Command

Displays the list of commands available in the NTP namespace.

hxcli services ntp [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for ntp		Displays help for the services ntp command.

Table 111. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli services ntp command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services ntp list Command

Lists the NTP servers available in the storage cluster.

hxcli services ntp list [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for list	required/optional	Displays help for the services ntp list command.
-o, --output string Output format. One of: [json\|yaml\|wide] (default "wide")		The output format. One of: [json\|yaml\|wide] (default "wide").

Table 112. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli services ntp list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services ntp add Command

Adds one or more NTP servers to the list of DNS servers.

Note

Use this command when the cluster is offine.

hxcli services ntp add [<space seperated ip addresses>] [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for add		Displays help for the services ntp add command.

Table 113. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli services ntp add command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services ntp clear Command

Use the command to remove one or more, or all NTP servers from the existing list of servers in the DNS server list.

Note

Use this command when the cluster is offine.

hxcli services ntp clear [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for clear		Displays help for the services ntp clear command.

Table 114. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli services ntp clear command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services ntp set Command

Deletes and replaces the existing list of servers in the NTP server list.

Note

Use this command when the cluster is offine.

hxcli services ntp set [<space seperated ip addresses>] [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for set		Displays help for the services ntp set command.

Table 115. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli services ntp set command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services timezone Command

Displays the list of commands available in the TimeZone namespace.

hxcli services timezone [flags]

Table 116. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for TimeZone commands.

Table 117. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli services timezone command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services timezone list Command

Displays time zone configured in the system.

hxcli services timezone list [flags]

Table 118. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for the time zone list command.
-o, --output string		Output format. One of: [json\|yaml\|wide] (default "wide")

Table 119. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli services timezone list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli services timezone edit Command

Enables you to set time zone in the system.

hxcli services timezone edit[flags]

Table 120. Syntax Description
Option	Required or Optional	Description
-h, --help		Displays help for the set time zone command.
-t, --timezone string		New time zone value.

Table 121. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

None.

Usage Guidelines

Accompany the hxcli services timezone edit command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli tasks Command

Displays the list of commands available in the task namespace.

hxcli tasks [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for tasks		Displays help for the tasks command.

Table 122. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli tasks list command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli tasks info Command

Displays detailed information related to the tasks completed in the storage cluster.

hxcli tasks info [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for info		Displays help for the tasks info command.
-h, --help help for info		The task ID.
-h, --help help for info		The output format. One of: [json\|yaml\|wide] (default "wide").

Table 123. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli tasks info command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli tasks list Command

Displays detailed information related to the tasks completed in the storage cluster.

hxcli tasks list [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for info		Displays help for the tasks list command.
-h, --help help for info		The task ID.
-h, --help help for info		The output format. One of: [json\|yaml\|wide] (default "wide").

Table 124. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the stcli services asup command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli tasks watch Command

View the tasks being executed in the storage cluster.

hxcli tasks watch [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for info		Displays help for the tasks watch command.
-h, --help help for info		The task ID.
-h, --help help for info		The output format. One of: [json\|yaml\|wide] (default "wide").

Table 125. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli tasks watch command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli vcenter Command

Displays the list of commands available in the vCenter namespace.

hxcli vcenter [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for vcenter		Displays help for the vcenter command.

Table 126. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli vcenter command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli vcenter info Command

Displays detailed information about the cluster name, vCenter URL, vCenter clustername and ID, and vCenter datacenter name and ID.

hxcli vcenter info [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for info		Displays help for the vcenter info command.
-o, --output string		The output format. One of: [json\|yaml\|wide] (default "wide").

Table 127. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the stcli services asup command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

hxcli version Command

Displays the HX CLI version.

hxcli version [flags]

Syntax Description


Option	Required or Optional	Description
-h, --help help for version		Displays help for the version command.

Table 128. Command History
HX Release	Modification
4.5(1a)	This command was introduced in Cisco HX Release 4.5(1a).

Command Default

Default (or None.)

Usage Guidelines

Example: Accompany the hxcli version command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

Bias-Free Language

Results

Chapter: hxcli Commands

hxcli Commands

hxcli Commands

Command Default

Usage Guidelines

hxcli cluster Command

Syntax Description

Command Default

Usage Guidelines

hxcli cluster about Command

Syntax Description

Command Default

Usage Guidelines

hxcli cluster detail Command

Syntax Description

Command Default

Usage Guidelines

hxcli cluster health Command

Syntax Description

Command Default

Usage Guidelines

hxcli cluster info Command

Syntax Description

Command Default

Usage Guidelines

hxcli cluster shutdown Command

Syntax Description

Command Default

Usage Guidelines

hxcli cluster start Command

Syntax Description

Command Default

Usage Guidelines

hxcli cluster stats Command

Syntax Description

Command Default

Usage Guidelines

hxcli cluster Command

Syntax Description

Command Default

Usage Guidelines

hxcli dataprotection Command

Syntax Description

Command Default

Usage Guidelines

hxcli dataprotection network Command

Syntax Description

Command Default

Usage Guidelines

hxcli dataprotection network edit Command

Syntax Description

Command Default

Usage Guidelines

hxcli dataprotection network info Command

Syntax Description

Command Default

Usage Guidelines

hxcli dataprotection svgroup Command

Syntax Description

Command Default

Usage Guidelines

hxcli dataprotection svgroup create Command

Alias

Syntax Description

Command Default

Usage Guidelines

hxcli dataprotection svgroup delete Command

Alias

Syntax Description

Command Default

Usage Guidelines

hxcli dataprotection svgroup list Command

Alias

Syntax Description

Command Default

Usage Guidelines

hxcli dataprotection svgroup snapshot Command