Armis Integration

In this guide we will cover:

• What is the Armis Integration?
• Connecting to Armis
• Sites
• Assets
• Syncing

What is the Armis Integration?#

Armis can be integrated with Halo to import and manage Sites and Assets, and sync these on a recurring schedule to ensure details stay up-to-date.

Connecting to Armis#

In Configuration > Integrations > Asset Management and Alerting, find the "Armis" module. Hover over it and click the "+" icon to enable the module.

Fig 1. Armis module

Clicking into the module will show the "Details" tab to create a new Armis connection. Give the connection a name, and enter your Armis URL and API Key. The API Key can be obtained from Armis.

Fig 2. Entering credentials

Upon saving, you can then click the "Test Configuration" button that will appear. 

Fig 3. Test Configuration button

A popup will then show to tell if the test was successful. If the credentials are invalid, an error message will show here to help troubleshoot.

Fig 4. Test successful popup

Sites#

Switch to the Sites tab to import your sites from Armis. The first field has a dropdown to select a "Site matching method", which will determine the fields that show afterwards to configure the import.

Import and map sites from Armis to sites in Halo#

The first method is to "Import and map sites from Armis to sites in Halo". With this method, you will have the additional option for "Customer for New Sites". This will be the Halo Customer that any newly created Sites will be made under if not mapped.

Fig 5. Site mapping import method

Clicking the "Add" button will allow you to map a Halo Site to an Armis Site.

Fig 6. Site mappings popup

Site Rules#

If the Site matching method is set to "Site Rules", you can add criteria for which Asset criteria falls into a Site.

Fig 7. Site rules import method

Clicking the "Add" button will show this popup to map a Halo Site based on criteria. You can choose a field, and whether data that includes or omits certain information falls into that criteria. In this example, any Asset's name that begins with "HAL" will be imported under the Org 1 Customer, Main Site.

Note: Criteria is based on Halo fields, so any fields set here will need to be mapped in the following "Assets" tab.

This method does not require the import of Sites after mapping as a result of this behaviour.

Fig 8. Criteria mappings

General Configuration#

Both methods then offer additional configuration options.

• Assets will be assigned to this Site if no Site has been matched: This is the Site that Assets will be imported under if they have not been matched to a Site by either matching method.
• Don't update the asset site for existing or matched assets: If enabled, any Assets that already exist in Halo will not have their Site changed (if different in Armis).

Upon saving, and if using the "Import and map sites from Armis to sites in Halo" Site matching method, the "Import Sites" button will show to manually import Sites. This button will be hidden if using the "Site Rules" method.

Fig 9. Import Sites button

Assets#

Once Sites have been matched (and imported if using the Site mapping method), you can then import the Assets.

The first field is the "Asset Matching Field", which will determine how Assets are matched to existing records when updating Assets. This should be an field that is unique per Asset.

Asset Field Mappings#

You can then set Field Mappings in the table below this. This determines which Halo fields information from Armis is pulled into. If the "Site Rules" matching method was used, ensure every field that is used as criteria is correctly mapped here to match that.

Fig 10. Field mappings

Clicking the "Add" button will bring up the below pop to map an Armis Field to a Halo Field. This can be with both system Asset Fields or Custom Fields.

Fig 11. Asset Field mappings

From v2.238+, manual mappings for properties not natively in the Armis field list are supported. To add one of these properties, select the "Manually enter Armis field" in the dropdown. This will show a text field where you can enter the Armis field name. From this version you can also map Armis custom properties by selecting "customProperties" in the dropdown. 

Filter which Assets are Imported#

If you would not like to import all the assets in your CMDB, you can set filters to control which assets are imported. Filters are set in the "Filters" table. 

Fig 12. Filters table

When adding a filter simply choose the field in Armis you would like the filter to be based on as well as the filter criteria. 

Fig 13. Example Filter

Operator - Controls whether assets need to meet all the criteria in the filter table, or at least one criteria in the table to be imported.

Filter Field - The field that criteria will be based on.

Filter Type - Controls whether assets should or should not contain the specified value in order to be imported.

Filter Value - The value in the chosen field assets need to/need to not have in order to be imported. 

From v2.238+, "Time Frame"  can be used as a Filter field.  

Determine Asset Types#

After completing the Field mappings, you can then set the the Asset Type configuration.

• Default Group for new Asset Types: Sets the Asset Group newly created Asset Types will be assigned to.
• Determining an Asset's type: Sets how the Asset Type is determined. 

  • Use the same type for all Assets: Assigns all Assets to a set Asset Type.

  • Use a field to determine each Asset's type: A set Field will be used for determining an Asset's type. If an Asset cannot match via this Field, it will be assigned to a set default Asset Type.

  • Determine Asset Type using rules: Criteria can be mapped to Asset Types based on values in Halo Fields. If an Asset cannot match via this Field, it will be assigned to a set default Asset Type.

• Don't update the Asset type for existing or matched Assets: If enabled, pre-existing Assets will not have their Asset Type updated (if different in Armis).

Fig 14. Asset Type configuration

Miscellaneous Asset Import Settings#

Finally, we can set the miscellaneous Asset configuration.

• Don't create new Assets: If enabled, Assets will not be created, only updated.
• Status of New Assets: Newly created Assets will be given this Status.
• Deactivate Assets in Halo when they are deleted from Armis (Halo Integrator only): If Assets are deleted in Armis, they will be made inactive in Halo (via the "Active" checkbox) when syncing via the Halo Integrator.
• Status for Assets when they are deleted from Armis (Halo Integrator only): If Assets are deleted in Armis, they will be given this Status in Halo when syncing via the Halo Integrator.

Fig 15. Miscellaneous configuration

Save, and the Assets can now be imported. Click the "Import Assets" button at the bottom of the tab.

Fig 16. Import Assets button

The Asset below has been imported, created a new "Automations" Asset Type, and assigned the Asset to that Asset Type.

Fig 17. Imported Asset example

The newly created Asset Type has been assigned to the default Asset Group.

Fig 18. Asset Group on the imported Asset Type

Syncing#

Once Sites and Assets are configured, you can enable the Halo Integrator to automatically sync Devices (Assets) and Sites.

Note: It is recommended to ensure you are happy with the configuration by manually importing before enabling automatic syncs via the Integrator.

Check "Enable the Halo Integrator for the Armis integration", and select the entities you wish to automatically sync.

Fig 19. Halo Integrator configuration