System Center 2016 – Data Protection Manager (DPM 2016) の DPM 管理シェルは、PowerShell を用いたコマンドライン インタフェースです。
DPM 管理シェルは、デスクトップ上のアイコン、もしくは [スタート メニュー] – [Microsoft System Center 2016] – [DPM 管理シェル] を選択、クリックすることで起動することが可能です。
DPM 2016 の管理を目的として様々なコマンドレットが DPM 管理シェルに用意されていますが、 コマンドレットのヘルプについては、日本語の情報は公開されていません。
このヘルプ情報について、「Get-Help」コマンドレットの -Full オプションを用いて実行した結果を編集、意訳しました。
この記事では、「Lock-DPMLibraryDoor」コマンドレットについて記載します (他のコマンドレットについては、「System Center 2016 – Data Protection Manager の DPM 管理シェルで使用できるコマンドレットについて」を参照)。
Lock-DPMLibraryDoor コマンドレット
名前
Lock-DPMLibraryDoor
概要
DPM ライブラリのドアをロックします。
構文
| Lock-DPMLibraryDoor [-DPMLibrary] <Library> [-Async] [-DoorAccessJobStateChangeEventHandler <DoorAccessJobStateChangeEventHandler>] [-Confirm] [-WhatIf] [<CommonParameters>] |
説明
Lock-DPMLibraryDoor コマンドレットは、System Center 2016 – Data Protection Manager (DPM) ライブラリのドアをロックします。
パラメーター
-Async [<SwitchParameter>]
コマンドが非同期で実行する場合に指定します。コマンドが非同期で実行される場合、ジョブ完了までに時間を要する場合でも、コマンド プロンプトはすぐに返ります。
| 必須 | false |
| 位置 | named |
| 既定値 | なし |
| パイプライン入力を許可する | true (ByPropertyName) |
| ワイルドカード文字を許可する | false |
-DoorAccessJobStateChangeEventHandler [<DoorAccessJobStateChangeEventHandler>]
特定のドア アクセス イベント用のイベント ハンドラーを指定します。Windows PowerShell で実行する GUI を更新するためにこのパラメーターは使用できますが、Windows PowerShell コンソールでは使用できません。
| 必須 | false |
| 位置 | named |
| 既定値 | なし |
| パイプライン入力を許可する | true (ByPropertyName) |
| ワイルドカード文字を許可する | false |
-DPMLibrary <Library>
このコマンドがロックする DPM ライブラリを指定します。DPM ライブラリ オブジェクトを取得するために、Get-DPMLibrary コマンドレットを用います。
| 必須 | true |
| 位置 | 1 |
| 既定値 | なし |
| パイプライン入力を許可する | true (ByValue, ByPropertyName) |
| ワイルドカード文字を許可する | false |
-Confirm [<SwitchParameter>]
コマンドレットを実行する前に確認のプロンプトを表示します。
| 必須 | false |
| 位置 | named |
| 既定値 | false |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-WhatIf [<SwitchParameter>]
コマンドレットを実行する場合、何が起きるかを表示します。コマンドレットは実行されません。
| 必須 | false |
| 位置 | named |
| 既定値 | false |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-WarningAction、-WarningVariable、-OutBuffer、-PipelineVariable、および -OutVariable。詳細については、about_CommonParameters を参照してください。
入力
入力の種類は、コマンドレットにパイプ可能なオブジェクトの種類です。
出力
出力の種類は、コマンドレットが発行するオブジェクトの種類です。
例
例 1 : ライブラリのドアをロックする
$DpmLibrary = Get-DPMLibrary -DPMServerName "DPMServer07" Lock-DPMLibraryDoor -DPMLibrary $DpmLibrary[0]
最初のコマンドは、サーバー「DPMServer07」に関連付けられたライブラリを取得、変数 $DpmLibrary に格納します。
2 番目のコマンドは、$DpmLibrary に格納された最初のライブラリ オブジェクトのライブラリ ドアをロックします。この DPM サーバーは、1つ 以上のライブラリを持ちます。そのため、このコマンドは 標準 PowerShell 配列構文を用いて $DpmLibrary 配列の最初のメンバーを指定しています。
関連するリンク
- Get-DPMLibrary
- Unlock-DPMLibraryDoor
参考
- Data Protection Manager Cmdlets
https://technet.microsoft.com/en-us/library/hh881730(v=sc.30).aspx - Lock-DPMLibraryDoor
https://technet.microsoft.com/en-us/library/hh881765(v=sc.30).aspx
