@itentialopensource/adapter-meraki 0.8.4 → 1.0.0

package/entities/Statuses/mockdatafiles/listTheStatusOfEveryMerakiDeviceInTheOrganization-default.json

@@ -0,0 +1,23 @@
+{
+  "name": "My AP",
+  "serial": "Q234-ABCD-5678",
+  "mac": "00:11:22:33:44:55",
+  "publicIp": "123.123.123.1",
+  "networkId": "N_24329156",
+  "status": "online",
+  "lastReportedAt": "2018-02-11T00:00:00.090210Z",
+  "lanIp": "1.2.3.4",
+  "gateway": "1.2.3.5",
+  "ipType": "dhcp",
+  "primaryDns": "8.8.8.8",
+  "secondaryDns": "8.8.4.4",
+  "productType": "wireless",
+  "components": {
+    "powerSupplies": []
+  },
+  "model": "MR34",
+  "tags": [
+    "tag1",
+    "tag2"
+  ]
+}

package/entities/Statuses/mockdatafiles/listtheuplinkstatusofeveryMerakiMGcellulargatewayintheorganization-default.json

@@ -0,0 +1,29 @@
+[
+  {
+    "networkId": "N_24329156",
+    "serial": "Q234-ABCD-5678",
+    "model": "MG21",
+    "lastReportedAt": "2018-02-11T00:00:00Z",
+    "uplinks": [
+      {
+        "interface": "cellular",
+        "status": "ready",
+        "ip": "1.2.3.4",
+        "provider": "at&t",
+        "publicIp": "123.123.123.1",
+        "model": "integrated",
+        "signalStat": {
+          "rsrp": "-120",
+          "rsrq": "-13"
+        },
+        "connectionType": "4g",
+        "apn": "internet",
+        "gateway": "100.100.100.100",
+        "dns1": "111.111.111.111",
+        "dns2": "222.222.222.222",
+        "signalType": "4G",
+        "iccid": "123456789"
+      }
+    ]
+  }
+]

package/entities/Statuses/mockdatafiles/listtheuplinkstatusofeveryMerakiMXMGandZseriesdevicesintheorganization-default.json

@@ -0,0 +1,31 @@
+[
+  {
+    "networkId": "N_24329156",
+    "serial": "Q234-ABCD-5678",
+    "model": "MX68C",
+    "lastReportedAt": "2018-02-11T00:00:00Z",
+    "uplinks": [
+      {
+        "interface": "wan1",
+        "status": "active",
+        "ip": "1.2.3.4",
+        "gateway": "1.2.3.5",
+        "publicIp": "123.123.123.1",
+        "primaryDns": "8.8.8.8",
+        "secondaryDns": "8.8.4.4",
+        "ipAssignedBy": "static",
+        "provider": "at&t",
+        "signalStat": {
+          "rsrp": "-120",
+          "rsrq": "-13"
+        },
+        "connectionType": "4g",
+        "apn": "internet",
+        "dns1": "111.111.111.111",
+        "dns2": "222.222.222.222",
+        "signalType": "4G",
+        "iccid": "123456789"
+      }
+    ]
+  }
+]

package/entities/Statuses/mockdatafiles/listtheuplinkstatusofeveryMerakiMXandZseriesappliancesintheorganization-default.json

@@ -0,0 +1,43 @@
+[
+  {
+    "networkId": "N_24329156",
+    "serial": "Q234-ABCD-5678",
+    "model": "MX68C",
+    "lastReportedAt": "2018-02-11T00:00:00Z",
+    "highAvailability": {
+      "enabled": true,
+      "role": "primary"
+    },
+    "uplinks": [
+      {
+        "interface": "wan1",
+        "status": "active",
+        "ip": "1.2.3.4",
+        "gateway": "1.2.3.5",
+        "publicIp": "123.123.123.1",
+        "primaryDns": "8.8.8.8",
+        "secondaryDns": "8.8.4.4",
+        "ipAssignedBy": "static"
+      },
+      {
+        "interface": "cellular",
+        "status": "ready",
+        "ip": "1.2.3.4",
+        "provider": "at&t",
+        "publicIp": "123.123.123.1",
+        "model": "integrated",
+        "signalStat": {
+          "rsrp": "-120",
+          "rsrq": "-13"
+        },
+        "connectionType": "4g",
+        "apn": "internet",
+        "gateway": "100.100.100.100",
+        "dns1": "111.111.111.111",
+        "dns2": "222.222.222.222",
+        "signalType": "4G",
+        "iccid": "123456789"
+      }
+    ]
+  }
+]

package/entities/Statuses/mockdatafiles/notifyThatCredentialHandoffToCameraHasCompleted-default.json

@@ -0,0 +1,3 @@
+{
+  "success": true
+}

