カスタム属性とは

カスタム属性とは、簡単にいうと vCenter の仮想マシンタブ、またはホストタブをクリックした際に表示される項目フィールドのことです

カスタム属性を追加することで、vCenter タブを押した時に表示される 状態・ステータス・CPU 使用率 のような項目フィールドをユーザが定義した任意の名前で作成・追加することができます。

今回は、vSphere Client を使って vCenter にカスタム属性を追加・削除する方法、そして、どういう時に使うのか。その使い方についてご紹介します。

vCenter ホスト一覧

カスタム属性の追加

Step 1. カスタム属性定義

仮想マシンのサマリタブ > 編集 をクリックします。

ちなみに、対象仮想マシンは電源 OFF 状態の仮想マシンでもなんでも構いません。

仮想マシンのサマリ

注釈の編集 画面がポップアップされたら 追加 をクリックします。

注釈の編集

カスタム属性の追加 ダイアログがポップアップされたら 名前タイプ を入力し、OK をクリックします。

項目 備考
名前 属性名を入力 簡単にいうとフィールド名
タイプ 仮想マシン or グローバル 設定範囲
今は入力しなくて良い
カスタム属性の追加

タイプについて

タイプには、以下の二種類が存在します。

・ 仮想マシン

・ グローバル

このタイプによって設定範囲が変わります。

例えば、仮想マシン を選択した場合には、vCenter 上の全ての仮想マシンに対してカスタム属性値を設定することができます。(仮想マシンに限定される)

また、グローバル を選択した場合には、vCenter 上の全ての仮想マシンを含め、クラスタ、ESX ホストに対してもカスタム属性値を設定できるようになります。

値について

この例では グローバルタイプGLOBAL_ATTRIBUTES というフィールドを新しく作成 (新規定義) しようとしています。

に関しては、今入れてもいいですが、後で各仮想マシンに設定する際にまとめて実施した方が分かりやすいかなと思ったので、値は入力していません。

ちなみに、今 を入力すると現在選択されている仮想マシンに値が設定されます。(カスタム属性を作成すると同時に仮想マシンに値を設定する感じです)

そうすると以下のように GLOBAL_ATTRIBUTES という属性が追加されます。

グローバル属性なので、現在選択されている仮想マシンだけでなく、vCenter 上の全てのクラスタ、ESX ホスト、仮想マシンが GLOBAL_ATTRIBUTES という属性を持つことになります。

クラスタ・ESX ホストの場合には、データセンター 選択 > クラスタ タブ または、クラスタ 選択 > ホスト タブ をクリックした時に表示されるクラスタ一覧・ESX ホスト一覧上で値を設定することができます。

仮想マシンの場合には、各仮想マシンの 設定の編集 を開くと GLOBAL_ATTRIBUTES という項目が表示されるので、各仮想マシンに任意の値を設定することができます。

グローバル属性追加完了

Step 2. カスタム属性に値を設定

仮想マシンのサマリタブ > 編集 をクリックします。

注釈の編集 画面がポップアップされたら GLOBAL_ATTRIBUTES の値を入力します。(入力欄からカーソルが抜けると特に OK ボタンを押さなくても値が設定されるようになっています)

この例では、仮想マシン s01 ~ s20 に対して、先ほど追加したグローバル属性 GLOBAL_ATTRIBUTES に以下の値を追加しました。

  • s01 ~ s05 : 01_SERVICE_NAME (例えば DNS サービス)
  • s06 ~ s10 : 02_SERVICE_NAME (例えば VPN サービス)
  • s11 ~ s15 : 03_SERVICE_NAME (例えば WEB サービス)
  • s15 ~ s20 : 04_SERVICE_NAME (例えば VPS サービス)
グローバル属性に値を設定

設定が終わったら vCenter 左側のペインで仮想マシンが動いている クラスタ > 仮想マシン タブ をクリックします。

仮想マシン一覧が表示されたら フィールドバー 右クリック > GLOBAL_ATTRIBUTES をクリックします。

仮想マシン一覧でカスタム属性を表示

そうすると以下のように仮想マシンにグローバル値が設定されていることが確認できます。

仮想マシン一覧でカスタム属性を確認

カスタム属性の削除

カスタム属性を削除する際には、新規作成時と同じやり方で適当に仮想マシンを一つ選択し、仮想マシンのサマリタブ > 編集 をクリックします。

注釈の編集 画面がポップアップされたら 削除 をクリックします。

カスタム属性の削除

属性の削除の確認 ダイアログがポップアップされます。

はい(Y) をクリックします。

属性の削除の確認

以下のようにカスタム属性が削除されていることが確認できます。

属性の削除完了

削除について

カスタム属性を削除すると属性そのものが削除されるため、全てのクラスタ・ESX ホスト・仮想マシンに設定されたカスタム属性と値も全部削除されます

終わりに

肝心な使い道についてなんですが、先ほどカスタム属性値を設定する例として仮想マシン s01 ~ s20 に対して、01_SERVICE_NAME02_SERVICE_NAME のようにサービス名を設定しました。

クラウド環境内に様々なサービスを提供している大量の仮想マシンが存在する場合、仮想マシンごとにサービス名を設定することでトラブルが起きたときにどんなサービスに影響が出たか把握しやすくなります

例えば、ある仮想マシンに異常が発生した場合、vCenter からアラートメールが飛びます。

vCenter アラートメールの例
件名: VMware vCenter - アラーム 仮想マシンのスナップショット領域 5GB 超え

本文
ターゲット: s01
旧ステータス: 緑
新ステータス: 黄

アラームの定義:
([黄色メトリック 次の値より大きい 5,242,880KB; 赤色メトリック 次の値より大きい 10,485,760KB])

メトリックまたは状態の現在の値:
メトリック ディスク デルタ ディスクのバッギングによるオーバーヘッド = 6,248,906KB

説明:
s01 上のアラーム「仮想マシンのスナップショット領域 5GB 超え」が緑から黄色に変わりました。

上記のアラートの場合には緊急度は低いですが、ターゲットを見れば分かるように仮想マシン名しか表示されないため、どんなサービスに影響が発生したかまでは特定することが出来ません。

特に、監視部隊が存在している場合には、アラートメールが飛んだ瞬間、監視担当者が vCenter へログインし状況を把握することもあるので、その際に障害が発生した仮想マシンにカスタム属性が設定されていると色々調べなくても、ぱっと見るだけてすぐ分かるので、把握しやすくなる・時間短縮にもなるというメリットがあります。

一つ注意点としては、vCenter を跨ぐ仮想マシンの移行時に、例えば、vCenter A 上の仮想マシンを vCenter B へ移した場合には、カスタム属性は引き継がれないので、新しく設定してあげる必要があります。

うまく活用すれば運用する際にかなり役に立つと思いますので、是非活用して見てください。

以上、vCenter カスタム属性追加・削除 でした。