System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Get-SCCustomPropertyValue コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Get-SCCustomPropertyValue」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Get-SCCustomPropertyValue コマンドレット
名前
Get-SCCustomPropertyValue
概要
カスタム プロパティ値オブジェクトを取得します。
構文
| Get-SCCustomPropertyValue -All [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-VMMServer <ServerConnection>] [<CommonParameters>] Get-SCCustomPropertyValue |
説明
Get-SCCustomPropertyValue コマンドレットは、カスタム プロパティ値オブジェクト情報を取得します。
パラメーター
-All [<SwitchParameter>]
このコマンドレットが親オブジェクトから独立したすべての従属オブジェクトを取得する場合に指定します。例えば、コマンド Get-SCVirtualDiskDrive -All は、各仮想ディスク ドライブ オブジェクトが関連付けられている仮想マシン オブジェクト、もしくはテンプレート オブジェクトに関係なく、すべての仮想ディスク ドライブ オブジェクトを取得します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-CustomProperty <CustomProperty>
カスタム プロパティ オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-InputObject <ClientObject>
値を取得、もしくは変更するプロパティが割り当てられているオブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUser <String>
ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUserRole <UserRole>
ユーザー ロールを指定します。ユーザー ロールを取得するには、Get-SCUserRole コマンドレットを用います。このコマンドレットは、このパラメーターで指定するユーザー ロールの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-VMMServer <ServerConnection>
VMM サーバー オブジェクトを取得します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
メモ
例
例 1 : 仮想マシン上のカスタム プロパティ値を取得する
コマンド
$VM = Get-SCVirtualMachine -Name "VM01" $CustomProp = Get-SCCustomProperty -Name "Cost Center" Get-SCCustomPropertyValue -InputObject $VM -CustomProperty $CustomProp
コマンドの説明
最初のコマンドは、仮想マシン オブジェクト “VM01” を取得し、このオブジェクトを $VM 変数に格納します。
2 番目のコマンドは、カスタム プロパティ オブジェクト “Cost Center” を取得し、このオブジェクトを $CustomProp 変数に格納します。
最後のコマンドは、$VM (VM01) に格納されている仮想マシンに対する $CustomProp (Cost Center) に格納されたカスタム プロパティ値を取得します。
関連するリンク
- Get-SCCustomProperty
- Get-SCVirtualMachine
- Remove-SCCustomPropertyValue
- Set-SCCustomPropertyValue
参考
- 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-SCCustomPropertyValue (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/get-sccustompropertyvalue?view=systemcenter-ps-2016