hosts オブジェクト

hostsオブジェクトは、X-MONのホスト設定を操作するオブジェクトです。

メソッド一覧

hosts.addホスト設定の新規作成

hosts.addは、ホスト設定を新規作成するためのメソッドです。

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

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

リクエストパラメータ

カラム名称	型	概要
host_name 必須	string	ホストIDを指定します。
package	array	適用させる監視パッケージのIDを指定します。このカラムを指定する際は、approveカラムを省略またはtrueとする必要があります。
alias	string	ホスト名称を指定します。省略時には、host_nameの値が指定されます。
address 必須	string	IPアドレス/FQDNを指定します。
macaddress	string	MACアドレスを指定します。
parents	array	親ホストを指定します。
type	string	機器種別を指定します。 server 物理サーバ router ルータ switch スイッチ hyper-v Hyper-V aws AWS vm 仮想サーバ省略時には、serverが指定されます。
check_command 必須	string	ホスト監視用コマンドを指定します。指定する監視コマンドのIDは、csvで指定する値と共通です。
check_command_param	object	ホスト監視用コマンドの引数を指定します。 argXX XXの部分には、引数の順番が入ります。（例・arg1、arg3 argXXをキー名として、設定する内容を値として記述してください。省略時には、指定したホスト監視用コマンドのデフォルト値が指定されます。
max_check_attempts	integer	試行回数を指定します。省略時には、1が指定されます。
check_interval	integer	監視間隔を指定します。省略時には、0が指定されます。
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_host	boolean	分散監視送信機能を指定します。 true 有効にする false 無効にする省略時には、falseが指定されます。
check_freshness	boolean	フレッシュネスチェックを指定します。 true 有効にする false 無効にする省略時には、falseが指定されます。
freshness_threshold	integer	フレッシュネスしきい値を指定します。省略時には、0が指定されます。
event_handler_enabled	boolean	イベントハンドラを指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
event_handler	string	イベントハンドラコマンドを指定します。
low_flap_threshold	float	フラッピング検出の低しきい値を指定します。省略時には、25が指定されます。
high_flap_threshold	float	フラッピング検出の高しきい値を指定します。省略時には、50が指定されます。
flap_detection_enabled	boolean	フラッピング検出を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
flap_detection_options	object	フラッピング検出の対象を指定します。 up ステータスUP状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする down ステータスDOWN状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする unreachable ステータスUNREACHABLE状態を検出対象にするかどうかを指定します。 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	通知及びエスカレーションの対象を指定します。 up ステータスUPの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする down ステータスDOWNの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする unreachable ステータスUNREACHABLEの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする flap フラップ通知を有効にするかどうかを指定します。 true 有効にする false 無効にする downtime ダウンタイムの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする省略時には、「UP」「DOWN」「UNREACHABLE」が有効になります。
notifications_enabled	boolean	通知及びエスカレーション機能を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
stalking_options	object	状態追跡オプションを指定します。 up ステータスUPを追跡するかどうかを指定します。 true 追跡する false 追跡しない down ステータスDOWNを追跡するかどうかを指定します。 true 追跡する false 追跡しない unreachable ステータスUNREACHABLEを追跡するかどうかを指定します。 true 追跡する false 追跡しない省略時には、全てfalseになります。
icon	string	ホストのアイコンを指定します。アイコンIDを指定してください。省略時には、unknownが指定されます。
snmp_version	string	SNMPのバージョンを指定します。 1 SNMP Version 1 2c SNMP Version 2c 3 SNMP Version 3 省略時には、1が指定されます。
snmp_port 3.8.0 以降	string	SNMPのポート番号を指定します。省略時には、161が指定されます。
snmp_community	string	SNMPのコミュニティ名を指定します。 SNMPv3の場合は、認証ユーザ名を指定します。
snmp_security_level	string	SNMPv3のセキュリティレベルを指定します。 authPriv 認証も暗号化もする authNoPriv 認証するが暗号化はしない
snmp_authtype	string	SNMPv3の認証タイプを指定します。 SHA SHAを使用 MD5 MD5を使用
snmp_user	string	SNMPv3の認証パスワードを指定します。
snmp_protocol	string	SNMPv3の暗号化プロトコルを指定します。 AES AESを使用 DES DESを使用
snmp_pass	string	SNMPv3の暗号化パスワードを指定します。
wmi_user	string	WMIのアカウントを指定します。
wmi_pass	string	WMIのパスワードを指定します。
aws_access	string	AWSのアクセスキーを指定します。
aws_secret	string	AWSのシークレットキーを指定します。
aws_region	string	AWSのリージョンを指定します。
aws_namespace	string	AWSのインスタンスIDを指定します。
approve	boolean	このリクエストを即座に反映するかどうかを指定します。省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

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

