# UDM Configurations (Addresses)

## Overview

The User-Defined Metadata allows for additional information to be added to a record for a given IP address. It can also be used to override existing fields. Metadata maybe specified for CIDR blocks, IP ranges or individual IP addresses.

## Configurations

### EF\_PROCESSOR\_ENRICH\_IPADDR\_METADATA\_ENABLE

Specifies whether the user-defined metadata enrichment is enabled.

* Valid Values
  * `true`, `false`
* Default
  * `false`

### EF\_PROCESSOR\_ENRICH\_IPADDR\_METADATA\_USERDEF\_PATH

If the user-defined metadata enrichment is enabled (`EF_PROCESSOR_ENRICH_IPADDR_METADATA_ENABLE` is `true`) this setting specifies the path to the metadata file. If this value is undefined or empty, metadata enrichment will be disabled.

For more details on the format of this file and the behavior of the User-Defined Metadata functionality, refer to: [User-Defined Metadata Enrichment](/flowcoll/configuration/enrichment-options/ip-address-enrichment/enrich_ip_udm.md#user-defined-metadata-enrichment)

* Default
  * `''`
* Recommended
  * `/etc/elastiflow/metadata/ipaddrs.yml`

### EF\_PROCESSOR\_ENRICH\_IPADDR\_METADATA\_REFRESH\_RATE

The file specified in `EF_PROCESSOR_ENRICH_IPADDR_METADATA_USERDEF_PATH` can be loaded automatically to refresh values without restarting the collector. This value specifies the refresh interval, in minutes, that the file will be reloaded. The value of `0` disables refreshing of the values.

* Default
  * `15` 

### EF\_PROCESSOR\_ENRICH\_IPADDR\_METADATA\_API\_ENABLE

Enable the REST/gRPC/connectrpc [API for User-Defined Metadata](/flowcoll/overview/api-based-metadata-enrichment.md). To enable this feature, [`EF_PROCESSOR_ENRICH_IPADDR_METADATA_ENABLE`](#ef_processor_enrich_ipaddr_metadata_enable) must also be set to `true`.

If the API is enabled, after startup of NetObserv, the file configured with `EF_PROCESSOR_ENRICH_IPADDR_METADATA_USERDEF_PATH` is never re-read, and should not be modified by hand, only via the API.

If this field is `false` (and `EF_PROCESSOR_ENRICH_IPADDR_METADATA_ENABLE` is `true`), then the API is disabled, and any updates to the `EF_PROCESSOR_ENRICH_IPADDR_METADATA_USERDEF_PATH` file must be done manually. As mentioned above, in that case the refresh rate can be configured using `EF_PROCESSOR_ENRICH_IPADDR_METADATA_REFRESH_RATE`.

* Valid Values
  * `true`, `false`
* Default
  * `false`


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.elastiflow.com/flowcoll/configuration/enrichment-options/ip-address-enrichment/enrich_ip_udm/enrich_ip_udm.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.