Table of Contents

• Getting Started
  • Helpful Background Information
  • Prerequisites
  • External Dependencies
  • Adapters
  • How to Install
  • Testing
• Using this Example Project
  • Create Network and Claim Devices - Meraki - Example
  • Create Network and Claim Devices - Reset - Meraki - Example
• Additional Information
  • Support

Getting Started

This section is helpful for deployments as it provides you with pertinent information on prerequisites and properties.

Helpful Background Information

Workflows and processes often include logic that varies from business to business. Our Example Projects are more complex processes that include several of our modular components to build a more complete process.

While these can be utilized, you may find more value in using them as a starting point to build around.

Prerequisites

Itential Example Projects are built and tested on particular versions of IAP. In addition, Example Projects are often dependent on external systems and as such, these Example Projects will have dependencies on these other systems. This version of Cisco - Meraki - REST - Example has been tested with:

• IAP 2023.2

External Dependencies

Adapters

How to Install

To install the Example Project:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Supported IAP Versions section in order to install the Example Project.
• Import the Example Project in Admin Essentials.

Testing

Cypress is generally used to test all Itential Example Projects. While Cypress is an opensource tool, at Itential we have internal libraries that have been built around Cypress to allow us to test with a deployed IAP.

When certifying our Example Projects for a release of IAP we run these tests against the particular version of IAP and create a release branch in GitLab. If you do not see the Example Project available in your version of IAP please contact Itential.

While Itential tests this Example Project and its capabilities, it is often the case the customer environments offer their own unique circumstances. Therefore, it is our recommendation that you deploy this Example Project into a development/testing environment in which you can test the Example Project.

Using this Example Project

Example Projects contain 1 or more workflows. Each of these workflows have different inputs and outputs.

Create Network and Claim Devices - Meraki - Example

This example use case automates the procedure of provisioning a new Meraki device, including creating the network and claiming the device.

Capabilities include:

• Create an organization network
• Claim devices into the created network

Example Project Configuration

Note that the JSON Form Create Network and Claim Devices - Meraki - Example uses Dynamic Data Binding and leverages the Itential Open Source Meraki adapter to populate the dropdown items in the JSON Form input fields Organization Name and Claim Devices. The base URL used in both of these requests needs to be verified as being equal to the name of the Meraki adapter instatiated on your IAP instance.

Additionally, the Request Body used for the Claim Devices dropdown selection needs to be updated to have the ID of the Meraki organization to use to search for devices. This ID can be found in the API response from the call used for input field Organization Name and copying the id associated with the name property of the intended organization.

Entry Point IAP Component

The primary IAP component to run Create Network and Claim Devices - Meraki - Example is listed below:

Inputs

The following table lists the inputs for Create Network and Claim Devices - Meraki - Example:

Organization

[
  "switch",
  "wireless",
  "camera"
]

[
  "A1B2-C3D4-E4F5",
  "1111-2222-3333"
]

Network

America/New_York

[
  {
    "tag": "tag1"
  },
  {
    "tag": "tag2"
  }
]

Meraki

Note associated with the network created.

Outputs

There are no outputs for Create Network and Claim Devices - Meraki - Example.

Query Output

There are no query output examples for Create Network and Claim Devices - Meraki - Example.

Example Inputs and Outputs

Example 1

Input:

{
  "formData": {
    "tags": [
      {
        "tag": "tag1"
      },
      {
        "tag": "tag2"
      }
    ],
    "productTypes": [
      "appliance",
      "camera",
      "cellularGateway",
      "sensor",
      "switch",
      "systemsManager",
      "wireless"
    ],
    "serials": [
      "Q3AL-NE8E-R4K6",
      "Q4AB-J4J8-6BJR"
    ],
    "organizationName": "Organization",
    "networkName": "Network",
    "notes": "Note about network created",
    "timeZone": "America/Denver",
    "merakiAdapter": "meraki"
  }
} 

Output:

{} 

API Links

No API Links provided.

Create Network and Claim Devices - Reset - Meraki - Example

This example use case automates the procedure of releasing a Meraki device that is currently claimed.

Capabilities include:

• Delete the network from Cisco Meraki

Example Project Configuration

Note that the JSON Form Create Network and Claim Devices - Reset - Meraki - Example uses Dynamic Data Binding and leverages the Itential Open Source Meraki adapter to populate the dropdown items in the JSON Form input field Network Name. The base URL used in this request needs to be verified as being equal to the name of the Meraki adapter instatiated on your IAP instance.

Additionally, the Request Body used for the Network Name dropdown selection needs to be updated to have the ID of the Meraki organization to use to search for devices. This ID can be found in the API response from the call used for input field Organization Name in the JSON Form Create Network and Claim Devices - Meraki - Example and copying the id associated with the name property of the intended organization.

Entry Point IAP Component

The primary IAP component to run Create Network and Claim Devices - Reset - Meraki - Example is listed below:

Inputs

The following table lists the inputs for Create Network and Claim Devices - Reset - Meraki - Example:

L_627126248111380526

Meraki

Outputs

There are no outputs for Create Network and Claim Devices - Reset - Meraki - Example.

Query Output

There are no query output examples for Create Network and Claim Devices - Reset - Meraki - Example.

Example Inputs and Outputs

Example 1

Input:

{
  "formData": {
    "networkId": "L_627126248111380526",
    "merakiAdapter": "Meraki"
  }
} 

Output:

{} 

API Links

No API Links provided.

Additional Information

Support

Please use your Itential Customer Success account if you need support when using this Workflow Project.