icinga2 0.7.0.1 → 0.8.1.2

data/doc/hostgroups.md

@@ -1,22 +1,37 @@
 # Icinga2 - Hostgroups
 
 
-## add
-    add_hostgroup()
+## <a name="add-hostgroup"></a>add a hostgroup
+    add_hostgroup( params )
 
+### Example
+    @icinga.add_hostgroup(host_group: 'foo', display_name: 'FOO')
 
-## delete
-    delete_hostgroup()
 
+## <a name="delete-hostgroup"></a>delete a hostgroup
+    delete_hostgroup( params )
 
-## list
+### Example
+    @icinga.delete_hostgroup(host_group: 'foo')
 
-### named
-    hostgroups()
 
-### all
-    hostgroups()
+## <a name="list-hostgroups"></a>list hostgroups
 
+### list named hostgroup
+    hostgroups( params )
 
-## check
-    exists_hostgroup()
+#### Example
+    @icinga.hostgroups(host_group: 'linux-servers')
+
+### list all hostgroups
+    hostgroups
+
+### Example
+    @icinga.hostgroups
+
+
+## <a name="usergroup-exists"></a>check if the hostgroup exists
+    exists_hostgroup?( hostgroup )
+
+### Example
+    @icinga.exists_hostgroup?('linux-servers')

data/doc/hosts.md

@@ -1,34 +1,107 @@
 # Icinga2 - Hosts
 
-## add
-    vars = {
-      'aws' => false
+## <a name="add-host"></a>add a host
+    add_host( params )
+
+### Example
+    param = {
+      host: 'foo',
+      fqdn: 'foo.bar.com',
+      display_name: 'test node',
+      max_check_attempts: 5,
+      notes: 'test node'
     }
+    @icinga.add_host(param)
+
+
+## <a name="delete-host"></a>delete a host
+    delete_host( params )
+
+### Example
+    @icinga.delete_host(host: 'foo')
+
+
+## <a name="list-hosts"></a>list hosts
+
+### list a named host
+    hosts( params )
+
+#### Example
+    @icinga.host(host: 'icinga2')
+
+### list all hosts
+    hosts
+
+#### Example
+    @icinga.hosts
+
+
+## <a name="host-exists"></a>check if the host exists
+    exists_host?( host_name )
+
+### Example
+    @icinga.exists_host?('icinga2')
+
 
-    addHost( 'foo-bar.lan', vars )
+## <a name="list-host-objects"></a>get host objects
+    host_objects( params )
 
-## delete
-    deleteHost( 'foo-bar.lan' )
+### Example
+    @icinga.host_objects(attrs: ['name', 'state'])
 
-## list
 
-### named
-    hosts( 'foo-bar.lan' )
+## <a name="hosts-adjusted"></a>adjusted hosts state
+    hosts_adjusted
 
-### all
-    hosts()
+### Example
+    @icinga.cib_data
+    @icinga.host_objects
+    warning, critical, unknown = @icinga.hosts_adjusted.values
 
-## check
-    existsHost()
+or
+    h = @icinga.hosts_adjusted
+    down = h.dig(:down_adjusted)
 
-##
-    host_objects
 
-##
+## <a name="count-hosts-with-problems"></a>count of hosts with problems
+    count_hosts_with_problems
+
+### Example
+    @icinga.count_hosts_with_problems
+
+
+## <a name="list-hosts-with-problems"></a>a hash of hosts with problems
+    list_hosts_with_problems( max_items )
+
+### Example
+    @icinga.list_hosts_with_problems
+    @icinga.list_hosts_with_problems( 10 )
+
+
+## <a name="count-all-hosts"></a>count of all hosts
+    hosts_all
+
+### Example
+    @icinga.host_objects
+    @icinga.hosts_all
+
+
+## <a name="count-host-problems"></a>count all hosts with problems (down, warning, unknown state)
     host_problems
 
-##
-    problem_hosts
+### Example
+    @icinga.host_objects
+    all, down, critical, unknown = @icinga.host_problems.values
+
+or
+    p = @icinga.host_problems
+    down = h.dig(:down)
+
+
+## <a name="host-severity"></a>(protected) calculate a host severity
+    host_severity( params )
+
+original code are from [Icinga Web2](/modules/monitoring/library/Monitoring/Backend/Ido/Query/ServicestatusQuery.php)
 
-##
-    host_severity
+### Example
+    host_severity( {'attrs' => { 'state' => 0.0, 'acknowledgement' => 0.0, 'downtime_depth' => 0.0 } } )

data/doc/index.html

@@ -60,16 +60,27 @@
       <div id="content"><div id='filecontents'>
 <h1 id="label-ruby-icinga2">ruby-icinga2</h1>
 
-<p>Small Ruby Class for the Icinga2 API</p>
+<p>Ruby Class for the Icinga2 API</p>
 
 <h2 id="label-Requirements">Requirements</h2>
+<ul><li>
+<p>ruby version ~&gt; 2.3</p>
+</li><li>
+<p>rest-client ~&gt; 2.0</p>
+</li><li>
+<p>openssl ~&gt; 2.0</p>
+</li><li>
+<p>json ~&gt; 2.1</p>
+</li></ul>
+
+<h2 id="label-install">install</h2>
 
-<pre class="code ruby"><code class="ruby">gem install rest-client --no-rdoc --no-ri
-gem install json --no-rdoc --no-ri</code></pre>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_icinga2'>icinga2</span>
+</code></pre>
 
 <h2 id="label-usage">usage</h2>
 
-<p>create an instance and get information about the Icinga2 Server</p>
+<p>create an instance</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='lbrace'>{</span>
   <span class='symbol'>:icinga</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
@@ -84,141 +95,183 @@ gem install json --no-rdoc --no-ri</code></pre>
   <span class='rbrace'>}</span>
 <span class='rbrace'>}</span>
 
