System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Remove-SCScript コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCScript」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Remove-SCScript コマンドレット
名前
Remove-SCScript
概要
VMM からスクリプト オブジェクトを削除します。
構文
| Remove-SCScript [-Script] <Script> [-Confirm] [-Force] [-JobVariable <String>] [-PROTipID <Guid>] [-RunAsynchronously] [-WhatIf] [<CommonParameters>] |
説明
Remove-SCScript コマンドレットは、Virtual Machine Manager (VMM) ライブラリから複数のスクリプト オブジェクトを削除し、ライブラリ サーバー上の対応するスクリプト ファイルを削除します。
スクリプトがテンプレート、もしくはハードウェア プロファイルに接続されている場合 (および Force パラメーターを使用しない場合)、Virtual Machine Manager (VMM) はスクリプトを含むコンテナーを一覧表示し、スクリプトの削除を確認するメッセージを表示します :
- Yes と応答すると、VMM はスクリプトとそれが接続されているコンテナー間の関連付けを削除し、VMM からスクリプト オブジェクトを削除します。
- No と応答すると、操作はキャンセルされます。
このコマンドレットは、成功すると (MarkedForDeletion を $True に設定して) オブジェクトを返します。失敗するとエラー メッセージを返します。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Force [<SwitchParameter>]
ユーザーの確認を求めずにコマンドを強制実行します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-JobVariable <String>
ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-PROTipID <Guid>
このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<SwitchParameter>]
ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Script <Script>
VMM スクリプト オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-WhatIf [<SwitchParameter>]
コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
メモ
例
例 1 : スクリプト オブジェクトを削除し、対応するスクリプト ファイルを削除する
コマンド
$Scripts = @(Get-SCScript -VMMServer "VMMServer01.Contoso.com" | where { $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" -and $_.Name -eq "AddHost.ps1"} )
$Scripts.Count
$Scripts | select Name,SharePath | Format-List
Remove-SCScript -Script $Scripts[0] -Force
コマンドの説明
最初のコマンドは、”VMMServer01.Contoso.com” 上の VMM ライブラリ “LibraryServer01.Contoso.com” からスクリプト オブジェクト “AddHost.ps1” を取得し、そのオブジェクトを $Scripts 配列に格納します。指定されたライブラリ サーバー上に複数のスクリプト コンテナーが存在する場合、同じ名前の複数のファイルが存在する可能性があります。
2 番目のコマンドは、$Scrips にあるスクリプトの数を計算し、その結果を表示します。
3 番目のコマンドは、$Scripts の各スクリプト オブジェクトを Select-Object コマンドレットに渡します。Select-Object コマンドレットは、配列内の各スクリプト名と共有パスを選択します。このコマンドは、これらの結果を Format-List コマンドレットに渡して、各スクリプト名とその共有パスを表示します。
最後のコマンドは、$Scripts 配列の最初のオブジェクトを削除し、Force パラメーターを使用してスクリプト オブジェクトが VMM データベースから削除され、対応するスクリプト ファイルがライブラリ サーバー上のファイル システムから削除されるようにします。
例 2 : ライブラリから複数のスクリプトを削除する
コマンド
$Scripts = Get-SCScript -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -match "Sysprep" }
$Scripts | Remove-SCScript -Confirm
コマンドの説明
最初のコマンドは、”VMMServer01.Contoso.com” の文字列 “Sysprep” を含むすべてのスクリプト オブジェクトを取得し、これらのオブジェクトを $Scripts という配列に格納します。
2 番目のコマンドは、$Scripts 内の各スクリプト オブジェクトを Remove-SCScript に渡します。Remove-SCScript は、ライブラリから各スクリプト オブジェクトを削除し、対応するスクリプト ファイルをライブラリ サーバー上のファイル システムから削除します。
Confirm パラメーターは、これらのスクリプトを削除するかどうかを確認するメッセージを表示します。一度にすべてのスクリプトの削除を確認したり、各スクリプトの削除を 1 つずつ確認したりすることが可能です。
関連するリンク
- Get-SCScript
- Set-SCScript
参考
- 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-SCScript (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/remove-scscript?view=systemcenter-ps-2016