6 メディアタイプ

概要

メディアタイプは、関連するすべてのオブジェクトおよびオブジェクト間の関係とともにエクスポートされます。

エクスポート

メディアタイプをエクスポートするには、次の手順を実行します。

  1. Alerts → Media types に移動します。
  2. エクスポートするメディアタイプのチェックボックスをオンにします。
  3. 一覧の下にある Export をクリックします。

選択した形式に応じて、メディアタイプはデフォルト名のローカルファイルにエクスポートされます。

  • zabbix_export_mediatypes.yaml - YAMLエクスポートの場合（エクスポートのデフォルトオプション）
  • zabbix_export_mediatypes.xml - XMLエクスポートの場合
  • zabbix_export_mediatypes.json - JSONエクスポートの場合。

インポート

メディアタイプをインポートするには、次の手順を実行します。

  1. Alerts → Media types に移動します。
  2. 右上隅の Import をクリックします。
  3. インポートファイルを選択します。
  4. インポートルールで必要なオプションをチェックします。
  5. 設定フォームの右下隅にある Import をクリックします。

インポートルール:

ルール 説明
Update existing 既存の要素は、インポートファイルのデータを使用して更新されます。それ以外の場合は、更新されません。
Create new 新しい要素は、インポートファイルのデータを使用して作成されます。それ以外の場合は、作成されません。

インポートの成功または失敗のメッセージが、Webインターフェースに表示されます。

エクスポート形式

YAMLにエクスポート:

