Class: ZabbixManager::Users

Inherits:
Basic
  • Object
show all
Defined in:
lib/zabbix_manager/classes/users.rb

Instance Method Summary collapse

Methods inherited from Basic

#add, #all, #create, #create_or_update, #create_raw, #default_options, #delete, #delete_raw, #destroy, #dump_by_id, #get, #get_full_data, #get_hostgroup_ids, #get_id, #get_or_create, #get_or_create_hostgroups, #get_raw, #hash_equals?, #initialize, #log, #merge_params, #mojo_update, #normalize_array, #normalize_hash, #parse_keys, #symbolize_keys, #update, #update_raw

Constructor Details

This class inherits a constructor from ZabbixManager::Basic

Instance Method Details

#add_medias(data) ⇒ Integer

Add media to users using Zabbix API

Parameters:

  • data (Hash) —

    Needs to include userids and media to mass add media to users

Returns:

  • (Integer) —

    Zabbix object id (media)

Raises:

  • (ManagerError) —

    Error returned when there is a problem with the Zabbix API call.

  • (HttpError) —

    Error raised when HTTP status from Zabbix Server response is not a 200 OK.



52
53
54
 
# File 'lib/zabbix_manager/classes/users.rb', line 52

def add_medias(data)
  medias_helper(data, "update")
end

#identify ⇒ String

The id field name used for identifying specific User objects via Zabbix API

Returns:

  • (String) 


29
30
31
 
# File 'lib/zabbix_manager/classes/users.rb', line 29

def identify
  "alias"
end

#key ⇒ String

The key field name used for User objects via Zabbix API

Returns:

  • (String) 


22
23
24
 
# File 'lib/zabbix_manager/classes/users.rb', line 22

def key
  "userid"
end

#keys ⇒ String

The keys field name used for User objects via Zabbix API

Returns:

  • (String) 


15
16
17
 
# File 'lib/zabbix_manager/classes/users.rb', line 15

def keys
  "userids"
end

#medias_helper(data, action) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/zabbix_manager/classes/users.rb', line 33

def medias_helper(data, action)
  result = @client.api_request(
    method: "user.#{action}",
    params: data[:userids].map do |t|
      {
        userid: t,
        user_medias: data[:media]
      }
    end
  )
  result ? result["userids"][0].to_i : nil
end

#method_name ⇒ String

The method name used for interacting with Users via Zabbix API

Returns:

  • (String) 


8
9
10
 
# File 'lib/zabbix_manager/classes/users.rb', line 8

def method_name
  "user"
end

#update_medias(data) ⇒ Integer

Update media for users using Zabbix API

Parameters:

  • data (Hash) —

    Needs to include userids and media to mass update media for users

Returns:

  • (Integer) —

    Zabbix object id (user)

Raises:

  • (ManagerError) —

    Error returned when there is a problem with the Zabbix API call.

  • (HttpError) —

    Error raised when HTTP status from Zabbix Server response is not a 200 OK.



62
63
64
 
# File 'lib/zabbix_manager/classes/users.rb', line 62

def update_medias(data)
  medias_helper(data, "update")
end