Tintri Automation Toolkit Quick Start & Overview Guide

Transcription

1 QUICK START & OVERVIEW GUIDE Tintri Automation Toolkit Quick Start & Overview Guide Windows PowerShell is Microsoft s command-line shell and scripting language for system administrators. In PowerShell, administrative tasks are performed by specialized cmdlets (pronounced command-lets). The Tintri Automation Toolkit is a set of cmdlets for Windows PowerShell that assists in task automation and serves as a Command Line Interface (CLI) and high-level API. These cmdlets let you easily perform a wide variety of Tintri specific tasks and integrate components from other vendors within PowerShell scripts. The cmdlets cover many aspects of Tintri operations. Tintri cmdlets operate with both VMstore and Tintri Global Center products; however, all cmdlets do not work for all products. Please check the cmdlet documentation for specific interactions. Note: The Tintri Automation Toolkit does not support Hyper-V (new in Tintri OS x), except for the Get-TintriVM and Restore-TintriVM cmdlets. Requirements Windows 7 and Windows Server 2008 R2 or later, x64 Microsoft PowerShell 3.0 Microsoft.NET Framework 4.5 or later Tintri VMstore running Tintri OS 3.0 or later How this documentation is organized This document contains the following sections: Initial Setup on page 3 provides instruction on how to download and install the Tintri Automation Toolkit, verify installation, get help and common use cases. Authentication on page 7 describes three methods to authenticate the Tintri Automation Toolkit to a Tintri server. Hello World Sample on page 9 provides a script used to verify the Tintri server is responding. Collect VM Information on page 10 provides a cmdlet for collecting VM information. Restoring a Hyper-V VM on page 11 provides a code example for restoring VMs. Obtain Snapshot Creation Times on page 13 provides a code example for obtaining snapshot creation times for a specific VM. Automation Toolkit PowerShell Examples on page 15 provides additonal examples for alert collection, cloning, disk information, etc Rev. C

2 Contact Tintri technical support If you encounter any trouble, please contact Tintri Technical Support via the web, , or phone: Web: Tintri, Inc Ravendale Drive Phone Local: , option 2 Mountain View, CA Phone Toll free: Tintri ( ), option 2 International: for local numbers. 2

3 Initial Setup This section provides step-by-step instruction on setting up the Tintri Automation Toolkit. Before you begin, first download the toolkit from the Tintri Support Portal. Downloading the Tintri Automation Toolkit The PowerShell Toolkit is available on the Tintri Support Portal. 1. Login to the Tintri Support Portal. 2. Click Downloads and select the Releases tab. 3. Click More Info in the Tintri Automation Toolkit section. 4. Click and save the toolkit to your local machine. Figure 1-1 Downloading the Tintri PowerShell Toolkit. Installing the Tintri Automation Toolkit To setup deployment: 1. Double-click the Tintri Automation Toolkit installer. 2. Click Next in the Welcome window. 3. Click Install. Figure 1-2 Click Next in the Welcome window (Left) and Click Install (Right). 3

4 4. Select I accept the terms in the License Agreement and click Next. 5. Select the way you want features to be installed and click Next. Figure 1-3 Select the License Agreement (Left) and select the way you want features to be installed (Right). 6. Please wait while the Setup Wizard installs the toolkit, and click Next. 7. Click Finish. Figure 1-4 Installing the Tintri PowerShell Toolkit (Left) and click Finish (Right). Verifying installation Before you can verify the installation, you first need to import the module: 1. To import the module, enter the following: Import-Module C:\Program Files\TintriPSToolKit\ TintriPSToolKit.psd1 2. To verify the installation, enter the following cmdlet: PS> get-command -Module TintriPSToolKit All commands in the toolkit are displayed. Connect-TintriServer Disconnect-TintriServer Get-TintriAlerts Get-TintriApiVersion Get-TintriAppliance Get-TintriApplianceDns 4

5 Get-TintriDashboard Get-TintriDatastore Get-TintriDatastoreReplConfiguration Get-TintriDatastoreReplPath Get-TintriDatastoreStat Get-TintriDatastoreVMSnapshotSchedule Get-TintriHypervisorDatastore Get-TintriPSToolkitConfiguration Get-TintriServerSession Get-TintriTaskStatus Get-TintriUserAccount Get-TintriVDisk Get-TintriVirtualHostResource Get-TintriVM Get-TintriVMByReplStatus Get-TintriVMReplConfiguration Get-TintriVMSnapshot Get-TintriVMSnapshotSchedule Get-TintriVMStat Get-TintriVMVDiskStat New-TintriDatastoreReplPath New-TintriVMClone New-TintriVMCloneMany New-TintriVMNameSequence New-TintriVMRemoteCopy New-TintriVMReplConfiguration New-TintriVMSnapshot New-TintriVMSnapshotSchedule Remove-TintriCachedServerCertificate Remove-TintriDatastoreReplPath Remove-TintriVMReplConfiguration Restore-TintriVM Resume-TintriDatastoreReplication Resume-TintriVMReplication Set-TintriDatastoreReplConfiguration Set-TintriDatastoreReplPath Set-TintriDefaultServer Set-TintriPSToolkitConfiguration Set-TintriUserPassword Set-TintriVMSnapshotSchedule Set-TintriVMSnapshotScheduleToDefault Suspend-TintriDatastoreReplication Suspend-TintriVMReplication 5

