SimpliVity OmniCube User Manual

Download

Command Line Interface Reference

OmniCube Software Version 2.1.4 or Later Release

SimpliVityTMand OmniCubeTMare trademarks of SimpliVity Corporation.

All trademarks and registered trademarks mentioned herein are the property of their respective owners.

Information in this document is subject to change without notification.

Reproduction in any manner whatsoever without the written permission of SimpliVity is strictly forbidden.

Publication Date: 6/30/2014

Part Number: 760-000003 Rev E

Table Of Contents iii Preface v 1 - Introduction to the OmniCube CLI 1

CLI Overview 1 Prerequisites for Using the OmniCube CLI 1 Accessing the CLI from a Client Computer 2 Logging in to the CLI on a SimpliVity Virtual Controller 3 CLI Command Privileges 3 CLI Command Format 5 vCenter Server Address and Credentials 6 Running CLI Commands Interactively 8 Using CLI Commands in a Script 9 Using Environment Variables 9

2 - CLI Commands 11

Obtaining Help on a Command 11 Common Command Options 12 Command Operation Control Options 13

3 - Session Commands 17

svt-session-start Command 18 svt-session-stop Command 19 svt-session-verify Command 20

4 - Federation and Datacenter Commands 21

svt-federation-remove Command 21 svt-federation-show Command 23 Cloud Datacenter CLI Constraints 25 svt-cloud-deploy Command 25 svt-cloud-renamedatacenter Command 27 svt-cloud-undeploy Command 27 svt-timezone-show Command 28 svt-timezones-list Command 29 svt-timezone-set Command 30

5 - Datastore Commands 33

svt-datastore-create Command 34 svt-datastore-delete Command 35 svt-datastore-policy-set Command 36 svt-datastore-resize Command 37 svt-datastore-share Command 38 svt-datastore-show Command 39 svt-datastore-unshare Command 40

6 - Virtual Machine Commands 43

svt-vm-backup Command 44 svt-vm-clone Command 45 svt-vm-move Command 46 svt-vm-policy-set Command 47 svt-vm-restore Command 49 svt-vm-show Command 50

iii

OmniCube CLI Reference Table Of Contents

7 - Backup Commands 53

svt-backup-cancel Command 54 svt-backup-copy Command 55 svt-backup-delete Command 56 svt-backup-lock Command 57 svt-backup-rename Command 59 svt-backup-restore Command 60 svt-backup-show Command 62 svt-backup-size-calculate Command 65

8 - Backup Policy Commands 69

svt-policy-create Command 70 svt-policy-delete Command 70 svt-policy-rename Command 71 svt-policy-rule-create Command 72 svt-policy-rule-delete Command 75 svt-policy-show Command 76

9 - Software Upgrade Commands 79

svt-software-commit Command 79 svt-software-rollback Command 80 svt-software-status-show Command 81 svt-software-upgrade Command 83

10 - Miscellaneous Commands 85

svt-hardware-show Command 86 svt-credstore-update Command 89 svt-task-cancel Command 90 svt-task-show Command 91

11 - Support Commands 95

svt-support-capture Command 96 svt-support-cc Command 98 svt-support-configure Command 99 svt-support-disable Command 101 svt-support-enable Command 102 svt-support-show Command 103 svt-support-test Command 104 svt-version-show Command 106

Appendix A - Example of Using the CLI in a Script 1

Creating a Manual Backup 1

Index 3

Preface

CLI Reference describes how to use the OmniCube command line interface (CLI) and provides a detailed description of each command and option.

Overview of OmniCube

The foundation of OmniCube is a pair of high-performance and highly-available CN-Series systems. After you install the hardware in a rack and connect power and network cables, you can create an OmniCube Global Federation within a vCenter™ Server and configure each CN-Series system as a Federation OmniCube.

OmniCube systems provide compute, storage, and other resources to the virtual machines (VMs) in the Federation. If you need more capacity or performance, you can seamlessly add another pair of OmniCube systems to the Federation, with no disruption to users.

Audience

The intended audience for the CLI Reference guide includes individuals who want to use the CLI to perform Federation management tasks, from the command line or by using a script.

For detailed information about OmniCube concepts and operations, including the alternate graphical user interface, see the OmniCube Software Configuration and Management guide.

Prerequisites

To perform the tasks described in this document, it is useful to know the following:

• UNIX-style CLI or the VMware® vSphere™ Command-Line Interface.

• Scripting vSphere operations. If you intend to use the CLI in a script, See also Using CLI Commands in a

Script on page 9.

• VMware® and virtual environments.

Organization

This document is organized as follows:

• Introduction to the OmniCube CLI on page 1, describes how to access and run the CLI, including how to provide authentication for commands.

• CLI Commands on page 11 , describes all the CLI commands and options.

• Example of Using the CLI in a Script on page 1, contains examples of using the CLI in a script.

OmniCube CLI Reference Preface

Technical Support and Customer Service

Support services from SimpliVity are available to answer your questions about OmniCube.

SimpliVity provides online and telephone-based support services. Availability varies by country and product, and some services might not be available in your area.

To ensure fast results and optimal service, make sure you have the serial number, which is located on the Express Service Tag (a pull out card) located directly under disk 2 on the front panel.

There are several methods you can use to contact SimpliVity support:

• For customers in the United States, call 855-SVT-SERVICE (855-788-7378).

• Customers outside the United States, please call 508-536-4151, using your local international code for the USA.

• Send email to support@SimpliVity.com.

• Visit the SimpliVity Web site (www.SimpliVity.com/support) or scan the QR code in Figure-1.

Figure-1: SimpliVity Support Contact QR Code

In addition, SimpliVity recommends that you configure Phone Home support to automatically notify support about significant events.

1 - Introduction to the OmniCube CLI

This section introduces the OmniCube command line interface (CLI) and provides the following topics:

• CLI Overview on page 1

• Prerequisites for Using the OmniCube CLI on page 1

• CLI Command Format on page 5

• vCenter Server Address and Credentials on page 6

• Running CLI Commands Interactively on page 8

• Using CLI Commands in a Script on page 9

• Using Environment Variables on page 9

CLI Overview

The OmniCube software runs on the OmniCube Virtual Controller, a VM contained by each OmniCube in a OmniCube Global Federation. The OmniCube command line interface (CLI) is part of this software, enabling you to use a terminal to manage your Federation from a login to the Virtual Controller.

The CLI provides an alternative method of creating and managing a Federation compared to using the SimpliVity vSphere Extension (plug-in). See the OmniCube Configuration and Management guide.

You can run the CLI interactively, or use it in scripts to automate frequent or recurring tasks. Any changes that you make to a Federation by using CLI commands are immediately visible in the graphical user interface and vice versa.

Because the CLI interacts with vCenter Server, you must provide vCenter Server authentication credentials when using CLI commands.

Prerequisites for Using the OmniCube CLI

Before using the OmniCube CLI, you require the following information and resources:

• Determine the IP addresses that you can use to access a Virtual Controller in the Federation.

Use vSphere Client to display Virtual Controller IP addresses. In the vSphere inventory panel, underneath

OmniCube CLI Reference 1 - Introduction to the OmniCube CLI

an OmniCube in your Federation, click the Virtual Controller, which has a name in the format: OmniCube

VC nn.nn. Click the Summary tab in the main window and click View All to display the IP addresses that

you can use.

• Determine the following information for the vCenter Server managing the datacenter that contains your Federation:

– vCenter Server IP address. – vCenter Server authorized user account (such as Administrator) and account password.

• Learn about the OmniCube CLI command format. See CLI Command Format on page 5.

• Learn your options for supplying authentication credentials for vCenter Server. See vCenter Server

Address and Credentials on page 6.

Note: The formatted output from some commands will not display correctly on the console or on terminal

emulator windows when the screen is set to narrow width. Make the window size or terminal width larger if you see badly formatted output.

Accessing the CLI from a Client Computer

There are two methods of accessing the CLI, the console or a terminal emulator. You cannot use a single signon account for a console login:

Accessing the CLI through a Virtual Controller Console

1. Start vSphere client and connect to the vCenter Server containing the Federation that you want to

manage.

2. Click a Virtual Controller (which has a name in the format: OmniCube VC nn.nn).

3. Click the Console tab.

4. Log in as described in Logging in to the CLI on a SimpliVity Virtual Controller on page 3.

Accessing the CLI through a Terminal Emulator

1. Set your terminal to display color output to view color information in the output. (Some commands

provide component status output in red, green, or yellow.)

2. Obtain the IP address of a Virtual Controller in the Federation that you want to manage.

3. Open an SSH connection directly to the Virtual Controller in the Federation on port 22.

4. Log in as described in Logging in to the CLI on a SimpliVity Virtual Controller on page 3.

OmniCube CLI Reference 1 - Introduction to the OmniCube CLI

Logging in to the CLI on a SimpliVity Virtual Controller

To log in to the CLI on a Virtual Controller, access the Virtual Controller as described in Accessing the CLI

from a Client Computer on page 2.

You can use the built-in svtcli account, or you can use appropriate vCenter account and credentials to log in. In the latter case, you do not need to use svt-session-start to establish a session.

If you use a vCenter Server account, the account is mapped to the svtcli account, and:

• The login has no sudo privileges.

• The vCenter server session starts automatically.

• You can run only svt-* commands.

• You can SSH to any other OmniCube in the Federation.

The svtcli account is a restricted shell intended for emergency access to run SimpliVity CLI (svt-*) commands on a Virtual Controller. If you use the svtcli account, it does not log you in to the vCenter Server. Avoid using this account when you can log in using Active Directory single sign-on.

Note: Do not use the svtcli account for other command line operations unless directed by your technical

support. Changing the configuration of your Virtual Controller will cause an OmniCube to stop functioning properly.

1. Press Enter to display the Virtual Controller log in prompt, if not already displayed.

2. Type the CLI user account name svtcli and press Enter.

3. Type the account password simplicity and press Enter.

4. Type svt- and press the Tab key twice to display a list of commands.

If you use the svtcli account, establish credentials on the vCenter Server that you use to manage the Federation. See vCenter Server Address and Credentials on page 6. (Not necessary if you use an appropriate vCenter Server account.)

See also Running CLI Commands Interactively on page 8 and Using CLI Commands in a Script on page 9 for more information.

For detailed information about each CLI command, see Chapter 1, CLI Commands.

CLI Command Privileges

Access to CLIcommands depends on the account that you use to log in to the Virtual Controller. Native SimpliVity accounts provide certain preset levels of privilege, related to the privileges of the vCenter Server account that you use when establishing session credentials (see svt-session-start Command on page 18.)

OmniCube CLI Reference 1 - Introduction to the OmniCube CLI

You can also create VMware vSphere accounts on your vCenter Server and assign different VMware privileges to these accounts. If you access the CLI using such accounts to establish credentials, your SimpliVity accounts inherit the VMware privileges and control your access to CLI commands.

If you attempt to run a command when using an account that does not have the correct privileges, the following message appears:

ERROR [49]: Not authorized to perform requested action or view requested information.

Missing permissions:

Admin

Default command privileges and constraints are as follows:

• svtcli user—When logged in as svtcli, you can run all svt-* commands, depending on the privileges of the vCenter Server account that you use to authenticate and create a session (see svt-session-start Command on page 18.)

• root user (Virtual Controller) —The root user account is not accessible. There is no need to access the root user account and using the account can cause your Federation to stop working properly.

Table-1 lists the Command privileges.

Table-1 svtcli Command Privileges

Privilege VMware ID

Create Alarm Alarm.Create

Disable alarm action Alarm.DisableActions

Modify Alarm Alarm.Edit

Set alarm Status Alarm.SetStatus

Remove alarm Alarm.Delete

Unregister Extension Extension.Unregister

Global - health Global.Health

Global - log event Global.LogEvent

Global - manage custom attributes Global.ManageCustomFields

Global - set custom attribute Global.SetCustomAttribute

Global - diagnostics Global.Diagnostics

Host CIM - CIM- interaction Host.Cim.CimInteraction

Create task Task.Create

Update task Task.Update

vApp - Assign a Vapp VApp.AssignVApp

Vapp - Unregister VApp.Unregister

Virtual machine - Configuration - Configure ManagedBy Virtual machine.Config.managedBy

Virtual machine - Configuration - Settings Virtual machine.Config.settings

Virtual machine - State - Remove Snapshot Virtual machine.State.RemoveSnapshot

Virtual machine - State - Create Snapshot Virtual machine.State.CreateSnapshot

OmniCube CLI Reference 1 - Introduction to the OmniCube CLI

Note: In vCenter V5.1, the name of the Virtual machine - State permission group has changed to Snapshot

management. When you create the SimpliVity User account, enable both Create snapshot and Remove Snapshot under Snapshot management.

CLI Command Format

Each OmniCube CLI command uses the following format:

svt-noun-verb

The noun variable specifies the subject of the action, which you specify with the verb variable. For example, in the command shown next, backup is the subject and show is the action:

svt-backup-show

In most cases, you specify options on the command line. You can specify options in any order. Options use the following format:

--option_name [parameter]

The option_name variable specifies the name of the option, and the parameter variable (not applicable to all options) specifies an argument to the option.

For example:

svt-datastore-create --name ds23 --size 250GB --policy dailybackup

If an argument contains spaces or special characters such as the dollar sign ($), surround the argument with straight quotes as follows:

--backup '2012-Nov-12 14:00'

Command Options

There are two types of command options:

• Command-specific options—Control the execution of a specific operation. For example, when creating a datastore, you specify the --policy name option to specify the name of the default backup policy.

See Chapter 1, CLI Commands for information about the command-specific options.

• Common options—Apply to all commands, as follows:

◦ vCenter Server identification and authentication options—Supply authentication credentials for a vCenter

Server. See vCenter Server Address and Credentials on page 6.

◦ Command operation options—Enable you to control the operation of a command. See Command

Operation Control Options on page 13.

OmniCube CLI Reference 1 - Introduction to the OmniCube CLI

You can use environment variables to set the values for the common options. Environment variables are useful when you are issuing many commands to the same Federation. See Using Environment Variables on page 9.

Some options have a default value. If you do not specify an option on the command line or set the associated environment variable, the default value is used. If you specify both an option on the command line and set the associated environment variable, the command line option has precedence.

If you do not supply the required options, an error message describes the missing options and the help display lists all available options.

To obtain help on a command, specify the --help or --? option. See Obtaining Help on a Command on page 11.

Command Operations that Generate Object Names

The following commands automatically generate a name for the created object, ensuring that the object name is unique in its destination location. You can override the proposed name string and substitute your preferred name, if that the name is unique.

• svt-vm-backup Command on page 44—Appends a timestamp to the name of the source VM.

• svt-vm-move Command on page 46—Uses the same name as the source VM.

• svt-vm-clone Command on page 45— The command appends the string -clone-<timestamp> to the original VM name.

• svt-backup-restore Command on page 60—The command appends the string -restored-<timestamp> to the original VM name.

You can edit the generated name, or rename the object at a later time.

Note: Serial operations can result in long object names because the timestamp string is appended more than

once.

vCenter Server Address and Credentials

OmniCube operates as an extension to vCenter Server and uses the vCenter Server access control system to determine which users can access resources and perform Federation tasks.

To run OmniCube CLI commands, you must identify the vCenter Server where the Federation resides and supply authentication credentials. Alternatively, use an appropriate vCenter Server account. Be aware that you cannot use a vCenter Server account to run scripts.

Note: If you are using a session, you only need to supply the vCenter Server address and credentials one time.

Otherwise, you must supply the information each time you issue a command or set the credentials using environment variables.

For information about credential stores and session files, see vCenter Identification and Authentication Options

on page 12.

OmniCube CLI Reference 1 - Introduction to the OmniCube CLI

You can use several methods to supply the IP address for a vCenter Server if you do not use a vCenter Server account (single sign-on):

• Use the --serverip-address option on the svt-session-start command line to specify the IP address for the vCenter Server when starting a session.

• Use the --serverip-address option on each command line.

• Set the VI_SERVER environment variable to the vCenter Server IP address prior to issuing commands. You might want to use this method if you are using a script. See Using Environment Variables on page 9.

You can use several methods to supply vCenter Server authentication credentials if you do not use a vCenter Server account:

