hostgroupオブジェクトは、X-MONのホストグループ設定を操作するオブジェクトです。
hostgroup.addは、ホストグループ設定を新規作成するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| hostgroup_name 必須 | string |
ホストグループIDを指定します。 |
| alias | string |
ホストグループの名称を指定します。 省略時には、hostgroup_nameと同じ値が指定されます。 |
| members 必須 | array |
ホストグループとして設定するホストIDを指定します。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
hostgroup.existは、指定したホストグループ設定が存在するかを確認するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
| カラム名称 | 型 | 概要 |
|---|---|---|
| hostgroup_name 必須 | string |
ホストグループIDを指定します。 |
このメソッドは、実行結果が boolean型で返ってきます。
hostgroup.deleteは、ホストグループ設定を削除するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| hostgroup_name 必須 | string |
ホストグループIDを指定します。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
hostgroup.getは、ホストグループ設定を取得するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
閲覧者権限のユーザは、閲覧対象ホストグループが設定されている場合、閲覧対象として許可されているホストグループ情報のみが取得されます。
| カラム名称 | 型 | 概要 |
|---|---|---|
| hostgroup_name | string | 取得するホストグループを指定します。 |
| key | string |
検索するホストグループ設定を指定します。 空欄を指定した場合、全てのホストグループ設定を取得します。 |
| limit | integer |
検索時に取得する件数を指定します。 省略時は、全件が取得されます。 |
| offset | integer |
取得開始するホストグループ設定の行数を指定します。 省略時は、0が指定されます。 |
このメソッドは、hostgroup_nameもしくはkeyのどちらかの指定が必要です。
| カラム名称 | 型 | 概要 |
|---|---|---|
| id | string |
内部管理用のID |
| hostgroup_name | string |
ホストグループID |
| alias | string |
ホストグループの名称 |
| members | array |
ホストグループに所属しているホストID |
| hostgroup_members | array |
現在のX-MONでは使用されていない情報のため、空値が返されます。 |
| notes | null |
現在のX-MONでは使用されていない情報のため、空値が返されます。 |
| notes_url | null |
現在のX-MONでは使用されていない情報のため、空値が返されます。 |
| action_url | null |
現在のX-MONでは使用されていない情報のため、空値が返されます。 |
hostgroup.updateは、既存のホストグループ設定を編集するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| hostgroup_name 必須 | string |
ホストグループIDを指定します。 |
| alias | string |
ホストグループの名称を指定します。 |
| members | array |
ホストグループとして設定するホストIDを指定します。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。