Axonius

About

The Axonius context integration provides enriched asset context to Netography Fusion from Axonius. It connects to the Axonius Platform API to retrieve asset information and then adds Context Labels to Netography Fusion.

As Axonius is a flexible platform that has a very broad set of potential queries and fields that may be used, you should expect that using this module will require basic familiarity with Axonius.

☁️NetoFuse Modules: Cloud deployment vs. on-prem deployment

This page documents how to add and configure the context integration in the Netography Fusion Portal. This will make a direct connection from the Netography Fusion SaaS in the cloud to the vendor API. If you prefer to deploy the integration within your own environment (on-prem or in your own cloud) with a container or Python package, go to the module documentation in NetoFuse Modules.

Adding a Context Integration

In the Netography Fusion Portal:

1. Select Settings at the bottom of the left-hand navigation menu

2. Select Context Integrations in the Data Management section.

3. Select the Add Integration button.

4. Select a context integration from the list provided.

5. Follow the configuration steps in the documentation for the context integration you selected.

Configuring

Axonius Field	Required	Description
Axonius URL	yes	URL to Axonius API
Axonious API Key	yes	Authentication key for Axonius API
Axonius API Secret	yes	Authentication secret for Axonius API
Saved Query	no	Saved query used to retrieve asset information
Query	no	Manually constructed query used to retrieve asset information
Entries	no	Axonius API wizard expression used to retrieve asset information
Fields	no	List of fields to return from api - required if using Query or Entries parameter

ℹ️You must specify one of Saved Query, Query, or Entries

There are 3 ways to query Axonius with the integration. You can either used the Saved Query parameter, Query (along with Fields), or Entries (along with Fields) to define the assets and fields to retrieve from the Axonius API.

Axonius Configuration

1. Create an API key in Axonius by following the instructions here: Axonius REST API

2. Optional: You can create a Saved Query in Axonius and then use that to determine what asset information is retrieved from the Axonius API. See: Creating and Saving a Saved Query in Axonius. If you do not specify a saved query, you must instead directly define the query in the Axonius NetoFuse module configuration below.

Configuring how the Axonius API is queried

Due to the wide variety in how Axonius is used, the axonius NetoFuse module does not have a default configuration for what assets and fields to use from Axonius. At a minimum, you must define the query to use with Axonius and the fields to retrieve.

The axonius module has three options available for defining what assets are retrieved and what fields are retrieved for those assets:

API query option 1: saved_query

See step 2 of the Axonius Configuration section above to set a saved query in Axonius.

API query option 2: query and fields

Use the query field with a valid Axonius GUI wizard expression. See Creating Queries with the Query Wizard for instructions on constructing queries in the Axonius GUI.

The fields field contains the list of Axonius fields to return from the API. To see a list of available fields in your Axonius deployment, you can install the Axonius API client and run the following command:

axonshell devices get-fields

API query option 3: entries and fields

The entries field contains the Axonius API wizard expression used to return the list of devices. You can get help with this by installing the Axonius API client and running the following command:

axonshell devices get --help-detailed wizard

The fields field contains the list of Axonius fields to return from the API. To see a list of available fields in your Axonius deployment, you can install the Axonius API client and run the following command:

axonshell devices get-fields

client_args adds additional arguments to pass to the Axonius API client

Any key:value parameters included in the client_args:section of the module configuration will be directly passed as parameters to the Axonius API client.

Tips for configuring queries

The module uses the Axonius API client to connect to and retrieve assets from Axonius. This is a freely available client from Axonius, and it is very helpful to have this client installed and configured on your development or local system if you will use this module. Test the queries and field settings you want to use, and inspect the results that are being returned using the axonshell devices commands.

For example, this command can be used as a template for testing different field and query configuration options:

axonshell devices get --fields '' --query ''

Download the Axonius API client here: https://axonius-api-client.readthedocs.io/en/latest/index.html

Transform

The Advanced section of the context integration contains the Transform field. This field allows you to add, remove, or change the mapping of fields returned by the vendor API to Netography Fusion context labels.

See the Context Transforms documentation section for more instructions on editing this field.

It may be helpful to first configure all the parameters and the transform field with a NetoFuse container on your local system and then copy those fields into the Portal once you have validated that everything is configured properly.