• Use the --username name option and, optionally, the --password password option on the command line. If you do not specify the password, you are prompted for the password.The password you enter is not echoed.

Note: Specifying a password by using the --password password option might be an unacceptable security

risk.

• Supply the vCenter Server user name and password when prompted after issuing a command.

• Set the VI_USERNAME and VI_PASSWORD environment variables to the vCenter Server user name and password prior to issuing commands. See Using Environment Variables on page 9.

Note: Specifying a password in an environment variable might be an unacceptable security risk.

• Specify a session file that contains valid vCenter Server credentials:

◦ On the command line, use the --sessionfile file option.

◦ Prior to issuing commands, set the VI_SESSIONFILE environment variable. See Using Environment

Variables on page 9.

Note: Using a session file might be an unacceptable security risk.

• Specify a credential store file that contains valid vCenter Server credentials:

◦ On the command line, use the --credstore file option.

◦ Before typing any commands, set the VI_CREDSTORE environment variable to specify a credential

store. See Using Environment Variables on page 9.

The order of precedence, from highest to lowest, for vCenter Server authentication is:

• Credentials specified using options on the command line.

• Credentials defined using environment variables.

• Credentials defined in a credential store.

• Credentials specified when prompted.

See vCenter Identification and Authentication Options on page 12 for more information.

OmniCube CLI Reference 1 - Introduction to the OmniCube CLI

Running CLI Commands Interactively

You can run the OmniCube CLI interactively by entering commands at the prompt.

There are several methods you can use to run the CLI interactively:

• Use an appropriate vCenter Server account (single sign-on). When you do this, you do not need to start a session.

• Use a session. This method is useful because you only need to supply the vCenter Server address and credentials one time. As long as the session is valid, you can run CLI commands without needing to enter the information again. A session is canceled after 30 minutes of inactivity. If a session becomes invalid, you must run svt-session-start again to create a new session.

Follow these steps to use a session:

1. Use the svt-session-start command to start a session, supplying vCenter Server IP address and

credentials, as described in vCenter Server Address and Credentials on page 6.

2. Enter the desired CLI commands.

3. Use the svt-session-stop command to end the session.

See svt-session-start Command on page 18 and svt-session-stop Command on page 19.

• Enter the desired commands, specifying the vCenter Server address and credentials on each command line.

• Enter the desired commands, specifying the vCenter Server address on the command line and specifying the authentication credentials when prompted.

• Set the vCenter Server address and credentials in environmental variables prior to issuing commands. See

Using Environment Variables on page 9.

The following example uses a session to create a datastore and then ends the session. The command prompts for the vCenter Server user name and password; the password you enter at the prompt will not appear:

$ svt-session-start --server 210.0.4.141 vCenter server: 210.0.4.141

Enter username: user25 Enter password for user25:

Saved file to /home/.svt_session

Successful login of user25 to 210.0.4.141

$ svt-datastore-create --name dxlab2 --policy nightly --size 300GB

..........

Task Complete

$ svt-session-stop Successful: deleted session

OmniCube CLI Reference 1 - Introduction to the OmniCube CLI

Using CLI Commands in a Script

You can use OmniCube CLI commands in a script. Running commands in a script can be useful if you perform the same task multiple times. See Example of Using the CLI in a Script on page 1.

Note: You can specify command options that control how a command operates in the script. See Command

Operation Control Options on page 13. However, do not use the --wait n option while scripting. In most

cases, you want a command to complete before a subsequent command runs.

For security reasons, you might want to use a file that contains the vCenter Server credentials (credstore) to provide vCenter Server credentials in a script. (See vCenter Identification and Authentication Options on page

12).

Using Environment Variables

For options that are not command specific, you can use environment variables to set the values. Environment variables are useful when you are issuing many commands to the same Federation environment. Use the env command to see what environment variables are set.

See Table-2 and Table-3 for the environment variable for each common command option.

You can set an environment variable on a command line or in a file that is called by a script.

Use the following format:

export variable_name=value

For example:

export VI_SERVER=120.45.2.10

When you set the variable, you can apply it to a command. For example, the following command creates a datastore and sets a time-out limit of 20 seconds for the operation:

$ svt-datastore-create --name dsEnglab --size 1TB --policy daily

--wait n --timeout 20

The following example performs the same task, but uses environment variables:

$ SVTCLI_WAIT=n SVTCLI_TIMEOUT=20 svt-datastore-create --name dslab

--size 1TB --policy daily

Unlike sessions, environment variables do not time out and remain valid until you log out of the shell.

2 - CLI Commands

This section describes how to get help on a command and the common OmniCube command options. Also provided are the format, options, and examples for each command.

The commands are grouped as follows:

• Session Commands on page 17

• Federation and Datacenter Commands on page 21

• Datastore Commands on page 33

• Virtual Machine Commands on page 43

• Backup Commands on page 53

• Backup Policy Commands on page 69

• Software Upgrade Commands on page 79

• Miscellaneous Commands on page 85

• Support Commands on page 95

Obtaining Help on a Command

With any OmniCube command, you can specify the --help or --? option to display help about the command, including the command syntax and information about the command options.

For example:

$ svt-backup-copy --help

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ----- ----- ----- ----.

| S ynops is: s vt-ba ckup- copy -- datas tore <d atast ore> -- vm <vm> - -back up <bac kup> |

| --s ource < datac enter > --des tinat ion < datac enter > |

| |

| D escri ption : Ccopy a b ackup t o a remot e datac enter . |

+-- ----- ----- ----- ---+- ----- ----- ---+- ----- ----------------- ----- ----- ---+- ----- ----- ----- ----+

+-- ----- ----- ----- ---+- ----- ----- ---+- ----- ----------------- ----- ----- ---+- ----- ----- ----- ----+

| - -vm | | [ Requi red] Th e origi nal V M | |

OmniCube CLI Reference 2 - CLI Commands

| | | a ny | |

'-- ----- ----- ----- ---+- ----- ----- ---+- ----- ----------------- ----- ----- ---+- ----- ----- ----- ----'

Common Command Options

You can use common options for any CLI command. See the following:

• vCenter Identification and Authentication Options on page 12.

• Command Operation Control Options on page 13.

For common command options, you can use environment variables to set the values. Environment variables are useful when you are issuing many commands to the same Federation. See Using Environment Variables on page

vCenter Identification and Authentication Options

OmniCube operates as an extension to vCenter Server and uses the vCenter Server access control system to determine which users can access resources and perform tasks.

To use OmniCube CLI commands, as svtcli user or root user, you must identify the vCenter Server where the Federation resides and provide valid authentication credentials. Table-2 describes the vCenter Server identification and authentication options.

Note: You can also use a single sign-on account, in which case you do not need to start a session.

See vCenter Server Address and Credentials on page 6 for more information.

OmniCube CLI Reference 2 - CLI Commands

Table-2 vCenter Identification and Authentication Options

Option Description Environment

Variable

--credstore file

--server ip-address

--sessionfile file

Location (on client) of credential store file that contains the vCenter Server credentials.

Commands for setting up a credential store are included in the vSphere SDK for Perl, which is installed with the vSphere CLI. The vSphere SDK for Perl Programming Guide explains how to use a credential store.

IP address for vCenter Server. VI_SERVER

Session file that contains a valid session token.

Note: Using a session file might be an unacceptable

security risk.

VI_CREDSTORE

VI_SESSIONFILE

For information about the format of a credential store and session file, see the topic: Specifying Authentication

Information in the VMware vSphere 5 Documentation Center (http://pubs.vmware.com/vsphere-

50/index.jsp?topic=%2Fcom.vmware.vcli.getstart.doc_50%2Fcli_run_remote.5.3.html).

Command Operation Control Options

Table-3 lists the options that control command operation.

Table-3 Command Operation Control Options

Option Default Description Environment

Variable

--force

--output text | xml

--timeout

seconds

--wait y | n

Wait for a response

text Format for the command output, either text or XML. SVTCLI_OUT

120 Number of seconds after which the command will expire (time out) as

y Whether to wait for a command to complete before returning the

Note: Under certain troubleshooting circumstances only, you are prompted to provide an IP address for the

target OmniCube using a hidden --ip option.

Considerations When Using Control Options

Automatically supplies a "yes" response to any "Are you sure?" prompt and overrides any checks.

This option is useful for scripting.

long as it has not yet completed.

command prompt.

SVTCLI_ FORCE

SVTCLI_ TIMEOUT

SVTCLI_WAIT

• Be careful when using the --wait n option. In many cases, you want a command to complete before a subsequent command runs.

• When a command exceeds its timeout threshold, you will see the following message:

OmniCube CLI Reference 2 - CLI Commands

Command still in progress, but timed out To check status, execute svt-task-show --task 4f186d32-305d-4cc0-a210-1c6f89e-b6a8

(This command continues to show the output of the specified task.)

• Each task has a unique ID string the persists for the duration of the task. When you specify the --wait n option with a command, you will see the following message:

Task started - ID is c7de83b1-3ce8-4f41-8062-8e86f041c599

The svt-task-show command may be used to monitor the progress of this task.

You can use the svt-task-show command (specifying the task ID) to monitor the progress of a task.

Using XML Output

The option to write the XML output of a command (SVTCLI_OUT) provides additional information that you can use when scripting. For example, if you use the --output xml option with svt-federation-show (see svt-

federation-show Command), yo obtain the following XML output:

<No de>

</m gmtIf >

<vm Name> XXXXX XXXXX XXX</ vmNam e>

</f edIf>

<up grade State >0

</s wVers ion>

OmniCube CLI Reference 2 - CLI Commands

<id >420c 4c0a- f523- 6382- 159b- b5630 51e35 6a

</s torIf >

</N ode>

</C omman dResu lt>

If you do not specify XML output, the svt-federation-show command output provides only the following information for a single OmniCube:

$ svt-federation-show

3 - Session Commands

The session commands manage CLI sessions to a vCenter Server.

• svt-session-start—Starts a CLI session to a specified vCenter Server. See svt-session-start Command on page 18.

• svt-session-stop—Stops a CLI session. See svt-session-stop Command on page 19.

• svt-session-verify—Checks whether a CLI session is valid and extends the session if valid. See svt-

session-verify Command on page 20.

Note: You do not need to use a session if you log in with an appropriate vCenter Server account (single sign-

on).

OmniCube CLI Reference 3 - Session Commands

svt-session-start Command

Use the svt-session-start command to start an authorized CLI session during an svtcli command-line login on a Virtual Controller. When you provide the username and password of an authorized vCenter Server account, this command generates a session token and stores the token in a session file. You do not need to do this if you use an appropriate vCenter Server account.

When you use a session, you supply vCenter Server credentials one time per session. Those credentials apply for as long as the session is valid.

To support a Federation in Linked Mode using vCenter 5.1, install single sign-on (SSO) using Multi-site mode. Multi-site mode requires an Active Directory (AD)server for authentication. In such environments, you must include the AD domain in the login credentials, using the format user-name@domain-name password. For example:

FedMgr@MyLab51 password.

Note: If you do not supply a vCenter Server IP address, the command defaults to the vCenter Server managing

the Federation.

By default, the session file is created in /home/svtcli/.svt_session, where svtcli is the limited login shell for CLI sessions on the OmniCube Virtual Controller.

Use the --sessionfile file option to specify a valid, write-enabled location for the session file. If there is no write-enabled location, the command fails.

A CLI session expires automatically after 30 minutes of inactivity. However, the session file is not deleted. You can:

• Use the svt-session-stop Command on page 19 to end a session and delete the session file.

• Use the svt-session-verify Command on page 20 to confirm and extend a session before it expires.When a CLI session expires or ends, you must again supply vCenter Server credentials to run CLI commands.

For security, you can omit the --password option and you are prompted for the password. The password is not echoed to the screen in plain text.

Format

svt-session-start --username account_name --password account_password [common-options]

Options

Options Description

--username

--password

common-options

The vCenter Server user name.

The vCenter Server user password.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

OmniCube CLI Reference 3 - Session Commands

Examples

Attempt a command outside a valid session

$ s vt-ba ckup- show ERR OR [48] : Inval id sess ion c reden tials . $ s vt-se ssion -star t

Specify no credentials

$ s vt-se ssion -star t vCe nter se rver: 1 0.0.5 .37 Ent er user name: A dmini strat or Ent er pass word fo r Admin istra tor:x xxxxx xxxxx x Sav ed file t o /home /svtc li/.s vt_se ssion Suc cessf ul logi n of Admi nistr ator to 1 0.0.5 .37

Specify a session file path

$ s vt-se ssion -star t --ses sionf ile / home/ creds vCe nter se rver: 1 0.0.5 .37 Ent er user name: A dmini strat or Ent er pass word fo r Admin istra tor: Sav ed file t o /home /svtc li/my sessi on Suc cessf ul logi n of Admi nistr ator to 1 0.0.5 .37

Use Environment Variables

$ e xport V I_USE RNAME =Admi nistr ator $ e xport V I_PAS SWORD =xxxx xxxxx xx $ s vt-se ssion -star t vCe nter se rver: 1 0.0.5 .37 Sav ed file t o /home /svtc li/.s vt_se ssion Suc cessf ul logi n of Admi nistr ator to 1 0.0.5 .37

svt-session-stop Command

The svt-session-stop command ends a vCenter Server session and deletes the session file. After you end a session, you must again supply vCenter Server authentication credentials to run CLI commands. See the svt-

session-start Command on page 18.

Note: A CLI session expires automatically after 30 minutes of inactivity. However, the session file is not

deleted and you can verify and extend a session for a further 30 minutes. See the svt-session-verify

Command on page 20.

Format

svt-session-stop [common-options]

Options

Options Description

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

OmniCube CLI Reference 3 - Session Commands

Examples

$ s vt-se ssion -stop Suc cessf ul: d elete d sessi on $ s vt-se ssion -stop No se ssion e xists .

svt-session-verify Command

The svt-session-verify command verifies a vCenter Server session and credentials, then resets the inactivity timer if the session is valid, extending the session. See the svt-session-start Command on page 18.

You can end an unwanted valid session and delete the credentials. See the svt-session-stop Command on page

19.

Format

svt-session-verify [common-options]

Options

Options Description

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Examples

Valid Session

$ s vt-se ssion -veri fy Ver ified s essio n on 120. 18.4. 20

Invalid Session

$ s vt-se ssion -veri fy ERR OR [47] : Missi ng sess ion c reden tials .

4 - Federation and Datacenter Commands

Federation commands enable you to manage the OmniCube systems in a Federation and in a Datacenter:

• svt-federation-show—Shows the status of OmniCube systems in a Federation. See svt-federation-show

Command on page 23.

• svt-federation-remove—Removes OmniCube systems from a Federation. See svt-federation-remove

Command on page 21.

• Cloud Datacenter CLI Constraints on page 25

◦ svt-cloud-deploy Command on page 25.

◦ svt-cloud-renamedatacenter Command on page 27.

◦ svt-cloud-undeploy Command on page 27.

• svt-timezone-show Command on page 28.

• svt-timezone-set Command on page 30.

• svt-timezones-list Command on page 29.

svt-federation-remove Command

The svt-federation-remove command removes individual OmniCube systems from a Federation, if there is at least one other healthy OmniCube in the datacenter.

If there are no healthy OmniCube systems in a datacenter, you can optionally remove all unhealthy OmniCube systems from that Federation in a single operation.

Removing an OmniCube

An OmniCube cannot remove itself from the Federation to which it belongs. You must run the command from another Federation OmniCube.

When you use this command, identify the IP address of the OmniCube that is the target for removal. Then, run the svt-federation-remove command from any other Federation OmniCube, specifying --peerip.

Use the output from svt-federation-show to determine the IP address, located under the ESXi Host column (see the svt-federation-show Command on page 23).

OmniCube CLI Reference 4 - Federation and Datacenter Commands

The command does not operate on a Federation where all the OmniCube systems in a given datacenter have a faulty status. You must correct any problems before using the command or you can optionally remove all unhealthy OmniCube systems from a Federation datacenter. See Removing all OmniCube Systems in a

Datacenter.

Warning: If you use the --override option to force the removal of an OmniCube, the command does not

check for active VMs or HA compliance. Any data associated with active VMs is permanently deleted, although remote backups of VMs are still available.

