Includes new endpoints for February release (0.8)

Author: Shiyue Cheng

examples/org_wide_clients.py

@@ -4,19 +4,25 @@
 
 import meraki
 
-# Either input your API key below by uncommenting line 10 and changing line 15 to api_key=api_key,
+# Either input your API key below by uncommenting line 10 and changing line 16 to api_key=api_key,
 # or set an environment variable (preferred) to define your API key. The former is insecure and not recommended.
 # For example, in Linux/macOS:  export MERAKI_DASHBOARD_API_KEY=093b24e85df15a3e66f1fc359f4c48493eaa1b73
 # api_key = '093b24e85df15a3e66f1fc359f4c48493eaa1b73'
 
 
 def main():
     # Instantiate a Meraki dashboard API session
-    dashboard = meraki.DashboardAPI(api_key=None, base_url='https://api.meraki.com/api/v0/', log_file_prefix=__file__[:-3], print_console=False)
+    dashboard = meraki.DashboardAPI(
+        api_key='',
+        base_url='https://api-mp.meraki.com/api/v0/',
+        log_file_prefix=os.path.basename(__file__)[:-3],
+        log_path='',
+        print_console=False
+    )
 
     # Get list of organizations to which API key has access
     organizations = dashboard.organizations.getOrganizations()
-
+    
     # Iterate through list of orgs
     for org in organizations:
         print(f'\nAnalyzing organization {org["name"]}:')

meraki/__init__.py

@@ -49,6 +49,7 @@
 from .api.malware_settings import MalwareSettings
 from .api.management_interface_settings import ManagementInterfaceSettings
 from .api.meraki_auth_users import MerakiAuthUsers
+from .api.monitored_media_servers import MonitoredMediaServers
 from .api.named_tag_scope import NamedTagScope
 from .api.netflow_settings import NetFlowSettings
 from .api.networks import Networks
@@ -79,7 +80,7 @@
 from .api.wireless_settings import WirelessSettings
 from .config import (
     API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, WAIT_ON_RATE_LIMIT,
-    MAXIMUM_RETRIES, OUTPUT_LOG, LOG_FILE_PREFIX, PRINT_TO_CONSOLE, SIMULATE_API_CALLS
+    MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE, SIMULATE_API_CALLS
 )
 
 
@@ -94,23 +95,26 @@ class DashboardAPI(object):
     - wait_on_rate_limit (boolean): retry if 429 rate limit error encountered?
     - maximum_retries_on_rate_limit (integer): retry up to this many times when encountering 429s or other server-side errors
     - output_log (boolean): create an output log file?
+    - log_path (string): path to output log; by default, working directory of script if not specified
     - log_file_prefix (string): log file name appended with date and timestamp
     - print_console (boolean): if output log used, output to console too?
     - simulate (boolean): simulate POST/PUT/DELETE calls to prevent changes?
     """
 
     def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeout=SINGLE_REQUEST_TIMEOUT,
                  certificate_path=CERTIFICATE_PATH, wait_on_rate_limit=WAIT_ON_RATE_LIMIT,
-                 maximum_retries=MAXIMUM_RETRIES, output_log=OUTPUT_LOG, log_file_prefix=LOG_FILE_PREFIX,
-                 print_console=PRINT_TO_CONSOLE, simulate=SIMULATE_API_CALLS):
+                 maximum_retries=MAXIMUM_RETRIES, output_log=OUTPUT_LOG, log_path=LOG_PATH,
+                 log_file_prefix=LOG_FILE_PREFIX, print_console=PRINT_TO_CONSOLE, simulate=SIMULATE_API_CALLS):
         # Check API key
         api_key = api_key or os.environ.get(API_KEY_ENVIRONMENT_VARIABLE)
         if not api_key:
             raise APIKeyError()
 
         # Configure logging
         self._logger = logging.getLogger(__name__)
-        self._log_file = f'{log_file_prefix}_log__{datetime.now():%Y-%m-%d_%H-%M-%S}.log'
+        if log_path and log_path[-1] != '/':
+            log_path += '/'
+        self._log_file = f'{log_path}{log_file_prefix}_log__{datetime.now():%Y-%m-%d_%H-%M-%S}.log'
         if output_log:
             logging.basicConfig(
                 filename=self._log_file,
@@ -183,6 +187,7 @@ def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeo
         self.malware_settings = MalwareSettings(self._session)
         self.management_interface_settings = ManagementInterfaceSettings(self._session)
         self.meraki_auth_users = MerakiAuthUsers(self._session)
+        self.monitored_media_servers = MonitoredMediaServers(self._session)
         self.named_tag_scope = NamedTagScope(self._session)
         self.netflow_settings = NetFlowSettings(self._session)
         self.networks = Networks(self._session)

meraki/api/clients.py

@@ -55,20 +55,24 @@ def getNetworkClients(self, networkId: str, total_pages=1, direction='next', **k
         return self._session.get_pages(metadata, resource, params, total_pages, direction)
 
 
-    def provisionNetworkClients(self, networkId: str, **kwargs):
+    def provisionNetworkClients(self, networkId: str, mac: str, devicePolicy: str, **kwargs):
         """
         **Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.**
         https://api.meraki.com/api_docs#provisions-a-client-with-a-name-and-policy
         
         - networkId (string)
         - mac (string): The MAC address of the client. Required.
-        - name (string): The display name for the client. Optional. Limited to 255 bytes.
         - devicePolicy (string): The policy to apply to the specified client. Can be 'Whitelisted', 'Blocked', 'Normal' or 'Group policy'. Required.
