Documentation
Table of Contents
hostgroup.propagate
Description
object hostgroup.propagate(object parameters)
This method allows to apply permissions and tag filters to all hosts groups' subgroups.
This method is only available to Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.
Parameters
(object) Parameters defining the desired output.
The method supports the following parameters.
| Parameter | Type | Description |
|---|---|---|
| groups (required) |
object/array | Host groups to propagate. The host groups must have the groupid property defined. |
| permissions | boolean | Set true if need to propagate permissions. |
| tag_filters | boolean | Set true if need to propagate tag filters. |
At least one parameter permissions or tag_filters is required.
Return values
(object) Returns an object containing the IDs of the propagated host groups under the groupids property.
例
ホストグループの権限とタグフィルターをそのサブグループに伝達します。
ホストグループの権限とタグフィルターをそのサブグループに伝達します。
リクエスト :
{
"jsonrpc": "2.0",
"method": "hostgroup.propagate",
"params": {
"groups": [
{
"groupid": "6"
}
],
"permissions": true,
"tag_filters": true
},
"id": 1
}レスポンス :
参照
ソース
CHostGroup::propagate() in ui/include/classes/api/services/CHostGroup.php.