Interface Config Intents
The recommended way to assign VRFs to agents is using Remote VRF configuration settings. In rare cases, when agent hosts may have multiple interfaces that need to be assigned different VRFs, users can choose to assign them VRFs using Interface Config Intents. Go to and click the Configure tab.
Inventory Config Intent Object
The GET and POST methods return an array of inventory config intent JSON objects. The object’s attributes are described below:
|
Attribute |
Type |
Description |
|---|---|---|
|
vrf_id |
integer |
VRF ID integer |
|
vrf_name |
string |
VRF Name |
|
inventory_filter_id |
string |
Inventory Filter ID |
|
inventory_filter |
JSON |
Inventory filter. See OpenAPI > Inventory Filters for more details. |
Get Interface Config Intents
This endpoint returns a list of inventory config intents to the user.
GET /openapi/v1/inventory_config/interface_intents
Parameters: None
Create or Update list of Interface Config Intents
This endpoint is used to create or modify list of interface config intents. The API takes an ordered list of intents. To remove an intent in this list, users would need to read the existing list of intents, modify the list and write the modified list back.
POST /openapi/v1/inventory_config/interface_intents
Parameters:
|
Name |
Type |
Description |
|---|---|---|
|
inventory_filter_id |
string |
Inventory filter ID to match interface |
|
vrf_id |
integer |
VRF ID to assign interface |
Sample python code
req_payload = {
"intents": [
{"inventory_filter_id": <inventory_filter_id_1>, "vrf_id": <vrf_id_1>},
{"inventory_filter_id": <inventory_filter_id_1>, "vrf_id": <vrf_id_2>}
]
}
resp = restclient.post('/inventory_config/interface_intents', json_body=json.dumps(req_payload))