op5util 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 633eb23a8f27b8e4fec8a2b91346245798125cb0
-  data.tar.gz: 96e215bea0d1036f0a0d5b6e9708477e02bcb167
+  metadata.gz: 98b7c7098263b0b79fbcc7dab53a96c1d66d9001
+  data.tar.gz: ed48f74b4482bc6d8a3e3688d7f6a5583526e1bd
 SHA512:
-  metadata.gz: 876545c14290ab04a7983d407ef1d538681b7a688bb2a59cdf77e0e646ce96a2ad9e2c5481dbbce50523677800961443108c2daa4127fff78701074535167b5b
-  data.tar.gz: 50dbac952a698fb8067550eeb4d8fd4118dd5ea3eb8af68dba63c5dbe57edd69395be0c8e11e8d3a61050138bed2cb752dbe84a94c7421ecf9eb966f8bfc88bf
+  metadata.gz: a4e6f2e3588cbbb251e67fe09ddfb4946d4b10715f3d6849d9d45699c7a610bae978e23f7d274c34f82e30afef19a58aa3d26d0f110fdaadaef316084e0da7e5
+  data.tar.gz: 837f71ec446b2151ac5c68ebf5e9ee412257fb97142dde0b0946c9e27f9937740f8b203c0923a4656d936cfa75249f2b2290fdfea3e9ab2e9f2fb809bb852bed

data/Readme.md

@@ -5,7 +5,7 @@ and want to be able to do the most common Op5 tasks without logging in
 to a web-gui?
 
 Or you want to start monitoring the newly installed hosts with Op5
-using your config management tool?
+using your ansible/chef/whatever config management tool?
 
 Those two use-cases were my biggest itches when I first started to use
 saved curl commands to interact with the REST-api and soon op5util.rb
@@ -92,14 +92,14 @@ and the other gems that op5util depends on.
 user@host:~$ sudo gem install op5util
 ```
 
-Latest version is 0.1.5, you can verify that op5util is installed correctly with:
+Latest version is 0.1.6, you can verify that op5util is installed correctly with:
 
 ``` shell
 user@host:~$ gem list --details op5util
 
 *** LOCAL GEMS ***
 
-op5util (0.1.5)
+op5util (0.1.6)
     Author: Niklas Paulsson
     Homepage: https://github.com/np422/Op5util
     License: MIT License
@@ -139,7 +139,7 @@ SYNOPSIS
     op5util [global options] command [command options] [arguments...]
 
 VERSION
-    0.1.5
+    0.1.6
 
 GLOBAL OPTIONS
     -f, --authfile=authfile - Authfile containing "username:password" used to authenticate with Op5
@@ -163,6 +163,7 @@ COMMANDS
     autocomplete   - Show instruction on howto setup tab autocomplete for op5util in your shell
     downtime       - Schedule fixed downtime for a host
     help           - Shows a list of commands or help for one command
+    hosts          - List all hosts, or detailed information about a single host
     hostgroups     - List hostgroups, optionally with member and service info, Usage examples:
                      'op5util hostgroups' to list all hostgroups, 'op5util hostgroups -l linux_hosts'
                      to list members and services for the linux_hosts hostgroup
@@ -213,6 +214,11 @@ free to leave a bug-reports or feature requests as an issue in this repo.
 
 ## Version history
 
+### 0.1.6
+
+New command 'hosts' which lists hosts, included example of ansible playbook
+in documentation.
+
 ### 0.1.5
 
 Added template for shell autocomplete of op5util command (bash/zsh)
@@ -225,3 +231,36 @@ Gemspec filespec corrected to avoid unnecessary large .gem-files.
 
 Environment variable OP5AUTHFILE possible to use instead of --authfile, check permission
 of authfile and refuse to start if readable by other than owner.
