1. index
  2. 監視
  3. 設定
  4. コマンド
  5. その他

hoststatus オブジェクト

hoststatusオブジェクトは、X-MONのホスト監視結果を操作するオブジェクトです。

ホスト監視設定に関する操作を知りたい方は、hostsを参照してください。

hoststatus.getホスト監視結果の取得

hoststatus.getは、ホスト監視の結果を取得するためのメソッドです。

対応X-MONバージョン
  • 3.0.9 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

閲覧者権限のユーザは、閲覧対象ホストグループが設定されている場合、閲覧対象として許可されているホスト情報のみが取得されます。

リクエストパラメータ

カラム名称 概要
hostgroup string

指定したホストグループに所属しているホストの監視結果のみを取得します。

state_type object

取得したいステートタイプの種類を連想配列で指定します。

hard
falseを指定するとステートタイプがHARDのものを取得しません。
soft
falseを指定するとステートタイプがSOFTのものを取得しません。

省略時はどちらも true として処理されます。

state_check_type object

取得したいステートチェックタイプの種類を連想配列で指定します。

active
falseを指定するとアクティブチェックの結果を取得しません。
passive
falseを指定するとパッシブチェックの結果を取得しません。

省略時はどちらも true として処理されます。

state_downtime object

取得したいホストのダウンタイムの状態を連想配列で指定します。

enable
falseを指定するとダウンタイムが設定されたホストの監視結果を取得しません。
disable
falseを指定するとダウンタイムが設定されていないホストの監視結果を取得しません。

省略時はどちらも true として処理されます。

state_acknowledged object

取得したいホストの認知済みの状態を連想配列で指定します。

enable
falseを指定すると認知済みの設定がされているホストの監視結果を取得しません。
disable
falseを指定すると認知済みの設定されていないホストの監視結果を取得しません。

省略時はどちらも true として処理されます。

state_flapping object

取得したいホストのフラッピング状態を連想配列で指定します。

enable
falseを指定するとフラッピングが検出されているホストの監視結果を取得しません。
disable
falseを指定するとフラッピングが検出されていないホストの監視結果を取得しません。

省略時はどちらも true として処理されます。

flapping object

取得したいホストのフラッピング検出設定を連想配列で指定します。

enable
falseを指定するとフラッピング検出が有効なホストの監視結果を取得しません。
disable
falseを指定するとフラッピング検出が無効なホストの監視結果を取得しません。

省略時はどちらも true として処理されます。

event_handler object

取得したいホストのイベントハンドラ設定を連想配列で指定します。

enable
falseを指定するとイベントハンドラが有効なホストの監視結果を取得しません。
disable
falseを指定するとイベントハンドラが無効なホストの監視結果を取得しません。

省略時はどちらも true として処理されます。

passive object

取得したいホストのパッシブチェック設定を連想配列で指定します。

enable
falseを指定するとパッシブチェックが有効なホストの監視結果を取得しません。
disable
falseを指定するとパッシブチェックが無効なホストの監視結果を取得しません。

省略時はどちらも true として処理されます。

active object

取得したいホストのアクティブチェック設定を連想配列で指定します。

enable
falseを指定するとアクティブチェックが有効なホストの監視結果を取得しません。
disable
falseを指定するとアクティブチェックが無効なホストの監視結果を取得しません。

省略時はどちらも true として処理されます。

notification object

取得したいホストの通知/エスカレーション設定を連想配列で指定します。

enable
falseを指定すると通知/エスカレーションが有効なホストの監視結果を取得しません。
disable
falseを指定するとア通知/エスカレーションが無効なホストの監視結果を取得しません。

省略時はどちらも true として処理されます。

status object

取得したい監視結果を連想配列で指定します。

up
falseを指定するとステータスがUPの監視結果を取得しません。
down
falseを指定するとステータスがDOWNの監視結果を取得しません。
unreachable
falseを指定するとステータスがUNREACHABLEの監視結果を取得しません。
pending
falseを指定するとステータスがPENDINGの監視結果を取得しません。

省略時はいずれも true として処理されます。

sort object

取得したい結果のソート方法指定します。

sorttype

ソートの順序を指定します。

asc
結果を昇順で取得します。
desc
結果を降順で取得します。

省略時は、ascが指定されます。

sortoption

ソートを行うカラムを指定します。

host_name
ホストIDでソートを行います。
last_check
最終チェックが行われた日時でソートを行います。
last_state_change
最後にステータスが変更された日時でソートを行います。
state
ステータスの種類でソートを行います。

省略時は、host_nameが指定されます。

レスポンスカラム

カラム名称 概要
name string

ホストID

alias string

ホストエイリアス

state string

ホストステータス

0
ステータスがUP、またはPENDING
1
ステータスがDOWN
2
ステータスがUNREACHABLE

PENDINGの判定は、has_been_checkedの値で行います。

address string

ホストアドレス

last_check string

最終チェック日時のUNIXTIME

last_state_change string

最終ステータス変更日時のUNIXTIME

plugin_output string

ステータス情報

string icon_image

アイコン画像ファイル名

active_checks_enabled string

アクティブチェックの設定

0
アクティブチェックが無効
1
アクティブチェックが有効
acknowledged string

認知済み状態

0
認知済み状態ではない
1
認知済み状態
notifications_enabled string

通知/エスカレーション設定の設定

0
通知/エスカレーションが無効
1
通知/エスカレーションが有効
is_flapping string

フラッピング検知の状態

0
フラッピングではない
1
フラッピング検知
scheduled_downtime_depth string

ダウンタイムの状態

0
ダウンタイム中ではない
0以外
ダウンタイム中
has_been_checked string

ホストチェックが実行済みかどうか

0
ホストチェック未実施
1
ホストチェック実施済
next_check string

次回チェック予定日時のUNIXTIME

実行例

ホストの監視結果を全て取得する

リクエスト
{  "jsonrpc":"2.0",  "method":"hoststatus.get",  "id":"1",  "user_id":"admin",  "auth_token":"0b7670bda71ac0a38e384ab7d4956d19e13655e5" }
レスポンス
{  "jsonrpc":"2.0",  "result":[   {    "name":"X-MON",    "alias":"X-MON",    "state":"0",    "address":"127.0.0.1",    "last_check":"1402122177",    "last_state_change":"1401424652",    "plugin_output":"PING OK - Packet loss = 0%, RTA = 0.05 ms",    "icon_image":"X-MON.png",    "active_checks_enabled":"1",    "acknowledged":"0",    "notifications_enabled":"1",    "is_flapping":"0",    "scheduled_downtime_depth":"0",    "has_been_checked":"1",    "next_check":"1402122177"   },   {    "name":"HOST-B",    "alias":"HOST-B",    "state":"0",    "address":"127.0.0.1",    "last_check":"0",    "last_state_change":"0",    "plugin_output":"",    "icon_image":"unknown.png",    "active_checks_enabled":"1",    "acknowledged":"0",    "notifications_enabled":"1",    "is_flapping":"0",    "scheduled_downtime_depth":"0",    "has_been_checked":"0",    "next_check":"0"   }  ],  "id":"1" }

未認知の障害発生ホストを取得する

リクエスト
{  "jsonrpc":"2.0",  "method":"hoststatus.get",  "params":{   "status":{    "up":false,    "pending":false   },   "state_acknowledged":{    "enable":false   },   "state_downtime":{    "enable":false   }  },  "id":"1",  "user_id":"admin",  "auth_token":"0b7670bda71ac0a38e384ab7d4956d19e13655e5" }