NSX-T Data Center REST API

Update the BFD Configuration for BFD peers for routing (Deprecated)

Modifies the BFD configuration for routing BFD peers. Note - the configuration |
changes apply only to those routing BFD peers for which the BFD configuration has |
not been overridden at Peer level.
Deprecated:
Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>

Request:

Method:

PUT

URI Path(s):

/api/v1/logical-routers/{logical-router-id}/routing/bfd-config

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

BfdConfig+

BfdConfig (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
declare_dead_multiple	Number of times a packet is missed before BFD declares the neighbor down.	integer	Minimum: 2 Maximum: 16 Default: "3"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Flag to enable BFD for this LogicalRouter	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
logical_router_id	Logical router id	string	Readonly
receive_interval	Receive interval for heartbeats the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats.	integer	Minimum: 50 Maximum: 60000 Default: "500"
resource_type	Must be set to the value BfdConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transmit_interval	Transmit interval for heartbeats the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats.	integer	Minimum: 50 Maximum: 60000 Default: "500"

Example Request:

PUT https://<nsx-mgr>/api/v1/logical-routers/19e504e6-2d1f-4aec-a36d-80bd3eb4caed/routing/bfd-config { "enabled": true, "receive_interval": 600, "transmit_interval": 600, "declare_dead_multiple": 5, "_revision": 1 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BfdConfig+

BfdConfig (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
declare_dead_multiple	Number of times a packet is missed before BFD declares the neighbor down.	integer	Minimum: 2 Maximum: 16 Default: "3"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Flag to enable BFD for this LogicalRouter	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
logical_router_id	Logical router id	string	Readonly
receive_interval	Receive interval for heartbeats the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats.	integer	Minimum: 50 Maximum: 60000 Default: "500"
resource_type	Must be set to the value BfdConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transmit_interval	Transmit interval for heartbeats the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats.	integer	Minimum: 50 Maximum: 60000 Default: "500"

Example Response:

{ "enabled": true, "receive_interval": 600, "transmit_interval": 600, "declare_dead_multiple": 5, "_revision": 2 }

Required Permissions:

crud

Feature:

routing_routers

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable