PowerShell Syntax and Parameters

SYNTAX 1

UDPPowerCLI.ps1 -Command <CreatePswFile> -Password <System.Security.SecureString> -PasswordFile <string> [<CommonParameters>]

SYNTAX 2

UDPPowerCLI.ps1 -Command <Backup> [-UDPConsoleServerName <String>] [-UDPConsoleProtocol <{http|https}>] [-UDPConsolePort <int>] [-UDPConsoleUserName [<String>]] [-UDPConsolePassword <System.Security.SecureString>] [-UDPConsolePasswordFile <String>] [-UDPConsoleDomainName <String>] -planName <String> -nodeName <String> [-backupJobType <String>] [-jobDescription <String>] [-waitJobFinish <String String>] [-timeOut <int>] [-jobType <{ agentbase|agentless|uncpath} String>] [-backupScheduleType <String>] [<CommonParameters>]

SYNTAX 3

UDPPowerCLI.ps1 -Command <Restore> [-UDPConsoleServerName <String>] [-UDPConsoleProtocol <String>] [-UDPConsolePort <int>] [-UDPConsoleUserName <String>] [-UDPConsolePassword <System.Security.SecureString>] [-UDPConsolePasswordFile <String>] [-UDPConsoleDomainName <String>] [-UDPAgentServerName <String>] [-UDPAgentProtocol <String>] [-UDPAgentPort <int>] [-UDPAgentUserName <String>] [-UDPAgentPassword <System.Security.SecureString>] [-UDPAgentPasswordFile <String>] [-UDPAgentDomainName <String>] [-RestoreDirectoryPath <String>] [-RestoreFilePath <String>] [-BackupSessionNumber <int>] [-VmName <String>] -RestoreDestination <String> [-RestoreDestinationUserName <String>] [-RestoreDestinationPassword <System.Security.SecureString>] [-CreateRootFolder <String>] [-ChangeFileName <String>] [-ReplaceActiveFilesFlag <String>] [-OverwriteExistFiles <String>] [<CommonParameters>]

SYNTAX 4

UDPPowerCLI.ps1 -command <RecoverVM> [-UDPConsoleServerName <String>] [-UDPConsoleProtocol <String>] [-UDPConsolePort <int>] [-UDPConsoleUserName <String>] [-UDPConsolePassword <System.Security.SecureString>] [-UDPConsolePasswordFile <String>] [-UDPConsoleDomainName <String>] [-UDPAgentServerName <String>] [-UDPAgentProtocol <String>] [-UDPAgentPort <int>] [-UDPAgentUserName <String>] [-UDPAgentPassword <System.Security.SecureString>] [-UDPAgentDomainName <String>] [-UDPAgentPasswordFile <String>] [-BackupSessionNumber <int>] -RecoverVmName <String> [-OverwriteExistingVM <String>] [-PoweronVM <String>] [<CommonParameters>]

DESCRIPTION

PARAMETERS

-Command <String>

Specifies the command that is used. Currently, the following strings are supported:

Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-Password <System.Security.SecureString>

Specifies the password you want to use for creating the password file.

Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-UDPConsoleServerName <String>

Specifies the DNS name of the UDP server (the server where you have installed the Console) to which you want to connect. If this value is not specified, then the cmdlet uses the default value, the DNS name of the local machine.

Required? false

Position? named

Default value $env:COMPUTERNAME

Accept pipeline input? false

Accept wildcard characters? false

-UDPConsolePort <int>

Specifies the port number you want to use for the connection. If this value is not specified, then the cmdlet uses the default value, 8015.

Required? false

Position? named

Default value 8015

Accept pipeline input? false

Accept wildcard characters? false

-UDPConsoleProtocol <String>

Specifies the protocol on the server that you want to use for the connection. The protocol can be either http or https. If this value is not specified, then the cmdlet uses the default value, http.

Required? false

Position? named

Default value http

Accept pipeline input? false

Accept wildcard characters? false

-UDPConsoleUserName <String>

Specifies the user name you want to use for connecting to the UDP server. If the user name is not specified, then the cmdlet uses the user name currently used to log into the system.

Required? false

Position? named

Default value $env:UserName

Accept pipeline input? false

-UDPConsolePassword <System.Security.SecureString>

Specifies the password you want to use for connecting to the UDP server.

Required? false

Position? named

Default value

Accept pipeline input? false

-PasswordFile <String>

Specifies to generate the password file.

Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-UDPConsolePasswordFile <String>

Specifies the UDP password file you want to use for connecting to the UDP server.

Required? false

Position? named

Default value

Accept pipeline input? false

-UDPAgentServerName <String>

Specifies the DNS name of the UDP agent server to which you want to connect for restore.

Required? false

Position? named

Default value $env:COMPUTERNAME

Accept pipeline input? false

-UDPAgentProtocol <String>

Specifies the internet protocol that you want to use to connect to the UDP agent server. It can be either http or https. If this value is not specified, then the cmdlet uses the default value, http.

Required? false

Position? named

Default value http

Accept pipeline input? false

Accept wildcard characters? false

-UDPAgentPort <int>

Specifies the port number that you want to use to connect to the UDP agent server. If this value is not specified, then the cmdlet uses the default value, 8014.

Required? false

Position? named

Default value 8014

Accept pipeline input? false

Accept wildcard characters? false

-UDPAgentUserName <String>

