Skip to content
Was this article helpful?

vpn_error_details

Configuration for Af report for VPN Error details resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
error_count <Double> Read-write Error Code.
policy_name <String> Read-write EPA Policy Name.

Maximum length = 1024
__count <Double> Read-write count..
cs_vserver_name <String> Read-write CS Server Name..

Maximum length = 128
error_description <String> Read-write STA Validation Failure Counts..

Maximum length = 1024
sso_method_type <String> Read-write SSO Method Type.

Minimum length = 1

Maximum length = 64
flag <Double> Read-write Flag.
ad_server_ip_address <String> Read-write Active Directory Server IP Address.

Maximum length = 32
ica_device_ip_address <String> Read-write ICA Device IP Address..

Minimum length = 1

Maximum length = 64
next_factor_policy_label <String> Read-write next factor policy label.

Maximum length = 255
id <String> Read-write Id is not dicided yet.

Minimum length = 1

Maximum length = 64
vpn_server_name <String> Read-write VPN Server Name..

Maximum length = 128
authentication_state <String> Read-write Authentication State.

Maximum length = 128
auth_type <String> Read-write Authentication Type.

Maximum length = 128
server_ip_address <String> Read-write Server IP Address..

Minimum length = 1

Maximum length = 64
sta_ip <String> Read-write STA Server IP..

Maximum length = 128
username <String> Read-write User Name.

Maximum length = 128
error_code <Double> Read-write Error Code.
error_time <Double> Read-write Flag.
vpn_fqdn <String> Read-write VPN FQDN.

Maximum length = 128
resource_name <String> Read-write Resource Name.

Maximum length = 128
req_url <String> Read-write req_url.

Maximum length = 255
current_factor_policy_label <String> Read-write current factor policy label.

Maximum length = 255
epa_expression <String> Read-write EPA Expression.

Maximum length = 255

Operations

(click to see Properties )

  • GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/vpn_error_details

Query-parameters:

cr_enabled Use this query-parameter to indicate cr is enabled or not.

Possible Values: 0, 1

report_start_time Use this query-parameter to specify the start time from which the summary for report is considered.

Possible Values: time in milli seconds

report_end_time Use this query-parameter to specify the end time until where summary for report is considered.

Possible Values: time in milli seconds

sla_enabled Use this query-parameter to indicate sla is enabled or not.

Possible Values: 0, 1

HTTPS Method: GET

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "vpn_error_details":[{
      "error_count":<Double_value>,
      "policy_name":<String_value>,
      "__count":<Double_value>,
      "cs_vserver_name":<String_value>,
      "error_description":<String_value>,
      "sso_method_type":<String_value>,
      "flag":<Double_value>,
      "ad_server_ip_address":<String_value>,
      "ica_device_ip_address":<String_value>,
      "next_factor_policy_label":<String_value>,
      "id":<String_value>,
      "vpn_server_name":<String_value>,
      "authentication_state":<String_value>,
      "auth_type":<String_value>,
      "server_ip_address":<String_value>,
      "epa_method_type":<String_value>,
      "sta_ip":<String_value>,
      "username":<String_value>,
      "error_code":<Double_value>,
      "error_time":<Double_value>,
      "client_ip_address":<String_value>,
      "vpn_fqdn":<String_value>,
      "resource_name":<String_value>,
      "req_url":<String_value>,
      "current_factor_policy_label":<String_value>,
      "epa_expression":<String_value>}]}
Was this article helpful?