acos_client 0.1.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffc04a9a5a06a8c4cf4e82930a95cc24f290921a
+  data.tar.gz: 937daca450fc18eb65b1729a8ca927c682fac1cd
+SHA512:
+  metadata.gz: ca6365ea55cda8312c062f851e70b31fa5ea9e978d1ea24a903a0b8bc30f9d6b6ec2e5c5ac368577db5a1f04a5de56aab70517c88240caacb9925a44f0be1792
+  data.tar.gz: 031b2e132b27b56bdf9a533f831431d29f0e1df1f113d2766aee1afefc6d5f6048ffeb3f60f1ca85b77c19a88112e2c89a336b14bf7e4d41487760682ba9367c

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+# AcosClient
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/acos_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acos_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acos_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/acos_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/acos_client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acos_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "acos_client"
+  spec.version = AcosClient::VERSION
+  spec.authors = ["Amine Benseddik"]
+  spec.email = ["amine.benseddik@gmail.com"]
+
+  spec.summary = %q{A10network AxAPI client}
+  spec.description = %q{Port Python A10network AxAPI client to Ruby}
+  spec.homepage = "https://gitlab.spiir.me/amine/acos_client"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'httparty'
+  spec.add_development_dependency 'addressable'
+  spec.add_development_dependency 'activesupport'
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acos_client"
+
+# 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

data/bin/setup

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

data/lib/acos_client/application.rb

@@ -0,0 +1,91 @@
+require 'optparse'
+require 'pp'
+require 'acos_client/client'
+require 'acos_client/v21/responses'
+
+module AcosClient
+  module Application
+
+    def self.run(argv)
+
+      c = AcosClient::Client.new('admin', 'a10', '192.168.1.10')
+
+      puts c.session.id
+      #c.system.partition.active('shared')
+
+      # System
+      #puts c.system.tech_download
+      puts c.system.information
+      puts c.system.device_info.get
+      puts c.system.device_info.cpu_current_usage
+      puts c.system.device_info.cpu_historical_usage
+      #puts c.system.action.reboot # Not Implemented
+
+      # Partition
+      if c.system.partition.exists('test')
+        puts c.system.partition.exists('test')
+        c.system.partition.active('test')
+      else
+        #c.system.partition.create("test")
+      end
+      puts c.current_partition
+
+      # Log
+
+      # Network
+      puts c.network.interface.all
+      #puts c.network.interface.get(3) # broken
+      puts c.network.acl.ext.all
+      puts c.nat.pool.all
+
+      # HA Sync
+      puts c.ha.sync('127.0.0.1', 'admin', 'a10')
+
+      #####################
+      # SLB               #
+      #####################
+
+      # Virtual Service
+      #
+      puts c.slb.virtual_service.all
+      begin
+        puts c.slb.virtual_service.get('test')
+      rescue => e
+        puts "#{e.message}"
+      end
+
+      # Virtual Server
+      #
+      puts c.slb.virtual_server.all
+      puts c.slb.virtual_server.get('test') rescue puts 'Not Found'
+
+      # Server
+      #
+      puts c.slb.server.all
+      puts c.slb.server.get('test') rescue puts 'Server Not Found'
+
+      # Class List
+      #
+      puts c.slb.class_list.all
+      puts c.slb.class_list.delete('ClassListTest02')
+
+      # Aflex
+      #
+      puts c.slb.aflex.all
+      puts c.slb.aflex.get('host_switching')
+      puts c.slb.aflex.get('redirect1')
+
+      # Template
+      #
+      puts c.slb.template.server_ssl.all
+      puts c.slb.template.cookie_persistence.all
+      puts c.slb.template.src_ip_persistence.all
+
+
+      ####################
+
+      # Close session
+      c.session.close
+    end
+  end
+end

data/lib/acos_client/client.rb