zabbix_export:
  version: '7.4'
  media_types:
    - name: Pushover
      type: WEBHOOK
      parameters:
        - name: endpoint
          value: 'https://api.pushover.net/1/messages.json'
        - name: eventid
          value: '{EVENT.ID}'
        - name: event_nseverity
          value: '{EVENT.NSEVERITY}'
        - name: event_source
          value: '{EVENT.SOURCE}'
        - name: event_value
          value: '{EVENT.VALUE}'
        - name: expire
          value: '1200'
        - name: message
          value: '{ALERT.MESSAGE}'
        - name: priority_average
          value: '0'
        - name: priority_default
          value: '0'
        - name: priority_disaster
          value: '0'
        - name: priority_high
          value: '0'
        - name: priority_information
          value: '0'
        - name: priority_not_classified
          value: '0'
        - name: priority_warning
          value: '0'
        - name: retry
          value: '60'
        - name: title
          value: '{ALERT.SUBJECT}'
        - name: token
          value: '<PUSHOVER TOKEN HERE>'
        - name: triggerid
          value: '{TRIGGER.ID}'
        - name: url
          value: '{$ZABBIX.URL}'
        - name: url_title
          value: Zabbix
        - name: user
          value: '{ALERT.SENDTO}'
      status: DISABLED
      max_sessions: '0'
      script: |
        try {
            var params = JSON.parse(value),
                request = new HttpRequest(),
                data,
                response,
                severities = [
                    {name: 'not_classified', color: '#97AAB3'},
                    {name: 'information', color: '#7499FF'},
                    {name: 'warning', color: '#FFC859'},
                    {name: 'average', color: '#FFA059'},
                    {name: 'high', color: '#E97659'},
                    {name: 'disaster', color: '#E45959'},
                    {name: 'resolved', color: '#009900'},
                    {name: 'default', color: '#000000'}
                ],
                priority;

            if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
                request.setProxy(params.HTTPProxy);
            }

            if ([0, 1, 2, 3].indexOf(parseInt(params.event_source)) === -1) {
                throw 'Incorrect "event_source" parameter given: "' + params.event_source + '".\nMust be 0-3.';
            }

            if (params.event_value !== '0' && params.event_value !== '1'
                && (params.event_source === '0' || params.event_source === '3')) {
                throw 'Incorrect "event_value" parameter given: ' + params.event_value + '\nMust be 0 or 1.';
            }

            if ([0, 1, 2, 3, 4, 5].indexOf(parseInt(params.event_nseverity)) === -1) {
                params.event_nseverity = '7';
            }

            if (params.event_value === '0') {
                params.event_nseverity = '6';
            }

            priority = params['priority_' + severities[params.event_nseverity].name] || params.priority_default;

            if (isNaN(priority) || priority < -2 || priority > 2) {
                throw '"priority" should be -2..2';
            }

            if (params.event_source === '0' && isNaN(params.triggerid)) {
                throw 'field "triggerid" is not a number';
            }

            if (isNaN(params.eventid)) {
                throw 'field "eventid" is not a number';
            }

            if (typeof params.message !== 'string' || params.message.trim() === '') {
                throw 'field "message" cannot be empty';
            }

            data = {
                token: params.token,
                user: params.user,
                title: params.title,
                message: params.message,
                url: (params.event_source === '0') 
                    ? params.url + '/tr_events.php?triggerid=' + params.triggerid + '&eventid=' + params.eventid
                    : params.url,
                url_title: params.url_title,
                priority: priority
            };

            if (priority == 2) {
                if (isNaN(params.retry) || params.retry < 30) {
                    throw 'field "retry" should be a number with value of at least 30 if "priority" is set to 2';
                }

                if (isNaN(params.expire) || params.expire > 10800) {
                    throw 'field "expire" should be a number with value of at most 10800 if "priority" is set to 2';
                }

                data.retry = params.retry;
                data.expire = params.expire;
            }

            data = JSON.stringify(data);
            Zabbix.log(4, '[ Pushover Webhook ] Sending request: ' + params.endpoint + '\n' + data);

            request.addHeader('Content-Type: application/json');
            response = request.post(params.endpoint, data);

            Zabbix.log(4, '[ Pushover Webhook ] Received response with status code ' + request.getStatus() + '\n' + response);

            if (response !== null) {
                try {
                    response = JSON.parse(response);
                }
                catch (error) {
                    Zabbix.log(4, '[ Pushover Webhook ] Failed to parse response received from Pushover');
                    response = null;
                }
            }

            if (request.getStatus() != 200 || response === null || typeof response !== 'object' || response.status !== 1) {
                if (response !== null && typeof response === 'object' && typeof response.errors === 'object'
                        && typeof response.errors[0] === 'string') {
                    throw response.errors[0];
                }
                else {
                    throw 'Unknown error. Check debug log for more information.';
                }
            }

            return 'OK';
        }
        catch (error) {
            Zabbix.log(4, '[ Pushover Webhook ] Pushover notification failed: ' + error);
            throw 'Pushover notification failed: ' + error;
        }
      description: |
        セットアップガイドはこちらを参照してください: https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/media/pushover?at=refs%2Fheads%2Frelease%2F7.4

        tokenパラメータには、Pushoverアプリケーションキーを設定してください。
        ZabbixユーザーにPushoverメディアを割り当てる際は、送信先フィールドにユーザーキーを追加してください。
      message_templates:
        - event_source: TRIGGERS
          operation_mode: PROBLEM
          subject: '障害: {EVENT.NAME}'
          message: |
            障害発生日時 {EVENT.DATE} {EVENT.TIME}
            障害名: {EVENT.NAME}
            ホスト: {HOST.NAME}
            深刻度: {EVENT.SEVERITY}
            運用データ: {EVENT.OPDATA}
            元の障害ID: {EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: RECOVERY
          subject: '{EVENT.DURATION}で復旧: {EVENT.NAME}'
          message: |
            障害は {EVENT.RECOVERY.DATE} {EVENT.RECOVERY.TIME} に復旧しました
            障害名: {EVENT.NAME}
            障害継続時間: {EVENT.DURATION}
            ホスト: {HOST.NAME}
            深刻度: {EVENT.SEVERITY}
            元の障害ID: {EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: UPDATE
          subject: '{EVENT.AGE}経過した障害を更新: {EVENT.NAME}'
          message: |
            {USER.FULLNAME} が {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME} に障害を {EVENT.UPDATE.ACTION} しました。
            {EVENT.UPDATE.MESSAGE}

            現在の障害ステータスは {EVENT.STATUS}、経過時間は {EVENT.AGE}、確認済み: {EVENT.ACK.STATUS} です。
        - event_source: DISCOVERY
          operation_mode: PROBLEM
          subject: 'ディスカバリ: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}'
          message: |
            ディスカバリルール: {DISCOVERY.RULE.NAME}

            デバイスIP: {DISCOVERY.DEVICE.IPADDRESS}
            デバイスDNS: {DISCOVERY.DEVICE.DNS}
            デバイスステータス: {DISCOVERY.DEVICE.STATUS}
            デバイス稼働時間: {DISCOVERY.DEVICE.UPTIME}

            デバイスサービス名: {DISCOVERY.SERVICE.NAME}
            デバイスサービスポート: {DISCOVERY.SERVICE.PORT}
            デバイスサービスステータス: {DISCOVERY.SERVICE.STATUS}
            デバイスサービス稼働時間: {DISCOVERY.SERVICE.UPTIME}
        - event_source: AUTOREGISTRATION
          operation_mode: PROBLEM
          subject: '自動登録: {HOST.HOST}'
          message: |
            ホスト名: {HOST.HOST}
            ホストIP: {HOST.IP}
            エージェントポート: {HOST.PORT}

エクスポートされる要素

エクスポートされる要素については、以下の表で説明します。

要素 型 説明
name string （必須）メディアタイプ名。
type string （必須）メディアタイプで使用される転送方式。
指定可能な値:1 EMAIL (0), SMS (1), SCRIPT (2), WEBHOOK (4)。
status string メディアタイプが有効かどうか。
指定可能な値:1 ENABLED (0、デフォルト), DISABLED (1)
max_sessions integer 並列処理できるアラートの最大数。
SMS の指定可能な値:1 1（デフォルト）。
その他のメディアタイプの指定可能な値:1 0-100（0 は無制限）。
attempts integer アラート送信の最大試行回数。
指定可能な値:1 1-10（デフォルト: 3）。
attempt_interval string 再試行の間隔（秒またはtime suffixを使用）。
指定可能な値:1 0-60s（デフォルト: 10s）。
description string メディアタイプの説明。
message_templates メディアタイプのメッセージテンプレートのルート要素。
event_source string （必須）イベントソース。
指定可能な値:1 TRIGGERS (0), DISCOVERY (1), AUTOREGISTRATION (2), INTERNAL (3), SERVICE (4)。
operation_mode string 動作モード。
指定可能な値:1 PROBLEM (0), RECOVERY (1), UPDATE (2)。
subject string メッセージの件名。
message string メッセージ本文。

関連項目: Media type object（一致する名前の関連プロパティを参照してください）。

メール

以下の追加要素は、メール メディアタイプに対してのみエクスポートされます。

Element Type Description
provider string メールプロバイダー。
smtp_server string SMTPサーバー。
smtp_port integer 接続先のSMTPサーバーポート。
デフォルト: 25。
smtp_helo string SMTP helo。
smtp_email string 通知の送信元となるメールアドレス。
smtp_security string 使用するSMTP接続のセキュリティレベル。
指定可能な値:1 NONE (0、デフォルト)、STARTTLS (1)、SSL_OR_TLS (2)。
smtp_verify_host string SMTPのSSLホスト検証。
指定可能な値:1 NO (0、デフォルト)、YES (1)。
smtp_verify_peer string SMTPのSSLピア検証。
指定可能な値:1 NO (0、デフォルト)、YES (1)。
smtp_authentication string 使用するSMTP認証方式。
指定可能な値:1 NONE (0、デフォルト)、PASSWORD (1)、OAUTH (2)。
username string ユーザー名。
password string 認証パスワード。
redirection_url string OAuth認可後にリダイレクトして戻る先のZabbix Webインターフェース URL。
client_id string OAuth認可サーバー内で登録されたクライアント識別子。
authorization_url string アクセスおよびリフレッシュトークンを取得するための、パラメータ付きOAuth URL。
token_url string 認可トークンをアクセスおよびリフレッシュトークンに交換するためのOAuth URL。
message_format string メッセージ形式。
指定可能な値:1 TEXT (0)、HTML (1、デフォルト)。

関連項目: Media type object（一致する名前の該当プロパティを参照してください）。

SMS

以下の追加要素は、SMS メディアタイプに対してのみエクスポートされます。

要素 Type 説明
gsm_modem string （必須）GSMモデムのシリアルデバイス名。

あわせて参照: メディアタイプオブジェクト（一致する名前を持つ関連プロパティを参照してください）。

スクリプト

以下の追加要素は、スクリプト メディアタイプに対してのみエクスポートされます。

要素 型 説明
スクリプト名 string （必須）スクリプト名。
parameters スクリプトパラメータのルート要素。
sortorder string （必須）コマンドライン引数としてスクリプトに渡されるスクリプトパラメータの順序。
value string スクリプトパラメータの値。

関連項目: メディアタイプオブジェクト（一致する名前を持つ関連プロパティを参照してください）。

webhook

以下の追加要素は、Webhook メディアタイプに対してのみエクスポートされます。

要素 Type 説明
script string スクリプト。
timeout string JavascriptスクリプトのHTTPリクエストタイムアウト間隔。
指定可能な値:1 1-60s（デフォルト: 30s）。
process_tags string 返されたタグを処理するかどうか。
指定可能な値:1 NO（0、デフォルト）、YES（1）。
show_event_menu string event_menu_url および event_menu_name フィールドで {EVENT.TAGS.*} マクロが正常に解決された場合に、イベントメニュー内にエントリが存在することを示します。
指定可能な値:1 NO（0、デフォルト）、YES（1）。
event_menu_url string イベントメニューエントリのURL。{EVENT.TAGS.*} マクロをサポートします。
event_menu_name string イベントメニューエントリの名前。{EVENT.TAGS.*} マクロをサポートします。
parameters webhookメディアタイプパラメータのルート要素。
name string （必須）webhookパラメータ名。
value string webhookパラメータ値。

関連項目: Media type object（一致する名前の関連プロパティを参照してください）。

脚注

1 かっこ内のAPI整数値（例: ENABLED (0)）は、参照用としてのみ記載されています。
詳細については、表の該当エントリにあるリンク先のAPIオブジェクトページ、または各セクションの末尾を参照してください。