zenoss_api 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccc01b38fe84290c614679cf9e4dec45178becb6
-  data.tar.gz: cefda83026ebac1c440221b8c340026e6f3b7522
+  metadata.gz: 701b7cc0a2bd590e8d5dcf26047c97bbebd40b63
+  data.tar.gz: 43f38fb45ad3979d5b99759e98186dde1bc9963b
 SHA512:
-  metadata.gz: febce1894dd23e4dbd8138fcfadde4f3190e6ea27a1820ab8d9b53acccfc869613ed978c4f6a04e156356fbf5916bfbe5d8efd01fde36bf4ae1ff2f746716cec
-  data.tar.gz: a6d91efa744df6e8c604da51f4b7b63fef8c424629e72cbee45f16ea59aa6589b73c7d762f52eff337952179ec9a2c1ff4da4573ff8be75eb6e3d7dadf5e2c45
+  metadata.gz: 7795a3a6c27dd3515648e95631b1cb3a7adf4adcfcfd25857c87249196f049df7e03f305acd777743165f0036f72bb9e20a0c8fbc611456a9e760deea7096c99
+  data.tar.gz: b07d9f7d5517555ca56e238422a7a80b919a55053437ae479b32bca21abfc37a070cf06c222a65acf16e5d3f62be31b5afbf12f5d07ddf46bdd2390b0ac4ad3e

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 Get all device classes:
 
 ```bash
-zenapi -m getDeviceClasses | jq '.devices[]'
+zenapi -m getDeviceClasses | jq '.deviceClasses[]'
 ```
 
 Get all groups:
@@ -35,12 +35,13 @@ zenapi -m getGroups | jq '.groups[] | .name'
 Get devices in device class, limit to 30:
 
 ```bash
-zenapi --uid '/Devices/Server/Linux' --limit 30 | jq '.devices[] | .name'
+zenapi -a uid=/zport/dmd/Devices/Server/Linux --limit 30 | jq '.devices[]'
 ```
+
 Get device by name:
 
 ```bash
-zenapi -m getDevices -a name:hostname.fqdn
+zenapi -m getDevices -p name=hostname|fqdn
 ```
 
 Get most recent events, limit to 10:
@@ -51,17 +52,17 @@ zenapi -m query -r EventsRouter --limit 10 | jq '.events[] | .device | .text'
 
 Get event detail:
 ````bash
-zenapi -r EventsRouter -m detail -a evid:0025b520-10e1-bfad-11e6-9abe93a9a0ae | jq '.'
+zenapi -r EventsRouter -m detail -a evid=0025b520-10e1-bfad-11e6-9abe93a9a0ae | jq '.'
 ````
 
 Get all routers:
 ````bash
-zenapi -r IntrospectionRouter -m getAllRouters | jq '.result | .data[] | .name'
+zenapi -r IntrospectionRouter -m getAllRouters  | jq '.data[] | .name'
 ````
 
 Introspect router methods:
 ````bash
-zenapi -r IntrospectionRouter -m getRouterMethods -a router:DeviceRouter | jq '.result | .data'
+zenapi -r IntrospectionRouter -m getRouterMethods -a router=DeviceRouter | jq '.data'
 ````
 
 ## Development

data/lib/zenoss_api/version.rb

@@ -1,3 +1,3 @@
 module ZenossApi
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

data/lib/zenoss_api.rb

@@ -26,7 +26,11 @@ module ZenossApi
 
   ROUTER_RETURN_KEYS = {
     'DeviceRouter' => 'devices',
-    'EventsRouter' => 'events'
+    'EventsRouter' => 'events',
+  }
+
+  ROUTER_RETURN_TYPE = {
+    'TemplateRouter' => 'templates',
   }
   
   DEFAULT_API_METHOD_ARGS = { 
@@ -116,6 +120,27 @@ module ZenossApi
       end
     end
 
+    # _normalize_response
+    # @param [Hash] zenoss router response
+    # @return [Hash] normalized response
+    def _normalize_response(r)
+      data = {
+        'action' => r['action'],
+        'method' => r['method'],
+      }
+      result = r['result']
+      begin
+        data.merge!(result)
+      rescue TypeError
+        # zenoss returns inconsistent result types, this is not a hash
+        type = ROUTER_RETURN_TYPE[data['action']]
+        data[type] = result
+        data['totalCount'] = result.length
+        data['success'] = true
+      end 
+      data
+    end
+        
     # http post to api
     # 
     # @param [String] url of api endpoint
@@ -132,7 +157,7 @@ module ZenossApi
          :verify => @verify,
        }) 
      if response.code == 200
