System Center 2016 – Data Protection Manager (DPM 2016) の DPM 管理シェルは、PowerShell を用いたコマンドライン インタフェースです。
DPM 管理シェルは、デスクトップ上のアイコン、もしくは [スタート メニュー] – [Microsoft System Center 2016] – [DPM 管理シェル] を選択、クリックすることで起動することが可能です。
DPM 2016 の管理を目的として様々なコマンドレットが DPM 管理シェルに用意されていますが、 コマンドレットのヘルプについては、日本語の情報は公開されていません。
このヘルプ情報について、「Get-Help」コマンドレットの -Full オプションを用いて実行した結果を編集、意訳しました。
この記事では、「Rename-DPMRole」コマンドレットについて記載します (他のコマンドレットについては、「System Center 2016 – Data Protection Manager の DPM 管理シェルで使用できるコマンドレットについて」を参照)。
Rename-DPMRole コマンドレット
名前
Rename-DPMRole
概要
DPM ロール名、もしくは説明を変更します。
構文
| Rename-DPMRole [-DpmRole] <DpmRole> [[-Name] <String>] [[-Description] <String>] [-Confirm] [-WhatIf] [<CommonParameters>] |
説明
Rename-DPMRole コマンドレットは、System Center 2016 – Data Protection Manager (DPM) ロール名、もしくは説明を変更します。DPM ロールにより、Microsoft SQL Server のデータベース所有者は、DPM administrator のアシスタントなしでデータベースを回復することが可能です。Set-DPMRole コマンドレットを用いて、変更を保存します。
パラメーター
-Description [<String>]
DPM ロールの説明を指定します。
| 必須 | false |
| 位置 | 3 |
| 既定値 | なし |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-DpmRole <DpmRole>
このコマンドレットで修正する DPM ロールを指定します。DPM ロール オブジェクトを取得するために、Get-DPMRole コマンドレットを用います。
| 必須 | true |
| 位置 | 1 |
| 既定値 | なし |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-Name [<String>]
DPM ロール名を指定します。
| 必須 | false |
| 位置 | 2 |
| 既定値 | なし |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | 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 : ロール名を変更する
$DpmRole = Get-DpmRole -Name "OpsMgrSQL" -Editable Rename-DPMRole -DpmRole $DpmRole -Name "OpsMgrSQL23" Set-DPMRole -DPMRole $DpmRole
最初のコマンドは、 Get-DpmRole コマンドレットを用いてロールを取得、変数 $DpmRole に格納します。このコマンドは、ロールを編集可能にします。
2 番目のコマンドは、$DpmRole に格納されたロール名を変更します。
3 番目のコマンドは、Set-DPMRole コマンドレットを用いて $DpmRole に格納されたロールに変更した内容を保存します。
関連するリンク
- Get-DPMRole
- New-DPMRole
- Remove-DPMRole
- Set-DPMRole
参考
- Data Protection Manager Cmdlets
https://technet.microsoft.com/en-us/library/hh881730(v=sc.30).aspx - Rename-DPMRole
https://technet.microsoft.com/en-us/library/hh881760(v=sc.30).aspx