Module: Organizations

Included in:
DashboardAPI
Defined in:
lib/organizations.rb

Overview

Organization section of the Meraki Dashboard API

Author:

  • Joe Letizia

Instance Method Summary collapse

Instance Method Details

#get_inventory(org_id) ⇒ Array

Returns the current inventory for an organization

Parameters:

  • org_id (String) —

    dashboard organization ID

Returns:

  • (Array) —

    an array of hashes containg information on each individual device



21
22
23
 
# File 'lib/organizations.rb', line 21

def get_inventory(org_id)
  self.make_api_call("/organizations/#{org_id}/inventory", 'GET')
end

#get_license_state(org_id) ⇒ Hash

Returns the current license state for a given organization

Parameters:

  • org_id (String) —

    dashboard organization ID

Returns:

  • (Hash) —

    results contains the current license state information



14
15
16
 
# File 'lib/organizations.rb', line 14

def get_license_state(org_id)
  self.make_api_call("/organizations/#{org_id}/licenseState", 'GET')
end

#get_organization(org_id) ⇒ Hash

Returns information about an organization

Parameters:

  • org_id (String) —

    dashboard organization ID

Returns:

  • (Hash) —

    results contains the org id and name of the given organization



7
8
9
 
# File 'lib/organizations.rb', line 7

def get_organization(org_id)
  self.make_api_call("/organizations/#{org_id}", 'GET')
end

#get_snmp_status(org_id) ⇒ Hash

Returns the current SNMP status for an organization

Parameters:

  • org_id (String) —

    dashboard organization ID

Returns:

  • (Hash) —

    a hash containing all SNMP configuration information for an organization



28
29
30
 
# File 'lib/organizations.rb', line 28

def get_snmp_status(org_id)
  self.make_api_call("/organizations/#{org_id}/snmp", 'GET')
end

#get_third_party_peers(org_id) ⇒ Array

Returns the configurations for an organizations 3rd party VPN peers

Parameters:

  • org_id (String) —

    dashboard organization ID

Returns:

  • (Array) —

    an arrry of hashes containing the configuration information for each 3rd party VPN peer



36
37
38
 
# File 'lib/organizations.rb', line 36

def get_third_party_peers(org_id)
  self.make_api_call("/organizations/#{org_id}/thirdPartyVPNPeers", 'GET')
end