Removing all OmniCube Systems in a Datacenter

If all OmniCube systems in a datacenter have a faulty status (down), you can use the

--datacenter option to forcibly remove all the OmniCube systems in a single operation.

This option does not check for active VMs and datastores because it is assumed that you have decided to do a tear down of the datacenter. This action permanently deletes all data associated with active VMs. However, remote backups of such VMs might be available for recovery, depending on your backup strategy.

Re-deploying Removed OmniCube Systems

When you remove an OmniCube from a Federation, you cannot join it back into the same Federation unless:

• The OmniCube is in a healthy state and at an appropriate compatibility level to rejoin the Federation. In this case, you can delete the Virtual Controller from disk, make sure that the network settings are appropriate, and deploy the OmniCube. See OmniCube Configuration and Management for more information.

• You restore the OmniCube to factory defaults and then re-deploy it as a new Federation OmniCube.

Format

svt-federation-remove [--peerip OmniCube-ip | --datacenter datacenter_name]

--override [common-options]

Options

Options Description Environment

Variable

--datacenter

--override

(Required, if --peerip is not specified) The name of a datacenter containing all the unhealthy OmniCube systems to remove. Intended to remove all OmniCube systems from a datacenter when every OmniCube is non-functional. This option is mutually exclusive with

--peerip.

Force the removal of the OmniCube even if active VMs are present and if the OmniCube is not HA-compliant.

SVTCLI_OVERRIDE

--peerip

This might cause data loss. This option (or environment variable) is ignored when you specify the --datacenter option because all OmniCube systems are removed.

(Required if --datacenter is not specified) The Federation IP

OmniCube CLI Reference 4 - Federation and Datacenter Commands

Options Description Environment

Variable

address or Management IP address of an OmniCube that you want to remove from the Federation.

This option is mutually exclusive with --datacenter. Use the output from svt-federation-show to determine the IP addresses, located under the Management IPor Federation IPcolumn.

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-fe derat ion-r emove - -peer ip 129. 128.4 .55 - -over ride

Are y ou sure y ou want t o perma nentl y remov e this Om niCub e from the Federation? You m ust r eset th e OmniC ube t o fac tory de fault s befor e you c an rede ploy it ? Yes

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ...

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ....

Tas k Compl ete

$ s vt-fe derat ion-r emove - -data cente r DMine 22

"WA RNING : if ther e are V Ms pres ent i n this da tacen ter, th is oper ation w ill r esult i n data lo ss. Are you su re you w ant t o perma nentl y remov e all O mniCu be syst ems f rom f edera tion DM ine22 ? You m ust r eset al l OmniC ube sys tems in t his f edera tion to f actor y defau lts b efore y ou can re deplo y them? ". Yes

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ...

Tas k Compl ete

Related Commands:

• svt-federation-show Command on page 23

svt-federation-show Command

The svt-federation-show command displays information about all OmniCube systems in a Federation and provides the following data:

• Datacenter—The name of VMware datacenter.

• ESXi Host—The IP address or DNSname of the ESXi instance running on the OmniCube. This is the IP address that identifies the OmniCube to vCenter Server. You specify this IP address or DNS name when you add the OmniCube to vCenter Server as an ESXi host.

• OmniCube VC Name—The name of the OmniCube Virtual Controller that hosts the OmniCube Software. This VM also appears in the vSphere Hosts and Cluster inventory under the OmniCube ESXi host.

• State—The current OmniCube state, which can be:

OmniCube CLI Reference 4 - Federation and Datacenter Commands

◦ Alive (Green)—The OmniCube is healthy.

◦ Faulty (Red)—The OmniCube is in a critical error state and operations have failed over to an alternate

OmniCube in the Federation. It is likely that one or more error or event messages were logged. See svt-

support-capture Command on page 96 for information about capturing log files.

◦ Suspected (Yellow)—The OmniCube has one or more components that show degraded performance.

◦ Unknown (Red)—The OmniCube status is indeterminate, perhaps because it is unable to communicate

with other Federation OmniCube systems. It is possible that one or more error or event messages were logged. See svt-support-capture Command on page 96 for information about capturing log files.

• Management IP—The IP address of the OmniCube Management network.

• Federation IP—The IP address of the OmniCube Federation network.

• Storage IP—The OmniCube Storage network IP address.

• Version—The OmniCube software release version number.

• Arbiter—The connection status of the SimpliVity Arbiter, connected (green) or disconnected (red).

Format

svt-federation-show [common-options]

Options

Options Description

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-fe derat ion-s how

.-- ----- ----- ----- ----- ----- ----- ----- ----- ---------

|Me mbers hip

+-- ----- ---+- ----- ----- -+--- ----- ----- ----- +------+-

+-- ----- ---+- ----- ----- -+--- ----- ----- ----- +------+-

|ds 2 |12 3.12. 90.80 |Omni Cube VC 2 .85 | A live|

+-- ----- ---+- ----- ----- -+--- ----- ----- ----- +------+-

|dc 0 |12 3.12. 90.70 |Omni Cube VC 2 .90 | A live|

+-- ----- ---+- ----- ----- -+--- ----- ----- ----- +------+-

--- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ---.

--- ----- ----- -+--- ----- ----- -+--- ----- ----+ --------+-------- ---+

--- ----- ----- -+--- ----- ----- -+--- ----- ----+ --------+-------- ---+

123 .19.9 0.85 | 12 3.110 .2.85 | 1 23.12 .2.85 | 1.0.7 58| C onnec ted |

--- ----- ----- -+--- ----- ----- -+--- ----- ----+ --------+-------- ---+

123 .19.9 0.75 | 12 3.110 .2.75 | 1 23.12 .2.75 | 1.0.7 58| C onnec ted |

--- ----- ----- -+--- ----- ----- -+--- ----- ----+ --------+-------- ---+

OmniCube CLI Reference 4 - Federation and Datacenter Commands

Related commands:

• svt-federation-remove Command on page 21

• svt-support-capture Command on page 96

• svt-hardware-show Command on page 86

Cloud Datacenter CLI Constraints

You can run CLI Commands from a physical OmniCube's Virtual Controller, specifying OmniCube Cloud Datacenter, or you run a CLI command by logging in to the OmniCube Cloud Datacenter.

The following OmniCube CLI constraints apply:

• svt-datastore-*—You cannot create or delete datastores on an OmniCube Cloud Datacenter. However, you can create or delete datastores on physical OmniCube systems if you run the command while you are logged in to an OmniCube Cloud Datacenter

• Any command that operates on a datastore, or takes a datastore name as an argument, (such as svt-vm-

*and svt-backup-*) does not function for an OmniCube Cloud Datacenter.

• svt-federation-remove—If you specify an OmniCube Cloud Datacenter, this command will remove it from the Federation without undeploying the cloud instance, preserving the data in the Amazon S3 bucket. Conversely, undeploying an OmniCube Cloud Datacenter by using svt-cloud-undeploy Command removes the cloud instance and destroys all the associated data.

• svt-hardware-show—An OmniCube Cloud Datacenter has no physical hardware to report.

• svt-session-*—Not required for an OmniCube Cloud Datacenter

• svt-support-capture—Captures limited OmniCube Cloud Datacenter data.

svt-cloud-deploy Command

The svt-cloud-deploy command deploys an OmniCube Cloud Datacenter instance and adds it to a Federation.

Format

svt-cloud-deploy --datacenter datacenter_name --cloudip ip-address

--interface net_interface --subnets subnet_masks --region AWS_region

--adminkey admin_key --adminsecret admin_secret --ockey omnicube_key

--ocsecret omnicube_secret --provider cloud_provider [common-options]

Options

Options Description

--datacenter

(Required) User-friendly name of the OmniCube Cloud Datacenter to add.

OmniCube CLI Reference 4 - Federation and Datacenter Commands

Options Description

--cloudip

--interface

--subnets

--region

--adminkey

--adminsecret

--ockey

--ocsecret

--provider

common-options

(Required) The IP address of the Amazon EC2 cloud instance that will host the new OmniCube Cloud Datacenter.

(Required) The virtual elastic network interface (ENI)to which you will attach the Amazon Web services (AWS) instance. It has the format eni-xxxxxxx.

(Required) Specify one or more subnet masks using CIDR format. You must specify an appropriate range of addresses to allow all physical OmniCube and OmniCube Cloud Datacenter systems in the Federation to access the AWS instance. Use the format netmask/N, where N is an integer with a value of: 0, 8, 16, or 32.

(Required) Specify the Amazon region in which this OmniCube Cloud Datacenter is located, such as "US West".

(Required) The access key identifier for an IAMuser account with administrative privileges. This credential is used once only for deployment and is not stored.

(Required) The access secret identifier for an IAMuser account with administrative privileges. This credential is used once only for deployment and is not stored.

(Required) Specify the access key ID for an IAM user with limited privileges to start, stop, and read/write data to and from the OmniCube Cloud Datacenter hosted in the AWS instance. This credential is stored securely on the Federation.

(Required) Specify the secret access key for an IAM user with limited privileges to start, stop, and read/write data to and from the OmniCube Cloud Datacenter hosted in the AWS instance. This credential is stored securely on the Federation.

(Optional) The cloud provider to use for cloud services. (In this release, the cloud provider defaults to amazon.)

Common options applicable to all commands. See:

vCenter Identification and Authentication Options on page 12

Command Operation Control Options on page 13

Example

$ svt-cloud-deploy --datacenter myclouddc --cloudip 100.20.1.52

--interface eni-dd7745b0

--subnets 100.20.0.0/16:100.130.0.0/16 --region "US West"

--adminkey AKIAJOPL5YXXLIYHFP3A

--adminsecret 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

--ockey AQLAJAGJKGKPLFLHFA3A

--ocsecret erYdZRGgVZft54gcKCdtYdfVmOlrwmQMtudMzkWA

Related Commands:

• svt-cloud-undeploy Command on page 27

• svt-cloud-renamedatacenter Command on page 27

OmniCube CLI Reference 4 - Federation and Datacenter Commands

svt-cloud-renamedatacenter Command

The svt-cloud-renamedatacenter command enables you to rename an existing OmniCube Cloud Datacenter.

Format

svt-cloud-renamedatacenter --datacenter datacenter_name --newdatacenter new_datacenter_name

--adminkey AWS_administrator_key --adminsecret AWS_administrator_secret [common-options]

Options

Options Description

--datacenter

--newdatacenter

--adminkey

--adminsecret

common-options

(Required) Existing datacenter name.

(Required) Replacement datacenter name.

(Required) The access key identifier for an IAMuser account with power user privileges (Admin-user).

(Required) The access secret for an IAMuser account with power user privileges (Admin-user).

Common options applicable to all commands. See:

vCenter Identification and Authentication Options on page 12

Command Operation Control Options on page 13

Example

# svt-cloud-renamedatacenter --datacenter AWSwestDC --datacenter AWSwestSVT

--adminkey AKIAJOPL5YXXLIYHFP3A

--adminsecret cjYdZRhgVZStKbCMnCrtYdrVhZSrlNoMtudNzkWA

................

Task Complete

Related Commands:

• svt-cloud-deploy Command on page 25

• svt-cloud-undeploy Command on page 27

svt-cloud-undeploy Command

The svt-cloud-undeploy command removes an OmniCube Cloud Datacenter instance from a Federation, destroying any data remaining in the OmniCube cloud datacenter.

Before you remove a OmniCube Cloud Datacenter from a Federation:

OmniCube CLI Reference 4 - Federation and Datacenter Commands

• Move backups that you want to preserve from the OmniCube Cloud Datacenter to a physical Federation datastore or another OmniCube Cloud Datacenter.

To preserve the relationship between a backup and the original VM from which the backup was taken, make sure that you move a backup to the datacenter where the original VM resides.

• Make sure your current VM backups are redirected to a physical datastore by adding new policies or new rules to existing policies.

• Delete any obsolete policy rules that direct backups to the OmniCube Cloud Datacenter that you intend to remove.

Format

svt-cloud-undeploy --datacenter datacenter_name --adminkey adminkey

--adminsecret admin secret [common-options]

Options

Options Default Description

--datacenter

--adminkey

-adminsecret

commonoptions

(Required) Name of the OmniCube Cloud Datacenter to remove.

(Required) The access key identifier for an IAMuser account with power user privileges (Admin-user).

(Required) The access secret for an IAMuser account with power user privileges (Adminuser).

Common options applicable to all commands. See:

vCenter Identification and Authentication Options on page 12

Command Operation Control Options on page 13

Example

svtcli@omnicube-ip3-105:~$ svt-cloud-undeploy --datacenter myclouddc

--adminkey AKLAXCRL5FHPUHQHBA3A

--adminsecret cjYdbRhgVZStKPOcjCrtYdrwRZSiwmoMtuEGzkWA

Related Commands:

• svt-cloud-deploy Command on page 25

• svt-cloud-renamedatacenter Command on page 27

svt-timezone-show Command

The svt-timezone-show command displays the time zone configured for backups taken in a Federation datacenter.

Use the svt-timezone-set command to configure the datacenter time zone. Use the svt-timezones-list command to list the time zone region/locale values supported by OmniCube.

Format

OmniCube CLI Reference 4 - Federation and Datacenter Commands

svt-timezone-show --datacenter datacenter_name [common-options]

Options

Options Default Description

--datacenter local

common-options

The datacenter for which you require the time zone setting.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ svt-timezone-show The Time Zone for datacenter <local> is "America/New_York"

$ svt-timezone-show --datacenter DNMRK22 The Time Zone for datacenter DNMRK22 is "Europe/Copenhagen"

Related Commands:

• svt-timezone-set Command on page 30

• svt-timezones-list Command on page 29

svt-timezones-list Command

The svt-timezones-list command lists the time zone identifiers supported by OmniCube for Federation datacenters.

Use the svt-timezone-show command to display the current datacenter time zone. Use the svt-timezone-

set command to change the datacenter time zone.

Format

svt-timezones-list [common-options]

Options

Options Default Description

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ svt-timezones-list | more

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

OmniCube CLI Reference 4 - Federation and Datacenter Commands

Africa/Algiers

Related Commands:

• svt-timezone-show Command on page 28

• svt-timezone-set Command on page 30

svt-timezone-set Command

The svt-timezone-set command sets the time zone used for backups for all OmniCube systems in a Federation datacenter.

Use the svt-timezone-show command to display the current datacenter time zone. Use the svt-

timezones-list command to list the time zone region/locale values supported by OmniCube.

Format

svt-timezone-set --timezone region/locale --datacenter datacenter_name

[common-options]

Options

Options Default Description

--timezone

--datacenter

common-options

America/New_York

(Required) The time zone region/locale for the Federation datacenter.

The datacenter that will use the specified time zone. All OmniCube systems in the datacenter use the same time zone.

Common options applicable to all commands. See:

vCenter Identification and Authentication Options on page 12

Command Operation Control Options on page 13

Example

$ svt-timezone-set --timezone America/Pacific

ERROR [169]: The specified time zone was not defined. You can execute 'svt-timezones-list' for list of valid time zone names.

$ svt-timezone-set --timezone America/Phoenix

.. Task Complete

5 - Datastore Commands

The following commands manage datastores in a Federation:

• svt-datastore-create—Creates a datastore. See svt-datastore-create Command on page 34.

• svt-datastore-delete—Deletes a datastore. See svt-datastore-delete Command on page 35.

• svt-datastore-policy-set—Sets the default backup policy for a datastore. See svt-datastore-policy-set

Command on page 36.

• svt-datastore-resize—Enables you to increase or decrease the storage capacity of a datastore. See svt-

datastore-resize Command on page 37.

• svt-datastore-share—Allows a Non-SimpliVity ESXi host to access a Federation datastore. See svt-

datastore-share Command on page 38.

• svt-datastore-show—Displays the datastores in a Federation. See svt-datastore-show Command on page

39.

• svt-datastore-unshare —Stops sharing a datastore previously shared by using svt-datastore-share. See svt-datastore-unshare Command on page 40.

OmniCube CLI Reference 5 - Datastore Commands

svt-datastore-create Command

The svt-datastore-create command creates a datastore in the Federation and sets the backup policy for new VMs that you create in the datastore.

