Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

vpnintranetapplication

August 17, 2023
Contributed by: 
C

Configuration for SSLVPN intranet application resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
intranetapplication Read-write Name of the intranet application.

Minimum length = 1

Maximum length = 31
protocol Read-write Protocol used by the intranet application. If protocol is set to BOTH, TCP and UDP traffic is allowed.

Possible values = TCP, UDP, ANY
destip Read-write Destination IP address, IP range, or host name of the intranet application. This address is the server IP address.

Minimum length = 1
netmask Read-write Destination subnet mask for the intranet application.
iprange Read-write If you have multiple servers in your network, such as web, email, and file shares, configure an intranet application that includes the IP range for all the network applications. This allows users to access all the intranet applications contained in the IP address range.

Minimum length = 1
hostname Read-write Name of the host for which to configure interception. The names are resolved during interception when users log on with the Citrix Gateway Plug-in.

Minimum length = 1
clientapplication <String[]> Read-write Names of the client applications, such as PuTTY and Xshell.

Minimum length = 1
spoofiip Read-write IP address that the intranet application will use to route the connection through the virtual adapter.

Default value: ON

Possible values = ON, OFF
destport Read-write Destination TCP or UDP port number for the intranet application. Use a hyphen to specify a range of port numbers, for example 90-95.

Minimum length = 1
interception Read-write Interception mode for the intranet application or resource. Correct value depends on the type of client software used to make connections. If the interception mode is set to TRANSPARENT, users connect with the Citrix Gateway Plug-in for Windows. With the PROXY setting, users connect with the Citrix Gateway Plug-in for Java.

Possible values = PROXY, TRANSPARENT
srcip Read-write Source IP address. Required if interception mode is set to PROXY. Default is the loopback address, 127.0.0.1.

Minimum length = 1
srcport Read-write Source port for the application for which the Citrix Gateway virtual server proxies the traffic. If users are connecting from a device that uses the Citrix Gateway Plug-in for Java, applications must be configured manually by using the source IP address and TCP port values specified in the intranet application profile. If a port value is not set, the destination port value is used.

Minimum value = 1
ipaddress Read-only The IP address for the application. This address is the real application server IP address.
__count Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET (ALL)
  • GET
  • COUNT

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

add

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"vpnintranetapplication":{
<b>      "intranetapplication":<String_value>,
</b>      "protocol":<String_value>,
      "destip":<String_value>,
      "netmask":<String_value>,
      "iprange":<String_value>,
      "hostname":<String_value>,
      "clientapplication":<String[]_value>,
      "spoofiip":<String_value>,
      "destport":<String_value>,
      "interception":<String_value>,
      "srcip":<String_value>,
      "srcport":<Integer_value>
}}

<!--NeedCopy-->

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/vpnintranetapplication/ intranetapplication_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

get (all)

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

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/vpnintranetapplication? 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/vpnintranetapplication? filter=property-name1:property-val1,property-name2:property-val2

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

view

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

Use this query-parameter to get the summary output of vpnintranetapplication resources configured on NetScaler.

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

pagination

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

Use this query-parameter to get the vpnintranetapplication 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 Header:

Content-Type:application/json

Response Payload: 


{ "vpnintranetapplication": [ {
      "intranetapplication":<String_value>,
      "protocol":<String_value>,
      "destip":<String_value>,
      "netmask":<String_value>,
      "ipaddress":<String_value>,
      "hostname":<String_value>,
      "destport":<String_value>,
      "clientapplication":<String[]_value>,
      "spoofiip":<String_value>,
      "interception":<String_value>,
      "srcip":<String_value>,
      "srcport":<Integer_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnintranetapplication/ intranetapplication_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/vpnintranetapplication/ intranetapplication_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/vpnintranetapplication/ intranetapplication_value<String> ? view=summary

Use this query-parameter to get the summary output of vpnintranetapplication resources configured on NetScaler.

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

Content-Type:application/json

Response Payload: 


{  "vpnintranetapplication": [ {
      "intranetapplication":<String_value>,
      "protocol":<String_value>,
      "destip":<String_value>,
      "netmask":<String_value>,
      "ipaddress":<String_value>,
      "hostname":<String_value>,
      "destport":<String_value>,
      "clientapplication":<String[]_value>,
      "spoofiip":<String_value>,
      "interception":<String_value>,
      "srcip":<String_value>,
      "srcport":<Integer_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnintranetapplication? 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 Header:

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
vpnintranetapplication
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.