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

ブログ エントリ内にアフィリエイト広告が含まれています

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

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

Remove-SCCustomProperty コマンドレット

名前

Remove-SCCustomProperty

概要

VMM データベースからカスタム プロパティの定義を削除します。

構文

Remove-SCCustomProperty
 [-Confirm]
 -CustomProperty <CustomProperty>
 [-JobVariable <String>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [-WhatIf]
 [<CommonParameters>]

説明

Remove-SCCustomProperty コマンドレットは、Virtual Machine Manager (VMM) データベースからカスタム プロパティの定義を削除します。

パラメーター

-Confirm [<SwitchParameter>]

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

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

-CustomProperty <CustomProperty>

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

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

-JobVariable <String>

ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。

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

-PROTipID <Guid>

このアクションをトリガーしたパフォーマンスとリソースの最適化のヒント (PRO ヒント) ID を指定します。これにより、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 を参照してください。

入力

出力

メモ

Get-SCCustomProperty コマンドレットを用いて取得可能な VMM カスタム プロパティ オブジェクトが必要となります。

例 1 : カスタム プロパティの定義を削除する

コマンド
$CustomProp = Get-SCCustomProperty -Name "Cost Center"
Remove-SCCustomProperty -CustomProperty $CustomProp
コマンドの説明

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

2 番目のコマンドは、$CustomProp に格納されているカスタム プロパティ オブジェクトを削除します。

関連するリンク

  • Get-SCCustomProperty
  • New-SCCustomProperty
  • Set-SCCustomProperty

参考

タイトルとURLをコピーしました