Installation and Administration Guide - Storware Virtual machine group management ... Run test...

Warsaw2017

Storware vProtect 2.6

Installation and

Administration Guide

1

STORWARE SPÓŁKAZOGRANICZONĄODPOWIEDZIALNOŚCIĄSPÓŁKAKOMANDYTOWA

ul. Leszno 8/44, 01-192 Warszawa, tel: +48 730 602 611 NIP: 5213656342, e-mail: [email protected], www.storware.eu

Contents 1. Prerequisitesandenvironmentpreparation...................................................................................3

2. Installation.......................................................................................................................................4

3. Initialconfiguration(fromWebUI)..................................................................................................8

3.1Virtualmachinebackup.................................................................................................................9

3.2Virtualmachinerestore...............................................................................................................11

3.3Backupmount/unmount(RHV/oVirt/OVM).............................................................................12

4.WebInterface....................................................................................................................................14

4.1Dashboard...................................................................................................................................14

4.2Taskmanagement.......................................................................................................................15

4.3Hypervisormanagement.............................................................................................................16

4.4Virtualmachinemanagement.....................................................................................................18

4.5Virtualmachinegroupmanagement..........................................................................................19

4.6Schedulemanagement................................................................................................................20

4.7Enginelog....................................................................................................................................21

4.8Settings........................................................................................................................................22

4.8.1General.................................................................................................................................22

4.8.2Taskexecution......................................................................................................................23

4.8.3Hypervisor............................................................................................................................24

4.8.4RHEV/oVirt...........................................................................................................................24

4.8.5OracleVM.............................................................................................................................25

4.8.6IBMSpectrumProtect..........................................................................................................25

4.8.7EMCNetworker....................................................................................................................26

4.8.8VeritasNetBackup................................................................................................................27

4.8.9AmazonS3............................................................................................................................27

4.8.10OpenStackSwift.................................................................................................................28

4.8.11FileSystem..........................................................................................................................29

5.CommandLineInterface...................................................................................................................30

5.1ConfigurationFiles.......................................................................................................................30

/opt/vprotect/config.properties(deprecated)..............................................................................30

/opt/tivoli/tsm/client/api/bin64/dsm.opt....................................................................................30

/opt/tivoli/tsm/client/api/bin64/dsm.sys.....................................................................................31

5.2Startingandstoppingservices....................................................................................................32

5.3Mainmenu..................................................................................................................................34

2



5.4Hypervisorpoolmanagement(Citrixonly).................................................................................35

5.5Hypervisormanagement.............................................................................................................36

5.6Hypervisormanager(i.e.RHEV/oVirt)management..................................................................37

5.7Virtualmachinemanagement.....................................................................................................38

5.8Virtualmachinegroupmanagement..........................................................................................39

5.9Backup/restoremanagement.....................................................................................................40

5.10Schedulemanagement..............................................................................................................41

5.11Mountedbackupsmanagement...............................................................................................43

5.12Taskmanagement.....................................................................................................................44

6.Troubleshooting................................................................................................................................45

7.DisasterRecovery..............................................................................................................................46

3



1. Prerequisites and environment preparation

1. Validlicense.keyfile-dependsonnumberandtypeofhypervisorsandbackupproviderthatyouwanttouse([email protected]).

2. OperatingSystem:LinuxRedhat/CentOS73. Prepareandmountstorage

a. sizeestimation:numberofVMsbackedupsimultaneouslytimesthesizeofthebiggestVM

b. recommendedmountpoint:/vprotect_data4. Addhostnameto/etc/hosts

5. Unblock8080and443portsonthefirewall(s).Example:

[root@vProtect /]# cat /etc/hosts 127.0.0.1 localhost localhost.localdomain localhost4 localhost4.localdomain4 vProtect

firewall-cmd --add-port=8080/tcp –permanent firewall-cmd --add-port=443/tcp --permanent firewall-cmd --complete-reload

4



2. Installation

1. Copyinstallationpackagevprotect-2.6.0-install.tgz,anduncompressit.

2. Changedirectorytovprotect-install.

3. Runinstallationscript,andwaitinstallerwillinstallallnecessaryrepositories.Wheninstalleraskaboutbackupproviderchoseone.

a. Makethisstep’sonlyifyouwantuseISP(IBMSpectrumProtectknownasTSM)asabackupdestination.

i. Select“1”,andacceptinstallationof“IBMSpectrumProtectClient”.

ii. RegisterNodeonTSMserver,fromdsmadmccommandline:

b. Makethisstep’sonlyifyouwantuseLocalStorage.i. Select“2”,andtypestoragepathonyoursystem.

[root@vProtect tmp]# tar -xf vprotect-2.6.0-install.tgz

cd vprotect-install

./install.sh ____ _ _ __ _| _ \ _ __ ___ | |_ ___ ___| |_ \ \ / / |_) | '__/ _ \| __/ _ \/ __| __| \ V /| __/| | | (_) | || __/ (__| |_ \_/ |_| |_| \___/ \__\___|\___|\__| REPOSITORIES [OK] # INTERNET CONNECTION [OK]

Please select your backup provider 1) ISP - IBM Spectrum Protect 2) Local Storage Select:1 Do you want to install IBM Spectrum Protect Client? [Yes/No]:Y Downloading, and installing ISP Client. Register vProtect node on ISP server. register node vprotect_proxy <SecretPassword> dom=<VMdomain> maxsess=10 passe=0 dedup=cli backdel=yes #######

tsm: TSM> Reg node VPROTECT_PROXY passw0rd dom=VM passe=0 dedup=cli maxnummp=10 backdel=yes

5



ii. Ifyouwan’tenableOpenDeduplicationonstoragetypeYes.(notrecommendedforcitrixxenbackup)

IfyouselectOpendeduplication:

c. Makethisstep’sonlyifyouwantuseNetbackupasabackupdestination.InstallNetBackupclient.MoreinNetbackupdocumentation(page133):https://download.veritas.com/resources/content/live/DOCUMENTATION/5000/DOC5154/en_US/NetBackup7.5_Install_UNIX.pdf?__gda__=1484277005_8d5c080f0b0030103a243e4a39a32184

4. IfyouwantenableSSLconnectiontovProtecttypeYes.

5. IfyouwantenableNFSshare(forbackupOVM,RHV)typeYes.

Andlateredit/etc/exportsfiletoallowaccesstoNFSforselectedIP.

Please select your backup provider 1) ISP - IBM Spectrum Protect 2) Local Storage Select:2 Installing Local Storage. Type storage path in your filesystem to store backup: /storage

## In /storage you have 500G free storage space. Do you want install, and enable Open Deduplication? [Yes/No]:

########## Local storage space set to /opendedup Local storage Open Deduplication [OK]

########### vProtect instalation [OK] Do you want to enable SSL conection to vProtect? [Yes/No]:

####### Do you want to configure NFS share? [Yes/No]:

6



6. UsewebbrowsertoconnecttovProtecthttp://IPvProtect:8080/console/start

####### Do you want to configure NFS share? [Yes/No]: # NFS UTILS [OK] NFS utils are installed configure it manualy. /etc/exports example: /vprotect_data IP_KVM_HOST(rw,sync,insecure,all_squash,anonuid=0,anongid=0)

#### vProtect installed correctly. https://vProtect/console/start Installation log: /var/log/vProtect_2017-03-16_17:27.install.log Starting vProtect server... vProtect server is running (PID = 3073). Please check log files: /var/log/vprotect_daemon.log*

