stcli dp (data protection) Commands

stcli dp Commands

Data protection (DP) commands for replication and disaster recovery.

stcli dp [-h] (vm | group | peer | schedule)

Syntax Description


Option	Required or Optional	Description
group	One of set required.	Data protection group snapshot operations.
peer	One of set required.	Site replication pairing operations.
schedule	One of set required.	Pause and resume replication, cluster wide for the sending cluster.
vm	One of set required.	VM data protection with replication snapshot operations.

Command Default

None. One option from the set is required.

Usage Guidelines

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

stcli dp group Commands

HX Data Platform disaster recovery and native replication commands applied to virtual machine protection groups and not to individual virtual machines.

stcli dp group [-h] {add | list | delete | vm | snapshot | schedule}

Syntax Description


Option	Required or Optional	Description
add	One of set required.	Add data protection group.
list	One of set required.	List of data protection groups.
delete	One of set required.	Delete data protection group.
vm	One of set required.	VM tasks in a data protection group.
snapshot	One of set required.	Snapshot operations in a data protection group. This command is not supported.
schedule	One of set required.	Schedule replication for a data protection group.

Command Default

None. One option from the set is required.

Usage Guidelines

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

stcli dp group add Command

Add data protection group.

stcli dp group add [-h] --groupname GROUPNAME

Syntax Description


Option	Required or Optional	Description
--groupname GROUPNAME	Required.	Name of the protection group.

Command Default

None.

Usage Guidelines

Accompany the stcli dp group add command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

stcli dp group delete Command

Delete the specified data protection group.

stcli dp group delete [-h] --groupid GROUPID

Syntax Description


Option	Required or Optional	Description
--groupid GROUPID	Required.	ID of the protection group. To delete a protection group, all virtual machines must be removed.

Command Default

None.

Usage Guidelines

Accompany the stcli dp group delete command with the required arguments with leading two dashes (--), or optionally, the arguments enclosed in [ ].

stcli dp group list Command

List data protection group configuration and schedule.

stcli dp group list [-h] [--groupname GROUPNAME] [--groupid GROUPID]

Syntax Description


Option	Required or Optional	Description
--groupname GROUPNAME	Optional.	List the protection group with given group name.
--groupid GROUPID	Optional.	List the protection group with given ID.

Command Default

List all data protection groups.

Usage Guidelines

Accompany the stcli dp group list command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

This example shows a list of data protection groups.

# stcli dp group list

clusterEr:
    type: cluster
    id: 21038104951568023:6930626691413900957
    name: source17-2.5.1a
vmGroupState: active
vmGroupEr:
    type: dp_vmgroup
    id: 4de5d40f-82d6-40f6-9425-e4942bdd9be9
    name: group1
members:
    ----------------------------------------
    idtype: 2
    type: dp_vm
    id: 423f38fd-9754-a25c-0d60-1ddacacaac60
    ----------------------------------------
    idtype: 2
    type: dp_vm
    id: 423fc732-4841-3a0a-8d75-6c7bdcf8de67
    ----------------------------------------
schedules:
    replicationSchedule:
        targetClusterEr:
            type: cluster
            id: 1279191129902762643:7329250794747596775
            name: target17-2.5.1a
        enabled: True
        mode: 2
        startTime: 07/19/17_20:24
        intervalInMinutes: 15

stcli dp group vm Commands

Hyperflex data protection group VM operations.

stcli dp group vm [-h] {add | list | delete}

Syntax Description


Option	Required or Optional	Description
add	One of set required.	Add VM to data protection group.
list	One of set required.	List VMs in data protection group.
delete	One of set required.	Delete VM from data protection group.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli dp group vm command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp group vm add Command

Add a VM to a data protection group.

stcli dp group vm add [-h] --groupid GROUPID --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}]

Syntax Description


Option	Required or Optional	Description
--groupid GROUPID	Required.	ID of the data protection group where the VMs reside.
--vmid VMID	Required.	ID of the virtual machine to add to the protection group.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	ID type for the virtual machine to add to the protection group. The VCMOID option is not supported.

Command Default

None.

Usage Guidelines

Accompany the stcli dp group vm add command with optionally, the arguments enclosed in [ ].

stcli dp group vm delete Command

Delete a protection group VM.

stcli dp group vm delete [-h] --groupid GROUPID --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}]

Syntax Description


Option	Required or Optional	Description
--groupid GROUPID	Required.	ID of the data protection group where the VMs reside.
--vmid VMID	Required.	ID of the virtual machine to be removed from the protection group.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	ID type of the virtual machine to be removed from the protection group. Remove a VM from data protection group. The VCMOID option is not supported.

Command Default

None.

Usage Guidelines

