rea-netscaler-cli 0.5.9

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    netscaler-cli (0)
+      choosy (>= 0.4.8)
+      highline (>= 1.6)
+      json_pure (>= 1.5.1)
+      log4r (>= 1.1.9)
+      savon (>= 0.7.9)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-notification (2.3.1)
+      autotest (~> 4.3)
+    builder (3.0.0)
+    choosy (0.4.9)
+    diff-lcs (1.1.2)
+    gyoku (0.4.4)
+      builder (>= 2.1.2)
+    highline (1.6.2)
+    httpi (0.9.4)
+      pyu-ntlm-http (>= 0.1.3.1)
+      rack
+    json_pure (1.5.1)
+    log4r (1.1.9)
+    nokogiri (1.4.4)
+    nori (0.2.3)
+    pyu-ntlm-http (0.1.3.1)
+    rack (1.3.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    savon (0.9.2)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (>= 0.7.8)
+      nokogiri (>= 1.4.0)
+      nori (>= 0.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  autotest
+  autotest-notification
+  netscaler-cli!
+  rspec

data/README.markdown

@@ -0,0 +1,37 @@
+# Netscaler CLI
+
+This is a simple command line interface for accessing a Netscaler load balancer.  It is currently alpha software, so use with caution.
+
+# Installing
+
+The command line tools can be installed with:
+
+    gem install netscaler-cli
+
+# Using
+
+The following commands are currently a part of the system:
+
+  * *netscaler vserver* -- An interface for enabling, disabling, querying, and binding responder policies to a specific virtual server.
+  * *netscaler service* -- An interface for enabling, disabling, querying, and binding servers to specific services.
+  * *netscaler server*  -- An interface for enabling, disabling, querying, and binding servers to virtual servers.
+  
+Each command requires at least the --netscaler flag (which can be the full netscaler host name in the configuration file, or its alias, see below).
+
+# Configuration
+
+All of the commands rely upon a configuration file in the YAML format.  By default, it looks for a file in your home directory
+
+    ~/.netscaler-cli.yml
+
+Each load balancer requires an entry in the file in the form:
+
+    netscaler.loadbalancer.somecompany.com:
+       username: 'some.username'
+       password: 'super!duper!secret!'
+       alias:  prod
+       version: '9.2'
+
+Multiple entries can be in the file; the password and the alias settings are not required.  An alias can be used as a shortcut name on the command line for a particular netscaler server.  However, if no password is given in the file for a given configuration, the tool will ask you for it.
+
+The version information is optional, but breaking API changes were introduced in version 9.2 of Netscaler software, so some commands may fail if this isn't set for this Netscaler software version.

data/Rakefile

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../spec", __FILE__)
+
+require 'fileutils'
+require 'rake'
+require 'rubygems'
+require 'rspec/core/rake_task'
+require 'choosy/rake'
+
+task :default => :spec
+
+desc "Run the RSpec tests"
+RSpec::Core::RakeTask.new :spec
+
+desc "Cleans the gem files up."
+task :clean => ['gem:clean']

data/bin/netscaler

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'netscaler/cli'
+Netscaler::CLI.new(ARGV).execute!

data/lib/VERSION.yml

@@ -0,0 +1,6 @@
+--- 
+date: 10/06/2011
+version: 
+  tiny: 8
+  major: 0
+  minor: 5

data/lib/netscaler/base_request.rb

@@ -0,0 +1,52 @@
+require 'netscaler/logging'
+
+module Netscaler
+  class BaseRequest
+    include Netscaler::Logging
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    protected
+    def send_request(name, params, &block)
+      if params.nil? || params.empty?
+        raise Netscaler::TransactionError.new("The parameters were empty.")
+      end
+
+      params.delete(:empty)
+
+      log.debug("Calling: #{name}")
+
+      result = client.request name do
+        soap.namespace = Netscaler::NSCONFIG_NAMESPACE
+        soap.input = name
+        body = Hash.new
+        params.each do |k,v|
+          body[k.to_s] = v
+        end
+        soap.body = body
+      end
+
+      if log.debug?
+        require 'pp'
+        PP::pp(result.to_hash, $stderr, 80)
+      end
+      
+      response = result.to_hash["#{name.to_s}_response".to_sym]
+      msg = response[:return][:message]
+      if msg !~ /^Done$/
+        log.error(response[:return][:message])
+        exit(1)
+      elsif block_given?
+        yield response
+      else
+        log.debug(msg)
+      end
+
+      result
+    end
+  end
+end

data/lib/netscaler/cli.rb

@@ -0,0 +1,246 @@
+require 'netscaler/errors'
+require 'netscaler/config'
+require 'netscaler/executor'
+require 'netscaler/server/request'
+require 'netscaler/vserver/request'
+require 'netscaler/service/request'
+require 'netscaler/servicegroup/request'
+require 'choosy'
+
+module Netscaler
+  class CLI
+
+    def initialize(args)
+      @args = args.dup
+    end
+
+    def parse!(propagate=nil)
+      command.parse!(@args, propagate)
+    end
+
+    def execute!
+      begin
+        command.execute!(@args)
+      rescue SystemExit
+        raise
+      rescue Netscaler::ConfigurationError => e
+        print_error(e.message)
+        exit 1
+      rescue Exception => e
+        STDERR.puts e.backtrace
+        print_error(e.message)
+        exit 1
+      end
+    end
+
+    protected
+    def command
+      cmds = [vservers, servers, services, servicegroups]
+      @command ||= Choosy::SuperCommand.new :netscaler do
+        printer :standard, :color => true, :headers => [:bold, :blue], :max_width => 80
+
+        summary "This is a command line tool for interacting with Netscaler load balancer"
+        heading 'Description:'
+        para "There are several subcommands to do various things with the load balancer. Try 'netscaler help SUBCOMMAND' for more information about the particular command you want to use."
+        para "Note that you can supply a configuration file, which would normally be found under ~/.netscaler-cli.yml. That file describes the relationship between your Netscaler load balancers and the aliases, usernames, and passwords that you supply for them. The file is in the general format:"
+        para "  netscaler.host.name.com:
+    alias: is_optional
+    usernamd: is_required
+    password: is_optional_but_querried_if_not_found"
+
+        # COMMANDS
+        heading 'Commands:'
+        cmds.each do |cmd|
+          command cmd
+        end
+        para
+        command :help
+
+        # OPTIONS
+        heading 'Global Options:'
+        string :netscaler, "The IP Address, hostname, or alias in the config file of the Netscaler load balancer. This is required." do
+          depends_on :config
+          required
+
+          validate do |arg, options|
+            reader = Netscaler::ConfigurationReader.new(options[:config])
+            config = reader[arg]
+            if config.nil?
+              die "the Netscaler address '#{arg}' is not defined in the configuration file"
+            else
+              options[:netscaler] = config
+            end
+          end
+        end
+        yaml :config, "The path to the netscaler configuration file. By default, it is ~/.netscaler-cli.yml" do
+          default File.join(ENV['HOME'], '.netscaler-cli.yml')
+        end
+        
+        heading 'Informative:'
+        boolean_ :debug, "Print extra debug information"
+        boolean_ :json, "Prints out JSON instead of textual data"
+        help
+        version Choosy::Version.load_from_parent.to_s
+      end
+    end#command
+
+    def servers
+      Choosy::Command.new :server do |s|
+        executor Netscaler::Executor.new(Netscaler::Server::Request)
+        summary "Enables, disbles, or lists servers in the load balancer"
+        heading 'Description:'
+        para "This is a tool for enabling and disabling a server in a Netscaler load balancer.  The name of the server is required, as is the address of the Netscaler load balancer."
+        para "By default, this command will tell you what the current status of the server is."
+        para "If you want to list all of the services, use the --list flag."
+          
+        heading 'Options:'
+        enum :action, [:enable, :disable, :list, :status], "Either [enable, disable, list]. 'list' will ignore additional arguments. Default action is 'status'" do
+          default :status
+        end
+        arguments do
+          count 0..1 #:at_least => 0, :at_most => 1
+          metaname '[SERVER]'
+          validate do |args, options|
+            if args.length == 0
+              die "no server given to act upon" unless options[:action] == :list
+            end
+          end
+        end
+      end
+    end
+
+    def vservers
+      Choosy::Command.new :vserver do
+        executor Netscaler::Executor.new(Netscaler::VServer::Request)
+        summary "Enables, disables, binds or unbinds policies, or lists virtual servers."
+        heading 'Description:'
+        para "This is a tool for acting upon virtual servers (VIPs) in a Netscaler load balancer. The name of the virtual server is required."
+        para "By default, this command will tell you what the current status of the server is."
+        para "If you want to list all of the virtual servers, use the --list flag."
+
+        heading 'Options:'
+        enum :action, [:enable, :disable, :list, :bind, :unbind, :status], "Either [enable, disable, list, bind, unbind, status]. 'bind' and 'unbind' require the additional '--policy' flag. 'list' will ignore additional arguments. Default action is 'status'." do
+          default :status
+        end
+        string :policy, "The name of the policy to bind/unbind." do
+          depends_on :action
+          default :unset
+          validate do |arg, options|
+            if [:bind, :unbind].include?(options[:action])
+              die "required by the 'bind/unbind' actions" if arg == :unset
+            else
+              die "only used with bind/unbind" unless arg == :unset
+            end
+          end
+        end
+        integer :Priority, "The integer priority of the policy to bind with. Default is 100." do
+          depends_on :action, :policy
+          default -1
+          validate do |arg, options|
+            if options[:action] == :bind
+              if arg == -1
+                options[:Priority] = 100
+              end
+            elsif arg != -1
+              die "only used with the bind action"
+            end
+          end
+        end
+        arguments do
+          count 0..1 #:at_least => 0, :at_most => 1
+          metaname '[SERVER]'
+          validate do |args, options|
+            if args.length == 0
+              die "no virtual server given to act upon" unless options[:action] == :list
+            end
+          end
+        end
+      end
+    end
+
+    def services
+      Choosy::Command.new :service do
+        executor Netscaler::Executor.new(Netscaler::Service::Request)
+        summary "Enables, disables, binds or unbinds from a virtual server, a given service."
+        heading 'Description:'
+        para "This is a tool for enabling and disabling services in a Netscaler load balancer.  The name of the service is required, as is the address of the Netscaler load balancer."
+        
+        heading 'Options:'
+        enum :action, [:enable, :disable, :bind, :unbind, :status], "Either [enable, disable, bind, unbind, status] of a service. 'bind' and 'unbind' require the '--vserver' flag. Default is 'status'." do
+          default :status
+        end
+        string :vserver, "The virtual server to bind/unbind this service to/from." do
+          depends_on :action
+          default :unset
+          validate do |arg, options|
+            if [:bind, :unbind].include?(options[:action])
+              die "requires the -v/--vserver flag" if arg == :unset
+            else
+              die "only used with bind/unbind" unless arg == :unset
+            end
+          end
+        end
+        arguments do
+          count 0..1 #:at_least => 0, :at_most => 1
+          metaname '[SERVICE]'
+          validate do |args, options|
+            if args.length == 0
+              die "no services given to act on" unless options[:action] == :list
+            end
+          end
+        end
+      end
+    end
+
+    def servicegroups
+      Choosy::Command.new :servicegroup do
+        executor Netscaler::Executor.new(Netscaler::ServiceGroup::Request)
+        summary "Enables, disables, binds or unbinds from a virtual server, a given service group."
+        heading 'Description:'
+        para "This is a tool for enabling and disabling service groups in a Netscaler load balancer.  The name of the service group is required, as is the address of the Netscaler load balancer."
+        
+        heading 'Options:'
+        enum :action, [:enable, :disable, :bind, :unbind, :status], "Either [enable, disable, bind, unbind, status] of a service group. 'bind' and 'unbind' require the '--vserver' flag. Default is 'status'." do
+          default :status
+        end
+        string :vserver, "The virtual server to bind/unbind this service to/from." do
+          depends_on :action
+          default :unset
+          validate do |arg, options|
+            if [:bind, :unbind].include?(options[:action])
+              die "requires the -v/--vserver flag" if arg == :unset
+            else
+              die "only used with bind/unbind" unless arg == :unset
+            end
+          end
+        end
+        string :servername, "The name of the server that an individual service runs on (used when scoping the action to an individual service in a service group)." do
+          depends_on :action
+        end
+        string :port, "The port number that an individual service in bound to (used when scoping the action to an individual service in a service group)." do
+          depends_on :action
+        end
+        string :delay, "The delay (in seconds) to wait before disabled services transition to Out of Service. Default is 0 seconds (immediately)." do
+          depends_on :action
+          default "0"
+        end
+        arguments do
+          count 0..1 #:at_least => 0, :at_most => 1
+          metaname '[SERVICEGROUP]'
+          validate do |args, options|
+            if args.length == 0
+              die "no service group given to act on" unless options[:action] == :list
+            end
+          end
+        end
+      end
+    end
+
+    private
+    def print_error(e)
+      STDERR.puts "#{File.basename($0)}: #{e}"
+      STDERR.puts "Try '#{File.basename($0)} help' for more information"
+      exit 1
+    end
+  end
+end

data/lib/netscaler/config.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+require 'yaml'
+require 'etc'
+require 'highline/import'
+
+module Netscaler
+
+  class ConfigurationReader
+    def initialize(yaml)
+      @servers = yaml
+    end
+
+    def [](name)
+      # First, try the aliases
+      @servers.each_key do |lbname|
+        found = @servers[lbname]
+        if found['alias'] == name
+          return create_config(lbname, found)
+        end
+      end
+
+      # Next, check the actual server names
+      found = @servers[name]
+      if found.nil?
+        raise Netscaler::ConfigurationError.new("The specified Netscaler host was not found")
+      end
+
+      return create_config(name, found)
+    end
+
+    def load_balancers
+      @servers.keys
+    end
+
+    def self.read_config_file(file)
+      if file.nil?
+        file = File.expand_path(".netscaler-cli.yml", Etc.getpwuid.dir)
+      end
+
+      if !File.exists?(file)
+        raise Netscaler::ConfigurationError.new("Unable to locate the netscaler-cli configuration file")
+      end
+
+      begin
+        yaml = File.read(file)
+        ConfigurationReader.new(YAML::load(yaml))
+      rescue Exception => e
+        raise Netscaler::ConfigurationError.new("Unable to load the netscaler-cli configuration file")
+      end
+    end
+
+    private
+    def create_config(lbname, yaml)
+      if yaml['username'].nil?
+        raise Netscaler::ConfigurationError.new("No username was specified for the given Netscaler host")
+      end
+
+      Configuration.new(lbname, yaml['username'], yaml['password'], yaml['alias'], yaml['version'])
+    end
+  end
+
+  class Configuration
+    attr_reader :host, :username, :password, :alias, :version
+
+    def initialize(host, username, password=nil, nalias=nil, version=nil)
+      @host = host
+      @username = username
+      @password = password
+      @alias = nalias
+      @version = if version
+                   version.to_s
+                 else
+                   "9.2"
+                 end
+
+      query_password
+    end
+
+    def query_password
+      if password.nil?
+        @password = ask("Netscaler password for host #{host}: ") {|q| q.echo = false }
+      end
+
+      if password.nil? || password.empty?
+        raise Netscaler::ConfigurationError.new("Unable to read the Netscaler password.")
+      end
+    end
+  end
+end