Get IP Sec VPNIKE Session Status
List status of IPSec session. Query parameter source supports both realtime and cached mode.
Request
URI
GET
https://nsxmanager.your.domain/api/v1/vpn/ipsec/sessions/{session-id}/status
COPY
Path Parameters
string
session-id
Required
session-id
Query Parameters
string
source
Optional
Data source type.
Possible values are : realtime, cached,
Responses
200
OK
Returns IPSecVPNSessionStatus of type(s) application/json
{
"ipsec_vpn_session_id": "string",
"display_name": "string",
"failed_tunnels": 0,
"negotiated_tunnels": 0,
"session_status": "string",
"last_update_timestamp": 0,
"aggregate_traffic_counters": {
"packets_out": 0,
"dropped_packets_out": 0,
"bytes_in": 0,
"bytes_out": 0,
"dropped_packets_in": 0,
"packets_in": 0
},
"ike_status": {
"fail_reason": "string",
"ike_session_state": "string"
},
"total_tunnels": 0
}string
ipsec_vpn_session_id
Optional
UUID of vpn session.
string
display_name
Optional
Display name of vpn session.
integer As int64 As int64
failed_tunnels
Optional
Number of failed tunnels.
integer As int64 As int64
negotiated_tunnels
Optional
Number of negotiated tunnels.
string
session_status
Optional
Gives session status consolidated using IKE status and tunnel status. It can be UP, DOWN, DEGRADED. If IKE and all tunnels are UP status will be UP, if all down it will be DOWN, otherwise it will be DEGRADED.
Possible values are : UP, DOWN, DEGRADED,
integer As int64 As int64
last_update_timestamp
Optional
Timestamp when the data was last updated.
integer As int64 As int64
total_tunnels
Optional
Total number of tunnels.
400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string",
"related_errors": [
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string"
}
]
}
403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string",
"related_errors": [
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string"
}
]
}
404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string",
"related_errors": [
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string"
}
]
}
412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string",
"related_errors": [
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string"
}
]
}
500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string",
"related_errors": [
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string"
}
]
}
503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string",
"related_errors": [
{
"module_name": "string",
"error_message": "string",
"error_code": 0,
"details": "string"
}
]
}
On This Page
Vpn Operations
POST
Create IP Sec VPNDPD Profile
POST
Create IP Sec VPNIKE Profile
POST
Create IP Sec VPN Local Endpoint
POST
Create IP Sec VPN Peer End Point
POST
Create IP Sec VPN Service
POST
Create IP Sec VPN Session
POST
Create IP Sec VPN Tunnel Profile
POST
Create L2 Vpn Service
POST
Create L2 Vpn Session
DELETE
Delete IP Sec VPNDPD Profile
DELETE
Delete IP Sec VPNIKE Profile
DELETE
Delete IP Sec VPN Local Endpoint
DELETE
Delete IP Sec VPN Peer Endpoint
DELETE
Delete IP Sec VPN Service
DELETE
Delete IP Sec VPN Session
DELETE
Delete IP Sec VPN Tunnel Profile
DELETE
Delete L2 Vpn Service
DELETE
Delete L2 Vpn Session
GET
Get IP Sec VPNDPD Profile
GET
Get IP Sec VPNIKE Profile
GET
Get IP Sec VPNIKE Service
GET
Get IP Sec VPNIKE Session Status
GET
Get IP Sec VPN Local Endpoint
GET
Get IP Sec VPN Peer Endpoint
GET
Get IP Sec VPN Peer Endpoint With PSK Show Sensitive Data
GET
Get IP Sec VPN Service
GET
Get IP Sec VPN Session
GET
Get IP Sec VPN Session Statistics
GET
Get IP Sec VPN Session Summary
GET
Get IP Sec VPN Tunnel Profile
GET
Get L2 Vpn Service
GET
Get L2 Vpn Session
GET
Get L2 Vpn Session Peer Codes
GET
Get L2VPN Session Remote Macs For LS
GET
Get L2VPN Session Statistics
GET
Get L2VPN Session Status
GET
Get L2VPN Session Summary
GET
Get Peer Config
GET
List IP Sec VPNDPD Profiles
GET
List IP Sec VPNIKE Profiles
GET
List IP Sec VPN Local Endpoints
GET
List IP Sec VPN Peer Endpoints
GET
List IP Sec VPN Services
GET
List IP Sec VPN Sessions
GET
List IP Sec VPN Tunnel Profiles
GET
List L2 Vpn Services
GET
List L2 Vpn Sessions
POST
Reset IP Sec VPN Session Statistics Reset
PUT
Update IP Sec VPNDPD Profile
PUT
Update IP Sec VPNIKE Profile
PUT
Update IP Sec VPN Local Endpoint
PUT
Update IP Sec VPN Peer Endpoint
PUT
Update IP Sec VPN Service
PUT
Update IP Sec VPN Session
PUT
Update IP Sec VPN Tunnel Profile
PUT
Update L2 Vpn Service
PUT
Update L2 Vpn Session