@@ -0,0 +1,58 @@
+require 'acos_client/v21/axapi_http'
+require 'acos_client/v21/session'
+require 'acos_client/v21/ha'
+require 'acos_client/v21/system'
+require 'acos_client/v21/slb/init'
+require 'acos_client/v21/network'
+require 'acos_client/v21/nat'
+
+
+module AcosClient
+
+  class Client
+
+    # VERSION_IMPORTS = {
+    # :21 = {
+    # 	:HA => :v21_HA,
+    # 	:Nat => :v21_Nat,
+    # 	:Network => :v21_Network,
+    # 	:Session => :v21_Session,
+    # 	:SLB => :v21_SLB,
+    # 	:System => :v21_System,
+    # 	}
+    # }
+
+    attr_accessor :http, :session, :system, :current_partition
+
+    def initialize(username, password, host, protocol: "https", port: nil)
+
+      @http = AcosClient::V21::HttpClient.new(host, protocol: protocol, port: port)
+      @session = AcosClient::V21::Session.new(self, username, password)
+      @current_partition = 'shared'
+
+    end
+
+    def ha
+      AcosClient::V21::HA.new(self)
+    end
+
+    def system
+      AcosClient::V21::System.new(self)
+    end
+
+    def slb
+      AcosClient::V21::SLB.new(self)
+    end
+
+    def network
+      AcosClient::V21::Network.new(self)
+    end
+
+    def nat
+      AcosClient::V21::Nat.new(self)
+    end
+
+
+  end
+
+end

data/lib/acos_client/errors.rb

@@ -0,0 +1,56 @@
+module AcosClient
+  module Error
+
+    class Error < StandardError;
+    end
+
+    class ACOSUnsupportedVersion < Error;
+    end
+
+    class ACOSUnknownError < Error;
+    end
+
+    class AddressSpecifiedIsInUse < Error;
+    end
+
+    class AuthenticationFailure < Error;
+    end
+
+    class InvalidSessionID < Error;
+    end
+
+    class Exists < Error;
+    end
+
+    class NotFound < Error;
+    end
+
+    class NoSuchServiceGroup < Error;
+    end
+
+    class NotImplemented < Error;
+    end
+
+    class InUse < Error;
+    end
+
+    class InvalidPartitionParameter < Error;
+    end
+
+    class MemoryFault < Error;
+    end
+
+    class InvalidParameter < Error;
+    end
+
+    class OutOfPartitions < Error;
+    end
+
+    class PartitionIdExists < Error;
+    end
+
+    class HMMissingHttpPassive < Error;
+    end
+
+  end
+end

data/lib/acos_client/tools.rb

@@ -0,0 +1,12 @@
+require 'addressable/uri'
+
+
+module AcosClient
+  module Tools
+
+    def self.extract_method(api_url)
+      return Addressable::URI.parse(api_url).query_values()['method']
+    end
+
+  end
+end

data/lib/acos_client/v21/action.rb

@@ -0,0 +1,36 @@
+require 'acos_client/errors'
+require 'acos_client/v21/base'
+
+module AcosClient
+  module V21
+
+    class Action < AcosClient::V21::BaseV21
+
+      def write_memory
+        begin
+          self._get('system.action.write_memory')
+        rescue AcosClient::Error::InvalidPartitionParameter
+          #pass
+        end
+      end
+
+      def reboot(**opts)
+        raise NotImplementedError, 'Reboot Action is not implemented'
+        # return self._post('system.action.reboot', **opts)
+      end
+
+      def reload(write_memory: false, **opts)
+        # write_memory param is required but no matter what value is passed
+        # it will ALWAYS save pending changes
+
+        if write_memory
+          write_memory = 1
+        else
+          write_memory = 0
+        end
+
+        self._post('system.action.reload', params: {:write_memory => write_memory}, **opts)
+      end
+    end
+  end
+end

data/lib/acos_client/v21/axapi_http.rb

