brocade_api_client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 230ae8a895a84e1e8f52517279ccd4900916f18fef0bc9cf7964638a0e592e1e
+  data.tar.gz: e0de429a4d41b9943515a7d938aecfe98350a0facf9b1bb2c66d70eca036d2b4
+SHA512:
+  metadata.gz: 9c6cafb39b3a6ebea61b253d52edc394b8d0428e17b34b1f9b2d6da6d449da55bf85364cc03b9ccdd36bd0108d34bf0f3d38475119f6feae86abacd552029e0a
+  data.tar.gz: e05c80a57e051f4e922dd992cfec5f28dbecd9da5a45da369794c45af655249ff3a1a9a830a70b75aa8aee548c845ce0165b82731ad0d8048e096037d8e71690

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/*.rb'
+Metrics/LineLength:
+  Max: 200
+Metrics/MethodLength:
+  Max: 30
+Metrics/ClassLength:
+  Max: 300
+Metrics/ParameterLists:
+  Max: 10

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install:
+  - gem install bundler
+  - bundle install
+script:
+  - rake build:spec

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in brocadeapi_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    brocade_api_client (0.1.0)
+      httparty (~> 0.16.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.4.0)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    jaro_winkler (1.5.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    multi_xml (0.6.0)
+    mustermann (1.0.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    public_suffix (3.0.3)
+    rack (2.0.7)
+    rack-protection (2.0.5)
+      rack
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.68.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    sinatra (2.0.5)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.5)
+      tilt (~> 2.0)
+    tilt (2.0.9)
+    unicode-display_width (1.5.0)
+    webmock (3.6.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  brocade_api_client!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.66)
+  sinatra (~> 2.0, >= 2.0.3)
+  webmock (~> 3.5, >= 3.5.1)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE

@@ -0,0 +1,234 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+
+
+1. Definitions.
+
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "{}"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+
+Copyright 2016-2017 Hewlett Packard Enterprise
+
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

data/README.md

@@ -0,0 +1,248 @@
+[![Build Status](https://travis-ci.com/raldi87/brocadeapi_client.svg?token=mkJwysQXyF3sdXnco1UE&branch=master)](https://travis-ci.com/raldi87/brocadeapi_client)
+[![Gem Version](https://badge.fury.io/rb/brocade_api_client.svg)](https://badge.fury.io/rb/brocade_api_client)
+
+Brocade Network Advisor API Client for SAN tasks Automation
+====================
+This is a Client library that can talk to the Brocade Network Advisor API. The BNA 
+has a REST web service interface which can be queried.
+This library implements an interface for talking to the Brocade Advisor and help SAN Admins automate SAN tasks.
+
+Prerequsites
+============
+* Brocade Network Advisor
+  * 14.2.0 
+  * 14.4.0 for Peer Zoning Support
+* Ruby - 2.2.x or higher.
+* Brocade Network Advisor REST API Service must be enabled on the Server.
+* Different vendors have there own flavor of Brocade Network Advisor which they are named accordingly: HPE Network Advisor, IBM Network Advisor. All are compatible as they are all based on Brocade Network Advisor.
+
+Features
+============
+
+    * resourcegroups
+    * fabrics
+    * fabric
+    * fabricswitches
+    * allswitches
+    * allports
+    * change_portstates
+    * change_persistentportstates
+    * set_portname
+    * zoneshow_all
+    * zoneshow_all_active
+    * zoneshow_all_defined
+    * zoneshow_active
+    * zoneshow_defined
+    * zonecreate_standard
+    * zonecreate_peerzone
+    * zonedelete
+    * zoneadd_standard
+    * zoneremove_standard
+    * zoneadd_peerzone
+    * zoneremove_peerzone
+    * zonedbs
+    * alishow
+    * cfgshow
+    * cfgadd
+    * cfgremove
+    * cfgenable
+    * alicreate
+    * aliadd
+    * aliremove
+    * alidelete
+    * trans_start
+    * trans_commit
+    * trans_abort
+    * syslog_events
+    * trap_events
+    * custom_events
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brocade_api_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brocade_api_client
+
+## Usage
+=============
+```ruby
+ #Create an instance of brocadeapi_client::Client
+ client = BrocadeAPIClient::Client.new('https://BNA_IP/rest')
+ # The Client supports logging and debug mode . Log format is :logstash
+ client = BrocadeAPIClient::Client.new('https://BNA_IP/rest', enable_logger: true, log_file_path: 'test.log'
+ # Also debug mode is supported by the debug parameters on the Client class constructor. By default its set to false.
+
+ #Login using Brocade Network Advisor API credential
+ client.login('BNA_user', 'BNA_password')
+
+ #Call any method from client class 
+ client.alishow(FABRICKEY,'alitest_port1')
+
+ #Logout once you have finished all of your operations
+ client.logout
+ 
+ # For zoning operations (zonecreate/add/remove , alicreate/add/remove and cfgadd/cfgremove) 
+ # you must start a transaction before sending a request to the Advisor
+ # After submitting, you must commit your transactions. 
+ # Below you can how to create a zone and peerzone
+ # FabricWWN is the seed switch WWN from the fabric on which you want to make the changes. 
+ # Using the fabrics and fabric method you can obtain it easily. Keep in mind this WWN might change, 
+ # so you might want to use the methods first tobtain de fabric WWN
+
+ client.trans_start('FabricWWN')
+ # Alicreate supports unlimited number of arguments as WWN
+ client.alicreate('FabricWWN', 'test_alias', '10:00:00:10:9b:52:a8:0b')
+ # Zonecreate supports unlimited number of arguments as zonealiases 
+ client.zonecreate_standard('FabricWWN', 'test_zone', 'test_alias', 'testalias')
+ # cfgadd method supports unlimited number to added as arguments/cfgremove is similar 
+ client.cfgadd('FabricWWN','test_config','test_zone')
+ client.trans_commit('FabricWWN')
+ # To enable the modification 
+ client.cfgenable('FabrickWWN')
+
+ # For Peerzoning use:
+ # The array support unlimited number of WWN that should be part of the zone
+ client.zonecreate_peerzone('FabricWWN', 'test_zone', principal: [ WWN ARRAY ], members: [WWN ARRAY])
+ 
+ # List all fabrics
+ client.fabrics
+ 
+ # List fabric description(including seed switch WWN)
+ client.fabric('FabricName')
+
+ # List all active zones in a Fabric
+ client.zoneshow_all_active('FabricWWN')
+ 
+ # List all defined zones in Fabric
+ client.zoneshow_all_defined('FabricWWN')
+ 
+ # List a specific active zones information
+ client.zoneshow_active('FabricWWN','zonename')
+
+ # List a specific define zones information
+ client.zoneshow_define('FabricWWN','zonename')
+
+ # Show aliases in fabric or for info for a specific alias
+ client.alishow('FabricWWN')
+ client.alishow('FabricWWN','aliasname')
+
+ # Set port name(PortWWN can be retrieved from allports method)
+ client.set_portname('FabricWWN','PortWWN','test_porname')
+
+ # Get all ports
+ client.allports
+
+ # Get all switches
+ client.allswitches
+
+ # Get all switchs from a specified Fabric
+ client.fabricswitches('FabricWWN')
+
+ # Change port state in a switch(non-persistent)
+ # Method support unlimited number or portwwns after disale|enable
+ client.change_portstates('FabricWWN', 'enable', 'PortWWN1', 'PortWWN2')
+
+ # Change port state in a switch(persistent)
+ # Method support unlimited number or portwwns after disale|enable
+ client.change_persistentportstates('FabricWWN', 'enable', 'PortWWN1', 'PortWWN2')
+
+ # Delete zones
+ # supports unlimited number of zones as arguments 
+ client.zonedelete('FabricWWN', 'zone1','zone2')
+
+ # Delete Aliases
+ client.alidelete('FabricWWN','alias1','alias2')
+
+ # Create Alias
+ client.alicreate('FabricWWN','aliasname','wwn1','wwn2')
+
+ # Add wwn to existing alias
+ client.aliadd('FabricWWN','aliasname','wwn1','wwn2')
+ # Remove wwns from existing alias 
+ client.aliremove('FabricWWN','aliasname','wwn1','wwn2')
+
+ # Zone add/remove (standard)
+ # supports unlimited number of arguments as aliases 
+ client.zoneremove_standard('10:00:00:27:f8:f7:6b:00', 'test_zone', 'alias1','alias2')
+ client.zoneadd_standard('10:00:00:27:f8:f7:6b:00', 'test_zone', 'alias1','alias2')
+
+ # Zone add/remove (peerzone)
+ # method supports both principal/members as hash keys or only one of them
+ client.zoneadd_peerzone('FabricWWN', 'test_zone', principal: ['wwn1','wwn2'],members: ['wwn1','wwn2'])
+ client.zoneremove_peerzone('FabricWWN', 'test_zone', principal: ['wwn1','wwn2'],members: ['wwn1','wwn2'])
+ client.zoneadd_peerzone('FabricWWN', 'test_zone', principal: ['wwn1','wwn2'])
+ client.zoneremove_peerzone('FabricWWN', 'test_zone', principal: ['wwn1','wwn2'])
+ client.zoneadd_peerzone('FabricWWN', 'test_zone', members: ['wwn1','wwn2'])
+ client.zoneremove_peerzone('FabricWWN', 'test_zone', members: ['wwn1','wwn2'])
+
+ # List latest syslog evets
+ client.syslog_events('999')
+
+ # List latest trap events
+ client.trap_events('999')
+ 
+ # List custom events 
+ # Below method lists latest 10 events from syslog with warning severity
+ client.custom_events('0', '10', 'syslog', 'WARNING')
+ 
+ # Commit changes to fabric defined configuration
+ client.trans_commit('FabricWWN')
+ 
+ # Start transaction on defined configuration
+ client.trans_start('FabricWWN')
+ 
+ # Abort/Rollback transaction
+ client.trans_abort('FabricWWN')
+
+ # Enable defined configuration as an active configuration
+ client.cfgenable('FabricWWN') 
+
+ # List zone Databases
+ client.zonedbs('FabricWWN')
+
+ # List fabric configuration
+ # Defined configuration
+ client.cfgshow('FabricWWN','defined')
+ # Active configuration
+ client.cfgshow('FabricWWN','active')
+ # Both active and defined configuration
+ client.cfgshow('FabricWWN','all')
+``` 
+ 
+## Unit Tests
+==========
+
+To run all unit tests:
+```bash
+ $ rake build:spec
+```
+The output of the coverage tests will be placed into the ``test_reports`` dir.
+
+To run a specific test:
+```bash
+ $ rspec spec/client_spec.rb
+```
+
+## Contributing
+```
+1.Fork it
+2.Create your feature branch (git checkout -b my-new-feature)
+3.Commit your changes (git commit -am 'Added some feature')
+4.Push to the branch (git push origin my-new-feature)
+5.Create new Pull Request
+```
+
+## License
+
+This project is licensed under the Apache 2.0 license.
+