See svt-policy-create Command on page 70 for information about creating a backup policy.

Note: Use the svt-vm-policy-set command to set a backup policy for an individual VM and override the

default policy. See svt-vm-policy-set Command on page 47.

Format

svt-datastore-create --name name --policy name --size [nGB|nTB]

--datacenter datacenter [common-options]

Options

Options Description

--datacenter

--name

--policy

--size

common-options

The name of the datacenter that contains this datastore, defaulting to the current datacenter.

(Required) Name of the new datastore.

(Required) Name of the backup policy. A backup policy enables you to schedule VM backup operations.

(Required) Size of the new datastore expressed as nGB or nTB. The size of a datastore is defined as the maximum amount of data the datastore can contain before the written data is deduplicated and compressed.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-da tasto re-cr eate -- name ds 2 --pol icy d ailyd r --siz e 4TB

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ...

Tas k Compl ete

Related commands:

• svt-datastore-delete Command on page 35

• svt-datastore-policy-set Command on page 36

• svt-datastore-resize Command on page 37

• svt-datastore-share Command on page 38

• svt-datastore-show Command on page 39

• svt-datastore-unshare Command on page 40

OmniCube CLI Reference 5 - Datastore Commands

svt-datastore-delete Command

The svt-datastore-delete command deletes a datastore from the Federation.

Note: You cannot delete a datastore if it contains active VMs or backups of deleted VMs.

Format

svt-datastore-delete --name name [common-options]

Options

Options Description

--name

common-options

Example

(Required) Name of the datastore.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

$ s vt-da tasto re-de lete -- name da talab Thi s actio n will de stroy a ny data r emain ing o n the d atast ore. Pro ceed? ( y/n): y

... ..... ..... ..... ..... ..... ..... ..... ..... .....

Tas k Compl ete

If VMs or backups exist, the command fails as follows:

~$ svt-d atast ore-d elete - -name M KO Thi s actio n will de stroy a ny data r emain ing o n the d atast ore. Pro ceed? ( y/n): y

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... .....

ERR OR [30] : You c annot d elete a d atast ore t hat i s used by V Ms. M igrat e or remo ve VMs an d try a gain. $

Related commands:

• svt-datastore-create Command on page 34

• svt-datastore-policy-set Command on page 36

• svt-datastore-resize Command on page 37

• svt-datastore-share Command on page 38

• svt-datastore-show Command on page 39

• svt-datastore-unshare Command on page 40

OmniCube CLI Reference 5 - Datastore Commands

svt-datastore-policy-set Command

The svt-datastore-policy-set command changes the default backup policy for a datastore. The new default policy applies only to any new VMs that you create after the policy change. Existing VMs continue to use the policy that was in force at their time of creation or the policy that you subsequently assigned to that VM.

See svt-policy-create Command on page 70 for information about creating a backup policy. You must add one or more rules to a backup policy to create backups. See the svt-policy-rule-create Command on page 72.

Use the svt-policy-show Command to display available policies and svt-datastore-show Command to list datastores.

Note: Use the svt-vm-policy-set command to set a backup policy for an individual VM and override the

default policy. See svt-vm-policy-set Command on page 47.

Format

svt-datastore-policy-set --datastore name --policy name [common-options]

Options

Options Description

--datastore

--policy

common-options

(Required) Name of the datastore.

(Required) Name of the new backup policy.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-da tasto re-po licy- set - -data store d s4 --po licy ho urly_ 12

... ..... ..... ..... ..... ..... ..... ..... .....

Tas k Compl ete

Related commands:

• svt-datastore-create Command on page 34

• svt-datastore-delete Command on page 35

• svt-datastore-resize Command on page 37

• svt-datastore-share Command on page 38

• svt-datastore-show Command on page 39

• svt-datastore-unshare Command on page 40

OmniCube CLI Reference 5 - Datastore Commands

svt-datastore-resize Command

The svt-datastore-resize command enables you to increase or decrease the capacity of a datastore by specifying a new size in GB, TB or PB.

When decreasing the size of a datastore, you cannot specify a size that is smaller than the space currently allocated to VMs in the datastore. The minimum size is 1GB.

You can list datastores to view the current size. See the svt-datastore-show Command on page 39.

Note: The size of a datastore is defined as the maximum amount of data the datastore can contain before the

written data is deduplicated and compressed.

Format

svt-datastore-resize --name datastore_name --size [nGB|nTB|nPB] [common-options]

Options

Options Description

--name

--size

common-options

(Required) Name of the SimpliVity datastore.

(Required) The revised size of the SimpliVity datastore in gigabytes terabyte, or petabytes (GB,TB,PB).

Common options applicable to all commands. See:

vCenter Identification and Authentication Options on page 12

Command Operation Control Options on page 13

Example

$ s vt-da tasto re-re size -- name fi nance -ds - -size 2 TB

Related Commands

• svt-datastore-create Command on page 34

• svt-datastore-delete Command on page 35

• svt-datastore-policy-set Command on page 36

• svt-datastore-share Command on page 38

• svt-datastore-show Command on page 39

• svt-datastore-unshare Command on page 40

OmniCube CLI Reference 5 - Datastore Commands

svt-datastore-share Command

The svt-datastore-share command enables you to allow access to Federation datastores from Non-SimpliVity ESXi hosts. This enables you to use vMotion™ and Storage vMotion™ and to enable VMs running on an ESXi host to access a datastore in a Federation, with no disruption to users. The VM remains running on the original ESXi host.

Before sharing a datastore, you must configure the NFS and network settings in the Non-SimpliVity ESXi host and configure the /etc/hosts file on Non-SimpliVity ESXi hosts. See OmniCube Configuration and Management for information about the required settings.

See OmniCube Release Notes for other constraints on datastore sharing and Non-SimpliVity ESXi host requirements.

Use the svt-datastore-show Command on page 39 to list datastores and the svt-datastore-unshare Command on page 40 to stop sharing datastores.

Note: You can use the --force common option to bypass command checking when adding multiple hosts by

using a script.

Format

svt-datastore-share --host non-simplivity-name|IP --datastore datastore-name [common-options]

Options

Options Description

--datastore

--host

commonoptions

[Required] The datastore for which access will be enabled.

The name or IP address of a non-SimpliVity ESXi host that will access the datastore, as it appears in the vSphere client.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-da tasto re-sh are - -host 1 29.23 .45.6 7 --dat astor e ds9re searc h

Bef ore s harin g a datas tore, y ou must f irst co nfigu re the no n-Sim pliVi ty ESXi h osts as d escri bed i n the O mniCu be use r docum entat ion

Pro ceed? ( y/n)

Related commands:

• svt-datastore-create Command on page 34

• svt-datastore-delete Command on page 35

• svt-datastore-policy-set Command on page 36

• svt-datastore-resize Command on page 37

OmniCube CLI Reference 5 - Datastore Commands

• svt-datastore-show Command on page 39

• svt-datastore-unshare Command on page 40

svt-datastore-show Command

The svt-datastore-show command displays information about the datastores and shares in the Federation:

• Datastore—The datastore name.

• Datacenter —The datacenter containing the named datastore.

• Policy—The datastore-wide default backup policy. See svt-datastore-policy-set Command on page 36 and

svt-policy-show Command on page 76.

• Size—The physical storage space allocated for this datastore. See svt-datastore-resize Command on page

37.

• Created at—The date and time of datastore creation. See svt-datastore-create Command on page 34.

• Shares—The name of a Non-SimpliVity ESXi host accessing this datastore. See svt-datastore-share

Command on page 38 and svt-datastore-unshare Command on page 40.

See also thesvt-vm-show Command on page 50.

Format

svt-datastore-show [common-options]

Options

Options Description

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-da tasto re-sh ow

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ----- ---.

| D atast ores |

+-- ----- ---+- ----- ----- +---- ----+ ----- --+-- ----------------- ----- +---- ----- ----- ---+

+-- ----- ---+- ----- ----- +---- ----+ ----- ----- ----------------- ----- +---- ----- ----- ---+

+-- ----- ---+- ----- ----- +---- ----+ ----- ----- ----------------- ----- +---- ----- ----- ---+

'-- ----- ---+- ----- ----- +---- ----+ ----- ----- ----------------- ----- +---- ----- ----- ---'

Related commands:

• svt-datastore-create Command on page 34

OmniCube CLI Reference 5 - Datastore Commands

• svt-datastore-delete Command on page 35

• svt-datastore-policy-set Command on page 36

• svt-datastore-resize Command on page 37

• svt-datastore-share Command on page 38

• svt-datastore-unshare Command on page 40

svt-datastore-unshare Command

The svt-datastore-unshare command stops sharing Federation datastores with a Non-SimpliVity ESXi host. See svt-datastore-share Command on page 38.

Format

svt-datastore-unshare --host non-simplivity-name|IP --datastore datastore-name [common-options]

Options

Options Description

--datastore

--host

common-options

[Required] The datastore to stop sharing.

The name or IP address of the Non-SimpliVity ESXi host that accessed the Federation datastore.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ svt-datastore-unshare --datastore ds9research --host nfsservr.svt

Related commands:

• svt-datastore-create Command on page 34

• svt-datastore-delete Command on page 35

• svt-datastore-policy-set Command on page 36

• svt-datastore-resize Command on page 37

• svt-datastore-share Command on page 38

• svt-datastore-show Command on page 39

OmniCube CLI Reference 5 - Datastore Commands

6 - Virtual Machine Commands

You use the vSphere Client to create a virtual machine (VM) in a Federation.

The following commands manage VMs in a Federation:

• svt-vm-backup—Creates a manual backup of a Federation VM. See svt-vm-backup Command on page 44.

• svt-vm-clone—Creates a new VM in the Federation that is a copy of an existing Federation VM. See svt-

vm-clone Command on page 45.

• svt-vm-move—Enables you to relocate a VM to a different datacenter. See svt-vm-move Command on page 46.

• svt-vm-policy-set —Sets the backup policy for a Federation VM. See svt-vm-policy-set Command on page 47.

• svt-vm-restore—Restores a Federation VM from a backup. See svt-vm-restore Command on page 49.

• svt-vm-show —Display information about all VMs in a Federation. See svt-vm-show Command on page

50.

OmniCube CLI Reference 6 - Virtual Machine Commands

svt-vm-backup Command

The svt-vm-backup command creates a manual backup of a virtual machine (VM) at the current time. A backup saves the state of the VM at the time you created the backup.

Unlike a policy backup, a manual backup is not deleted during the automatic cleanup performed by a backup policy (see the svt-policy-rule-create Command on page 72). You must manually delete these backups to make sure that they do not consume excessive system resources. See the svt-backup-show Command on page 62 for information about displaying manual backups.

The default operation is to take an instantaneous copy without using VMware operations. Manual backup options include:

• Application consistent—Include a VMware application consistent snapshot in the backup. This type of backup brings guest VM applications to a consistent state before taking a backup. Using application consistency increases the time required to complete a backup, and you should not use it for guest VMs that have high I/O.

• Remote datacenter—Specify a remote destination for the backup.

• Name—By default, the command creates a unique name for the backup by appending a timestamp to the VM name. You can override the default by specifying a unique name for the backup. You can also rename a backup at any time. See the svt-backup-rename Command on page 59.

You can later restore the VM from the backup or create a new VM that has the same point-in-time data as the source VM (at the time you created the backup). See the svt-vm-restore Command on page 49.

Note: To back up VMs by using a regular schedule (for disaster protection), use a backup policy. See the svt-

policy-create Command on page 70 and the svt-vm-policy-set Command on page 47.

Format

svt-vm-backup --datastore datastore-name --vm vm-name --name backup-name

--appconsistent --destination datacenter-name [common-options]

Options

Options Default Description

--appconsistent

--datastore

--destination

--name

--vm

common-options

local

Creates a VMware application consistent backup.

(Required) Name or GUID of the datastore that contains the VM.

The destination datacenter where the new backup is stored.

An optional name for the new backup. The default name appends a timestamp to the VMname to ensure unique backup names.

(Required) Name or GUID of the VM.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Exa mple $ s vt-vm -back up --vm u ser3 -- datas tore ds 2 --nam e backu p3-12 - -appc onsis tent

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... .....

OmniCube CLI Reference 6 - Virtual Machine Commands

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... .....

... ..... ..... ..... ..... ..... ..... ..... ..... .....

Tas k Compl ete

Related commands:

• svt-vm-clone Command on page 45

• svt-vm-move Command on page 46

• svt-vm-policy-set Command on page 47

• svt-vm-restore Command on page 49

• svt-vm-show Command on page 50

• Backup Policy Commands on page 69

• Backup Commands on page 53

svt-vm-clone Command

The svt-vm-clone command creates a new virtual machine (VM) that contains the same contents as an existing VM. The new VM has a different name, but resides in the same datastore as the original VM. Characteristics of the cloned VM are:

• Clone name—By default, the command appends the string -clone-<timestamp> to the original VM name. You can override this by specifying the --name option.

• Power status— The clone is powered off. Make sure you have sufficient CPU and memory resources before powering on the VM.

• Backup—As for any VM, you can back up a cloned VM using a policy (see the svt-policy-create

Command on page 70) or a manual backup (see the svt-vm-backup Command on page 44).

Note: Serial clone and backup operations can cause long object names. Use the appropriate renaming option to

shorten the name.

Format

svt-vm-clone --datastore datastore --vm vm --name new-name

--appconsistent [common-options]

Options

Options Description

--appconsistent

--datastore

--name

The resulting clone is created from an application consistent snapshot of the source VM, and is application consistent when powered on.

(Required) Name or GUID of the datastore containing the VM that you want to clone.

Name of the cloned (new) VM. If not specified, a name is assigned to the clone in the format

<vm-name>-clone-<date>-<time>.

OmniCube CLI Reference 6 - Virtual Machine Commands

Options Description

--vm

common-options

(Required) Name or GUID of the VM to clone.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-vm -clon e --vm la b29 - -data store d s4

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... .

Tas k Compl ete

Related commands:

• svt-vm-backup Command on page 44

• svt-vm-move Command on page 46

• svt-vm-policy-set Command on page 47

• svt-vm-restore Command on page 49

• svt-vm-show Command on page 50

svt-vm-move Command

The svt-vm-move command enables you to relocate a VM to a Federation datastore in a different datacenter or a different datastore contained in the same datacenter.

Considerations when moving VMs are:

• You must shut down the guest OS and power off the VM before you move it. Otherwise the operation will fail.

• After moving a VM, set its boot sequence so that it powers on after the Virtual Controller during startup, and shuts down before the Virtual Controller during shutdown.

• Any pre-move backups associated with the VM will show the VM as DELETED after the move completes. You can recover the VM from these backups. (See the svt-backup-restore Command on page

60.) To find backups for moved VMs, see the svt-backup-show Command on page 62.

• If the VM is subject to Policy backups, you cannot move a VM while a policy backup is in progress:

◦ You can cancel the backup, if it is in an appropriate backup state.

◦ You can wait for a backup to complete.

By default, the command uses the original VM name as the name for the moved VM. You can override the default by specifying a unique name for the moved VM. You can move a VM to and from a remote datacenter.

Format

OmniCube CLI Reference 6 - Virtual Machine Commands

svt-vm-move --source datastore --vm vm --datacenter datacenter

--destination datastore --name vm-name [common-options]

Options

Options Description

--datacenter

--destination

--name

--source

--vm

commonoptions

Name of the datacenter containing the destination datastore. The default is the datacenter containing the VM.

(Required) Name of a destination datastore that will contain the relocated VM.

Name for the relocated VM. The default is the original VM name.

(Required) Name of the datastore containing the original VM (the source of the move operation).

(Required) Name (or GUID) of the original VM that you want to move.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12.

• Command Operation Control Options on page 13

Example

$ s vt-vm -move - -sour ce ds4 -- vm ubnt u-mv -- desti natio n reloc ated -- name mvd -ubnt u

Upo n compl etion , the V M will re main po wered o ff in t he new lo catio n. Pro ceed? ( y/n) Y

... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... .....

Tas k Compl ete

Related commands:

• svt-vm-backup Command on page 44

• svt-vm-clone Command on page 45

• svt-vm-policy-set Command on page 47

• svt-vm-restore Command on page 49

• svt-vm-show Command on page 50

svt-vm-policy-set Command

The svt-vm-policy-set command sets the backup policy for a virtual machine (VM). A backup policy enables you to schedule VM backup operations and control the frequency and number of backups retained. You can also create a manual backup at any time (see the svt-vm-backup Command on page 44).

By default, each VM inherits the backup policy assigned to the datastore in which the VM resides. If you change the VM's backup policy to a different policy from the datastore default, any changes to the datastore default policy are ignored by the VM. Use the svt-vm-policy-set command to change the backup policy for a VM.

See svt-policy-create Command on page 70 for information about creating a backup policy. To create VMbackups, add one or more rules to a backup policy. See the svt-policy-rule-create Command on page 72.

OmniCube CLI Reference 6 - Virtual Machine Commands

Note: You can assign only one backup policy to a VM. However, a backup policy can contain an unlimited

number of rules.

Modifying Backup Rules

If you modify backup policy rules, all VM backups created under the previous policy rule continue to exist and consume storage space. These backups are automatically deleted according to the retention rules of the previous policy. If you want to remove them sooner, you must manually delete the backups at an appropriate time.

To delete many backups, use the svt-backup-delete Command on page 56. If you want to retain the backups, use the svt-backup-lock Command on page 57.

Format

svt-vm-policy-set --datastore datastore_name --vm vm_name --policy ploicy_name [common-options]

Options

Options Description

--datastore

--policy

--vm

common-options

(Required) Name of the datastore that contains the VM.

(Required) Name of the backup policy.

(Required) Name of the VM.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-vm -poli cy-se t --vm us er23 -- datas tore ds 4 --pol icy d aily

... ..... ..... ...

Tas k Compl ete

Related commands:

• svt-policy-create Command on page 70

• svt-policy-delete Command on page 70

• svt-vm-backup Command on page 44

• svt-vm-clone Command on page 45

• svt-vm-move Command on page 46

• svt-vm-restore Command on page 49

• svt-vm-show Command on page 50

OmniCube CLI Reference 6 - Virtual Machine Commands

svt-vm-restore Command

The svt-vm-restore command restores a virtual machine (VM) from a backup. The backup still exists after the restore operation. The svt-vm-restore command replaces the contents of the VM with the contents that existed at the time the backup was created.

If the restored VM was powered on at the time of the restore operation, it is powered off during the operation and remains powered off when the operation is complete.

Important: Restoring a VM deletes any data changes that have occurred since you created the backup. Use

the svt-backup-restore Command on page 60 to restore a VM without deleting the original VM.

Format

svt-vm-restore --vm vm_name --datastore datastore_name --backup backup_name [common-options]

Options

Options Description

--backup

(Required) Name of the backup.

If the name includes spaces, surround all the text with quotes.

--datastore

--vm

common-options

(Required) Name of the datastore that contains the VM.

(Required) Name of the VM.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ svt-vm-restore --vm TiCore4.5.4 --datastore LTN-1 --backup '2013-Nov-11 19:59:00 EST'

This action will replace the data on your VM.

If the VM is currently powered on, it will be powered off.

Proceed? (y/n): y

....................

Task Complete

Related commands:

• svt-backup-restore Command on page 60

• svt-vm-backup Command on page 44

• svt-vm-clone Command on page 45

• svt-vm-move Command on page 46

• svt-vm-policy-set Command on page 47

• svt-vm-show Command on page 50

OmniCube CLI Reference 6 - Virtual Machine Commands

svt-vm-show Command

The svt-vm-show command displays information about VMs in a Federation datastore. You can also display deleted and removed VMs for which there are existing backups. (You can recover VMs from backups as described in the svt-vm-restore Command on page 49.)

This command provides the following information:

• Datacenter name —Name of the datacenter containing the datastore or datastores.

• Datastore name—Name of the datastore or datastores containing the virtual machines.

• Virtual Machine—Name of the virtual machines.

• Policy—The backup policy assigned to a virtual machine.

• Storage HA—Whether the virtual machine is in Storage High Availability (HA) compliance (synchronized). This does not apply to single OmniCube systems, only to a minimum of a pair of OmniCube systems.

• Created At—Timestamp of the virtual machine creation.

Format

svt-vm-show --datastore datastore-name --all --deleted --removed

[common-options]

Options

Options Description

--all

--datastore

--deleted

--removed

common-options

Shows active, deleted, and removed VMs.

Name of the datastore for which VMs are displayed. If not specified, the command lists all VMs in all datastores.

Shows only VMs that you deleted with the VMware Delete from Disk option. (You deleted the VM from disk , but at least one SimpliVity VMbackup persists.).

You can restore the deleted VM from any persisting SimpliVity backup.

Shows only VMs that you removed from the vSphere inventory with the VMware Remove from

Inventory option. You can browse to the datastore, right click on the .vmx file and then use the

VMware Add to Inventory option to restore the VM.

You can also restore the removed VM from a SimpliVity backup, if you retained at least one SimpliVity VM backup.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

In the following example, VM names are truncated and the formatting is compressed to make the output fit the page.

~$ svt-v m-sho w --all

OmniCube CLI Reference 6 - Virtual Machine Commands

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ----- ----- ----- ----.

| V irtua l Machi nes b y Datas tore |

+-- ----- ---+- ----- ---+- ----- ----- ----- ----- -------+------+-- ----- ---+- ----- ----- ----- ----- ----+

+-- ----- ---+- ----- ---+- ----- ----- ----- ----- -------+------+-- ----- ---+- ----- ----- ----- ----- ----+

| d n2 | ds3 | Ub -124D C [DELE TED < date> ] |hifr eq| N o |We d Nov 2 1 16:58 :49 2 012 |

+-- ----- ---+- ----- ---+- ----- ----- ----- ----- -------+------+-- ----- ---+- ----- ----- ----- ----- ----+

+-- ----- ---+- ----- ---+- ----- ----- ----- ----- -------+------+-- ----- ---+- ----- ----- ----- ----- ----+

'-- ----- ---+- ----- ---+- ----- ----- ----- ----- -------+------+-- ----- ---+- ----- ----- ----- ----- ----'

Related commands:

• svt-vm-backup Command on page 44

• svt-vm-clone Command on page 45

• svt-vm-move Command on page 46

• svt-vm-policy-set Command on page 47

• svt-vm-restore Command on page 49

OmniCube CLI Reference 6 - Virtual Machine Commands

7 - Backup Commands

The following backup commands manage virtual machine (VM) backups in a Federation.

• svt-backup-cancel—Cancel an in-progress backup. See the svt-backup-cancel Command on page 54.

• svt-backup-copy—Copies a VM backup to a remote datacenter. See the svt-backup-copy Command on page 55.

• svt-backup-delete—Deletes a VM backup. See the svt-backup-delete Command on page 56.

• svt-backup-lock—Permanently saves an automatic VM backup, preventing it from being recycled (deleted according to policies in force). See the svt-backup-lock Command on page 57.

• svt-backup-rename—Renames a VM backup. See the svt-backup-rename Command on page 59.

• svt-backup-restore—Restores a backup of a VM, creating a new VM on any available datacenter. See the svt-backup-restore Command on page 60.

• svt-backup-show—Displays VM backups. See the svt-backup-show Command on page 62.

• svt-backup-size-calculate—Enables you to determine the unique data in a backup so that you can recover storage space. See thesvt-backup-size-calculate Command on page 65

OmniCube CLI Reference 7 - Backup Commands

svt-backup-cancel Command

The svt-backup-cancel command cancels a virtual machine (VM) backup the is in-progress

If a backup name contains spaces, use straight quotes as follows:

--backup "2012-Nov-12 14:00"

You can cancel a backup only when it is in one of the following states (see the svt-backup-show Command on page 62):

• New—The VM copy for a remote backup is complete, but the replication to the remote site has not yet begun. The state will change to saving or failed. (Be aware that this state is transient, and it is unlikely to coincide with the cancel operation.)

• Queued —The backup is waiting to be replicated to a remote datacenter. Backups that are destined for a remote datacenter will go through the following states: New, Queued, Saving, Protected. If replication to a remote datacenter is temporarily blocked, the backup may alternate between Queued and Saving. When successfully replicated, it will go to the Protected state. You might not be able to cancel backups in the queued state may, depending whether they are queued for a first replication attempt or a retry.

• Saving—The backup replication is in progress. The state will change to protected or failed. This state can take some time to complete and therefore is most likely to coincide with a cancel operation.

You cannot cancel a backup when it is in one of the following states:

• Failed—The backup was unsuccessful. Delete such backups and if the outcome of backup operations fails consistently, contact your support provider.

• Protected—The backup is successful and the data protected. If the backup was a remote backup, successful replication to the remote site has also completed.

• Unknown—The backup is in an indeterminate state. Delete such backups and if the outcome of backup operations persist as Unknown , contact your support provider.

During a cancellation, the following backup states might appear in the output of the svt-backup-show Command

• Canceling—The backup operation is responding to a manual cancellation of a backup in progress.

• Canceled—The backup operation was successfully canceled.

Format

svt-backup-cancel --datastore datastore --vm vm --backup backup

--datacenter datacenter [common-options]

Options

Options Description

--backup

--datacenter

(Required) The name or GUID of the backup.

The datacenter containing the backup.

OmniCube CLI Reference 7 - Backup Commands

Options Description

--datastore

--vm

common-options

(Required) Name or GUID of the datastore containing the VM.

(Required) Name or GUID of the VM that was backed up.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-ba ckup- cance l --vm W2 8Kusr - -data store d USR4 -- backu p "2012 -Nov- 12 14 :00"

... ..... ..... ..... ....

Tas k Compl ete

Related commands:

• svt-backup-copy Command on page 55

• svt-backup-delete Command on page 56

• svt-backup-lock Command on page 57

• svt-backup-rename Command on page 59

• svt-backup-restore Command on page 60

• svt-backup-show Command on page 62

• svt-backup-size-calculate Command on page 65

svt-backup-copy Command

The svt-backup-copy command copies VM backups to remote datacenters. Use this command to create a copy of a backup.

Be aware that using svt-backup-copy might not preserve the original backup. If you used a policy to create the original backup, that backup is still subject to deletion under the backup policy retention rule. Use svt-backup-

lock to preserve the original obackup.

Format

svt-backup-copy --datastore datastore --vm vm --backup backup

--source datacenter --destination datacenter [common-options]

Options

Options Description

--backup

--datastore

Name or GUID of the backup. If not specified, the most recent backup is copied. If the name includes spaces, surround all the text with quotes.

(Required) Name or GUID of the datastore containing the VM.

OmniCube CLI Reference 7 - Backup Commands

Options Description

--destination

--vm

--source

common-options

(Required) Name or GUID of the destination datacenter for the backup copy.

(Required) Name or GUID of the VM that was backed up.

The source datacenter. If not specified, the command references all datacenters.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

svt-backup-copy --datastore Tokyo_DS2 --vm Agaki-Win28K

--source Tokyo --destination San_Fran

Related commands:

• svt-backup-cancel Command on page 54

• svt-backup-delete Command on page 56

• svt-backup-lock Command on page 57

• svt-backup-rename Command on page 59

• svt-backup-restore Command on page 60

• svt-backup-show Command on page 62

• svt-backup-size-calculate Command on page 65

svt-backup-delete Command

The svt-backup-delete command deletes one or more backups of a virtual machine (VM).

If a backup name contains spaces, use single quotes as follows:

--backup "2012-Nov-12 14:00"

Format

svt-backup-delete --datastore datastore --datacenter datacenter

--datacenter-id datacenter_id --datastore-id datastore_id --vm vm

--vm-id vm_id --backup backup [common-options]

Options

Options Description

--backup

--datacenter

Name or GUID of the backup. If not specified, all backups are deleted. If the name includes spaces, surround all the text with quotes.

The datacenter containing the backup. If not specified, the command references all

OmniCube CLI Reference 7 - Backup Commands

Options Description

datacenters that contain backups of the named VM. This option is mutually exclusive with --datacenter-id.

--datacenter-id

The GUID of a datacenter by which the query is scoped. If not specified, the command references all datacenters that contain backups of the named VM. This

option is mutually exclusive with --datacenter.

--datastore

(Required) Name of the datastore containing the VM. This option is mutually exclusive with --datastore-id.

--datastore-id

(Required) The GUIDof a datastore by which the query is scoped. This option is mutually exclusive with --datastore.

--vm

(Required) Name of the VM that was backed up. This option is mutually exclusive with --vm-id

--vm-id

(Required) The GUID of a VMby which the query is scoped. This option is mutually exclusive with --vm.

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Examples

$ s vt-ba ckup- delet e --vm W2 8Kusr - -data store d USR4 -- backu p "2012 -Nov- 12 14 :00"

... ..... ..... ..... ....

Tas k Compl ete

$ s vt-ba ckup- delet e --dat astor e ds1 - -VM c w-ubu ntu-2 0 Thi s will de lete al l the b ackup s assoc iated w ith c w-ubu ntu-2 0. Pro ceed? ( y/n) y

... ..... ..

Tas k Compl ete

Related commands:

• svt-backup-copy Command on page 55

• svt-backup-lock Command on page 57

• svt-backup-rename Command on page 59

• svt-backup-restore Command on page 60

• svt-backup-show Command on page 62

• svt-backup-size-calculate Command on page 65

svt-backup-lock Command

The svt-backup-lock command preserves automatic (policy) VM backups, preventing them from deletion.

Normally, a backup policy keeps backups for the retention period that you specify in the policy, such as two

days. Use svt-backup-lock if you want to keep a backup until you decide to delete it manually. See the svt-

policy-create Command on page 70.

OmniCube CLI Reference 7 - Backup Commands

The backup is marked as locked in the output from svt-backup-show. See the svt-backup-show Command on page 62.

You can also use svt-backup-copy to preserve a backup by copying it to a remote datacenter.

Format

svt-backup-lock --datastore datastore --vm vm --backup backup [common-options]

Options

Options Description

--datastore

--vm

--backup

common-options

(Required) Name or GUID of the datastore containing the backed-up VM.

(Required) Name or GUID of the VM that was backed up.

(Required) Name or GUID of the backup.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-ba ckup- show -- datas tore ds 1 --vm cw -ubun tu-20

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- --\

| B ackup s of VM c w-ubu ntu-2 0 \

+-- ----- ----- ----- --+-- ----- -+--- ----- ----- ---+------------- ----- ----- ---+- ----\

+-- ----- ----- ----- --+-- ----- -+--- ----- ----- ---+------------- ----- ----- ---+- ----- -\

'-- ----- ----- ----- --+-- ----- -+--- ----- ----- ---+------------- ----- ----- ---+- ----- ----\

$ s vt-ba ckup- lock -- backu p "2012 -Nov- 12 15:0 0" --da tasto re ds1

--V M cw-ub untu- 20

Tas k Compl ete

$ s vt-ba ckup- show -- datas tore ds 1 --vm cw -ubun tu-20

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ----- ----\

| B ackup s of VM c w-ubu ntu-2 0 \

+-- ----- ----- ----- --+-- ----- -+--- ----- ----- ---+------------- ----- ----- ---+- ----- ----- -\

+-- ----- ----- ----- --+-- ----- -+--- ----- ----- ---+------------- ----- ----- ---+- ----- ----- --+\

| 2 012-N ov-12 1 5:00 | Lo cked | no | Mo n Nov 1 2 15:00 :03 2 012 | D atace nter1 | \

'-- ----- ----- ----- --+-- ----- -+--- ----- ----- ---+------------- ----- ----- ---+- ----- ----- --+-- -\

Related commands:

• svt-backup-cancel Command on page 54

• svt-backup-copy Command on page 55

• svt-backup-delete Command on page 56

OmniCube CLI Reference 7 - Backup Commands

• svt-backup-rename Command on page 59

• svt-backup-restore Command on page 60

• svt-backup-show Command on page 62

• svt-backup-size-calculate Command on page 65

svt-backup-rename Command

The svt-backup-rename command renames an existing VM backup.

Renaming a backup does not prevent it from automatic deletion under backup policy retention rules. To prevent a backup from automatic deletion, use the svt-backup-lock command.

Note: It is possible to have two copies of the same backup stored in separate datacenters. If you rename the

backup in one datacenter, the backup in the other datacenter is also renamed.

Format

svt-backup-rename --datastore datastore --vm vm --backup backup

--name new-name [common-options]

Options

Options Description

--backup

--datastore

--name

--vm

common-options

(Required) Original Name (or GUID) of the backup. Use Quotes if the name contains spaces.

(Required) Name or GUID of the datastore containing the backed-up VM.

(Required) New name for the backup. Use quotes if the name contains spaces.

(Required) Name or GUID of the VM that was backed up.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

svt-backup-rename --datastore San_Fran --vm Accounting_LX

--backup "Acct_Weds 10:30" --name Acct_Weds_Archive

The following command sequence shows a before-and-after example of the command:

$ s vt-ba ckup- show -- datas tore ds 1 --vm cw -ubun tu-20

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- -\

| B ackup s of VM c w-ubu ntu-2 0 \

+-- ----- ----- ----- ----- ----- ----- ----- ----+ --------+-------- ----- ---+- ---\

| N ame | S ource | A pp Cons isten t | Time\

+-- ----- ----- ----- ----- ----- ----- ----- ----+ --------+-------- ----- ---+- ----- \

| c w-ubu 1 456 | Man ual | n o | M on No\

| c w-ubu ntu-2 0-bac kup-2 012-1 1-12- 15:27 :03 | M anual | n o | Mon No v\

OmniCube CLI Reference 7 - Backup Commands

'-- ----- ----- ----- ----- ----- ----- ----- ----+ --------+-------- ----- ---+- ----- ---\

$ s vt-ba ckup- renam e --dat astor e ds1 - -vm c w-ubu ntu-2 0 --bac kup " cw-ub u 1456"

--n ame c w-ubu -20-t oday

Tas k Compl ete

$ s vt-ba ckup- show -- datas tore ds 1 --vm cw -ubun tu-20

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- -- \

| B ackup s of VM c w-ubu ntu-2 0 \

+-- ----- ----- ----- ----- ----- ----- ----- ----+ --------+-------- ----- ---+- \

| N ame | S ource | A pp Cons isten t | T\

+-- ----- ----- ----- ----- ----- ----- ----- ----+ --------+-------- ----- ---+- --\

| c w-ubu -20-t oday | M anual | n o | M on\

| c w-ubu ntu-2 0-bac kup-2 012-1 1-12- 15:27 :03 | M anual | n o | Mon \

'-- ----- ----- ----- ----- ----- ----- ----- ----+ --------+-------- ----- ---+- ----- \

Related commands:

• svt-backup-copy Command on page 55

• svt-backup-delete Command on page 56

• svt-backup-lock Command on page 57

• svt-backup-restore Command on page 60

• svt-backup-show Command on page 62

• svt-backup-size-calculate Command on page 65

svt-backup-restore Command

The svt-backup-restore command restores a VM backup to a new VM at any accessible datacenter and datastore. You can use this command to create a new VM, preserving the original VM. (The VMthat was the backup source.)

By default, the command appends the string -restore-<timestamp> to the original VM name when creating a name for the restored VM.

You can use the svt-backup-restore Command on page 60 to replace the content of an existing VM.

Format

svt-backup-restore --datastore datastore --vm vm --backup backup

--source datacenter --destination datacenter --home datastore

--name vm [ common-options]

Options

--backup

Options Description

Name or GUID of the backup to restore. If not specified, the command references the most recent backup by its timestamp. If the name includes spaces, surround all the text

OmniCube CLI Reference 7 - Backup Commands

Options Description

with quotes.

--datastore

--destination

(Required) Name or GUID of the datastore containing the VM.

The destination datacenter for the restore operation. If not specified, the command references the original datacenter containing the backed-up VM.

--home

The destination datastore for the new VM operation. If not specified, the command references the original datastore containing the backed-up VM.

--name

--source

--vm

common-options

The name of the new VM. If not specified, the command appends the string -

restore-<timestamp> to the original VM name.

The source datacenter. If not specified, the command references all datacenters.

(Required) Name or GUID of the VM that was backed up.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

svt-backup-restore --datastore London_DS2 --vm Eng1-Win28K

--backup Eng1_weekly_Fri --source London_Eng --destination Tokyo_Eng

--home datastore --name VM_Eng1_Lon [common-options]

The following example shows a before-and-after use of the command:

$ s vt-ba ckup- show -- datas tore ds 1 --vm cw -ubun tu-20

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- -\

| B ackup s of VM c w-ubu ntu-2 0 \

+-- ----- ----- ----- ----- ----- ----- ----- ----+ --------+-------- ----- ---+- ---\

| N ame | S ource | A pp Cons isten t | Time\

+-- ----- ----- ----- ----- ----- ----- ----- ----+ --------+-------- ----- ---+- ----- \

| 2 012-N ov-12 1 6:00 | Lock ed | no | Mon No \

| 2 012-N ov-12 1 6:00 | Poli cy | no | Mon No v\

| c w-ubu -20-t oday | M anual | n o | M on Nov \

| c w-ubu ntu-2 0-bac kup-2 012-1 1-12- 15:27 :03 | M anual | n o | Mon No v 1\

'-- ----- ----- ----- ----- ----- ----- ----- ----+ --------+-------- ----- ---+- ----- ----- \

$ s vt-ba ckup- resto re --da tasto re ds1 -- vm cw-u buntu -20

--b ackup " 2012- Nov-1 2 16:00 " --sou rce D atace nter1

... ..... ..... ..... ..... .....

Tas k Compl ete

$ s vt-vm -show

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ----- --\

| V irtua l Machi nes b y Datas tore \

+-- ----- ----- -+--- ----- ---+- ----- ----- ----- ----------------- ----- ----- ----- ----+ ----\

| D atace nter | Datastore | Vi rtual M achin e | Poli\

+-- ----- ----- -+--- ----- ---+- ----- ----- ----- ----------------- ----- ----- ----- ----+ ----- -\

| D atace nter1 | d s1 | cw -ubun tu-20 | d efaul \

| D atace nter1 | | c w-ubu ntu-2 0-res tore- 2012- 11-12 -16:0 0:02 | de fault \

| D atace nter1 | | w in2k8 -iom- 4dd-1 00gb- 65-10 | de fault \

'-- ----- ----- -+--- ----- ---+- ----- ----- ----- ----------------- ----- ----- ----- ----+ ----- ----+ --\

Related commands:

OmniCube CLI Reference 7 - Backup Commands

• svt-backup-copy Command on page 55

• svt-backup-delete Command on page 56

• svt-backup-lock Command on page 57

• svt-backup-rename Command on page 59

• svt-backup-show Command on page 62

• svt-backup-size-calculate Command on page 65

svt-backup-show Command

The svt-backup-show command displays the backups created for a virtual machine (VM). The command lists backups created by a backup policy rule and backups created manually with the svt-vm-backup command.

Notes: If you removed or deleted a VM from the vSphere inventory and you specify the -all option, the

command identifies persisting backups using the string [REMOVED] or [DELETED] in the command output. You can recover VMs from these backups. See the svt-backup-restore Command on page 60 and the svt-backup-restore Command on page 60.

If you removed a VM using Remove from Inventory using VMware rather than deleting it, you can also use the VMware Add to Inventory option to restore the VM as it was at the time of removal. In this case, the VM's backups revert to ownership by that VM and the [REMOVED] string no longer appears in the output.

Information Available When Using svt-backup-show

The following information is provided:

• Datastore—The datastore containing the backed-up VM.

• VM—The virtual machine that was the target of the backup operation.

• Name—The backup name, a user-specified name or a timestamp if a policy creates the backup. Considerations for policy backup names are:

◦ A plus symbol (+) appended to a backup indicates that one or more policy backups was unable to

complete on schedule. This might be due to system unavailability, scheduling conflicts, or any other system issue that prevents the backup from occurring on schedule.

• Source—The operation that created the backup:

◦ Policy—An automatic policy created the backup. The backup is subject to automatic deletion when its

retention period expires or when the maximum number of backups is exceeded. In the latter case, the oldest backups are deleted first.

You can lock a policy backup to prevent its automatic deletion.

◦ Manual—A user manually created this backup. Manual backups are not deleted automatically. See the

svt-vm-backup Command on page 44 and the svt-backup-delete Command on page 56.

OmniCube CLI Reference 7 - Backup Commands

◦ Locked—A user has locked a policy backup to prevent its automatic deletion. The backup is preserved

until you delete it manually. See the svt-backup-lock Command on page 57.

• App Consistent—Whether the backup includes a VMware snapshot, which flushes all I/O to disk, enabling you to restore the VM and its applications in a consistent state.

• Timestamp—The date and time of the backup.

• Datacenter—The datacenter containing the backup.

• State—The status of the backup:

◦ New—The VM copy for a remote backup is complete, but the replication to the remote site has not yet

begun. The state will change to saving or failed.

◦ Saving—The backup replication is in progress. The state will change to protected, queued, or failed.

◦ Queued—The backup is waiting for replication to a datacenter (possibly a remote datacenter). This

might be a first attempt and the backup task queued while waiting for a previous replication to complete. It might also be queued after a failed replication, and the task is waiting for another replication opportunity.

◦ Failed—The backup was unsuccessful. Delete such backups and if the outcome of backup operations

fails consistently, contact your support provider.

◦ Protected—The backup is successful and the data protected. If the backup was a remote backup,

successful replication to the remote site has also completed.

◦ Canceling—The backup operation is responding to a manual cancellation of a backup in progress.

◦ Canceled—The backup operation was successfully canceled.

• Size—The logical size of the backup.

• Sent—In cases where the backup is sent to a remote location, the volume of data in transfer or transferred.

Filtering and Sorting When Using svt-backup-show

A Federation might contain a large number of manual and policy backups. The command options enable you sort and filter the backups so that you can easily find specific backups.

The maximum number of backups returned by a filter is 500. For example, if you have 3772 backups only 500 backups are listed, even though there might be many more backups that matched the filter conditions.

Format

svt-backup-show --consistency [application-consistent|normal] --datacenter datacenter_name

--datastore datastore_name --max-sent-size [nnn b|kb|mb|gb|tb]

--max-size [nnn b|kb|mb|gb|tb] --min-size[nnn b|kb|mb|gb|tb]

--max-unique-size [nnn b|kb|mb|gb|tb] --min-sent-size [nnn b|kb|mb|gb|tb]

--min-unique-size [nnn b|kb|mb|gb|tb] --name backup-name

--until mm-dd-yyyy --since mm-dd-yyyy --vm vm-name --vm-state [active|deleted|removed] [common-options]

OmniCube CLI Reference 7 - Backup Commands

Options

Options Description

--consistency

--datacenter

--datastore

--max-sent-size

--max-size

--max-unique-size

--min-sent-size

--min-size

--min-unique-size

--name

--since

--sort

--source

--status

--until

--vm

--vm-state

common-options

Whether or not the backup is application consistent. You can specify a commaseparated list of:application-consistent, normal.

List only backups contained in this datacenter.

List all backups in the specified datastore. If you also specify --vm, the datastore containing the source VM. If you do not specify a datastore, the command references all accessible datastores.

The upper limit for the volume of data transferred to a remote datacenter.

The upper limit for the logical size of the backup.

The upper limit for the volume of unique (non-deduplicated) data in a backup. The list of backups must contain backups for which you have performed a unique backup size calculation.

The lower limit for the volume of data transferred to a remote datacenter.

The lower limit for the logical size of the backup.

The lower limit for the volume of unique (non-deduplicated) data in a backup. The list of backups must contain backups for which you have performed a unique backup size calculation.

Name of the Backup. You can also specify a string pattern to match, using asterisks as the wildcard character.

The lower limit for the date of backup creation. (List backups taken after this date.)

Sort the command output by a specific attribute or value. You can specify any one of:

name, timestamp (the default), consistency, state, datacenter, sent, datastore, vm, source, size, unique-size, vm-state.

The method of backup creation. You can specify a comma-separated list consisting of any combination of: saved, manual, policy.

The current backup status. You can specify a comma-separated list consisting of any combination of: new, evaluate, protected, saving, canceled, canceling, failed, queued.

The upper limit for the date of backup creation. (List backups taken before this date.)

Name of the source VM. If not specified, the command references all accessible VMs.

The current condition of the source VM. You can specify a comma-separated list consisting of any combination of active, deleted or removed.

Common options applicable to all commands. See:

Examples

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

OmniCube CLI Reference 7 - Backup Commands

$ svt-backup-show --consistency application-consistent --datacenter ds53x

--datastore Zk01 --max-size 100gb --since 03-10-2015 --sort name --source manual

--vm-state active

Related commands:

• svt-backup-copy Command on page 55

• svt-backup-delete Command on page 56

• svt-backup-lock Command on page 57

• svt-backup-rename Command on page 59

• svt-backup-restore Command on page 60

• svt-backup-show Command on page 62

• svt-backup-size-calculate Command on page 65

svt-backup-size-calculate Command

The svt-backup-size-calculate command enables you to determine the unique data in a backup, which represents the amount of physical storage space consumed exclusively by this backup.

Consider a 100 GB VM named CalcVM which is the source VM for your backups.

You take CalcVMBackup1, at 10:00 PM. You then run user applications on CalcVM causing 10GB of changed data (data delta). After 2 hours, you take another backup named CalcVMBackup2.

The first backup, CalcVMBackup1 has a logical size of 100 GB, but it shares 90 GB of data in common with both

CalcVMBackup2 and CalcVM (the source VM).

Therefore:

• CalcVMBackup1 contains 10 GB of unique data, corresponding to the 10 GB data delta.

• CalvVMBackup2 has a logical size of 100 GB, but contains 0 (zero) bytes of unique data. Its data content is exactly the same as the source VM at the point in time that you created the backup.

In general, chronologically older VMbackups tend to contain larger amounts of unique data and consume more physical storage space. More recent backups tend to consume less physical storage space and more logical space.

Knowing the location of unique data in backups enables you to:

OmniCube CLI Reference 7 - Backup Commands

• Identify and compare VM backups for unique data size and logical data size, and consider carefully whether you need to retain the older backups in accordance with your site-specific recovery point objectives.

• Make decisions about which backups to delete so that you might recover physical storage space.

Deleting backups is only one of a number of methods of freeing up physical space. You can also:

1. Delete any unwanted VMs that are already Removed from Inventory.

2. Delete any existing surplus VMs such as test VMs or clones.

3. Clean up backups that show as [DELETED] when you run the svt-backup-restore Command on page 60.

Retain the minimum number of backups required for recovery according to your recovery point objective. Be aware that:

– Policy backups age out (expire) according to retention rules unless locked. – Manual and locked backups never age out (expire), and you must delete them manually.

4. Reduce backups of current VMs to an optimum level.

5. Make sure that backup policy rules are creating an optimum number of backups.

6. Move VMs (perhaps only temporarily while cleaning up)to locations that have more available resources.

After you run the svt-backup-size-calculate command, you run the svt-backup-show Command with the -

output XMLoption, specifying the backup for which you calculated the unique data size. The XML output

provides the following backup attributes:

• <uniqueSize></uniqueSize>—The backup's unique data size in bytes at the point-in-time of the timestamp.

• <logicalSize></logicalSize>—The backups logical size in bytes at the point-in-time of the timestamp.

• <lastTimeSizeCalc></lastTimeSizeCalc>—The timestamp of the calculation. Consider recalculating the backup size if the timestamp is more than a few days old.

Note: The process of calculating unique data consumes system resources and might result in a noticeable

decrease in I/O performance and slower Federation response times.

Format

svt-backup-size-calculate --vm vm-name|GUID --datastore [datastore-name|GUID]

--backup backup-name|GUID --datacenter [datacenter-name|GUID] [common-options]

Options

Options Default Description

--backup

--datacenter

(Required) Name or GUID of a backup of the original VM. A backup name typically contains spaces, and you must enclose the name string in single quotes.

(Required) Name or GUID of the datacenter containing the datastore.

OmniCube CLI Reference 7 - Backup Commands

Options Default Description

--datastore

--vm

common-options

(Required) Name or GUID of the datastore containing the original VM.

(Required) Name or GUID of the original VM that was backed up.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-ba ckup- size- calcu late -- vm Win2 8kFin ance -- datas tore Ac ctng

--b ackup 1 296D0 E6-49 C0-44 6B-B9 5D-1A 4C292 B46BD - -data cente r mosko vits

Thi s opera tion mi ght t empor arily r educe I O perfo rmanc e durin g perio ds of h eavy IO .

Pro ceed? ( y/n): y

Onc e the t ask c omple tes, ru n svt-b ackup -show - o XML t o see r esult s.

... ..... ..... ...

Tas k Compl ete

To see the results:

roo t@dvm -3:/v ar/tm p/bui ld# s vt-ba ckup- show -d atast ore A cctng - vm Win2 8kFin ance -o X ML

<pe rcent Trans >0

<da tasto re>de fault </dat astor e>

<id >a76a 72fe- fbf6- 45d7- 99b7- c7223 f4e76 0a

<hi veNam e>Win 28kFi nance </hiv eName >

</C omman dResu lt>

Related Commands:

OmniCube CLI Reference 7 - Backup Commands

◦ svt-backup-show Command on page 62

◦ svt-backup-delete Command on page 56

8 - Backup Policy Commands

Use the following backup policy commands to manage the backup policies for datastores and virtual machines (VMs) in a Federation:

• svt-policy-create—Creates a backup policy. See svt-policy-create Command on page 70.

• svt-policy-delete—Deletes a backup policy. See svt-policy-delete Command on page 70.

• svt-policy-rename—Renames a backup policy. See svt-policy-rename Command on page 71.

• svt-policy-rule-create—Creates a rule for a backup policy. See svt-policy-rule-create Command on page 72.

• svt-policy-rule-delete—Deletes a rule for a backup policy. See svt-policy-rule-delete Command on page 75.

• svt-policy-show—Displays the backup policies and rules. See svt-policy-show Command on page 76.

OmniCube CLI Reference 8 - Backup Policy Commands

svt-policy-create Command

The svt-policy-create command creates a backup policy in a Federation. For each datastore in a Federation, you set a default backup policy that applies to new virtual machines (VMs) created in the datastore. You can also set a specific backup policy for an individual Federation VM.

There is no limit to the number of backup policies you can create in a Federation.

Note: After creating a backup policy, you must create at least one rule for the policy in order for the policy to

create backups. See the svt-policy-rule-create Command on page 72.

Format

svt-policy-create --name policy_name [common-options]

Options

Options Description

--name

common-options

(Required) Name of the backup policy.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ svt-policy-create --name daily1

................

Task Complete

svt-policy-delete Command

The svt-policy-delete command deletes a backup policy in a Federation.

Instead of deleting a policy, you can manage rules in a backup policy. See the svt-policy-rule-create Command on page 72 and the svt-policy-rule-delete Command on page 75.

If you delete a backup policy, all VM backups created under the policy continue to exist and consume storage space. These backups are automatically deleted according to the retention rules of the deleted policy. If you want to remove them sooner, you must manually delete the backups at an appropriate time (see svt-backup-

delete Command on page 56). If you want to keep these backups, you can also lock backups to prevent their

automatic deletion (see svt-backup-lock Command on page 57).

Note: You cannot delete a backup policy if it is assigned to a datastore or a VM.

Format

svt-policy-delete --name policy_name [common-options]

OmniCube CLI Reference 8 - Backup Policy Commands

Options

Options Description

--name

common-options

(Required) Name of the backup policy to delete.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ svt-policy-delete --name 30MinDailyVDI

.....

Task Complete

Related commands:

• svt-policy-create Command on page 70

• svt-policy-rename Command on page 71

• svt-policy-rule-create Command on page 72

• svt-policy-rule-delete Command on page 75

• svt-policy-show Command on page 76

svt-policy-rename Command

The svt-policy-rename command renames an existing backup policy in a Federation. This does not affect the policy operations. You can rename the default policy for a datastore.

Format

svt-policy-rename --policy original_name --name new_name

[common-options]

Options

Options Description

--name

--policy

common-options

(Required) New name for the backup policy.

(Required) Original name of the backup policy.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

OmniCube CLI Reference 8 - Backup Policy Commands

Example

$ s vt-po licy- renam e --pol icy d aily1 -allv ms --na me dail yAM-a llvms

... ..... ..... ...

Tas k Compl ete

Related Commands:

• svt-policy-create Command on page 70

• svt-policy-delete Command on page 70

• svt-policy-rule-create Command on page 72

• svt-policy-rule-delete Command on page 75

• svt-policy-show Command on page 76

svt-policy-rule-create Command

The svt-policy-rule-create command creates a rule for a backup policy in a Federation.

A backup policy rule can contain the following attributes that control how and when to create backups:

• Destination—A datacenter that contains the backups. Policy rules control not only the rate of backup creation for a virtual machine (VM), but also the degree of data protection. For full disaster protection, you must store a backup in a remote datacenter.

• Frequency—The backup schedule defined as days, calendar dates, and times. If you specify 12:30 as a start time and 13:45 as an end time with --frequency 60, you will get a backup at 12:30. This is because backups align with the start time.

• Retention—The maximum number of backups to retain for a specific rule. You might create a backup policy that has one rule defining --frequency 60 --max_backups 6 and another rule defining frequency

10 --max_backups 6. When you apply that backup policy to a VM it will retain up to 12 backups at any

one time. Be aware that the GUI works differently than the CLI because in the GUI you can specify a backup retention time. In the CLI, derive the retention time by multiplying the value of frequency with the value of max_backups.

If a backup exceeds its retention time, the policy deletes the backup unless you lock it with the svt-backup-

lock Command on page 57.

• Application Consistency—Whether the backup includes a VMware application consistent snapshot that enables you to restore the VM with its applications in a consistent state. Because VMware attempts to cleanly quiesce I/O to take a the snapshot, application consistent backups might take many hours to complete in VMs that have high rates of I/O. For such VMs, schedule backups during intervals when the VM experiences its lowest I/O rates.

Note: The maximum number of backups in a federation is 250,000 regardless of available datastore space.

OmniCube CLI Reference 8 - Backup Policy Commands

A backup policy can have an unlimited number of rules. For a comprehensive VM backup strategy, add rules to create a mix of local and remote backups. In addition, create a mix of backups that are, and are not, application consistent.

Backups that you create using a policy rule have an automatic name based on the execution timestamp. The policy backup name has the format <YYYY-MM-DD>T<HH:MM:SS>-<TZ>, such as 2014-04-23T14:00:00-04:00. To rename a backup, use the svt-backup-rename Command on page 59.

Important: Use the svt-timezone-show Command on page 28 to set the local time for backup creation.

Format

svt-policy-rule-create- --policy policy --destination destination

--frequency frequency --start_time start-time --end_time end-time

--days days --max_backups max-backups --appconsistent [common-options]

OmniCube CLI Reference 8 - Backup Policy Commands

Options

Options Default Description

--appconsistent

--days

--destination

--end_time

--frequency

All Either of the following:

local Datacenter that will contain the backups.

00:00 Time of day (hours and minutes) at which to stop creating backups, specified using a

Includes a VMware application consistent copy.

• Day of the week (for example, Monday or Mon), a range of days (for example,

Monday-Friday).

