Sloe

Sloe uses NETCONF and/or SNMP to gather data regarding a network device. Designed to help with automated testing this gem can also be used with things like Ruby on Rails

Installation

Add this line to your application's Gemfile:

gem 'sloe'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sloe

Usage

This gem augments the functionality of Netconf::SSH, Net::SCP and SNMP gems. Please refer to those gem's documentation or detailed instruction on how to use this gem.

All Netconf methods are accessed via the rpc() method. All Net::SCP methods are access via the scp() method. All SNMP methods are accessed via the snmp() method. For example:

require 'sloe'

# create options hash
options = {:target => 'remotehost', :username => 'foo', :password => 'bar'}

Sloe::Device.new(options) { |device|

  # call a Netconf RPC and display some of output
  inventory = device.rpc.get_chassis_inventory
  puts "Chassis: " + inventory.xpath('chassis/description').text

  # display SNMP data
  puts device.snmp.get_value('sysDescr.0')
} 

An alternate way to use this module is:

require 'sloe'

# create options hash
options = {:target => 'remotehost', :username => 'foo', :password => 'bar'}

device = Sloe::Device.new(options)

# call a Netconf RPC and display some of output
inventory = device.rpc.get_chassis_inventory
puts "Chassis: " + inventory.xpath('chassis/description').text

# display SNMP data
puts device.snmp.get_value('sysDescr.0')

All options supported by Netconf, Net::SCP and SNMP are supported in this gem too. The :target Netconf::SSH option is aliased to the SNMP :host option so there is no need to duplicate that option key.

Vendor specific Netconf extensions

Sloe supports vendor specific Netconf extensions. To add that vendor specific support call new() on one of the supported classes. Sloe supports the following:

*Sloe::Device - no vendor specific Netconf extensions added

*Sloe::Junos - Junos vendor specific Netconf extensions added

Just simply call Sloe::Junos.new() to get the Junos extensions added

Junos specific extension

For Junos specific Netconf extensions please refer to the Juniper webiste

As well as supporting Junos specific Netconf RPCs Sloe::Junos also supports the cli() method. This method allows you to execute CLI commands on the Juniper device. For example

device.cli("show version")
device.cli("show ospf interfaces")

By default this call will respond with a string. This should make this call compatable with existing automation scripts that are based on CLI commands. To get an XML result tree fragment use the rpc.command() API.

SUPPORT

This software is not officially supported by Juniper Networks, but by a team dedicated to helping customers, partners, and the development community. To report bug-fixes, issues, susggestions, please contact David Gethings [email protected]

Contributing

1. Fork it
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 new Pull Request