Configure YAML
Flowlink requires configurable parameters using a YAML file.
Note
Refer to the /usr/local/illumio/flowlink_config_schema.json file provided with the Flowlink RPM for definitions of all the fields supported by the Flowlink configuration file.
Key Value Parameters
This table describes the YAML file key-value parameters.
Parameter | Required/Optional | Description |
|---|---|---|
| Optional | The interval (in minutes) in which flows are aggregated and sent to the PCE. Default interval: 10 Minimum allowed interval: 5 Maximum allowed interval: 60 For example:
|
| Required | API key and secret of the PCE. This allows Flowlink to POST flows to the PCE. The API key and secret can be copied into a file. You can run a script to cat the contents of that file. In the example below, a file called api_info is created which contains the PCE API key and secret. For example:
|
| Required | A list of dictionaries. It requires a name, parser, and connector. Flowlink configuration supports one or many destinations (flow types). For more details about configuring the ingested flow types, see Ingested Flow Types. |
| Required | The pathname of a directory where Flowlink can store any unsent data flow files or any restart information. For example:
|
| Optional | The maximum size (in Megabytes) of data that can be stored in the data directory before being pruned. Default: 500 Minimum value: 100 For example:
|
| Optional | The maximum number of hours unsent data flow files will be stored before being pruned. Default: 24 Minimum: 4 For example:
|
| Optional | The frequency (in seconds) at which the metrics information is printed. Default: 60 Minimum: 15 For example:
|
| Required for SaaS Optional for on-premises | The org id to which the flow data will be posted. The default id is 1. For example:
|
| Required | FQDN of the PCE and port. For example:
|