wlc_snmp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c01f85ae4e6dc37a6f146713d8644545444ff64
+  data.tar.gz: 1b8b573ae2c159508436a82ce55e79f4e13f44a9
+SHA512:
+  metadata.gz: cb3fbbe1ed2ce428c7a34ca6284b3eb8f19ed43c8349c048d271a8963ae4da429e1820f04ac21f9e3627ce73161a4b9d8497188ea3f9bc5e6b35ba9c4868bf5d
+  data.tar.gz: 12a2c4d55fde83f33bf27338683cfd2bd24f8569ab676f627bcb4ca699f8da1b39dfd51e65881e9e14be17eaac1c17ec5d61f2b274befa14daf809398a49580a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wlc_snmp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sorah Fukumori
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# WlcSnmp: Easy interaction with Cisco WLC via SNMP
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wlc_snmp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wlc_snmp
+
+## Usage
+
+```
+wlc = WlcSnmp::Client.new(host: 'wlc.example.com', community: 'xxx')
+
+p wlc.aps
+p wlc.clients
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sorah/wlc_snmp.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wlc_snmp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wlc_snmp.rb

@@ -0,0 +1,2 @@
+require 'wlc_snmp/version'
+require 'wlc_snmp/client'

data/lib/wlc_snmp/ap.rb

@@ -0,0 +1,27 @@
+module WlcSnmp
+  class Ap
+    def initialize(name: , mac_address: nil, ethernet_mac_address: nil, location: nil, operational_status: nil, model: nil, serial: nil, ip_address: nil, type: nil, admin_status: nil)
+      @name = name
+      @mac_address = mac_address
+      @ethernet_mac_address = ethernet_mac_address
+      @location = location
+      @operational_status = operational_status
+      @model = model
+      @serial = serial
+      @ip_address = ip_address
+      @type = type
+      @admin_status = admin_status
+    end
+
+    attr_reader :name
+    attr_reader :mac_address
+    attr_reader :ethernet_mac_address
+    attr_reader :location
+    attr_reader :operational_status
+    attr_reader :model
+    attr_reader :serial
+    attr_reader :ip_address
+    attr_reader :type
+    attr_reader :admin_status
+  end
+end

data/lib/wlc_snmp/client.rb

@@ -0,0 +1,147 @@
+require 'snmp'
+
+require 'wlc_snmp/client_data'
+require 'wlc_snmp/ap'
+
+module WlcSnmp
+  class Client
+    MIB_AIRESPACE_CLIENT_MAC = '1.3.6.1.4.1.14179.2.1.4.1.1'
+    MIB_AIRESPACE_CLIENT_IP = '1.3.6.1.4.1.14179.2.1.4.1.2'
+
+    MIB_AIRESPACE_AP_BASE_MAC = '1.3.6.1.4.1.14179.2.2.1.1.1'
+    MIB_AIRESPACE_AP_NAME = '1.3.6.1.4.1.14179.2.2.1.1.3'
+    MIB_AIRESPACE_AP_LOCATION = '1.3.6.1.4.1.14179.2.2.1.1.4'
+    MIB_AIRESPACE_AP_OPER_STATUS = '1.3.6.1.4.1.14179.2.2.1.1.6'
+    MIB_AIRESPACE_AP_MODEL = '1.3.6.1.4.1.14179.2.2.1.1.16'
+    MIB_AIRESPACE_AP_SERIAL = '1.3.6.1.4.1.14179.2.2.1.1.17'
+    MIB_AIRESPACE_AP_IP = '1.3.6.1.4.1.14179.2.2.1.1.19'
+    MIB_AIRESPACE_AP_TYPE = '1.3.6.1.4.1.14179.2.2.1.1.22'
+    MIB_AIRESPACE_AP_ETHENRET_MAC = '1.3.6.1.4.1.14179.2.2.1.1.33'
+    MIB_AIRESPACE_AP_ADMIN_STATUS = '1.3.6.1.4.1.14179.2.2.1.1.37'
+
+    MIB_LWAPP_AP_NAME = '1.3.6.1.4.1.9.9.513.1.1.1.1.5'
+    MIB_LWAPP_AP_MAC = '1.3.6.1.4.1.9.9.513.1.1.1.1.2'
+
+    MIB_LWAPP_CLIENT_MAC = '1.3.6.1.4.1.9.9.599.1.3.1.1.1'
+    MIB_LWAPP_CLIENT_WLAN_PROFILE = '1.3.6.1.4.1.9.9.599.1.3.1.1.3'
+    MIB_LWAPP_CLIENT_PROTOCOL = '1.3.6.1.4.1.9.9.599.1.3.1.1.6'
+    MIB_LWAPP_CLIENT_AP_MAC = '1.3.6.1.4.1.9.9.599.1.3.1.1.8'
+    MIB_LWAPP_CLIENT_IP = '1.3.6.1.4.1.9.9.599.1.3.1.1.10'
+    MIB_LWAPP_CLIENT_UPTIME = '1.3.6.1.4.1.9.9.599.1.3.1.1.15'
+    MIB_LWAPP_CLIENT_CURRENT_RATE = '1.3.6.1.4.1.9.9.599.1.3.1.1.17'
+    MIB_LWAPP_CLIENT_RATE_SET = '1.3.6.1.4.1.9.9.599.1.3.1.1.18'
+    MIB_LWAPP_CLIENT_USER = '1.3.6.1.4.1.9.9.599.1.3.1.1.27'
+    MIB_LWAPP_CLIENT_SSID = '1.3.6.1.4.1.9.9.599.1.3.1.1.28'
+
+    def initialize(host: , port: 161, community: )
+      @host = host
+      @port = port
+      @community = community
+    end
+
+    def aps
+      snmp_get_tree(
+        mac_address: MIB_AIRESPACE_AP_BASE_MAC,
+        name: MIB_AIRESPACE_AP_NAME,
+        location: MIB_AIRESPACE_AP_LOCATION,
+        operational_status: MIB_AIRESPACE_AP_OPER_STATUS,
+        model: MIB_AIRESPACE_AP_MODEL,
+        serial: MIB_AIRESPACE_AP_SERIAL,
+        ip_address: MIB_AIRESPACE_AP_IP,
+        type: MIB_AIRESPACE_AP_TYPE,
+        ethernet_mac_address: MIB_AIRESPACE_AP_ETHENRET_MAC,
+        admin_status: MIB_AIRESPACE_AP_ADMIN_STATUS,
+      ).map do |data|
+        Ap.new(
+          name: data[:name].to_s,
+          mac_address: unpack_mac(data[:mac_address]),
+          location: data[:location]&.to_s,
+          operational_status: data[:operational_status]&.to_i,
+          model: data[:model]&.to_s,
+          serial: data[:serial]&.to_s,
+          ip_address: data[:ip_address]&.to_s,
+          type: data[:ip_address],
+          ethernet_mac_address: unpack_mac(data[:ethernet_mac_address]),
+          admin_status: data[:admin_status]&.to_i,
+        )
+      end
+    end
+
+    def clients
+      aps = aps().map{ |_| [_.mac_address, _] }.to_h
+
+      airespace_clients = snmp_get_tree(ip: MIB_AIRESPACE_CLIENT_IP, mac: MIB_AIRESPACE_CLIENT_MAC).map do |data|
+        [data[:ip].to_s, unpack_mac(data[:mac])]
+      end.to_h
+
+      snmp_get_tree(
+        wlan_profile: MIB_LWAPP_CLIENT_WLAN_PROFILE,
+        protocol: MIB_LWAPP_CLIENT_PROTOCOL,
+        ap_mac: MIB_LWAPP_CLIENT_AP_MAC,
+        ip: MIB_LWAPP_CLIENT_IP,
+        uptime: MIB_LWAPP_CLIENT_UPTIME,
+        data_rate: MIB_LWAPP_CLIENT_CURRENT_RATE,
+        supported_data_rates: MIB_LWAPP_CLIENT_RATE_SET,
+        user: MIB_LWAPP_CLIENT_USER,
+        ssid: MIB_LWAPP_CLIENT_SSID,
+      ).map do |data|
+        ip = data[:ip].to_s.unpack("C*").map(&:to_s).join(?.)
+        mac = airespace_clients[ip] ? airespace_clients[ip] : nil
+        ap_mac = unpack_mac(data[:ap_mac])
+
+        ClientData.new(
+          mac_address: mac,
+          ip_address: ip,
+          ap: aps[ap_mac],
+          wlan_profile: data[:wlan_profile].to_s,
+          protocol: data[:protocol].to_i,
+          ap_mac: ap_mac,
+          uptime: data[:uptime].to_i,
+          current_rate: data[:data_rate].to_s,
+          supported_data_rates: data[:supported_data_rates].to_s.split(?,),
+          user: data[:user]&.to_s,
+          ssid: data[:ssid]&.to_s,
+        )
+      end
+    end
+
+    def snmp
+      @snmp ||= SNMP::Manager.new(host: @host, port: @port, community: @community)
+    end
+
+    private
+
+    def snmp_get_tree(attributes)
+      variables = attributes.map do |key, oid|
+        [key, snmp_walk(oid).map{|_| [_.name.index(oid).to_s, _] }.to_h]
+      end
+
+      variables.first[1].each_key.map do |index|
+        variables.map do |key, vbs|
+          [key, vbs[index]&.value]
+        end.to_h
+      end
+    end
+
+    def snmp_walk(tree)
+      vbs = []
+      pointer = tree
+      begin
+        list = snmp.get_bulk(0, 100, [pointer])
+        list.varbind_list.each do |vb|
+          unless vb.name.subtree_of?(tree)
+            pointer = nil
+            break
+          end
+          vbs.push vb
+          pointer = vb.name
+        end
+      end while pointer
+      vbs
+    end
+
+    def unpack_mac(mac)
+      mac.unpack("C*").map{ |_| _.to_s(16).rjust(2,'0') }.join(?:)
+    end
+  end
+end

data/lib/wlc_snmp/client_data.rb

@@ -0,0 +1,29 @@
+module WlcSnmp
+  class ClientData
+    def initialize(ip_address: , mac_address: nil, wlan_profile: nil, protocol: nil, ap_mac: nil, uptime: nil, current_rate: nil, supported_data_rates: nil, user: nil, ssid: nil, ap: nil)
+      @ip_address = ip_address
+      @mac_address = mac_address
+      @wlan_profile = wlan_profile
+      @protocol = protocol
+      @ap_mac = ap_mac
+      @uptime = uptime
+      @current_rate = current_rate
+      @supported_data_rates = supported_data_rates
+      @user = user
+      @ssid = ssid
+      @ap = ap
+    end
+
+    attr_reader :ip_address
+    attr_reader :mac_address
+    attr_reader :wlan_profile
+    attr_reader :protocol
+    attr_reader :ap_mac
+    attr_reader :uptime
+    attr_reader :current_rate
+    attr_reader :supported_data_rates
+    attr_reader :user
+    attr_reader :ssid
+    attr_reader :ap
+  end
+end

data/lib/wlc_snmp/version.rb

@@ -0,0 +1,3 @@
+module WlcSnmp
+  VERSION = "0.1.0"
+end

data/wlc_snmp.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wlc_snmp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wlc_snmp"
+  spec.version       = WlcSnmp::VERSION
+  spec.authors       = ["Sorah Fukumori"]
+  spec.email         = ["sorah@cookpad.com"]
+
+  spec.summary       = %q{Wrapper of snmp.gem for easy interacting with Cisco WLC}
+  spec.homepage      = "https://github.com/sorah/wlc_snmp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "snmp"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: wlc_snmp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sorah Fukumori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: snmp
+  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: 
+email:
+- sorah@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wlc_snmp.rb
+- lib/wlc_snmp/ap.rb
+- lib/wlc_snmp/client.rb
+- lib/wlc_snmp/client_data.rb
+- lib/wlc_snmp/version.rb
+- wlc_snmp.gemspec
+homepage: https://github.com/sorah/wlc_snmp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Wrapper of snmp.gem for easy interacting with Cisco WLC
+test_files: []