package/entities/Statuses/mockdatafiles/showVPNstatusfornetworksinanorganization-default.json

@@ -0,0 +1,80 @@
+[
+  {
+    "networkId": "N_12345678",
+    "networkName": "San Francisco Office",
+    "deviceSerial": "Q234-ABCD-1234",
+    "deviceStatus": "online",
+    "uplinks": [
+      {
+        "interface": "wan1",
+        "publicIp": "1.2.3.4"
+      },
+      {
+        "interface": "wan2",
+        "publicIp": "2.3.4.5"
+      }
+    ],
+    "vpnMode": "hub",
+    "exportedSubnets": [
+      {
+        "subnet": "192.168.0.0/24",
+        "name": "sales-vlan"
+      },
+      {
+        "subnet": "172.16.0.0/24",
+        "name": "engineering-vlan"
+      }
+    ],
+    "merakiVpnPeers": [
+      {
+        "networkId": "L_1234",
+        "networkName": "New York Office",
+        "reachability": "reachable"
+      }
+    ],
+    "thirdPartyVpnPeers": [
+      {
+        "name": "London Office",
+        "publicIp": "111.222.333.444",
+        "reachability": "reachable"
+      }
+    ]
+  },
+  {
+    "networkId": "L_1234",
+    "networkName": "New York Office",
+    "deviceSerial": "Q234-EFGH-5678",
+    "deviceStatus": "online",
+    "uplinks": [
+      {
+        "interface": "wan1",
+        "publicIp": "3.4.5.6"
+      }
+    ],
+    "vpnMode": "spoke",
+    "exportedSubnets": [
+      {
+        "subnet": "192.168.1.0/24",
+        "name": "sales-vlan"
+      },
+      {
+        "subnet": "172.16.1.0/24",
+        "name": "engineering-vlan"
+      }
+    ],
+    "merakiVpnPeers": [
+      {
+        "networkId": "N_12345678",
+        "networkName": "San Francisco Office",
+        "reachability": "reachable"
+      }
+    ],
+    "thirdPartyVpnPeers": [
+      {
+        "name": "Tokyo Office",
+        "publicIp": "222.333.444.555",
+        "reachability": "reachable"
+      }
+    ]
+  }
+]

package/entities/Statuses/schema.json

@@ -0,0 +1,25 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "listtheuplinkstatusofeveryMerakiMXandZseriesappliancesintheorganization",
+        "fetchOnboardingStatusOfCameras",
+        "notifyThatCredentialHandoffToCameraHasCompleted",
+        "listtheuplinkstatusofeveryMerakiMGcellulargatewayintheorganization",
+        "listtheuplinkstatusofeveryMerakiMXMGandZseriesdevicesintheorganization",
+        "showVPNstatusfornetworksinanorganization",
+        "listTheStatusOfEveryMerakiDeviceInTheOrganization"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/Subnets/action.json

@@ -0,0 +1,25 @@
+{
+  "actions": [
+    {
+      "name": "returntheDHCPsubnetinformationforanappliance",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/devices/{pathv1}/appliance/dhcp/subnets?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/returntheDHCPsubnetinformationforanappliance-default.json"
+        }
+      ]
+    }
+  ]
+}

package/entities/Subnets/mockdatafiles/returntheDHCPsubnetinformationforanappliance-default.json

@@ -0,0 +1,8 @@
+[
+  {
+    "subnet": "192.168.1.0/24",
+    "vlanId": 100,
+    "usedCount": 2,
+    "freeCount": 251
+  }
+]

package/entities/Subnets/schema.json

@@ -0,0 +1,19 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "returntheDHCPsubnetinformationforanappliance"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/Switch ports/action.json

@@ -4,7 +4,10 @@
       "name": "getDeviceSwitchPorts",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/devices/{pathv1}/switchPorts?{query}",
+      "entitypath": {
+        "v0": "{base_path}/{version}/devices/{pathv1}/switchPorts?{query}",
+        "v1": "{base_path}/{version}/devices/{pathv1}/switch/ports?{query}"
+      },
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -25,7 +28,10 @@
       "name": "getDeviceSwitchPort",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/devices/{pathv1}/switchPorts/{pathv2}?{query}",
+      "entitypath": {
+        "v0": "{base_path}/{version}/devices/{pathv1}/switchPorts/{pathv2}?{query}",
+        "v1": "{base_path}/{version}/devices/{pathv1}/switch/ports/{pathv2}?{query}"
+      },
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -46,7 +52,10 @@
       "name": "updateDeviceSwitchPort",
       "protocol": "REST",
       "method": "PUT",
-      "entitypath": "{base_path}/{version}/devices/{pathv1}/switchPorts/{pathv2}?{query}",
+      "entitypath": {
+        "v0": "{base_path}/{version}/devices/{pathv1}/switchPorts/{pathv2}?{query}",
+        "v1": "{base_path}/{version}/devices/{pathv1}/switch/ports/{pathv2}?{query}"
+      },
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -62,6 +71,54 @@
           "mockFile": "mockdatafiles/updateDeviceSwitchPort-default.json"
         }
       ]
