Get Tier1IP Sec Vpn Session Status

Get Tier1IP Sec Vpn Session Status
  • no enforcement point path specified: detailed status is evaluated on each enforcement point.
  • an enforcement point path is specified: detailed status is evaluated only on the given enforcement point.
  • source=realtime: detailed status is fetched realtime from the enforcement point.
  • source=cached: cached detailed status from enforcement point is returned.
Request
URI
GET
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
COPY
Path Parameters
string
tier-1-id
Required

tier-1-id

string
locale-service-id
Required

locale-service-id

string
service-id
Required

service-id

string
session-id
Required

session-id

Query Parameters
string
enforcement_point_path
Optional

String Path of the enforcement point

string
source
Optional

Data source type.

Possible values are : realtime, cached,
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AggregateIPSecVpnSessionStatus of type(s) application/json
This response body class contains all of the following: AggregatePolicyRuntimeInfo , InlineAggregateIPSecVpnSessionStatus1 
{
    "intent_path": "string",
    "results": [
        {
            "alarm": {
                "error_details": {
                    "related_errors": [
                        {
                            "details": "string",
                            "error_code": 0,
                            "error_message": "string",
                            "module_name": "string"
                        }
                    ]
                },
                "error_id": "string",
                "message": "string"
            },
            "enforcement_point_path": "string",
            "resource_type": "string"
        }
    ]
}

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

On This Page
Tier 1s Operations
PUT
Create Or Replace Tier1 Interface
PUT
Create Or Replace Tier1 Locale Services
PUT
Create Tier1 Policy Service Instance
DELETE
Delete Tier1 Interface
DELETE
Delete Tier1 Locale Services
DELETE
Delete Tier1 Locale Services Flood Protection Profile Binding
DELETE
Delete Tier1 Locale Services Session Timer Profile Binding
DELETE
Delete Tier1 Policy Service Instance
GET
Get Tier1 Interface Statistics
GET
Get Tier1IP Sec Vpn Session Statistics
GET
Get Tier1IP Sec Vpn Session Status
GET
Get Tier1 Locale Services Flood Protection Profile Binding
GET
Get Tier1 Locale Services Session Timer Profile Binding
GET
Get Tier1 Policy Service Instance Statistics
GET
List Tier1 Locale Services
PATCH
Patch Tier1 Interface
PATCH
Patch Tier1 Locale Services
PATCH
Patch Tier1 Locale Services Flood Protection Profile Binding Map
PATCH
Patch Tier1 Locale Services Session Timer Profile Binding Map
PATCH
Patch Tier1 Policy Service Instance
GET
Read All Policy Service Instances For Tier1
GET
Read Tier1 Interface
GET
Read Tier1 Locale Services
GET
Read Tier1 Policy Service Instance
PUT
Update Tier1 Locale Services Flood Protection Profile Binding
PUT
Update Tier1 Locale Services Session Timer Profile Binding
GET
View Tier1 Locale Services Gateway Firewall