System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Remove-SCLibraryServer コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCLibraryServer」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Remove-SCLibraryServer コマンドレット
名前
Remove-SCLibraryServer
概要
VMM からライブラリ サーバーを削除します。
構文
| Remove-SCLibraryServer [-LibraryServer] <LibraryServer> [-Confirm] -Credential <VMMCredential> [-JobVariable <String>] [-PROTipID <Guid>] [-RunAsynchronously] [-WhatIf] [<CommonParameters>] |
説明
Remove-SCLibraryServer コマンドレットは、Virtual Machine Manager (VMM) データベースからライブラリ サーバー オブジェクト (およびそのライブラリ サーバー上のすべてのライブラリ オブジェクト) を削除します。 サーバーのファイル システムに格納されている対応するファイル (.vhd、もしくは .vmdk ファイルなど) を持つライブラリ オブジェクトは、このコマンドレットによってファイル システムから削除されません。
このコマンドレットの操作は、次のとおり :
- このライブラリ サーバーが VMM サーバーでもある場合は、ライブラリ サーバーを削除できないため、ライブラリ サーバーの削除操作は失敗します。
- このコンピューターがライブラリ サーバーとホストの両方である場合、このコマンドレットはライブラリ サーバー機能のみを VMM から削除しますが、コンピューターは引き続きホストとして機能します。
- このコンピューターがライブラリ サーバー (ホスト サーバー、もしくは VMM サーバーではない) のみの場合、ライブラリ サーバーは VMM から削除されます。
このコマンドレットは、成功すると (MarkedForDeletion を $True に設定して) オブジェクトを返します。失敗するとエラー メッセージを返します。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Credential <VMMCredential>
資格情報オブジェクトもしくは一部のコマンドレットで、この操作を実行するアクセス許可を持つアカウントのユーザー名とパスワードを含む Run As アカウント オブジェクトを指定します。もしくは、Restart-SCJob の場合、再起動したタスクを完了するためのアクセス許可が必要となります。
PSCredential オブジェクトに関する詳細な情報は、Get-Help Get-Credential を実行します。
Run As アカウントに関する詳細な情報は、Get-Help New-SCRunAsAccount を実行します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-JobVariable <String>
ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-LibraryServer <LibraryServer>
VMM ライブラリ サーバー オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-PROTipID <Guid>
このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<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 : VMM からライブラリ サーバー オブジェクトを削除する
コマンド
$Creds = Get-Credential $LibServ = Get-SCLibraryServer -VMMServer "VMMServer1.Contoso.com" -ComputerName "LibraryServer01.Contoso.com" Remove-SCLibraryServer -LibraryServer $LibServ -Credential $Creds
コマンドの説明
最初のコマンドは、資格情報を求めるプロンプトを表示します。ダイアログ ボックスが表示されたら、ローカル Administrator アカウント、もしくはライブラリ サーバーの管理者権限を持つドメイン アカウントのユーザー名とパスワードを入力します。
2 番目のコマンドは、”VMMServer1.Contoso.com” 上のライブラリ サーバー オブジェクト “LibraryServer01.Contoso.com” を取得し、$LibServ 変数に格納します。
3 番目のコマンドは、ライブラリ サーバー オブジェクトと、このサーバー上のすべてのライブラリ共有を VMM ライブラリから削除します。この例に示すように、Remove-SCLibraryServer コマンドレットを LibraryServer パラメーターと共に使用すると、1 つのライブラリ サーバー オブジェクトのみをコマンドレットに渡すことが可能です。
例 2 : 名前に特定の文字列を持つ複数のライブラリ サーバー オブジェクトを削除する
コマンド
$Creds = Get-Credential
$LibServers = Get-SCLibraryServer -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -match "LibraryServer" }
$LibServers | Remove-SCLibraryServer -Credential $Creds
コマンドの説明
最初のコマンドは、資格情報を求めるプロンプトを表示します。ダイアログ ボックスが表示されたら、ローカル Administrator アカウント、もしくはライブラリ サーバーの管理者権限を持つドメイン アカウントのユーザー名とパスワードを入力します。
2 番目のコマンドは、”VMMServer01.Contoso.com” からすべてのライブラリ サーバー オブジェクトを文字列 “LibraryServer” を含む名前で取得し、返されたオブジェクトを $LibServers 変数 (オブジェクト配列) に格納します。
3 番目のコマンドは、$LibServers の各ライブラリ サーバー オブジェクトを Remove-SCLibraryServer に渡します。これにより、VMM から各オブジェクトが削除されます。
例 3 : 高可用性ライブラリ サーバーとそのすべてのノードを削除する
コマンド
$Credential = Get-Credential
$Cluster = Find-SCCluster -ComputerName "HAFileServer01.Contoso.com" -Credential $Credential
Remove-LibraryServer -LibraryServer "HAFileServer01.Contoso.com" -Credential $Credential -RunAsynchronously
ForEach ($Node in $Cluster.ClusterNodes) {Remove-LibraryServer -LibraryServer $Node -Credential $Credential-RunAsynchronously}
コマンドの説明
最初のコマンドは Get-Credential を使用してユーザー名とパスワードの入力を促し、資格情報を $Credential に格納します。この操作に必要な資格情報は、ローカル管理者アカウント、もしくはライブラリ サーバーの管理者権限を持つドメイン アカウントのどちらかになります。次のコマンドは、$Credential を使用して、資格情報を必要とする各コマンドレットに資格情報を渡します。
2 番目のコマンドは Find-SCCluster コマンドレットを用いて、”HAFileServer01.Contoso.com” が高可用性ファイル サーバーであることを確認し、$Cluster 変数にクラスター オブジェクトを格納します。
3 番目のコマンドは、高可用性ファイル サーバーを (名前を指定して) VMM からライブラリ サーバーとして削除します。コマンドは RunAsynchronously パラメーターを使用して、このコマンドが完了するまで直ちに (このコマンドが完了する前に) シェルに制御を戻します。最後のコマンドはこのコマンドが完了するまで待つ必要がないため、となります。
最後のコマンドは ForEach ループを使用して、$Cluster.ClusterNodes に格納されている各オブジェクトを Remove-SCLibraryServer コマンドレットに渡します。このコマンドレットは VMM から各ノードを削除します。 のコマンドは、RunAsynchronously パラメーターを使用して、すぐにコントロールをシェルに戻します。ライブラリ サーバーに関する詳細な情報について、Get-Help Add-LibraryServer -Detailed を実行します。Windows PowerShell forEach ループ ステートメントの詳細については、Get-Help about_ForEachを実行してください。
関連するリンク
- Add-SCLibraryServer
- Get-SCLibraryServer
- Set-SCLibraryServer
参考
- System Center 2016 – データセンターの管理 | Microsoft
https://www.microsoft.com/ja-jp/cloud-platform/system-center - VirtualMachineManager | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/?view=systemcenter-ps-2016 - Remove-SCLibraryServer (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/remove-sclibraryserver?view=systemcenter-ps-2016