+    },
+    {
+      "name": "returnTheStatusForAllThePortsOfASwitch",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": {
+        "v0": "{base_path}/{version}/devices/{pathv1}/switchPortStatuses?{query}",
+        "v1": "{base_path}/{version}/devices/{pathv1}/switch/ports/statuses?{query}"
+      },
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/returnTheStatusForAllThePortsOfASwitch-default.json"
+        }
+      ]
+    },
+    {
+      "name": "returnThePacketCountersForAllThePortsOfASwitch",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": {
+        "v0": "{base_path}/{version}/devices/{pathv1}/switchPortStatuses/packets?{query}",
+        "v1": "{base_path}/{version}/devices/{pathv1}/switch/ports/statuses/packets?{query}"
+      },
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/returnthepacketcountersforalltheportsofaswitch-default.json"
+        }
+      ]
     }
   ]
 }

package/entities/Switch ports/mockdatafiles/returnTheStatusForAllThePortsOfASwitch-default.json

@@ -0,0 +1,64 @@
+[
+  {
+    "portId": "1",
+    "enabled": true,
+    "status": "Connected",
+    "isUplink": false,
+    "errors": [
+      "PoE overload",
+      "Very high proportion of CRC errors"
+    ],
+    "warnings": [
+      "SecureConnect authentication in progress",
+      "PoE port was denied power",
+      "High proportion of CRC errors"
+    ],
+    "speed": "10 Gbps",
+    "duplex": "full",
+    "usageInKb": {
+      "total": 40867,
+      "sent": 23008,
+      "recv": 17859
+    },
+    "cdp": {
+      "systemName": "",
+      "platform": "MS350-24X",
+      "deviceId": "0c8ddbddee:ff",
+      "portId": "Port 20",
+      "nativeVlan": 1,
+      "address": "10.0,0.1",
+      "managementAddress": "10.0.0.100",
+      "version": "1",
+      "vtpManagementDomain": "",
+      "capabilities": "Switch"
+    },
+    "lldp": {
+      "systemName": "MS350-24X - Test",
+      "systemDescription": "MS350-24X Cloud Managed PoE Switch",
+      "portId": "20",
+      "portDescription": "Port 20",
+      "chassisId": "0c:8d:db:dd:ee:ff",
+      "managementVlan": 1,
+      "portVlan": 1,
+      "managementAddress": "10.0.0.100",
+      "systemCapabilities": "switch"
+    },
+    "clientCount": 10,
+    "powerUsageInWh": 55.9,
+    "trafficInKbps": {
+      "total": 2.2,
+      "sent": 1.2,
+      "recv": 1
+    },
+    "secureConnect": {
+      "enabled": true,
+      "active": true,
+      "authenticationStatus": "Authentication in progress",
+      "configOverrides": {
+        "type": "trunk",
+        "allowedVlans": "all",
+        "vlan": 12
+      }
+    }
+  }
+]

package/entities/Switch ports/mockdatafiles/returnthepacketcountersforalltheportsofaswitch-default.json

@@ -0,0 +1,51 @@
+[
+  {
+    "portId": "1",
+    "packets": [
+      {
+        "desc": "Total",
+        "total": 112081,
+        "sent": 104135,
+        "recv": 7946,
+        "ratePerSec": {
+          "total": 1,
+          "sent": 1,
+          "recv": 0
+        }
+      },
+      {
+        "desc": "Broadcast",
+        "total": 30884,
+        "sent": 30370,
+        "recv": 514,
+        "ratePerSec": {
+          "total": 0,
+          "sent": 0,
+          "recv": 0
+        }
+      },
+      {
+        "desc": "Multicast",
+        "total": 67620,
+        "sent": 66849,
+        "recv": 771,
+        "ratePerSec": {
+          "total": 0,
+          "sent": 0,
+          "recv": 0
+        }
+      },
+      {
+        "desc": "CRC align errors",
+        "total": 0,
+        "sent": 0,
+        "recv": 0,
+        "ratePerSec": {
+          "total": 0,
+          "sent": 0,
+          "recv": 0
+        }
+      }
+    ]
+  }
+]

package/entities/Switch ports/schema.json

@@ -12,7 +12,9 @@
       "enum": [
         "getDeviceSwitchPorts",
         "getDeviceSwitchPort",
-        "updateDeviceSwitchPort"
+        "updateDeviceSwitchPort",
+        "returnTheStatusForAllThePortsOfASwitch",
+        "returnThePacketCountersForAllThePortsOfASwitch"
       ],
       "external_name": "ph_request_type"
     }