Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

> Map object

次のオブジェクトは map API に直接関連しています。

Map

Map オブジェクトには次のプロパティがあります。

プロパティ タイプ 説明
sysmapid string (読取専用) マップのID
height
(必須)
integer マップの高さ(ピクセル)
name
(必須)
string マップの名前
width
(必須)
integer マップの横幅(ピクセル)
backgroundid string マップの背景として使用される画像の ID
expand_macros integer マップの構成時にラベルのマクロを展開するかどうか

有効な値:
0 - (デフォルト) 展開しない
1 - 展開する
expandproblem integer 1 つの障害がある要素に対して障害のトリガーを表示するかどうか

有効な値:
0 - 常に問題の数を表示する

1 - (デフォルト) 障害が1つしかない場合は障害のトリガーを表示します
grid_align integer グリッド配置

有効な値:
0 - 無効
1 - (デフォルト) 有効
grid_show integer 地図上のグリッド表示

有効な値:
0 - 表示しない
1 - (デフォルト) 表示する
grid_size integer 地図上のグリッドピクセルサイズ

有効な値:20,40,50,75,100

デフォルト: 50
highlight integer アイコンの強調表示

有効な値:
0 - しない
1 - (デフォルト) する
iconmapid string マップで使用されるアイコン マップの ID
label_format integer 高度なラベルの有効化

有効な値:
0 - (デフォルト) 無効
1 - 有効
label_location integer マップエレメントラベルの位置

有効な値:
0 - (デフォルト)
1 - 左
2 - 右
3 - 上
label_string_host string ホスト要素のカスタムラベル

カスタムホストラベルタイプのマップでは必須
label_string_hostgroup string ホストグループ要素のカスタムラベル

カスタムホストグループラベルタイプのマップでは必須
label_string_image string 画像要素のカスタム ラベル

カスタム画像ラベルタイプの地図では必須
label_string_map string マップ要素のカスタムラベル

カスタムマップラベルタイプのマップでは必須
label_string_trigger string トリガー要素のカスタム ラベル

カスタムトリガーラベルタイプのマップでは必須
label_type integer マップ要素のラベルタイプ

有効な値:
0 - ラベル
1 - IP アドレス
2 - (デフォルト) 要素名
3 - ステータスのみ
4 - 無し
label_type_host integer ホスト要素のラベルタイプ

有効な値:
0 - ラベル
1 - IP アドレス
2 - (デフォルト) 要素名
3 - ステータスのみ
4 - 無し
5 - カスタム
label_type_hostgroup integer ホストグループ要素のラベルタイプ

有効な値:
0 - ラベル
2 - (デフォルト) 要素名
3 - ステータスのみ
4 - 無し
5 - カスタム
label_type_image integer ホストグループ要素のラベルタイプ

有効な値:
0 - ラベル
2 - (デフォルト) 要素名
4 - 無し
5 - カスタム
label_type_map integer マップ要素のラベル タイプ

有効な値:
0 - ラベル
2 - (デフォルト) 要素名
3 - ステータスのみ
4 - なし
4 - 無し
5 - カスタム
label_type_trigger integer トリガー要素のラベル タイプ

有効な値:
0 - ラベル
2 - (デフォルト) 要素名
3 - ステータスのみ
4 - 無し
5 - カスタム
markelements integer 最近ステータスが変更されたマップ要素の強調表示

有効な値:
0 - (デフォルト) 強調表示しない
1 - 要素を強調表示する
severity_min integer マップに表示されるトリガーの最小深刻度

サポートされているトリガー深刻度のリストについては、トリガーの"深刻度"プロパティを参照してください
show_unack integer 障害の表示方法

有効な値:
0 - (デフォルト) すべての障害数を表示
1 - 未確認の障害数のみ表示
2 - 確認済みの障害数と未確認の障害数を別々に表示
userid string マップ所有者のユーザー ID
private integer マップの共有

有効な値:
0 - 公開
1 - (デフォルト) 非公開
show_suppressed integer 抑制された障害の表示

有効な値:
0 - (デフォルト) 非表示
1 - 表示

Map element

map element オブジェクトは、マップ上に表示されるオブジェクトを定義します。 次のプロパティがあります。

プロパティ タイプ 説明
selementid string (読取専用) マップ要素の ID
elements
(必須)
array 要素データ オブジェクト。 ホスト、ホスト グループ、トリガー、およびマップタイプ要素に必要です。
elementtype
(必須)
integer マップ要素のタイプ

有効な値:
0 - ホスト
1 - マップ
2 - トリガー
3 - ホスト グループ
4 - 画像
iconid_off
(必須)
string デフォルト状態で要素を表示するために使用される画像の ID
areatype integer 個別のホスト グループ ホストを表示する方法。

