Skip to content
Was this article helpful?

vpn_active_sessions

Configuration for Af report for VPN Session resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
__count <Double> Read-write count..
state <String> Read-write State (Active/Idle/Terminated).

Minimum length = 1

Maximum length = 128
logout_mode <String> Read-write Logout Reason.

Minimum length = 1

Maximum length = 128
id <String> Read-write Id is VPN Session ID.

Minimum length = 1

Maximum length = 64
os_type <String> Read-write OS type.

Maximum length = 128
session_type <String> Read-write Session type.

Maximum length = 128
up_time <Double> Read-write Session Up Time.
gateway_ipaddress <String> Read-write Gateway IPAddress.

Minimum length = 1

Maximum length = 128
vpn_user_name <String> Read-write Name of VPN User.

Minimum length = 1

Maximum length = 128
gateway_fqdn <String> Read-write FQDN of Gateway.

Minimum length = 1

Maximum length = 128
rpt_sample_time <Double> Read-write Report Sample time..
total_bytes <Double> Read-write Total Bytes.
session_setup_time <Double> Read-write vpn session start time.
bandwidth <Double> Read-write Avg Bandwidth..
client_ip <String> Read-write Client IP Address..

Maximum length = 64
session_end_time <Double> Read-write vpn session end time.
server_ip <String> Read-write Server IP Address..

Maximum length = 64

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_active_sessions

Query-parameters:

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

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_active_sessions":[{
      "__count":<Double_value>,
      "state":<String_value>,
      "logout_mode":<String_value>,
      "id":<String_value>,
      "os_type":<String_value>,
      "session_type":<String_value>,
      "up_time":<Double_value>,
      "gateway_ipaddress":<String_value>,
      "vpn_user_name":<String_value>,
      "gateway_fqdn":<String_value>,
      "rpt_sample_time":<Double_value>,
      "total_bytes":<Double_value>,
      "device_ip_address":<String_value>,
      "session_setup_time":<Double_value>,
      "bandwidth":<Double_value>,
      "client_ip":<String_value>,
      "session_end_time":<Double_value>,
      "server_ip":<String_value>}]}
Was this article helpful?