VSASubclientContent

Scope

Intended Audience
All X
CommVault Internal  
CE/System Test  
Development  

Platform

  • CommServer (Database: CommServ)

Release

  • 9.0.0

Description

Use the QS_VSASubclientContent script to move/delete/list/add vm/vms for specified subclient.


Note:


1. The script could accept one vm (by @i_vmName) or list of vms placed inside text file (path to file in @i_vmListFileName).



2. @i_OperationName one of {'Move'|'Delete'|'List'|'Add'}.



3. if the script used to move vm/vms (@i_OperationName='Move') you have to specify @i_NewSubclientName also.



4. Use optional parameters @i_BackupSetName/@i_NewBackupSetName if @i_SubclientName/@i_NewSubclientName are not unique for provided client and instance.



5. if @i_OperationName='Add' then file specified by @i_vmListFileName must have comma separated VM name, VM GUID, VM ESX Server on each line of file like:


vmName1,vmGUID1,vmESXServer1


vmName2,vmGUID2,vmESXServer2



6. if @i_OperationName='Move' or 'Delete' then file specified by @i_vmListFileName must have just VM name on each line of file like:


vmName1


vmName2



7. if @i_OperationName='Add' and file is not specified by @i_vmListFileName then you have to specify VM name via @i_vmName, VM GUID via @i_vmGUID amd VM ESX Server via @i_vmESXServer.



8. If invalid arguments or combination of arguments are used, appropriate error messages are displayed.




Usage:


  • qoperation execscript -sn VSASubclientContent -si @i_ClientName='client_name' -si @i_InstanceName='Instance_Name' -si @i_SubclientName='subclient_name' -si @i_OperationName='Operation_Name' [ -si @i_BackupSetName='BackupSetName' -si @i_vmName='VM_Name' -si @i_NewBackupSetName='NewBackupSetName' -si @i_NewSubclientName='New_Subclient_Name' -si @i_vmListFileName='vm_List_File_Name' -si @i_vmGUID='vmGUID' -si @i_vmESXServer='ESXServer']
     


    • Example:


  • qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='Move' -si @i_vmName='VM1' -si @i_NewBackupSetName='TestBackupSet' -si @i_NewSubclientName='TestSubclient2'
     


  • qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='Delete' -si @i_vmListFileName='c:\VmList.txt'
     


  • qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_BackupSetName='defaultBackupSet' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='List'
     


  • qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='Add' -si @i_vmName='VM_Name1' -si @i_vmGUID='vmGUID1' -si @i_vmESXServer='ESXServer1'
     

    • Usage

    qoperation execscript -sn VSASubclientContent -si @i_ClientName='client_name' -si @i_InstanceName='Instance_Name' -si @i_SubclientName='subclient_name' -si @i_OperationName='Operation_Name' [ -si @i_BackupSetName='BackupSetName' -si @i_vmName='VM_Name' -si @i_NewBackupSetName='NewBackupSetName' -si @i_NewSubclientName='New_Subclient_Name' -si @i_vmListFileName='vm_List_File_Name' -si @i_vmGUID='vmGUID' -si @i_vmESXServer='ESXServer']


  • @i_OperationName one of {'Move'|'Delete'|'List'|'Add'}.
     
  • if @i_OperationName='Move' you have to specify @i_NewSubclientName.
     
  • You can specify one VM by @i_vmName or list of VMs by @i_vmListFileName or combination of both.
     
  • @i_vmListFileName must contain full path to text file with VM information.
     
  • if @i_OperationName='Add' then file specified by @i_vmListFileName must have comma separated VM name, VM GUID, VM ESX Server on each line of file like (CSV file):
     
  • vmName1,vmGUID1,vmESXServer1
     
  • vmName2,vmGUID2,vmESXServer2
     
  • Note: VM GUID (UUID) format should be like: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'. Real file line example:
     
  • testvm4,564d27a5-1847-b59e-0615-b9cb5ef77e9b,vsa-esx3
     
  • if @i_OperationName='Move' or 'Delete' then file specified by @i_vmListFileName must have just VM name on each line of file like:
     
  • vmName1
     
  • vmName2
     
  • Use optional parameters @i_BackupSetName/@i_NewBackupSetName if @i_SubclientName/@i_NewSubclientName are not unique for provided client and instance.
     
  • if @i_OperationName='Add' and file is not specified by @i_vmListFileName then you have to specify VM name via @i_vmName, VM GUID via @i_vmGUID amd VM ESX Server via @i_vmESXServer.
     


    • Example:



  • qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='Move' -si @i_vmName='VM1' -si @i_NewBackupSetName='TestBackupSet' -si @i_NewSubclientName='TestSubclient2'
     


  • qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='Delete' -si @i_vmListFileName='c:\VmList.txt'
     


  • qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_BackupSetName='defaultBackupSet' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='List'
     


  • qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='Add' -si @i_vmName='VM_Name1' -si @i_vmGUID='564d27a5-1847-b59e-0615-b9cb5ef77e9b' -si @i_vmESXServer='ESXServer1'
     

    • Version


  •  

    • Disclaimer of Warranties

    CommVault provides software tools and utilities on an "as is" basis, as a courtesy and convenience to its users, and they may be changed from time to time without notice. These tools and utilities are provided without express, implied, or statutory warranties of any kind. You assume full risk and responsibility for the selection, possession, performance and proper installation and use of the software tools and utilities, and for verifying the results obtained there from. Your use of CommVault software tools and utilities indicates your unconditional acceptance of the above disclaimer.