dashboard-api 0.3.0 → 0.4.0

data/doc/_index.html

@@ -149,6 +149,11 @@
                 
               </li>
             
+              <li>
+                <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span>
+                
+              </li>
+            
           </ul>
         </ul>
       
@@ -161,7 +166,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Nov 15 21:16:06 2016 by
+  Generated on Tue Nov 15 22:02:44 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.5 (ruby-2.3.0).
 </div>

data/doc/class_list.html

@@ -43,7 +43,7 @@
 
       <ul id="full_list" class="class">
         <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
-<li id='object_Clients' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_DashboardAPI' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span> &lt; Object<small class='search_info'>Top Level Namespace</small></div></li><li id='object_DashboardAPIVersion' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Devices' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Networks' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Organizations' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_SSIDs' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span><small class='search_info'>Top Level Namespace</small></div></li>
+<li id='object_Clients' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_DashboardAPI' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span> &lt; Object<small class='search_info'>Top Level Namespace</small></div></li><li id='object_DashboardAPIVersion' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Devices' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Networks' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Organizations' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_SSIDs' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Switchports' class='odd'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span><small class='search_info'>Top Level Namespace</small></div></li>
 
       </ul>
     </div>

data/doc/file.README.html

@@ -60,13 +60,14 @@
       <iframe id="search_frame" src="file_list.html"></iframe>
 
       <div id="content"><div id='filecontents'>
-<h1 id="label-Dashboard+API+v0.1.0">Dashboard API v0.1.0</h1>
+<h1 id="label-Dashboard+API+v0.3.0">Dashboard API v0.3.0</h1>
 
 <p>A ruby implementation of the <a
 href="https://documentation.meraki.com/zGeneral_Administration/Other_Topics/The_Cisco_Meraki_Dashboard_API">Meraki
 Dashboard API</a></p>
 
-<p>Documentation <a href="https://">here</a></p>
+<p>Documentation <a
+href="http://www.rubydoc.info/gems/dashboard-api/0.3.0">here</a></p>
 
 <h1 id="label-Preface">Preface</h1>
 
@@ -200,7 +201,7 @@ set as ENV variables above.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Tue Nov 15 21:16:06 2016 by
+  Generated on Tue Nov 15 22:02:45 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.5 (ruby-2.3.0).
 </div>

data/doc/index.html

@@ -60,13 +60,14 @@
       <iframe id="search_frame" src="class_list.html"></iframe>
 
       <div id="content"><div id='filecontents'>
-<h1 id="label-Dashboard+API+v0.1.0">Dashboard API v0.1.0</h1>
+<h1 id="label-Dashboard+API+v0.3.0">Dashboard API v0.3.0</h1>
 
 <p>A ruby implementation of the <a
 href="https://documentation.meraki.com/zGeneral_Administration/Other_Topics/The_Cisco_Meraki_Dashboard_API">Meraki
 Dashboard API</a></p>
 
-<p>Documentation <a href="https://">here</a></p>
+<p>Documentation <a
+href="http://www.rubydoc.info/gems/dashboard-api/0.3.0">here</a></p>
 
 <h1 id="label-Preface">Preface</h1>
 
@@ -200,7 +201,7 @@ set as ENV variables above.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Tue Nov 15 21:16:06 2016 by
+  Generated on Tue Nov 15 22:02:45 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.5 (ruby-2.3.0).
 </div>

data/doc/method_list.html

@@ -157,6 +157,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Switchports.html#get_single_switch_port-instance_method" title="Switchports#get_single_switch_port (method)">#get_single_switch_port</a></span>
+      <small>Switchports</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Organizations.html#get_snmp_status-instance_method" title="Organizations#get_snmp_status (method)">#get_snmp_status</a></span>
       <small>Organizations</small>
@@ -164,6 +172,14 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Switchports.html#get_switch_ports-instance_method" title="Switchports#get_switch_ports (method)">#get_switch_ports</a></span>
+      <small>Switchports</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Organizations.html#get_third_party_peers-instance_method" title="Organizations#get_third_party_peers (method)">#get_third_party_peers</a></span>
@@ -252,6 +268,14 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Switchports.html#update_switchport-instance_method" title="Switchports#update_switchport (method)">#update_switchport</a></span>
+      <small>Switchports</small>
+    </div>
+  </li>
+  
+
 
       </ul>
     </div>

data/doc/top-level-namespace.html

@@ -84,7 +84,7 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>, <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span>
     
   
     
@@ -104,7 +104,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Nov 15 21:16:06 2016 by
+  Generated on Tue Nov 15 22:02:45 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.5 (ruby-2.3.0).
 </div>

data/lib/clients.rb

@@ -1,3 +1,5 @@
+# Clients section of the Meraki Dashboard API
+# @author Joe Letizia
 module Clients
   # Return client usage for a specific device
   # @param [String] serial meraki serial number of the device

data/lib/dashboard-api.rb

@@ -6,6 +6,8 @@ require 'networks'
 require 'devices'
 require 'clients'
 require 'ssids'
+require 'switchports'
+
 # Ruby Implementation of the Meraki Dashboard api
 # @author Joe Letizia
 class DashboardAPI
@@ -16,6 +18,7 @@ class DashboardAPI
   include Clients
   include Devices
   include SSIDs
+  include Switchports
   base_uri "https://dashboard.meraki.com/api/v0"
 
   attr_reader :key

data/lib/dashboard-api/version.rb

@@ -1,3 +1,6 @@
+# Version number of the Gem build
+# @author Joe Letizia
 module DashboardAPIVersion
-  VERSION = "0.3.0"
+  # Current version number of the gem
+  VERSION = "0.4.0"
 end

data/lib/devices.rb

@@ -1,3 +1,5 @@
+# Devices section of the Meraki Dashboard API
+# @author Joe Letizia
 module Devices
   # List all devices in a given network
   # @param [String] network_id network that you want to get devices for
@@ -47,7 +49,7 @@ module Devices
 
   # Remove a single device from a network
   # @param [String] network_id dashboard network id to remove device from
-  # @param [String] serial meraki serial number for device to remove
+  # @param [String] device_serial meraki serial number for device to remove
   # @return [Integer] http_code HTTP code for API call
   def remove_device_from_network(network_id, device_serial)
     self.make_api_call("/networks/#{network_id}/devices/#{device_serial}/remove", 'POST')

data/lib/ssids.rb

@@ -1,3 +1,5 @@
+# SSIDs section of the Meraki Dashboard API
+# @author Joe Letizia
 module SSIDs
   # Get a list of the SSIDs and their attributes for a network
   # @param [String] network_id network id where the SSIDs you exists are

data/lib/switchports.rb

@@ -0,0 +1,33 @@
+# Switchports section of the Meraki Dashboard API
+# @author Joe Letizia
+module Switchports
+  # Get configuration for all switchports on a given switch
+  # @param [String] device_serial meraki serial number of the switch
+  # @return [Array] an array of Hashes, each containing the switchports attributes / configuration
+  def get_switch_ports(device_serial)
+    self.make_api_call("/devices/#{device_serial}/switchPorts", 'GET')
+  end
+
+  # Get configuration for a single switch port
+  # @param [String] device_serial meraki serial number of the switch
+  # @param [Integer] port_number port number you want to modify 
+  # @return [Hash] hash of the switch ports attributes
+  def get_single_switch_port(device_serial, port_number)
+    raise 'Invalid switchport provided' unless port_number.is_a?(Integer)
+    self.make_api_call("/devices/#{device_serial}/switchPorts/#{port_number}", 'GET')
+  end
+
+  # Update the attributes for a given switchport
+  # @param [String] device_serial meraki serial number of the switch
+  # @param [Integer] port_number port number you want to modify 
+  # @param [Hash] options hash of attributes. Keys can include name, tags, enabled, type, vlan, voiceVlan
+  #   allowedVlans, poeEnabled, isolationEnabled, rstpEnabled, stpGuard, accessPolicyNumber. For values to these keys, please refer to the official Meraki Dashboard API documentation.
+  # @return [Hash] hash of the update port attributes
+  def update_switchport(device_serial, port_number, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    raise 'Invalid switchport provided' unless port_number.is_a?(Integer)
+    options = {:body => options}
+    
+    self.make_api_call("/devices/#{device_serial}/switchPorts/#{port_number}", 'PUT', options)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dashboard-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joe Letizia
@@ -115,6 +115,7 @@ files:
 - doc/Networks.html
 - doc/Organizations.html
 - doc/SSIDs.html
+- doc/Switchports.html
 - doc/_index.html
 - doc/class_list.html
 - doc/css/common.css
@@ -136,6 +137,7 @@ files:
 - lib/networks.rb
 - lib/organizations.rb
 - lib/ssids.rb
+- lib/switchports.rb
 homepage: https://github.com/jletizia/dashboardapi
 licenses: []
 metadata: {}