Auvik Network Management

This document provides the steps required to configure the Auvik Network Management integration with Gradient.

Overview

The integration with Auvik Network Management syncs billable devices exclusively from this platform and does not currently support Auvik SaaS Management. The integration creates the following services to facilitate mapping and reconciliation with services or products in your PSA, based on your billing requirements:

• Total Billable Devices
• Firewalls
• Controllers
• Routers 
• Layer 3 Switches
• VoIP Switches
• Switch Stacks
• Total Switches
• Access Points

What Counts as a "Billable Device"

For further clarification on what constitutes a billable device in Auvik Network Management, please consult the following article here.

Access Points

Although Access Points are not typically classified as billable devices in Auvik Network Management, we have introduced this additional service to reconcile the number of access points deployed at each site to accommodate your billing requirements.

Unmanaged Devices

In Auvik Network Management, there's an option to edit a device and change its status from "billable" to "unmanaged". However, please be aware that we do not currently synchronize "unmanaged" billable devices into Synthesize.

Additionally, Auvik Network Manager employs an "Auvik-identified" device category rather than a user-identified one. This approach is designed to prevent users from altering billable devices like switches and misclassifying them as access points to avoid billing.

It's important to recognize that there may be slight disparities between Auvik's definition of a billable device and the user-identified fields, as well as the "managed" devices synchronized by Synthesize.

Nested Sites

Currently, we are unable to reach down nested accounts/sites within Auvik.  

How to Configure Auvik Network Management

To connect and configure the Auvik Network Management integration, please review the following documentation:

Authentication Details

Check API Access Only Role Permissions

Before inviting an API Access Only user, verify that the API Access Only role possesses the appropriate permissions. Ensure that the role is configured with "API Access Only" enabled and "Read Access" granted for the "Inventory API".

1. Login to Auvik Network Manager.
2. Click on "Manage Users" in the side navigation bar, then select "Roles".
3. Choose the "API Access Only" role and click on "Edit".
4. Enable the "API Access Only" option.
5. Expand the "Inventory API" section and ensure that "Read" access is selected.
6. Click on "Save" to apply the changes.

Invite User with API Access Only Role

Before generating an API Key, it's recommended that you invite a new user that as an API Access Only Role assigned that has Read Only access to all accounts.

1. Login to Auvik Network Manager.

2. Click on "Manage Users" in the side navigation bar, then select "Users".

3. In the Invitation box, select "Invite User".

4. Enter the email address you wish to invite (e.g., gradient@yourdomain.com). Note that access to this email inbox is required to accept the invitation, register, and log in as this user to generate an API Key.

5. Check the box for "All" sites from the list of sites.

6. From the "Roles" drop-down menu, choose "API Access Only."

7. Click on "Invite" to send the invitation.

8. Accept the invitation, completing the registration process, and logging in as this user to generate an API key according to the following steps below.

Generate an API Key 

1. Login to Auvik Network Manager
2. Navigate to your User Profile in the side navigation bar.
3. Click on "Generate".
4. Copy the generated API key by clicking "Copy" and ensure to securely store this API Key for future use.
5. Click "Save" to confirm the changes.

API URL

In order to authenticate Auvik Network Management, an API URL is required. Within the API URL, us1.my (https://auvikapi.us1.my.auvik.com) should be updated to match the region in which your account resides. To locate the region, log into your Auvik dashboard and look at the URL in your browser’s address bar.

Connect Auvik Network Management

1. Navigate to the Integrations tab.
2. Select the Auvik Network Management integration and click Connect.
3. Enter the API URL and API Key generated from Auvik Network Management in the previous steps.
4. Click Authenticate.
5. Once successfully authenticated, accounts and services will be generated, and the integration will be updated to a pending status. You can click the status refresh button or simply refresh your browser if you are unable to proceed to the next step.
   
   

Map Accounts and Services

1. We have auto-mapped any accounts that are exact matches. The remaining can be searched by pressing the filter button or typing in the search bar. 
2. Review and Press Finish