System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Suspend-SCService コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Suspend-SCService」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Suspend-SCService コマンドレット
名前
Suspend-SCService
概要
サービス内の VMM サービスおよびすべての仮想マシンを一時停止します。
構文
| Suspend-SCService [-Service] <Service> [-JobVariable <String>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-PROTipID <Guid>] [-RunAsynchronously] [-VMMServer <ServerConnection>] [<CommonParameters>] |
説明
Suspend-SCService コマンドレットは、Virtual Machine Manager (VMM) サービス、およびサービス内のすべての仮想マシンを一時停止します。サービスを再開するには、Resume-SCService コマンドレットを用います。
パラメーター
-JobVariable <String>
ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUser <String>
ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUserRole <UserRole>
ユーザー ロールを指定します。ユーザー ロールを取得するには、Get-SCUserRole コマンドレットを用います。このコマンドレットは、このパラメーターで指定するユーザー ロールの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-PROTipID <Guid>
このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<SwitchParameter>]
ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Service <Service>
VMM サービス オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-VMMServer <ServerConnection>
VMM サーバー オブジェクトを取得します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- VirtualMachine[]
- このコマンドレットは、VirtualMachine オブジェクトの配列を返します。
メモ
例
例 1 : 特定のサービスを一時停止する
コマンド
$Service = Get-SCService -Name "Service01" Suspend-SCService -Service $Service
コマンドの説明
最初のコマンドは、サービス オブジェクト “Service01” を取得し、そのオブジェクトを $Service 変数に格納します。
2 番目のコマンドは、$Service でサービスを一時停止し、サービス内のすべての仮想マシンを一時停止します。
関連するリンク
- Get-SCService
- New-SCService
- Read-SCService
- Remove-SCService
- Resume-SCService
- Set-SCService
- Start-SCService
- Stop-SCService
- Update-SCService
参考
- 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 - Suspend-SCService (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/suspend-scservice?view=systemcenter-ps-2016
