6 メディアタイプ

概要

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

エクスポート

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

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

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

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

インポート

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

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

インポートルール:

ルール 説明
既存のものを更新 既存の要素はインポートファイルのデータで更新されます。チェックしない場合は更新されません。
新規作成 新しい要素はインポートファイルのデータで作成されます。チェックしない場合は作成されません。

インポートの成功または失敗メッセージがフロントエンドに表示されます。

エクスポート形式

YAMLへのエクスポート:

zabbix_export:
  version: '8.0'
  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

        tokenパラメータにはPushoverアプリケーションキーを設定してください。
        ZabbixユーザーにPushoverメディアを割り当てる際は、ユーザーキーを送信先フィールドに追加してください。
      message_templates:
        - event_source: TRIGGERS
          operation_mode: PROBLEM
          subject: 'Problem: {EVENT.NAME}'
          message: |
            Problem started at {EVENT.TIME} on {EVENT.DATE}
            Problem name: {EVENT.NAME}
            Host: {HOST.NAME}
            Severity: {EVENT.SEVERITY}
            Operational data: {EVENT.OPDATA}
            Original problem ID: {EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: RECOVERY
          subject: 'Resolved in {EVENT.DURATION}: {EVENT.NAME}'
          message: |
            Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
            Problem name: {EVENT.NAME}
            Problem duration: {EVENT.DURATION}
            Host: {HOST.NAME}
            Severity: {EVENT.SEVERITY}
            Original problem ID: {EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: UPDATE
          subject: 'Updated problem in {EVENT.AGE}: {EVENT.NAME}'
          message: |
            {USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
            {EVENT.UPDATE.MESSAGE}

            Current problem state is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
        - event_source: DISCOVERY
          operation_mode: PROBLEM
          subject: 'Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}'
          message: |
            Discovery rule: {DISCOVERY.RULE.NAME}

            Device IP: {DISCOVERY.DEVICE.IPADDRESS}
            Device DNS: {DISCOVERY.DEVICE.DNS}
            Device status: {DISCOVERY.DEVICE.STATUS}
            Device uptime: {DISCOVERY.DEVICE.UPTIME}

            Device service name: {DISCOVERY.SERVICE.NAME}
            Device service port: {DISCOVERY.SERVICE.PORT}
            Device service status: {DISCOVERY.SERVICE.STATUS}
            Device service uptime: {DISCOVERY.SERVICE.UPTIME}
        - event_source: AUTOREGISTRATION
          operation_mode: PROBLEM
          subject: 'Autoregistration: {HOST.HOST}'
          message: |
            Host name: {HOST.HOST}
            Host IP: {HOST.IP}
            Agent port: {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 再試行間隔（秒または時間のサフィックスを使用）。
可能な値: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 メッセージ本文。

参照: メディアタイプオブジェクト（同名のプロパティを参照）。

Email

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

要素 型 説明
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 verify host。
指定可能な値:1 NO (0, デフォルト), YES (1)。
smtp_verify_peer string SMTPのSSL verify peer。
指定可能な値: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フロントエンドのURL。
client_id string OAuth認可サーバーに登録されたクライアント識別子。
authorization_url string アクセストークンとリフレッシュトークンを取得するためのパラメータ付きOAuth URL。
token_url string 認可トークンをアクセストークンとリフレッシュトークンに交換するためのOAuth URL。
message_format string メッセージフォーマット。
指定可能な値:1 TEXT (0), HTML (1, デフォルト)。

参照: メディアタイプオブジェクト（同名の関連プロパティを参照）。

SMS

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

要素 タイプ 説明
gsm_modem string (必須) GSMモデムのシリアルデバイス名

参照: メディアタイプオブジェクト（同名のプロパティを参照）。

スクリプト

スクリプトメディアタイプの場合、次の追加要素のみがエクスポートされます。

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

参照: メディアタイプオブジェクト（同名のプロパティを参照）。

Webhook

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

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

参照: メディアタイプオブジェクト（同名の関連プロパティを参照）。

脚注

1 括弧内のAPI整数値（例：ENABLED（0））は、参照用にのみ記載されています。 詳細については、表のエントリまたは各セクションの最後にあるリンクされたAPIオブジェクトページを参照してください。