commandCheckAcknowledgeオブジェクトは、ホストやサービスの監視結果に対して、認知済みの操作を行うオブジェクトです。
cmd_acknowledge_host_problem.setは、指定したホストの監視結果に対して認知済みの設定を行います。
設定された認知済みは、現在のステータスが別のステータスに変わるまで保持されます。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
| カラム名称 | 型 | 概要 |
|---|---|---|
| host_name 必須 | string | 認知済みを設定するホストIDを指定します。 |
| sticky | boolean |
監視結果がUPになるまで認知済みの設定を保持したい場合、trueを指定します。 省略時には、falseが指定されます。 |
| notify | boolean |
認知済みが設定されたことをメールで通知する場合、trueを指定します。 省略時には、trueが指定されます。 |
| persistent | boolean |
コメント文をX-MONが再起動を行った際にも保持されるようにする場合、trueを指定します。 省略時には、trueが指定されます。 |
| comment | string |
コメントを記載します。 省略時には、「(リクエスト発行ユーザID)が処理を実行しました」が指定されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
cmd_acknowledge_svc_problem.setは、指定したサービスの監視結果に対して認知済みの設定を行います。
設定された認知済みは、現在のステータスが別のステータスに変わるまで保持されます。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
| カラム名称 | 型 | 概要 |
|---|---|---|
| host_name 必須 | string | 認知済みを設定するホストIDを指定します。 |
| service_description 必須 | string | 認知済みを設定するサービスIDを指定します。 |
| sticky | boolean |
監視結果がUPになるまで認知済みの設定を保持したい場合、trueを指定します。 省略時には、falseが指定されます。 |
| notify | boolean |
認知済みが設定されたことをメールで通知する場合、trueを指定します。 省略時には、trueが指定されます。 |
| persistent | boolean |
コメント文をX-MONが再起動を行った際にも保持されるようにする場合、trueを指定します。 省略時には、trueが指定されます。 |
| comment | string |
コメントを記載します。 省略時には、「(リクエスト発行ユーザID)が処理を実行しました」が指定されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
cmd_remove_host_acknowledgement.setは、指定したホストの認知済みの設定を解除します。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
| カラム名称 | 型 | 概要 |
|---|---|---|
| host_name 必須 | string | 認知済みを解除するホストIDを指定します。 |
このメソッドは、実行結果が boolean型で返ってきます。
cmd_remove_svc_acknowledgement.setは、指定したサービスの認知済みの設定を解除します。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
| カラム名称 | 型 | 概要 |
|---|---|---|
| host_name 必須 | string | 認知済みを解除するホストIDを指定します。 |
| service_description 必須 | string | 認知済みを解除するサービスIDを指定します。 |
このメソッドは、実行結果が boolean型で返ってきます。