Auvik

What You'll Need

• Access to retrieve Auvik API credentials.
• Admin or super-admin user role within Hudu.

Integration Features

• Companies:
  • Create client spaces within Hudu directly from Auvik companies, or seamlessly merge them into existing (already-created) client spaces.
• Configurations:
  • Pull configuration/device information from Auvik; sorted into asset layouts based on set sort rules.
• Networks:
  • Auvik-discovered networks are automatically synced into Hudu and placed within the Core IPAM section of the respective company, unless the Skip Networks option is enabled.

What Hudu needs from Auvik

• Auvik Domain.
• Auvik Domain Prefix.
• Auvik Username.
• Auvik API Key.

Obtaining the Auvik Information

• It is recommended to use the Default Super Admin or API Access Only roles if possible to ensure there are all the necessary permissions. 
• Alternatively, you could create a new user with locked-down permissions.
  • Navigate to your Auvik account.
  • Go to the left-hand side of Auvik and click Manage Users >> Roles.
  • Click Add Role.
  • Under Inventory API, give the role the following permissions:

• Save the settings. It should look like this:

• Assign the role to the user you would like to use for the integration.
  • When creating the user, assign it a role with access to all client spaces that you'd like to bring over.
• Login (to Auvik) as the user and generate an API Key under the bottom-left edit profile tab.

• Copy the API key and paste it into Hudu exactly.
• Alternate required information:
  • Auvik Domain: Look in your Auvik Dashboard at the URL. You will need to take the FQDN without the first subdomain.
    • For example, the URL mytest.us2.my.auvik.com would need to be replaced with us2.my.auvik.com
  • Auvik Domain Prefix: This is the first part of the subdomain that we didn't use in the last step.
    • For example: from the URL mytest.us2.my.auvik.com, you would put only mytest
  • Auvik Username: This is the username of the account you set up earlier.
  • API key: This is the API key copied from earlier.
• Save the settings.

• Start the sync. After inputting all settings and ensuring the connection was successful; start the sync to push initial data to Hudu from Auvik (this is required before moving on).

Enabling the Auvik Integration

• Integrations can be enabled at any time, during Hudu environment testing or in production.

• Once enabled, integrations can be merged into existing documentation based on predefined rules.

• This allows you to configure the integration upfront or connect it later as needed.

• To enable the Auvik integration:

  • Navigate to the Hudu admin area (Admin → Integrations).

  • Select Auvik from the list.

Setting up the Integration in Hudu

Step 1. Connect to Auvik 

• Enter the following:
  • Auvik Domain
  • Auvik Domain Prefix
  • Auvik Username
  • Auvik API Key
• Choose any data types to skip (optional)
• Select any additional options:
  • Auto-update names of Assets - If name is changed in Auvik, the name will automatically be updated in Hudu
  • Do not update basic company details - This will prevent the company details from being changed in Hudu if they are changed in Auvik
  • Match assets on primary serial - This option tells Auvik to match devices using their primary serial number. It helps ensure that assets are correctly identified and reduces the chance of duplicates when device names or other attributes change.
• Save the Settings

Step 2. Test connection and run an initial sync

• On the integration overview page, click Test Connection
• If successful, start an initial sync to bring in Auvik Sites

Step 3. Match Auvik Sites

• Before Sites from Auvik can be brought into Hudu, they must be matched to:

  • Existing companies in Hudu, or

  • New companies you create in Hudu

• Hudu recommends matching one client first for testing to ensure data imports correctly

• When the integration runs successfully for the first time:

  • Sites from Auvik are imported

  • They appear in the Matched Companies List for the integration

• Navigate to Hudu Admin → Integrations → Auvik

• Open the integration and click Match Companies

• Review the list of companies and choose one of the following options:

  • Bulk create and/or match all companies

  • Match a company to an existing Hudu company

  • Create a new matched company in Hudu from a Auvik company

  • Leave a company unmatched (it and its data will not be imported)

• After matching companies, re-run the integration import to populate data for the matched or newly created companies

Step 4. Skip the following Auvik device types

• Once an initial sync has been ran, next tell Hudu which device types you would like to skip (optional)

Step 5. Choose where Auvik devices will fill to

• Select Default Asset Layout

  • Choose an asset layout (must be active asset layouts) from the list to designate as the default asset layout

  • They store information that is pulled in but not explicitly mapped to another asset layout

• The Auvik integration requires one default asset layout for:

  • Devices

• Add Sort Rules

  • Sort Rules determine how data types from Auvik are mapped to asset layouts in Hudu

  • They let you define specific rules that control where each asset type is placed

  • Any asset types imported without an assigned Sort Rule will automatically be placed into the default asset layout

  • Asset layouts used for Sort Rules can be created ahead of time in the Hudu admin area (Admin → Asset Layouts) and must be marked as Active

  • You can also create new asset layouts directly from this section if needed.

• Save the Settings and stop and start the integration to reflect your changes. 

FAQ