有効な値:
0 - (デフォルト) ホスト グループ要素がマップ全体を占有
1 - ホスト グループ要素はサイズ固定
elementsubtype integer ホストグループ要素をマップ上に表示する方法

有効な値:
0 - (デフォルト) ホスト グループを 1 つの要素として表示
1 - 各ホストを表示 グループで別々に
evaltype integer マップ要素タグのフィルタリング条件評価方法

有効な値:
0 - (デフォルト) AND/OR
2 - OR
height integer 固定サイズのホストグループ要素の高さ (ピクセル単位)

デフォルト: 200
iconid_disabled string 無効な地図要素を表示するために使用される画像の ID。 画像要素には使用されません。
iconid_maintenance string メンテナンスでマップ要素を表示するために使用される画像の ID。 画像要素には使用されません。
iconid_on string 障害のあるマップ要素を表示するために使用される画像の ID。 画像要素には使用されません。
label string 要素のラベル。
label_location integer マップ要素ラベル位置

有効な値:
-1 - (デフォルト) デフォルト位置
0 - 下;
1 - 左;
2 - 右 ;
3 - 上
permission integer 権限レベル

有効な値:
-1 - 無し
2 - 読取専用
3 - 読取/書込
sysmapid string (読取専用) 要素が属するマップの ID
urls array マップ要素の URL

マップ要素のURLオブジェクトについては、以下で詳しく説明します。
use_iconmap integer ホスト要素にアイコンマッピングを使用するか

有効な値:
0 - 使用しない
1 - (デフォルト) 使用する
viewtype integer ホストグループ要素配置アルゴリズム

可能な値:
0 - (デフォルト) グリッド
width integer 固定サイズのホストグループ要素の幅 (ピクセル単位)

デフォルト: 200
x integer 要素の X 座標 (ピクセル単位)

デフォルト: 0
y integer 要素の Y 座標 (ピクセル単位)

デフォルト: 0

Map element Host

map element Host オブジェクトは 1 つのホスト要素を定義します

プロパティ タイプ 説明
hostid string ホストID

Map element Host group

map element Host group オブジェクトは、1つのホストグループ要素を定義します。

プロパティ タイプ 説明
groupid string ホストグループID

Map element Map

map element Map オブジェクトは、1つのマップ要素を定義します。

プロパティ タイプ 説明
sysmapid string マップID

Map element Trigger

map element Trigger オブジェクトは、1 つまたは複数のトリガー要素を定義します。

プロパティ タイプ 説明
triggerid string トリガーID

Map element tag

map element tag オブジェクトには次のプロパティがあります。

プロパティ タイプ 説明
tag
(必須)
string マップ要素のタグ名
operator string 要素タグの条件演算子をマップします

有効な値:
0 - (デフォルト) 含む
1 - 等しい
2 - 含まない
3 - 含まない 等しい
4 - 存在する
5 - 存在しない
value string マップ要素のタグ値

Map element URL

map element URL オブジェクトは、特定のマップ要素で使用できるクリック可能なリンクを定義します。 次のプロパティがあります。

プロパティ タイプ 説明
sysmapelementurlid string (読取専用) マップ要素URLのID
name
(必須)
string リンクのキャプション
url
(必須)
string リンク URL
selementid string URLが属するマップ要素のID

Map link オブジェクトは2つのマップ要素間のリンクを定義します。 次のプロパティがあります。

プロパティ タイプ 説明
linkid string (読取専用) マップ リンクの ID
selementid1
(必須)
string 一方の端にリンクされている最初のマップ要素の ID
selementid2
(必須)
string もう一方の端にリンクされている最初のマップ要素の ID
color string ラインの色を 16 進数のカラーコードで表します

デフォルト: 000000
drawtype integer リンク線の描画スタイル

有効な値:
0 - (デフォルト)
2 - 太線
3 - 点線
4 - 破線
label string リンクラベル
linktriggers array リンク ステータス インジケーターとして使用するマップ リンク トリガー

マップ リンク トリガー オブジェクトについては、以下で詳しく説明します。
permission integer 権限レベル

有効な値:
-1 - 無し
2 - 読取専用
3 - 読取/書込
sysmapid string リンクが属する地図の ID。

The map link trigger オブジェクトはトリガーの状態に基づいてマップリンクステータスインジケーターを定義します。 次のプロパティがあります。

プロパティ タイプ 説明
linktriggerid string (読取専用) マップ リンク トリガーの ID
triggerid
(必須)
string リンク インジケーターとして使用されるトリガーの ID
color string インジケータの色を 16 進数のカラー コードで表したもの。

デフォルト: DD0000
drawtype integer インジケーターの描画スタイル

