SCVMM 2016 UR5 で利用可能なコマンドレット (Remove-SCCustomPropertyValue) について

スポンサーリンク
Microsoft Public Affiliate Program (JP)(マイクロソフトアフィリエイトプログラム)

System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。

ここでは Remove-SCCustomPropertyValue コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCCustomPropertyValue」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。

Remove-SCCustomPropertyValue コマンドレット

名前

Remove-SCCustomPropertyValue

概要

カスタム プロパティから値を削除します。

構文

Remove-SCCustomPropertyValue
 [-Confirm]
 -CustomProperty <CustomProperty>
 -JobGroup <Guid>
 [-JobVariable <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [-WhatIf]
 [<CommonParameters>]

Remove-SCCustomPropertyValue
[-Confirm]
-CustomPropertyValue <CustomPropertyValue>
[-JobVariable <String>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[-PROTipID <Guid>]
[-RunAsynchronously]
[-WhatIf]
[<CommonParameters>]

説明

Remove-SCCustomPropertyValue コマンドレットは、カスタム プロパティから値を削除します。

パラメーター

-Confirm [<SwitchParameter>]

コマンドレットの実行前に確認のプロンプトを表示します。

必須 false
位置 named
既定値 False
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-CustomProperty <CustomProperty>

カスタム プロパティ オブジェクトを指定します。

必須 true
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-CustomPropertyValue <CustomPropertyValue>

カスタム プロパティ値オブジェクトを指定します。

必須 true
位置 named
既定値 None
パイプライン入力を許可する True (ByValue)
ワイルドカード文字を許可する false

-JobGroup <Guid>

同じジョブ グループ識別子を含む最後のコマンドが実行される直前に、一連のコマンドを実行する一連のコマンドの識別子を指定します。

必須 true
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-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

-WhatIf [<SwitchParameter>]

コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。

必須 false
位置 named
既定値 False
パイプライン入力を許可する False
ワイルドカード文字を許可する 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"
$CustomPropValue = Get-SCCustomPropertyValue -InputObject $VM -CustomProperty $CustomProp
Remove-SCCustomPropertyValue -CustomPropertyValue $CustomPropValue
コマンドの説明

最初のコマンドは、仮想マシン オブジェクト”VM01″ を取得、そのオブジェクトを $VM 変数を格納します。

2 番目のコマンドは、カスタム プロパティ オブジェクト “Cost Center” を取得し、そのオブジェクトを $CustomProp 変数に格納します。

3 番目のコマンドは、$VM (VM01) に格納されている仮想マシンの $CustomProp (Cost Center) に格納されているカスタム プロパティ値を取得し、その値を $CustomPropValue 変数に格納します。

最後のコマンドは、$CustomPropValue に格納されているカスタム プロパティ値を削除します。

関連するリンク

  • Get-SCCustomProperty
  • Get-SCVirtualMachine
  • Get-SCCustomPropertyValue
  • Set-SCCustomPropertyValue

参考