Documentation

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

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.

Examples

Propagating host group permissions and tag filters to its subgroups.

Propagate host group permissions and tag filters to its subgroups.

Request:

{
           "jsonrpc": "2.0",
           "method": "hostgroup.propagate",
           "params": {
               "groups": [
                   {
                       "groupid": "6"
                   }
               ],
               "permissions": true,
               "tag_filters": true
           },
           "auth": "f223adf833b2bf2ff38574a67bba6372",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "groupids": [
                   "6",
               ]
           },
           "id": 1
       }

See also

Source

CHostGroup::propagate() in ui/include/classes/api/services/CHostGroup.php.