2 ユーザーマクロ

概要

ユーザーマクロは、標準でサポートされているマクロに加えて、より高い柔軟性を実現するためにZabbixでサポートされています。

ユーザーマクロは、グローバル、テンプレート、ホストの各レベルで定義できます。これらのマクロは、次の特別な構文を持ちます。

{$MACRO}

Zabbixは、次の優先順位に従ってマクロを解決します。

1. ホストレベルのマクロ（最初に確認）
2. ホストの第1レベルのテンプレート（つまり、ホストに直接リンクされたテンプレート）で定義されたマクロ。テンプレートID順にソート
3. ホストの第2レベルのテンプレートで定義されたマクロ。テンプレートID順にソート
4. ホストの第3レベルのテンプレートで定義されたマクロ。テンプレートID順にソート、以下同様
5. グローバルマクロ（最後に確認）

言い換えると、あるマクロがホストに存在しない場合、Zabbixは深さが浅い順にホストのテンプレート内でそのマクロを探します。それでも見つからない場合は、存在すればグローバルマクロが使用されます。

Zabbixがマクロを見つけられない場合、そのマクロは解決されません。

ユーザーマクロは次の場所で使用できます。

• アイテム名
• アイテムキーのパラメータ
• アイテムの更新間隔および柔軟な間隔
• トリガー名および説明
• トリガー条件式のパラメータおよび定数（例を参照）
• その他多数の場所 - 完全な一覧を参照

グローバルマクロとホストマクロの一般的な使用例

• グローバルマクロを複数の場所で使用し、マクロの値を変更すると、ワンクリックですべての場所に設定変更が適用されます。
• ホスト固有の属性（パスワード、ポート番号、ファイル名、正規表現など）を持つテンプレートを活用します。

設定

ユーザーマクロを定義するには、Webインターフェース内の該当する場所に移動します。

• グローバルマクロの場合は、Administration → Macros を開きます
• ホストおよびテンプレートレベルのマクロの場合は、ホストまたはテンプレートのプロパティを開き、 Macros タブを探します

ユーザーマクロには、次の属性があります。

ユーザーマクロを設定する際は、以下のコンテキスト固有の動作に注意してください。

• ユーザーマクロがテンプレートのアイテムまたはトリガーで使用される場合は、それらのマクロをテンプレートにも追加することを検討してください（グローバルに定義されている場合でも）。そうすることで、テンプレートをXMLにエクスポートして別のシステムにインポートした後も、Text タイプのマクロが期待どおりに動作します（シークレットマクロの値はエクスポートされません）
• ユーザーマクロがトリガー式で使用される場合、それらのマクロはパラメータまたは定数を参照している場合にのみ展開されます。ホスト、アイテムキー、関数、演算子、または別のトリガー式を参照している場合は展開されません（シークレットマクロはトリガー式では使用できません）
• ユーザーマクロが、ホストプロトタイプを持つローレベルディスカバリルールが設定されたホストで使用される場合、discovered hosts はそのホストで定義されたすべてのユーザーマクロを継承します

例

例 1

"Status of SSH daemon" item キーにホストレベルマクロを使用する。

net.tcp.service[ssh,,{$SSH_PORT}]

この項目は、複数のホストで {$SSH_PORT} の値が定義されている場合に、複数のホストに割り当てることができます。

例 2

"CPU load is too high" トリガー でのホストレベルマクロの使用:

last(/ca_001/system.cpu.load[,avg1])>{$MAX_CPULOAD}

このようなトリガーは、個々のホストで編集するのではなく、テンプレート上で作成されることになります。

例 3

"CPU load is too high" トリガーで2つのマクロを使用する:

min(/ca_001/system.cpu.load[,avg1],{$CPULOAD_PERIOD})>{$MAX_CPULOAD}

マクロはトリガー関数（この例では関数min()）のパラメータとして使用することができることに注意。

例 4

agent の利用不可条件と item の更新間隔を同期させる。:

• {INTERVAL} マクロを定義し、item の更新間隔に使用する。
• {INTERVAL} を agent 使用不可トリガーのパラメータとして使用する。

nodata(/ca_001/agent.ping,{$INTERVAL})=1

例 5

稼働時間の設定を一元化します。

• 1-5,09:00-18:00 に等しいグローバルマクロ {$WORKING_HOURS} を作成します。
• Administration → General → GUI の Working time フィールドでこれを使用します。
• Users → Users のユーザーの Media タブにある When active フィールドでこれを使用します。
• 稼働時間中にアイテムをより高頻度でポーリングする設定にこれを使用します。

• Time period アクション条件でこれを使用します。
• 必要に応じて、Administration → Macros で稼働時間を調整します。

例 6

ホストプロトタイプマクロを使用して、検出されたホストの item を設定します:

ホストプロトタイプで、{$SNMPVALUE} を {#SNMPVALUE}low-level discovery マクロ値として定義します:

• ホストプロトタイプに Generic SNMPv2 テンプレートを割り当てます。
• {SNMPVALUE} を使用します。汎用SNMPv2テンプレート項目の SNMP OID* フィールドに {$SNMPVALUE} を使用します。

ユーザーマクロのコンテキスト

user macros with context を参照してください。