+
+## Example, use op5util with ansible
+
+Use the example below as a source of inspiration on how op5util can be used from
+an ansible playbook.
+
+In this example the variable 'hostgroups', which should be a list, will be used to
+assign hostgroups, otherwise the default hostgroup 'linux_hosts' will beassigned.
+
+``` yaml
+---
+- hosts: monitoring-clients
+  gather_facts: false
+  serial: 1
+  vars:
+    op5_user: 'user'
+    op5_password: 'password'
+    op5_server: 'op5server'
+  tasks:
+
+  - name: Check if Op5 registration is needed
+    shell: op5util -u {{ op5_user }} -p {{ op5_password }} -m {{ op5_server }} hosts
+    register: var_op5_hosts
+    delegate_to: localhost
+
+  - set_fact:
+      op5_hosts: "{{ var_op5_hosts.stdout_lines }}"
+
+  - name: Register client with Op5 monitoring server
+    shell: op5util -u {{ op5_user }} -p {{ op5_password }} -m {{ op5_server }} add -g {{ hostgroups | default([ 'linux_hosts' ])  | join(' -g ') }} {{ inventory_hostname }}
+    delegate_to: localhost
+    when: inventory_hostname not in op5_hosts
+```

data/bin/op5util

@@ -156,6 +156,17 @@ command :hostgroups do |c|
   end
 end
 
+desc 'List all hosts, or detailed information about a single host'
+arg_name 'host'
+command :hosts do |c|
+  c.desc 'Show detailed information'
+  c.switch [:l, :long]
+
+  c.action do |_global_options, options, args|
+    monitor.list_hosts(args[0], options)
+  end
+end
+
 desc 'Show instruction on howto setup tab autocomplete for op5util in your shell'
 command :autocomplete do |c|
   c.action do

data/lib/op5util/list_hosts.rb

@@ -0,0 +1,29 @@
+# rubocop:disable LineLength, AbcSize
+# Foo
+module Op5util
+  # Foo
+  class Monitor
+    def list_hosts(host, options)
+      response = self.class.get(@base_uri + 'config/host?format=json',
+                                basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      JSON.parse!(response.body).map { |h| h['name'] }.select { |h| host.nil? ? true : h == host }.each do |h|
+        puts h
+        print_detailed_host_info(h) if options[:long]
+      end
+    end
+
+    private
+
+    def print_detailed_host_info(host)
+      response = self.class.get(@base_uri + "config/host/#{host}?format=json",
+                                basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      host_info = JSON.parse!(response.body)
+      puts 'Contact-groups: ' + host_info['contact_groups'].join(',')
+      puts 'Host-groups: ' + host_info['hostgroups'].join(',')
+      puts 'Address: ' + host_info['address']
+      puts 'Alias: ' + host_info['alias']
+    end
+  end
+end

data/lib/op5util/version.rb

@@ -1,3 +1,3 @@
 module Op5util
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 end

data/lib/op5util.rb

@@ -10,3 +10,4 @@ require 'op5util/acknowledge_alarm.rb'
 require 'op5util/list_hostgroups.rb'
 require 'op5util/schedule_checks.rb'
 require 'op5util/autocomplete.rb'
+require 'op5util/list_hosts.rb'

data/op5util.gemspec

@@ -6,7 +6,7 @@ spec = Gem::Specification.new do |s|
   s.author = 'Niklas Paulsson'
   s.email = 'niklasp@gmail.com'
   s.platform = Gem::Platform::RUBY
-  s.licenses = ['MIT License']
+  s.licenses = ['MIT']
   s.homepage = 'https://github.com/np422/Op5util'
   s.summary = 'A utility to do common Op5 administration from the commandline'
   s.files = %w[bin/op5util lib/op5util.rb LICENSE op5util.gemspec] +

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: op5util
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Niklas Paulsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -128,6 +128,7 @@ files:
 - lib/op5util/autocomplete.rb
 - lib/op5util/check_auth.rb
 - lib/op5util/list_hostgroups.rb
+- lib/op5util/list_hosts.rb
 - lib/op5util/method_template.rb
 - lib/op5util/monitor.rb
 - lib/op5util/schedule_checks.rb
@@ -139,7 +140,7 @@ files:
 - op5util.rdoc
 homepage: https://github.com/np422/Op5util
 licenses:
-- MIT License
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: