System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Get-SCVMMServer コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Get-SCVMMServer」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Get-SCVMMServer コマンドレット
名前
Get-SCVMMServer
概要
接続がまだ存在しない場合に VVM 管理サーバーに接続、もしくは別の VMM 管理サーバーに接続します。
構文
| Get-SCVMMServer [-ComputerName] <String> [-AllowJobGC] [-ConnectAs {Administrator | DelegatedAdmin | TenantAdmin | SelfServiceUser | ReadOnlyAdmin}] [-Credential <PSCredential>] [-ForOnBehalfOf] [-RetainDeletedObjects] [-RetainObjectCache] [-SetAsDefault] [-TCPPort <Int32>] [-UserRoleName <String>] [<CommonParameters>] |
説明
Get-SCVMMServer コマンドレットは、接続が存在しない場合は Virtual Machine Manager (VMM) 管理サーバーに接続し、VMM データベースからサーバー オブジェクトを取得します。VMM サーバーへの接続に使用される既定のポートは、TCP ポート 8100 です。
ユーザー インターフェイス (UI) を使用して VMM 管理サーバーへの接続を作成した場合、VMM コマンド シェルを開くと、そのコマンドシェルは自動的に同じ VMM 管理サーバーに接続します。以前に UI を使用して VMM 管理サーバーに接続していない場合は、Get-SCVMMServer を使用して接続を確立する必要があります。VMM コマンド シェルのみを使用して VMM 管理サーバーに接続する場合、SetAsDefault パラメーターを使用してセッション間セッションを維持するか、新しい VMM コマンド シェル セッションを開くたびに VMM サーバーに再接続する必要があります。
Get-VMMServer を用いて、別の VMM 管理サーバーに接続することも可能です。
VMM 管理サーバーへの接続が確立された後、VMM コマンド シェルで実行されるそれ以降のすべてのコマンドは、その VMM コマンドシェルウィンドウを閉じるまで、VMM サーバー オブジェクトが必要な既存の接続を自動的に使用します。
VMM 管理サーバー上で実行されている VMM サービスは、VMM データベースをサポートしています。このデータベースは、Microsoft SQL Server に VMM 管理サーバー、もしくは SQL Server を実行する別のサーバーに格納されます。
VMM サービスを使用すると、(仮想マシンをホストする) ホスト サーバー、(VMM ライブラリ リソースを格納する) ライブラリ サーバー、およびホストに展開された、もしくはライブラリに格納されている仮想マシンなどの仮想環境を管理することが可能です。
VMM 管理サーバーへの接続の詳細については、Get-Help about_VMM_2016_Connecting_to_the_VMM_Server を実行します。
パラメーター
-AllowJobGC [<SwitchParameter>]
ジョブにガベージ コレクションが許可されている場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-ComputerName <String>
VMM がネットワーク上で一意に識別できるコンピューター名を指定します。このパラメーターで利用可能な値は、次のとおりです :
- FQDN
- IPv4 もしくは IPv6 アドレス
- NetBIOS 名
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-ConnectAs <Profile>
VMM コマンド シェルから VMM 管理サーバーに接続する際、ユーザーが複数のロールのメンバーである場合に、使用する VMM ユーザーの役割を指定します。このパラメーターで利用可能な値は、次のとおり :
- Administrator
- DelegatedAdmin
- ReadOnlyAdmin
- SelfServiceUser
VMM 管理者はすべての VMM オブジェクトの管理が可能です。委任された管理者、およびセルフサービス ユーザーは、ユーザー役割の範囲内にあるオブジェクトにのみアクセスして変更可能です。読み取り専用管理者は、既存のオブジェクトのプロパティのみを表示可能です。新しいオブジェクトを作成したり、既存のオブジェクトのプロパティを変更することはできません。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Credential <PSCredential>
資格情報オブジェクトもしくは一部のコマンドレットで、この操作を実行するアクセス許可を持つアカウントのユーザー名とパスワードを含む Run As アカウント オブジェクトを指定します。もしくは、Restart-SCJob の場合、再起動したタスクを完了するためのアクセス許可が必要となります。
PSCredential オブジェクトに関する詳細な情報は、Get-Help Get-Credential を実行します。
Run As アカウントに関する詳細な情報は、Get-Help New-SCRunAsAccount を実行します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-ForOnBehalfOf [<SwitchParameter>]
VMM コマンドレットに対して、管理者が OnBehalfOf パラメーターを使用する場合に指定します。このパラメーターは、主に VMM への Service Provider Foundation 接続に用いられます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RetainDeletedObjects [<SwitchParameter>]
削除対象のキャッシュ内のオブジェクトを保持する場合に指定します。このパラメーターは、VMM コマンド シェル上にユーザー インターフェイスを作成する場合にのみ必要となります。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RetainObjectCache [<SwitchParameter>]
キャッシュ内のオブジェクトがメモリ内に残り、ガーベジ コレクションによって再利用しない場合に指定します。VMM コマンド シェル上にユーザー インターフェイスを作成する場合、このパラメーターが必要な場合があります。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-SetAsDefault [<SwitchParameter>]
$True に設定する場合、VMM コマンド シェルがこのセッションの指定された VMM 管理サーバーに接続し、今後のセッションでその接続を保持します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-TCPPort <Int32>
TCP ポートを表す数値を指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-UserRoleName <String>
ユーザー ロール名を指定します。ユーザー ロールの種類は、次のとおり :
- Delegated Administrator
- Read-Only Administrator
- Self-Service User
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
メモ
例
例 1 : VMM サーバーに接続する
コマンド
Get-SCVMMServer -ComputerName "VMMServer01.Contoso.com"
コマンドの説明
このコマンドは、VMM サーバー “VMMServer01.Contoso.com” に接続し、VMM データベースからサーバー オブジェクトを取得します。
例 2 : 特定のポートを経由して VMM サーバーに接続する
コマンド
Get-SCVMMServer -ComputerName "VMMServer01.Contoso.com" -TCPPort 8100
コマンドの説明
このコマンドは、TCP ポート 8100 を経由して VMM サーバー “VMMServer01.Contoso.com” に接続します。
例 3 : VMM サーバーに接続し、.NET オブジェクトの種類、メソッドおよびプロパティ情報を取得する
コマンド
$VMMServer = Get-SCVMMServer -ComputerName "VMMServer01.Contoso.com" $VMMServer | Get-Member $VMMServer | Get-Member | Format-List
コマンドの説明
最初のコマンドは、VMM サーバー オブジェクト “VMMServer01.Contoso.com” を取得し、そのオブジェクトを $VMMServer 変数に格納します。
2 番目のコマンドは、$VMMServer に格納されている VMM サーバー オブジェクトを Get-Member コマンドレットに渡し、Get-Member コマンドレットは次のものを取得して表示します。
- TypeName : VMM サーバー オブジェクトの .NET の種類の名前、Microsoft.SystemCenter.VirtualMachineManager.Remoting.ServerConnection
- MemberType : このオブジェクト型に関連付けられた各イベント、メソッド、およびプロパティ名と定義を含むリスト
3 番目のコマンドは、2 番目のコマンドと同じ情報を取得して表示します。ただし、出力を Format-List コマンドレットにパイプし、VMM サーバー オブジェクトの各メソッドおよび各プロパティの完全な定義を表示します。
例 4 : 別のユーザー ロールを使用して別の VMM サーバーに接続する
コマンド
Get-SCVMMServer -ComputerName "VMMServer02.Contoso.com" -ConnectAs "DelegatedAdmin"
コマンドの説明
このコマンドは、”DelegatedAdmin” ユーザーの役割を用いて VMMサーバー “VMMServer02.Contoso.com” に接続します。
関連するリンク
- Backup-SCVMMServer
- Set-SCVMMServer
参考
- 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 - Get-SCVMMServer (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/get-scvmmserver?view=systemcenter-ps-2016