The Bidirectional Forwarding Detection (BFD) template contains a configuration of advanced BFD settings such as authentication and timer intervals.
References to bfdtemplate are object references. The name part of a BFD template object reference has the following components:
- Name of the BFD template
Example: bfdtemplate/ZG5zLmJpbmRfY25h:templatename
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): name.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name |
The authentication key for BFD protocol message-digest authentication.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
authentication_key is not readable.
The authentication key identifier for BFD protocol authentication. Valid values are between 1 and 255.
Type
Unsigned integer.
Create
The default value is 1.
Search
The field is not available for search.
The authentication type for BFD protocol.
Type
String.
Create
The default value is NONE.
Search
The field is not available for search.
The detection time multiplier value for BFD protocol. The negotiated transmit interval, multiplied by this value, provides the detection time for the receiving system in asynchronous BFD mode. Valid values are between 3 and 50.
Type
Unsigned integer.
Create
The default value is 3.
Search
The field is not available for search.
The minimum receive time (in seconds) for BFD protocol. Valid values are between 50 and 9999.
Type
Unsigned integer.
Create
The default value is 100.
Search
The field is not available for search.
The minimum transmission time (in seconds) for BFD protocol. Valid values are between 50 and 9999.
Type
Unsigned integer.
Create
The default value is 100.
Search
The field is not available for search.
The name of the BFD template object.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| authentication_key | String | N | N | N | N/A |
| authentication_key_id | Unsigned int | N | N | N | N/A |
| authentication_type | String | N | N | N | N/A |
| detection_multiplier | Unsigned int | N | N | N | N/A |
| min_rx_interval | Unsigned int | N | N | N | N/A |
| min_tx_interval | Unsigned int | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
