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.

BasicAuth

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

Request

Path Parameters

Query Parameters

200 Response Body

Errors

Tier 1s Operations

Create Or Replace Tier1 Interface

Create Or Replace Tier1 Locale Services

Create Tier1 Policy Service Instance

Delete Tier1 Interface

Delete Tier1 Locale Services

Delete Tier1 Locale Services Flood Protection Profile Binding

Delete Tier1 Locale Services Session Timer Profile Binding

Delete Tier1 Policy Service Instance

Get Tier1 Interface Statistics

Get Tier1IP Sec Vpn Session Statistics

Get Tier1IP Sec Vpn Session Status

Get Tier1 Locale Services Flood Protection Profile Binding

Get Tier1 Locale Services Session Timer Profile Binding

Get Tier1 Policy Service Instance Statistics

List Tier1 Locale Services

Patch Tier1 Interface

Patch Tier1 Locale Services

Patch Tier1 Locale Services Flood Protection Profile Binding Map

Patch Tier1 Locale Services Session Timer Profile Binding Map

Patch Tier1 Policy Service Instance

Read All Policy Service Instances For Tier1

Read Tier1 Interface

Read Tier1 Locale Services

Read Tier1 Policy Service Instance

Update Tier1 Locale Services Flood Protection Profile Binding

Update Tier1 Locale Services Session Timer Profile Binding

View Tier1 Locale Services Gateway Firewall