services オブジェクト

servicesオブジェクトは、X-MONのサービス設定を操作するオブジェクトです。

メソッド一覧

services.addサービス設定の新規作成

services.addは、サービス設定を新規作成するためのメソッドです。

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

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称	型	概要
host_name 必須	string	ホストIDを指定します。
service_description 必須	string	サービスIDを指定します。
is_volatile	boolean	volatileサービスを指定します。 true 有効にする false 無効にする省略時には、falseが指定されます。
check_command 必須	string	サービス監視用コマンドを指定します。指定する監視コマンドのIDは、csvで指定する値と共通です。
check_command_param	object	サービス監視用コマンドの引数を指定します。 argXX XXの部分には、引数の順番が入ります。（例・arg1、arg3 argXXをキー名として、設定する内容を値として記述してください。省略時には、指定したサービス監視用コマンドのデフォルト値が指定されます。
max_check_attempts	integer	試行回数を指定します。省略時には、3が指定されます。
check_interval	integer	監視間隔を指定します。省略時には、5が指定されます。
retry_interval	integer	再試行間隔を指定します。省略時には、1が指定されます。
active_checks_enabled	boolean	アクティブチェックを指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
passive_checks_enabled	boolean	パッシブチェックを指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
check_period	string	監視時間帯を指定します。時刻IDを指定してください。省略時には、24x7が指定されます。
obsess_over_service	boolean	分散監視送信機能を指定します。 true 有効にする false 無効にする省略時には、falseが指定されます。
check_freshness	boolean	フレッシュネスチェックを指定します。 true 有効にする false 無効にする省略時には、falseが指定されます。
freshness_threshold	integer	フレッシュネスしきい値を指定します。省略時には、0が指定されます。
event_handler	boolean	イベントハンドラを指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
event_handler_enabled	string	イベントハンドラコマンドを指定します。
low_flap_threshold	float	フラッピング検出の低しきい値を指定します。省略時には、25が指定されます。
high_flap_threshold	float	フラッピング検出の高しきい値を指定します。省略時には、50が指定されます。
flap_detection_enabled	boolean	フラッピング検出を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
flap_detection_options	object	フラッピング検出の対象を指定します。 ok ステータスOK状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする critical ステータスCRITICAL状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする warning ステータスWARNING状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする unknown ステータスUNKNOWN状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする省略時には、全てfalseになります。
process_perf_data	boolean	パフォーマンスデータ処理を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
retain_status_information	boolean	監視ステータス状態の保存を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
retain_nonstatus_information	boolean	監視設定情報の保存を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
contact_groups 3.0.9 - 3.8.0	array	通知先のユーザグループを指定します。ユーザグループIDを指定してください。
notification_interval 3.0.9 - 3.8.0	integer	再通知間隔を指定します。省略時には、120が指定されます。
first_notification_delay 3.0.9 - 3.8.0	integer	初期通知の遅延時間を指定します。省略時には、0が指定されます。
notification_period 3.0.9 - 3.8.0	string	通知及びエスカレーションの時間帯を指定します。時刻IDを指定してください。省略時には、24x7が指定されます。
notification_options 3.0.9 - 3.8.0	object	通知及びエスカレーションの対象を指定します。 ok ステータスOKの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする critical ステータスCRITICALの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする warning ステータスWARNINGの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする unknown ステータスUNKNOWNの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする flap フラップ通知を有効にするかどうかを指定します。 true 有効にする false 無効にする downtime ダウンタイムの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする省略時には、全て有効になります。
notifications_enabled	boolean	通知及びエスカレーション機能を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
stalking_options	object	状態追跡オプションを指定します。 ok ステータスOKを追跡するかどうかを指定します。 true 追跡する false 追跡しない critical ステータスCRITICALを追跡するかどうかを指定します。 true 追跡する false 追跡しない warning ステータスWARNINGを追跡するかどうかを指定します。 true 追跡する false 追跡しない unknown ステータスUNKNOWNを追跡するかどうかを指定します。 true 追跡する false 追跡しない省略時には、全てfalseになります。
approve	boolean	このリクエストを即座に反映するかどうかを指定します。省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

services.existサービス設定の存在確認

services.existは、指定したサービス設定が存在するかを確認するためのメソッドです。

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

リクエストパラメータ

カラム名称	型	概要
host_name 必須	string	ホストIDを指定します。
service_description 必須	string	サービスIDを指定します。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

services.deleteサービス設定の削除