-<span class='id identifier rubyid_i'>i</span> <span class='op'>=</span> <span class='const'>Icinga</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_config'>config</span> <span class='rparen'>)</span>
-<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_application_data'>application_data</span><span class='lparen'>(</span><span class='rparen'>)</span>
+<span class='ivar'>@icinga</span> <span class='op'>=</span> <span class='const'>Icinga</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_config'>config</span> <span class='rparen'>)</span>
 </code></pre>
 
 <h2 id="label-Status">Status</h2>
 
 <p>supports the following API Calls:</p>
 <ul><li>
-<p><a href="doc/status.md">Users</a></p>
+<p><a href="doc/users.md">Users</a></p>
 <ul><li>
-<p>application_data</p>
+<p><a href="doc/users.md#add-user">add user</a></p>
 </li><li>
-<p>cib_data</p>
+<p><a href="doc/users.md#delete-dser">delete user</a></p>
 </li><li>
-<p>api_listener</p>
+<p><a href="doc/users.md#list-users">list users</a></p>
 </li><li>
-<p>application_data</p>
+<p><a href="doc/users.md#user-exists">check if user exists</a></p>
 </li><li>
-<p>cib_data</p>
+<p><a href="doc/users.md#add-user">add user</a></p>
 </li><li>
-<p>api_listener</p>
-</li></ul>
+<p><a href="doc/users.md#delete-dser">delete user</a></p>
 </li><li>
-<p><a href="doc/users.md">Users</a></p>
-<ul><li>
-<p>add_user( params = {} )</p>
+<p><a href="doc/users.md#list-users">list users</a></p>
 </li><li>
-<p>delete_user( params = {} )</p>
-</li><li>
-<p>users( params = {} )</p>
-</li><li>
-<p>exists_user?( name )</p>
+<p><a href="doc/users.md#user-exists">check if user exists</a></p>
 </li></ul>
 </li><li>
 <p><a href="doc/usergroups.md">Usergroups</a></p>
 <ul><li>
-<p>add_usergroup( params = {} )</p>
+<p><a href="doc/usergroups.md#add-usergroup">add usergroup</a></p>
 </li><li>
-<p>delete_usergroup( params = {} )</p>
+<p><a href="doc/usergroups.md#delete-usergroup">delete usergroup</a></p>
 </li><li>
-<p>usergroups( params = {} )</p>
+<p><a href="doc/usergroups.md#list-usergroups">list usergroups</a></p>
 </li><li>
-<p>exists_usergroup?( name )</p>
+<p><a href="doc/usergroups.md#usergroup-exists">check if usergroup exists</a></p>
 </li></ul>
 </li><li>
 <p><a href="doc/hosts.md">Hosts</a></p>
 <ul><li>
