vpn_active_sessions
Configuration for Af report for VPN Session resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| up_time | <Double> | Read-write | Session Up Time. |
| session_type | <String> | Read-write | Session type. Maximum length = 128 |
| vpn_user_name | <String> | Read-write | Name of VPN Uer. Minimum length = 1 Maximum length = 128 |
| __count | <Double> | Read-write | count.. |
| total_bytes | <Double> | Read-write | Total Bytes. |
| rpt_sample_time | <Double> | Read-write | Report Sample time.. |
| state | <String> | Read-write | State (Active/Idle/Terminated). Minimum length = 1 Maximum length = 128 |
| bandwidth | <Double> | Read-write | Avg Bandwidth.. |
| session_setup_time | <Double> | Read-write | vpn session start time. |
| client_ip | <String> | Read-write | Client IP Address.. Maximum length = 64 |
| 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_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)
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>.
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/vpn_active_sessions
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "vpn_active_sessions":[{
"up_time":<Double_value>,
"session_type":<String_value>,
"vpn_user_name":<String_value>,
"__count":<Double_value>,
"total_bytes":<Double_value>,
"rpt_sample_time":<Double_value>,
"state":<String_value>,
"device_ip_address":<String_value>,
"bandwidth":<Double_value>,
"session_setup_time":<Double_value>,
"client_ip":<String_value>,
"id":<String_value>,
"os_type":<String_value>,
"session_end_time":<Double_value>,
"server_ip":<String_value>}]}