Accompany the stcli dp group vm add command with optionally, the arguments enclosed in [ ].

stcli dp group vm list Command

List the VMs included in the data protection group.

stcli dp group vm list [-h] --groupid GROUPID

Syntax Description


Option	Required or Optional	Description
--groupid GROUPID	Required.	ID of the data protection group where the VMs reside.

Command Default

None.

Usage Guidelines

Accompany the stcli dp group vm list command with optionally, the arguments enclosed in [ ].

stcli dp group schedule Commands

Hyperflex protection group schedule operations.

stcli dp group schedule [-h] {set | get}

Syntax Description


Option	Required or Optional	Description
set	One of set required.	Set the replication schedule for a data protection group.
get	One of set required.	Get the replication schedule for a data protection group.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli dp group schedule command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp group schedule get Command

List the replication schedule information for a data protection group.

stcli dp group schedule get [-h] --groupid GROUPID [--outgoing OUTGOING]

Syntax Description


Option	Required or Optional	Description
--groupid GROUPID	Required.	ID of the data protection group where the VMs reside.
--outgoing OUTGOING	Optional.	ID of the outgoing/target cluster where data is replicated to.

Command Default

Outgoing cluster is the paired remote cluster.

Usage Guidelines

Accompany the stcli dp group schedule get command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp group schedule set Command

Set the replication schedule for a data protection group.

stcli dp group schedule set [-h] --groupid GROUPID --replication-interval REPINTERVALINMINS [--start-time REPSTARTTIME] [--quiesce-using-tools] [--outgoing OUTGOING]

Syntax Description


Option	Required or Optional	Description
--groupid GROUPID	Required.	ID of the data protection group where the VMs reside.
--replication-interval REPINTERVALINMINS	Required.	Replication interval (frequency) in minutes. This sets how often the VMs are replicated to the target cluster.
--start-time REPSTARTTIME	Optional.	Replication start time in format `mm/dd/yy_HH_MM.` Specifies when the first replication begins.
--quiesce-using-tools	Optional.	Whether to use VMware Tools to quiesce the VMs before replication. VMware Tools must be installed in all the VMs in the replication group.
--outgoing OUTGOING	Optional.	ID of the outgoing/target cluster where data is replicated to.

Command Default

Start time is immediately upon execution of the command. Quiesce is not set. Outgoing cluster is the paired remote cluster.

Usage Guidelines

Accompany the stcli dp group schedule set command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp group snapshot Commands

HX Data Platform data protection group snapshot operations.

Note

This command is not supported.

stcli dp group snapshot [-h] {create}

Syntax Description


Option	Required or Optional	Description
create	Required.	Creates a data protection snapshot of all the VMs in the given protection group.

Command Default

None.

Usage Guidelines

Accompany the stcli dp group snapshot command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp group snapshot create Command

Creates data protection replication snapshots of the VMs in the given group.

Note

This command is not supported.

stcli dp group snapshot create [-h] --groupid GROUPID --snapshot SNAPSHOT [--desc DESC] [--quiesce]

Syntax Description


Option	Required or Optional	Description
--groupid GROUPID	Required.	ID of the data protection group where the VMs reside.
--snapshot SNAPSHOT	Required.	Name of the snapshot.
--desc DESC	Optional.	Description of the snapshot.
--quiesce	Optional.	Whether to use VMware Tools to quiesce the VMs before replication. VMware Tools must be installed in all the VMs in the replication group.

Command Default

Description is blank. Quiesce is not set.

Usage Guidelines

Accompany the stcli dp group snapshot create command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp peer Commands

Hyperflex data protection operations on the remote (peer) cluster in a replication pair.

stcli dp peer [-h] {get | add | list | query | edit | datastore | delete | forget | schedule}

Syntax Description


Option	Required or Optional	Description
get	One of set required.	Get peer cluster details.
add	One of set required.	Add a pair using given inputs.
list	One of set required.	Show all pairs.
query	One of set required.	Query a pair to get pair-details.
edit	One of set required.	Edit pair description for peer management IP.
datastore	One of set required.	Edit mapped datastores in existing pair.
delete	One of set required.	Delete a replication pair.
forget	One of set required.	Forget peer using given inputs.
schedule	One of set required.	Peer schedule operations.

Command Default

None. One option from the set is required.

Usage Guidelines

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

stcli dp peer add Command

Add a replication pair using given inputs.

Attention

Please enter password when prompted.

Note

This command does not invoke and verify the Test Remote Replication Network similar to the verification process that gets done automatically while configuring replication pair in HX Connect.

stcli dp peer add [-h] --name NAME --description DESCRIPTION --mgmtIp MGMTIP --username USERNAME

