Get Tier0IP Sec Vpn Session Status

• Tier 0s
• Locale Services Ipsec Vpn

• 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-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status

COPY

Path Parameters

string

tier-0-id

Required

tier-0-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.

BasicAuth

Responses

200

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Tier 0s Operations

PATCH

Create Or Patch Tier0IP Sec Vpn Local Endpoint

PATCH

Create Or Patch Tier0IP Sec Vpn Service

PATCH

Create Or Patch Tier0IP Sec Vpn Session

PUT

Create Or Update Tier0IP Sec Vpn Local Endpoint

PUT

Create Or Update Tier0IP Sec Vpn Service

PUT

Create Or Update Tier0IP Sec Vpn Session

DELETE

Delete Tier0IP Sec Vpn Local Endpoint

DELETE

Delete Tier0IP Sec Vpn Service

DELETE

Delete Tier0IP Sec Vpn Session

GET

Get Tier0IP Sec Vpn Local Endpoint

GET

Get Tier0IP Sec Vpn Peer Config

GET

Get Tier0IP Sec Vpn Service

GET

Get Tier0IP Sec Vpn Session

GET

Get Tier0IP Sec Vpn Session Status

GET

Get Tier0IP Sec Vpn Session With Sensitive Data Show Sensitive Data

GET

List Tier0IP Sec Vpn Local Endpoints

GET

List Tier0IP Sec Vpn Services

GET

List Tier0IP Sec Vpn Sessions