stcli file clone Commands

stcli file clone Command

Creates a HX clone for the given file.

stcli file clone [-h] --name NAME --clone CLONE [--parentname PARENTNAME] [--replfirst] [--repl] [--readonly] [--thick]

Syntax Description

Option

Required or Optional

Description
--clone CLONE

Required.

Name to assign to the file clone.
--name NAME

Required.

Name of the file to be cloned.
--parentname PARENTNAME

Optional.

Name of the parent file of the file to be cloned.
--replfirst

Optional.

First replication file clone.
--repl

Optional.

Replication file clone.
--readonly

Optional.

Read only file clone.
--thick

Optional.

Thick file clone.

Command Default

None. File name and clone name required.

Usage Guidelines

Accompany the stcli file clone command with the positional arguments and optionally the arguments enclosed in [ ].

stcli snapshot-schedule Command

Enables or disables native snapshot schedules for all the objects in this cluster.

stcli snapshot-schedule [-h] {--enable | --disable}

Syntax Description

Option

Required or Optional

Description
--enable

One of set required.

Enable the native snapshot schedule.
--disable

One of set required.

Disable the native snapshot schedule.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli snapshot-schedule command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

Use the HX Data Platform plug-in to create the native snapshot schedule. This command allows you to disable the schedule and re-enable it without requiring you to rebuild the schedule.

stcli vm Commands

HX Data Platform VM ReadyClone and Native Snapshot operations.

stcli vm [-h] {clone | snapshot}

Syntax Description

Option

Required or Optional

Description
clone

One of set required.

Creates a specified number of ReadyClones for the given VM.
snapshot

One of set required.

Creates a native snapshot for the given VM.

Command Default

None. One option from the set is required.

Usage Guidelines

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

stcli vm clone Command

Creates a specified number of ReadyClones for the given VM.

stcli vm clone [-h] {--id ID | --name NAME} --clone CLONE --number NUMBER [--poweron] [--custspec CUSTSPEC] [--guestname GUESTNAME] [--startnumber STARTNUMBER] [--increment INCREMENT] [--resourcepool-id RP-ID | --resourcepool-name RP-NAME]

Syntax Description

Option

Required or Optional

Description
--clone CLONE

Required.

Name of the ReadyClone.
--id ID

One of set required.

ID of source VM. The ID is listed in the stcli cluster info command.

--name NAME

One of set required.

Name of the source VM.

-number NUMBER

Required.

Number of ReadyClones to create.

--custspec CUSTSPEC

Optional.

Guest customization spec for the ReadyClones. See vCenter Customize Guest OS feature.

--guestname GUESTNAME

Optional.

Specify a guest name for the ReadyClones so it can be different from source VM name.

Default is the DNS name for the host. This name must be DNS resolvable before specifying it.

--increment INCREMENT

Optional.

Suffix to use for incrementing the ReadyClone names.

Note 
Do not try to increment clone numbers using a value = or > 10000000000.

--poweron

Optional.

Power on the created ReadyClone after cloning.

--resourcepool-id RP-ID

Optional.

ID of the resource pool to place the ReadyClones.

--resourcepool-name RP-NAME

Optional.

Name of the resource pool to place the ReadyClones.

--startnumber STARTNUMBER

Optional.

Starting number for the incrementing suffix for the ReadyClone names.

Command Default

None. Specified options are required.

Usage Guidelines

Accompany the stcli vm clone command with one of the required positional arguments listed and optionally, arguments enclosed in [ ].

stcli vm snapshot Command

Creates a native snapshot for the given VM.

stcli vm snapshot [-h] {id ID | --name NAME | --folder-id FOLDER-ID | --folder-name FOLDER-NAME | --resourcepool-id RP-ID | --resourcepool-name RP-NAME} --snapshot SNAPSHOT [--desc DESC] [--memory | --quiesce]

Syntax Description

Option

Required or Optional

Description
--snapshot SNAPSHOT

Required.

Name of the native snapshot.
-folder-id FOLDER-ID

One of set required.

ID of the folder used to create the native snapshot.
--folder-name FOLDER-NAME

One of set required.

Name of the folder used to create the native snapshot.
--id ID

One of set required.

ID of the source VM used to create the native snapshot.

--name NAME

One of set required.

Name of the source VM used to create the native snapshot.

--resourcepool-id RP-ID

One of set required.

ID of the resource pool used to create the native snapshot.

--resourcepool-name RP-NAME

One of set required.

Name of the resource pool used to create the native snapshot.

--desc DESC

Optional.

Description of the native snapshot.

--memory

One of pair optional.

Memory for the native snapshot.

--quiesce

One of pair optional.

Quiesce the file system in the virtual machine.

Command Default

None. Specified options are required.

Usage Guidelines

Accompany the stcli vm snapshot command with one of the required positional arguments listed and optionally, arguments enclosed in [ ].