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

servicegroup オブジェクト

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

servicegroup.addサービスグループ設定の新規作成

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

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

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

リクエストパラメータ

カラム名称 型 概要
servicegroup_name　必須 string

サービスグループIDを指定します。
alias string

サービスグループ名称を指定します。

省略時には、servicegroup_nameと同じ値が指定されます。
members　必須 array

サービスグループとして設定するサービスIDおよび該当するホストIDを指定します。

カラム名称 型 概要
host_name string ホストID
service_description string サービスID
approve boolean

このリクエストを即座に反映するかどうかを指定します。

省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

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

実行例

サービスグループ CPU_GROUP の設定を新規作成する

リクエスト
{ 　"jsonrpc":"2.0", 　"method":"servicegroup.add", 　"params":{ 　　"servicegroup_name":"CPU_GROUP", 　　"alias":"CPUグループ", 　　"members":[ 　　　{ 　　　　"host_name":"X-MON", 　　　　"service_description":"CPU" 　　　}, 　　　{ 　　　　"host_name":"WEB_SERVER", 　　　　"service_description":"CPU" 　　　}, 　　　{ 　　　　"host_name":"DB_SERVER", 　　　　"service_description":"CPU" 　　　} 　　], 　　"approve":true }, 　"id":"1", 　"user_id":"admin", 　"auth_token":"0b7670bda71ac0a38e384ab7d4956d19e13655e5" }
レスポンス
{ 　jsonrpc:2.0, 　result:true, 　id:1 }

servicegroup.deleteサービスグループ設定の削除

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

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

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

リクエストパラメータ

カラム名称 型 概要
servicegroup_name 必須 string

サービスグループIDを指定します。
approve boolean

このリクエストを即座に反映するかどうかを指定します。

省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

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

servicegroup.getサービスグループ設定の取得

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

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

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

リクエストパラメータ

カラム名称 型 概要
servicegroup_name string

サービスグループIDを指定します。
key string

検索するサービスグループ設定を指定します。

空欄を指定した場合、全てのサービスグループ設定を取得します。

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

レスポンスカラム

カラム名称 型 概要
id string

内部管理用のID
servicegroup_name string

サービスグループID
alias string

サービスグループ名称
members array
カラム名称 型 概要
host_name string ホストID
service_description string サービスID
servicegroup_members array

現在のX-MONでは使用されていない情報のため、空値が返されます。
notes null

現在のX-MONでは使用されていない情報のため、nullが返されます。
notes_url null

現在のX-MONでは使用されていない情報のため、nullが返されます。
action_url null

現在のX-MONでは使用されていない情報のため、nullが返されます。

実行例

サービスグループ CPU_GROUP の設定情報を取得する

リクエスト
{ 　"jsonrpc":"2.0", 　"method":"servicegroup.get", 　"params":{"servicegroup_name":"CPU_GROUP"}, 　"id":"1", 　"user_id":"admin", 　"auth_token":"0b7670bda71ac0a38e384ab7d4956d19e13655e5" }
レスポンス
{ 　jsonrpc:2.0, 　result:{ 　　id:CPU_GROUP, 　　servicegroup_name:CPU_GROUP, 　　alias:CPUグループ, 　　members:[ 　　　{ 　　　　host_name:X-MON, 　　　　service_description:CPU 　　　}, 　　　{ 　　　　host_name:WEB_SERVER, 　　　　service_description:CPU 　　　}, 　　　{ 　　　　host_name:DB_SERVER, 　　　　service_description:CPU 　　　} 　　], 　　servicegroup_members:[ 　　　 　　], 　　notes: 　　}, 　　notes_url: 　　}, 　　action_url: 　　} 　}, 　id:1 }

servicegroup.updateサービスグループ設定の更新

servicegroup.updateは、サービスグループ設定を編集するためのメソッドです。

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

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

リクエストパラメータ

カラム名称 型 概要
servicegroup_name　必須 string

サービスグループIDを指定します。
alias string

サービスグループ名称を指定します。
members array

サービスグループとして設定するサービスIDおよび該当するホストIDを指定します。

カラム名称 型 概要
host_name string ホストID
service_description string サービスID
approve boolean

このリクエストを即座に反映するかどうかを指定します。

省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

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