Formatting the IPAM data for import - User Guide - BlueCat Horizon

BlueCat Horizon User Guide

ft:locale
en-US
Product name
BlueCat Horizon

Follow these guidelines for formatting the IPAM data you’re importing into DDI orchestrator.

Examples of IPAM data import formats are provided on the following pages for ranges, IP addresses, devices, and DHCP reservations.

Clearing values

By default, empty values in a column will not be automatically cleared. Instead, it is excluded from the import. This allows you to selectively update certain fields while leaving others unchanged within the same import action.

To clear a value for a custom property, such as “Responsible Person”, insert one of the following clearing tokens in place of an empty value:

  • $null

  • %clear

  • <none>

  • <blank>

  • <empty>

These tokens will clear the field only if the field contains the token and nothing else. For example, if the import text contains the field value “This is <none>”, the field will not be cleared, but instead assigned that specific value.

Refer to the Clearing property example for IP address information import.

Header line

The first line of the data must be a header line, containing the name of the fields in the follwoing columns. Some fields refer to built-in system fields and vary depending on the contents of the import. The remaining fields should match the custom properties defined for the object type. Only fields that you want to import or update need to be included, except for those that are mandatory or required for object identification.

Field names in the header are not case-sensitive. For example, “title” matches the custom property “Title”.

Action field

The Action field is an optional column that defines whether to add, remove, or modify the object specified in the line, with Add being the default action unless otherwise specified.

This column is identified by the fieldnames “Action”, “Operation”, or “ActionType”. If a custom field name conflicts with one of these, it will take precedence and the column won’t be recognized as the Action column. In that case, use one of the provided alternatives for the Action column that doesn’t conflict with custom property names.

The Action field can have one of three values:

  • Add: The default for Range Import. Create, New, and Import are equivalent alternatives.

  • Update: The default for IP Address Import. Modify and Mod are equivalent alternatives.

  • Delete: Remove and Del are equivalent alternatives.