System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Get-SCCustomProperty コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Get-SCCustomProperty」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Get-SCCustomProperty コマンドレット
名前
Get-SCCustomProperty
概要
VMM データベースからカスタム プロパティ定義を取得します。
構文
| Get-SCCustomProperty [-ID <Guid>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-VMMServer <ServerConnection>] [<CommonParameters>] Get-SCCustomProperty Get-SCCustomProperty |
説明
Get-SCCustomProperty コマンドレットは、Virtual Machine Manager (VMM) データベースからカスタム プロパティ定義情報を取得します。
パラメーター
-ID <Guid>
特定のオブジェクトに対するグローバル一意識別子、もしくは GUID として数値 ID を指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Member <CustomPropertyObjectType>
グループの一部であるオブジェクトを指定します。このパラメーターで利用可能な値は次のとおり :
- VM
- Template
- VMHost
- HostCluster
- VMHostGroup
- ServiceTemplate
- ServiceInstance
- ComputerTier
- Cloud
- ProtectionUnit
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Name <String>
VMM オブジェクト名を指定します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | 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 : Name によるカスタム プロパティ情報を取得する
コマンド
$CustomProp = Get-SCCustomProperty -Name "Cost Center" $CustomProp
コマンドの説明
最初のコマンドは、カスタム プロパティ オブジェクト “Cost Center” を取得し、そのオブジェクトを $CustomProp 変数に格納します。
2 番目のコマンドは、$CustomProp に格納されているカスタム プロパティ オブジェクトのプロパティ情報を表示します。
例 2 : 特定のメンバーの種類に対するすべてのカスタム プロパティ情報を取得する
コマンド
Get-SCCustomProperty -Member "VM"
コマンドの説明
このコマンドは、メンバーとして VM に含まれているすべてのカスタム プロパティ情報を返します。
関連するリンク
- New-SCCustomProperty
- Remove-SCCustomProperty
- Set-SCCustomProperty
参考
- 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-SCCustomProperty (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/get-sccustomproperty?view=systemcenter-ps-2016