Syntax Description


Option	Required or Optional	Description
--name NAME	Required.	Name of cluster-pair.
--description DESCRIPTION	Required.	Description of cluster-pair.
--mgmtIp MGMTIP	Required.	Peer cluster's management IP.
--username USERNAME	Required.	Peer cluster's user name. Enter peer cluster's password when prompted.

Command Default

None.

Usage Guidelines

Accompany the stcli dp peer get command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

stcli dp peer datastore Commands

Edit mapped datastores in existing replication pair.

Note

This command does not invoke and verify the Test Remote Replication Network similar to the verification process that gets done automatically while editing the pair in HX Connect.

stcli dp peer datastore [-h] {edit | editstatus}

Syntax Description


Option	Required or Optional	Description
edit	One of set required.	Edit pair description or peer management IP.
editstatus	One of set required.	Status of datastore edit job.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli dp peer datastore command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp peer datastore edit Command

Edit mapped datastores in existing replication pair.

stcli dp peer datastore edit [-h] --name NAME --datastore DATASTORE

Syntax Description


Option	Required or Optional	Description
--name NAME	Required.	Name of cluster-pair.
--datastore DATASTORE	Required.	Datastore pairs with operations. Format is: `local_ds:remote_ds:OPERATION` Operation choices are: `ADD`, `DELETE`.

Command Default

None.

Usage Guidelines

Accompany the stcli dp peer datastore edit command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

This example shows changing the datastores associated with the replication pair.

# stcli dp peer datastore edit

<local ds 1>:<peer ds 1>:ADD,<local ds 2>:<peer ds 2>:DELETE,..

stcli dp datastore editstatus Command

View the status of the datastore mapping change for the replication pair.

stcli dp peer datastore editstatus [-h] [--jobid JOBID]

Syntax Description


Option	Required or Optional	Description
--jobid JOBID	Optional.	Job ID for a datastore change task.

Command Default

Job ID default is all displays status of all datastore edits.

Usage Guidelines

Accompany the stcli dp peer datastore editstatus command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

This example shows changing the datastores associated with the replication pair.

# stcli dp peer datastore editstatus

[<jobid>,<jobid>...,<jobid>]

stcli dp peer delete Command

Delete the peer from the replication pair.

Important

Please enter password when prompted.

stcli dp peer delete [-h] --name NAME --username USERNAME [--mgmtIp MGMTIP]

Syntax Description


Option	Required or Optional	Description
--name NAME	Required.	Name of cluster replication pair.
--username USERNAME	Required.	Peer cluster's user name. Enter peer cluster's user password when prompted.
--mgmtIp MGMTIP	Optional.	Peer cluster's management IP.

Command Default

Management IP is assumed to be the currently associated peer.

Usage Guidelines

Accompany the stcli dp peer delete command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

stcli dp peer edit Command

Edit pair description or peer mgmtIp

Note

This command is not supported.

stcli dp peer edit [-h] --name NAME [--description DESCRIPTION] [--mgmtIp MGMTIP] --username USERNAME

Syntax Description


Option	Required or Optional	Description
--name NAME	Required.	Name of cluster-pair
--description DESCRIPTION	Required	Description of cluster-pair
--mgmtIp MGMTIP	Required	Peer cluster's management Ip
--username USERNAME	Required	Peer cluster's user name Enter peer cluster's user password when prompted.

Command Default

None.

Usage Guidelines

Accompany the stcli dp peer edit command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp peer forget Command

This removes the pairing between peers: the source and target clusters. Freeing up each cluster to be paired with a different cluster.

stcli dp peer forget [-h] [--name NAME] [--all]

Syntax Description


Option	Required or Optional	Description
--all	One of set required.	Remove the pairing between peers, for all partially-paired and successfully paired clusters.
--name NAME	One of set required.	Remove the pairing between peers, (the source and target clusters), for the cluster pair with the listed name.

Command Default

None.

Usage Guidelines

Accompany the stcli dp peer forget command the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

stcli dp peer get Command

List the peer cluster details.

Note

Please enter password when prompted.

stcli dp peer get [-h] --mgmtIp MGMTIP --username USERNAME

Syntax Description


Option	Required or Optional	Description
--mgmtIp MGMTIP	Required.	Peer cluster's management IP.
--username USERNAME	Required.	Peer cluster's user name. Enter peer cluster's user password when prompted.

Command Default

None.

Usage Guidelines

Accompany the stcli dp peer get command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

stcli dp peer list Command

Show all replication pairs.

stcli dp peer list [-h]

Command Default

None.

Usage Guidelines

Accompany the stcli dp peer list command with optionally, the arguments enclosed in [ ].

stcli dp peer query Command