-<p>add_host( params = {} )</p>
+<p><a href="doc/hosts.md#add-host">add host</a></p>
+</li><li>
+<p><a href="doc/hosts.md#delete-host">delete host</a></p>
 </li><li>
-<p>delete_host( params = {} )</p>
+<p><a href="doc/hosts.md#list-hosts">list hosts</a></p>
 </li><li>
-<p>hosts( params = {} )</p>
+<p><a href="doc/hosts.md#host-exists">check if host exists</a></p>
 </li><li>
-<p>exists_host?( name )</p>
+<p><a href="doc/hosts.md#list-host-objects">list host objects</a></p>
 </li><li>
-<p>host_objects( params = {} )</p>
+<p><a href="doc/hosts.md#hosts-adjusted">adjusted hosts state</a></p>
 </li><li>
-<p>host_problems</p>
+<p><a href="doc/hosts.md#count-hosts-with-problems">count of hosts with
+problems</a></p>
 </li><li>
-<p>problem_hosts( max_items = 5 )</p>
+<p><a href="doc/hosts.md#list-hosts-with-problems">list of hosts with
+problems</a></p>
 </li><li>
-<p>host_severity( host )</p>
+<p><a href="doc/hosts.md#count-all-hosts">count of all hosts</a></p>
+</li><li>
+<p><a href="doc/hosts.md#count-host-problems">count hosts with problems</a></p>
+</li><li>
+<p>calculate host severity (protected)</p>
 </li></ul>
 </li><li>
 <p><a href="doc/hostgroups.md">Hostgroups</a></p>
 <ul><li>
-<p>add_hostgroup(params = {})</p>
+<p><a href="doc/hostgroups.md#add-usergroup">add hostgroup</a></p>
 </li><li>
-<p>delete_hostgroup(params = {})</p>
+<p><a href="doc/hostgroups.md#delete-usergroup">delete hostgroup</a></p>
 </li><li>
-<p>hostgroups(params = {})</p>
+<p><a href="doc/hostgroups.md#list-usergroups">list hostgroups</a></p>
 </li><li>
-<p>exists_hostgroup?(name)</p>
+<p><a href="doc/hostgroups.md#usergroup-exists">check if hostgroup exists</a></p>
 </li></ul>
 </li><li>
 <p><a href="doc/services.md">Services</a></p>
 <ul><li>
-<p>add_services( host, services = {} )</p>
+<p><a href="doc/services.md#add-service">add service</a> (<strong>this
+function is not operable yet!</strong>)</p>
+</li><li>
+<p><a href="doc/services.md#delete-service">delete service</a> (<strong>not
+yet implemented</strong>)</p>
+</li><li>
+<p><a href="doc/services.md#add-service">add service</a> (<strong>this
+function is not operable yet!</strong>)</p>
+</li><li>
+<p><a href="doc/services.md#unhandled-services">list unhandled services</a>
+(<strong>not yet implemented</strong>)</p>
+</li><li>
+<p><a href="doc/services.md#list-services">list services</a></p>
+</li><li>
+<p><a href="doc/services.md#service-exists">check if service exists</a></p>
 </li><li>
-<p>unhandled_services( params = {} )</p>
+<p><a href="doc/services.md#list-service-objects">list service objects</a></p>
 </li><li>
-<p>services( params = {} )</p>
+<p><a href="doc/services.md#services-adjusted">adjusted service state</a></p>
 </li><li>
-<p>exists_service?( params = {} )</p>
+<p><a href="doc/services.md#count-services-with-problems">count services with
+problems</a></p>
 </li><li>
-<p>service_objects( params = {} )</p>
+<p><a href="doc/services.md#list-services-with-problems">list of services with
+problems</a></p>
 </li><li>
-<p>service_problems</p>
+<p><a href="doc/services.md#update-host">update host</a> (<strong>this
+function is not operable yet!</strong>)</p>
 </li><li>
-<p>problem_services( max_items = 5 )</p>
+<p><a href="doc/services.md#count-all-services">count of all services</a></p>
 </li><li>
-<p>update_host( hash, host )</p>
+<p><a href="doc/services.md#count-all-services-handled">count all services
+with handled problems</a></p>
 </li><li>
-<p>service_severity( service )</p>
+<p>calculate service severity (protected)</p>
 </li></ul>
 </li><li>
 <p><a href="doc/servicegroups.md">Servicegroups</a></p>
 <ul><li>
