Class: ZabbixApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zabbixapi.rb,
lib/zabbixapi/client.rb,
lib/zabbixapi/version.rb,
lib/zabbixapi/classes/hosts.rb,
lib/zabbixapi/classes/items.rb,
lib/zabbixapi/classes/users.rb,
lib/zabbixapi/classes/errors.rb,
lib/zabbixapi/classes/graphs.rb,
lib/zabbixapi/classes/server.rb,
lib/zabbixapi/classes/actions.rb,
lib/zabbixapi/classes/proxies.rb,
lib/zabbixapi/classes/screens.rb,
lib/zabbixapi/classes/scripts.rb,
lib/zabbixapi/basic/basic_func.rb,
lib/zabbixapi/basic/basic_init.rb,
lib/zabbixapi/classes/triggers.rb,
lib/zabbixapi/classes/unusable.rb,
lib/zabbixapi/basic/basic_alias.rb,
lib/zabbixapi/basic/basic_logic.rb,
lib/zabbixapi/classes/httptests.rb,
lib/zabbixapi/classes/templates.rb,
lib/zabbixapi/classes/valuemaps.rb,
lib/zabbixapi/classes/hostgroups.rb,
lib/zabbixapi/classes/mediatypes.rb,
lib/zabbixapi/classes/usergroups.rb,
lib/zabbixapi/classes/usermacros.rb,
lib/zabbixapi/classes/maintenance.rb,
lib/zabbixapi/classes/applications.rb,
lib/zabbixapi/classes/configurations.rb

Defined Under Namespace

Classes: Actions, ApiError, Applications, BaseError, Basic, Client, Configurations, Graphs, HostGroups, Hosts, HttpError, HttpTests, Items, Maintenance, Mediatypes, Proxies, Screens, Scripts, Server, Templates, Triggers, Usergroups, Usermacros, Users, ValueMaps

Constant Summary collapse

VERSION = 
'3.2.1'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ZabbixApi::Client

Initializes a new ZabbixApi object

Parameters:

  • options (Hash) (defaults to: {}) 


61
62
63
 
# File 'lib/zabbixapi.rb', line 61

def initialize(options = {})
  @client = Client.new(options)
end

Instance Attribute Details

#client ⇒ ZabbixApi::Client (readonly)

Returns:



34
35
36
 
# File 'lib/zabbixapi.rb', line 34

def client
  @client
end

Class Method Details

.connect(options = {}) ⇒ ZabbixApi

Initializes a new ZabbixApi object

Parameters:

  • options (Hash) (defaults to: {})

Returns:



40
41
42
 
# File 'lib/zabbixapi.rb', line 40

def self.connect(options = {})
  new(options)
end

.current ⇒ ZabbixApi

Returns:



45
46
47
 
# File 'lib/zabbixapi.rb', line 45

def self.current
  @current ||= ZabbixApi.new
end

Instance Method Details

#actions ⇒ ZabbixApi::Actions

Returns:



66
67
68
 
# File 'lib/zabbixapi.rb', line 66

def actions
  @actions ||= Actions.new(@client)
end

#applications ⇒ ZabbixApi::Applications

Returns:



71
72
73
 
# File 'lib/zabbixapi.rb', line 71

def applications
  @applications ||= Applications.new(@client)
end

#configurations ⇒ ZabbixApi::Configurations

Returns:



76
77
78
 
# File 'lib/zabbixapi.rb', line 76

def configurations
  @configurations ||= Configurations.new(@client)
end

#graphs ⇒ ZabbixApi::Graphs

Returns:



81
82
83
 
# File 'lib/zabbixapi.rb', line 81

def graphs
  @graphs ||= Graphs.new(@client)
end

#hostgroups ⇒ ZabbixApi::HostGroups

Returns:



86
87
88
 
# File 'lib/zabbixapi.rb', line 86

def hostgroups
  @hostgroups ||= HostGroups.new(@client)
end

#hosts ⇒ ZabbixApi::Hosts

Returns:



91
92
93
 
# File 'lib/zabbixapi.rb', line 91

def hosts
  @hosts ||= Hosts.new(@client)
end

#httptests ⇒ ZabbixApi::HttpTests

Returns:



96
97
98
 
# File 'lib/zabbixapi.rb', line 96

def httptests
  @httptests ||= HttpTests.new(@client)
end

#items ⇒ ZabbixApi::Items

Returns:



101
102
103
 
# File 'lib/zabbixapi.rb', line 101

def items
  @items ||= Items.new(@client)
end

#maintenance ⇒ ZabbixApi::Maintenance

Returns:



106
107
108
 
# File 'lib/zabbixapi.rb', line 106

def maintenance
  @maintenance ||= Maintenance.new(@client)
end

#mediatypes ⇒ ZabbixApi::Mediatypes

Returns:



111
112
113
 
# File 'lib/zabbixapi.rb', line 111

def mediatypes
  @mediatypes ||= Mediatypes.new(@client)
end

#proxies ⇒ ZabbixApi::Proxies

Returns:



116
117
118
 
# File 'lib/zabbixapi.rb', line 116

def proxies
  @proxies ||= Proxies.new(@client)
end

#query(data) ⇒ Hash

Executes an API request directly using a custom query

Parameters:

  • data (Hash)

Returns:

  • (Hash) 


53
54
55
 
# File 'lib/zabbixapi.rb', line 53

def query(data)
  @client.api_request(:method => data[:method], :params => data[:params])
end

#screens ⇒ ZabbixApi::Screens

Returns:



121
122
123
 
# File 'lib/zabbixapi.rb', line 121

def screens
  @screens ||= Screens.new(@client)
end

#scripts ⇒ ZabbixApi::Scripts

Returns:



126
127
128
 
# File 'lib/zabbixapi.rb', line 126

def scripts
  @scripts ||= Scripts.new(@client)
end

#server ⇒ ZabbixApi::Server

Returns:



131
132
133
 
# File 'lib/zabbixapi.rb', line 131

def server
  @server ||= Server.new(@client)
end

#templates ⇒ ZabbixApi::Templates

Returns:



136
137
138
 
# File 'lib/zabbixapi.rb', line 136

def templates
  @templates ||= Templates.new(@client)
end

#triggers ⇒ ZabbixApi::Triggers

Returns:



141
142
143
 
# File 'lib/zabbixapi.rb', line 141

def triggers
  @triggers ||= Triggers.new(@client)
end

#usergroups ⇒ ZabbixApi::Usergroups

Returns:



146
147
148
 
# File 'lib/zabbixapi.rb', line 146

def usergroups
  @usergroups ||= Usergroups.new(@client)
end

#usermacros ⇒ ZabbixApi::Usermacros

Returns:



151
152
153
 
# File 'lib/zabbixapi.rb', line 151

def usermacros
  @usermacros ||= Usermacros.new(@client)
end

#users ⇒ ZabbixApi::Users

Returns:



156
157
158
 
# File 'lib/zabbixapi.rb', line 156

def users
  @users ||= Users.new(@client)
end

#valuemaps ⇒ ZabbixApi::ValueMaps

Returns:



161
162
163
 
# File 'lib/zabbixapi.rb', line 161

def valuemaps
  @valuemaps ||= ValueMaps.new(@client)
end