services.deleteは、サービス設定を削除するためのメソッドです。

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

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称	型	概要
host_name 必須	string	ホストIDを指定します。
service_description 必須	string	サービスIDを指定します。
approve	boolean	このリクエストを即座に反映するかどうかを指定します。省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

services.getサービス設定の取得

services.getは、サービス設定を取得するためのメソッドです。

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

リクエストパラメータ

カラム名称	型	概要
host_name	string	ホストIDを指定します。 host_name もしくは host_key の指定が必要です。
host_key 3.9.0 以降	string	ホストを検索するキーを指定します。ホストIDを部分一致で検索します。空欄を指定した場合、全てのホストを取得します。 host_name もしくは host_key の指定が必要です。
service_description	string	取得するサービスIDを指定します。 service_description もしくは key の指定が必要です。
key	string	サービスを検索するキーを指定します。サービスIDを部分一致で検索します。空欄を指定した場合、全てのサービス設定を取得します。 service_description もしくは key の指定が必要です。
limit	integer	検索時に取得する件数を指定します。省略時は、全件が取得されます。
offset	integer	取得開始するサービス設定の行数を指定します。省略時は、0が指定されます。

このメソッドは、service_descriptionもしくはkeyのどちらかの指定が必要です。

レスポンスカラム

カラム名称	型	概要
id	string	内部管理用のID
host_name	string	ホストID
service_description	string	サービスID
is_volatile	integer	volatileサービス true 有効 false 無効
check_command	string	サービス監視用コマンド
check_command_param	array	サービス監視用コマンドの引数
max_check_attempts	integer	試行回数
check_interval	integer	監視間隔
retry_interval	integer	再試行間隔
active_checks_enabled	boolean	アクティブチェック true 有効 false 無効
passive_checks_enabled	boolean	パッシブチェック true 有効 false 無効
check_period	string	監視時間帯時刻IDを指定してください。
obsess_over_service	boolean	分散監視送信機能 true 有効 false 無効
check_freshness	boolean	フレッシュネスチェック true 有効 false 無効
freshness_threshold	integer	フレッシュネスしきい値
event_handler	string	イベントハンドラコマンド
event_handler_enabled	boolean	イベントハンドラ true 有効 false 無効
low_flap_threshold	string	フラッピング検出の低しきい値
high_flap_threshold	string	フラッピング検出の高しきい値
flap_detection_enabled	boolean	フラッピング検出 true 有効 false 無効
flap_detection_options	array	フラッピング検出の対象 ok ステータスOK状態を検出対象にするかどうか true 有効 false 無効 critical ステータスCRITICAL状態を検出対象にするかどうか true 有効 false 無効 warning ステータスWARNING状態を検出対象にするかどうか true 有効 false 無効 unknown ステータスUNKNOWN状態を検出対象にするかどうか true 有効 false 無効
process_perf_data	パフォーマンスデータ処理 true 有効 false 無効
retain_status_information	監視ステータス状態の保存 true 有効 false 無効
retain_nonstatus_information	監視設定情報の保存 true 有効 false 無効
contact_groups 3.0.9 - 3.8.0	通知先のユーザグループ
notification_interval 3.0.9 - 3.8.0	再通知間隔
first_notification_delay 3.0.9 - 3.8.0	初期通知の遅延時間
notification_period 3.0.9 - 3.8.0	通知及びエスカレーションの時間帯
notification_options 3.0.9 - 3.8.0	通知及びエスカレーションの対象 ok ステータスOKの通知を有効かどうか true 有効 false 無効 critical ステータスCRITICALの通知を有効かどうか true 有効 false 無効 warning ステータスWARNINGの通知を有効かどうか true 有効 false 無効 unknown ステータスUNKNOWNの通知を有効かどうか true 有効 false 無効 flap フラップ通知を有効かどうか true 有効 false 無効 downtime ダウンタイムの通知を有効かどうか true 有効 false 無効
notifications_enabled	boolean	通知及びエスカレーション機能 true 有効 false 無効
stalking_options	array	状態追跡オプション ok ステータスOKを追跡するかどうか true 追跡する false 追跡しない critical ステータスCRITICALを追跡するかどうか true 追跡する false 追跡しない warning ステータスWARNINGを追跡するかどうか true 追跡する false 追跡しない unknown ステータスUNKNOWNを追跡するかどうか true 追跡する false 追跡しない
_uuid 3.7.0 以降	サービスの一意な識別番号
hostgroup_name	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
display_name	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
servicegroups	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
contacts	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
notes	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
notes_url	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
action_url	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
icon_image	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
icon_image_alt	null	現在のX-MONでは使用されていない情報のため、空値が返されます。