hosts.deleteホスト設定の削除

hosts.deleteは、ホスト設定を削除するためのメソッドです。

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

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

リクエストパラメータ

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

レスポンスカラム

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

hosts.existホスト設定の存在確認

hosts.existは、指定したホスト設定が存在するかを確認するためのメソッドです。

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

リクエストパラメータ

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

レスポンスカラム

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

hosts.getホスト設定の取得

hosts.getは、ホスト設定を取得するためのメソッドです。

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

リクエストパラメータ

カラム名称	型	概要
host_name	string	ホストIDを指定します。
key	string	検索するホスト設定を指定します。空欄を指定した場合、全てのホスト設定を取得します。
limit	integer	検索時に取得する件数を指定します。省略時は、全件が取得されます。
offset	integer	取得開始するホスト設定の行数を指定します。省略時は、0が指定されます。

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

レスポンスカラム

カラム名称	型	概要
id	string	内部管理用のID
host_name	string	ホストID
alias	string	ホスト名称
address	string	IPアドレス/FQDN
macaddress	string	MACアドレス
parents	string	親ホスト
type	string	機器種別 server 物理サーバ router ルータ switch スイッチ hyper-v Hyper-V aws AWS vm 仮想サーバ
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	監視時間帯
obsess_over_host	boolean	分散監視送信機能 true 有効 false 無効
check_freshness	boolean	フレッシュネスチェック true 有効 false 無効
freshness_threshold	integer	フレッシュネスしきい値
event_handler_enabled	boolean	イベントハンドラ true 有効 false 無効
event_handler	null	イベントハンドラコマンド
low_flap_threshold	string	フラッピング検出の低しきい値
high_flap_threshold	string	フラッピング検出の高しきい値
flap_detection_enabled	boolean	フラッピング検出 true 有効 false 無効
flap_detection_options	array	フラッピング検出の対象 up ステータスUP状態を検出対象にするか true 有効 false 無効 down ステータスDOWN状態を検出対象にするか true 有効 false 無効 unreachable ステータスUNREACHABLE状態を検出対象にするか 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	null	通知先のユーザグループ
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	通知及びエスカレーションの時間帯
notification_options 3.0.9 - 3.8.0	array	通知及びエスカレーションの対象 up ステータスUPの通知を有効か true 有効 false 無効 down ステータスDOWNの通知を有効か true 有効 false 無効 unreachable ステータスUNREACHABLEの通知を有効か true 有効 false 無効 flap フラップ通知を有効か true 有効 false 無効 downtime ダウンタイムの通知を有効か true 有効 false 無効
notifications_enabled	boolean	通知及びエスカレーション機能 true 有効 false 無効
stalking_options	array	状態追跡オプション up ステータスUPを追跡するか true 追跡する false 追跡しない down ステータスDOWNを追跡するか true 追跡する false 追跡しない unreachable ステータスUNREACHABLEを追跡するか true 追跡する false 追跡しない
icon	string	アイコンID
snmp_version	string	SNMPのバージョン 1 SNMP Version 1 2c SNMP Version 2c 3 SNMP Version 3
snmp_port 3.8.0 以降	SNMPのポート番号
snmp_community	string	SNMPのコミュニティ名/認証ユーザ名
snmp_security_level	string	SNMPv3のセキュリティレベル authPriv 認証も暗号化もする authNoPriv 認証するが暗号化はしない
snmp_authtype	string	SNMPv3の認証タイプ SHA SHAを使用 MD5 MD5を使用
snmp_user	string	SNMPv3の認証パスワード
snmp_protocol	string	SNMPv3の暗号化プロトコル AES AESを使用 DES DESを使用
snmp_pass	string	SNMPv3の暗号化パスワード
wmi_user	string	WMIのアカウント
wmi_pass	string	WMIのパスワード
aws_access	string	AWSのアクセスキー
aws_secret	string	AWSのシークレットキー
aws_region	string	AWSのリージョン
aws_namespace	string	AWSのインスタンスID
_uuid 3.7.0 以降	ホストの一意な識別番号
hostgroups	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
display_name	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
contacts	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
notes	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
notes_url	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
action_url	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
vrml_image	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
statusmap_image	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
2d_coords	null	現在のX-MONでは使用されていない情報のため、空値が返されます。
3d_coords	null	現在のX-MONでは使用されていない情報のため、空値が返されます。

