PowerShell の構文とパラメータ

構文 1

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

構文 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>]

構文 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>]

構文 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>]

説明

パラメータ

-Command <String>

使用されるコマンドを指定します。現在、以下の文字列がサポートされています。

必要? true

位置named

デフォルト値

パイプライン入力を許可false

ワイルドカード文字を許可false

-Password <System.Security.SecureString>

パスワード ファイルの作成に使用するパスワードを指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

ワイルドカード文字を許可false

-UDPConsoleServerName <String>

接続先の UDP サーバ（コンソールがインストールされているサーバ）の DNS 名を指定します。この値が指定されない場合、cmdlet では、デフォルト値（ローカル マシンの DNS 名）を使用します。

必要? false

位置named

デフォルト値 $env:COMPUTERNAME

パイプライン入力を許可false

ワイルドカード文字を許可false

-UDPConsolePort <int>

接続に使用するポート番号を指定します。この値が指定されない場合、cmdlet ではデフォルト値 8015 を使用します。

必要? false

位置named

デフォルト値 8015

パイプライン入力を許可false

ワイルドカード文字を許可false

-UDPConsoleProtocol <String>

接続に使用するサーバに対するプロトコルを指定します。プロトコルは、http または https のいずれかです。この値が指定されない場合、cmdlet では、デフォルト値 http を使用します。

必要? false

位置named

デフォルト値 http

パイプライン入力を許可false

ワイルドカード文字を許可false

-UDPConsoleUserName <String>

UDP サーバへの接続に使用するユーザ名を指定します。ユーザ名が指定されない場合、cmdlet では、現在システムにログインするために使用されているユーザ名を使用します。

必要? false

位置named

デフォルト値 $env:UserName

パイプライン入力を許可false

-UDPConsolePassword <System.Security.SecureString>

UDP サーバへの接続に使用するパスワードを指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-PasswordFile <String>

パスワード ファイルを生成することを指定します。

必要? true

位置named

デフォルト値

パイプライン入力を許可false

ワイルドカード文字を許可false

-UDPConsolePasswordFile <String>

UDP サーバへの接続に使用する UDP パスワード ファイルを指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-UDPAgentServerName <String>

リストアのために接続する UDP エージェント サーバの DNS 名を指定します。

必要? false

位置named

デフォルト値 $env:COMPUTERNAME

パイプライン入力を許可false

-UDPAgentProtocol <String>

UDP エージェント サーバへの接続に使用するインターネット プロトコルを指定します。http または https のいずれかです。この値が指定されない場合、cmdlet では、デフォルト値 http を使用します。

必要? false

位置named

デフォルト値 http

パイプライン入力を許可false

ワイルドカード文字を許可false

-UDPAgentPort <int>

UDP エージェント サーバへの接続に使用するポート番号を指定します。この値が指定されない場合、cmdlet ではデフォルト値 8014 を使用します。

必要? false

位置named

デフォルト値 8014

パイプライン入力を許可false

ワイルドカード文字を許可false

-UDPAgentUserName <String>

UDP エージェント サーバへの接続に使用するユーザ名を指定します。ユーザ名が指定されない場合、cmdlet では、現在システムにログインするために使用されているユーザ名を使用します。

位置named

デフォルト値 $env:UserName

パイプライン入力を許可false

ワイルドカード文字を許可false

-UDPAgentPassword <System.Security.SecureString>

UDP エージェント サーバへの接続に使用するパスワードを指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-UDPAgentPasswordFile <String>

UDP エージェント サーバへの接続に使用する UDP エージェント パスワード ファイルを指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-UDPAgentDomainName <String>

指定された UDP エージェントのユーザが存在するドメイン名を指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-NodeName <String>

バックアップするノードの名前を指定します。

必要? true

位置named

デフォルト値

パイプライン入力を許可false

ワイルドカード文字を許可false

-RestoreFilePath <String>

リストアするファイルを指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-RestoreDirectoryPath <String>

リストアするディレクトリを指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-BackupSessionNumber <int>

リストア ジョブに使用するセッション番号を指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-VmName <String>

そのバックアップ セッションからファイルまたはディレクトリをリストアする仮想マシンのホスト名を指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-RestoreDestination <String>

ファイルがリストアされるディレクトリ パスを指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-RestoreDestinationUserName <String>

データをリストアするデスティネーション マシンのユーザ名を指定します。ユーザ名は、デスティネーション マシンにログインできるユーザの名前です。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-RestoreDestinationPassword <System.Security.SecureString>

デスティネーション マシンにログインするために使用するパスワードを指定します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-CreateRootFolder <String>

