net_app_manageability 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12e9bc7a7c8b1d17e7a3557e9b15368ba29ab827
+  data.tar.gz: 803b7f6d60916bab77a87794947f5adc0ea4f50d
+SHA512:
+  metadata.gz: 31c7a4e272673efde95fe8afea55dd7b5ceaefbc2b8708b117696de7afb3440c65fc0470edb8df2f53ddc149b31ca532e9d35d5c8444d9f3d06b8ff46d556174
+  data.tar.gz: e672edf77f9cd6472e15aa57ac06dc9f5da6c7c2740cbe3890f613b12a39f1727b5ce4e4c8860c253bd533445076443d85a1f50c24a3a5dcc89d6064e9145d17

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.so
+*.bundle

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Red Hat, Inc.
+
+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,76 @@
+# NetAppManageability
+
+Ruby binding to NetApp Manageability SDK.
+
+[![Gem Version](https://badge.fury.io/rb/net_app_manageability.svg)](http://badge.fury.io/rb/net_app_manageability)
+[![Code Climate](http://img.shields.io/codeclimate/github/ManageIQ/net_app_manageability.svg)](https://codeclimate.com/github/ManageIQ/net_app_manageability)
+[![Dependency Status](https://gemnasium.com/ManageIQ/net_app_manageability.svg)](https://gemnasium.com/ManageIQ/net_app_manageability)
+
+## Installation
+
+First, install the NetApp Manageability SDK.
+
+- This is only provided by NetApp directly.  For the next steps, we will assume these files are located in `$INSTALL_DIR`.
+
+- Create symlinks for libssl and libcrypto, if necessary.
+
+  ```sh
+  ln -s libssl.so $INSTALL_DIR/lib/linux-64/libssl.so.0.9.8
+  ln -s libcrypto.so $INSTALL_DIR/lib/linux-64/libcrypto.so.0.9.8
+  ```
+
+Next, if using bundler
+
+- Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'net_app_manageability'
+  ```
+
+- If the NetApp Manageability SDK is not available on the normal compile paths, then execute:
+
+  ```sh
+  bundle config build.net_app_manageability --with-netapp-manageability-sdk-include=$INSTALL_DIR/include --with-netapp-manageability-sdk-lib=$INSTALL_DIR/lib/linux-64
+  ```
+
+- And finally execute:
+
+  ```sh
+  bundle
+  ```
+
+Otherwise, if not using bundler
+
+- If the NetApp Manageability SDK is not available on the normal compile paths, then execute:
+
+  ```sh
+  gem install net_app_manageability --with-netapp-manageability-sdk-include=$INSTALL_DIR/include --with-netapp-manageability-sdk-lib=$INSTALL_DIR/lib/linux-64
+  ```
+
+- Otherwise execute:
+
+  ```sh
+  gem install net_app_manageability
+  ```
+
+## Usage
+
+For examples of usage, see the [examples](examples).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to compile the gem and run the tests.  If you want to just compile the gem, use `rake compile`.  If the NetApp Manageability SDK is not accessible via the normal compile paths, you make have to pass those locations to `rake compile` as follows:
+
+    rake compile -- --with-netapp-manageability-sdk-include=$INSTALL_DIR/include --with-netapp-manageability-sdk-lib=$INSTALL_DIR/lib/linux-64
+
+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/ManageIQ/net_app_manageability.
+
+## 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,13 @@
+require "bundler/gem_tasks"
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new do |ext|
+  ext.name    = 'net_app_manageability'
+  ext.ext_dir = 'ext/net_app_manageability'
+  ext.lib_dir = 'lib/net_app_manageability'
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec => :compile)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,7 @@
+require "net_app_manageability"
+svr = NetAppManageability::API.server_open(SERVER, 1, 1)
+NetAppManageability::API.server_style(svr, NetAppManageability::API::NA_STYLE_LOGIN_PASSWORD)
+NetAppManageability::API.server_adminuser(svr, USERNAME, PASSWORD)
+rv = NetAppManageability::API.server_invoke(svr, "volume-list-info", :volume => "vol1")
+
+puts "RV: #{rv.inspect}"

data/examples/client_example.rb

@@ -0,0 +1,45 @@
+require 'net_app_manageability'
+require 'logger'
+
+SERVER    = raise "please define server"
+USERNAME  = ""
+PASSWORD  = ""
+
+netapp_client = NetAppManageability::Client.new do
+  server     SERVER
+  auth_style NetAppManageability::Client::NA_STYLE_LOGIN_PASSWORD
+  username   USERNAME
+  password   PASSWORD
+end
+
+puts
+puts "*** No options - list info for all volumes:"
+rv = netapp_client.volume_list_info
+puts rv.inspect
+
+#
+# Different ways of mking the same call.
+#
+puts
+puts "*** List info for a specific volume V1:"
+rv = netapp_client.volume_list_info(:volume => "vol1")
+puts rv.inspect
+
+puts
+puts "*** List info for a specific volume V2:"
+rv = netapp_client.volume_list_info(:volume, "vol1")
+puts rv.inspect
+
+puts
+puts "*** List info for a specific volume V3:"
+rv = netapp_client.volume_list_info do
+  volume "vol1"
+end
+puts rv.inspect
+
+puts
+puts "*** List info for a specific volume V4:"
+rv = netapp_client.volume_list_info do |vla|
+  vla.volume = "vol1"
+end
+puts rv.inspect

data/examples/create_volume.rb

@@ -0,0 +1,96 @@
+require 'net_app_manageability'
+require 'logger'
+
+SERVER    = raise "please define server"
+USERNAME  = ""
+PASSWORD  = ""
+
+GB        = 1024 * 1024 *1024
+CONTAINING_AGGR = "aggr1"
+NEW_VOLUME    = "api_test_vol1"
+VOL_SIZE_GB   = 10
+NFS_PATH    = "/vol/#{NEW_VOLUME}"
+ROOT_HOSTS    = [ HOST1, HOST2 ]
+
+NetAppManageability.logger    = Logger.new(STDOUT)
+NetAppManageability.wire_dump = false
+
+netapp_client = NetAppManageability::Client.new do
+  server     SERVER
+  auth_style NetAppManageability::Client::NA_STYLE_LOGIN_PASSWORD
+  username   USERNAME
+  password   PASSWORD
+end
+
+#
+# Ensure the volume doesn't already exist.
+#
+err = false
+begin
+  netapp_client.volume_list_info(:volume, NEW_VOLUME)
+  err = true
+rescue
+  # Ignore expected failure
+end
+raise "Volume #{NEW_VOLUME} already exists" if err
+
+#
+# Make sure there's enough free space in the aggregate for the new volume.
+#
+rv = netapp_client.aggr_list_info(:aggregate, CONTAINING_AGGR)
+aggr_free_space = rv.aggregates.aggr_info.size_available.to_i
+raise "Insufficient free space in #{CONTAINING_AGGR}: #{aggr_free_space}" if aggr_free_space < VOL_SIZE_GB * GB
+
+#
+# The creation of the volume will result in the creation a qtree entry for its root.
+# If we want to base a VMware datastore on the volume's NFS share, the security style of
+# its corresponding qtree must not be 'ntfs'.
+#
+# Unfortunately, the API doesn't provide a way to specify this value or change it after the fact.
+# The security style is always set to the value of the 'wafl.default_security_style' option.
+# So we must ensure that this value is set to either 'unix' or 'mixed' before the volume is created.
+#
+rv = netapp_client.options_get(:name, 'wafl.default_security_style')
+if rv.value == "ntfs"
+  puts "Default security style is ntfs, resetting it to mixed"
+  rv = netapp_client.options_set do
+    name  'wafl.default_security_style'
+    value 'mixed'
+  end
+end
+
+#
+# Create the volume within the given aggregate.
+#
+rv = netapp_client.volume_create do
+  containing_aggr_name  CONTAINING_AGGR
+  volume                NEW_VOLUME
+  space_reserve         "none"
+  size                  "#{VOL_SIZE_GB}g"
+end
+
+#
+# Get the export rules for the new volume's NFS share.
+#
+rv = netapp_client.nfs_exportfs_list_rules(:pathname, NFS_PATH)
+
+#
+# Add a list of root access hosts to the rules.
+# These are the ESX hosts that will be able to access the datastore.
+#
+rules = rv.rules
+rules.exports_rule_info.root = NetAppManageability::NAMHash.new do
+  exports_hostname_info NetAppManageability::NAMArray.new do
+    ROOT_HOSTS.each do |rh|
+      push NetAppManageability::NAMHash.new { name rh }
+    end
+  end
+end
+
+#
+# Update the export rules with the root access host list.
+#
+rv = netapp_client.nfs_exportfs_modify_rule do
+  persistent  true
+  rule        rules
+end

data/examples/list_aggregates.rb

@@ -0,0 +1,20 @@
+require 'net_app_manageability'
+require 'logger'
+
+SERVER    = raise "please define server"
+USERNAME  = ""
+PASSWORD  = ""
+
+netapp_client = NetAppManageability::Client.new do
+  server     SERVER
+  auth_style NetAppManageability::Client::NA_STYLE_LOGIN_PASSWORD
+  username   USERNAME
+  password   PASSWORD
+end
+
+rv = netapp_client.aggr_list_info
+
+aia = rv.aggregates.aggr_info.to_ary
+aia.each do |ai|
+  puts "Aggregate: #{ai.name}\tavailable space: #{ai.size_available}"
+end

data/examples/list_volumes.rb

@@ -0,0 +1,20 @@
+require 'net_app_manageability'
+require 'logger'
+
+SERVER    = raise "please define server"
+USERNAME  = ""
+PASSWORD  = ""
+
+netapp_client = NetAppManageability::Client.new do
+  server     SERVER
+  auth_style NetAppManageability::Client::NA_STYLE_LOGIN_PASSWORD
+  username   USERNAME
+  password   PASSWORD
+end
+
+rv = netapp_client.volume_list_info
+
+aia = rv.volumes.volume_info.to_ary
+aia.each do |ai|
+  puts "Volume: #{ai.name}\tavailable space: #{ai.size_available}"
+end

data/examples/lun_info.rb

@@ -0,0 +1,29 @@
+require 'net_app_manageability'
+require 'logger'
+
+SERVER    = raise "please define server"
+USERNAME  = ""
+PASSWORD  = ""
+
+netapp_client = NetAppManageability::Client.new do
+  server     SERVER
+  auth_style NetAppManageability::Client::NA_STYLE_LOGIN_PASSWORD
+  username   USERNAME
+  password   PASSWORD
+end
+
+rv = netapp_client.lun_list_info
+puts rv.inspect
+puts
+
+rv = netapp_client.lun_map_list_info(:path, '/vol/luns/lun1')
+puts rv.inspect
+puts
+
+rv = netapp_client.iscsi_adapter_initiators_list_info
+puts rv.inspect
+puts
+
+rv = netapp_client.iscsi_connection_list_info
+puts rv.inspect
+puts

data/examples/nfs_root_hosts.rb

@@ -0,0 +1,51 @@
+require 'net_app_manageability'
+require 'logger'
+
+SERVER    = raise "please define server"
+USERNAME  = ""
+PASSWORD  = ""
+
+netapp_client = NetAppManageability::Client.new do
+  server     SERVER
+  auth_style NetAppManageability::Client::NA_STYLE_LOGIN_PASSWORD
+  username   USERNAME
+  password   PASSWORD
+end
+
+rv = netapp_client.nfs_exportfs_list_rules(:pathname, "/vol/#{VOLUME_NAME}")
+raise "No export rules found for path /vol/#{VOLUME_NAME}" unless rv.kind_of?(NetAppManageability::NAMHash)
+
+rules = rv.rules
+rules.exports_rule_info.root = NetAppManageability::NAMHash.new if rules.exports_rule_info.root.nil?
+if rules.exports_rule_info.root.exports_hostname_info.nil?
+  rules.exports_rule_info.root.exports_hostname_info = NetAppManageability::NAMArray.new
+else
+  rules.exports_rule_info.root.exports_hostname_info = rules.exports_rule_info.root.exports_hostname_info.to_ary
+end
+
+rha = rules.exports_rule_info.root.exports_hostname_info
+
+changed = false
+ROOT_HOSTS.each do |nrhn|
+  skip = false
+  rha.each do |crhh|
+    if crhh.name == nrhn
+      skip = true
+      break
+    end
+  end
+  next if skip
+  
+  rha << NetAppManageability::NAMHash.new { name nrhn }
+  changed = true
+end
+
+if changed
+  puts "Updating rules"
+  netapp_client.nfs_exportfs_modify_rule do
+    persistent  true
+    rule        rules
+  end
+else
+  puts "No change to rules, not updating"
+end