6 Getting help To get help for any command, use the Get-help cmdlet, for example: PS> Get-Help Get-TintriApiVersion The following details are displayed: NAME Get-TintriApiVersion SYNOPSIS Queries one or more Tintri Servers for their Tintri REST API version. SYNTAX Get-TintriApiVersion [-All [<SwitchParameter>]] [<CommonParameters>] Get-TintriApiVersion [-TintriServer] <ITintriServer> [-All [<SwitchParameter>]] [<CommonParameters>] Get-TintriApiVersion [-HostNameOrIp] <String> [-All [<SwitchParameter>]] [<CommonParameters>] Common use cases There are many possible use cases for the toolkit, including: Collect VM information from VMstore or Tintri Global Center (TGC). Snapshot management, create a manual snapshot or setup a snapshot schedule for one or more VMs. Perform backups from snapshots. Collect VMstore or TGC performance, capacity, and data protection metrics. Clone virtual disks with VM consistency. Note: Was this section helpful? Click Documentation Feedback and let us know. 6

7 Authentication There are three methods to authorize to a Tintri server (currently Tintri VMstore or Tintri Global Center): Interactively from a script Single line with user name and password Using PSCredential Interactively from a script To perform authorization interactively from a script: 1. Enter the following cmdlet in either the command line or in a script: PS> Connect-TintriServer Server mytintriserver 2. Enter your User name and Password credentials in the pop-up window. Figure 2.1 Enter your User name and Password credentials. An authentication confirmation response is displayed. Figure 2.2 Authentication confirmation response. Note: The above confirmation response is the same for all authentication methods. 7

8 Single line with a user name and password The Single Line method includes both the user name and password in the line itself. The downside of this method is that passwords in a script file are frowned upon by IT security. To perform authorization using the single line method, enter the following cmdlet: PS> Connect-TintriServer Server mytintriserver User- Name admin Password tintri987 There is no Credentials Required pop-up window. An authentication confirmation response is displayed (See Figure 2.2). Using PSCredential This method includes the PowerShell Credential object, PSCredential. To perform authorization using PSCredential, enter the following cmdlet: PS> Connect-TintriServer Server mytintriserver Credential $mycredentials There is no Credentials Required pop-up window. An authentication confirmation response is displayed (See Figure 2.2). Example: PSCredential object To create a PSCredential object: PS> $password = (ConvertTo-SecureString tintri987 -AsPlainText -Force) PS> $mycredentials = new-object System.Management.Automation.PSCredential -ArgumentList admin, $password Note: Was this section helpful? Click Documentation Feedback and let us know. 8

9 Hello World Sample The first script to verify the Tintri server is responding: PS> Connect-TintriServer Server mytintriserver User- Name admin Password tintri987 The following output is displayed: HostNameOrIp : ttvm38.tintri.com ApplianceHostName : ttvm38.tintri.com Uuid : 420E1A5BC9A PLT ApiVersion : v310 ServerType : VMstore SessionId : JSESSIONID=30640CD29FF468F599CA18 3C51B8F2A9; Path=/; Secure; HttpOnly SessionStartZoned : T11:56:01 Pacific Standard Time (-07) SessionStartLocal : 6/13/ :56:01 AM LastUsed : 6/13/ :56:02 AM SessionDuration : 0:00:00:00 (d:hh:mm:ss) ApiMethodCallCount : 2 IsDefaultServer : True PS> Get-TintriApiVersion Tintri Server Type : Tintri VMstore API Version : v310 Note: Was this section helpful? Click Documentation Feedback and let us know. 9

10 Collect VM Information To collect VM information, enter the following cmdlet: PS> Get-TintriVm The following details are displayed below (the list may be long due to the number of VMs attached to the Tintri server). Name : ttvm38-01-vm-1 VCenterName : dom.tintri.com Host : maith.tintri.com FolderPath : dc-pri Uuid : 68FABB62-5D69-22ED-BE9C- 88F938DA6717-VIM F IsLive : True IsTemplate : False IsInInventory : True IsPoweredOn : False ReplicationEnabled : True ReplicationState : RUNNING Note: Was this section helpful? Click Documentation Feedback and let us know. 10