Query a replication pair for pair details.

stcli dp peer query [-h] --name NAME

Syntax Description


Option	Required or Optional	Description
--name NAME	Required.	Name of cluster replication pair.

Command Default

None.

Usage Guidelines

Accompany the stcli dp peer query command with optionally, the arguments enclosed in [ ].

stcli dp peer schedule Commands

Hyperflex remote (peer) cluster schedule operations.

Note

This command and its subcommands are not supported.

stcli dp peer schedule [-h] {pause,resume}

Syntax Description


Option	Required or Optional	Description
pause	One of set required.	Pause replication. Stop sending data replication bits from the remote cluster.
resume	One of set required.	Resume replication. Resume sending data replication bits from the remote cluster.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli dp peer schedule command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp peer schedule pause Command

Pause replication. Stop monitoring existing jobs and stop creating new jobs sending replication snapshot bits to the remote cluster.

Note

This command is not supported.

stcli dp peer schedule pause [-h]

Command Default

None.

Usage Guidelines

Accompany the stcli dp peer schedule pause command with optionally, the arguments enclosed in [ ].

stcli dp peer schedule resume Command

Resume replication. Resume monitoring existing jobs and resume creating new jobs sending data replication bits to the remote cluster.

Note

This command is not supported.

stcli dp peer schedule resume [-h]

Command Default

None.

Usage Guidelines

Accompany the stcli dp peer schedule resume command with optionally, the arguments enclosed in [ ].

stcli dp schedule Commands

Data protection schedule operations.

stcli dp schedule [-h] {pause | resume | status}

Syntax Description


Option	Required or Optional	Description
pause	One of set required.	Pause replication. Stop sending replication snapshot bits to the remote cluster.
resume	One of set required.	Resume replication. Resume sending replication snapshot bits to the remote cluster.
status	One of set required.	Query the scheduler state. That is the database state, not the status of scheduled events. It does not imply that the scheduler is full.

Command Default

None. One option from the set is required.

Usage Guidelines

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

stcli dp schedule pause Command

Pause replication. Stop monitoring existing jobs and stop creating new jobs sending replication snapshot bits to the remote cluster.

stcli dp schedule pause [-h]

Command Default

None.

Usage Guidelines

Accompany the stcli dp schedule pause command optionally, the arguments enclosed in [ ].

stcli dp schedule resume

Resume replication. Resume monitoring existing jobs and resume creating new jobs sending data replication bits to the remote cluster.

stcli dp schedule resume [-h]

Command Default

None.

Usage Guidelines

Accompany the stcli dp schedule resume command optionally, the arguments enclosed in [ ].

stcli dp schedule status

Query the scheduler state. That is the database state, not the status of scheduled events. It does not imply that the scheduler is full.

stcli dp schedule status [-h]

Command Default

None.

Usage Guidelines

Accompany the stcli dp schedule status command optionally, the arguments enclosed in [ ].

stcli dp vm Commands

HX Data Platform disaster recovery and native replication commands applied to virtual machines individually and not through the protection group.

stcli dp vm [-h] {add | list | info | delete | schedule | failover | testfailover | hxtask}

Syntax Description


Option	Required or Optional	Description
add	One of set required.	Add data protection to a virtual machine.
clone	Unsupported	This command is not supported.
delete	One of set required.	Delete data protection from a virtual machine.
info	One of set required.	Display information about virtual machines under data protection.
list	One of set required.	List virtual machines under data protection.
restore	Unsupported	This command is not supported.
schedule	One of set required.	Schedule data protection for a virtual machine.
snapshot	Unsupported	This command is not supported.
failover	One of set required.	Failover the individual virtual machines from the recovery HX Storage Cluster.
testfailover	One of set required.	Test recovery of individual virtual machines from the recovery HX Storage Cluster.
hxtask	One of set required.	Data protection related operations.

Command Default

None. One option from the set is required.

Usage Guidelines

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

stcli dp vm add Command

Add data protection on a virtual machine.

stcli dp vm add [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID. ID of the virtual machine (vcmoid, vmbiosuuid). If using vCenter VCMOID, specify the unique virtual machine VMBIOSUUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. ID the type of the virtual machine (vcmoid, vmbiosuuid). If using vCenter VCMOID, specify the unique virtual machine VMBIOSUUID. The VCMOID option is not supported.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm add command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

stcli dp vm clone Commands

HyperFlex virtual machine clone operations.

Note

This command and its subcommands are not supported.

stcli dp vm clone [-h] {now,list}

Syntax Description


Option	Required or Optional	Description
now	Required one of set.	Clone and restore as the given virtual machine.
list	Required one of set.	List clones available on this cluster.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm clone command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp vm clone list Command

List clones available on this cluster.

Note

This command is not supported.

stcli dp vm clone list [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}] [--clone-id CLONEID]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.
--clone-id CLONEID	Optional.	Clone id of the virtual machine.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm clone list command with the required arguments with leading two dashes (--), one of the positional arguments enclosed in { }, or optionally, the arguments enclosed in [ ].