有効な値:
0 - (デフォルト)
2 - 太線
3 - 点線
4 - 破線
linkid string リンク トリガーが属するマップ リンクの ID

Map URL

The map URL オブジェクトはマップ上の特定タイプすべての要素で使用できるクリック可能なリンクを定義します。 次のプロパティがあります。

プロパティ タイプ 説明
sysmapurlid string (読取専用) MapURLのID
name
(必須)
string リンクキャプション
url
(必須)
string リンクURL
elementtype integer URL を使用できる地図要素のタイプ

サポートされているタイプのリストについては、地図要素の"type"プロパティ を参照してください。

デフォルト: 0
sysmapid string URL が属するマップの ID

Map user

ユーザーに基づくマップ権限のリスト。 次のプロパティがあります。

プロパティ タイプ 説明
sysmapuserid string (読取専用) マップユーザーのID
userid
(必須)
string ユーザーID
permission
(必須)
integer 権限レベル

有効な値:
2 - 読取専用
3 - 読書可能

Map user group

ユーザー グループに基づくマップ権限のリスト。 次のプロパティがあります。

プロパティ タイプ 説明
sysmapusrgrpid string (読取専用) マップユーザーグループのID
usrgrpid
(必須)
string ユーザーグループID
permission
(必須)
integer 権限レベル

有効な値:
2 - 読取専用
3 - 読書可能

Map shapes

Map shapes オブジェクトは、マップ上に表示される幾何学的形状 (テキストの有無にかかわらず) を定義します。 次のプロパティがあります。

プロパティ タイプ 説明
sysmap_shapeid string (読取専用) マップ シェイプ エレメントのID
type (必須) integer マップ シェイプ エレメントのタイプ

有効な値:
0 - 長方形
1 - 楕円形

新しいシェイプを作成する場合はプロパティが必要です。
x integer シェイプの X 座標 (ピクセル単位)

デフォルト: 0
y integer シェイプの Y 座標 (ピクセル単位)

デフォルト: 0
width integer シェイプの幅 (ピクセル単位)

デフォルト: 200
height integer シェイプの高さ (ピクセル単位)

デフォルト: 200
text string シェイプのテキスト
font integer シェイプ内のテキストのフォント

有効な値:
0 - Georgia, serif
1 - “Palatino Linotype”, “Book Antiqua”, Palatino, serif
2 - “Times New Roman”, Times, serif
3 - Arial, Helvetica, sans-serif
4 - “Arial Black”, Gadget, sans-serif
5 - “Comic Sans MS”, cursive, sans-serif
6 - Impact, Charcoal, sans-serif
7 - “Lucida Sans Unicode”, “Lucida Grande”, sans-serif
8 - Tahoma, Geneva, sans-serif
9 - “Trebuchet MS”, Helvetica, sans-serif
10 - Verdana, Geneva, sans-serif
11 - “Courier New”, Courier, monospace
12 - “Lucida Console”, Monaco, monospace

デフォルト: 9
font_size integer ピクセル単位のフォント サイズ

デフォルト: 11
font_color string フォントカラー

デフォルト: '000000'
text_halign integer テキストの水平方向配置

有効な値:
0 - 中央
1 - 左
2 - 右

デフォルト: 0
text_valign integer テキストの垂直方向配置

有効な値:
0 - 中央
1 - 上
2 - 下

デフォルト: 0
border_type integer ボーダータイプ

可能な値:
0 - 無し
1 - —————
2 - ·····
3 - - - -

デフォルト: 0
border_width integer ボーダーの幅 (ピクセル単位)

デフォルト: 0
border_color string ボーダーカラー

デフォルト: '000000'
background_color string 背景色 (塗りつぶし)

デフォルト: (空)
zindex integer すべての形状と線の順序付けに使用される値 (z-index)

デフォルト: 0

Map lines

map line オブジェクトは、マップに表示されるラインを定義します。 次のプロパティがあります:

プロパティ タイプ 説明
sysmap_shapeid string (読取専用) 地図形状要素のID
x1 integer ライン ポイント 1 の X 座標 (ピクセル単位)

デフォルト: 0
y1 integer ライン ポイント 1 の Y 座標 (ピクセル単位)

デフォルト: 0
x2 integer ライン ポイント 2 の X 座標 (ピクセル単位)

デフォルト: 200
y2 integer ライン ポイント 2 の Y 座標 (ピクセル単位)

デフォルト: 200
line_type integer 線のタイプ

使用可能な値:
0 - 無し
1 - —————
2 - ·····
3 - - - -

デフォルト: 0
line_width integer ラインの幅 (ピクセル単位)

デフォルト: 0
line_color string ラインの色

デフォルト: '000000'
zindex integer すべての形と線の順序付けに使用される値 (z-index)

デフォルト: 0