-       response['result']
+       _normalize_response(response)
      else 
        raise ({ code: response.code, response: response }).to_json
      end
@@ -174,15 +199,15 @@ module ZenossApi
       if uids.kind_of?(Array)
         uids.collect { |x| self._validateUid(x, type) }
       else 
-        self._validateUid(uids, type)
+        [ self._validateUid(uids, type) ]
       end 
     end
  
     def _validateUid(u, type)
       if u.match(/^\/zport\/dmd\/.*$/)
-        u
+        u 
       else 
-        response = self.getDeviceProps(u, [ "uid" ])
+        response = self.getDeviceProperties(u, [ "uid" ])
         if not response.nil?
           response[type][0]['uid']
         else 
@@ -190,13 +215,25 @@ module ZenossApi
         end
       end
     end 
-     
+    
+    def getDeviceUidByName(device)
+    end
+
+    # set device location
+    #
+    # @param uids [Array] list of device uids 
+    def setDeviceLocation(uids, location)
+      validated = self.validateUids(uids)
+      data = { 'uids' => uids, 'ranges' => [], 'target' => location }
+      response = self.router("DeviceRouter", "moveDevices", data)
+    end
+
     # get device properties
     #
     # @param device [String] the name of the device (device title or id)
     # @param properties [Array] properties to be returned; default uid 
     # @return [Hash] of device properties or nil if device not found 
-    def getDeviceProperties(device, properties=[])
+    def getDeviceProperties(device, properties=['uid'])
       data = { 'keys' => properties, 'params' => { 'name' => device }, }
       result = self.router("DeviceRouter", "getDevices", data)
       if result['success'] == true and result['totalCount'] == 1

data/test.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+zenapi -r TemplateRouter -m getTemplates -a id=/zport/dmd/Devices | jq '.success'
+zenapi -m query -r EventsRouter --limit 50 | jq '.events | length == 50'
+zenapi -r DeviceRouter -m getDevices --limit 50 | jq '.devices | length == 50'
+zenapi -r EventsRouter -m query --limit 1 -f 'severity:5,eventState:0,prodState:1000,eventClass:/Status/Ping,summary:is DOWN'   | jq '.totalCount'
+zenapi -r EventsRouter -m query --limit 1 -f 'severity:3,eventState:0,prodState:1000' | jq '.totalCount'
+zenapi -r EventsRouter -m query --limit 1 -f 'severity:5,eventState:1,prodState:1000' | jq '.totalCount'
+zenapi -r EventsRouter -m query --limit 1000 -k device,summary -f 'eventClass:/Status/SNMP,eventState:0,prodState:1000' | jq '.totalCount'
+zenapi -r EventsRouter -m query --limit 1 -f 'severity:4,eventState:0,prodState:1000'   | jq '.totalCount'
+zenapi -r EventsRouter -m query --limit 1000 -k device,summary -f 'eventClass:/Status/WinRM,eventState:0,prodState:1000' | jq '.totalCount'
+zenapi -r EventsRouter -m query --limit 1 -f 'severity:5,eventState:0,prodState:1000'   | jq '.totalCount'
+zenapi --limit 1 -f '{ "productionState": [ 1000 ] }' | jq '.totalCount'
+zenapi --limit 1 -f '{ "productionState": [ 400, -1 ] }' | jq '.totalCount'
+

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: zenoss_api
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Todd Stoll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: io-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Execute api calls given the router, method, and parameters. Returns response
@@ -89,7 +89,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -100,6 +100,7 @@ files:
 - bin/zenapi
 - lib/zenoss_api.rb
 - lib/zenoss_api/version.rb
+- test.sh
 - zenoss_api.gemspec
 homepage: ''
 licenses:
@@ -111,17 +112,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Zenoss API via command line.