Capture Utility Reference

Refer to the following table for the options available for the Google Transfer Appliance capture utility.

Capture utility commands

Command Usage
capture-directory Required, unless you choose to use -f instead to specify a list of files to capture. Data is captured from the specified directory and all subdirectories. The value must be an absolute path to the source data as it is accessed from the workstation where you run the capture utility.
-f filespec Optional. Instead of specifying a single directory to capture, you can provide a text file containing a list of data files to capture. filespec must be the absolute path to a text file, which in turn contains a list of absolute paths to the target data files to be captured, one file per line. Paths to directories in filespec are ignored.
job-name

Required. The job name for the data capture jobs. A job name can only contain alphanumeric characters, hyphens ( - ) and underscores ( _ ). The job name is used to track the progress and final disposition of the capture job in the Transfer Appliance web interface and the Rehydrator interface. When you rehydrate data in Google Cloud Platform (GCP), data is recovered to a Google Cloud Storage bucket named the same as the capture job that is the source of the data.

Use a meaningful job name. They are used to identify each capture job, and the files it contains, for the rest of the data migration project. For example, if you capture the file e:\sourcedatafolder\data1\file_001 with the Windows capture utility command tacapture.exe this-job e:\sourcedatafolder\data1, the file will reside at gs://<bucket_name>/this-job/e:/sourcedatafolder/data1/file_001 in the Google Cloud Storage staging bucket when your data is uploaded into GCP.

-m Optional. The number of parallel capture tasks (subprocesses of the capture job) to run for a data capture job. Defaults to 8, which is also the maximum possible. You might want to use fewer parallel capture tasks if you want to use fewer ports or have poor network bandwidth.
-p portNum Optional. If the default data streaming ports (as described in Firewall port requirements) on the workstation are blocked for incoming traffic and you don't want to open them, you can use this option to direct the capture process to use different ports. portNum specifies the starting port number on the workstation to open for incoming traffic from Transfer Appliance. Each capture task requires its own data streaming port and chooses one from the range portNum through (portNum + tasks - 1), where tasks is the count of capture tasks (either the default of 8, or as specified by the -m option). If you specify a port range, make sure it is unique for each job, as having port overlap between jobs can cause errors.
-t Optional. Tests network connectivity between the workstation and the Transfer Appliance.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Google Transfer Appliance