services.updateサービス設定の更新

services.updateは、既存のサービス設定を編集するためのメソッドです。

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

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称	型	概要
host_name 必須	string	ホストIDを指定します。
service_description 必須	string	サービスIDを指定します。
is_volatile	boolean	volatileサービスを指定します。 true 有効にする false 無効にする
check_command	string	サービス監視用コマンドを指定します。指定する監視コマンドのIDは、csvで指定する値と共通です。
check_command_param	object	サービス監視用コマンドの引数を指定します。このカラムを適応させるには、check_commandも合わせて指定する必要があります。 argXX XXの部分には、引数の順番が入ります。（例・arg1、arg3 argXXをキー名として、設定する内容を値として記述してください。
max_check_attempts	integer	試行回数を指定します。
check_interval	integer	監視間隔を指定します。
retry_interval	integer	再試行間隔を指定します。
active_checks_enabled	boolean	アクティブチェックを指定します。 true 有効にする false 無効にする
passive_checks_enabled	boolean	パッシブチェックを指定します。 true 有効にする false 無効にする
check_period	string	監視時間帯を指定します。時刻IDを指定してください。
obsess_over_service	boolean	分散監視送信機能を指定します。 true 有効にする false 無効にする
check_freshness	boolean	フレッシュネスチェックを指定します。 true 有効にする false 無効にする
freshness_threshold	integer	フレッシュネスしきい値を指定します。
event_handler	boolean	イベントハンドラを指定します。 true 有効にする false 無効にする
event_handler_enabled	string	イベントハンドラコマンドを指定します。
low_flap_threshold	float	フラッピング検出の低しきい値を指定します。
high_flap_threshold	float	フラッピング検出の高しきい値を指定します。
flap_detection_enabled	boolean	フラッピング検出を指定します。 true 有効にする false 無効にする
flap_detection_options	object	フラッピング検出の対象を指定します。 ok ステータスOK状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする critical ステータスCRITICAL状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする warning ステータスWARNING状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする unknown ステータスUNKNOWN状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする
process_perf_data	boolean	パフォーマンスデータ処理を指定します。 true 有効にする false 無効にする
retain_status_information	boolean	監視ステータス状態の保存を指定します。 true 有効にする false 無効にする
retain_nonstatus_information	boolean	監視設定情報の保存を指定します。 true 有効にする false 無効にする
contact_groups 3.0.9 - 3.8.0	array	通知先のユーザグループを指定します。ユーザグループIDを指定してください。
notification_interval 3.0.9 - 3.8.0	integer	再通知間隔を指定します。
first_notification_delay 3.0.9 - 3.8.0	integer	初期通知の遅延時間を指定します。
notification_period 3.0.9 - 3.8.0	string	通知及びエスカレーションの時間帯を指定します。時刻IDを指定してください。
notification_options 3.0.9 - 3.8.0	object	通知及びエスカレーションの対象を指定します。 ok ステータスOKの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする critical ステータスCRITICALの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする warning ステータスWARNINGの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする unknown ステータスUNKNOWNの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする flap フラップ通知を有効にするかどうかを指定します。 true 有効にする false 無効にする downtime ダウンタイムの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする
notifications_enabled	boolean	通知及びエスカレーション機能を指定します。 true 有効にする false 無効にする
stalking_options	object	状態追跡オプションを指定します。 ok ステータスOKを追跡するかどうかを指定します。 true 追跡する false 追跡しない critical ステータスCRITICALを追跡するかどうかを指定します。 true 追跡する false 追跡しない warning ステータスWARNINGを追跡するかどうかを指定します。 true 追跡する false 追跡しない unknown ステータスUNKNOWNを追跡するかどうかを指定します。 true 追跡する false 追跡しない
approve	boolean	このリクエストを即座に反映するかどうかを指定します。省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

実行例

ホストX-MONのPINGサービスのラウンドトリップタイムしきい値を変更する

リクエスト

{ 　"jsonrpc":"2.0", 　"method":"services.update", 　"params":{ 　　"host_name":"X-MON", 　　"service_description":"PING", 　　"check_command":"check_xmon3_ping", 　　"check_command_param":{ 　　　"arg1":150, 　　　"arg3":200 　　} 　}, 　"id":"1", 　"user_id":"admin", 　"auth_token":"0b7670bda71ac0a38e384ab7d4956d19e13655e5" }