Upload File

Applies To: System Center 2012 R2 Orchestrator, System Center 2012 SP1 - Orchestrator

The Upload File activity is used in a runbook to upload files to a FTP server.

This activity publishes all of the data from the required and optional properties into published data.

The following tables list the required and optional properties and published data for this activity.

Upload File Required Properties

Element

Description

Valid Values

File Mask

The path and file mask of the file to upload. The asterisk (*) will match any number of characters. The question mark (?) will match any one character.

String

Remote Path

The remote destination path where the files are uploaded.

String

Recursive

Determines if folders contained in the subfolders will be copied if matching file mask.

True

False

Replace Existing Files (SFTP)

Determines if existing files in the Remote Path should be replaced. Only compatible with SFTP.

True

False

Representation Type

Determines how data is transferred.

Ascii

Binary

ModeZ

Enables Mode Z data decompression.

True

False

Error Action (FTP)

Determines the action to take when an error occurs transferring files. Only compatible with FTP.

Abort - Activity should fail.

Ignore - Skip the file and continue with the next.

Retry - Attempt to retransfer the file.

Abort

Retry

Ignore

Recreate Folder Structure (FTP)

Determines if the directory structure should be recreated on the local machine. Only compatible with FTP.

True

False

Upload File Optional Properties

Element

Description

Valid Values

Retry Count (FTP)

The number of times to retry when Error Action is set to Retry.

Integer

Upload File Published Data

Element

Description

Valid Values

Count

Number of files uploaded.

Integer

Error Action (FTP)

Action to take when an error occurs transferring files.

Abort

Retry

Ignore

File Mask

The path and file mask of the file to upload.

String

File Name

The file name of each file uploaded.

String

File Path

The file path for each file uploaded.

String

Remote Path

The remote destination path where the files are copied.

String

ModeZ

Mode Z data decompression.

True

False

Recreate Folder Structure (FTP)

Directory structure should be recreated on the local machine.

True

False

Recursive

Folders contained in the subfolders will be copied if matching file mask.

True

False

Replace Existing Files (SFTP)

Existing files in the Local Path should be replaced.

True

False

Representation Type

Data transfer type.

Ascii

Binary

Retry Count (FTP)

The number of times to retry when Error Action is set to Retry.

Integer

Certificate Path (FTP)

The file path for the certificate.

String

Connection Type

The FTP connection type used to connect to the FTP server.

Normal

ImplicitSslTls

NormalWithExplicitSsl30Authentication

NormalWithExplicitTlsSsl31Authentication

SFTP

HTTP Proxy Port (FTP)

The port used to connect to the HTTP proxy server.

Integer

HTTP Proxy Server (FTP)

The IP address or computer name of the HTTP proxy server.

String

HTTP Proxy Username (FTP)

The user name used to connect to the HTTP proxy server.

String

Log

Detailed FTP log.

String

Port

The port used to connect to the FTP server.

Integer

Server

The IP address or computer name of the FTP server.

String

Timeout

The time to wait before a FTP operation times out.

Integer

Transfer Type (FTP)

The transfer type used by FTP.

Passive

Active

Username

The user name used to connect to the FTP server.

String

See Also

Other Resources

Using Runbooks in System Center 2012 - Orchestrator