@itentialopensource/adapter-meraki 0.8.1 → 0.8.4
Sign up to get free protection for your applications and to get access to all the features.
- package/AUTH.md +14 -15
- package/BROKER.md +199 -0
- package/CALLS.md +158 -89
- package/CHANGELOG.md +68 -26
- package/CODE_OF_CONDUCT.md +12 -17
- package/CONTRIBUTING.md +88 -74
- package/ENHANCE.md +14 -14
- package/PROPERTIES.md +483 -89
- package/README.md +131 -51
- package/SUMMARY.md +2 -2
- package/TROUBLESHOOT.md +4 -3
- package/adapter.js +174 -732
- package/adapterBase.js +841 -88
- package/entities/.generic/action.json +105 -0
- package/entities/.generic/schema.json +6 -1
- package/package.json +5 -3
- package/pronghorn.json +642 -563
- package/propertiesDecorators.json +14 -0
- package/propertiesSchema.json +393 -195
- package/refs?service=git-upload-pack +0 -0
- package/report/adapterInfo.json +10 -0
- package/report/updateReport1651511176919.json +115 -0
- package/report/updateReport1652488414759.json +120 -0
- package/sampleProperties.json +132 -3
- package/test/integration/adapterTestBasicGet.js +1 -1
- package/test/integration/adapterTestIntegration.js +24 -107
- package/test/unit/adapterBaseTestUnit.js +10 -3
- package/test/unit/adapterTestUnit.js +38 -131
- package/utils/adapterInfo.js +206 -0
- package/utils/entitiesToDB.js +12 -57
- package/utils/pre-commit.sh +3 -0
- package/utils/tbScript.js +35 -20
- package/utils/tbUtils.js +49 -31
- package/utils/testRunner.js +16 -16
package/README.md
CHANGED
|
@@ -2,34 +2,36 @@
|
|
|
2
2
|
|
|
3
3
|
## Table of Contents
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
5
|
+
Some of the page links in this document and links to other GitLab files do not work in Confluence however, the information is available in other sections of the Confluence material.
|
|
6
|
+
|
|
7
|
+
- [Overview](./SUMMARY.md)
|
|
8
|
+
- [Versioning](#versioning)
|
|
9
|
+
- [Supported IAP Versions](#supported-iap-versions)
|
|
10
|
+
- [Getting Started](#getting-started)
|
|
11
|
+
- [Helpful Background Information](#helpful-background-information)
|
|
12
|
+
- [Prerequisites](#prerequisites)
|
|
13
|
+
- [How to Install](#how-to-install)
|
|
14
|
+
- [Testing](#testing)
|
|
15
|
+
- [Configuration](./PROPERTIES.md)
|
|
16
|
+
- [Using this Adapter](./CALLS.md)
|
|
17
|
+
- [Additional Information](#additional-information)
|
|
18
|
+
- [Enhancements](./ENHANCE.md)
|
|
19
|
+
- [Contributing](./CONTRIBUTING.md)
|
|
20
|
+
- [Helpful Links](#helpful-links)
|
|
21
|
+
- [Node Scripts](#node-scripts)
|
|
22
|
+
- [Troubleshoot](./TROUBLESHOOT.md)
|
|
23
|
+
- [License and Maintainers](#license-and-maintainers)
|
|
24
|
+
- [Product License](#product-license)
|
|
23
25
|
|
|
24
26
|
## [Overview](./SUMMARY.md)
|
|
25
27
|
|
|
26
28
|
## Versioning
|
|
27
29
|
|
|
28
|
-
Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the IAP GUI on the System page. All Itential opensource adapters can be found in the
|
|
30
|
+
Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the IAP GUI on the System page. All Itential opensource adapters can be found in the <a href="https://gitlab.com/itentialopensource/adapters" target="_blank">Itential OpenSource Repository</a>.
|
|
29
31
|
|
|
30
32
|
Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are generally set up as pre-releases as there is often work that needs to be done to configure the adapter and make sure the authentication process to Meraki works appropriately.
|
|
31
33
|
|
|
32
|
-
Release notes can be viewed in CHANGELOG.md or in the
|
|
34
|
+
Release notes can be viewed in CHANGELOG.md or in the <a href="https://itential.atlassian.net/servicedesk/customer/portals" target="_blank">Customer Knowledge Base</a> for Itential adapters.
|
|
33
35
|
|
|
34
36
|
## Supported IAP Versions
|
|
35
37
|
|
|
@@ -45,7 +47,7 @@ These instructions will help you get a copy of the project on your local machine
|
|
|
45
47
|
|
|
46
48
|
### Helpful Background Information
|
|
47
49
|
|
|
48
|
-
There is adapter documentation available on the Itential Developer Site
|
|
50
|
+
There is adapter documentation available on the Itential Developer Site <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">HERE</a>. This documentation includes information and examples that are helpful for:
|
|
49
51
|
|
|
50
52
|
```text
|
|
51
53
|
Authentication
|
|
@@ -59,7 +61,7 @@ Troubleshooting
|
|
|
59
61
|
```
|
|
60
62
|
|
|
61
63
|
Others will be added over time.
|
|
62
|
-
Want to build a new adapter? Use the
|
|
64
|
+
Want to build a new adapter? Use the <a href="https://adapters.itential.io" target="_blank">Itential Adapter Builder</a>
|
|
63
65
|
|
|
64
66
|
### Prerequisites
|
|
65
67
|
|
|
@@ -73,22 +75,65 @@ Git
|
|
|
73
75
|
|
|
74
76
|
The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.
|
|
75
77
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
78
|
+
<table border="1" class="bordered-table">
|
|
79
|
+
<tr>
|
|
80
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Package</span></th>
|
|
81
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
|
|
82
|
+
</tr>
|
|
83
|
+
<tr>
|
|
84
|
+
<td style="padding:15px">@itentialopensource/adapter-utils</td>
|
|
85
|
+
<td style="padding:15px">Runtime library classes for all adapters; includes request handling, connection, authentication throttling, and translation.</td>
|
|
86
|
+
</tr>
|
|
87
|
+
<tr>
|
|
88
|
+
<td style="padding:15px">ajv</td>
|
|
89
|
+
<td style="padding:15px">Required for validation of adapter properties to integrate with Meraki.</td>
|
|
90
|
+
</tr>
|
|
91
|
+
<tr>
|
|
92
|
+
<td style="padding:15px">axios</td>
|
|
93
|
+
<td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
|
|
94
|
+
</tr>
|
|
95
|
+
<tr>
|
|
96
|
+
<td style="padding:15px">commander</td>
|
|
97
|
+
<td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
|
|
98
|
+
</tr>
|
|
99
|
+
<tr>
|
|
100
|
+
<td style="padding:15px">fs-extra</td>
|
|
101
|
+
<td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
|
|
102
|
+
</tr>
|
|
103
|
+
<tr>
|
|
104
|
+
<td style="padding:15px">mocha</td>
|
|
105
|
+
<td style="padding:15px">Testing library that is utilized by some of the node scripts that are included with the adapter.</td>
|
|
106
|
+
</tr>
|
|
107
|
+
<tr>
|
|
108
|
+
<td style="padding:15px">mocha-param</td>
|
|
109
|
+
<td style="padding:15px">Testing library that is utilized by some of the node scripts that are included with the adapter.</td>
|
|
110
|
+
</tr>
|
|
111
|
+
<tr>
|
|
112
|
+
<td style="padding:15px">mongodb</td>
|
|
113
|
+
<td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
|
|
114
|
+
</tr>
|
|
115
|
+
<tr>
|
|
116
|
+
<td style="padding:15px">network-diagnostics</td>
|
|
117
|
+
<td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
|
|
118
|
+
</tr>
|
|
119
|
+
<tr>
|
|
120
|
+
<td style="padding:15px">nyc</td>
|
|
121
|
+
<td style="padding:15px">Testing coverage library that is utilized by some of the node scripts that are included with the adapter.</td>
|
|
122
|
+
</tr>
|
|
123
|
+
<tr>
|
|
124
|
+
<td style="padding:15px">readline-sync</td>
|
|
125
|
+
<td style="padding:15px">Utilized by the node script that comes with the adapter; helps to test unit and integration functionality.</td>
|
|
126
|
+
</tr>
|
|
127
|
+
<tr>
|
|
128
|
+
<td style="padding:15px">semver</td>
|
|
129
|
+
<td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
|
|
130
|
+
</tr>
|
|
131
|
+
<tr>
|
|
132
|
+
<td style="padding:15px">winston</td>
|
|
133
|
+
<td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
|
|
134
|
+
</tr>
|
|
135
|
+
</table>
|
|
136
|
+
<br>
|
|
92
137
|
|
|
93
138
|
If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.
|
|
94
139
|
|
|
@@ -223,24 +268,59 @@ Test should also be written to clean up after themselves. However, it is importa
|
|
|
223
268
|
|
|
224
269
|
### Helpful Links
|
|
225
270
|
|
|
226
|
-
|
|
271
|
+
<a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">Adapter Technical Resources</a>
|
|
227
272
|
|
|
228
273
|
### Node Scripts
|
|
229
274
|
|
|
230
275
|
There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.
|
|
231
276
|
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
277
|
+
<table border="1" class="bordered-table">
|
|
278
|
+
<tr>
|
|
279
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Run</span></th>
|
|
280
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
|
|
281
|
+
</tr>
|
|
282
|
+
<tr>
|
|
283
|
+
<td style="padding:15px">npm run adapter:install</td>
|
|
284
|
+
<td style="padding:15px">Provides an easier way to install the adapter.</td>
|
|
285
|
+
</tr>
|
|
286
|
+
<tr>
|
|
287
|
+
<td style="padding:15px">npm run adapter:checkMigrate</td>
|
|
288
|
+
<td style="padding:15px">Checks whether your adapter can and should be migrated to the latest foundation.</td>
|
|
289
|
+
</tr>
|
|
290
|
+
<tr>
|
|
291
|
+
<td style="padding:15px">npm run adapter:findPath</td>
|
|
292
|
+
<td style="padding:15px">Can be used to see if the adapter supports a particular API call.</td>
|
|
293
|
+
</tr>
|
|
294
|
+
<tr>
|
|
295
|
+
<td style="padding:15px">npm run adapter:migrate</td>
|
|
296
|
+
<td style="padding:15px">Provides an easier way to update your adapter after you download the migration zip from Itential DevSite.</td>
|
|
297
|
+
</tr>
|
|
298
|
+
<tr>
|
|
299
|
+
<td style="padding:15px">npm run adapter:update</td>
|
|
300
|
+
<td style="padding:15px">Provides an easier way to update your adapter after you download the update zip from Itential DevSite.</td>
|
|
301
|
+
</tr>
|
|
302
|
+
<tr>
|
|
303
|
+
<td style="padding:15px">npm run adapter:revert</td>
|
|
304
|
+
<td style="padding:15px">Allows you to revert after a migration or update if it resulted in issues.</td>
|
|
305
|
+
</tr>
|
|
306
|
+
<tr>
|
|
307
|
+
<td style="padding:15px">npm run troubleshoot</td>
|
|
308
|
+
<td style="padding:15px">Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.</td>
|
|
309
|
+
</tr>
|
|
310
|
+
<tr>
|
|
311
|
+
<td style="padding:15px">npm run connectivity</td>
|
|
312
|
+
<td style="padding:15px">Provides a connectivity check to the Meraki system.</td>
|
|
313
|
+
</tr>
|
|
314
|
+
<tr>
|
|
315
|
+
<td style="padding:15px">npm run healthcheck</td>
|
|
316
|
+
<td style="padding:15px">Checks whether the configured healthcheck call works to Meraki.</td>
|
|
317
|
+
</tr>
|
|
318
|
+
<tr>
|
|
319
|
+
<td style="padding:15px">npm run basicget</td>
|
|
320
|
+
<td style="padding:15px">Checks whether the basic get calls works to Meraki.</td>
|
|
321
|
+
</tr>
|
|
322
|
+
</table>
|
|
323
|
+
<br>
|
|
244
324
|
|
|
245
325
|
## [Troubleshoot](./TROUBLESHOOT.md)
|
|
246
326
|
|
package/SUMMARY.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
## Overview
|
|
2
2
|
|
|
3
|
-
This adapter is used to integrate the Itential Automation Platform (IAP) with the Meraki System. The API for Meraki is available
|
|
3
|
+
This adapter is used to integrate the Itential Automation Platform (IAP) with the Meraki System. The API that was used to build the adapter for Meraki is usually available in the report directory of this adapter. The adapter utilizes the Meraki API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
|
|
4
4
|
|
|
5
5
|
>**Note**: It is possible that some integrations will be supported through the Meraki adapter while other integrations will not. If you need additional API calls, you can use the Update capabilities provided by the Adapter Builder or request Itential to add them if the Adapter is an Itential opensourced adapter.
|
|
6
6
|
|
|
7
|
-
Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the
|
|
7
|
+
Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the <a href="https://itential.atlassian.net/servicedesk/customer/portals" target="_blank">Customer Knowledge Base</a> is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
|
|
8
8
|
|
|
9
9
|
For opensourced and custom built adapters, the ReadMe is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into IAP.
|
package/TROUBLESHOOT.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
## Troubleshoot
|
|
2
2
|
|
|
3
|
-
Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows
|
|
3
|
+
Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
You also have the option to run individual commands to perform specific test:
|
|
6
6
|
|
|
7
7
|
- `npm run healthcheck` will perform a healthcheck request of with current setting.
|
|
8
8
|
- `npm run basicget` will perform some non-parameter GET request with current setting.
|
|
@@ -27,6 +27,7 @@ Go into the Itential Platform GUI and verify/update the properties
|
|
|
27
27
|
```text
|
|
28
28
|
ping the ip address of Meraki server
|
|
29
29
|
try telnet to the ip address port of Meraki
|
|
30
|
+
execute a curl command to the other system
|
|
30
31
|
```
|
|
31
32
|
|
|
32
33
|
4. Verify the credentials provided for Meraki.
|
|
@@ -43,4 +44,4 @@ Go into the Itential Platform GUI and verify/update the properties
|
|
|
43
44
|
|
|
44
45
|
### Functional Issues
|
|
45
46
|
|
|
46
|
-
Adapter logs are located in `/var/log/pronghorn`. In older releases of the Itential Platform, there is a `pronghorn.log` file which contains logs for all of the Itential Platform. In newer versions, adapters
|
|
47
|
+
Adapter logs are located in `/var/log/pronghorn`. In older releases of the Itential Platform, there is a `pronghorn.log` file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.
|