CsvColumnMappings

CsvColumnMappings
CSV Column Mappings

Defines how CSV columns map to segmentation concepts. This configuration tells the analysis engine which columns contain asset identifiers, types, and hierarchy information. When provided, certain fields become required to ensure valid mapping.

Notes:

  • asset_identifiers (1-3 columns) must be set before triggering PARSE_FILE; the analysis engine uses these columns to match CSV rows to NSX entities (VMs, segments, etc.).
  • columns is a read-only field auto-detected from the CSV header row; it cannot be set by clients.
  • If asset_type is omitted, the system will attempt to auto-detect asset types from the column values.
JSON Example
{
    "columns": [
        "string"
    ],
    "asset_identifiers": [
        "string"
    ],
    "asset_type": "string",
    "hierarchy_scopes": {
        "region_scope": "string",
        "zone_scope": "string",
        "environment_scope": "string",
        "application_scope": "string",
        "application_tier_scope": "string"
    },
    "infrastructure_service": "string"
}
array of string
columns
Optional

Complete list of column names from the uploaded CSV file. This is typically auto-detected from the CSV header row.

array of string
asset_identifiers
Optional
Constraints: minItems: 1 maxItems: 3

List of column names (1-3) used to identify and resolve assets to NSX entities. The analysis engine will use these columns to match CSV rows to VMs, segments, etc. This field is absent when identifiers have not yet been assigned for this session.

string
asset_type
Optional

Column name that specifies the type of asset (e.g., VIRTUAL_MACHINE, SEGMENT). If not provided, the system will attempt to auto-detect asset types.

hierarchy_scopes
Optional

Defines the mapping of CSV columns to segmentation hierarchy levels. The hierarchy follows a fixed order: Region -> Zone -> Environment -> Application -> Tier. Not all levels need to be specified, but if a lower level is specified, all parent levels must also be specified (e.g., to use Tier, you must specify Application).

Notes:

  • The hierarchy follows a strict top-down order: Region -> Zone -> Environment -> Application -> Tier; a lower level cannot be specified without all its parent levels.
  • Omitting a level means the CSV does not provide that scope, which limits the depth of segmentation object hierarchy that can be generated.
  • Column names are case-sensitive and must exactly match the column headers from the uploaded CSV.
string
infrastructure_service
Optional

Optional column name for infrastructure service classification. Used to identify infrastructure services like DNS, DHCP, NTP, etc.