キャプチャされたバックアップ イメージ内にルート ディレクトリ構造が存在する場合、Arcserve UDP によって、リストア先のパス上に同じルート ディレクトリ構造が再作成されます。このオプションが選択されていない場合、ファイルまたはフォルダはデスティネーション フォルダに直接リストアされます。以下のいずれかの文字列を使用できます。

必要? false

位置named

デフォルト値 False

パイプライン入力を許可false

-ChangeFileName <String>

ファイル名がすでに存在する場合、新規ファイルを作成します。このオプションを選択すると、ファイル名は変更せず、拡張子を変更してソース ファイルをデスティネーションにコピーします。その後、データは新規ファイルにリストアされます。以下のいずれかの文字列を使用できます。

必要? false

位置named

デフォルト値 False

パイプライン入力を許可false

-ReplaceActiveFilesFlag <String>

再起動の後にアクティブなファイルを置換します。リストア試行時に、既存ファイルが使用中またはアクセス中であることが Arcserve UDP エージェント（Windows） によって検出された場合、ファイルはすぐには置換されません。問題の発生を避けるために、次回マシンが再起動されるまで、アクティブ ファイルの置換は延期されます（リストアはすぐに実行されますが、アクティブ ファイルの置換は次の再起動中に完了します）。このオプションは、OverwriteExistingFiles パラメータが True の場合のみ使用できます。以下のいずれかの文字列を使用できます。

必要? false

位置named

デフォルト値 False

パイプライン入力を許可false

-OverwriteExistingFiles <String>

リストア先にある既存ファイルを上書き（置換）します。すべてのオブジェクトが、コンピュータ上に存在しているかどうかに関わらずバックアップ ファイルからリストアされます。以下のいずれかの文字列を使用できます。

必要? false

位置named

デフォルト値 False

パイプライン入力を許可false

-UDPConsoleDomainName <String>

指定されたユーザが存在するドメインの名前を指定します。この値が指定されない場合、cmdlet では、ローカル マシンのドメイン名を使用するか、ドメイン内に存在しない場合はローカル マシンの DNS 名を使用します。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

-PlanName <String>

バックアップ ジョブ設定を定義するプラン名を指定します。

必要? true

位置named

デフォルト値

パイプライン入力を許可false

-BackupJobType <String>

バックアップ ジョブの種類を指定します。Full （フル バックアップ）、Incr （増分バックアップ）、または Rsyn （再同期バックアップ）のいずれかの値を使用できます。以下の文字列がサポートされています。

必要? true

位置named

パイプライン入力を許可false

-JobDescription <String>

バックアップ ジョブの説明を指定します。

必要? true

位置named

デフォルト値 PowerCLIJo

パイプライン入力を許可false

-RecoverVmName <String>

復旧する仮想マシンのホスト名を指定します。

必要? true

位置named

デフォルト値

パイプライン入力を許可false

-OverwriteExistingVM <String>

値が true の場合、リストア ジョブが既存の仮想マシンを上書きことを指定します。デフォルト値は false です。以下のいずれかの文字列を使用できます。

必要? false

位置named

デフォルト値 False

パイプライン入力を許可false

-PoweronVM <String>

値が true の場合、仮想マシンの復旧後に電源がオンになることを指定します。デフォルト値は false です。以下のいずれかの文字列を使用できます。

必要? false

位置named

デフォルト値 False

パイプライン入力を許可false

-waitJobFinish <{true|false} String>

値が true の場合、バックアップ ジョブが完了するまで、コマンドが次の手順を待機することを指定します。デフォルト値は false です。以下のいずれかの文字列を使用できます。

必要? false

位置named

デフォルト値 False

パイプライン入力を許可false

-timeOut <int>

バックアップ ジョブが完了するまで待機する最大の時間（秒数）を指定します。

必要? false

位置named

デフォルト値 600

パイプライン入力を許可false

-jobType <String>

別のノード タイプのバックアップ ジョブ タイプを指定します。デフォルト値は agentbase です。以下のいずれかの文字列を使用します。

必要? false

位置named

デフォルト値 agentbase

パイプライン入力を許可false

-backupScheduleType <String>

スケジュール バックアップ ジョブを指定し、指定したスケジュール バックアップ ジョブをただちにサブミットして 1 回だけ実行します。以下の文字列がサポートされています。

必要? false

位置named

デフォルト値

パイプライン入力を許可false

<CommonParameters>

この cmdlet では、共通のパラメータをサポートします。たとえば、Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer、OutVariable などです。詳細については、about_CommonParameters を参照してください。