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/roles.rb,
lib/zabbixapi/classes/users.rb,
lib/zabbixapi/classes/drules.rb,
lib/zabbixapi/classes/errors.rb,
lib/zabbixapi/classes/events.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/problems.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/configurations.rb

Defined Under Namespace

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

Constant Summary collapse

VERSION = 
'7.2.2'.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: {}) 


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

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

Instance Attribute Details

#client ⇒ ZabbixApi::Client (readonly)

Returns:



37
38
39
 
# File 'lib/zabbixapi.rb', line 37

def client
  @client
end

Class Method Details

.connect(options = {}) ⇒ ZabbixApi

Initializes a new ZabbixApi object

Parameters:

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

Returns:



43
44
45
 
# File 'lib/zabbixapi.rb', line 43

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

.current ⇒ ZabbixApi

Returns:



48
49
50
 
# File 'lib/zabbixapi.rb', line 48

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

Instance Method Details

#actions ⇒ ZabbixApi::Actions

Returns:



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

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

#configurations ⇒ ZabbixApi::Configurations

Returns:



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

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

#drules ⇒ ZabbixApi::Drules

Returns:



185
186
187
 
# File 'lib/zabbixapi.rb', line 185

def drules
  @drules ||= Drules.new(@client)
end

#events ⇒ ZabbixApi::Events

Returns:



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

def events
  @events ||= Events.new(@client)
end

#graphs ⇒ ZabbixApi::Graphs

Returns:



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

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

#hostgroups ⇒ ZabbixApi::HostGroups

Returns:



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

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

#hosts ⇒ ZabbixApi::Hosts

Returns:



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

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

#httptests ⇒ ZabbixApi::HttpTests

Returns:



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

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

#items ⇒ ZabbixApi::Items

Returns:



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

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

#logout ⇒ Boolean

Invalidate current authentication token

Returns:

  • (Boolean) 


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

def logout
  @client.logout
end

#maintenance ⇒ ZabbixApi::Maintenance

Returns:



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

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

#mediatypes ⇒ ZabbixApi::Mediatypes

Returns:



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

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

#problems ⇒ ZabbixApi::Problems

Returns:



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

def problems
  @problems ||= Problems.new(@client)
end

#proxies ⇒ ZabbixApi::Proxies

Returns:



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

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

#query(data) ⇒ Hash

Executes an API request directly using a custom query

Parameters:

  • data (Hash)

Returns:

  • (Hash) 


56
57
58
 
# File 'lib/zabbixapi.rb', line 56

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

#roles ⇒ ZabbixApi::Roles

Returns:



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

def roles
  @roles ||= Roles.new(@client)
end

#screens ⇒ ZabbixApi::Screens

Returns:



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

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

#scripts ⇒ ZabbixApi::Scripts

Returns:



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

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

#server ⇒ ZabbixApi::Server

Returns:



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

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

#templates ⇒ ZabbixApi::Templates

Returns:



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

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

#triggers ⇒ ZabbixApi::Triggers

Returns:



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

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

#usergroups ⇒ ZabbixApi::Usergroups

Returns:



165
166
167
 
# File 'lib/zabbixapi.rb', line 165

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

#usermacros ⇒ ZabbixApi::Usermacros

Returns:



170
171
172
 
# File 'lib/zabbixapi.rb', line 170

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

#users ⇒ ZabbixApi::Users

Returns:



175
176
177
 
# File 'lib/zabbixapi.rb', line 175

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

#valuemaps ⇒ ZabbixApi::ValueMaps

Returns:



180
181
182
 
# File 'lib/zabbixapi.rb', line 180

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