Start_guest_scan

Use this vmcli command to scan guest VMs for application information.

The vmcli -f start_guest_scan command saves VM name, application, and globally unique identifier (GUID) information to the Tivoli® Storage Manager server.

You must issue the vmcli -f set_password command before you run a guest scan operation.

Syntax

The vmcli -f start_guest_scan command uses this syntax:

vmcli -f start_guest_scan -dcscan "datacenterNvmcliprofile,...," | ALL_DC -o datamovernodename

Required Parameters

-dcscan datacenterNvmcliprofile | ALL_DC

Specify one or more datacenter names that are defined in the vmcliprofile. Repeat datacenter names with a comma. Double quotation marks (") must be specified at the beginning and at the end of the datacenter name list. For example:

-dcscan "Local DC,svc"

To scan all VM guests in all datacenters, specify the ALL_DC parameter.

-o datamovernodename

Specify the data mover node that is configured with proxy authority access to the datacenters specified by -dcscan.

During a vmcli -f start_guest_scan operation, Data Protection for VMware copies files to a temporary subdirectory in the remote directory ($TEMP_REMOTE\TSMSCAN) on the guest VM. The remote directory must be unlocked and not used by another application. Data Protection for VMware determines the location of the remote directory in the following order:

If the TEMP environment variable is set, TEMP_REMOTE is set as the TEMP environment variable.
If the TEMP environment variable is not set, TEMP_REMOTE is set as C:\TEMP.

Example

In this example, the vmcliprofile contains the following VE_DATACENTER_NAME settings:

VE_DATACENTER_NAME: DataCenter1:TSM_DC1
VE_DATACENTER_NAME: DataCenter2:TSM_DC2

The data mover node, VC1_DC1_DM1, is configured with proxy authority access to DataCenter1 and DataCenter2.

The following command is issued to scan all guest VMs in DataCenter1 and DataCenter2:

vmcli -f start_guest_scan -dcscan "DataCenter1,DataCenter2" -o VC1_DC1_DM1

The following application information is displayed:

Tivoli Storage Manager Command Line Wrapper for Virtual Environments
Version: 7.1.0.00
Build Date: Mon Apr 8 20:03:31 2012
Tivoli Storage Manager API Version 71000
Tivoli Storage Manager Command Line Wrapper Compile Version 71000
#PARAM OPERATION_TYPE 9
#PHASE_COUNT 4
#PHASE PREPARE
#PARAM BACKUP_TYPE=0
#PARAM TSM_SERVER_NAME=OREO.STORE.XYZ.COM
#PARAM TSM_SERVER_PORT=1500
#PARAM TSMCLI_NODE_NAME=VC1_VCLI1
#PARAM VCENTER_NODE_NAME=VC1
#PARAM DATACENTER_NODE_NAME=VC1_DC1
#PARAM OFFLOAD_HOST_NAME=VC1_DC1_DM1
#PARAM PASSWORD_TYPE=CLINODE
#PARAM TSM_OPTFILE=C:\Users\ADMINI~1\AppData\Local\Temp\2\T4V9393.tmp
#PARAM INPUT_FILE=
#PARAM TRACEFILE=c:\amd64_unicode\tsmcli.trace
#PARAM TRACEFLAGS=service,VMVCB,VMTSMVSS,verbdetail,C2C
#PHASE INITIALIZE
#CHILD targetnode:VC1_DC1
#PARENT peernode:VC1_DC1_DM1
#CHILD hladdress:9.52.62.65
#PARENT peernode:VC1_DC1_DM1
#CHILD lladdress:50408
#PARENT peernode:VC1_DC1_DM1
#PHASE READ_DATACENTER_GUEST_PASSWORD
#PHASE SCANGUEST
#PARAM STATUS=success

#CHILD scanid: DataCenter1::VC1_DC1.1358316054281
#PARENT datacentername: DataCenter1::VC1_DC1
#PARAM OPERATION_TYPE 9 #PHASE_COUNT 4 
#PHASE PREPARE 
#PARAM BACKUP_TYPE=0 
#PARAM TSM_SERVER_NAME=OREO.STORE.XYZ.COM 
#PARAM TSM_SERVER_PORT=1500 
#PARAM TSMCLI_NODE_NAME=VC1_VCLI1 
#PARAM VCENTER_NODE_NAME=VC1 
#PARAM DATACENTER_NODE_NAME=VC1_DC2 
#PARAM OFFLOAD_HOST_NAME=VC1_DC1_DM1 
#PARAM PASSWORD_TYPE=CLINODE 
#PARAM TSM_OPTFILE=C:\Users\ADMINI~1\AppData\Local\Temp\2\T4V50B.tmp 
#PARAM INPUT_FILE= #PARAM TRACEFILE=c:\amd64_unicode\tsmcli.trace 
#PARAM TRACEFLAGS=service,VMVCB,VMTSMVSS,verbdetail,C2C 
#PHASE INITIALIZE #CHILD targetnode:VC1_DC2 
#PARENT peernode:VC1_DC1_DM1 
#CHILD hladdress:9.52.62.65 
#PARENT peernode:J_VC1_DC1_DM1 
#CHILD lladdress:50408 
#PARENT peernode:VC1_DC1_DM1 
#PHASE READ_DATACENTER_GUEST_PASSWORD 
#PHASE SCANGUEST 
#PARAM STATUS=success
#CHILD scanid: DataCenter2::VC1_DC2.1358316054281 
#PARENT datacentername:DataCenter2::VC1_DC2
#INFO FMM16014I The return code is 0. 
#END

Windows operating systems The #PARAM STATUS=success message (in the #PHASE SCANGUEST section) confirms only that the datacenter was successfully submitted for processing by the data mover. The actual scan status for each VM is available only after the data mover completed processing that VM. To view the scan status of an individual VM, see the value in the Scan Status column of the Data Protection for VMware vSphere GUI Application Configuration Status report. To view the overall status of the scan operation, see the Overall Scan Status value in the Data Protection for VMware vSphere GUI Report window.

Important: If you receive an error after you run the vmcli -f start_guest_scan command, view the contents of the dsmerror.log file for more information. The dsmerror.log file is on the system that is associated with the data mover node defined by the OFFLOAD_HOST_NAME parameter in the command output. By default, error log files are in the installation directory:
C:\Program Files\Tivoli\TSM\baclient