@@ -0,0 +1,142 @@
+require 'httparty'
+require 'json'
+require 'pp'
+
+require 'acos_client/v21/monkey_patch_ssl'
+require 'acos_client/tools'
+require 'acos_client/v21/responses'
+
+module AcosClient
+  module V21
+
+    # Some were fixed in ACOS 2.7.2-P4
+    #
+    BROKEN_REPLIES = {
+        ('<?xml version="1.0" encoding="utf-8" ?>'\
+        '<response status="ok">') => ({:response => {:status => 'OK'}}).to_json,
+
+        ('<?xml version="1.0" encoding="utf-8" ?><response status="fail">'\
+        '<error code="999" msg=" Partition does not exist. (internal error: 520749062)" />'\
+        '</response>') => ({:response => {:status => 'fail', :err => {:code => 999,
+                                                                      :msg => ' Partition does not exist.'}}}).to_json,
+
+        ('<?xml version="1.0" encoding="utf-8" ?><response status="fail">'\
+        '<error code="1076" msg="Invalid partition parameter." /></response>') => ({
+            :response => {:status => 'fail', :err => {:code => 1076, :msg => 'Invalid partition parameter.'}}}).to_json,
+
+        ('<?xml version="1.0" encoding="utf-8" ?><response status="fail">'\
+        '<error code="999" msg=" No such aFleX. (internal error: '\
+        '17039361)" /></response>') => ({:response => {:status => 'fail', :err => {:code => 17039361,
+                                                                                   :msg => ' No such aFleX.'}}}).to_json,
+
+        ('<?xml version="1.0" encoding="utf-8" ?><response status="fail">'\
+        '<error code="999" msg=" This aFleX is in use. (internal error: '\
+        '17039364)" /></response>') => ({:response => {:status => 'fail', :err => {:code => 17039364,
+                                                                                   :msg => ' This aFleX is in use.'}}}).to_json
+    }
+
+    class HttpClient
+      include HTTParty
+
+      #default_options[:ssl_version] = :TLSv1
+      ssl_version :TLSv1
+      default_options.update(verify: false)
+
+      HEADERS = {
+          "Content-type" => "application/json",
+          "User-Agent" => "A10MGMT-Client-AGENT-#{VERSION}",
+      }
+
+      attr_accessor :host, :port, :protocol
+
+      def initialize(host, protocol: 'https', port: nil)
+
+        @host = host
+        @port = port
+        @protocol = protocol
+
+        if port.nil?
+          if protocol == 'http'
+            @port = 80
+          else
+            @port = 443
+          end
+        end
+
+        @base_uri = @protocol + '://' + @host + ':' + @port.to_s
+        self.class.base_uri(@base_uri)
+      end
+
+      def request(method, api_url, params: {}, ** opts)
+        #
+        # Todo: Catch http/httparty exceptions
+        #
+
+        if !params.empty?
+          params_copy = params.merge(opts)
+        end
+
+        options = {
+            :body => params_copy.to_json,
+            :headers => HEADERS
+        }
+
+        case method
+
+          when 'GET'
+            r = self.class.get(api_url, params)
+            response = r.body
+
+            begin
+              r.inspect
+
+            rescue JSON::ParserError
+              # ToDo: should check broken replies
+            end
+
+          when 'POST'
+            r = self.class.post(api_url, options)
+            response = r.body
+
+            begin
+              r.inspect
+
+            rescue JSON::ParserError
+              # Extract "<?xml version="1.0" encoding="utf-8" ?><response status="ok">"
+              xmlhead = r.body[0..60]
+
+              if BROKEN_REPLIES.key?(xmlhead)
+                response = BROKEN_REPLIES[xmlhead]
+              elsif BROKEN_REPLIES.key?(r.body.to_s)
+                response = BROKEN_REPLIES[r.body.to_s]
+              end
+
+            end
+
+          else
+            raise RuntimeError
+        end
+
+        r = JSON.load(response).deep_symbolize_keys!
+        if r.key?(:response) and r[:response].key?(:status)
+          if r[:response][:status] == 'fail'
+            AcosClient::V21::Responses.raise_axapi_error(r, action: AcosClient::Tools.extract_method(@base_uri + api_url))
+          end
+        end
+
+        r
+      end
+
+      def get(api_url, params: {}, ** opts)
+        self.request('GET', api_url, params: params)
+      end
+
+      def post(api_url, params: {}, ** opts)
+        self.request('POST', api_url, params: params)
+      end
+
+    end
+
+  end
+
+end