stcli dp vm clone now Command

Clone and restore as the given virtual machine.

Note

This command is not supported.

stcli dp vm clone now [-h] (--snapid SNAPSHOTID | --latest {LATEST,LATESTSNAPSHOT}) --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}] --newname NEWVMNAME [--rpid RESOURCEPOOLID | --rpname RESOURCEPOOLNAME] [--fdid FOLDERID | --fdname FOLDERNAME]

Syntax Description


Option	Required or Optional	Description
--snapid SNAPSHOTID	Required one of set.	Snapshot ID of the VM to clone from.
--latest {LATEST,LATESTSNAPSHOT}	Required one of set.	Latest snapshot of the VM to clone from. Options: `LATEST` or `LATESTSNAPSHOT` for the snapshot ID.
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.
--newname NEWVMNAME	Required.	Assign the new VM clone this name.
--resourcepool-id RESOURCEPOOL-ID	One of optional pair.	Place the recovered VM(s) on the resource pool with the listed ID. Set either resource pool or folder, not both.
--resourcepool-name RESOURCEPOOL-NAME	One of optional pair.	Place the recovered VM(s) on the resource pool with the listed name. Set either resource pool or folder, not both.
--folder-id FOLDER-ID	One of optional pair.	Place the recovered VM(s) in the folder with the listed ID. Set either resource pool or folder, not both.
--folder-name FOLDER-NAME	One of optional pair.	Place the recovered VM(s) in the folder with the listed name. Set either resource pool or folder, not both.
If using resource pool, rpid or folder, fdid, only use one of rpid or fdid, do not specify both. After the clone completes, then you can add the other grouping, folder or resource pool.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm clone now command with the required arguments with leading two dashes (--), one of the positional arguments enclosed in { }, or optionally, the arguments enclosed in [ ].

stcli dp vm delete Command

Delete data protection from a virtual machine.

