Axonius to External Field Mapping
  • 17 Apr 2024
  • 4 Minutes to read
  • Dark
    Light
  • PDF

Axonius to External Field Mapping

  • Dark
    Light
  • PDF

Article summary

Use the field mapping Wizard to map Axonius fields to fields in external systems. In this way you can transfer data found in Axonius into the external system as part of the configuration of relevant enforcement actions; for example Axonius to ServiceNow field mapping. The wizard shows you which fields exist on the Axonius system, allowing you to map them easily.
The following Enforcement Actions are supported:

Mapping Fields from External Systems to Axonius Fields

Use the Wizard to enter fields from External Systems and map them to Axonius fields.
To map Axonius fields to fields from External Systems:

Note: Screen captures in the example are from ServiceNow.

  1. From the Action Library, click Manage CMDB Assets, and then click the name of the Enforcement Action set you want to configure.

  2. Locate the section Map Axonius fields to <External System name> fields.
    MapCMDB1.png

  3. In the text box with the prompt Enter <adapter name> field, enter the name of an external field.
    MapCMDBEnterPrompt.png

  4. Click the Adapters list drop down and select an adapter. You can select the name of an aggregated field available on the system, or fields from one or more specific adapters.
    MapCMDBAdapterList.png

  5. Click the drop down box to see fields available and select a field.
    MapCMDBSelectFieldList.png

  6. Click Add Field to add another field to map.

  7. If necessary, select more field/adapter combinations and set their priorities. By default, the first combination is assigned 1st priority. See Setting Priority for Adapters and Fields for more about how to set field priority.
    FieldMapping2.png

  • Click TrashcanIcon-gray.png to delete a row.
Note:
Each custom field is sent as is, and not converted to a different format (i.e. integers remain integers, and their format is not changed).

Setting Priority for Adapters and Fields

When you choose specific adapters, the system can check whether the field/adapter combination is available according to priority that you can set. If the specific field/adapter combination is not available, additional field/adapter combinations are checked according to priority that you set. You can select different fields for each adapter and priority.

  1. Choose an adapter and a field. 1st appears in the drop down box
    MappingFirst-1.png

  2. Click 1st and choose Add 2nd mapping priority. A search box appears to the right.

    Add2ndMapping.png

  3. In the Search box, type an adapter name or select one from the list.
    MappingSearch.png

  4. In the field list, select a field. The field can be any field in the list.
    MappingSearch-2.png

  5. Click 2nd to add a third adapter and field.
    FieldMappingFieldAdapCombo-small.png

You can add as many adapter/field combinations as required.

Loading a Table of Mapped Files from a CSV File

You can also load a CSV file with a list of mapped fields. The CSV file should contain three columns with the titles, 'Adapter', 'Axonius field', 'External field'.

  • Adapter - the Axonius field adapter, if this is empty use Aggregated.
  • Axonius field - the name of the Axonius field
  • External field - the name of the field from the external system.

Axonius provides a template to create these CSV files

  1. Click Template to download the template.

MappingTEmpalte.png

  1. Click Import CSV to load a CSV file; a browser opens for you to upload a file.

    • If you have already mapped values, the imported file adds to the existing values.
    • If a field is mapped and also appears in the CSV file, the value in the CSV file overrides the value in the wizard.

Switching between Wizard and JSON View

You can view and define field mapping using the wizard or by describing the adapters, fields, and priorities in JSON format.

  • Click JSON view to see the mapping in JSON format or set the mapping using JSON.
    FieldMapping-WizardToJSON.png

  • Click Wizard view to go back to the wizard.
    FieldMapping-JSONToWizard.png

Mapping Format in JSON

You can set the mapping of Axonius fields to fields from external systems using JSON. The input format is key/value pairs in JSON format.
For example:

{"axonius_field1":"servicenow_field1", "axonius_field2":"servicenow_field2"}

Axonius Field Format

  • Axonius field names can be supplied in a short name or in a full name format. The following table provides examples for each format for each field type:
Note:

If you open the JSON file in the Wizard, the Wizard converts the Axonius field names to short name format. Full name is still supported.

Field LevelField TypeField Label in GUIFormat - Short NameFormat - Full NameComment
AggregatedSimpleimage.pnghostnamespecific_data.data.hostname
AdapterSimpleimage.pngaws_adapter:hostnameadapters_data.aws_adapter.hostname
AggregatedCompleximage.pnginstalled_software:namespecific_data.data.
installed_software.name
Mapping is supported only for the 1st level fields in a complex field hierarchy
AdapterCompleximage.pngtanium_asset_adapter:
installed_software.name
adapters_data.tanium_asset_adapter.
installed_software.name
Mapping is supported only for the 1st level fields in a complex field hierarchy
  • A field that contains multiple values will be mapped to a single string consisting of the various values separated by comma.
  • The supplied field mapping can override any of the default mappings done when the external entity is created/updated.
  • If the supplied Axonius field is not found, the specific key/value pair will be ignored.

External System Field format

  • The External System field names are the External system technical name as defined in the relevant API.

Setting Priority in the JSON View

You can set priority in the JSON file, refer to Setting Priority for Adapters
To set priority use one of the following syntax options:
Option 1:

"adapter1name, adapter2name, adapter3name: asset name”:”servicenow_assetname"

For example:

"alibaba_adapter,aws_adapter,cisco_adapter :plugin_and_severities.nessus_instance.thorough_tests": "test"

Option 2:

"adapter1name=field1name,adapter2name=field2name, adapter3name=field3name”:”servicenow_assetname"

For example:

{
"service_now_adapter=hostname,jira_software_adapter=asset_name": "servicenow_assetname"
}

Mapping the Same Axonius Field to More than one External System Field

Use commas in the JSON file to map the same Axonius field to more than one External System field.
For example: "hostname": "test,dd"


For more details about other Enforcement Actions available, see Action Library.


Was this article helpful?