vpn_gateway_info
Configuration for Af report for VPN Gateway resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| gateway_name | <String> | Read-write | Name of Gateway. Minimum length = 1 Maximum length = 128 |
| gateway_ipaddress | <String> | Read-write | Gateway IPAddress. Minimum length = 1 Maximum length = 128 |
| gateway_fqdn | <String> | Read-write | FQDN of Gateway. Minimum length = 1 Maximum length = 128 |
| __count | <Double> | Read-write | count.. |
| total_bytes | <Double> | Read-write | Total bytes in sampled timeframe used by all users.. |
| rpt_sample_time | <Double> | Read-write | Report Sample time.. |
| device_ip_address | <String> | Read-write | Device IP Address.. Minimum length = 1 Maximum length = 64 |
| bandwidth | <Double> | Read-write | Avg Bandwidth.. |
| id | <String> | Read-write | Id. Minimum length = 1 Maximum length = 64 |
| session_count | <Double> | Read-write | Number of sessions launched by user. |
| active_session | <Double> | Read-write | Number of active sessions launched by user. |
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_gateway_info
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "vpn_gateway_info":[{
"gateway_name":<String_value>,
"gateway_ipaddress":<String_value>,
"gateway_fqdn":<String_value>,
"__count":<Double_value>,
"total_bytes":<Double_value>,
"rpt_sample_time":<Double_value>,
"device_ip_address":<String_value>,
"bandwidth":<Double_value>,
"id":<String_value>,
"session_count":<Double_value>,
"active_session":<Double_value>}]}