123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588 |
- from __future__ import print_function
- #
- # Copyright (c) 2018-2020 Joe Clarke <jclarke@cisco.com>
- #
- # Redistribution and use in source and binary forms, with or without
- # modification, are permitted provided that the following conditions
- # are met:
- # 1. Redistributions of source code must retain the above copyright
- # notice, this list of conditions and the following disclaimer.
- # 2. Redistributions in binary form must reproduce the above copyright
- # notice, this list of conditions and the following disclaimer in the
- # documentation and/or other materials provided with the distribution.
- #
- # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
- # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
- # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- # SUCH DAMAGE.
- from builtins import str
- from builtins import object
- import requests
- import logging
- class Meraki(object):
- MERAKI_API = "https://api.meraki.com/api/v0"
- _headers = {"X-Cisco-Meraki-API-Key": None, "Content-type": "application/json"}
- _logit = False
- _key = None
- _name = None
- _id = None
- _class_name = "Meraki"
- _name_prop = "name"
- _id_prop = "id"
- _api_url_endpoint = ""
- def __init__(self, **kwargs):
- if "logit" in kwargs:
- self._logit = kwargs["logit"]
- if "key" in kwargs:
- self._key = kwargs["key"]
- self._headers["X-Cisco-Meraki-API-Key"] = kwargs["key"]
- if "name" in kwargs:
- self._name = kwargs["name"]
- if "id" in kwargs:
- self._id = str(kwargs["id"])
- self.__dict = {}
- self._initialized = False
- def set_key(self, key):
- self._key = key
- self._headers["X-Cisco-Meraki-API-Key"] = key
- def set_name(self, name):
- self._name = name
- def _set_id(self, id):
- self._id = id
- def __check_headers(self):
- if self._headers["X-Cisco-Meraki-API-Key"] is None:
- msg = "Meraki API key is not set!"
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- return True
- def realize(self):
- return self._check_obj()
- @staticmethod
- def _get_json_errors(response):
- res = ""
- try:
- jobj = response.json()
- if "errors" in jobj:
- res = ", ".join(jobj["errors"])
- except Exception:
- pass
- return res
- def _check_obj(self):
- if self._initialized:
- return True
- if self._id is None:
- msg = "{} id is not set!".format(self._class_name)
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- return self.__get_current_obj()
- def __get_current_obj(self):
- if not self.__check_headers():
- return False
- url = self.MERAKI_API + self._api_url_endpoint + "/" + self._id
- try:
- response = requests.request("GET", url, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error getting {} for {}: {} ({})".format(self._class_name.lower(), self._id, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- jobj = response.json()
- self.__populate_obj(jobj)
- # Object may not have a name yet.
- if self._name_prop in jobj:
- self._name = jobj[self._name_prop]
- self._initialized = True
- return True
- def __populate_obj(self, jobj):
- for k, v in list(jobj.items()):
- self.__dict[k] = v
- def get(self, field):
- if not self._check_obj():
- raise Exception("Failed to initialize object!")
- if field in self.__dict:
- return self.__dict[field]
- else:
- raise Exception("Field {} does not exist".format(field))
- def set(self, field, value):
- if not self._check_obj():
- raise Exception("Failed to initialize object!")
- self.__dict[field] = value
- def get_organizations(self):
- if not self.__check_headers():
- return None
- url = self.MERAKI_API + "/organizations"
- try:
- response = requests.request("GET", url, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error getting list of organizations: {} ({})".format(e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- res = []
- for org in response.json():
- org_obj = Organization(key=self._key, name=org[Organization._name_prop], id=org[Organization._id_prop])
- res.append(org_obj)
- return res
- class Organization(Meraki):
- def __init__(self, **kwargs):
- super(Organization, self).__init__(**kwargs)
- self._class_name = "Organization"
- self._api_url_endpoint = "/organizations"
- self.ORG_API = self.MERAKI_API + self._api_url_endpoint
- def get_inventory(self):
- if not self._check_obj():
- return None
- url = self.ORG_API + "/" + self._id + "/inventory"
- try:
- response = requests.request("GET", url, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error getting inventory for organization {}: {} ({})".format(self._name, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- return response.json()
- def get_networks(self):
- if not self._check_obj():
- return None
- url = self.ORG_API + "/" + self._id + "/networks"
- try:
- response = requests.request("GET", url, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error getting list of networks for {}: {} ({})".format(self._name, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- res = []
- for n in response.json():
- net = Network(key=self._key, name=n[Network._name_prop], id=n[Network._id_prop])
- res.append(net)
- return res
- def create_network(self, name, **kwargs):
- if not self._check_obj():
- return None
- payload = {"name": name}
- for key in ["type", "tags", "timezone", "copy_from_network_id"]:
- if key in kwargs:
- if key == "timezone":
- payload["timeZone"] = kwargs[key]
- elif key == "copy_from_network_id":
- payload["copyFromNetworkId"] = kwargs[key]
- else:
- payload[key] = kwargs[key]
- if "type" not in kwargs:
- payload["type"] = "wireless switch appliance"
- url = self.ORG_API + "/" + self._id + "/networks"
- try:
- response = requests.request("POST", url, json=payload, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error creating new network {} in {}: {} ({})".format(name, self._name, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- jobj = response.json()
- net_obj = Network(key=self._key, id=jobj["id"], name=jobj["name"])
- return net_obj
- class Network(Meraki):
- def __init__(self, **kwargs):
- super(Network, self).__init__(**kwargs)
- self._class_name = "Network"
- self._api_url_endpoint = "/networks"
- self.NET_API = self.MERAKI_API + self._api_url_endpoint
- def get_devices(self):
- if not self._check_obj():
- return None
- url = self.NET_API + "/" + self._id + "/devices"
- try:
- response = requests.request("GET", url, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error getting device list for network {}: {} ({})".format(self._name, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- res = []
- for d in response.json():
- dev = Device(key=self._key, name=d[Device._name_prop], id=d[Device._id_prop])
- res.append(dev)
- return res
- def claim_device(self, dev):
- if not self._check_obj():
- return None
- url = self.NET_API + "/" + self._id + "/devices/claim"
- payload = {"serial": dev._id}
- try:
- response = requests.request("POST", url, json=payload, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error claiming device {} for network {}: {} ({})".format(dev._id, self._name, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- new_dev = Device(key=self._key, id=dev._id, net=self)
- return new_dev
- def create_vlan(self, name, id, subnet, appliance_ip):
- if not self._check_obj():
- return None
- payload = {"id": id, "name": name, "subnet": subnet, "applianceIp": appliance_ip}
- url = self.NET_API + "/" + self._id + "/vlans"
- try:
- response = requests.request("POST", url, json=payload, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error adding VLAN {} (ID: {}) to network {}: {} ({})".format(name, id, self._name, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- jobj = response.json()
- vlan_obj = Vlan(key=self._key, id=jobj["id"], name=jobj["name"], net=self)
- return vlan_obj
- class SSID(Meraki):
- _id_prop = "number"
- def __init__(self, **kwargs):
- super(SSID, self).__init__(**kwargs)
- if "net" not in kwargs:
- raise TypeError("Missing mandatory net argument!")
- self._net = kwargs["net"]
- self._class_name = "SSID"
- self._api_url_endpoint = "/networks/" + self._net.get(Network._id_prop) + "/ssids"
- self.SSID_API = self.MERAKI_API + self._api_url_endpoint
- def update_ssid(self, **kwargs):
- if not self._check_obj():
- return False
- payload = {}
- for key in ["name", "enabled", "auth_mode", "encryption_mode", "psk", "ip_assignment_mode"]:
- if key in kwargs:
- if key == "auth_mode":
- payload["authMode"] = kwargs[key]
- elif key == "encryption_mode":
- payload["encryptionMode"] = kwargs[key]
- elif key == "ip_assignment_mode":
- payload["ipAssignmentMode"] = kwargs[key]
- else:
- payload[key] = kwargs[key]
- if len(payload) == 0:
- return False
- if "ip_assignment_mode" not in kwargs:
- payload["ipAssignmentMode"] = "Bridge mode"
- url = self.SSID_API + "/" + self._id
- try:
- response = requests.request("PUT", url, json=payload, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error updating SSID properties for {}: {} ({})".format(self._id, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- jobj = response.json()
- for k, v in list(jobj.items()):
- self.set(k, v)
- return True
- class Vlan(Meraki):
- def __init__(self, **kwargs):
- super(Vlan, self).__init__(**kwargs)
- if "net" not in kwargs:
- raise TypeError("Missing mandatory net argument!")
- self._net = kwargs["net"]
- self._class_name = "Vlan"
- self._api_url_endpoint = "/networks/" + self._net.get(Network._id_prop) + "/vlans"
- self.VLAN_API = self.MERAKI_API + self._api_url_endpoint
- def update_vlan(self, **kwargs):
- if not self._check_obj():
- return False
- payload = {}
- for key in ["name", "subnet", "appliance_ip", "fixed_ip_assignments", "reserved_ip_ranges", "dns_nameservers"]:
- if key in kwargs:
- if key == "appliance_ip":
- payload["applianceIp"] = kwargs[key]
- elif key == "fixed_ip_assignments":
- payload["fixedIpAssignments"] = kwargs[key]
- elif key == "reserved_ip_ranges":
- payload["reservedIpRanges"] = kwargs[key]
- elif key == "dns_nameservers":
- payload["dnsNameservers"] = kwargs[key]
- else:
- payload[key] = kwargs[key]
- if len(payload) == 0:
- return False
- url = self.VLAN_API + "/" + self._id
- try:
- response = requests.request("PUT", url, json=payload, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error updating VLAN properties for {}: {} ({})".format(self._name, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- jobj = response.json()
- for k, v in list(jobj.items()):
- self.set(k, v)
- return True
- class Device(Meraki):
- _id_prop = "serial"
- def __init__(self, **kwargs):
- super(Device, self).__init__(**kwargs)
- if "net" not in kwargs:
- raise TypeError("Missing mandatory net argument!")
- self._net = kwargs["net"]
- self._class_name = "Device"
- self._api_url_endpoint = "/networks/" + self._net.get(Network._id_prop) + "/devices"
- self.DEV_API = self.MERAKI_API + self._api_url_endpoint
- def remove_device(self):
- if not self._check_obj():
- return False
- url = self.DEV_API + "/" + self._id + "/remove"
- try:
- response = requests.request("POST", url, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Failed to remove device {} for network {}: {} ({})".format(
- self._name, self._net.get(Network._name_prop), e, Meraki._get_json_errors(response)
- )
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- return True
- def update_device(self, **kwargs):
- if not self._check_obj():
- return False
- payload = {}
- for key in ["name", "tags", "lat", "lng", "address", "move_map_marker"]:
- if key in kwargs:
- if key == "move_map_marker":
- payload["moveMapMarker"] = kwargs[key]
- else:
- payload[key] = kwargs[key]
- if len(payload) == 0:
- return False
- url = self.DEV_API + "/" + self._id
- try:
- response = requests.request("PUT", url, json=payload, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error updating device properties for {}: {} ({})".format(self._name, e, Meraki._get_json_errors(response))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- jobj = response.json()
- for k, v in list(jobj.items()):
- if k == "moveMapMarker":
- continue
- self.set(k, v)
- return True
- class SwitchPort(Meraki):
- _id_prop = "number"
- def __init__(self, **kwargs):
- super(SwitchPort, self).__init__(**kwargs)
- if "dev" not in kwargs:
- raise TypeError("Missing mandatory dev argument!")
- self._dev = kwargs["dev"]
- self._class_name = "SwitchPort"
- self._api_url_endpoint = "/devices/" + self._net.get(Network._id_prop) + "/switchPorts"
- self.SWP_API = self.MERAKI_API + self._api_url_endpoint
- def update_switchport(self, **kwargs):
- if not self._check_obj():
- return False
- payload = {}
- for key in ["name", "tags", "enabled", "type", "vlan", "voice_vlan", "allowed_vlans", "poe_enabled"]:
- if key in kwargs:
- if key == "voice_vlan":
- payload["voiceVlan"] = kwargs[key]
- elif key == "allowed_vlans":
- payload["allowedVlans"] = kwargs[key]
- elif key == "poe_enabled":
- payload["poeEnabled"] = kwargs[key]
- else:
- payload[key] = kwargs[key]
- if len(payload) == 0:
- return False
- url = self.SWP_API + "/" + self._id
- try:
- response = requests.request("PUT", url, json=payload, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error updating switchport properties for {} on device {}: {} ({})".format(
- self._id, self._dev.get(Device._name_prop), e, Meraki._get_json_errors(response)
- )
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- jobj = response.json()
- for k, v in list(jobj.items()):
- self.set(k, v)
- return True
|