-<p>add_servicegroup( params = {} )</p>
+<p><a href="doc/servicegroups.md#add-servicegroup">add servicegroup</a></p>
 </li><li>
-<p>delete_servicegroup( params = {} )</p>
+<p><a href="doc/servicegroups.md#delete-servicegroup">delete servicegroup</a></p>
 </li><li>
-<p>servicegroups( params = {} )</p>
+<p><a href="doc/servicegroups.md#list-servicegroup">list servicegroups</a></p>
 </li><li>
-<p>exists_servicegroup?( name )</p>
+<p><a href="doc/servicegroups.md#servicegroup-exists">check if servicegroup
+exists</a></p>
 </li></ul>
 </li><li>
 <p><a href="doc/downtimes.md">Downtimes</a></p>
 <ul><li>
-<p>add_downtime( params = {} )</p>
+<p><a href="doc/downtimes.md#add-downtime">add downtime</a></p>
 </li><li>
-<p>downtimes( params = {} )</p>
+<p><a href="doc/downtimes.md#list-downtimes">list downtimes</a></p>
 </li></ul>
 </li><li>
 <p><a href="doc/notifications.md">Notifications</a></p>
 <ul><li>
-<p>enable_host_notification( host )</p>
+<p><a href="doc/notifications.md#enable-host-notification">enable host
+notifications</a></p>
 </li><li>
-<p>disable_host_notification( host )</p>
+<p><a href="doc/notifications.md#disable-host-notification">disable host
+notifications</a></p>
 </li><li>
-<p>enable_service_notification( params = {} )</p>
+<p><a href="doc/notifications.md#enable-service-notification">enable service
+notifications</a></p>
 </li><li>
-<p>disable_service_notification( host )</p>
+<p><a href="doc/notifications.md#disable-service-notification">disable service
+notifications</a></p>
 </li><li>
-<p>enable_hostgroup_notification( group )</p>
+<p><a href="doc/notifications.md#enable-hostgroup-notification">enable
+hostgroup notifications</a></p>
 </li><li>
-<p>disable_hostgroup_notification( group )</p>
+<p><a href="doc/notifications.md#disable-hostgroup-notification">disable
+hostgroup notifications</a></p>
+</li><li>
+<p><a href="doc/notifications.md#list-notifications">list all
+notifications</a></p>
+</li><li>
+<p>host notification (protected)</p>
+</li><li>
+<p>hostgroup notification (protected)</p>
+</li><li>
+<p>service notification (protected)</p>
+</li></ul>
+</li><li>
+<p><a href="doc/statistics.md">Statistics</a></p>
+<ul><li>
+<p><a href="doc/statistics.md#stats-avg">statistic data for latence and
+execution time</a></p>
 </li><li>
-<p>notifications( params = {} )</p>
+<p><a href="doc/statistics.md#stats-interval">statistic data for interval
+data</a></p>
 </li><li>
-<p>host_notification( params = {} )</p>
+<p><a href="doc/statistics.md#stats-services">statistic data for services</a></p>
 </li><li>
-<p>hostgroup_notification( params = {} )</p>
+<p><a href="doc/statistics.md#stats-hosts">statistic data for hosts</a></p>
 </li><li>
-<p>service_notification( params = {} )</p>
+<p><a href="doc/statistics.md#stats-work-queue">queue statistics from the
+api</a></p>
 </li></ul>
 </li></ul>
 
@@ -238,8 +291,7 @@ Successfully installed icinga2-0.6.0
 
 <h2 id="label-test+via+CLI">test via CLI</h2>
 
-<pre class="code ruby"><code class="ruby">#$ export ICINGA_HOST=localhost ; export ICINGA_API_USER=root ; export ICINGA_API_PASSWORD=icinga
-#$ irb
+<pre class="code ruby"><code class="ruby">#$ irb
 2.3.0 :001 &gt; require &#39;icinga2&#39;
  =&gt; true
 2.3.0 :002 &gt; config = { :icinga =&gt; { :host =&gt; &#39;localhost&#39;, :api =&gt; { :user =&gt; &#39;root&#39;, :pass =&gt; &#39;icinga&#39; } } }
@@ -268,7 +320,7 @@ feature&#39;</code>)</p>
 </div></div>
 
       <div id="footer">
-  Generated on Wed Jun 28 05:55:20 2017 by
+  Generated on Tue Aug 22 11:29:51 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.4).
 </div>