trusty (3) Zabbix::API::UserGroup.3pm.gz

Provided by: libzabbix-api-perl_0.009-1_all bug

NAME

       Zabbix::API::UserGroup -- Zabbix usergroup objects

SYNOPSIS

         use Zabbix::API::UserGroup;

         my $group = $zabbix->fetch(...);

         $group->delete;

DESCRIPTION

       Handles CRUD for Zabbix usergroup objects.

       This is a very simple subclass of "Zabbix::API::CRUDE".  Only the required methods are implemented (and
       in a very simple fashion on top of that).

METHODS

       name()
           Accessor for the usergroup's name (the "name" attribute); returns the empty string if no name is set,
           for instance if the usergroup has not been created on the server yet.

       users()
           Mutator for the usergroup's users.

       push()
           This method handles extraneous "user => Zabbix::API::User" attributes in the users array,
           transforming them into "userid" attributes, and pushing the users to the server if they don't exist
           already.  The original user attributes are kept but hidden from the "CRUDE" "push" method, and
           restored after the "pull" method is called.

           This means you can put "Zabbix::API::User" objects in your data and the module will Do The Right
           Thing (assuming you agree with my definition of the Right Thing).  Users that have been created this
           way will not be removed from the server if they are removed from the graph, however.

           Overriden from "Zabbix::API::CRUDE".

SEE ALSO

       Zabbix::API::CRUDE.

AUTHOR

       Fabrice Gabolde <fabrice.gabolde@uperto.com>

       Copyright (C) 2013 SFR

       This library is free software; you can redistribute it and/or modify it under the terms of the GPLv3.