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/drules.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, Drules, Graphs, HostGroups, Hosts, HttpError, HttpTests, Items, Maintenance, Mediatypes, Proxies, Screens, Scripts, Server, Templates, Triggers, Usergroups, Usermacros, Users, ValueMaps

Constant Summary collapse

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


68
69
70
 
# File 'lib/zabbixapi.rb', line 68

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

Instance Attribute Details

#client ⇒ ZabbixApi::Client (readonly)

Returns:



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

def client
  @client
end

Class Method Details

.connect(options = {}) ⇒ ZabbixApi

Initializes a new ZabbixApi object

Parameters:

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

Returns:



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

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

.current ⇒ ZabbixApi

Returns:



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

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

Instance Method Details

#actions ⇒ ZabbixApi::Actions

Returns:



73
74
75
 
# File 'lib/zabbixapi.rb', line 73

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

#applications ⇒ ZabbixApi::Applications

Returns:



78
79
80
 
# File 'lib/zabbixapi.rb', line 78

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

#configurations ⇒ ZabbixApi::Configurations

Returns:



83
84
85
 
# File 'lib/zabbixapi.rb', line 83

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

#drules ⇒ ZabbixApi::Drules

Returns:



173
174
175
 
# File 'lib/zabbixapi.rb', line 173

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

#graphs ⇒ ZabbixApi::Graphs

Returns:



88
89
90
 
# File 'lib/zabbixapi.rb', line 88

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

#hostgroups ⇒ ZabbixApi::HostGroups

Returns:



93
94
95
 
# File 'lib/zabbixapi.rb', line 93

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

#hosts ⇒ ZabbixApi::Hosts

Returns:



98
99
100
 
# File 'lib/zabbixapi.rb', line 98

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

#httptests ⇒ ZabbixApi::HttpTests

Returns:



103
104
105
 
# File 'lib/zabbixapi.rb', line 103

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

#items ⇒ ZabbixApi::Items

Returns:



108
109
110
 
# File 'lib/zabbixapi.rb', line 108

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

#logout ⇒ Boolean

Invalidate current authentication token

Returns:

  • (Boolean) 


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

def logout
  @client.logout
end

#maintenance ⇒ ZabbixApi::Maintenance

Returns:



113
114
115
 
# File 'lib/zabbixapi.rb', line 113

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

#mediatypes ⇒ ZabbixApi::Mediatypes

Returns:



118
119
120
 
# File 'lib/zabbixapi.rb', line 118

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

#proxies ⇒ ZabbixApi::Proxies

Returns:



123
124
125
 
# File 'lib/zabbixapi.rb', line 123

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

#query(data) ⇒ Hash

Executes an API request directly using a custom query

Parameters:

  • data (Hash)

Returns:

  • (Hash) 


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

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

#screens ⇒ ZabbixApi::Screens

Returns:



128
129
130
 
# File 'lib/zabbixapi.rb', line 128

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

#scripts ⇒ ZabbixApi::Scripts

Returns:



133
134
135
 
# File 'lib/zabbixapi.rb', line 133

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

#server ⇒ ZabbixApi::Server

Returns:



138
139
140
 
# File 'lib/zabbixapi.rb', line 138

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

#templates ⇒ ZabbixApi::Templates

Returns:



143
144
145
 
# File 'lib/zabbixapi.rb', line 143

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

#triggers ⇒ ZabbixApi::Triggers

Returns:



148
149
150
 
# File 'lib/zabbixapi.rb', line 148

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

#usergroups ⇒ ZabbixApi::Usergroups

Returns:



153
154
155
 
# File 'lib/zabbixapi.rb', line 153

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

#usermacros ⇒ ZabbixApi::Usermacros

Returns:



158
159
160
 
# File 'lib/zabbixapi.rb', line 158

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

#users ⇒ ZabbixApi::Users

Returns:



163
164
165
 
# File 'lib/zabbixapi.rb', line 163

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

#valuemaps ⇒ ZabbixApi::ValueMaps

Returns:



168
169
170
 
# File 'lib/zabbixapi.rb', line 168

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