NSX Autonomous Edge REST API

Get IPSec dead peer detection (DPD) profile

Get IPSec dead peer detection (DPD) profile.

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<ip>/api/v1/vpn/ipsec/dpd-profiles/12a39f8c-c37b-11e7-abc4-cec278b6b50a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNDPDProfile+

IPSecVPNDPDProfile (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.	integer	Readonly
_schema	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
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
dpd_probe_interval	DPD probe interval defines an interval for DPD probes (in seconds) When the DPD probe mode is periodic, this interval is the number of seconds between DPD messages. When the DPD probe mode is on-demand, this interval is the number of seconds during which traffic is not received from the peer before DPD retry messages are sent if there is IPSec traffic to send. For PERIODIC Mode: Minimum: 3 Maximum: 360 Default: 60 For ON_DEMAND Mode: Minimum: 1 Maximum: 10 Default: 3	integer	Minimum: 1 Maximum: 360
dpd_probe_mode	DPD probe mode DPD probe mode is used to query the liveliness of the peer. Two modes are possible - PERIODIC - is used to query the liveliness of the peer at regular intervals (dpd_probe_interval). It does not take into consideration traffic coming from the peer. The benefit of this mode over the on-demand mode is earlier detection of dead peers. However, use of periodic DPD incurs extra overhead. When communicating to large numbers of peers, please consider using on-demand DPD instead. ON_DEMAND - is used to query the liveliness of the peer by instructing the local endpoint to send DPD message to a peer if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds (i.e. there was no traffic from the peer for dpd_probe_interval seconds)	string	Enum: PERIODIC, ON_DEMAND Default: "PERIODIC"
enabled	Enable dead peer detection (DPD) If true, enable dead peer detection.	boolean	Default: "True"
id	Unique identifier of this resource	string	Readonly Sortable
is_default	Default Profile It is a boolean flag which reflects whether a profile is created and owned by system or not. If the session creation/update does not define a profile, this default profile will be used. Default profiles cannot be edited or deleted. If the sessions needs different settings, please create a new profile.	boolean	Readonly
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
resource_type	Must be set to the value IPSecVPNDPDProfile	string
retry_count	Retry count Maximum number of DPD messages retry attempts. This value is applicable for both dpd probe modes, periodic and on-demand.	integer	Minimum: 1 Maximum: 100 Default: "5"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type" : "IPSecVPNDPDProfile", "id" : "12a39f8c-c37b-11e7-abc4-cec278b6b50a", "display_name" : "nsx-default-dpd-profile", "enabled" : true, "dpd_probe_interval" : 90 }

Required Permissions:

read

Feature:

vpn

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