11 Restoring a Hyper-V VM This version of the Tintri Automation Toolkit supports restoration of Hyper-V VMs from only the latest VM snapshot. To obtain the list of VMs with VM type (VMware, Hyper-V or RHEV) associated with each VM, enter the following cmdlet. PS> Get-TintriVM Use Restore-TintriVM -Name <VMName> -UseLatestSnapshot -DestinationDirectory <Hyper-V share\vmnamedir> with the following conditions: The destination directory must be directly under any VMstore Hyper-V share. A list of shares can be viewed on the VMstore UI under Settings-> HyperV Shares. The directory should not already exist. If it does, the cmdlet will fail. Once completed, the Hyper-V Import-VM cmdlet can be used to import the cloned VM into the Hyper-V host. The following example illustrates the use of the Get-TintriVM and Restore-TintriVM cmdlets to restore a Hyper-V VM: # Import module import-module C:\Program Files\TintriPSToolkit\ TintriPSToolkit.psd1 # Connect to server $server = Connect-TintriServer -Server <EnterServerName> -UserName <EnterUserName> -Password <EnterPassword> # Get VM $vm = Get-TintriVM -Name <EnterVMName> # See VM Object $vm # Restore Tintri VM Restore-TintriVM -VM $vm -DestinationDirectory <EnterHypervShare> -UseLatestSnapshot -TintriServer $server For example: Restore-TintriVM -VM $vm -DestinationDirectory hyperv\1234 -UseLatestSnapshot -TintriServer $server 11

12 # Import VM to resurrect it $vmdestpath = <Enter UNC_FQDN Of Tintri Box\hyperv\ Enter Destination Directory> $vmsourcepath = <Enter UNC_FQDN Of Tintri Box\hyperv\ Enter Source Directory Used Before> For example: $vmdestpath = \\My VMStore FQDN\hyperv\1234Restore $vmsourcepath = \\My VMStore FQDN\hyperv\1234 # Get XML File $xmlfile = Get-ChildItem $vmsourcepath\* -include *.xml $vmfile = $vmsourcepath + \ + $xmlfile.name $importedvm = Import-VM -Path $vmfile -vhdsourcepath $vmsourcepath -copy -GenerateNewId -VhdDestinationPath $vmdestpath -SmartPagingFilePath $vmdestpath -SnapshotFilePath $vmdestpath -VirtualMachinePath $vmdestpath Note: Was this section helpful? Click Documentation Feedback and let us know. 12

13 Obtain Snapshot Creation Times The code example below obtains the Snapshot creation times for a specific VM: # Displays the creation time of the first VM on the Tintri Server. # # Input positional parameters: # 1. Tintri server name or IP address # 2. Optional user name which defaults to admin param([string]$tintriserver, [String]$user= admin ) # Connect to the Tintri server. $conn = connect-tintriserver -Server $tintriserver -UserName $user $myhost = $conn.appliancehostname $myapiversion = $conn.apiversion write-verbose Connected to $myhost at $myapiversion. # Obtain all the VMs associated with this Tintri server. $vms = get-tintrivm # Extract the name of the first VM. $vmname = $vms[0].vmware.name Write-verbose Getting Snapshot create times for $vm- Name. $ss = get-tintrivmsnapshot -Name $vmname $ss.createdate # Disconnect from the Tintri server. disconnect-tintriserver -TintriServer $conn write-verbose Disconnected from $myhost. Notice the VM name is inside the VMware data structure, returned from get-tintrivm. PS>.\get_vm_snapshots ttvm38.tintri.com The following output is displayed: Connected to ttvm38.tintri.com at v310. Getting Snapshot create timess for ttvm38-01-vm-1 (2). 5/30/2014 2:43:25 PM 6/4/ :05:05 PM 6/16/2014 5:05:26 PM 13

14 6/16/2014 6:05:26 PM 6/16/2014 7:05:27 PM 6/16/2014 8:05:27 PM 6/16/2014 9:05:22 PM 6/16/ :05:23 PM 6/16/ :05:23 PM 6/17/ :05:23 AM 6/17/2014 1:05:24 AM 6/17/2014 2:05:24 AM 6/17/2014 3:05:24 AM 6/17/2014 4:05:25 AM 6/17/2014 5:05:25 AM 6/17/2014 6:05:25 AM 6/17/2014 7:05:26 AM 6/17/2014 8:05:26 AM 6/17/2014 9:05:26 AM 6/17/ :05:27 AM 6/17/ :05:27 AM 6/17/ :05:22 PM 6/17/2014 1:05:23 PM 6/17/2014 2:05:23 PM 6/17/2014 3:05:23 PM 6/17/2014 4:05:24 PM Disconnected from ttvm38.tintri.com. Note: Was this section helpful? Click Documentation Feedback and let us know. 14

15 Automation Toolkit PowerShell Examples Automation Toolkit PowerShell Examples are available on the Tintri Support Portal. Select the Downloads tab > Utilities tab. Examples cover topics such as: alert collection, cloning, disk information, replication, snapshot control and VM monitoring. Modification of these examples may be necessary to make them work in your specific environment. Note: Was this section helpful? Click Documentation Feedback and let us know. Tintri, the Tintri logo, Tintri VMstore, and FlashFirst are trademarks or registered trademarks of Tintri, Inc. All other trademarks or service marks are the property of their respective holders and are hereby acknowledged. Copyright 2014 Tintri, Incorporated. All Rights Reserved. 303 Ravendale Dr., Mt. View CA