data/lib/acos_client/v21/base.rb

@@ -0,0 +1,63 @@
+require 'acos_client/errors'
+
+module AcosClient
+  module V21
+
+    class BaseV21
+
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+
+      end
+
+      def url(action)
+        "/services/rest/v2.1/?format=json&method=#{action}&session_id=#{@client.session.id}"
+      end
+
+      def _request(method, action, params: params, retry_count: 0, **opts)
+
+        if retry_count > 6
+          raise AcosClient::Error::ACOSUnknownError
+        end
+
+        begin
+
+          return @client.http.request(method, self.url(action), params: params, **opts)
+
+        rescue AcosClient::Error::MemoryFault => e
+          if retry_count < 5
+            sleep(0.5)
+            return self._request(method, action, params: params, retry_count: retry_count+1, **opts)
+          end
+          raise e
+
+        rescue AcosClient::Error::InvalidSessionID
+          if retry_count < 5
+            sleep(0.5)
+            begin
+              p = @client.current_partition
+              @client.session.close
+              @client.partition.active(p)
+            rescue Exception => e
+              #pass
+            end
+            return self._request(method, action, params: params, retry_count: retry_count+1, **opts)
+          end
+          raise e
+        end
+
+      end
+
+      def _get(action, params: {}, **opts)
+        self._request('GET', action, params: params, **opts)
+      end
+
+      def _post(action, params: {}, **opts)
+        self._request('POST', action, params: params, **opts)
+      end
+
+    end
+  end
+end

data/lib/acos_client/v21/config_file.rb

@@ -0,0 +1,26 @@
+require 'acos_client/v21/base'
+
+module AcosClient
+  module V21
+    class ConfigFile < AcosClient::V21::BaseV21
+
+      def upload(cfg_backup, **opts)
+        self._post('system.config_file.upload', params: cfg_backup, **opts)
+      end
+
+
+      def restore(**opts)
+        self._post('system.config_file.restore', **opts)
+      end
+
+
+      def write(from_file, to_file, **opts)
+        params = {:from => from_file, :to => to_file}
+        self._post('system.config_file.write', params: params, **opts)
+      end
+    end
+
+  end
+end
+
+

data/lib/acos_client/v21/device_info.rb

@@ -0,0 +1,22 @@
+require 'acos_client/v21/base'
+
+module AcosClient
+  module V21
+
+    class DeviceInfo < AcosClient::V21::BaseV21
+
+      def get(**opts)
+        return self._get('system.device_info.get', **opts)
+      end
+
+      def cpu_current_usage(**opts)
+        return self._get('system.device_info.cpu.current_usage.get', **opts)
+      end
+
+      def cpu_historical_usage(**opts)
+        return self._get('system.device_info.cpu.historical_usage.get', *opts)
+      end
+
+    end
+  end
+end

data/lib/acos_client/v21/ha.rb

@@ -0,0 +1,29 @@
+require 'acos_client/v21/base'
+
+module AcosClient
+  module V21
+
+    class HA < AcosClient::V21::BaseV21
+
+      def sync(destination_ip, username, password)
+
+        params = {
+            :ha_config_sync => {
+                :auto_authentication => 0,
+                :user => username,
+                :password => password,
+                :sync_all_partition => 1,
+                :operation => 2, # running config only
+                :peer_operation => 0, # running config
+                :peer_reload => 0,
+                :destination_ip => destination_ip
+            }
+        }
+
+        self._post('ha.sync_config', params: params)
+      end
+
+    end
+
+  end
+end