@itentialopensource/adapter-meraki 0.8.1 → 0.8.4

package/adapter.js

@@ -83,7 +83,15 @@ class Meraki extends AdapterBaseCl {
    * @iapGetAdapterWorkflowFunctions
    */
   iapGetAdapterWorkflowFunctions(inIgnore) {
-    let myIgnore = ['hasEntities', 'hasDevices'];
+    let myIgnore = [
+      'healthCheck',
+      'iapGetAdapterWorkflowFunctions',
+      'iapHasAdapterEntity',
+      'iapVerifyAdapterCapability',
+      'iapUpdateAdapterEntityCache',
+      'hasEntities',
+      'getAuthorization'
+    ];
     if (!inIgnore && Array.isArray(inIgnore)) {
       myIgnore = inIgnore;
     } else if (!inIgnore && typeof inIgnore === 'string') {
@@ -111,8 +119,10 @@ class Meraki extends AdapterBaseCl {
    * @param {Callback} callback - The results of the call
    */
   iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
-    const origin = `${this.id}-adapter-iapUpdateAdapterConfiguration`;
+    const meth = 'adapter-iapUpdateAdapterConfiguration';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     super.iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback);
   }
 
@@ -124,8 +134,10 @@ class Meraki extends AdapterBaseCl {
    * @param {Callback} callback - The results of the call
    */
   iapFindAdapterPath(apiPath, callback) {
-    const origin = `${this.id}-adapter-iapFindAdapterPath`;
+    const meth = 'adapter-iapFindAdapterPath';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     super.iapFindAdapterPath(apiPath, callback);
   }
 
@@ -136,8 +148,10 @@ class Meraki extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapSuspendAdapter(mode, callback) {
-    const origin = `${this.id}-adapter-iapSuspendAdapter`;
+    const meth = 'adapter-iapSuspendAdapter';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapSuspendAdapter(mode, callback);
     } catch (error) {
@@ -153,8 +167,10 @@ class Meraki extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapUnsuspendAdapter(callback) {
-    const origin = `${this.id}-adapter-iapUnsuspendAdapter`;
+    const meth = 'adapter-iapUnsuspendAdapter';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapUnsuspendAdapter(callback);
     } catch (error) {
@@ -170,8 +186,10 @@ class Meraki extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapGetAdapterQueue(callback) {
-    const origin = `${this.id}-adapter-iapGetAdapterQueue`;
+    const meth = 'adapter-iapGetAdapterQueue';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     return super.iapGetAdapterQueue(callback);
   }
 
@@ -185,8 +203,10 @@ class Meraki extends AdapterBaseCl {
   * @param {Callback} callback - The results of the call
   */
   iapTroubleshootAdapter(props, persistFlag, callback) {
-    const origin = `${this.id}-adapter-iapTroubleshootAdapter`;
+    const meth = 'adapter-iapTroubleshootAdapter';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapTroubleshootAdapter(props, persistFlag, this, callback);
     } catch (error) {
@@ -203,8 +223,10 @@ class Meraki extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapRunAdapterHealthcheck(callback) {
-    const origin = `${this.id}-adapter-iapRunAdapterHealthcheck`;
+    const meth = 'adapter-iapRunAdapterHealthcheck';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapRunAdapterHealthcheck(this, callback);
     } catch (error) {
@@ -220,8 +242,10 @@ class Meraki extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapRunAdapterConnectivity(callback) {
-    const origin = `${this.id}-adapter-iapRunAdapterConnectivity`;
+    const meth = 'adapter-iapRunAdapterConnectivity';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapRunAdapterConnectivity(callback);
     } catch (error) {
@@ -237,8 +261,10 @@ class Meraki extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapRunAdapterBasicGet(callback) {
-    const origin = `${this.id}-adapter-iapRunAdapterBasicGet`;
+    const meth = 'adapter-iapRunAdapterBasicGet';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapRunAdapterBasicGet(callback);
     } catch (error) {
@@ -255,8 +281,10 @@ class Meraki extends AdapterBaseCl {
    *                                  or the error
    */
   iapMoveAdapterEntitiesToDB(callback) {
-    const origin = `${this.id}-adapter-iapMoveAdapterEntitiesToDB`;
+    const meth = 'adapter-iapMoveAdapterEntitiesToDB';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapMoveAdapterEntitiesToDB(callback);
     } catch (err) {
@@ -446,56 +474,18 @@ class Meraki extends AdapterBaseCl {
    *                              value is true or false
    */
   hasEntities(entityType, entityList, callback) {
-    const origin = `${this.id}-adapter-hasEntities`;
+    const meth = 'adapter-hasEntities';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    switch (entityType) {
-      case 'Device':
-        return this.hasDevices(entityList, callback);
-      default:
-        return callback(null, `${this.id} does not support entity ${entityType}`);
+    try {
+      return super.hasEntities(entityType, entityList, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
-  /**
-   * @summary Helper method for hasEntities for the specific device case
-   *
-   * @param {Array} deviceList - array of unique device identifiers
-   * @param {Callback} callback - A map where the device is the key and the
-   *                              value is true or false
-   */
-  hasDevices(deviceList, callback) {
-    const origin = `${this.id}-adapter-hasDevices`;
-    log.trace(origin);
-
-    const findings = deviceList.reduce((map, device) => {
-      // eslint-disable-next-line no-param-reassign
-      map[device] = false;
-      log.debug(`In reduce: ${JSON.stringify(map)}`);
-      return map;
-    }, {});
-    const apiCalls = deviceList.map((device) => new Promise((resolve) => {
-      this.getDevice(device, (result, error) => {
-        if (error) {
-          log.debug(`In map error: ${JSON.stringify(device)}`);
-          return resolve({ name: device, found: false });
-        }
-        log.debug(`In map: ${JSON.stringify(device)}`);
-        return resolve({ name: device, found: true });
-      });
-    }));
-    Promise.all(apiCalls).then((results) => {
-      results.forEach((device) => {
-        findings[device.name] = device.found;
-      });
-      log.debug(`FINDINGS: ${JSON.stringify(findings)}`);
-      return callback(findings);
-    }).catch((errors) => {
-      log.error('Unable to do device lookup.');
-      return callback(null, { code: 503, message: 'Unable to do device lookup.', error: errors });
-    });
-  }
-
   /**
    * @summary Get Appliance that match the deviceName
    *
@@ -510,167 +500,11 @@ class Meraki extends AdapterBaseCl {
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // make sure we are set up for device broker getDevice
-    if (!this.props.devicebroker || !this.props.devicebroker.getDevice || !this.props.devicebroker.getDevice.path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getDevice.path'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    /* HERE IS WHERE YOU VALIDATE DATA */
-    if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
     try {
-      // need to get the device so we can convert the deviceName to an id
-      // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
-      const opts = {
-        filter: {
-          name: deviceName
-        }
-      };
-      return this.getDevicesFiltered(opts, (devs, ferr) => {
-        // if we received an error or their is no response on the results return an error
-        if (ferr) {
-          return callback(null, ferr);
-        }
-        if (devs.list.length < 1) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
-          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-          return callback(null, errorObj);
-        }
-        // get the uuid from the device
-        const { uuid } = devs.list[0];
-
-        // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
-        // !! you can also replace with a specific call if that is easier
-        let uriPath = '';
-        let uriMethod = 'GET';
-        let callQuery = {};
-        let callBody = {};
-        let callHeaders = {};
-        let nameField = 'name';
-        let nameArray = ['name'];
-        let ostypeField = 'ostype';
-        let ostypeArray = ['ostype'];
-        let ostypePrefix = '';
-        let portField = 'port';
-        let portArray = ['port'];
-        let ipField = 'ipaddress';
-        let ipArray = ['ipaddress'];
-        if (this.props.devicebroker.getDevice.path) {
-          uriPath = `${this.props.devicebroker.getDevice.path}`;
-          uriPath = uriPath.replace('{deviceid}', uuid);
-        }
-        if (this.props.devicebroker.getDevice.method) {
-          uriMethod = this.props.devicebroker.getDevice.method;
-        }
-        if (this.props.devicebroker.getDevice.query) {
-          try {
-            callQuery = JSON.parse(this.props.devicebroker.getDevice.query);
-          } catch (e) {
-            log.warn('Could not parse query parameter for getDevice call');
-          }
-        }
-        if (this.props.devicebroker.getDevice.body) {
-          try {
-            callBody = this.props.devicebroker.getDevice.body;
-          } catch (e) {
-            log.warn('Could not parse body for getDevice call');
-          }
-        }
-        if (this.props.devicebroker.getDevice.headers) {
-          try {
-            callHeaders = this.props.devicebroker.getDevice.headers;
-          } catch (e) {
-            log.warn('Could not parse headers for getDevice call');
-          }
-        }
-        if (this.props.devicebroker.getDevice.name_field) {
-          nameField = this.props.devicebroker.getDevice.name_field;
-          nameArray = nameField.split('.');
-        }
-        if (this.props.devicebroker.getDevice.ostype_field) {
-          ostypeField = this.props.devicebroker.getDevice.ostype_field;
-          ostypeArray = ostypeField.split('.');
-        }
-        if (this.props.devicebroker.getDevice.ostype_prefix) {
-          ostypePrefix = this.props.devicebroker.getDevice.ostype_prefix;
-        }
-        if (this.props.devicebroker.getDevice.port_field) {
-          portField = this.props.devicebroker.getDevice.port_field;
-          portArray = portField.split('.');
-        }
-        if (this.props.devicebroker.getDevice.ip_field) {
-          ipField = this.props.devicebroker.getDevice.ip_field;
-          ipArray = ipField.split('.');
-        }
-
-        return this.genericAdapterRequest(uriPath, uriMethod, callQuery, callBody, callHeaders, (result, error) => {
-          // if we received an error or their is no response on the results return an error
-          if (error) {
-            return callback(null, error);
-          }
-          if (!result.response) {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevice'], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
-
-          // return the response
-          // !! format the data we send back
-          // !! these fields are config manager fields you need to map to the data we receive
-          const thisDevice = result.response;
-          let thisName = thisDevice;
-          for (let i = 0; i < nameArray.length; i += 1) {
-            if (!Object.hasOwnProperty.call(thisName, nameArray[i])) {
-              const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-              log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-              return callback(null, errorObj);
-            }
-            thisName = thisName[nameArray[i]];
-          }
-          thisDevice.name = thisName;
-          let thisOstype = thisDevice;
-          for (let i = 0; i < ostypeArray.length; i += 1) {
-            if (!Object.hasOwnProperty.call(thisOstype, ostypeArray[i])) {
-              const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-              log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-              return callback(null, errorObj);
-            }
-            thisOstype = thisOstype[ostypeArray[i]];
-          }
-          thisDevice.ostype = ostypePrefix + thisOstype;
-          let thisPort = thisDevice;
-          for (let i = 0; i < portArray.length; i += 1) {
-            if (!Object.hasOwnProperty.call(thisPort, portArray[i])) {
-              const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-              log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-              return callback(null, errorObj);
-            }
-            thisPort = thisPort[portArray[i]];
-          }
-          thisDevice.port = thisPort;
-          let thisIp = thisDevice;
-          for (let i = 0; i < ipArray.length; i += 1) {
-            if (!Object.hasOwnProperty.call(thisIp, ipArray[i])) {
-              const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-              log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-              return callback(null, errorObj);
-            }
-            thisIp = thisIp[ipArray[i]];
-          }
-          thisDevice.ipaddress = thisIp;
-          return callback(thisDevice);
-        });
-      });
-    } catch (ex) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
+      return super.getDevice(deviceName, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
@@ -688,267 +522,11 @@ class Meraki extends AdapterBaseCl {
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // make sure we are set up for device broker getDevicesFiltered
-    if (!this.props.devicebroker || !this.props.devicebroker.getDevicesFiltered || !this.props.devicebroker.getDevicesFiltered.path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getDevicesFiltered.path'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // verify the required fields have been provided
-    if (options === undefined || options === null || options === '' || options.length === 0) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['options'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-    log.debug(`Device Filter Options: ${JSON.stringify(options)}`);
-
-    // TODO - get pagination working
-    // const nextToken = options.start;
-    // const maxResults = options.limit;
-
-    // set up the filter of Device Names
-    let filterName = [];
-    if (options && options.filter && options.filter.name) {
-      // when this hack is removed, remove the lint ignore above
-      if (Array.isArray(options.filter.name)) {
-        // eslint-disable-next-line prefer-destructuring
-        filterName = options.filter.name;
-      } else {
-        filterName = [options.filter.name];
-      }
-    }
-
-    // TODO - get sort and order working
-    /*
-    if (options && options.sort) {
-      reqObj.uriOptions.sort = JSON.stringify(options.sort);
-    }
-    if (options && options.order) {
-      reqObj.uriOptions.order = options.order;
-    }
-    */
     try {
-      // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
-      // !! you can also replace with a specific call if that is easier
-      let uriPath = '';
-      let uriMethod = 'GET';
-      let callQuery = {};
-      let callBody = {};
-      let callHeaders = {};
-      let nameField = 'name';
-      let nameArray = ['name'];
-      let ostypeField = 'ostype';
-      let ostypeArray = ['ostype'];
-      let ostypePrefix = '';
-      let portField = 'port';
-      let portArray = ['port'];
-      let ipField = 'ipaddress';
-      let ipArray = ['ipaddress'];
-      if (this.props.devicebroker.getDevicesFiltered.path) {
-        uriPath = this.props.devicebroker.getDevicesFiltered.path;
-      }
-      if (this.props.devicebroker.getDevicesFiltered.method) {
-        uriMethod = this.props.devicebroker.getDevicesFiltered.method;
-      }
-      if (this.props.devicebroker.getDevicesFiltered.query) {
-        try {
-          callQuery = this.props.devicebroker.getDevicesFiltered.query;
-        } catch (e) {
-          log.warn('Could not parse query parameter for getDevicesFiltered call');
-        }
-      }
-      if (this.props.devicebroker.getDevicesFiltered.body) {
-        try {
-          callBody = this.props.devicebroker.getDevicesFiltered.body;
-        } catch (e) {
-          log.warn('Could not parse body for getDevicesFiltered call');
-        }
-      }
-      if (this.props.devicebroker.getDevicesFiltered.headers) {
-        try {
-          callHeaders = this.props.devicebroker.getDevicesFiltered.headers;
-        } catch (e) {
-          log.warn('Could not parse headers for getDevicesFiltered call');
-        }
-      }
-      if (this.props.devicebroker.getDevicesFiltered.name_field) {
-        nameField = this.props.devicebroker.getDevicesFiltered.name_field;
-        nameArray = nameField.split('.');
-      }
-      if (this.props.devicebroker.getDevicesFiltered.ostype_field) {
-        ostypeField = this.props.devicebroker.getDevicesFiltered.ostype_field;
-        ostypeArray = ostypeField.split('.');
-      }
-      if (this.props.devicebroker.getDevicesFiltered.ostype_prefix) {
-        ostypePrefix = this.props.devicebroker.getDevicesFiltered.ostype_prefix;
-      }
-      if (this.props.devicebroker.getDevicesFiltered.port_field) {
-        portField = this.props.devicebroker.getDevicesFiltered.port_field;
-        portArray = portField.split('.');
-      }
-      if (this.props.devicebroker.getDevicesFiltered.ip_field) {
-        ipField = this.props.devicebroker.getDevicesFiltered.ip_field;
-        ipArray = ipField.split('.');
-      }
-
-      return this.genericAdapterRequest(uriPath, uriMethod, callQuery, callBody, callHeaders, (result, error) => {
-        // if we received an error or their is no response on the results return an error
-        if (error) {
-          return callback(null, error);
-        }
-        if (!result.response) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-          return callback(null, errorObj);
-        }
-
-        // !! go through the response - may have to look for sub object
-        // handle an array of devices
-        if (Array.isArray(result.response)) {
-          const myDevices = [];
-
-          for (let d = 0; d < result.response.length; d += 1) {
-            // !! format the data we send back
-            // !! these fields are config manager fields you need to map to the data we receive
-            const thisDevice = result.response;
-            let thisName = thisDevice;
-            for (let i = 0; i < nameArray.length; i += 1) {
-              if (!Object.hasOwnProperty.call(thisName, nameArray[i])) {
-                const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-                log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-                return callback(null, errorObj);
-              }
-              thisName = thisName[nameArray[i]];
-            }
-            thisDevice.name = thisName;
-            let thisOstype = thisDevice;
-            for (let i = 0; i < ostypeArray.length; i += 1) {
-              if (!Object.hasOwnProperty.call(thisOstype, ostypeArray[i])) {
-                const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-                log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-                return callback(null, errorObj);
-              }
-              thisOstype = thisOstype[ostypeArray[i]];
-            }
-            thisDevice.ostype = ostypePrefix + thisOstype;
-            let thisPort = thisDevice;
-            for (let i = 0; i < portArray.length; i += 1) {
-              if (!Object.hasOwnProperty.call(thisPort, portArray[i])) {
-                const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-                log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-                return callback(null, errorObj);
-              }
-              thisPort = thisPort[portArray[i]];
-            }
-            thisDevice.port = thisPort;
-            let thisIp = thisDevice;
-            for (let i = 0; i < ipArray.length; i += 1) {
-              if (!Object.hasOwnProperty.call(thisIp, ipArray[i])) {
-                const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-                log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-                return callback(null, errorObj);
-              }
-              thisIp = thisIp[ipArray[i]];
-            }
-            thisDevice.ipaddress = thisIp;
-
-            // if there is no filter - return the device
-            if (filterName.length === 0) {
-              myDevices.push(thisDevice);
-            } else {
-              // if we have to match a filter
-              let found = false;
-              for (let f = 0; f < filterName.length; f += 1) {
-                if (thisDevice.name.indexOf(filterName[f]) >= 0) {
-                  found = true;
-                  break;
-                }
-              }
-              // matching device
-              if (found) {
-                myDevices.push(thisDevice);
-              }
-            }
-          }
-          log.debug(`${origin}: Found #${myDevices.length} devices.`);
-          log.debug(`Devices: ${JSON.stringify(myDevices)}`);
-          return callback({ total: myDevices.length, list: myDevices });
-        }
-        // handle a single device response
-        // !! format the data we send back
-        // !! these fields are config manager fields you need to map to the data we receive
-        const thisDevice = result.response;
-        let thisName = thisDevice;
-        for (let i = 0; i < nameArray.length; i += 1) {
-          if (!Object.hasOwnProperty.call(thisName, nameArray[i])) {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
-          thisName = thisName[nameArray[i]];
-        }
-        thisDevice.name = thisName;
-        let thisOstype = thisDevice;
-        for (let i = 0; i < ostypeArray.length; i += 1) {
-          if (!Object.hasOwnProperty.call(thisOstype, ostypeArray[i])) {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
-          thisOstype = thisOstype[ostypeArray[i]];
-        }
-        thisDevice.ostype = ostypePrefix + thisOstype;
-        let thisPort = thisDevice;
-        for (let i = 0; i < portArray.length; i += 1) {
-          if (!Object.hasOwnProperty.call(thisPort, portArray[i])) {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
-          thisPort = thisPort[portArray[i]];
-        }
-        thisDevice.port = thisPort;
-        let thisIp = thisDevice;
-        for (let i = 0; i < ipArray.length; i += 1) {
-          if (!Object.hasOwnProperty.call(thisIp, ipArray[i])) {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
-          thisIp = thisIp[ipArray[i]];
-        }
-        thisDevice.ipaddress = thisIp;
-
-        // if there is no filter - return the device
-        if (filterName.length === 0) {
-          log.debug(`${origin}: Found #1 device.`);
-          log.debug(`Device: ${JSON.stringify(thisDevice)}`);
-          return callback({ total: 1, list: [thisDevice] });
-        }
-
-        // if there is a filter need to check for matching device
-        let found = false;
-        for (let f = 0; f < filterName.length; f += 1) {
-          if (thisDevice.name.indexOf(filterName[f]) >= 0) {
-            found = true;
-            break;
-          }
-        }
-        // matching device
-        if (found) {
-          log.debug(`${origin}: Found #1 device.`);
-          log.debug(`Device Found: ${JSON.stringify(thisDevice)}`);
-          return callback({ total: 1, list: [thisDevice] });
-        }
-        // not a matching device
-        log.debug(`${origin}: No matching device found.`);
-        return callback({ total: 0, list: [] });
-      });
-    } catch (ex) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
+      return super.getDevicesFiltered(options, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
@@ -966,121 +544,11 @@ class Meraki extends AdapterBaseCl {
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // make sure we are set up for device broker isAlive
-    if (!this.props.devicebroker || !this.props.devicebroker.isAlive || !this.props.devicebroker.isAlive.path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.isAlive.path'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // verify the required fields have been provided
-    if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
     try {
-      // need to get the device so we can convert the deviceName to an id
-      // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
-      const opts = {
-        filter: {
-          name: deviceName
-        }
-      };
-      return this.getDevicesFiltered(opts, (devs, ferr) => {
-        // if we received an error or their is no response on the results return an error
-        if (ferr) {
-          return callback(null, ferr);
-        }
-        if (devs.list.length < 1) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
-          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-          return callback(null, errorObj);
-        }
-        // get the uuid from the device
-        const { uuid } = devs.list[0];
-
-        // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
-        // !! you can also replace with a specific call if that is easier
-        let uriPath = '';
-        let uriMethod = 'GET';
-        let callQuery = {};
-        let callBody = {};
-        let callHeaders = {};
-        let statusField = 'status';
-        let statusArray = ['status'];
-        let statusValue = 'true';
-        if (this.props.devicebroker.isAlive.path) {
-          uriPath = `${this.props.devicebroker.isAlive.path}`;
-          uriPath = uriPath.replace('{deviceid}', uuid);
-        }
-        if (this.props.devicebroker.isAlive.method) {
-          uriMethod = this.props.devicebroker.isAlive.method;
-        }
-        if (this.props.devicebroker.isAlive.query) {
-          try {
-            callQuery = this.props.devicebroker.isAlive.query;
-          } catch (e) {
-            log.warn('Could not parse query parameter for isAlive call');
-          }
-        }
-        if (this.props.devicebroker.isAlive.body) {
-          try {
-            callBody = this.props.devicebroker.isAlive.body;
-          } catch (e) {
-            log.warn('Could not parse body for isAlive call');
-          }
-        }
-        if (this.props.devicebroker.isAlive.headers) {
-          try {
-            callHeaders = this.props.devicebroker.isAlive.headers;
-          } catch (e) {
-            log.warn('Could not parse headers for isAlive call');
-          }
-        }
-        if (this.props.devicebroker.isAlive.response && this.props.devicebroker.isAlive.status_field) {
-          statusField = this.props.devicebroker.isAlive.status_field;
-          statusArray = statusField.split('.');
-        }
-        if (this.props.devicebroker.isAlive.response && this.props.devicebroker.isAlive.status_value) {
-          statusValue = this.props.devicebroker.isAlive.response.status_value;
-        }
-
-        return this.genericAdapterRequest(uriPath, uriMethod, callQuery, callBody, callHeaders, (result, error) => {
-          // if we received an error or their is no response on the results return an error
-          if (error) {
-            return callback(null, error);
-          }
-
-          // !! should update this to make sure we are checking for the appropriate object/field
-          if (!result.response || !result.response.returnObj) {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['isAlive'], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
-          let thisObj = result.response.returnObj;
-          for (let i = 0; i < statusArray.length; i += 1) {
-            if (!Object.hasOwnProperty.call(thisObj, statusArray[i])) {
-              const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['isAlive'], null, null, null);
-              log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-              return callback(null, errorObj);
-            }
-            thisObj = thisObj[statusArray[i]];
-          }
-
-          // !! return the response - Update to the appropriate object/field
-          let response = true;
-          if (thisObj.toString() !== statusValue) {
-            response = false;
-          }
-          return callback(response);
-        });
-      });
-    } catch (ex) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
+      return super.isAlive(deviceName, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
@@ -1099,94 +567,11 @@ class Meraki extends AdapterBaseCl {
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // make sure we are set up for device broker getConfig
-    if (!this.props.devicebroker || !this.props.devicebroker.getConfig || !this.props.devicebroker.getConfig.path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getConfig.path'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // verify the required fields have been provided
-    if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
     try {
-      // need to get the device so we can convert the deviceName to an id
-      // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
-      const opts = {
-        filter: {
-          name: deviceName
-        }
-      };
-      return this.getDevicesFiltered(opts, (devs, ferr) => {
-        // if we received an error or their is no response on the results return an error
-        if (ferr) {
-          return callback(null, ferr);
-        }
-        if (devs.list.length < 1) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
-          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-          return callback(null, errorObj);
-        }
-        // get the uuid from the device
-        const { uuid } = devs.list[0];
-
-        // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
-        // !! you can also replace with a specific call if that is easier
-        let uriPath = '';
-        let uriMethod = 'GET';
-        let callQuery = {};
-        let callBody = {};
-        let callHeaders = {};
-        if (this.props.devicebroker.getConfig.path) {
-          uriPath = `${this.props.devicebroker.getConfig.path}`;
-          uriPath = uriPath.replace('{deviceid}', uuid);
-        }
-        if (this.props.devicebroker.getConfig.method) {
-          uriMethod = this.props.devicebroker.getConfig.method;
-        }
-        if (this.props.devicebroker.getConfig.query) {
-          try {
-            callQuery = this.props.devicebroker.getConfig.query;
-          } catch (e) {
-            log.warn('Could not parse query parameter for getConfig call');
-          }
-        }
-        if (this.props.devicebroker.getConfig.body) {
-          try {
-            callBody = this.props.devicebroker.getConfig.body;
-          } catch (e) {
-            log.warn('Could not parse body for getConfig call');
-          }
-        }
-        if (this.props.devicebroker.getConfig.headers) {
-          try {
-            callHeaders = this.props.devicebroker.getConfig.headers;
-          } catch (e) {
-            log.warn('Could not parse headers for getConfig call');
-          }
-        }
-
-        return this.genericAdapterRequest(uriPath, uriMethod, callQuery, callBody, callHeaders, (result, error) => {
-          // if we received an error or their is no response on the results return an error
-          if (error) {
-            return callback(null, error);
-          }
-
-          // return the result
-          const newResponse = {
-            response: JSON.stringify(result.response, null, 2)
-          };
-          return callback(newResponse);
-        });
-      });
-    } catch (ex) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
+      return super.getConfig(deviceName, format, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
@@ -1203,59 +588,117 @@ class Meraki extends AdapterBaseCl {
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // make sure we are set up for device broker getCount
-    if (!this.props.devicebroker || !this.props.devicebroker.getCount || !this.props.devicebroker.getCount.path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getCount.path'], null, null, null);
+    try {
+      return super.iapGetDeviceCount(callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /* GENERIC ADAPTER REQUEST - allows extension of adapter without new calls being added */
+  /**
+   * Makes the requested generic call
+   *
+   * @function genericAdapterRequest
+   * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
+   * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
+   * @param {Object} queryData - the parameters to be put on the url (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} requestBody - the body to add to the request (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} addlHeaders - additional headers to be put on the call (optional).
+   *                 Can be a stringified Object.
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                 or the error
+   */
+  genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
+    const meth = 'adapter-genericAdapterRequest';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (uriPath === undefined || uriPath === null || uriPath === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['uriPath'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (restMethod === undefined || restMethod === null || restMethod === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['restMethod'], null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
 
-    // verify the required fields have been provided
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    // remove any leading / and split the uripath into path variables
+    let myPath = uriPath;
+    while (myPath.indexOf('/') === 0) {
+      myPath = myPath.substring(1);
+    }
+    const pathVars = myPath.split('/');
+    const queryParamsAvailable = queryData;
+    const queryParams = {};
+    const bodyVars = requestBody;
 
-    try {
-      // !! using Generic makes it easier on the Adapter Builder (just need to set the path or call in properties)
-      // !! you can also replace with a specific call if that is easier
-      let uriPath = '';
-      let uriMethod = 'GET';
-      let callQuery = {};
-      let callBody = {};
-      let callHeaders = {};
-      if (this.props.devicebroker.getCount.path) {
-        uriPath = this.props.devicebroker.getCount.path;
-      }
-      if (this.props.devicebroker.getCount.method) {
-        uriMethod = this.props.devicebroker.getCount.method;
-      }
-      if (this.props.devicebroker.getCount.query) {
-        try {
-          callQuery = this.props.devicebroker.getCount.query;
-        } catch (e) {
-          log.warn('Could not parse query parameter for getCount call');
-        }
-      }
-      if (this.props.devicebroker.getCount.body) {
-        try {
-          callBody = this.props.devicebroker.getCount.body;
-        } catch (e) {
-          log.warn('Could not parse body for getCount call');
-        }
-      }
-      if (this.props.devicebroker.getCount.headers) {
-        try {
-          callHeaders = this.props.devicebroker.getCount.headers;
-        } catch (e) {
-          log.warn('Could not parse headers for getCount call');
-        }
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
       }
+    });
 
-      return this.genericAdapterRequest(uriPath, uriMethod, callQuery, callBody, callHeaders, (result, error) => {
-        // if we received an error or their is no response on the results return an error
-        if (error) {
-          return callback(null, error);
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams,
+      uriOptions: {}
+    };
+    // add headers if provided
+    if (addlHeaders) {
+      reqObj.addlHeaders = addlHeaders;
+    }
+
+    // determine the call and return flag
+    let action = 'getGenerics';
+    let returnF = true;
+    if (restMethod.toUpperCase() === 'POST') {
+      action = 'createGeneric';
+    } else if (restMethod.toUpperCase() === 'PUT') {
+      action = 'updateGeneric';
+    } else if (restMethod.toUpperCase() === 'PATCH') {
+      action = 'patchGeneric';
+    } else if (restMethod.toUpperCase() === 'DELETE') {
+      action = 'deleteGeneric';
+      returnF = false;
+    }
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('.generic', action, reqObj, returnF, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['genericAdapterRequest'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
         }
 
-        // return the result
-        return callback({ count: result.response });
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
       });
     } catch (ex) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
@@ -1264,11 +707,10 @@ class Meraki extends AdapterBaseCl {
     }
   }
 
-  /* GENERIC ADAPTER REQUEST - allows extension of adapter without new calls being added */
   /**
-   * Makes the requested generic call
+   * Makes the requested generic call with no base path or version
    *
-   * @function genericAdapterRequest
+   * @function genericAdapterRequestNoBasePath
    * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
    * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
    * @param {Object} queryData - the parameters to be put on the url (optional).
@@ -1280,8 +722,8 @@ class Meraki extends AdapterBaseCl {
    * @param {getCallback} callback - a callback function to return the result (Generics)
    *                 or the error
    */
-  genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
-    const meth = 'adapter-genericAdapterRequest';
+  genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
+    const meth = 'adapter-genericAdapterRequestNoBasePath';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -1335,16 +777,16 @@ class Meraki extends AdapterBaseCl {
     }
 
     // determine the call and return flag
-    let action = 'getGenerics';
+    let action = 'getGenericsNoBase';
     let returnF = true;
     if (restMethod.toUpperCase() === 'POST') {
-      action = 'createGeneric';
+      action = 'createGenericNoBase';
     } else if (restMethod.toUpperCase() === 'PUT') {
-      action = 'updateGeneric';
+      action = 'updateGenericNoBase';
     } else if (restMethod.toUpperCase() === 'PATCH') {
-      action = 'patchGeneric';
+      action = 'patchGenericNoBase';
     } else if (restMethod.toUpperCase() === 'DELETE') {
-      action = 'deleteGeneric';
+      action = 'deleteGenericNoBase';
       returnF = false;
     }
 
@@ -1359,7 +801,7 @@ class Meraki extends AdapterBaseCl {
           return callback(null, irReturnError);
         }
         if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['genericAdapterRequest'], null, null, null);
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['genericAdapterRequestNoBasePath'], null, null, null);
           log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
           return callback(null, errorObj);
         }