Create a static hop BFD peer

Creates a BFD peer for static route. The required parameters includes peer IP address.

Request:

Method:

POST

URI Path(s):

/api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

StaticHopBfdPeer+

StaticHopBfdPeer (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
bfd_config	Configuration for the BFD peer If not specified then BFD peer will inherit configuration from the BFD global config.	BfdConfigParameters
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	status of BFD peer Indicate BFD peer is enabled or disabled. Default is true.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
peer_ip_address	IP address of BFD peer IP address of BFD peer. This should be same as next hop IP address.	IPAddress	Required
resource_type	Must be set to the value StaticHopBfdPeer	string
source_addresses	Array of Logical Router Uplink IP Addresses BFD peers will be created from all these source addresses to this neighbour.	array of IPAddress	Maximum items: 8
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST https://<nsx-mgr>/api/v1/logical-routers/f962173f-ac03-4d08-8366-56a41779f61d/routing/static-routes/bfd-peers { "peer_ip_address": "10.10.10.10", "enabled": true, "bfd_config": { "receive_interval": 1000, "transmit_interval": 1000, "declare_dead_multiple": 3 } }

Successful Response:

Response Code:

201 Created

Response Headers:

Location
Content-type: application/json

Response Body:

StaticHopBfdPeer+

StaticHopBfdPeer (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
bfd_config	Configuration for the BFD peer If not specified then BFD peer will inherit configuration from the BFD global config.	BfdConfigParameters
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	status of BFD peer Indicate BFD peer is enabled or disabled. Default is true.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
peer_ip_address	IP address of BFD peer IP address of BFD peer. This should be same as next hop IP address.	IPAddress	Required
resource_type	Must be set to the value StaticHopBfdPeer	string
source_addresses	Array of Logical Router Uplink IP Addresses BFD peers will be created from all these source addresses to this neighbour.	array of IPAddress	Maximum items: 8
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "id": "ab6e173e-ac03-5d09-8888-46a41779f633", "peer_ip_address": "10.10.10.10", "enabled": true, "bfd_config": { "receive_interval": 1000, "transmit_interval": 1000, "declare_dead_multiple": 3 }, "_create_time": 1460092633898, "_last_modified_user": "admin", "_system_owned": false, "_last_modified_time": 1460092633898, "_create_user": "admin", "_revision": 0 }

Create a static hop BFD peer

Request:

StaticHopBfdPeer (schema)

Example Request:

Successful Response:

StaticHopBfdPeer (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: