junos-ez-stdlib 0.1.2 → 1.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjZiNjRhZDYwMmQ4N2IxODdhOGM1YzUyNzY4M2Q5MmNkM2JjOTAxZQ==
-  data.tar.gz: !binary |-
-    YTA1YzNjNWE4OTgyNTg2M2JkNGFkMzhjMGQ3OWY5MzA1Mjg3ZTA4Nw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NTAxYTA0NTU3Y2RjMDg3ZWU0NTExYjVkNDdjOGJhMDdhNTg5Nzg3NDg5Yzc2
-    Y2E4OTlkZmY2ZmNjNjRmZGFmOTQxOTMyMTVhYmExYjczZWZkZWYwNGY2YWFl
-    OWVmZjEzZDJhZWFlYjcxNDI1M2VmOWVmMjY4ZDFkY2QwYWM1ZmE=
-  data.tar.gz: !binary |-
-    N2Y1NzgyYjE5MzYzYWQ4ZDliMWY3Zjg3MWVlNGIyNGE5YTU5NDExNzZjMDg4
-    YzU1NDliNmJjYTgwYzA2Y2UwMmNjZDMxNWU1ZGM0MjZhZDBmZDExYmU1YmZk
-    NTBhZGE4YjE5ZDRhZTk0ODE1ZGQ2Mzc0MmU3Y2E5NDM2OWJiYjQ=
+SHA1:
+  metadata.gz: c697205390d0ed04e57f3c85a19e990953fb4805
+  data.tar.gz: e64aa12fab174460cc502e8b441dff3661a7fbad
+SHA512:
+  metadata.gz: 4c82a99479059c7349217f6ddc9a0f9292c0b79c65a4539a6c8b626e65d1f402c6aa9d805111efb1d9182b2d820c56e691fbfe3ea47511e7219167e21c2220b4
+  data.tar.gz: 2c52b83d9e6f28063d7756be9152a8f0651bc00acf9c537192ca1e9469dde58e9d67d99197c3004b50e9407de58f73dd1bcf2afb89604d98d9c40c6272f66c3b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+*.gem
+coverage

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+LineLength:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9.3-p551
+  - 2.0.0-p648
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1
+matrix:
+  allow_failures:
+    - rvm: 1.9.3-p551
+    - rvm: 2.0.0-p648
+  fast_finish: true
+before_install: gem update --remote bundler
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rake build

data/CHANGELOG.md

@@ -1,62 +1,103 @@
 # 2013-April
 
   0.0.10: 2013-04-26
-  
+
     Initial release of code into RubyGems.  Code tested on EX and SRX-branch. Consider this code
     as "early-adopter".  Comments/feedback is welcome and appreciated.
 
   0.0.11: 2013-04-26
-  
+
     Updated Junos::Ez::RE::Utils
       #memory changed :procs from Hash to Array  
       #users changed return from Hash to Array
-    
+
   0.0.12: 2013-04-26
-  
+
     Updated Junos::Ez::FS:Utils#ls to include :symlink information
     Adding Junos::Ez::Users::Provider for login management
     Adding Junos::Ez::UserAuths::Provider for SSH-key management
-    
+
   0.0.14: 2013-04-28
-  
+
     Completed initial documentation.  Still more work to be done with these files
     but the "enough to get started" information is now available
-    
+
 # 2013-May    
 
   0.0.15: 2013-05-02
-  
+
     L2ports - added support for framework to read [edit vlans] stanza to recognize interfaces configured
     there vs. under [edit interfaces]
-    
+
     IPports - added :acl_in and :acl_out for stateless ACL filtering.  added .status method to return
     runtime status information about the port
-    
+
     RE::Utils - misc updates, and documentation
 
   0.0.16: 2013-05-03
-  
+
     RE::Utils - added support for license-key management.  Renamed "software" methods from "xxx_software"
     to "software_xxx" to be consistent with other naming usage.  Updated docs.
-  
+
   0.0.17: 2013-05-05
-  
+
     FS::Utils - updated docs.  fixed methods so that all "error" scenarios raise IOError excaptions.
-  
+
   0.1.0: 2013-05-06
-  
+
     All docs and code _finished_ for the inital release of code.  Always more to do, but at this
     point, declaring the framework "good for early adopter testing".  Looking forward to bug-reports,
     please open issues against this repo.  Thank you!
-    
+
   0.1.1: 2013-05-29
-  
+
     Fixed a small bug in fact gathering for hardwaremodel
-  
+
 # 2013-July
 
   0.1.2: 2013-07-04
-  
+
     Fixed issue#3.  Previously this gem would not work with non-VC capable EX switches.  Updated
     the `facts/version.rb` file to handle these devices.  Also added a new fact `:vc_capable` that
     is set to `true` if the EX can support virtual-chassis, and `false` if it cannot.
+
+# 2013-Aug
+
+  0.2.0:
+
+    Fixed issue #6.  Added support for EX4300 platform.  Added new provider for Link Aggregation Group
+    resources (LAGports)
+
+# 2016-March
+
+  1.0.0:
+
+    Fixed issues
+      Issue #17 Add support for OCX device.
+      Issue #20 "under development" error is thrown while importing the interface_create recipe from the Chef-Server.
+      Issue #22 "netdev_vlan" resource action delete is not working fine while invoking from the JUNOS Chef-Client.
+      Issue #23 RPC command error: commit-configuration is getting thrown on Invoking the "netdev_lag" resource from
+                 JUNOS Chef Client.
+      Issue #27 Duplicate declaration of lag configuration in a recipe is giving NoMethodError: undefined method
+                 `properties' for nil:NilClass.
+      Issue #30 Error in rerunning netdev_lag interface.
+      Issue #33 undefined method `properties' for nil:NilClass error is thrown if the backup RE is unreachable.
+      Issue #35 Error in running chef client from Backup RE.
+      Issue #39 Getting 'Junos::Ez::NoProviderError' error on qfx device.
+      Issue #42 Raise exception to handle warnings in <error-severity>.
+
+    Enhancement
+      * Add support for configuring l2_interface on MX device.
+      * Add support for provider 'group' for configuring JUNOS groups.
+
+# 2016-August
+
+  1.0.3
+     Fixed issues
+     Issue #46 Removing references to rake from gemspec
+     Issue #47 cannot get the git source code
+
+     Enhancement
+     * Valid project metadata and rake for cleanly building/releasing
+     * Test hooks and badges
+     * netconf gem pessimistic version constraint to 0.3.1

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'simplecov', require: false, group: :test

data/README.md

@@ -1,11 +1,14 @@
+[![Gem Version](https://badge.fury.io/rb/junos-ez-stdlib.svg)](https://badge.fury.io/rb/junos-ez-stdlib)[![Dependency Status](https://gemnasium.com/badges/github.com/Juniper/ruby-junos-ez-stdlib.svg)](https://gemnasium.com/github.com/Juniper/ruby-junos-ez-stdlib)
+[![Build Status](https://travis-ci.org/Juniper/ruby-junos-ez-stdlib.svg?branch=master)](https://travis-ci.org/Juniper/ruby-junos-ez-stdlib)
+
 # OVERVIEW
 
 Ruby framework to support Junos OS based device management automation.  
 
 This is the "standard library" or "core" set of functionality that should work on most/all Junos OS based devices.  
 
-This framework is build on top of the NETCONF gem which uses XML as the fundamental data-exchange.  So no 
-"automating the CLI" or using SNMP.  The purpose of this framework is to **enable automation development 
+This framework is build on top of the NETCONF gem which uses XML as the fundamental data-exchange.  So no
+"automating the CLI" or using SNMP.  The purpose of this framework is to **enable automation development
 without requiring specific Junos XML knowledge**.
 
 Further documentation can be found in the *docs* subdirectory.
@@ -14,32 +17,32 @@ Further documentation can be found in the *docs* subdirectory.
 
 The framework is comprised of these basic eloements:
 
-  - Facts: 
+  - Facts:
 
     A Hash of name/value pairs of information auto-collected.  Fact values can be Hash structures as well
     so you can have deeply nested fact data.  You can also define your own facts in addition to the "stdlib" facts.
     The facts are used by the framework to create a platform indepent layer of abstraction.  This means
     that managing a VLAN, for example, is the same regardless of the underlying hardware platofrm (EX, QFX,
     MX, SRX, ...)
-    
-  - Resources: 
 
-    Resources allow you to easily configure and perform operational functions on specific items within Junos, 
+  - Resources:
+
+    Resources allow you to easily configure and perform operational functions on specific items within Junos,
     for example VLANs, or switch ports.  A resource has *properties* that you manipuate as Hash.  You can
-    interact with Junos using resource methods like `read!`, `write!`, `delete!`, `activate!`, `deactivate!`, etc. 
+    interact with Junos using resource methods like `read!`, `write!`, `delete!`, `activate!`, `deactivate!`, etc.
     For a complete listing of resource methods, refer to the *docs* directory
-    
+
   - Providers:
 
     Providers allow you to manage a collection of resource, and most commonly, select a resource.  
     The purpose of a provider/resource is to automate the life-cycle of common changes, like adding
-    VLANs, or ports to a VLAN.  A provider also allows you to obtain a `list` of resources 
-    (Array of *names*) or a `catalog` (Hash of resource properties).  Providers may include resource 
-    specific functionality, like using complex YAML/Hash data for easy import/export and provisioning 
+    VLANs, or ports to a VLAN.  A provider also allows you to obtain a `list` of resources
+    (Array of *names*) or a `catalog` (Hash of resource properties).  Providers may include resource
+    specific functionality, like using complex YAML/Hash data for easy import/export and provisioning
     with Junos.  If you need the ability to simply apply config-snippets that you do not need to model
-    as resources (as you might for initial device commissioning), the Utilities library is where you 
+    as resources (as you might for initial device commissioning), the Utilities library is where you
     want to start.
-  
+
   - Utilities:
 
     Utilities are simply collections of functions.  The **configuration** utilities, for example, will
@@ -47,9 +50,9 @@ The framework is comprised of these basic eloements:
     for unmanaged provider/resources (like initial configuration of the device).  The
     **routing-engine** utilities, for example, will allow you to easily upgrade software, check
     memory usage, and do `ping` operations.
-  
+
 # EXAMPLE USAGE
-  
+
 ```ruby
 require 'pp'
 require 'net/netconf/jnpr'
@@ -60,7 +63,7 @@ unless ARGV[0]
    exit 1
 end
 
-# login information for NETCONF session 
+# login information for NETCONF session
 login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
 
 ## create a NETCONF object to manage the device and open the connection ...
@@ -71,8 +74,8 @@ ndev.open
 puts "OK!"
 
 ## Now bind providers to the device object. The 'Junos::Ez::Provider' must be first.
-## This will retrieve the device 'facts'.  The other providers allow you to define the 
-## provider variables; so this example is using 'l1_ports' and 'ip_ports', but you could name 
+## This will retrieve the device 'facts'.  The other providers allow you to define the
+## provider variables; so this example is using 'l1_ports' and 'ip_ports', but you could name
 ## them what you like, yo!
 
 Junos::Ez::Provider( ndev )
@@ -125,7 +128,7 @@ ndev.cu.rollback!
 
 ndev.close
 ```
-  
+
 # PROVIDERS
 
 Providers manage access to individual resources and their associated properties.  Providers/resources exists
@@ -137,29 +140,30 @@ documentation on Providers/Resources, see the *docs* directory.
   - Vlans: VLAN resource management
   - IPports: IP v4 port management
   - StaticHosts: Static Hosts [system static-host-mapping ...]  
-  - StaticRoutes: Static Routes [routing-options static ...] 
+  - StaticRoutes: Static Routes [routing-options static ...]
+  - Group: JUNOS groups management
 
 # UTILITIES
 
   - Config:
-    
+
     These functions allow you to load config snippets, do commit checks, look at config diffs, etc.
-    Generally speaking, you would want to use the Providers/Resources framework to manage specific 
+    Generally speaking, you would want to use the Providers/Resources framework to manage specific
     items in the config.  This utility library is very useful when doing the initial commissioning
     process, where you do not (cannot) model every aspect of Junos.  These utilities can also be
     used in conjunction with Providers/Resources, specifically around locking/unlocking and committing
     the configuration.
-  
+
   - Filesystem:
-  
+
     These functions provide you "unix-like" commands that return data in Hash forms rather than
     as string output you'd normally have to screen-scraps.  These methods include `ls`, `df`, `pwd`,
     `cwd`, `cleanup`, and `cleanup!`
 
   - Routing-Engine:
-  
-    These functions provide a general collection to information and functioanlity for handling 
-    routing-engine (RE) processes.  These functions `reboot!`, `shutdown!`, `install_software!`, 
+
+    These functions provide a general collection to information and functioanlity for handling
+    routing-engine (RE) processes.  These functions `reboot!`, `shutdown!`, `install_software!`,
     `ping`.  Information gathering such as memory-usage, current users, and RE status information
     is also made available through this collection.
 
@@ -167,14 +171,21 @@ documentation on Providers/Resources, see the *docs* directory.
 
   * gem netconf
   * Junos OS based products
-  
-# INSTALLATION 
+
+# INSTALLATION
 
   * gem install junos-ez-stdlib
 
 # CONTRIBUTORS
+  Juniper Networks is actively contributing to and maintaining this repo. Please contact jnpr-community-netdev@juniper.net
+  for any queries.
+
+  Contributors:
+  [John Deatherage](https://github.com/routelastresort), [Nitin Kumar](https://github.com/vnitinv),
+  [Priyal Jain](https://github.com/jainpriyal), [Ganesh Nalawade](https://github.com/ganeshnalawade)
 
-  * Jeremy Schulman, @nwkautomaniac
+  Former Contributors:  
+  [Jeremy Schulman](https://github.com/jeremyschulman)
 
 # LICENSES
 

data/Rakefile

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

data/SUGGESTION-BOX/README.md

@@ -0,0 +1,32 @@
+# PLEASE CONTRIBUTE
+
+## IDEAS & SUGGESTIONS
+
+If you have a suggestion or idea, please write it up as a separate file and do a *pull request*.  Your file will be added to this directory as a separate file so folks can peer-review and crowdsource around it.  
+
+It would be helpful to include the following information in the file:
+
+1. SYNOPSIS - A brief statement of what is needed
+2. TARGET PLATFORMS - A list of Junos OS based platforms this would apply to
+3. TARGET RELEASE - If you have specific Junos OS release requirements, please state them
+4. TIMELINE - If you have a specific *gotta have it* by date, please let us know
+5. GORY DETAILS - Please provide as much information you can around the use-case or application
+
+Please name your file in the following format:
+
+    <DATEYYMMDD>_<GITHUB-USER-HANDLE>_<IDEA-NAME>.md
+
+For example, let's say I was going to submit something around virtual-routing (VRF), I would name the file:
+
+    20130430_jeremyschulman_vrf.md
+    
+Thank you all for your support and contributions!
+
+## CODE & BUG-FIXES
+
+Pull requests are welcome and appreciated !
+
+# THANK YOU
+
+This framework is built for the commmunity of DevOps and NetDevOps that need to create automation solutions.  Your help and participation in the development of this software is essential  
+

data/docs/Providers/Group.md

@@ -0,0 +1,61 @@
+# Junos::Ez::Group::Provider
+
+Manages JUNOS group properties
+
+# EXAMPLE
+
+The provider *name* selector is the JUNOS group name, e.g. "service_group".
+
+```ruby
+Junos::Ez::Group::Provider( ndev, :group )
+
+grp = ndev.group["service_group"]
+
+grp[:format] = 'set'
+grp[:path] = 'services.set'
+
+grp.write!
+
+```
+
+# PROPERTIES
+
+  - `:format` - JUNOS configuration format is file. It can be 'xml', 'text' or 'set'. Default is 'xml'
+  - `:path` - Path of configuration file that is applied inside JUNOS group hierarchy.
+
+# METHODS
+
+No additional methods at this time ...
+
+# USAGE NOTES
+
+Contents of 'service.set' file
+
+````
+% cat services.set 
+set system services ftp
+set system services ssh
+set system services netconf ssh
+````
+
+JUNOS group configuration reflected on executing above example.
+
+````
+{master}[edit]
+junos@switch# show groups service_group 
+system {
+    services {
+        ftp;
+        ssh;
+        netconf {
+            ssh;
+        }
+    }
+}
+
+junos@switch# show apply-groups
+apply-groups [ global re0 re1 service_group ];
+
+````
+
+