Specifies the user name that you want to use to connect to the UDP agent server. If the user name is not specified, then the cmdlet uses the user name currently used to log into the system.

Position? named

Default value $env:UserName

Accept pipeline input? false

Accept wildcard characters? false

-UDPAgentPassword <System.Security.SecureString>

Specifies the password that you want to use to connect to the UDP agent server.

Required? false

Position? named

Default value

Accept pipeline input? false

-UDPAgentPasswordFile <String>

Specifies the UDP agent password file that you want to use to connect to the UDP agent server.

Required? false

Position? named

Default value

Accept pipeline input? false

-UDPAgentDomainName <String>

Specifies the domain name where the specified UDP agent user is located.

Required? false

Position? named

Default value

Accept pipeline input? false

-NodeName <String>

Specifies the name of node that you want to back up.

Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-RestoreFilePath <String>

Specifies the file that you want to restore.

Required? false

Position? named

Default value

Accept pipeline input? false

-RestoreDirectoryPath <String>

Specifies the directory that you want to restore.

Required? false

Position? named

Default value

Accept pipeline input? false

-BackupSessionNumber <int>

Specifies the session number to use for the restore job.

Required? false

Position? named

Default value

Accept pipeline input? false

-VmName <String>

Specifies the host name of a virtual machine for restoring file or directory from its backup session.

Required? false

Position? named

Default value

Accept pipeline input? false

-RestoreDestination <String>

Specifies the directory path where the files will be restored.

Required? false

Position? named

Default value

Accept pipeline input? false

-RestoreDestinationUserName <String>

Specifies the user name of the destination machine where you want to restore data. The user name belong to the user who can log in to the destination machine.

Required? false

Position? named

Default value

Accept pipeline input? false

-RestoreDestinationPassword <System.Security.SecureString>

Specifies the password that you will use to log into the destination machine.

Required? false

Position? named

Default value

Accept pipeline input? false

-CreateRootFolder <String>

Specifies that if a root directory structure exists in the captured backup image, Arcserve UDP recreates that same root directory structure on the restore destination path. When this option is not selected, the file or folder is restored directly to the destination folder. You can use any one of the following strings:

Required? false

Position? named

Default value False

Accept pipeline input? false

-ChangeFileName <String>

Creates a new file if the file name already exists. Selecting this option copies the source file to the destination with the same filename but a different extension. Data is then restored to the new file. You can use any one of the following strings:

Required? false

Position? named

Default value False

Accept pipeline input? false

-ReplaceActiveFilesFlag <String>

Replaces any active files after reboot. If during the restore attempt Arcserve UDP Agent (Windows) discovers that the existing file is currently in use or being accessed, it will not immediately replace that file, but instead, to avoid any problems, will delay the replacement of the active files until the next time the machine is rebooted. (The restore occurs immediately, but the replacement of any active files is done during the next reboot). This option is only available when the OverwriteExistingFiles parameter is True. You can use any one of the following strings:

Required? false

Position? named

Default value False

Accept pipeline input? false

-OverwriteExistingFiles <String>

Overwrites (replaces) any existing files, which are at the restore destination. All objects are restored from the backup files regardless of their current presence on your computer. You can use any one of the following strings:

Required? false

Position? named

Default value False

Accept pipeline input? false

-UDPConsoleDomainName <String>

Specifies name of domain where the specified user is located. If this value is not specified, then the cmdlet uses the domain name of local machine; or the DNS name of local machine if it is not in a domain.

Required? false

Position? named

Default value

Accept pipeline input? false

-PlanName <String>

Specifies the plan name that defines the backup job setting.

Required? true

Position? named

Default value

Accept pipeline input? false

-BackupJobType <String>

Specifies the type of the backup job. One of the following values can be used: Full (indicates a Full backup), Incr (indicates an Incremental backup), or Rsyn (indicates a Resync backup). The following strings are supported:

Required? true

Position? named

Accept pipeline input? false

-JobDescription <String>

Specifies the description for the backup job.

Required? true

Position? named

Default value PowerCLIJo

Accept pipeline input? false

-RecoverVmName <String>

Specifies the host name of the virtual machine that you want to recover.

Required? true

Position? named

Default value

Accept pipeline input? false

-OverwriteExistingVM <String>

Specifies that if the value is true, the restore job overwrites the existing virtual machine. The default value is false. You can use any one of the following strings:

Required? false

Position? named

Default value False

Accept pipeline input? false

-PoweronVM <String>

Specifies that if the value is true, the virtual machine is powered on after it is recovered. The default value is false. You can use any one of the following strings:

Required? false

Position? named

Default value False

Accept pipeline input? false

-waitJobFinish <{true|false} String>

Specifies that if the value is true, the command waits for further instructions until the backup job is complete. The default value is false. You can use any one of the following strings:

Required? false

Position? named

Default value False

Accept pipeline input? false

-timeOut <int>

Specifies the maximum waiting time (in seconds) for the backup job to complete.

Required? false

Position? named

Default value 600

Accept pipeline input? false

-jobType <String>

Specifies the backup job type for different node type. The default value is agentbase. Use any one of the following strings:

Required? false

Position? named

Default value agentbase

Accept pipeline input? false

-backupScheduleType <String>

Specifies schedule backup job, submits the specified schedule backup job immediately, and runs only once. The following strings are supported:

Required? false

Position? named

Default value

Accept pipeline input? false

<CommonParameters>

This cmdlet supports the common parameters such as Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.