Skip to content


Configuration for Af report for VPN Gateway resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
gateway_name<String>Read-writeName of Gateway.
Minimum length = 1
Maximum length = 128
gateway_ipaddress<String>Read-writeGateway IPAddress.
Minimum length = 1
Maximum length = 128
gateway_fqdn<String>Read-writeFQDN of Gateway.
Minimum length = 1
Maximum length = 128
total_bytes<Double>Read-writeTotal bytes in sampled timeframe used by all users..
rpt_sample_time<Double>Read-writeReport Sample time..
device_ip_address<String>Read-writeDevice IP Address..
Minimum length = 1
Maximum length = 64
bandwidth<Double>Read-writeAvg Bandwidth..
Minimum length = 1
Maximum length = 64
session_count<Double>Read-writeNumber of sessions launched by user.
active_session<Double>Read-writeNumber of active sessions launched by user.


(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:


    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:



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



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":[{