Veeam Home | Support | Downloads
Veeam FastSCP 1.0 for Microsoft Azure

Veeam Help Center  > User Guide > Using the Command-Line Utility

Using the Command-Line Utility

Previous page Next page Print this Topic

Table of contents

To upload a file or folder to or download a file or folder from an Azure VM, you can use the Veeam.FastSCP.Copy command-line utility.

The utility can copy one folder or file per command execution. Commands are executed independently of Veeam FastSCP for Microsoft Azure jobs. Independently means that limitations on the number of concurrent jobs in Veeam FastSCP for Microsoft Azure do not apply to the utility commands. That is, you can execute a copy command in Veeam.FastSCP.Copy and run a job in Veeam FastSCP for Microsoft Azure at the same time.

Installation and Configuration

The Veeam.FastSCP.Copy utility is installed together with Veeam FastSCP for Microsoft Azure, and resides in the product installation folder. The default path to the utility is C:\Program Files\Veeam\FastSCP for Azure\Veeam.FastSCP.Copy.exe.

If required, you can change the default settings of the utility in the configuration file. For details, see Advanced Configuration.

Syntax and Parameters

The file copy command has the following syntax:

Veeam.FastSCP.Copy.exe -vm:<Azure_VM> -source:<path_to_source> -target:<path_to_target> -dir:{send|recv} [-username:<username>] [-password:<password>] [-verbose:{yes|no}] [-port:<port_number>] [-ssl:{yes|no}] [-skipca:{yes|no}] [-skipcn:{yes|no}] [-skiprc:{yes|no}]

The command can take the following parameters:

Parameter

Short Form

Required

Description

vm

--

yes

Azure cloud service DNS name.

Alternatively, you can specify a Public Virtual IP address of a cloud service.

source

src

yes

Path to the source file or folder.

To upload a file or folder to an Azure VM, specify a path to the file or folder on-premises.

To download a file or folder to on-premises, specify a path to the file or folder on an Azure VM.

target

trg

yes

Path to the target folder.

To upload a file or folder to an Azure VM, specify a path to the target folder on the Azure VM.

To download a file or folder to on-premises, specify a path to the target folder on-premises.

dir

--

yes

File copy direction. The following values are accepted:

send — upload a file or folder from on-premises to an Azure VM.

recv — download a file or folder from an Azure VM to on-premises.

username

u

yes

Username of the local Administrator on the Azure VM.

The username must be specified in the DOMAIN\USERNAME format for domain accounts or HOST\USERNAME for local accounts.

password

p

yes

Password of the local Administrator on the Azure VM.

verbose

v

no

Type of command output to show in the command prompt. The following values are accepted:

yes — produce verbose command output.

no (default) — produce standard command output.

port

--

no

Number of a public port configured for the PowerShell Remoting endpoint on the Azure VM.

If you plan to enable SSL encryption for traffic between the Azure VM and Veeam.FastSCP.Copy, specify an HTTPS port.

If you plan to disable encryption for traffic between the Azure VM and Veeam.FastSCP.Copy, specify an HTTP port.

The default port number is 5896.

ssl

--

no

Specifies whether traffic between the Azure VM and Veeam.FastSCP.Copy must be encrypted with SSL. The following values are accepted:

yes (default) — encrypt traffic with SSL.

no — do not encrypt traffic with SSL.

skipca

--

no

Specifies whether Veeam.FastSCP.Copy must skip verification of the Azure service certificate digital signature. The following values are accepted:

yes (default) — do not perform the certificate authority verification check.

no — perform the certificate authority verification check.

skipcn

--

no

Specifies whether Veeam.FastSCP.Copy must skip verification of the VM hostname against the Azure service certificate. The following values are accepted:

yes — do not perform the common name verification check.

no (default) — perform the common name verification check.

skiprc

--

no

Specifies whether Veeam.FastSCP.Copy must skip verification of the Azure service certificate revocation status. The following values are accepted:

yes — do not perform the certificate revocation check.

no (default) — perform the certificate revocation check.

Example 1: Download a File

This command downloads a file C:\Program Files\MyApp\MyApp.log from an Azure VM to a local folder C:\Users\Administrator\Downloads\Files\. Data is transmitted over an SSL connection. The following certificate verification checks are performed: common name verification check, certificate revocation check. Command output is set to verbose.

"C:\Program Files\Veeam\FastSCP for Azure\Veeam.FastSCP.Copy.exe" -vm:files001.cloudapp.net -source:"C:\Program Files\MyApp\MyApp.log" -target:C:\Users\Administrator\Downloads\Files\ -dir:recv -username:files001\john.smith -password:PaSsWoRd -verbose:yes -port:51229

Example 2: Upload a Folder

This command uploads a folder C:\Users\Administrator\Files\MyApp\ from on-premises to an Azure VM folder C:\inetpub\wwwroot\. Data is transmitted over an HTTP connection. No certificate verification checks are performed.

"C:\Program Files\Veeam\FastSCP for Azure\Veeam.FastSCP.Copy.exe" -vm:files001.cloudapp.net -source:C:\Users\Administrator\Files\MyApp\ -target:C:\inetpub\wwwroot\ -dir:send -username:files001\john.smith -password:PaSsWoRd -port:51228 -ssl:no -skipcn:yes -skiprc:yes

Table of contents