• Day of the month (23, a contiguous range of dates (2-5), the first day of the month (first) or last day of the month (last). You can separate ranges with a comma, such as --days first,15.

Do not use days 29, 30, and 31 in monthly schedules. For example, to take backups on every calendar day of the month either not specify this option, or specify --

days all.

If you use the default (local), the backups are contained in the same datacenter as the VM.

24-hour clock. If you do not specify a start and stop time, backups occur all day, at the specified frequency.

(Required) Time in minutes elapsing between backup creation events. For example, if the start time is the default, and the frequency is set to 10 minutes, backups will occur all day, at 00:10, 00:20, and so on.

The minimum frequency interval is 10 minutes,

--max_backups

(Required) Maximum number of backups to retain for this rule. When the number of backups exceeds this value, the oldest backup is deleted. (Backups you create using

the svt-vm-backup command are exempt from this limit.)

The maximum number of backups in a Federation is 250,000, regardless of storage space availability.

--policy

--start_time

00:00 Time of day (hours and minutes) at which to start creating backups, specified using a

(Required) Name of the backup policy.

24-hour clock. If you do not specify a start and stop time, backups occur all day, at the specified frequency. If you specify a start time, the backup aligns with the start time and occurs at the specified frwquency.

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example:

$ s vt-po licy- rule- creat e --pol icy u serdr - -freq uency 3 0

--m ax-ba ckups 3 36 --de stina tion dc enter 5

... ..... .....

Tas k Compl ete

The following example creates 2 days of backups running every hour from 22:00 to 06:00 the next morning.

$ s vt-po licy- creat e --pol icy o verni ght - -freq uency 6 0 --sta rt_ti me 22:0 0

--e nd_ti me 06:0 0 --max _back ups 1 8

Related commands:

OmniCube CLI Reference 8 - Backup Policy Commands

• svt-policy-create Command on page 70

• svt-policy-delete Command on page 70

• svt-policy-rename Command on page 71

• svt-policy-rule-delete Command on page 75

• svt-policy-show Command on page 76

• svt-timezone-set Command on page 30

• svt-timezone-show Command on page 28

• svt-timezones-list Command on page 29

svt-policy-rule-delete Command

The svt-policy-rule-delete- command deletes a rule from a backup policy in a Federation. To list policy rules, see thesvt-policy-show Command on page 76.

If you delete all the rules from a backup policy:

• The policy persists but cannot create backups. See the svt-policy-rule-create Command on page 72.

• No further backups are taken for any VMs previously using the policy and no warning is given. Make sure that your VMs are backed up by another policy. See thesvt-vm-policy-set Command on page 47.

• If the backup policy is the default policy for a datastore, no backups are created. See the svt-datastore-

policy-set Command on page 36.

If you delete a backup policy rule, all VM backups created under the rule continue to exist and consume storage space. These backups are automatically deleted according to the retention specification of the deleted rule. If you want to remove them sooner, you must manually delete the backups at an appropriate time (see the svt-

backup-delete Command on page 56). If you want to keep these backups, you can also lock backups to prevent

their automatic deletion (see the svt-backup-lock Command on page 57).

Format

svt-policy-rule-delete --policy name --rule n [common-options]

Options

Options Description

--policy

--rule

(Required) Name of the backup policy.

(Required) Unique identification number associated with the rule.

commonoptions

Use the svt-policy-show Command on page 76 to display the rules in a backup policy and to identify each rule’s number. Deleting a rule permanently retires its unique identification number.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

OmniCube CLI Reference 8 - Backup Policy Commands

Example

$ svt-policy-rule-delete --policy daily1 --rule 2

.....

Task Complete

Related commands:

• svt-policy-create Command on page 70

• svt-policy-delete Command on page 70

• svt-policy-rename Command on page 71

• svt-policy-rule-create Command on page 72

• svt-policy-show Command on page 76

svt-policy-show Command

The svt-policy-show command displays the backup policies in a Federation. The command also displays the backup policy rules and the number associated with each rule. For a full list of the possible rule values, See the

svt-policy-rule-create Command on page 72.

The following information is provided:

• Policy—The policy name.

• Num—The unique number identifying the policy rule. Used with svt-policy-rule-delete Command on page

75. When you delete a rule, the integer is not reused (retired).

• Destination—The datacenter that contains the backups created by this policy.

• Frequency—The time elapsed between backup attempts, in minutes.

• Start—The daily start time in 24-hour clock format. The policy begins creating backups after this time.

• End—The daily end time in 24-hour clock format. The policy stops creating backups after this time.

• Days—The days of the week or of the month when the policy is active.

• Max. Backups—The maximum number of backups that this rule retains. When this number is exceeded, the policy deletes the oldest backup to make room for the newest backup. To prevent automatic deletion, use svt-backup-lock Command on page 57.

• App Consistent—Indicates that the backup includes a VMware application consistent snapshot.

Format

svt-policy-show --policy policy_name [common-options]

OmniCube CLI Reference 8 - Backup Policy Commands

Options

Options Description

--policy

common-options

Common Name of the policy to display. If you do not specify a policy name, all policies are returned.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-po licy- show

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ----- ----- ----- ----.

| B ackup P olici es |

+-- ----- ----- -+--- +---- ----- --+-- ----- --+-- ---+-----+------- ----- -+--- ----- ----+ ----- ----- ----+

+-- ----- ----- -+--- +---- ----- --+-- ----- --+-- ---+-----+------- ----- -+--- ----- ----+ ----- ----- ----+

|10 3dail y | 0 |MD23 _m1_d c0| 1 440 |00:00 |00:0 0| All |1 |no |

| | 1 | <loc al> | 6 0 |00:0 0|00: 00| A ll |2 4 |no | +-- ----- ----- -+--- +---- ----- --+-- ----- --+-- ---+-----+------- ----- -+--- ----- ----+ ----- ----- ----+

|hi freqA 02 | 0 | ds finan ce2| 10 | 05:00 |18:0 0| All |3 |n o |

+-- ----- ----- -+--- +---- ----- --+-- ----- --+-- ---+-----+------- ----- -+--- ----- ----+ ----- ----- ----+

+-- ----- ----- -+--- +---- ----- --+-- ----- --+-- ---+-----+------- ----- -+--- ----- ----+ ----- ----- ----+

|ub ntusy s-eod | 0 | D Seng0 09 | 30 | 06:00 |22:0 0| Sun, Tue,T hu |8 |ye s |

| | 1 | metd t_dcy 0| 15 |09 :00|2 2:00| M on,We d,Fri | 20 |no |

'-- ----- ----- -+--- +---- ----- --+-- ----- --+-- ---+-----+------- ----- -+--- ----- ----+ ----- ----- ----'

Related commands:

• svt-policy-create Command on page 70

• svt-policy-delete Command on page 70

• svt-policy-rename Command on page 71

• svt-policy-rule-create Command on page 72

• svt-policy-rule-delete Command on page 75

OmniCube CLI Reference 8 - Backup Policy Commands

9 - Software Upgrade Commands

The following commands manage OmniCube software upgrades in a Federation:

• svt-software-commit Command on page 79—Permanently commits upgrades that you previously installed using svt-software-upgrade.

• svt-software-rollback Command on page 80—Removes software upgrades that you previously installed using svt-software-upgrade, but have not yet committed using svt-software-commit. This command operates only on the OmniCube hosting the current log in.

• svt-software-status-show Command on page 81— Displays the status of a software upgrade task.

• svt-software-upgrade Command on page 83—Installs a software upgrade package. The installation is not permanent until you either permanently commit it using svt-software-commit or revert to the previous version, using svt-software-rollback.

svt-software-commit Command

The svt-software-commit command confirms the installation of a previously installed upgrade package, permanently replacing the current version of the OmniCube software with a later version. See the svt-software-

upgrade Command on page 83.

Important: If you are using OmniCube cloud support, you cannot use the CLI to upgrade OmniCube Cloud

Datacenters. You must use the Graphical User Interface to perform the upgrade and subsequent commit.

You can also use the graphical user interface (SimpliVity vSphere Extension) to commit software upgrades.

You run this command only once on one OmniCube in a Federation to commit the upgrade on all recentlyupgraded OmniCube systems.

When you have committed the upgrade, you cannot roll back to the previously-installed revision. See the svt-

software-rollback Command on page 80.

Format

svt-software-commit [ common-options]

OmniCube CLI Reference 9 - Software Upgrade Commands

Options

Options Description

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-so ftwar e-com mit Upg rade ta sk with i d 72c50 8c0-b 68f-4 151-b 407-2 e1f2c cbb2d d has b een s tarte d.

... ..... ..... ..... ..... ..... ..... ..... ..... ...

Tas k Compl ete

Related Commands:

• svt-software-upgrade Command on page 83

• svt-software-rollback Command on page 80

• svt-software-status-show Command on page 81

svt-software-rollback Command

The svt-software-rollback command reverts an OmniCube to the previously installed version of the SimpliVity OmniCube Software, if an upgrade is not yet committed. See the svt-software-commit Command on page 79.

Important: You cannot use the CLI to upgrade or roll back Federations that contain OmniCube Cloud

Datacenters. Use the Graphical User Interface to perform the upgrade.

You can install software upgrades and leave them as uncommitted until you are ready to commit to the new version. See the svt-software-upgrade Command on page 83.

This command operates only on the OmniCube hosting the current login. You must run the command on each OmniCube in the Federation. You can also use the graphical user interface (SimpliVity vSphere Extension) to rollback software upgrades on specific OmniCube systems.

Format

svt-software-rollback [common-options]

Options

Options Description

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

OmniCube CLI Reference 9 - Software Upgrade Commands

Example

$ s vt-so ftwar e-rol lback Upg rade ta sk with i d 25e57 cb2-3 da6-4 a76-a 74c-f f7bf0 974ef 7 has b een s tarte d.

... ..... ..... ...

Tas k Compl ete

Related Commands:

• svt-software-commit Command on page 79

• svt-software-upgrade Command on page 83

• svt-software-status-show Command on page 81

svt-software-status-show Command

Use the svt-software-status-show command to display the status of OmniCube Software upgrade tasks for each OmniCube.

The following information is provided:

• Type—The type of upgrade task.

• OmniCube VC—The OmniCube Virtual Controller that was the target for the upgrade.

• VCStatus—The status of the Virtual Controller.

• Start Time—The time that the task started.

• End Time—The time that the task finished.

• State — The result of the upgrade task.

Possible upgrade task outcomes are:

• Completed—The upgrade task completed successfully.

• Failed—The upgrade task failed and an error code and message indicates the reason for the failure.

• In progress—The upgrade task is proceeding.

• No action needed—The upgrade is incomplete, but no user action is required at this point.

• Unknown—It is not possible to determine the status of the previous upgrade task.

If there are no previous upgrade tasks the following error message appears:

ERROR [133]: No previous Upgrade task found.

Format

svt-software-status-show --details [common-options]

OmniCube CLI Reference 9 - Software Upgrade Commands

Options

Options Default Description

--details

common-options

Display additional information for each OmniCube.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Examples

$ s vt-so ftwar e-sta tus-s how

ERR OR [133 ]: No p revio us Upgr ade t ask f ound.

svt cli@B osFed -ip2- 105:~ $ svt -soft ware- statu s-show

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ----- ----- ----.

|Ta sk deta ils |

+-- ----- ----- ----- ----- ----- -+--- ----- ----- +---------+------ ----- -+--- ----- ----+ ----- ----+

+-- ----- ----- ----- ----- ----- -+--- ----- ----- +---------+------ ----- -+--- ----- ----+ ----- ----+

|up grade .ever ywher e | | |17:38 :01 |17:54 :32 | |

'-- ----- ----- ----- ----- ----- ----- ----- ----- +---------+------ ----- -+--- ----- ----+ ----- ----'

Related Commands:

• svt-software-upgrade Command on page 83

• svt-software-rollback Command on page 80

• svt-software-commit Command on page 79

OmniCube CLI Reference 9 - Software Upgrade Commands

svt-software-upgrade Command

The svt-software-upgrade command upgrades your OmniCube software to a later version. You can upgrade an individual OmniCube, or all OmniCube systems in a datacenter (the default).

Important: If you are using OmniCube cloud support, you cannot use the CLI to upgrade OmniCube Cloud

Datacenters. You must use the Graphical User Interface to perform the upgrade, and only after you upgrade all physical Federation OmniCube systems.

For information about obtaining upgrade packages and preparing to upgrade your software, see OmniCube Configuration and Management. You can also use the graphical user interface (SimpliVity vSphere Extension) to upgrade by datacenter.

After an upgrade is complete, the OmniCube starts to use the upgrade software immediately. However, you can revert the upgrade or make it permanent as follows:

• Roll back—You can roll back the upgrade at any time before you commit it. See the svt-software-rollback

Command on page 80.

• Commit—You can commit the upgrade to make it permanent. See the svt-software-commit Command on page 79.

You cannot downgrade to a software version that predates the current version.

Important: You must specify the --noHA option when upgrading a single-OmniCube datacenter.

Format

svt-upgrade-software --pkg_path path-to-software-package --noHA --omnicube

[common-options]

Options

Options Description

--noHA

--omnicube

--pkg_path

common-options

Override the requirement that VMs are Storage High Availability (HA)compliant before the upgrade starts. This might make your data unavailable for a short time following the upgrade, while the VMs synchronize.

You must specify the --noHa option when upgrading a single-OmniCube datacenter.

Upgrade only this individual OmniCube, not the entire datacenter. You must complete the upgrade on all individual OmniCube systems and then commit the upgrade.

The path to the location where the upgrade package is located.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

OmniCube CLI Reference 9 - Software Upgrade Commands

Example

svt-software-upgrade --pkg_path

/mnt/svtfs/0/<identifier>/.svtupgrade/SimpliVity-OmniCube-Software-2.2.0.3.tar

Upgrade task with id 1a22412f-87a5-48eb-a227-0534c3d32ed8 has been started.

................

Task Complete

Related Commands:

• svt-software-commit Command on page 79

• svt-software-rollback Command on page 80

• svt-software-status-show Command on page 81

10 - Miscellaneous Commands

The following miscellaneous commands are provided:

• svt-hardware-show—Displays the attributes and status of hardware components in a Federation OmniCube. See svt-hardware-show Command on page 86.

• svt-credstore-update—Updates the vCenter Server credential store, if you change the vCenter account password. See svt-credstore-update Command on page 89.

• svt-task-cancel—Displays the status of a Federation task. See the svt-task-cancel Command on page 90.

• svt-task-show—Displays the status of a Federation task. See svt-task-show Command on page 91.

OmniCube CLI Reference 10 - Miscellaneous Commands

svt-hardware-show Command

The svt-hardware-show command displays the hardware inventory and health status for an OmniCube.

• Component—The name of the hardware component, which can be:

◦ Node—The status of an OmniCube in the Federation, identified by the ESX host IP.

◦ Storage adapter.

◦ Storage adapter battery backup unit (BBU).

◦ Logical drive, SSD array.

◦ Drive Set—A set of physical drives (SSD or HDD) included in a specific logical drive.

◦ Physical drives in the SSD array.

◦ Logical drive in the rotational HDD array.

◦ Physical drives in the rotational HDD array.

• Name/Location—The device name or slot ID number.

• Status—The operational status of the device, which can be:

◦ Degraded (Yellow)—The component is functioning, but at reduced capability. For example, a recently-

replaced drive might be rebuilding.

◦ Enabled—Component attribute status, such as enabled or disabled.

◦ Error (Red)—The component is absent or in a critical error state. Operations might have failed over to a

redundant alternate device.

◦ FPGA Temp (Yellow/Red)—The temperature of the OmniCube Accelerator™ card.

◦ Healthy (Green)—The component is present and functioning correctly.

◦ Missing (Red)—The component is absent from the system. For example, a disk was removed.

◦ Offline (Red)—The Component is present, but unavailable for use, although not necessarily in a

degraded or error state.

◦ Rebuilding N% Completed (Yellow)—A storage component is undergoingrebuild after you replace an

SSD or HDD. Includes the progress of the rebuild.

◦ Warning (Yellow)—The component is present, but generating alarms or errors. Operations might have

failed over to an alternate, redundant device.

• Parameter:

◦ Any configurable parameters associated with the device, such as cache state.

◦ An attribute of the device, such as serial or model number.

• Value—The health status of the device, or the value of a parameter, such as enabled.

If a device has a yellow or red status, you can obtain more information from alarms and error messages visible in the vSphere Triggered Alarms panel and the Alarms tab. Select Definitions to display the SimpliVity alarms and their descriptions, for example:

OmniCube CLI Reference 10 - Miscellaneous Commands

Alarm: SimpliVity Logical Drive Health State Change

Description: This object Monitors for unhealthy virtual drives for SimpliVity Storage.

Format

svt-hardware-show --details [common-options]

Options

Options Description

--details

common-options

Displays additional hardware information, including the serial number, the model number, and firmware revision for the OmniCube hardware.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Examples

The examples are truncated and compressed to fit the page.

The following example shows output for a model CN-3000:

$ s vt-ha rdwar e-sho w

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ---.

| H ardwa re Inve ntory f or Node 1 30.19 .2.70 |

+-- ----- ----- ----- ----- ----+ ----- ----- ----- -+---------+----- ----- ---+- ----- ---+

+-- ----- ----- ----- ----- ----+ ----- ----- ----- -+---------+----- ----- ---+- ----- ---+

'-- ----- ----- ----- ----- ----+ ----- ----- ----- -+---------+----- ----- ---+- ----- ---'

OmniCube CLI Reference 10 - Miscellaneous Commands

The following example shows output for a model CN-5000

$ s vt-ha rdwar e-sho w

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ---.

| H ardwa re Inve ntory f or Node 1 30.19 .2.72 |

+-- ----- ----- ----- ----- ----+ ----- ----- ----- -+---------+----- ----- ---+- ----- ---+

+-- ----- ----- ----- ----- ----+ ----- ----- ----- -+---------+----- ----- ---+- ----- ---+

'-- ----- ----- ----- ----- ----+ ----- ----- ----- -+---------+----- ----- ---+- ----- ---'

The following example shows detailed output.

$ s vt-ha rdwar e-sho w --det ails

.-- ----- ----- ----- ----- ----- ----- ----- ----- ----------------- ----- ----- ----- ----- ----- ----- ----.

| H ardwa re Inve ntory f or Node 1 30.19 .2.75 |

+-- ----- ----- ----- ----- ---+- ----- ----- ----+ --------+-------- ----- ----- +---- ----- ----- ----- ----+

+-- ----- ----- ----- ----- ---+- ----- ----- ----+ --------+-------- ----- ----- +---- ----- ----- ----- ----+

OmniCube CLI Reference 10 - Miscellaneous Commands

| | | |S erial N umber | 356C6 W1 |

| | | |S erial N umber | 28E00 G3 |

| | | |M odel Nu mber |N /A |

| | | |M anufa cture r |N/A |

| | | |F irmwa re Revi sion |3 .130. 05-17 96 |

| | | |S erial N umber | 0 |

| | | |M odel Nu mber |N /A |

| | | |F irmwa re Revi sion |N /A |

| | | |M anufa cture D ate |07/18 , 2011 |

| | | |F irmwa re Revi sion |N /A |

| | | |M anufa cture r |ATA |

| | | |F irmwa re Revi sion |7 D3Q |

. . . . . .

svt-credstore-update Command

The svt-credstore-update command enables you to update the credentials stored by the SimpliVity user account. This is a secure, non-login account used for background operations in the Federation.

If you change the vCenter Server password after you deploy a Federation, it affects authentication of the SimpliVity user account within the Federation. Operations will fail until you update the credential store on all OmniCube systems in the Federation that are contained within the vCenter for which the password was changed.

You are prompted to provide:

• The current vCenter administrator password.

• A new password that complies with the requirements for administrative account credentials.

Format

svt-credstore-update [common-options]

OmniCube CLI Reference 10 - Miscellaneous Commands

Options

Options Description

common-options

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-cr edsto re-up date Ent er curr ent a dmini strat or pass word: x xxxxx xxxxx xx Ent er new ad minis trato r passw ord: xx xxxxx xxxxx x Con firm ne w admin istra tor p asswo rd: x xxxxx xxxxx xx

svt-task-cancel Command

The svt-task-cancel command cancels a specific Federation task in progress. To display a task, see the svt-

task-show Command on page 91.

You cannot cancel all tasks. Some tasks complete too quickly, and other tasks might have dependent tasks that prevent cancellation.

You must specify the unique task identifier. To generate this identifier, either use the --wait n option on the command line or configure a value for the SVTCLI_WAIT environment variable.

For example:

$ svt-datastore-create --name jnds --policy daily --wait n

--timeout 100

Task started - ID is 90c6524a-c4d3-4c11-bb5d-e3781502cd60

If a command times out, you will see a message similar to the following. In this case, the CLI timed out, but the task might still be running in vCenter:

Command still in progress, but timed out To check status, execute svt-task-show --task 4f186d32-305d-4cc0-a210-1c6f89efb6a8

Format

svt-task-cancel --task n [common-options]

OmniCube CLI Reference 10 - Miscellaneous Commands

Options

Options Description

--task

commonoptions

(Required) Identification number for a task. Use the --wait n option with other CLI commands to generate a task identification number. Alternatively, use the task ID returned when the original command timed out.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-ta sk-ca ncel -- task 90 c6524 a-c4d 3-4c1 1-bb5 d-e37 81502 cd60

Related commands:

• svt-task-show Command on page 91

svt-task-show Command

The svt-task-show command displays the status of a Federation task, including the percentage complete. To cancel a task in progress, See the svt-task-cancel Command on page 90.

Each task has a unique identifier. To retrieve this identifier, either use the --wait n option on the command line or configure a value for the SVTCLI_WAIT environment variable.

For example:

$ svt-datastore-create --size 3TB --name jnds --policy daily --wait n

--timeout 100

Task started - ID is 90c6524a-c4d3-4c11-bb5d-e3781502cd60

If a command times out you will see a message similar to the following. In this case, the CLI has timed out, not the task.

Command still in progress, but timed out To check status, execute svt-task-show --task 4f186d32-305d-4cc0-a210-1c6f89efb6a8

If the original task timed out and had not yet completed when you run svt-task-show , the command continues

where the previous command had left off, printing the progress string ". . . . . ." until either the command

completes or the svt-task-show command times out. If svt-task-show times out, run it again.

Format

svt-task-show --task n [common-options]

OmniCube CLI Reference 10 - Miscellaneous Commands

Options

Options Description

--task

commonoptions

(Required) Identification number for a task. Use the --wait n option with other CLI commands to generate a task identification number.

Alternatively, specify the task ID returned when the original command timed out.

Common options applicable to all commands. See:

• vCenter Identification and Authentication Options on page 12

• Command Operation Control Options on page 13

Example

$ s vt-ta sk-sh ow --ta sk 90c6 524a- c4d3- 4c11- bb5d- e3781 502cd 60 tas k 90c65 24a-c 4d3-4 c11-b b5d-e 37815 02cd6 0 is 90 p ercen t compl ete.

Related commands:

• svt-task-cancel Command on page 90

OmniCube CLI Reference 10 - Miscellaneous Commands

SimpliVity OmniCube User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Table Of Contents

Preface

1 - Introduction to the OmniCube CLI

CLI Overview

Prerequisites for Using the OmniCube CLI

Accessing the CLI from a Client Computer

Logging in to the CLI on a SimpliVity Virtual Controller

CLI Command Privileges

CLI Command Format

vCenter Server Address and Credentials

Running CLI Commands Interactively

Using CLI Commands in a Script

Using Environment Variables

2 - CLI Commands

Obtaining Help on a Command

Common Command Options

Command Operation Control Options

3 - Session Commands

svt-session-start Command

svt-session-stop Command

svt-session-verify Command

4 - Federation and Datacenter Commands

svt-federation-remove Command

svt-federation-show Command

Cloud Datacenter CLI Constraints

svt-cloud-deploy Command

svt-cloud-renamedatacenter Command

svt-cloud-undeploy Command

svt-timezone-show Command

svt-timezones-list Command

svt-timezone-set Command

5 - Datastore Commands

svt-datastore-create Command

svt-datastore-delete Command

svt-datastore-policy-set Command

svt-datastore-resize Command

svt-datastore-share Command

svt-datastore-show Command

svt-datastore-unshare Command

6 - Virtual Machine Commands

svt-vm-backup Command

svt-vm-clone Command

svt-vm-move Command

svt-vm-policy-set Command

svt-vm-restore Command

svt-vm-show Command

7 - Backup Commands

svt-backup-cancel Command

svt-backup-copy Command

svt-backup-delete Command

svt-backup-lock Command

svt-backup-rename Command

svt-backup-restore Command

svt-backup-show Command

svt-backup-size-calculate Command

8 - Backup Policy Commands

svt-policy-create Command

svt-policy-delete Command

svt-policy-rename Command

svt-policy-rule-create Command

svt-policy-rule-delete Command

svt-policy-show Command

9 - Software Upgrade Commands

svt-software-commit Command

svt-software-rollback Command

svt-software-status-show Command

svt-software-upgrade Command

10 - Miscellaneous Commands

svt-hardware-show Command

svt-credstore-update Command

svt-task-cancel Command

svt-task-show Command