-        - groupPolicyId (string): The ID of the desired group policy to apply to the client. Required if 'devicePolicy' is set to "Group policy". Otherwise this is ignored.
+        - name (string): The display name for the client. Optional. Limited to 255 bytes.
+        - groupPolicyId (integer): The ID of the desired group policy to apply to the client. Required if 'devicePolicy' is set to "Group policy". Otherwise this is ignored.
         """
 
         kwargs.update(locals())
 
+        if 'devicePolicy' in kwargs:
+            options = ['Whitelisted', 'Blocked', 'Normal', 'Group policy']
+            assert kwargs['devicePolicy'] in options, f'''"devicePolicy" cannot be "{kwargs['devicePolicy']}", & must be set to one of: {options}'''
+
         metadata = {
             'tags': ['Clients'],
             'operation': 'provisionNetworkClients',

meraki/api/monitored_media_servers.py

@@ -0,0 +1,102 @@
+class MonitoredMediaServers(object):
+    def __init__(self, session):
+        super(MonitoredMediaServers, self).__init__()
+        self._session = session
+    
+    def getOrganizationInsightMonitoredMediaServers(self, organizationId: str):
+        """
+        **List the monitored media servers for this organization. Only valid for organizations with Meraki Insight.**
+        https://api.meraki.com/api_docs#list-the-monitored-media-servers-for-this-organization
+        
+        - organizationId (string)
+        """
+
+        metadata = {
+            'tags': ['Monitored media servers'],
+            'operation': 'getOrganizationInsightMonitoredMediaServers',
+        }
+        resource = f'/organizations/{organizationId}/insight/monitoredMediaServers'
+
+        return self._session.get(metadata, resource)
+
+    def createOrganizationInsightMonitoredMediaServer(self, organizationId: str, name: str, address: str):
+        """
+        **Add a media server to be monitored for this organization. Only valid for organizations with Meraki Insight.**
+        https://api.meraki.com/api_docs#add-a-media-server-to-be-monitored-for-this-organization
+        
+        - organizationId (string)
+        - name (string): The name of the VoIP provider
+        - address (string): The IP address (IPv4 only) or hostname of the media server to monitor
+        """
+
+        kwargs = locals()
+
+        metadata = {
+            'tags': ['Monitored media servers'],
+            'operation': 'createOrganizationInsightMonitoredMediaServer',
+        }
+        resource = f'/organizations/{organizationId}/insight/monitoredMediaServers'
+
+        body_params = ['name', 'address']
+        payload = {k: v for (k, v) in kwargs.items() if k in body_params}
+
+        return self._session.post(metadata, resource, payload)
+
+    def getOrganizationInsightMonitoredMediaServer(self, organizationId: str, monitoredMediaServerId: str):
+        """
+        **Return a monitored media server for this organization. Only valid for organizations with Meraki Insight.**
+        https://api.meraki.com/api_docs#return-a-monitored-media-server-for-this-organization
+        
+        - organizationId (string)
+        - monitoredMediaServerId (string)
+        """
+
+        metadata = {
+            'tags': ['Monitored media servers'],
+            'operation': 'getOrganizationInsightMonitoredMediaServer',
+        }
+        resource = f'/organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}'
+
+        return self._session.get(metadata, resource)
+
+    def updateOrganizationInsightMonitoredMediaServer(self, organizationId: str, monitoredMediaServerId: str, **kwargs):
+        """
+        **Update a monitored media server for this organization. Only valid for organizations with Meraki Insight.**
+        https://api.meraki.com/api_docs#update-a-monitored-media-server-for-this-organization
+        
+        - organizationId (string)
+        - monitoredMediaServerId (string)
+        - name (string): The name of the VoIP provider
+        - address (string): The IP address (IPv4 only) or hostname of the media server to monitor
+        """
+
+        kwargs.update(locals())
+
+        metadata = {
+            'tags': ['Monitored media servers'],
+            'operation': 'updateOrganizationInsightMonitoredMediaServer',
+        }
+        resource = f'/organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}'
+
+        body_params = ['name', 'address']
+        payload = {k: v for (k, v) in kwargs.items() if k in body_params}
+
+        return self._session.put(metadata, resource, payload)
+
+    def deleteOrganizationInsightMonitoredMediaServer(self, organizationId: str, monitoredMediaServerId: str):
+        """
+        **Delete a monitored media server from this organization. Only valid for organizations with Meraki Insight.**
+        https://api.meraki.com/api_docs#delete-a-monitored-media-server-from-this-organization
+        
+        - organizationId (string)
+        - monitoredMediaServerId (string)
+        """
+
+        metadata = {
+            'tags': ['Monitored media servers'],
+            'operation': 'deleteOrganizationInsightMonitoredMediaServer',
+        }
+        resource = f'/organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}'
+
+        return self._session.delete(metadata, resource)
+

meraki/api/mx_1_many_nat_rules.py

@@ -19,7 +19,7 @@ def getNetworkOneToManyNatRules(self, networkId: str):
 
         return self._session.get(metadata, resource)
 
-    def updateNetworkOneToManyNatRules(self, networkId: str, **kwargs):
+    def updateNetworkOneToManyNatRules(self, networkId: str, rules: list):
         """
         **Set the 1:Many NAT mapping rules for an MX network**
         https://api.meraki.com/api_docs#set-the-1many-nat-mapping-rules-for-an-mx-network
@@ -28,7 +28,7 @@ def updateNetworkOneToManyNatRules(self, networkId: str, **kwargs):
         - rules (array): An array of 1:Many nat rules
         """
 
-        kwargs.update(locals())
+        kwargs = locals()
 
         metadata = {
             'tags': ['MX 1:Many NAT rules'],