Product Documentation

vpnsessionaction

Sep 08, 2016

Configuration for VPN session action resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the NetScaler Gateway profile (action). Must begin with an ASCII alphabetic or underscore (_) character, and must consist only of ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the profile is created.

The following requirement applies only to the NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').
Minimum length = 1
useraccounting
<String>
Read-write
The name of the radiusPolicy to use for RADIUS user accounting info on the session.
httpport
<Integer[]>
Read-write
Destination port numbers other than port 80, added as a comma-separated list. Traffic to these ports is processed as HTTP traffic, which allows functionality, such as HTTP authorization and single sign-on to a web application to work.
Minimum value = 1
winsip
<String>
Read-write
WINS server IP address to add to NetScaler Gateway for name resolution.
dnsvservername
<String>
Read-write
Name of the DNS virtual server for the user session.
Minimum length = 1
splitdns
<String>
Read-write
Route the DNS requests to the local DNS server configured on the user device, or NetScaler Gateway (remote), or both.
Possible values = LOCAL, REMOTE, BOTH
sesstimeout
<Double>
Read-write
Number of minutes after which the session times out.
Minimum value = 1
clientsecurity
<String>
Read-write
Specify the client security check for the user device to permit a NetScaler Gateway session. The web address or IP address is not included in the expression for the client security check.
clientsecuritygroup
<String>
Read-write
The client security group that will be assigned on failure of the client security check. Users can in general be organized into Groups. In this case, the Client Security Group may have a more restrictive security policy.
Minimum length = 1
clientsecuritymessage
<String>
Read-write
The client security message that will be displayed on failure of the client security check.
Minimum length = 1
Maximum length = 127
clientsecuritylog
<String>
Read-write
Set the logging of client security checks.
Possible values = ON, OFF
splittunnel
<String>
Read-write
Send, through the tunnel, traffic only for intranet applications that are defined in NetScaler Gateway. Route all other traffic directly to the Internet. The OFF setting routes all traffic through NetScaler Gateway. With the REVERSE setting, intranet applications define the network traffic that is not intercepted. All network traffic directed to internal IP addresses bypasses the VPN tunnel, while other traffic goes through NetScaler Gateway. Reverse split tunneling can be used to log all non-local LAN traffic. For example, if users have a home network and are logged on through the NetScaler Gateway Plug-in, network traffic destined to a printer or another device within the home network is not intercepted.
Possible values = ON, OFF, REVERSE
locallanaccess
<String>
Read-write
Set local LAN access. If split tunneling is OFF, and you set local LAN access to ON, the local client can route traffic to its local interface. When the local area network switch is specified, this combination of switches is useful. The client can allow local LAN access to devices that commonly have non-routable addresses, such as local printers or local file servers.
Possible values = ON, OFF
rfc1918
<String>
Read-write
As defined in the local area network, allow only the following local area network addresses to bypass the VPN tunnel when the local LAN access feature is enabled:
* 10.*.*.*,
* 172.16.*.*,
* 192.168.*.*.
Possible values = ON, OFF
spoofiip
<String>
Read-write
IP address that the intranet application uses to route the connection through the virtual adapter.
Possible values = ON, OFF
killconnections
<String>
Read-write
Specify whether the NetScaler Gateway Plug-in should disconnect all preexisting connections, such as the connections existing before the user logged on to NetScaler Gateway, and prevent new incoming connections on the NetScaler Gateway Plug-in for Windows and MAC when the user is connected to NetScaler Gateway and split tunneling is disabled.
Possible values = ON, OFF
transparentinterception
<String>
Read-write
Allow access to network resources by using a single IP address and subnet mask or a range of IP addresses. The OFF setting sets the mode to proxy, in which you configure destination and source IP addresses and port numbers. If you are using the NetScaler Gateway Plug-in for Windows, set this parameter to ON, in which the mode is set to transparent. If you are using the NetScaler Gateway Plug-in for Java, set this parameter to OFF.
Possible values = ON, OFF
windowsclienttype
<String>
Read-write
Choose between two types of Windows Client\
a) Application Agent - which always runs in the task bar as a standalone application and also has a supporting service which runs permanently when installed\
b) Activex Control - ActiveX control run by Microsoft Internet Explorer.
Possible values = AGENT, PLUGIN
defaultauthorizationaction
<String>
Read-write
Specify the network resources that users have access to when they log on to the internal network. The default setting for authorization is to deny access to all network resources. Citrix recommends using the default global setting and then creating authorization policies to define the network resources users can access. If you set the default authorization policy to DENY, you must explicitly authorize access to any network resource, which improves security.
Possible values = ALLOW, DENY
authorizationgroup
<String>
Read-write
Comma-separated list of groups in which the user is placed when none of the groups that the user is a part of is configured on NetScaler Gateway. The authorization policy can be bound to these groups to control access to the resources.
Minimum length = 1
smartgroup
<String>
Read-write
This is the default group that is chosen when the authentication succeeds in addition to extracted groups.
Minimum length = 1
Maximum length = 64
clientidletimeout
<Double>
Read-write
Time, in minutes, after which to time out the user session if NetScaler Gateway does not detect mouse or keyboard activity.
Minimum value = 1
Maximum value = 9999
proxy
<String>
Read-write
Set options to apply proxy for accessing the internal resources. Available settings function as follows:
* BROWSER - Proxy settings are configured only in Internet Explorer and Firefox browsers.
* NS - Proxy settings are configured on the NetScaler appliance.
* OFF - Proxy settings are not configured.
Possible values = BROWSER, NS, OFF
allprotocolproxy
<String>
Read-write
IP address of the proxy server to use for all protocols supported by NetScaler Gateway.
Minimum length = 1
httpproxy
<String>
Read-write
IP address of the proxy server to be used for HTTP access for all subsequent connections to the internal network.
Minimum length = 1
ftpproxy
<String>
Read-write
IP address of the proxy server to be used for FTP access for all subsequent connections to the internal network.
Minimum length = 1
socksproxy
<String>
Read-write
IP address of the proxy server to be used for SOCKS access for all subsequent connections to the internal network.
Minimum length = 1
gopherproxy
<String>
Read-write
IP address of the proxy server to be used for GOPHER access for all subsequent connections to the internal network.
Minimum length = 1
sslproxy
<String>
Read-write
IP address of the proxy server to be used for SSL access for all subsequent connections to the internal network.
Minimum length = 1
proxyexception
<String>
Read-write
Proxy exception string that will be configured in the browser for bypassing the previously configured proxies. Allowed only if proxy type is Browser.
Minimum length = 1
proxylocalbypass
<String>
Read-write
Bypass proxy server for local addresses option in Internet Explorer and Firefox proxy server settings.
Possible values = ENABLED, DISABLED
clientcleanupprompt
<String>
Read-write
Prompt for client-side cache clean-up when a client-initiated session closes.
Possible values = ON, OFF
forcecleanup
<String[]>
Read-write
Force cache clean-up when the user closes a session. You can specify all, none, or any combination of the client-side items.
Possible values = none, all, cookie, addressbar, plugin, filesystemapplication, application, applicationdata, clientcertificate, autocomplete, cache
clientoptions
<String>
Read-write
Display only the configured menu options when you select the "Configure NetScaler Gateway" option in the NetScaler Gateway Plug-in system tray icon for Windows.
Possible values = none, all, services, filetransfer, configuration
clientconfiguration
<String[]>
Read-write
Allow users to change client Debug logging level in Configuration tab of the NetScaler Gateway Plug-in for Windows.
Possible values = none, trace
sso
<String>
Read-write
Set single sign-on (SSO) for the session. When the user accesses a server, the user's logon credentials are passed to the server for authentication.
Possible values = ON, OFF
ssocredential
<String>
Read-write
Specify whether to use the primary or secondary authentication credentials for single sign-on to the server.
Possible values = PRIMARY, SECONDARY
windowsautologon
<String>
Read-write
Enable or disable the Windows Auto Logon for the session. If a VPN session is established after this setting is enabled, the user is automatically logged on by using Windows credentials after the system is restarted.
Possible values = ON, OFF
usemip
<String>
Read-write
Enable or disable the use of a unique IP address alias, or a mapped IP address, as the client IP address for each client session. Allow NetScaler Gateway to use the mapped IP address as an intranet IP address when all other IP addresses are not available.
When IP pooling is configured and the mapped IP is used as an intranet IP address, the mapped IP address is used when an intranet IP address cannot be assigned.
Possible values = NS, OFF
useiip
<String>
Read-write
Define IP address pool options. Available settings function as follows:
* SPILLOVER - When an address pool is configured and the mapped IP is used as an intranet IP address, the mapped IP address is used when an intranet IP address cannot be assigned.
* NOSPILLOVER - When intranet IP addresses are enabled and the mapped IP address is not used, the Transfer Login page appears for users who have used all available intranet IP addresses.
* OFF - Address pool is not configured.
Possible values = NOSPILLOVER, SPILLOVER, OFF
clientdebug
<String>
Read-write
Set the trace level on NetScaler Gateway. Technical support technicians use these debug logs for in-depth debugging and troubleshooting purposes. Available settings function as follows:
* DEBUG - Detailed debug messages are collected and written into the specified file.
* STATS - Application audit level error messages and debug statistic counters are written into the specified file.
* EVENTS - Application audit-level error messages are written into the specified file.
* OFF - Only critical events are logged into the Windows Application Log.
Possible values = debug, stats, events, OFF
loginscript
<String>
Read-write
Path to the logon script that is run when a session is established. Separate multiple scripts by using comma. A "$" in the path signifies that the word following the "$" is an environment variable.
Minimum length = 1
logoutscript
<String>
Read-write
Path to the logout script. Separate multiple scripts by using comma. A "$" in the path signifies that the word following the "$" is an environment variable.
Minimum length = 1
homepage
<String>
Read-write
Web address of the home page that appears when users log on. Otherwise, users receive the default home page for NetScaler Gateway, which is the Access Interface.
icaproxy
<String>
Read-write
Enable ICA proxy to configure secure Internet access to servers running Citrix XenApp or XenDesktop by using Citrix Receiver instead of the NetScaler Gateway Plug-in.
Possible values = ON, OFF
wihome
<String>
Read-write
Web address of the Web Interface server, such as http://<ipAddress>/Citrix/XenApp, or Receiver for Web, which enumerates the virtualized resources, such as XenApp, XenDesktop, and cloud applications. This web address is used as the home page in ICA proxy mode.
If Client Choices is ON, you must configure this setting. Because the user can choose between FullClient and ICAProxy, the user may see a different home page. An Internet web site may appear if the user gets the FullClient option, or a Web Interface site if the user gets the ICAProxy option. If the setting is not configured, the XenApp option does not appear as a client choice.
wihomeaddresstype
<String>
Read-write
Type of the wihome address(IPV4/V6).
Possible values = IPV4, IPV6
citrixreceiverhome
<String>
Read-write
Web address for the Citrix Receiver home page. Configure NetScaler Gateway so that when users log on to the appliance, the NetScaler Gateway Plug-in opens a web browser that allows single sign-on to the Citrix Receiver home page.
wiportalmode
<String>
Read-write
Layout on the Access Interface. The COMPACT value indicates the use of small icons.
Possible values = NORMAL, COMPACT
clientchoices
<String>
Read-write
Provide users with multiple logon options. With client choices, users have the option of logging on by using the NetScaler Gateway Plug-in for Windows, NetScaler Gateway Plug-in for Java, the Web Interface, or clientless access from one location. Depending on how NetScaler Gateway is configured, users are presented with up to three icons for logon choices. The most common are the NetScaler Gateway Plug-in for Windows, Web Interface, and clientless access.
Possible values = ON, OFF
epaclienttype
<String>
Read-write
Choose between two types of End point Windows Client
a) Application Agent - which always runs in the task bar as a standalone application and also has a supporting service which runs permanently when installed
b) Activex Control - ActiveX control run by Microsoft Internet Explorer.
Possible values = AGENT, PLUGIN
iipdnssuffix
<String>
Read-write
An intranet IP DNS suffix. When a user logs on to NetScaler Gateway and is assigned an IP address, a DNS record for the user name and IP address combination is added to the NetScaler Gateway DNS cache. You can configure a DNS suffix to append to the user name when the DNS record is added to the cache. You can reach to the host from where the user is logged on by using the user's name, which can be easier to remember than an IP address. When the user logs off from NetScaler Gateway, the record is removed from the DNS cache.
Minimum length = 1
forcedtimeout
<Double>
Read-write
Force a disconnection from the NetScaler Gateway Plug-in with NetScaler Gateway after a specified number of minutes. If the session closes, the user must log on again.
Minimum value = 1
Maximum value = 65535
forcedtimeoutwarning
<Double>
Read-write
Number of minutes to warn a user before the user session is disconnected.
Minimum value = 1
Maximum value = 255
ntdomain
<String>
Read-write
Single sign-on domain to use for single sign-on to applications in the internal network. This setting can be overwritten by the domain that users specify at the time of logon or by the domain that the authentication server returns.
Minimum length = 1
Maximum length = 32
clientlessvpnmode
<String>
Read-write
Enable clientless access for web, XenApp or XenDesktop, and FileShare resources without installing the NetScaler Gateway Plug-in. Available settings function as follows:
* ON - Allow only clientless access.
* OFF - Allow clientless access after users log on with the NetScaler Gateway Plug-in.
* DISABLED - Do not allow clientless access.
Possible values = ON, OFF, DISABLED
emailhome
<String>
Read-write
Web address for the web-based email, such as Outlook Web Access.
clientlessmodeurlencoding
<String>
Read-write
When clientless access is enabled, you can choose to encode the addresses of internal web applications or to leave the address as clear text. Available settings function as follows:
* OPAQUE - Use standard encoding mechanisms to make the domain and protocol part of the resource unclear to users.
* CLEAR - Do not encode the web address and make it visible to users.
* ENCRYPT - Allow the domain and protocol to be encrypted using a session key. When the web address is encrypted, the URL is different for each user session for the same web resource. If users bookmark the encoded web address, save it in the web browser and then log off, they cannot connect to the web address when they log on and use the bookmark. If users save the encrypted bookmark in the Access Interface during their session, the bookmark works each time the user logs on.
Possible values = TRANSPARENT, OPAQUE, ENCRYPT
clientlesspersistentcookie
<String>
Read-write
State of persistent cookies in clientless access mode. Persistent cookies are required for accessing certain features of SharePoint, such as opening and editing Microsoft Word, Excel, and PowerPoint documents hosted on the SharePoint server. A persistent cookie remains on the user device and is sent with each HTTP request. NetScaler Gateway encrypts the persistent cookie before sending it to the plug-in on the user device, and refreshes the cookie periodically as long as the session exists. The cookie becomes stale if the session ends. Available settings function as follows:
* ALLOW - Enable persistent cookies. Users can open and edit Microsoft documents stored in SharePoint.
* DENY - Disable persistent cookies. Users cannot open and edit Microsoft documents stored in SharePoint.
* PROMPT - Prompt users to allow or deny persistent cookies during the session. Persistent cookies are not required for clientless access if users do not connect to SharePoint.
Possible values = ALLOW, DENY, PROMPT
allowedlogingroups
<String>
Read-write
Specify groups that have permission to log on to NetScaler Gateway. Users who do not belong to this group or groups are denied access even if they have valid credentials.
Minimum length = 1
Maximum length = 511
securebrowse
<String>
Read-write
Allow users to connect through NetScaler Gateway to network resources from iOS and Android mobile devices with Citrix Receiver. Users do not need to establish a full VPN tunnel to access resources in the secure network.
Possible values = ENABLED, DISABLED
storefronturl
<String>
Read-write
Web address for StoreFront to be used in this session for enumeration of resources from XenApp or XenDesktop.
Minimum length = 1
Maximum length = 255
sfgatewayauthtype
<String>
Read-write
The authentication type configured for the NetScaler Gateway on StoreFront.
Possible values = domain, RSA, domainAndRSA, SMS, smartCard
kcdaccount
<String>
Read-write
The kcd account details to be used in SSO.
Minimum length = 1
Maximum length = 32
rdpclientprofilename
<String>
Read-write
Name of the RDP profile associated with the vserver.
Minimum length = 1
Maximum length = 31
windowspluginupgrade
<String>
Read-write
Option to set plugin upgrade behaviour for Win.
Possible values = Always, Essential, Never
macpluginupgrade
<String>
Read-write
Option to set plugin upgrade behaviour for Mac.
Possible values = Always, Essential, Never
linuxpluginupgrade
<String>
Read-write
Option to set plugin upgrade behaviour for Linux.
Possible values = Always, Essential, Never
iconwithreceiver
<String>
Read-write
Option to decide whether to show plugin icon along with receiver.
Possible values = ON, OFF
alwaysonprofilename
<String>
Read-write
Name of the AlwaysON profile associated with the session action. The builtin profile named none can be used to explicitly disable AlwaysON for the session action.
Minimum length = 1
Maximum length = 31
clientidletimeoutwarning
<Double>
Read-only
The time after which the client gets a timeout warning, in minutes.
builtin
<String[]>
Read-only
Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
__count
<Double>
Read-only
count parameter

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"vpnsessionaction":{
      "name":<String_value>,
      "useraccounting":<String_value>,
      "httpport":<Integer[]_value>,
      "winsip":<String_value>,
      "dnsvservername":<String_value>,
      "splitdns":<String_value>,
      "sesstimeout":<Double_value>,
      "clientsecurity":<String_value>,
      "clientsecuritygroup":<String_value>,
      "clientsecuritymessage":<String_value>,
      "clientsecuritylog":<String_value>,
      "splittunnel":<String_value>,
      "locallanaccess":<String_value>,
      "rfc1918":<String_value>,
      "spoofiip":<String_value>,
      "killconnections":<String_value>,
      "transparentinterception":<String_value>,
      "windowsclienttype":<String_value>,
      "defaultauthorizationaction":<String_value>,
      "authorizationgroup":<String_value>,
      "smartgroup":<String_value>,
      "clientidletimeout":<Double_value>,
      "proxy":<String_value>,
      "allprotocolproxy":<String_value>,
      "httpproxy":<String_value>,
      "ftpproxy":<String_value>,
      "socksproxy":<String_value>,
      "gopherproxy":<String_value>,
      "sslproxy":<String_value>,
      "proxyexception":<String_value>,
      "proxylocalbypass":<String_value>,
      "clientcleanupprompt":<String_value>,
      "forcecleanup":<String[]_value>,
      "clientoptions":<String_value>,
      "clientconfiguration":<String[]_value>,
      "sso":<String_value>,
      "ssocredential":<String_value>,
      "windowsautologon":<String_value>,
      "usemip":<String_value>,
      "useiip":<String_value>,
      "clientdebug":<String_value>,
      "loginscript":<String_value>,
      "logoutscript":<String_value>,
      "homepage":<String_value>,
      "icaproxy":<String_value>,
      "wihome":<String_value>,
      "wihomeaddresstype":<String_value>,
      "citrixreceiverhome":<String_value>,
      "wiportalmode":<String_value>,
      "clientchoices":<String_value>,
      "epaclienttype":<String_value>,
      "iipdnssuffix":<String_value>,
      "forcedtimeout":<Double_value>,
      "forcedtimeoutwarning":<Double_value>,
      "ntdomain":<String_value>,
      "clientlessvpnmode":<String_value>,
      "emailhome":<String_value>,
      "clientlessmodeurlencoding":<String_value>,
      "clientlesspersistentcookie":<String_value>,
      "allowedlogingroups":<String_value>,
      "securebrowse":<String_value>,
      "storefronturl":<String_value>,
      "sfgatewayauthtype":<String_value>,
      "kcdaccount":<String_value>,
      "rdpclientprofilename":<String_value>,
      "windowspluginupgrade":<String_value>,
      "macpluginupgrade":<String_value>,
      "linuxpluginupgrade":<String_value>,
      "iconwithreceiver":<String_value>,
      "alwaysonprofilename":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction/name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

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

update

URL: http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"vpnsessionaction":{
      "name":<String_value>,
      "useraccounting":<String_value>,
      "httpport":<Integer[]_value>,
      "winsip":<String_value>,
      "dnsvservername":<String_value>,
      "splitdns":<String_value>,
      "sesstimeout":<Double_value>,
      "clientsecurity":<String_value>,
      "clientsecuritygroup":<String_value>,
      "clientsecuritymessage":<String_value>,
      "clientsecuritylog":<String_value>,
      "splittunnel":<String_value>,
      "locallanaccess":<String_value>,
      "rfc1918":<String_value>,
      "spoofiip":<String_value>,
      "killconnections":<String_value>,
      "transparentinterception":<String_value>,
      "windowsclienttype":<String_value>,
      "defaultauthorizationaction":<String_value>,
      "authorizationgroup":<String_value>,
      "smartgroup":<String_value>,
      "clientidletimeout":<Double_value>,
      "proxy":<String_value>,
      "allprotocolproxy":<String_value>,
      "httpproxy":<String_value>,
      "ftpproxy":<String_value>,
      "socksproxy":<String_value>,
      "gopherproxy":<String_value>,
      "sslproxy":<String_value>,
      "proxyexception":<String_value>,
      "proxylocalbypass":<String_value>,
      "clientcleanupprompt":<String_value>,
      "forcecleanup":<String[]_value>,
      "clientoptions":<String_value>,
      "clientconfiguration":<String[]_value>,
      "sso":<String_value>,
      "ssocredential":<String_value>,
      "windowsautologon":<String_value>,
      "usemip":<String_value>,
      "useiip":<String_value>,
      "clientdebug":<String_value>,
      "loginscript":<String_value>,
      "logoutscript":<String_value>,
      "homepage":<String_value>,
      "icaproxy":<String_value>,
      "wihome":<String_value>,
      "wihomeaddresstype":<String_value>,
      "citrixreceiverhome":<String_value>,
      "wiportalmode":<String_value>,
      "clientchoices":<String_value>,
      "epaclienttype":<String_value>,
      "iipdnssuffix":<String_value>,
      "forcedtimeout":<Double_value>,
      "forcedtimeoutwarning":<Double_value>,
      "ntdomain":<String_value>,
      "clientlessvpnmode":<String_value>,
      "emailhome":<String_value>,
      "clientlessmodeurlencoding":<String_value>,
      "clientlesspersistentcookie":<String_value>,
      "allowedlogingroups":<String_value>,
      "securebrowse":<String_value>,
      "storefronturl":<String_value>,
      "sfgatewayauthtype":<String_value>,
      "kcdaccount":<String_value>,
      "rdpclientprofilename":<String_value>,
      "windowspluginupgrade":<String_value>,
      "macpluginupgrade":<String_value>,
      "linuxpluginupgrade":<String_value>,
      "iconwithreceiver":<String_value>,
      "alwaysonprofilename":<String_value>
}}

Response:

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

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"vpnsessionaction":{
      "name":<String_value>,
      "useraccounting":true,
      "httpport":true,
      "winsip":true,
      "dnsvservername":true,
      "splitdns":true,
      "sesstimeout":true,
      "clientsecurity":true,
      "clientsecuritygroup":true,
      "clientsecuritymessage":true,
      "clientsecuritylog":true,
      "splittunnel":true,
      "locallanaccess":true,
      "rfc1918":true,
      "spoofiip":true,
      "killconnections":true,
      "transparentinterception":true,
      "windowsclienttype":true,
      "defaultauthorizationaction":true,
      "authorizationgroup":true,
      "smartgroup":true,
      "clientidletimeout":true,
      "proxy":true,
      "allprotocolproxy":true,
      "httpproxy":true,
      "ftpproxy":true,
      "socksproxy":true,
      "gopherproxy":true,
      "sslproxy":true,
      "proxyexception":true,
      "proxylocalbypass":true,
      "clientcleanupprompt":true,
      "forcecleanup":true,
      "clientoptions":true,
      "clientconfiguration":true,
      "sso":true,
      "ssocredential":true,
      "windowsautologon":true,
      "usemip":true,
      "useiip":true,
      "clientdebug":true,
      "loginscript":true,
      "logoutscript":true,
      "homepage":true,
      "icaproxy":true,
      "wihome":true,
      "citrixreceiverhome":true,
      "wiportalmode":true,
      "clientchoices":true,
      "epaclienttype":true,
      "iipdnssuffix":true,
      "forcedtimeout":true,
      "forcedtimeoutwarning":true,
      "ntdomain":true,
      "clientlessvpnmode":true,
      "emailhome":true,
      "clientlessmodeurlencoding":true,
      "clientlesspersistentcookie":true,
      "allowedlogingroups":true,
      "securebrowse":true,
      "storefronturl":true,
      "sfgatewayauthtype":true,
      "kcdaccount":true,
      "rdpclientprofilename":true,
      "windowspluginupgrade":true,
      "macpluginupgrade":true,
      "linuxpluginupgrade":true,
      "iconwithreceiver":true,
      "alwaysonprofilename":true
}}

Response:

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

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of vpnsessionaction resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction?pagesize=#no&pageno=#no

Use this query-parameter to get the vpnsessionaction resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "vpnsessionaction": [ {
      "name":<String_value>,
      "useraccounting":<String_value>,
      "httpport":<Integer[]_value>,
      "winsip":<String_value>,
      "dnsvservername":<String_value>,
      "splitdns":<String_value>,
      "sesstimeout":<Double_value>,
      "clientsecurity":<String_value>,
      "clientsecuritygroup":<String_value>,
      "clientsecuritymessage":<String_value>,
      "clientsecuritylog":<String_value>,
      "splittunnel":<String_value>,
      "locallanaccess":<String_value>,
      "rfc1918":<String_value>,
      "spoofiip":<String_value>,
      "killconnections":<String_value>,
      "transparentinterception":<String_value>,
      "windowsclienttype":<String_value>,
      "defaultauthorizationaction":<String_value>,
      "authorizationgroup":<String_value>,
      "smartgroup":<String_value>,
      "clientidletimeout":<Double_value>,
      "clientidletimeoutwarning":<Double_value>,
      "proxy":<String_value>,
      "allprotocolproxy":<String_value>,
      "httpproxy":<String_value>,
      "ftpproxy":<String_value>,
      "socksproxy":<String_value>,
      "gopherproxy":<String_value>,
      "sslproxy":<String_value>,
      "proxyexception":<String_value>,
      "proxylocalbypass":<String_value>,
      "clientcleanupprompt":<String_value>,
      "forcecleanup":<String[]_value>,
      "clientoptions":<String_value>,
      "clientconfiguration":<String[]_value>,
      "sso":<String_value>,
      "ssocredential":<String_value>,
      "windowsautologon":<String_value>,
      "usemip":<String_value>,
      "useiip":<String_value>,
      "clientdebug":<String_value>,
      "loginscript":<String_value>,
      "logoutscript":<String_value>,
      "homepage":<String_value>,
      "icaproxy":<String_value>,
      "wihome":<String_value>,
      "wihomeaddresstype":<String_value>,
      "citrixreceiverhome":<String_value>,
      "wiportalmode":<String_value>,
      "clientchoices":<String_value>,
      "epaclienttype":<String_value>,
      "iipdnssuffix":<String_value>,
      "forcedtimeout":<Double_value>,
      "forcedtimeoutwarning":<Double_value>,
      "ntdomain":<String_value>,
      "clientlessvpnmode":<String_value>,
      "clientlessmodeurlencoding":<String_value>,
      "clientlesspersistentcookie":<String_value>,
      "emailhome":<String_value>,
      "allowedlogingroups":<String_value>,
      "securebrowse":<String_value>,
      "storefronturl":<String_value>,
      "sfgatewayauthtype":<String_value>,
      "kcdaccount":<String_value>,
      "rdpclientprofilename":<String_value>,
      "builtin":<String[]_value>,
      "windowspluginupgrade":<String_value>,
      "macpluginupgrade":<String_value>,
      "linuxpluginupgrade":<String_value>,
      "iconwithreceiver":<String_value>,
      "alwaysonprofilename":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction/name_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction/name_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction/name_value<String>?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "vpnsessionaction": [ {
      "name":<String_value>,
      "useraccounting":<String_value>,
      "httpport":<Integer[]_value>,
      "winsip":<String_value>,
      "dnsvservername":<String_value>,
      "splitdns":<String_value>,
      "sesstimeout":<Double_value>,
      "clientsecurity":<String_value>,
      "clientsecuritygroup":<String_value>,
      "clientsecuritymessage":<String_value>,
      "clientsecuritylog":<String_value>,
      "splittunnel":<String_value>,
      "locallanaccess":<String_value>,
      "rfc1918":<String_value>,
      "spoofiip":<String_value>,
      "killconnections":<String_value>,
      "transparentinterception":<String_value>,
      "windowsclienttype":<String_value>,
      "defaultauthorizationaction":<String_value>,
      "authorizationgroup":<String_value>,
      "smartgroup":<String_value>,
      "clientidletimeout":<Double_value>,
      "clientidletimeoutwarning":<Double_value>,
      "proxy":<String_value>,
      "allprotocolproxy":<String_value>,
      "httpproxy":<String_value>,
      "ftpproxy":<String_value>,
      "socksproxy":<String_value>,
      "gopherproxy":<String_value>,
      "sslproxy":<String_value>,
      "proxyexception":<String_value>,
      "proxylocalbypass":<String_value>,
      "clientcleanupprompt":<String_value>,
      "forcecleanup":<String[]_value>,
      "clientoptions":<String_value>,
      "clientconfiguration":<String[]_value>,
      "sso":<String_value>,
      "ssocredential":<String_value>,
      "windowsautologon":<String_value>,
      "usemip":<String_value>,
      "useiip":<String_value>,
      "clientdebug":<String_value>,
      "loginscript":<String_value>,
      "logoutscript":<String_value>,
      "homepage":<String_value>,
      "icaproxy":<String_value>,
      "wihome":<String_value>,
      "wihomeaddresstype":<String_value>,
      "citrixreceiverhome":<String_value>,
      "wiportalmode":<String_value>,
      "clientchoices":<String_value>,
      "epaclienttype":<String_value>,
      "iipdnssuffix":<String_value>,
      "forcedtimeout":<Double_value>,
      "forcedtimeoutwarning":<Double_value>,
      "ntdomain":<String_value>,
      "clientlessvpnmode":<String_value>,
      "clientlessmodeurlencoding":<String_value>,
      "clientlesspersistentcookie":<String_value>,
      "emailhome":<String_value>,
      "allowedlogingroups":<String_value>,
      "securebrowse":<String_value>,
      "storefronturl":<String_value>,
      "sfgatewayauthtype":<String_value>,
      "kcdaccount":<String_value>,
      "rdpclientprofilename":<String_value>,
      "builtin":<String[]_value>,
      "windowspluginupgrade":<String_value>,
      "macpluginupgrade":<String_value>,
      "linuxpluginupgrade":<String_value>,
      "iconwithreceiver":<String_value>,
      "alwaysonprofilename":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/vpnsessionaction?count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "vpnsessionaction": [ { "__count": "#no"} ] }