hosts.updateホスト設定の更新

hosts.updateは、既存のホスト設定を編集するためのメソッドです。

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

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

リクエストパラメータ

カラム名称	型	概要
host_name 必須	string	ホストIDを指定します。
package	array	適用させる監視パッケージのIDを指定します。このカラムを指定する際は、approveカラムを省略またはtrueとする必要があります。
alias	string	ホスト名称を指定します。
address	string	IPアドレス/FQDNを指定します。
macaddress	string	MACアドレスを指定します。
parents	array	親ホストを指定します。
type	string	機器種別を指定します。 server 物理サーバ router ルータ switch スイッチ hyper-v Hyper-V aws AWS vm 仮想サーバ
check_command	string	ホスト監視用コマンドを指定します。指定する監視コマンドのIDは、csvで指定する値と共通です。
check_command_param	object	ホスト監視用コマンドの引数を指定します。 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_host	boolean	分散監視送信機能を指定します。 true 有効にする false 無効にする
check_freshness	boolean	フレッシュネスチェックを指定します。 true 有効にする false 無効にする
freshness_threshold	integer	フレッシュネスしきい値を指定します。
event_handler_enabled	boolean	イベントハンドラを指定します。 true 有効にする false 無効にする
event_handler	string	イベントハンドラコマンドを指定します。
low_flap_threshold	float	フラッピング検出の低しきい値を指定します。
high_flap_threshold	float	フラッピング検出の高しきい値を指定します。
flap_detection_enabled	boolean	フラッピング検出を指定します。 true 有効にする false 無効にする
flap_detection_options	object	フラッピング検出の対象を指定します。 up ステータスUP状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする down ステータスDOWN状態を検出対象にするかどうかを指定します。 true 有効にする false 無効にする unreachable ステータスUNREACHABLE状態を検出対象にするかどうかを指定します。 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	通知及びエスカレーションの対象を指定します。 up ステータスUPの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする down ステータスDOWNの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする unreachable ステータスUNREACHABLEの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする flap フラップ通知を有効にするかどうかを指定します。 true 有効にする false 無効にする downtime ダウンタイムの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする
notifications_enabled	boolean	通知及びエスカレーション機能を指定します。 true 有効にする false 無効にする
stalking_options	object	状態追跡オプションを指定します。 up ステータスUPを追跡するかどうかを指定します。 true 追跡する false 追跡しない down ステータスDOWNを追跡するかどうかを指定します。 true 追跡する false 追跡しない unreachable ステータスUNREACHABLEを追跡するかどうかを指定します。 true 追跡する false 追跡しない
icon	string	ホストのアイコンを指定します。アイコンIDを指定してください。
snmp_version	string	SNMPのバージョンを指定します。 1 SNMP Version 1 2c SNMP Version 2c 3 SNMP Version 3
snmp_port 3.8.0 以降	string	SNMPのポート番号を指定します。
snmp_community	string	SNMPのコミュニティ名を指定します。 SNMPv3の場合は、認証ユーザ名を指定します。
snmp_security_level	string	SNMPv3のセキュリティレベルを指定します。 authPriv 認証も暗号化もする authNoPriv 認証するが暗号化はしない
snmp_authtype	string	SNMPv3の認証タイプを指定します。 SHA SHAを使用 MD5 MD5を使用
snmp_user	string	SNMPv3の認証パスワードを指定します。
snmp_protocol	string	SNMPv3の暗号化プロトコルを指定します。 AES AESを使用 DES DESを使用
snmp_pass	string	SNMPv3の暗号化パスワードを指定します。
wmi_user	string	WMIのアカウントを指定します。
wmi_pass	string	WMIのパスワードを指定します。
aws_access	string	AWSのアクセスキーを指定します。
aws_secret	string	AWSのシークレットキーを指定します。
aws_region	string	AWSのリージョンを指定します。
aws_namespace	string	AWSのインスタンスIDを指定します。
approve	boolean	このリクエストを即座に反映するかどうかを指定します。省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

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