7



7. Makethisstep’sonlyifyouwantbackupRHEV,RHV,Ovirt,OracleVM.a. AddbackupstoragedomainintheRHEV/oVirt–nameofthisdomainwillbelater

usedintheconfigurationb. BothimportandexportoperationswillbedoneusingthisNFSshare–restorewill

bedonedirectlytothisstoragedomain,soyoucaneasilyimportbackupintoRHEV/oVirt(shownbelow)

Notice:formultipleexportdomains(oneperdatacenter)remembertocreatesubdirectoriesforeachdatacenterinexportpathi.e./vprotect_data/dc01,/vprotect_data/dc02,anduseeachsubdirectoryasNFSshareforeachdatacenterexportdomain.

c. CreaterepositoryfromNFSshare(OVMexample).

8



3. Initial configuration (from WebUI)

LogintotheadminWebUIhttp://IPvProtect:8080/console/startorhttps://IPvProtect/console/start

Credentialsandtimezoneareconfiguredinvconsole.cfgfile,defaultcredentials:

login:rootpassword:vPr0tect

Enterin“Settings”menu.

1. ChoseyoubackupRepositoryIBMSpectrumProtect,OpenStackSwift,VeritasNetBackup,orlocalFileSystem.

For“IBMSpectrumProtect”enternodename,password,andtimezone(ISPdetailedconfiguration).

For“OpenStackSwift”enterurl,login,andpassword(OpenStackSwiftdetailedconfiguration).

For“VeritasNetBackup”enterpolicy,schedule,realexportpath(VeritasNetBackupdetailedconfiguration).

For“FileSystem”enterpath,andretention(FileSystemdetailedconfiguration).

For“AmazonS3”enteraccesskey,secretkey,uniquekeytoidentifybuckets,andsetretention(AmazonS3detailedconfiguration).

<?xml version="1.0" encoding="UTF-8"?>  <config> <preferences> <debug>true</debug> <vaddress>127.0.0.1</vaddress> <vport>8080</vport> <vpath>vprotect</vpath> <timezone>CET</timezone> <user>root</user> <password>vPr0tect</password> <elog>5000</elog> </preferences> </config>

9



Saveconfiguration(enginewillapplysettingsinaround30s.).

2. AddHypervisormanager,orhypervisorhost(Hypervisormanagement).3. CreategroupsforVM’s(Virtualmachinegroupmanagement).4. Defineschedules(Schedulemanagement).5. Runtestbackup/restoreforthevm.

3.1 Virtual machine backup

Pleaseselectvirtualmachinestobackup(multipleselectionwithcheckboxes),andrightmouseclick,thenclickin“Backup”.

Thenyoucaneditstarttimeforbackuptask,andunselectmachinefrombackup.IfallissetuprunbackupclickingOK.

ForCitrixyoucanselectincrementalbackup(onlyiffirstwillbecreatedschedulejobwithincremental).

10



11



3.2 Virtual machine restore

Pleaseselectvirtualmachinestorestore,andrightmouseclick,thenclickin“Restore”.

Thenselectbackuptime,andrestorepath.ForCitrixyoucanrestorevirtualmachinedirectlytothehypervisor.Ifyouimportbackuptothehypervisor(Citrix)-youneedtoprovidewhichstoragerepositoryshouldthebackuptemplatebecreatedon.

12



Whenrestoreoperationends,dependingontheselectedvirtualizationplatform,youneed:

1. Citrix–importXVA(ifnotdoneautomatically),anddeployVMfromitusingXenCenter2. RHV/oVirt–restoreisdonetostaging,andshouldappearinImportVMtabforexport

storagedomain3. OracleVM-restoreisdonetostaging,andshouldappearinUnassignedVirtual

Machines4. KVM/Xen(libvirt)–restoredonetostaging,QCOW2filesshouldbereplacedmanualy

intheoriginalVMdirectory,LVMvolumesoverwritewithddcommand,XMLfileusedtorecreateVM

3.3 Backup mount / unmount (RHV/oVirt/OVM)

Pleaseselectvirtualmachinestobackupandrightmouseclick,thenclickin“Mountbackup”.

Youcanselecteithertomountautomaticallyallfilesystemsdetectedinthebackup(singleroot)ormanuallytoseparatemountpoints.

Manualmount:ifyousetmountpathtoemptystring,volumewillnotbemounted.

13



Mountedbackupsaremanagedusing“Mountedbackups”button:

Firstlistshowslistofallmountedbackups(ifyourebootmachineorvolumesareunmountedforanyreason,youcanremountthemusing“Mountselected“button.“Unmountselected”buttonunmountsbackupandremoves(ifbackupsarenotuseddirectlyfrombackupprovider).

RandomAccesscolumnshowsifbackupisindependfrombackupprovider(randomaccess=false)orisreaddirectlyfrombackupprovider(randomaccess=true,supportedonlyforFileSystembackupprovider).

14



4. Web Interface

4.1 Dashboard

Dashboard is themain screen of the application. It allows you to quickly get general informationaboutbackupstatus,itssizeandthevProtect’senginestate.

Itconsistofseveralsections:

• VMprotection–numberofVMs thathave scheduleandareprotected (ornot) and thosewhichhavenotbeenassignedtoanygroup(orschedule)

• vProtect’s temporary space – this relates to the temporary space that has been providedduringinstallation(bydefault/vprotect_datamountpoint)

• VM backup size in last 24h – summary of top biggest VMs in terms of backup size (sumofbackupsizesperVM)thathasbeendoneinlast24h

• vProtect Status – number of hypervisors, VMs, groups and schedules assigned to theenvironment,enginestatusandlicensestatus

• Totalbackupsize/day–sumofbackupsforeachdayinpast30days

15



4.2 Task management

Atthebottomofthescreen,thereisataskmanager.Youcandragitstopborderandmoveup/downtochangeit’ssizetomatchyourneeds.Rightclickenablesyoutoclearuporcanceltasks.

Colorsof theprogressbar indicate statusof the task (blue for running tasks, green for completedandredforfailed).Ingeneral,thereareseveraltasktypes:

• Index–toindexVMsandhypervisors• Export–1stphaseofthebackup–snapshotandexportdatafromhypervisortothevProtect

server• Store–2ndphaseofthebackup–movedatatothebackupprovider• Restore–restoresbackuptostaging(also1ststepformount/importoperations)• Import–importsVMtoCitrixXenServer• Mount–mountsbackupfilestovProtect(RHV/oVirt/OVM)• Oldbackupscleanup–cleansbackupsperiodicallyinbackupprovideraccordingtoretention

settings

Window Start and End represent time windowwhen the task should start. If the engine will notbeable to start the taskwithin this window (i.e. all of the threads are processing other backups,andtherewasnothreadavailabletostartthistask),thetaskfails.

16



4.3 Hypervisor management

Hypervisor management section enables you to define and modify properties of hypervisors andindexVMsandhypervisorsrunninginthevirtualenvironment.Itconsistsof3tables:

• Hypervisors - list of all hypervisors visible to the vProtect – both definedmanually (CirtixXenServer,Xen,KVM)andattachedtotheRHEV/oVirtmanager

• Hypervisor pools – Citrix XenServer only – represents pools defined in the Citrixenvironments–usedtoinformvProtectaboutpooltopology.

• Hypervisors managers – RHEV/oVirt managers only – hypervisors for this environmentareaddedautomaticallybyindextaskforhypervisormanager

Todefinenewhypervisor:

• gototheHypervisormanagementsectionandclickNew(topleftcorner).• ProvideIP/hostname,usernameandpassword• (KVM/Xenonly)logintothevProtectoperatingsystemasrootandrun:

17



(KVM only) KVM setup requires qemu-kvm and libvirt to provide blockcommit functionality.DistributionssuchasCentOShaveonlyalimitedqemu-kvmpackage.Youcanconsultthreadslikethisone: https://www.redhat.com/archives/libvirt-users/2014-November/msg00106.html in ordertopreparehypervisortobecompatiblewithvProtect.

TodefineRHEV/oVirtmanager:

• clickNew(top-leftbuttoninthethirdtable)• provide API URL for the manager (form: https://IP/api) <ADMIN_USER>@<PROFILE>

andpasswordforRHV/oVirt4.0url:https://IP/ovirt-engine/api/v3

Defined hypervisor/hypervisor manager can now be indexed. Index of RHEV/oVirt manager alsodetectsVMs in the environment. If theoVirt/RHEVmanager is attached tomorehypervisors thanthelicenseallows,backupsrelatedtosuchenvironmentwillfail.Sameruleappliestothesituation,whentherearemorehypervisorsofaspecifictypedefinedthanlicensemaximum.

[root@localhost ~]# ssh -o HostKeyAlgorithms=ssh-rsa 10.110.100.13 The authenticity of host '10.110.100.13 (10.110.100.13)' can't be established. RSA key fingerprint is 96:5d:05:58:84:c4:38:51:c6:6b:b1:bf:5d:f8:50:08. Are you sure you want to continue connecting (yes/no)? yes Warning: Permanently added '10.110.100.13' (RSA) to the list of known hosts. [email protected]'s password: ! password to 10.110.100.13 host Last login: Thu Oct 6 15:43:29 2016 from 192.168.55.127 [root@KVM ~]# exit logout Connection to 10.110.100.13 closed. [root@localhost ~]# ssh 10.110.100.13 Last login: Mon Oct 10 12:40:38 2016 from 10.110.100.15 [root@KVM ~]# exit logout Connection to 10.110.100.13 closed. [root@localhost ~]#

18



4.4 Virtual machine management

VirtualmachinemanagementsectionshowsalloftheVMsdetectedintheenvironment,andstatusoflast backup. Last Successful Backup color indicates if the backup has been done accordingtotheschedule defined. No color means that even though the backup has been done, thereisnoschedulecurrentlydefinedfortheVM.

Usingthissection,userisabletobackupandrestoreVMsondemand.SelectVMsusingcheckboxesandclickrightmousebuttontohaveamenuofactionsavailable.BackupcanbedoneonmultipleselectedVMs,whilerestoreactionisrelatedonlytothesinglerowselection.Backupoperationcanbeexecutedwithdifferentthandefaultpriority(50=default,0=lowest,100=highest),whichisusefulwhentherearealreadysometasksinthequeueandyouwanttohavecontroloverthetaskqueue.

“Present”flagrepresentsthestatusoftheVMinthevirtualenvironment–iftheVMisnotavailableinthevirtualenvironmentanymore,“present”flag issettofalse,andbackupsforthisVMscannotbedone.

TotrackinformationaboutconsecutivebackupsforeachVMandtheirstatusorcauseofitsfailureyoucanuse“Listbackups”right-clickmenuoption.“Listschedules”alsoenablesyoutolistalloftheschedulesappliedtothegrouptowhichVMisassigned.

“Properties”oftheVMallowyoutochangethegrouptowhichVMisassigned.YoucandeleteVMfromthevProtectinventoryusing“Delete”right-clickmenuoption.

VMsareaddedautomaticallyby indextask.Apart frombeing invokedmanually, it isalsoexecutedevery24hbydefault.

19



4.5 Virtual machine group management

GroupsenableyoutoassignschedulestomultipleVMsonce.InordertoassignscheduletotheVMitneedsfirsttobeassignedtosomegroup.

StepsinordertoassignschedulestoVMs:

• Create group: “New” button in top left corner and provide name and priority (whichisassignedtoallbackuptasksrelatedtotheVMsinthegroupexecutedbyschedule)

• Use“Assign/removeVMs”right-clickmenutomanageVMsinthegroup• Use“Assign/removeschedules”right-clickmenutomanageschedulesinthegroup• Youcanuseauto-assignment tagandRE toautomaticallyassignVMsthatdon’tbelong to

anygroupbasedonVMnameortag(Citrix/RHV/oVirt)

20



4.6 Schedule management

ScheduledefineswhenandonwhichdaysVMsshouldbebackedup.Ithasthefollowingproperties:

• Windowstarttime–defineswhenthetaskshouldbeaddedtothequeue• Duration–defineshowlongthetaskshouldwaitforbeingexecuted(otherwisefails)• Whichdaysoftheweekthebackupshouldbeexecuted• Activeflag–toenableordisableschedule• Backup type – full/incremental (incremental for Citrix only, at least one incremental

schedulemustbeassignedtothegrouptoenableincrementalbackupforVMsinthegroup)• VMgrouptowhichtheschedule isassigned(onegrouponly,howeverthegroupcanhave

multipleschedules)

In order to define new schedule use the New button in the top-left corner and provide above-mentionedproperties.

21



4.7 Engine log

Incaseofanyproblem,youcanalwaysviewcurrentenginelog.Enginelogenablesyoutoviewlastenginemessagesandexportloginseveralformats.

Search box on the right enables you also to filter out messages by message content or status.Archivedlogfileswitholdermessages(vprotect_daemon.log*files)arestoredin/var/logdirectory

22



4.8 Settings

EngineconfigurationcanbedoneusingWebUI.ClickSettingsbuttontoopenconfigurationwindow.Thereareseveraltabsrelatedtothedifferentaspectsoftheconfiguration.

Aftersavingconfigurationitshouldtakeaproximately30secondsforenginetorereadconfiguration.

4.8.1 General

Generaltabvariables:

• Backup provider – TSM (IBM Spectrum Protect), SWIFT (OpenStack Swift), NETBACKUP(Veritas NetBackup), FILE_SYSTEM (local File System) – detailed configuration for backupprovidercanbefoundinappropriatetabs.

• Export path – default is /vprotect_data – path to store temporary backup files beforetransfertothebackupprovider–itisrecommentedtousesymlink/vprotect_datapointingtoactualmountpoint(thisenableseasiermigrationincaseofpathchange)

• Max. backup time difference [s] – maximum time difference between vProtect serverandbackendusedbylocal-to-remotebackupmatching

• Keeplastbackuplocally–whethertokeeporremovelastbackupintemporaryspaceaftertransfertobackupprovider(iflastbackupisbeingrestored,thenitcanberestoreddirectlyfromstagingwithouttheneedtoaccessbackupprovider)

• Removed backup retention [days] – number of days to keep information in vProtect’sdatabaseaboutbackupafterithasbeenremovedfrombackupprovider

Notice:Keeplastbackuplocallysetting:• Whenflagissettotrue,lastbackupsarekeptin<EXPORT_PATH>/lastBackups

directoryinordertospeedupaccesstolastbackups,• Usageforspecifictasks:

o Restore-filesarecopiedfromlastBackupsdirtospecifiedrestoredirectoryo Import-filesaredirectlyusedbyimporttask,sounnecessarycopyingisnottaking

placeo Mount-filesarecopiedfromlastBackupstomountdestination

• Whenspecifiedbackupisnotlastbackuporanyfileismissingthenfilesaretakenfrombackupprovider.

23



4.8.2 Task execution

Taskexecutiontabvariables:

• Max.numberofindexthreads–max.numberofconcurrentlyrunningindexthreads• Indexoperationtimewindow[mins.]–defaulttimewindowforstartingindextask• Max. number of export threads – max. number of concurrently running export tasks (1st

phaseofbackup)• Exportoperationtimewindow[mins.]-defaulttimewindowforstartingexporttask• Max.numberofstorethreads–max.numberofconcurrentlyrunningexporttasks(2ndphase

ofbackup)• Storeoperationtimewindow[mins.]-defaulttimewindowforstartingstoretask• Max.numberofrestorethreads–max.numberofconcurrentlyrunningrestoretasks• Restoreoperationtimewindow[mins.]–defaulttimewindowforstartingrestoretask• Taskretention(taskbar)[mins.]–numberofminutesuntilfinishedtasksareremovedfrom

taskslist

24



4.8.3 Hypervisor

Hypervisortabvariables:

• CitrixXenServer–progressrefreshinterval[s]–numberofsecondstopollhypervisorforprogressupdate(exporttask)

• SSHcommandtimeout[s]–numberofsecondstowaitforanSSHcommandexecutedonKVM/Xenhypervisors

• SSHknownhostsfile–knownhostsfilelocationonvProtectserver–default/root/.ssh/known_hosts

• SSHprogressrefreshrate(every1/xofdatasize)–howoftentorefreshprogresswhentransferringdataoverSSH(xtimesperdatasize)

• LVMsnapshotsize–valuefor“-l”parameterinlvcreatecommand• LVMsnapshotextents–valuefor“-L”parameterinlvcreatecommand

4.8.4 RHEV/oVirt

RHEV/oVirttabvariables:

• Exportfrommultipledatacentersstoragedomain–ifRHVenvironmentsconsistofmultipledatacenters, you need to setup separate NFS exports in your staging with name of thedatacentre (must correspond to datacentre names in RHV): i.e. /vprotect_data/dc01,/vprotect_data/dc02…(eachdatacentreshoulduseownNFSexportasexportdomain.

• Snapshotcreationtimeout[s]–timeoutforsnapshotcreationduringexportphase• Snapshotclonetimeout[s]–timeoutforsnapshotcloningprocessduringexportphase• Exporttimeout[s]–timeoutforexportclonedVMduringexportphase

25



• ForcedDCtoSDmapstring(optional)–whenusingmultipleDCsinRHV(version3.5only)you need to manually specifiy list of pairs <DC_NAME>=<STORAGE_DOMAIN_NAME>(semicolon separated) to inform vProtect what are the name of export domain for eachdatacenter.

4.8.5 Oracle VM

OracleVMtabvariables:

• Backup storage repository id - this is the ID of the repository that is going to be usedbyvProtecttoexportVMs

• Jobstatuspollinginterval[s]-intervalinseconds,howoftenvProtectpollsOVMforstatus

4.8.6 IBM Spectrum Protect

IBMSpectrumProtecttabvariables:

• dsm.optfilelocation–default/opt/tivoli/tsm/client/api/bin64/dsm.opt• Node name – name of the node used by vProtect server in IBM Spectrum Protect

environmentExampleofnoderegistrationsettings:RegisternodeVPROTECT_PROXYsecure_passworddom=vmpasse=0dedup=cli

• Password – node password used by vProtect server to log in to IBM Spectrum Protectenvironment

26



• Timezone–TimezonesetonIBMSpectrumProtectserver• Retention(full)–keeplastNbackups:-keeponlyNlastversionsofthefullbackup• Retention(full)–keepbackupsNdays:-keeponlyversionsofthefullbackupthatarenot

olderthanNdays• Retention (incremental) – keep last N backups: - keep only N last versions

oftheincrementalbackup• Retention (incremental) – keep backups N days: - keep only versions ofthe incremental

backupthatarenotolderthanNdays• Backupprogressrefreshrate(every1/xofdatasize)–howoftentorefreshprogresswhen

transferringdatatoIBMSpectrumProtect(xtimesperdatasize)• Restoreprogressrefreshrate(every1/xofdatasize)–howoftentorefreshprogresswhen

transferringdatafromIBMSpectrumProtect(xtimesperdatasize)

Notice:

• Default management class in vprotect_proxy node domain must not have less restrictivesettingthaninvProtect(i.e.shouldallowmoreversionsandlongertimethanvProtect).

• RemembertochangealsotimezoneinthevProtectserverthatisusedinyourcountryo https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

• Nodenamechangerequiresupdateofdsm.optanddsm.sysfilesin:o /opt/tivoli/tsm/client/api/bin64o /opt/tivoli/tsm/client/ba/bin

• Make sure /vprotect_data points to the location that has sufficient storage space to keepstaged files – lastbackupof eachVM is stored in thisdirectory.Bydefault /vprotect_datasymlinkpointstothe/tmpdirectoryontheVM.Ifyouneedmorespace,pleaseaddanotherVMdisk,andwhenitisavailableupdate/vprotect_datasymlinktopointtothenewlocation

4.8.7 EMC Networker

Notice:EMCNetworkerrequiresagentandadministrativetoolsinstalledonthevProtectmachine:commandsrequired:save,recover,mminfo,nsrmm

Filesystemtabvariables:

• Serveraddress–addressofyourNetworkerserver• Retention(full)–keeplastNbackups:-keeponlyNlastversionsofthefullbackup• Retention(full)–keepbackupsNdays:-keeponlyversionsofthefullbackupthatarenot

olderthanNdays

27



• Retention (incremental) – keep last N backups: - keep only N last versionsoftheincrementalbackup

• Retention (incremental) – keep backups N days: - keep only versions ofthe incrementalbackupthatarenotolderthanNdays

4.8.8 Veritas NetBackup

VeritasNetBackuptabvariables:

• Home directory - directory of the NetBackup client (needs to be installed and configuredbeforerunningfirsttasks

• Policy-nameofthepolicyassignedinNetBackuptotheclientusedbyvProtect• Schedule - name of the schedule assigned in NetBackup to the client used by vProtect;

backup schedules are controlled by vProtect, so no specific values should be configuredinNetBackup

• Real export path - net backup client requires export path (staging space, default/vprotect_data) to be real directories instead of symlinks; if /vprotect_data is a symlinktoe.g./datathenput/datainthisfield

4.8.9 Amazon S3

AmazonS3tabvariables:

• S3backupmode– ifyouprefertostoreallVMs inasinglebucket,oruseseparatebucketperVM

• Uniquekeytoidentifybuckets–nameofsinglebucketpreviouslycreatedonS3• Bucketnamewherebackupswillbestored–nameprefixforbucketscreatedforeachVM• Accesskey–generatedkeyfromS3

28



• Secretkey-generatedkeyfromS3• Retention(full)–keeplastNbackups:-keeponlyNlastversionsofthefullbackup• Retention(full)–keepbackupsNdays:-keeponlyversionsofthefullbackupthatarenot

olderthanNdays

4.8.10 OpenStack Swift

OpenStackSwifttabvariables:

• Authenticationmethod-BASIC/TEMPAUTH/KEYSTONE• AuthenticationURL–URLpointingtoauthenticationservice• Username–username:tenant formattedusernameusedbyvProtect to log intoOpenStack

Swift• Password–passwordusedbyvProtecttologintoOpenStackSwift• Segmentsize[MB]–sizeofdatasegmentintowhichdataisbeingfragmentedwhensending

toSwift• Retention(full)–keeplastNbackups:-keeponlyNlastversionsofthefullbackup• Retention(full)–keepbackupsNdays:-keeponlyversionsofthefullbackupthatarenot



backupthatarenotolderthanNdays

29



4.8.11 File System

Filesystemtabvariables:

• Storage paths, separated by semicolons - paths to file systems mounted on vProtecttobeused by File System connector for storing data (paths will be balanced basedonthefreespaceavailable)

• Retention(full)–keeplastNbackups:-keeponlyNlastversionsofthefullbackup• Retention(full)–keepbackupsNdays:-keeponlyversionsofthefullbackupthatarenot



backupthatarenotolderthanNdays

30



5. Command Line Interface

5.1 Configuration Files

/opt/vprotect/config.properties (deprecated)

ThisthemainconfigurationfileforthevProtect.Startingfromthe2.2releaseitshouldbeusedonlyforpointingengine to theAPI, andall of the configuration shouldbedone viaWebUI. EnginewillreplaceconfigvariableswiththosesetbyWebUI.

Wheneveryoumodifythisfile,pleaseremembertorestartdaemon:

• /opt/vprotect/vprotectstop• /opt/vprotect/vprotectstart

/opt/tivoli/tsm/client/api/bin64/dsm.opt

youcanalsocopythisfileto/opt/Tivoli/tsm/client/ba/bin,soyourBAclientcanalsouseit.



API_URL=http://localhost:8080/vprotect BACKUP_PROVIDER=TSM TSM_DSM_OPT_FILE=/opt/Tivoli/tsm/client/api/bin64/dsm.opt TSM_NODE_NAME=VPROTECT_PROXY TSM_PASSWORD=secret TSM_TIME_ZONE=CET BACKUP_TIME_DIFF=600 EXPORT_PATH=/vprotect_data

SErvername VPROTECT_PROXY

31



/opt/tivoli/tsm/client/api/bin64/dsm.sys

PleasechangeServernameandNODENAMEvariablestomatchnodenameintheconfigurationintheUI(nameofthenodeusedbyvProtectwhenconnectingtoTSM(SpectrumProtect)).YoualsoneedtoprovideTCPServeraddressvariable(addressofyourTSMinstance).

youcanalsocopy this file to/opt/Tivoli/tsm/client/ba/bin, soyourBAclient canalsouseit



SErvername VPROTECT_PROXY NODENAME VPROTECT_PROXY COMMMethod TCPip TCPPort 1500 TCPServeraddress 192.168.55.2 Passwordaccess generate passworddir /opt/tivoli/tsm/client/api/bin64/passwd deduplication yes dedupcachepath /opt/tivoli/tsm/client/api/bin64 dedupcachesize 2048 enablededupcache yes

32



5.2 Starting and stopping services

StorwarevProtectconsistsof3maincomponents:

– vProtectAPI– vProtectEngine– vProtectWebUI

TostartAPIandWebUI,pleaseexecutethefollowingcommand:

Startprocedurecantakeuptoaminute.Youcanlaterverifyifitisrunning:

or

(shouldreturnasinglerow)

TostartvProtectenginepleaseexecutethefollowingcommand:

UsebrowsertoaccessWebUI:http://IPvProtect:8080/console/start

Tostopengine:

[root@vProtect vprotect]# systemctl start tomcat

[root@vProtect vprotect]# systemctl status tomcat ● tomcat.service - Apache Tomcat Web Application Container Loaded: loaded (/usr/lib/systemd/system/tomcat.service; enabled; vendor preset: disabled) Active: active (running) since Wed 2016-10-05 12:43:37 CEST; 1 day 22h ago Process: 13419 ExecStop=/usr/libexec/tomcat/server stop (code=exited, status=0/SUCCESS)

[root@vProtect vprotect]# netstat -tlnp | grep 8080 tcp6 0 0 :::8080 :::* LISTEN 13501/java

[root@vProtect vprotect]# /opt/vprotect/vprotect start Starting vProtect server... vProtect server is running (PID = 21986).

[root@vProtect vprotect]# /opt/vprotect/vprotect stop Stopping vProtect server (PID = 13625)... vProtect server is not running.

33



youcanverifyiftheengineisrunningbyusing:

TostopAPIandWebUI,pleaseexecutethefollowingcommand:

Stopprocedurecantakeuptoaminute.Youcanlaterverifyifitisrunning:

or

(shouldnotreturnanything)

[root@vProtect vprotect]# /opt/vprotect/vprotect status vProtect server is not running.

[root@vProtect vprotect]# systemctl stop tomcat

[root@vProtect vprotect]# systemctl status tomcat ● tomcat.service - Apache Tomcat Web Application Container Loaded: loaded (/usr/lib/systemd/system/tomcat.service; enabled; vendor preset: disabled) Active: inactive (dead) since Fri 2016-10-07 10:58:48 CEST; 30s ago Process: 21371 ExecStop=/usr/libexec/tomcat/server stop (code=exited, status=0/SUCCESS) Process: 13501 ExecStart=/usr/libexec/tomcat/server start (code=exited, status=143) Main PID: 13501 (code=exited, status=143)

[root@vProtect vprotect]# netstat -tlnp | grep 8080

34



5.3 Main menu

vProtectprovidesaneasytouseCLI.Generalsyntaxis:

If you do not provide required parameter – usage screen for a particularmodule is being shown.Youcanalsoinvokevprotectcommandfromthe/opt/vprotectdirectoryusing./vprotect.

Expamples:

• Tolisthypervisors:

/opt/vprotect/vprotect hv –l

• Tosetuser/passwordforhypervisor:

• Toshowhelpforhypervisormanagementmodule:

[root@vProtect-dev vprotect]# ./vprotect usage: vprotect <COMMAND> -<ARG_1> ... -<ARG_N> COMMAND is one of the following: pool Hypervisor pool management hv Hypervisor management hvm Hypervisor manager management vm Virtual machine management vmg Virtual Machine Group management br Backup/restore management sched Schedule management mnt Mounted backups management task Task management stop Safely stops engine status Shows engine status start Starts engine

/opt/vprotect/vprotect NAME_OF_THE_MODULE PARAMETERS

/opt/vprotect/vprotect hv –l

/opt/vprotect/vprotect hv –u 1 root password

/opt/vprotect/vprotect hv

35



5.4 Hypervisor pool management (Citrix only)

HypervisorpoolmanagementisusedtoprovideinformationaboutpoolingofXenServerhypervisorsinyourenvironment.Ifyou’reconnectingstand-alonehypervisoryoudon’thavetocreateanypool.However, ifyourenvironmentusespoolsofhypervisors,youmustdefinethemhereandaddallofthehypervisorsinthatpool.

Expamples:

• Toaddpool:

• TohypervisorwithID1topoolwithID2:

assumingthatyouhavedefinedbothpoolandhypervisor.IDsarealwaysshowninthefirstcolumnoftheoutput.

• Tolistpools:

• TolisthypervisorsinthepoolwithID1:

[root@vProtect vprotect]# ./vprotect pool Incorrect syntax: Missing required option: [-c Create a new pool, -s Set master for the pool, -d Delete a pool, -l List pools, -L List hypervisors in the pool, -m Modify pool] usage: pool -c <NAME> | -d <ID> | -l | -L <ID> | -m <ID> <NAME> | -s <ID> <HV_ID> Hypervisor pool management -c,--create <NAME> Create a new pool -d,--delete <ID> Delete a pool -l,--list List pools -L,--list-hv <ID> List hypervisors in the pool -m,--modify <ID> <NAME> Modify pool -s,--set-master <ID> <HV_ID> Set master for the pool

/opt/vprotect/vprotect pool –c Pool1

/opt/vprotect/vprotect hv –p 1 2

/opt/vprotect/vprotect pool –l

/opt/vprotect/vprotect pool –L 1

36



5.5 Hypervisor management

Hypervisor management module is used to add, remove hypervisors and invoke indexing task.IndexingtasksgathersinformationaboutVMsrunningonthehypervisorandupdatestheirlocationiftheVMhasbeenmovedwithinthepool.

Examples:

• TodefineCitrixXenServerhypervisor:

• TosetcredentialstobeusedforhypervisorwithID1:

• ToindexVMsonhypervisorwithID1:

Notice–indexingmasterhypervisorinthepoolalsoprovidesinformationaboutotherVMsonotherhypervisors

• TolistVMsonhypervisorwithID1:

• TodeletehypervisorwithID1:

[root@vProtect vprotect]# ./vprotect hv Incorrect syntax: Missing required option: [-p Set hypervisor's pool (0 = remove from pool), -c Create hypervisor (type = ["citrix", "xen", "kvm"]), -d Delete hypervisor, -u Set user/password, -i Index VMs on hypervisor, -l List hypervisors, -L List VMs for hypervisor, -m Modify hypervisor] usage: hv -c <HOST> <TYPE> | -d <ID> | -i <ID> | -l | -L <ID> | -m <ID> <HOST> | -p <HV_ID> <POOL_ID> | -u <ID> <USER> <PASSWORD> Hypervisor management -c,--create <HOST> <TYPE> Create hypervisor (type = ["citrix", "xen", "kvm"]) -d,--delete <ID> Delete hypervisor -i,--index <ID> Index VMs on hypervisor -l,--list List hypervisors -L,--list-vms <ID> List VMs for hypervisor -m,--modify <ID> <HOST> Modify hypervisor -p,--set-pool <HV_ID> <POOL_ID> Set hypervisor's pool (0 = remove from pool) -u,--credentials <ID> <USER> <PASSWORD> Set user/password

/opt/vprotect/vprotect hv –c 192.168.1.100 citrix

/opt/vprotect/vprotect hv –u 1 root password

/opt/vprotect/vprotect hv –i 1

/opt/vprotect/vprotect hv –L 1

/opt/vprotect/vprotect hv –d 1

37



5.6 Hypervisor manager (i.e. RHEV/oVirt) management

Hypervisormanagermanagementmodule is used to add, remove hypervisormanagers (currentlyonlyoVirtandRHEVmanagers)and invoke indexingtask. Indexingtasksgathers informationabouthypervisorsandVMsrunninginthemanagedenvironmentandupdatestheirlocationiftheVMhasbeenmovedtothedifferenthypervisor.

Examples:

• TodefineRHEV/oVirthypervisormanager:

RHV/oVirt4.0hypervisormanager:

• TosetcredentialstobeusedforhypervisorwithID1:

• ToindexVMsonhypervisorwithID1:

Notice–indexingmasterhypervisorinthepoolalsoprovidesinformationaboutotherVMsonotherhypervisors

• TolistVMsonhypervisormanagerwithID1:

• TolisthypervisorsdetectedonhypervisormanagerwithID1:

• TodeletehypervisormanagerwithID1:

[root@vProtect-dev vprotect]# ./vprotect hvm Incorrect syntax: Missing required option: [-c Create hypervisor manager (type = ["rhev", "ovm"]), -d Delete hypervisor manager, -u Set user/password, -V List VMs managed by hypervisor manager, -i Index inventory on hypervisor manager, -l List hypervisor managers, -L List hypervisors managed by hypervisor manager, -m Modify hypervisor manager] usage: hvm -c <URL> <TYPE> | -d <ID> | -i <ID> | -l | -L <ID> | -m <ID> <URL> | -u <ID> <USER> <PASSWORD> | -V <ID> Hypervisor manager management -c,--create <URL> <TYPE> Create hypervisor manager (type = ["rhev", "ovm"]) -d,--delete <ID> Delete hypervisor manager -i,--index <ID> Index inventory on hypervisor manager -l,--list List hypervisor managers -L,--list-hvs <ID> List hypervisors managed by hypervisor manager -m,--modify <ID> <URL> Modify hypervisor manager -u,--credentials <ID> <USER> <PASSWORD> Set user/password -V,--list-vms <ID> List VMs managed by hypervisor manager

/opt/vprotect/vprotect hvm –c https://51.254.226.232/api rhev

/opt/vprotect/vprotect hvm –c https://51.254.226.232/api/v3 rhev

/opt/vprotect/vprotect hvm –u 1 root password

/opt/vprotect/vprotect hvm –i 1

/opt/vprotect/vprotect hvm –V 1

/opt/vprotect/vprotect hvm –L 1

/opt/vprotect/vprotect hvm –d 1

38



5.7 Virtual machine management

Virtual machine management module is used to provide information about VMs that has beendetectedonhypervisors, report statusof lastbackupofyourVMs (andallbackups foraparticularVM)andsetpriorityforoperationsinvokedonVM.

Examples:

• TolistavailableVMs:

• Toassignhigherpriority (60, range is from0 to100)whenbackup task isexecutedby the

scheduleronVMwithID1:

• TolistbackupsofaVMwithID1:

• ToshowreportofthestatusoflastbackupsforallVMs:

[root@vProtect vprotect]# ./vprotect vm Incorrect syntax: Missing required option: [-p Set VM's backup task priority (0-100, 50 = default), -B Last backup report, -S List backup schedules for VM, -d Delete VM, -T List tasks related to the VM, -g Assign VM to the group, -l List VMs, -L List backups of the VM] usage: vm -B | -d <ID> | -g <ID> <VM_GROUP_ID> | -l | -L <ID> | -p <ID> <PRIORITY> | -S <ID> | -T <ID> Virtual machine management -B,--report-last-backup Last backup report -d,--delete <ID> Delete VM -g,--assign-vmg <ID> <VM_GROUP_ID> Assign VM to the group -l,--list List VMs -L,--list-backups <ID> List backups of the VM -p,--set-priority <ID> <PRIORITY> Set VM's backup task

priority (0-100, 50 = default)

-S,--list-schedules <ID> List backup schedules for VM -T,--list-tasks <ID> List tasks related to the

/opt/vprotect/vprotect vm –l

/opt/vprotect/vprotect vm –p 1 60

/opt/vprotect/vprotect vm –L 1

/opt/vprotect/vprotect vm –B

39



5.8 Virtual machine group management

VirtualmachinegroupmanagementmoduleisusedtodefinegroupsofVMs.Youcanassigndifferentbackuppriorityforagroupwhenthescheduler invokesbackuptask.YouneedfirsttodefineaVMgroupandthenaddVMstoit.VMcanbelongonlytoasinglegroup.

Examples:

• TolistavailableVMgroups:

• Todefineanewgroup(Group1):

• ToassignVMswithIDs1,2and3totheVMgroupwithID5:

Notice – there is no spaces between commas and IDs of VMs – this is a single comma-separatedstring

• To set priority lower priority (40, range is from 0 to 100) for backup task defined on thegroupwithID1:

• TolistVMsinthegroupwithID1:

• TolistschedulesassignedtothegroupofVMswithID1:

[root@vProtect vprotect]# ./vprotect vmg Incorrect syntax: Missing required option: [-p Set group's backup task priority (0-100, 50 = default), -c Create a new group, -S List schedules for the group, -d Delete a group, -U unassign VMs to the group, -V Assign VMs to the group, -l List groups, -L List VMs in the group, -m Modify group] usage: vmg -c <NAME> | -d <ID> | -l | -L <ID> | -m <ID> <NAME> | -p <ID> <PRIORITY> | -S <ID> | -U <ID> <VM_ID,...,VM_ID> | -V <ID> <VM_ID,...,VM_ID> Virtual Machine Group management -c,--create <NAME> Create a new group -d,--delete <ID> Delete a group -l,--list List groups -L,--list-vms <ID> List VMs in the group -m,--modify <ID> <NAME> Modify group -p,--set-priority <ID> <PRIORITY> Set group's backup task

priority (0-100, 50 = default)

-S,--list-schedule <ID> List schedules for the group -U,--unassign-vms <ID> <VM_ID,...,VM_ID> Unassign VMs from the group -V,--assign-vms <ID> <VM_ID,...,VM_ID> Assign VMs to the group

/opt/vprotect/vprotect vmg –l

/opt/vprotect/vprotect vmg –c Group1

/opt/vprotect/vprotect vmg –V 5 1,2,3

/opt/vprotect/vprotect vmg –p 1 40

/opt/vprotect/vprotect vmg –L 1

/opt/vprotect/vprotect vmg –S 1

40



5.9 Backup/restore management

This module is used to manage backup and restore process. It is also used to list backups of aparticularVM.

Examples:

• Tolistallbackupsandtheirstatus:

• TobackupaVMwith ID1 (notice that the ID is shown in theoutputof the./vprotect

vm –l)allbackupsandtheirstatus:

• Tobackupwithapriority80(higherthandefault,whichis50):

• TolistbackupsoftheVMwithID1:

• TorestoreabackupfileofaVM(forXenServeritisXVAformat)frombackupwithID123to

/tmp/restoreddirectory:

Notice–directorywillbeautomaticallycreatedifitdoesn’texists

• TomonitorprogressofthestateoftasksassociatedwithbackupwithID123:

• ToremovebackupwithID123fromthelist(notfromTSM):

[root@vProtect-dev vprotect]# ./vprotect br Incorrect syntax: Missing required option: [-b Backup VM (full), -B Backup VM (full) with task priority (0-100, 50 = default), -d Delete the backup, -D Remove old backups, -F List file systems, -H Restore the backup to the hypervisor, -i Backup VM (incremental), -I Backup VM (incremental) with task priority (0-100, 50 = default), -l List backups, -L List backup files, -M Restore the backup to the hypervisor manager, -r Restore the backup, -T List tasks related to the backup] usage: br -b <VM_ID> | -B <VM_ID> <PRIORITY> | -d <ID> | -D | -F <arg> | -H <ID> <HV_ID> <STORAGE_ID> | -i <VM_ID> | -I <VM_ID> <PRIORITY> | -l | -L <ID> | -M <ID> <HVM_ID> <STORAGE_ID> | -r <ID> <DIRECTORY> | -T <ID> Backup/restore management -b,--backup <VM_ID> Backup VM (full) -B,--backup-with-priority <VM_ID> <PRIORITY> Backup VM (full) with task priority (0-100, 50 = default) -d,--delete <ID> Delete the backup -D,--remove-old-backups Remove old backups -F,--list-file-systems <arg> List file systems -H,--restore-to-hv <ID> <HV_ID> <STORAGE_ID> Restore the backup to the hypervisor -i,--backup-inc <VM_ID> Backup VM (incremental) -I,--backup-inc-with-priority <VM_ID> <PRIORITY> Backup VM (incremental) with task

priority (0-100, 50 = default) -l,--list List backups -L,--list-files <ID> List backup files -M,--restore-to-hvm <ID> <HVM_ID> <STORAGE_ID> Restore the backup to the hypervisor manager -r,--restore <ID> <DIRECTORY> Restore the backup -T,--list-tasks <ID> List tasks related to the backup

/opt/vprotect/vprotect br –l

/opt/vprotect/vprotect br –b 1

/opt/vprotect/vprotect br –B 1 80

/opt/vprotect/vprotect br –L 1

/opt/vprotect/vprotect br –r 123 /tmp/restored

/opt/vprotect/vprotect br –T 123

/opt/vprotect/vprotect br –d 123

41



5.10 Schedule management

Schedulemanagementmodule isused tocreateschedulesassociatedwithVMsorgroupsofVMs.Each scheduledefinesdaysofweekand thehourwhen thebackup tasks shouldbe invoked.Eachschedulealsodefinestimewindowinwhichthebackupprocessmuststart. Ifthetaskqueueisfullandthetasksstartsafterthespecifiedamountoftimefromtheschedule–itwillbecancelledandmarkedasfailed.

Notice:

– tasksinthequeuearerunintheorderfromthehighesttothelowestpriority.– you can assign multiple schedules if you need backup to be executed at different hours

ondifferentdays– remember always to assign schedule toVMorVMgroup– schedule canbeassignedonly

toasingleVMorVMgroup

Examples:

• Tolistallschedulesdefined:

• TocreateafullbackupschedulewithnameSchedule1executedeverydayat05:00with60

minutesoftimewindow:

• To create a incremental backup schedule with name Schedule2 executed everyMonday,

WednesdayandFridayat17:00with90minutesoftimewindow:

Notice – days of week are given as a single comma-separated string of short (3-letter)weekdaynames

[root@vProtect vprotect]# ./vprotect sched Incorrect syntax: Missing required option: [-a Set schedule to be active (1) / not active (0), -c Create schedule for VM (type: FULL / INCREMENTAL), -d Delete schedule, -g Assign schedule to the VM group, -l List schedules, -m Modify schedule (type: FULL / INCREMENTAL)] usage: sched -a <ID> <0|1> | -c <NAME> <TYPE> <START_TIME> <DURATION> <everyday | DAYS_OF_WEEK> | -d <ID> | -g <ID> <VM_GROUP_ID> | -l | -m <ID> <NAME> <TYPE> <START_TIME> <DURATION> <everyday | DAYS_OF_WEEK> Schedule management -a,--set-active <ID> <0|1> Set schedule to be active (1) / not active (0) -c,--create <NAME> <TYPE> <START_TIME> <DURATION> <everyday | DAYS_OF_WEEK> Create schedule for VM (type: FULL / INCREMENTAL) -d,--delete <ID> Delete schedule -g,--assign-vmg <ID> <VM_GROUP_ID> Assign schedule to the VM group -l,--list List schedules -m,--modify <ID> <NAME> <TYPE> <START_TIME> <DURATION> <everyday | DAYS_OF_WEEK> Modify schedule (type: FULL / INCREMENTAL)

/opt/vprotect/vprotect sched –l

/opt/vprotect/vprotect sched –c Schedule1 FULL 05:00 60 everyday

/opt/vprotect/vprotect sched –c Schedule2 INCREMENTAL 17:00 90 mon,wed,fri

42



• To create schedules (full backup) with name Schedule3 and Schedule4 executed everyTuesdayat02:00andeveryWednesdayat03:00with90minutesoftimewindowandassignthemtotheVMgroupwithID123:Notice–assumingIDsgeneratedfornewschedules10and11respectively:

• TodisableaschedulewithID123:

• ToassignschedulewithID123totheVMgroupwithID456:

/opt/vprotect/vprotect sched –c Schedule3 FULL 02:00 90 tue /opt/vprotect/vprotect sched –c Schedule4 FULL 03:00 90 wed /opt/vprotect/vprotect sched –g 10 123 /opt/vprotect/vprotect sched –g 11 123

/opt/vprotect/vprotect sched –a 123 0

/opt/vprotect/vprotect sched –a 123 456

43



5.11 Mounted backups management

MountedbackupmanagementmoduleisusedtomountandunmountsbackupsofRHV/oVirt/OVMVMsonthevProtectServer.Eachmountedbackupcanbemountedautomatically(auto-detectionofmountpointswithinsinglerootormanuallywithseparatemountpointsforeachvolume.

Examples:

• Tolistallmountedbackupsdefined:

• TolistallmountedfilesusedbymountedbackupwithID=1:

• TolistallmoutedfilesystemsandmountpointsformountedbackupwithID=1:

• TomountallfilesystemsinbackupwithID=123to/mnt/myVM/2017-01-01

• Tomountmanually file systems inbackupwith ID=123with specifyingmountpoints youneedtoprovidesemicolon-separatedlistwhereyouprovidenameofthevolume=mount point (white space before or after semicolon or equal sign is not allowed)

• TounmountsmountedbackupwithID=1:

[root@vProtect-dev vprotect]# ./vprotect mnt Incorrect syntax: Missing required option: [-T List tasks related to the mounted backup, -u Unmount previously mounted backup, -F List file systems, -l List mounted backups, -L List mounted files, -m Mount backup according to the MOUNT_SPECIFICATION] usage: mnt -F <arg> | -l | -L <ID> | -m <ID> <auto|manual> <MOUNT_SPECIFICATION> | -T <ID> | -u <ID> Mounted backups management -F,--list-file-systems <arg> List file systems -l,--list List mounted backups -L,--list-files <ID> List mounted files -m,--mount <ID> <auto|manual> <MOUNT_SPECIFICATION> Mount backup according to the MOUNT_SPECIFICATION -T,--list-tasks <ID> List tasks related to the mounted backup -u,--unmount <ID> Unmount previously mounted backup

/opt/vprotect/vprotect mnt –l

/opt/vprotect/vprotect mnt –L 1

/opt/vprotect/vprotect mnt –F 1

./vprotect mnt -m 123 auto /mnt/myVM/2017-01-01

./vprotect mnt -m 123 manual "/dev/sda1=/mnt/123/sda1; /dev/vg_sda/lv_root=/mnt/123/lv_root"

/opt/vprotect/vprotect mnt –u 1

44



5.12 Task management

Taskmanagementmodule isused to showandcancel tasksbeingexecuted.Youcanalsomonitorprogressofthetasks.

Notice:

– tasksinthequeuearerunintheorderfromthehighesttothelowestpriority.– queueisbeingperiodicallycleaned,soonlylasttasksarebeingshown

Examples

• Tolistalltasksinthequeue:

• Tolistallrunningtasksinthequeue:

• TocancelataskwithID1:

Notice – some tasksmay require to be finished before they are cancelled, i.e. export VMfrom the hypervisor – after cancellation the backup process will be finished withoutuploadingfiletotheTSMandbackupwillbemarkedascancelled.

[root@vProtect vprotect]# ./vprotect task Incorrect syntax: Missing required option: [-Q List queued tasks, -R List running tasks, -d Delete/cancel task, -F List finished (including failed) tasks, -l List tasks] usage: task -d <ID> | -F | -l | -Q | -R Task management -d,--delete <ID> Delete/cancel task -F,--list-finished List finished (including failed) tasks -l,--list List tasks -Q,--list-queued List queued tasks -R,--list-running List running tasks

/opt/vprotect/vprotect task –l

/opt/vprotect/vprotect task –R

/opt/vprotect/vprotect task –d 1

45



6. Troubleshooting

StorwarevProtectdaemonwritesallofthemessagestothevprotect_daemon.logfilesinthe/opt/vprotect. CLI interface records messages in vprotect_client.log files. TSM(Spectrum Protect related errors can also be found in dsierror.log in the /opt/vprotectdirectory.

Commonissues:

– Indexorbackuptasksfail:o The most common error is a typo in hypervisor address or credentials – use

hypervisormoduletomodifyhypervisoraddressorcredentials– Backupfailsontheexporttask–numericcodeisprovidedintheBackupstatus:

o PleaserefertoClientMessagesandApplicationProgrammingInterfaceReturnCodesfor the versionof TSM (SpectrumProtect) that you’re using. For version 7.1.2 youcanusethefollowinglink:

http://www-01.ibm.com/support/knowledgecenter/SSGSG7_7.1.2/com.ibm.itsm.msgs.client.doc/b_msgs_client.pdf

VerificationifWebUIisrunning:

shouldreturnalinewithservicerunning8080

WebUIrelatedmessagesarerecordedin/usr/share/tomcat/logs/vconsole.log*

Ifwillbeproblemwithportal,pleaseverifythatsteps:

a. vprotectservice

b. tomcatservice(port8080or443)


[root@vProtect vprotect-install]# cd /opt/vprotect/ [root@vProtect vprotect]# ./vprotect status vProtect server is running (PID = 4988).


46



7. Disaster Recovery

Storware vProtect stores all of the metadata in the local database. The database is stored in/usr/share/tomcat/vprotect.db.

It is highly recommended to schedule a periodic copy and transfer of this database to remotelocation.Databaseshouldbecopiedwhennotasksarerunningandthereforeacommonpracticeistoscheduleittobedoneduringtheday(outsideVMbackupwindow).

Additionally it is recommendtoalsokeepacopyofbackupproviderspecific files, i.e.dsm.optanddsm.sys files for IBM Spectrum Protect, or other config files used by NetBackup, Networker,OpenDedupetc.

IncaseofacompletelossofthevProtectServer:

1. ReinstallOS2. ReinstallvProtect3. Stoptomcatservice

4. Replace/usr/share/tomcat/vprotect.dbwithbackupcopy5. Replaceallbackupproviderspecificfiles6. Makesurestagingpathiscorrectandavailable7. Starttomcatservice

8. Restartenginetorestartdaemon:

AtthispointvProtectshouldbereadytocontinueoperation.

[root@vProtect ~]# systemctl stop tomcat

[root@vProtect ~]# systemctl start tomcat

[root@vProtect ~]# /opt/vprotect/vprotect stop [root@vProtect ~]# /opt/vprotect/vprotect start

Installation and Administration Guide - Storware Virtual machine group management ... Run test...

Documents

Transcript of Installation and Administration Guide - Storware Virtual machine group management ... Run test...