NSX-T Data Center REST API

Read NSX Edge Ipsec VPN service status

Checks the status of iked process on the Edge.
If iked process is running, returns "running",
returns "stopped" otherwise.

Request:

Method:

GET

URI Path(s):

/api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn/status

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<ip>/api/v1/node/services/ipsecvpn/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeServiceStatusProperties+

NodeServiceStatusProperties (schema)

Name	Description	Type	Notes
_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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
health	Service health in addition to runtime_state	string	Readonly Enum: STABLE, DEGRADED
monitor_pid	Service monitor process id	integer	Readonly
monitor_runtime_state	Service monitor runtime state	string	Readonly Enum: running, stopped
pids	Service process ids	array of integer	Readonly
reason	Reason for service degradation	string	Readonly
runtime_state	Service runtime state	string	Readonly Enum: running, stopped

Example Response:

{ "_schema": "NodeServiceStatusProperties", "_self": { "href": "/node/services/ipsecvpn/status", "rel": "self" }, "pids": [ 21661 ], "runtime_state": "running" }

Required Permissions:

read

Feature:

system_administration

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