stcli dp vm delete [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID. ID of the virtual machine (vcmoid, vmbiosuuid). If using vCenter VCMOID, specify the unique virtual machine VMBIOSUUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. ID the type of the virtual machine (vcmoid, vmbiosuuid). If using vCenter VCMOID, specify the unique virtual machine VMBIOSUUID. The VCMOID option is not supported.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm delete command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

stcli dp vm hxtask Command

Data protection related operations.

stcli dp vm hxtask [-h] [--vmid VMID] [--id ID] [--name NAME][--state {new,starting,running,suspended,shutting_down,completed,terminated,cancelled,exception,stalled}]

Syntax Description


Option	Required or Optional	Description
– vmid VMID	Required	ID of the virtual machine.
--id ID	Optional	ID of the hxtask.
--name NAME	Optional.	Name of the task. The name to be filtered are: testFailover failover prepareReverseProtect prepareFailover reverseProtect
--state	Optional.	State of the replication process: new starting running suspended shutting_down completed terminated canceled exception stalled

Command Default

None. One option from the set is required.

stcli dp vm info Command

List the data protection virtual machine information.

stcli dp vm info [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID. ID of the virtual machine (vcmoid, vmbiosuuid). If using vCenter VCMOID, specify the unique virtual machine VMBIOSUUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. ID the type of the virtual machine (vcmoid, vmbiosuuid). If using vCenter VCMOID, specify the unique virtual machine VMBIOSUUID. The VCMOID option is not supported.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm info command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

stcli dp vm list Command

List virtual machines with data protection. Display includes replication schedule.

stcli dp vm list [-h] [--vmname VMNAME] [--vmid VMID] [--brief]

Syntax Description


Option	Required or Optional	Description
--vmname VMNAME	Optional.	Lists the protected virtual machine that matches the specified name.
--vmid VMID	Optional.	Run command on the virtual machine that matches the specified BIOS UUID.
--brief	Optional.	Display brief summary only.

Command Default

Defaut lists all protected virtual machines.

Usage Guidelines

Accompany the stcli dp vm list command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

This example shows a summary list of protected virtual machines.

# stcli dp vm list --brief

vmInfo:
    ----------------------------------------
    name: dslvm-2
    uuid: 423f11c4-20c9-893b-0dd8-2a0ad59ad634
    ----------------------------------------
    name: dslvm-1
    uuid: 423f1d85-990a-4e06-ebef-a215c0ec4cf8
    ----------------------------------------

stcli dp vm failover Command

To failover the individual virtual machines from the recovery HX Storage Cluster. Where the recovery HX Storage Cluster is the target cluster for the replication pair protecting the virtual machines.

This command outputs the JOB-ID that is used for monitoring by the status command.

stcli dp vm failover [-h] --vmid VMID [--resourcepool-id RESOURCEPOOL-ID | --resourcepool-name RESOURCEPOOL-NAME] [--folder-id FOLDER-ID | --folder-name FOLDER-NAME] [--network-mapping NETWORKMAPPING [NETWORKMAPPING ...]] [--poweron] [--force]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--resourcepool-id RESOURCEPOOL-ID	One of optional pair.	Place the recovered VM(s) on the resource pool with the listed ID.
--resourcepool-name RESOURCEPOOL-NAME	One of optional pair.	Place the recovered VM(s) on the resource pool with the listed name.
--folder-id FOLDER-ID	One of optional pair.	Place the recovered VM(s) in the folder with the listed ID.
--folder-name FOLDER-NAME	One of optional pair.	Place the recovered VM(s) in the folder with the listed name.
--network-mapping NETWORKMAPPING [NETWORKMAPPING ...]	Optional.	Map the source to destination network. Format `source_network:destination_network`. For example: `--network-mapping "source_network1:destination_network1","source_network2:destination_network2"`
--poweron	Optional.	Power on the VM after recovery
--force	Optional.	Do not validate the arguments and perform recovery

Command Default

Location defaults to command execution path.

Usage Guidelines

Accompany the stcli dp vm failover command with the required arguments with leading two dashes (--) or optionally, the arguments enclosed in [ ].

stcli dp vm testfailover Command

To test recovery of individual virtual machines from the recovery HX Storage Cluster. Where the recovery HX Storage Cluster is the target cluster for the replication pair protecting the virtual machines.

This command outputs the JOB-ID that is used for monitoring by the status command.

stcli dp vm testfailover [-h] --vmid VMID [--resourcepool-id RESOURCEPOOL-ID | --resourcepool-name RESOURCEPOOL-NAME] [--folder-id FOLDER-ID | --folder-name FOLDER-NAME] [--test-network TESTNETWORK] [--network-mapping NETWORKMAPPING [NETWORKMAPPING ...]] [--poweron] [--force] [--newname NEWNAME]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Lists the virtual machine that matches the specified BIOS UUID.
--resourcepool-id RESOURCEPOOL-ID	One of optional pair.	Place the recovered VM(s) on the resource pool with the listed ID.
--resourcepool-name RESOURCEPOOL-NAME	One of optional pair.	Place the recovered VM(s) on the resource pool with the listed name.
--folder-id FOLDER-ID	One of optional pair.	Place the recovered VM(s) in the folder with the listed ID.
--folder-name FOLDER-NAME	One of optional pair.	Place the recovered VM(s) in the folder with the listed name.
--test-network TESTNETWORK	Optional.	Test network to be used for test recovery. All source networks are assigned to this network after recovery.
--network-mapping NETWORKMAPPING [NETWORKMAPPING ...]	Optional.	Map the source to destination network. Format `source_network:destination_network`. For example: `--network-mapping "source_network1:destination_network1","source_network2:destination_network2"`
--poweron	Optional.	Power on the VM after recovery.
--force	Optional.	Perform recovery without validating the arguments.
--newname NEWNAME	Optional.	New name for the test recovered VM.

Command Default

By default test recovery recovers the VM with the same name in the HxTestRecovery folder.

Usage Guidelines

Accompany the stcli dp vm testfailover command with the required arguments with leading two dashes (--), or optionally, the arguments enclosed in [ ].

stcli dp vm restore Commands

Data protection virtual machine restore operations.

Note

This command and its subcommands are not supported.

stcli dp vm restore [-h] {now,list}

Syntax Description


Option	Required or Optional	Description
now	One of set required.	Restore the given virtual machine.
list	One of set required.	List restores available on this cluster.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli dp vm restore command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp vm restore list Command

List restores available on this cluster.

Note

This command is not supported.

stcli dp vm restore list [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}] [--restore-id RESTORE-ID]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.
--restore-id RESTORE-ID	Optional.	Restore the ID of the VM.

Command Default

Default does not restore the ID for the restored VM.

Usage Guidelines

Accompany the stcli dp vm restore list command with the required arguments with leading two dashes (--), one of the positional arguments enclosed in { }, or optionally, the arguments enclosed in [ ].

stcli dp vm restore now Command

Restore the given virtual machine.

Note

This command is not supported.

stcli dp vm restore now [-h] [--snapid SNAPSHOTID | --latest {LATEST,LATESTSNAPSHOT}] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}] [--rpid RESOURCEPOOLID | --rpname RESOURCEPOOLNAME] [--fdid FOLDERID | --fdname FOLDERNAME]

Syntax Description


Option	Required or Optional	Description
--snapid SNAPSHOTID	Optional.	Snapshot ID of the VM to restore from.
--latest {LATEST,LATESTSNAPSHOT}	Optional.	Latest snapshot of the VM to restore from. Options are: `LATEST` or `LATESTSNAPSHOT` for the snapshot ID.
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.
--rpid RESOURCEPOOL-ID	One of optional pair.	Place the recovered VM(s) on the resource pool with the listed ID. Set either resource pool or folder, not both.
--rpname RESOURCEPOOL-NAME	One of optional pair.	Place the recovered VM(s) on the resource pool with the listed name. Set either resource pool or folder, not both.
--fdid FOLDER-ID	One of optional pair.	Place the recovered VM(s) in the folder with the listed ID. Set either resource pool or folder, not both.
--fdname FOLDER-NAME	One of optional pair.	Place the recovered VM(s) in the folder with the listed name. Set either resource pool or folder, not both.
If using resource pool, rpid or folder, fdid, only use one of rpid or fdid, do not specify both. After the clone completes, then you can add the other grouping, folder or resource pool.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm restore now command with the required arguments with leading two dashes (--), one of the positional arguments enclosed in { }, or optionally, the arguments enclosed in [ ].

stcli dp vm schedule Commands

HyperFlex data protection VM schedule operations.

stcli dp vm schedule [-h] {set,get}

Syntax Description


Option	Required or Optional	Description
--set	Required one of set.	Set VM schedule operations.
--get	Required one of set.	Get VM schedule.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm schedule command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp vm schedule get Command

Get the VM replication schedule information.

stcli dp vm schedule get [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm schedule get command with the required arguments with leading two dashes (--), or optionally, the arguments enclosed in [ ].

stcli dp vm schedule set Command

Set the VM replication schedule.

stcli dp vm schedule set [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}] --replication-interval REPINTERVALINMINS [--start-time REPSTARTTIME] [--quiesce-using-tools] [--outgoing OUTGOING]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.
--replication-interval REPINTERVALINMINS	Required.	Replication interval in minutes
--start-time REPSTARTTIME	Optional	Description of the replication snapshot.
--quiesce-using-tools	Optional	Whether to use VMware Tools to quiesce the VMs before replication. VMware Tools must be installed in all the VMs in the replication group.
--outgoing OUTGOING	Optional	ID of the outgoing/target cluster where data is replicated to.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm snapshot create command with the required arguments with leading two dashes (--), or optionally, the arguments enclosed in [ ].

stcli dp vm snapshot Commands

Data protection virtual machine replication snapshot operations.

Note

This command and its subcommands are not supported.

stcli dp vm snapshot [-h] {create | replicate | list | info | delete}

Syntax Description


Option	Required or Optional	Description
create	One of set required.	Creates a replication snapshot for a virtual machine.
replicate	One of set required.	Replicates a replication snapshot for a virtual machine.
list	One of set required.	List replication snapshots available on this cluster.
info	One of set required.	Show info for a replication snapshot.
delete	One of set required.	Delete the specified replication snapshot.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli dp vm snapshot command with one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp vm snapshot create Command

Creates a replication snapshot for a virtual machine.

Note

This command is not supported.

stcli dp vm snapshot create [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}] --snapname SNAPSHOTNAME [--desc DESCRIPTION] [--quiesce]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.
--snapname SNAPSHOTNAME	Required.	Name of the replication snapshot.
--desc DESCRIPTION	Optional.	Description of the replication snapshot.
--quiesce	Optional.	Whether to use VMware Tools to quiesce the VMs before replication. VMware Tools must be installed in all the VMs in the replication group.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm snapshot create command with the required arguments with leading two dashes (--), one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp vm snapshot delete Command

Delete the specified replication snapshot.

Note

This command is not supported.

stcli dp vm snapshot delete [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}] --snapshot-id SNAPSHOTID

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.
--snapshot-id SNAPSHOTID	Required.	Snapshot ID of the VM to replicate.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm snapshot delete command with the required arguments with leading two dashes (--), one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp vm snapshot info Command

Show info for a replication snapshot.

Note

This command is not supported.

stcli dp vm snapshot info [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}] --snapshot-id SNAPSHOTID

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.
--snapshot-id SNAPSHOTID	Required.	Snapshot ID of the VM to replicate.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm snapshot info command with the required arguments with leading two dashes (--), one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp vm snapshot list Command

List replication snapshots available on this cluster.

Note

This command is not supported.

stcli dp vm snapshot list [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}]

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm snapshot list command with the required arguments with leading two dashes (--), one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp vm snapshot replicate Command

Replicates a replication snapshot of a virtual machine to a remote cluster.

Note

This command is not supported.

stcli dp vm snapshot replicate [-h] --vmid VMID [--vmidtype {VCMOID,VMBIOSUUID}] --snapshot-id SNAPSHOT-ID --outgoing OUTGOING

Syntax Description


Option	Required or Optional	Description
--vmid VMID	Required.	Run command on the virtual machine that matches the specified BIOS UUID.
--vmidtype {VCMOID,VMBIOSUUID}	Optional.	Run the command on the virtual machine that matches the specified ID type. The VCMOID option is not supported.
--snapshot-id SNAPSHOTID	Required.	Snapshot ID of the VM to replicate.
--outgoing OUTGOING	Required.	ID of the outgoing/target cluster where data is replicated to.

Command Default

None.

Usage Guidelines

Accompany the stcli dp vm snapshot replicate command with the required arguments with leading two dashes (--), one of the positional arguments enclosed in { } or optionally, the arguments enclosed in [ ].

stcli dp vm migrate command

Migrates the given VM.

stcli dp vm migrate [-h] --vmid VMID [--resourcepool-id RESOURCEPOOL-ID | --resourcepool-name RESOURCEPOOL-NAME] [--folder-id FOLDER-ID | --folder-name FOLDER-NAME] [--network-mapping NETWORKMAPPING [NETWORKMAPPING ...]] [--poweron]


Option	Required or Optional	Description
-h, --help	Optional	Shows the help message relative to the listed command and exits.
--vmid VMID	Required	VMID BIOS UUID of the virtual machine.
--resourcepool-id RESOURCEPOOL-ID	Optional	ID of the Resource pool to place the recovered VM(s) on.
--resourcepool-name RESOURCEPOOL-NAME	Optional	Name of the Resource pool to place the recovered VM(s) on.
--folder-id FOLDER-ID	Optional	ID of the Folder to place the recovered VM(s) on.
--folder-name FOLDER-NAME	Optional	Name of the Folder to place the recovered VM(s) on.
--network-mapping NETWORKMAPPING [NETWORKMAPPING ...]	Optional	"Source Network" : "Destination Network"
--poweron	Optional	Power on the VM after recovery.

stcli dp vm reverseProtect command

Performs reverse protection action for the given VM.

stcli dp vm reverseProtect [-h] --vmid VMID [--force] [--secondaryOnly]


Option	Required or Optional	Description
-h, --help	Optional	Shows the help message relative to the listed command and exits.
--vmid VMID	Required	VMID BIOS UUID of the virtual machine.
--force	Optional	Do not validate the arguments and perform the operation.
--secondaryOnly	Optional	Execute reverseProtect only on secondary, assumes prepareReverseProtect is completed on primary.

Cisco HyperFlex Data Platform CLI Guide, 3.5

Bias-Free Language

Results

Chapter: stcli dp (data protection) Commands

stcli dp (data protection) Commands

stcli dp Commands

Syntax Description

Command Default

Usage Guidelines

stcli dp group Commands

Syntax Description

Command Default

Usage Guidelines

stcli dp group add Command

Syntax Description

Command Default

Usage Guidelines

stcli dp group delete Command

Syntax Description

Command Default

Usage Guidelines

stcli dp group list Command

Syntax Description

Command Default

Usage Guidelines

stcli dp group vm Commands

Syntax Description

Command Default

Usage Guidelines

stcli dp group vm add Command

Syntax Description

Command Default

Usage Guidelines

stcli dp group vm delete Command

Syntax Description

Command Default

Usage Guidelines

stcli dp group vm list Command

Syntax Description

Command Default

Usage Guidelines

stcli dp group schedule Commands

Syntax Description

Command Default

Usage Guidelines

stcli dp group schedule get Command

Syntax Description

Command Default

Usage Guidelines

stcli dp group schedule set Command

Syntax Description

Command Default

Usage Guidelines

stcli dp group snapshot Commands

Syntax Description

Command Default

Usage Guidelines

stcli dp group snapshot create Command

Syntax Description

Command Default

Usage Guidelines

stcli dp peer Commands

Syntax Description

Command Default

Usage Guidelines

stcli dp peer add Command

Syntax Description

Command Default

Usage Guidelines

stcli dp peer datastore Commands

Syntax Description

Command Default

Usage Guidelines

stcli dp peer datastore edit Command

Syntax Description

Command Default

Usage Guidelines

stcli dp datastore editstatus Command

Syntax Description

Command Default