Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

wisite

August 17, 2023
Contributed by: 
C

Configuration for WI site resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
sitepath Read-write Path to the Web Interface site being created on the Citrix ADC.

Minimum length = 1

Maximum length = 250
agurl Read-write Call back URL of the Gateway.

Minimum length = 1

Maximum length = 255
staurl Read-write URL of the Secure Ticket Authority (STA) server.

Minimum length = 1

Maximum length = 255
secondstaurl Read-write URL of the second Secure Ticket Authority (STA) server.

Minimum length = 1

Maximum length = 255
sessionreliability Read-write Enable session reliability through Access Gateway.

Default value: OFF

Possible values = ON, OFF
usetwotickets Read-write Request tickets issued by two separate Secure Ticket Authorities (STA) when a resource is accessed.

Default value: OFF

Possible values = ON, OFF
authenticationpoint Read-write Authentication point for the Web Interface site.

Possible values = WebInterface, AccessGateway
agauthenticationmethod Read-write Method for authenticating a Web Interface site if you have specified Web Interface as the authentication point. Available settings function as follows
  • Explicit - Users must provide a user name and password to log on to the Web Interface.
  • Anonymous - Users can log on to the Web Interface without providing a user name and password. They have access to resources published for anonymous users. Possible values = Explicit, SmartCard
    		•
    wiauthenticationmethods <String[]> Read-write The method of authentication to be used at Web Interface.

    Default value: Explicit

    Possible values = Explicit, Anonymous
    defaultcustomtextlocale Read-write Default language for the Web Interface site.

    Default value: English

    Possible values = German, English, Spanish, French, Japanese, Korean, Russian, Chinese_simplified, Chinese_traditional
    websessiontimeout Read-write Time-out, in minutes, for idle Web Interface browser sessions. If a client’s session is idle for a time that exceeds the time-out value, the Citrix ADC terminates the connection.

    Default value: 20

    Minimum value = 1

    Maximum value = 1440
    defaultaccessmethod Read-write Default access method for clients accessing the Web Interface site.



    Note: Before you configure an access method based on the client IP address, you must enable USIP mode on the Web Interface service to make the client’s IP address available with the Web Interface.

    Depending on whether the Web Interface site is configured to use an HTTP or HTTPS virtual server or to use access gateway, you can send clients or access gateway the IP address, or the alternate address, of a XenApp or XenDesktop server. Or, you can send the IP address translated from a mapping entry, which defines mapping of an internal address and port to an external address and port.

    Note: In the Citrix ADC command line, mapping entries can be created by using the bind wi site command.

    Possible values = Direct, Alternate, Translated, GatewayDirect, GatewayAlternate, GatewayTranslated
    logintitle Read-write A custom login page title for the Web Interface site.

    Default value: “Welcome to Web Interface on NetScaler”

    Minimum length = 1

    Maximum length = 255
    appwelcomemessage Read-write Specifies localized text to appear at the top of the main content area of the Applications screen. LanguageCode is en, de, es, fr, ja, or any other supported language identifier.

    Minimum length = 1

    Maximum length = 255
    welcomemessage Read-write Localized welcome message that appears on the welcome area of the login screen.

    Minimum length = 1

    Maximum length = 255
    footertext Read-write Localized text that appears in the footer area of all pages.

    Minimum length = 1

    Maximum length = 255
    loginsysmessage Read-write Localized text that appears at the bottom of the main content area of the login screen.

    Minimum length = 1

    Maximum length = 255
    preloginbutton Read-write Localized text that appears as the name of the pre-login message confirmation button.

    Minimum length = 1

    Maximum length = 255
    preloginmessage Read-write Localized text that appears on the pre-login message page.

    Minimum length = 1

    Maximum length = 2048
    prelogintitle Read-write Localized text that appears as the title of the pre-login message page.

    Minimum length = 1

    Maximum length = 255
    domainselection Read-write Domain names listed on the login screen for explicit authentication.

    Minimum length = 1

    Maximum length = 255
    sitetype Read-write Type of access to the Web Interface site. Available settings function as follows
  • XenApp/XenDesktop web site - Configures the Web Interface site for access by a web browser.
  • XenApp/XenDesktop services site - Configures the Web Interface site for access by the XenApp plug-in. Default value: XenAppWeb Possible values = XenAppWeb, XenAppServices
    		•
    userinterfacebranding Read-write Specifies whether the site is focused towards users accessing applications or desktops. Setting the parameter to Desktops changes the functionality of the site to improve the experience for XenDesktop users. Citrix recommends using this setting for any deployment that includes XenDesktop.

    Default value: Applications

    Possible values = Desktops, Applications
    publishedresourcetype Read-write Method for accessing the published XenApp and XenDesktop resources. Available settings function as follows
  • Online - Allows applications to be launched on the XenApp and XenDesktop servers.
  • Offline - Allows streaming of applications to the client.
  • DualMode - Allows both online and offline modes. Default value: Online Possible values = Online, Offline, DualMode
    		•
    kioskmode Read-write User settings do not persist from one session to another.

    Default value: OFF

    Possible values = ON, OFF
    showsearch Read-write Enables search option on XenApp websites.

    Default value: OFF

    Possible values = ON, OFF
    showrefresh Read-write Provides the Refresh button on the applications screen.

    Default value: OFF

    Possible values = ON, OFF
    wiuserinterfacemodes Read-write Appearance of the login screen.

    * Simple - Only the login fields for the selected authentication method are displayed.

    * Advanced - Displays the navigation bar, which provides access to the pre-login messages and preferences screens.

    Default value: SIMPLE

    Possible values = SIMPLE, ADVANCED
    userinterfacelayouts Read-write Specifies whether or not to use the compact user interface.

    Default value: AUTO

    Possible values = AUTO, NORMAL, COMPACT
    restrictdomains Read-write The RestrictDomains setting is used to enable/disable domain restrictions. If domain restriction is enabled, the LoginDomains list is used for validating the login domain. It is applied to all the authentication methods except Anonymous for XenApp Web and XenApp Services sites.

    Default value: OFF

    Possible values = ON, OFF
    logindomains Read-write [List of NetBIOS domain names], Domain names to use for access restriction.

    Only takes effect when used in conjunction with the RestrictDomains setting.

    Minimum length = 1

    Maximum length = 255
    hidedomainfield Read-write The HideDomainField setting is used to control whether the domain field is displayed on the logon screen.

    Default value: OFF

    Possible values = ON, OFF
    agcallbackurl Read-write Callback AGURL to which Web Interface contacts. .

    Minimum length = 1

    Maximum length = 255
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • UPDATE
    • UNSET
    • 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/wisite

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"wisite":{
<b>      "sitepath":<String_value>,
</b>      "agurl":<String_value>,
      "staurl":<String_value>,
      "secondstaurl":<String_value>,
      "sessionreliability":<String_value>,
      "usetwotickets":<String_value>,
      "authenticationpoint":<String_value>,
      "agauthenticationmethod":<String_value>,
      "wiauthenticationmethods":<String[]_value>,
      "defaultcustomtextlocale":<String_value>,
      "websessiontimeout":<Double_value>,
      "defaultaccessmethod":<String_value>,
      "logintitle":<String_value>,
      "appwelcomemessage":<String_value>,
      "welcomemessage":<String_value>,
      "footertext":<String_value>,
      "loginsysmessage":<String_value>,
      "preloginbutton":<String_value>,
      "preloginmessage":<String_value>,
      "prelogintitle":<String_value>,
      "domainselection":<String_value>,
      "sitetype":<String_value>,
      "userinterfacebranding":<String_value>,
      "publishedresourcetype":<String_value>,
      "kioskmode":<String_value>,
      "showsearch":<String_value>,
      "showrefresh":<String_value>,
      "wiuserinterfacemodes":<String_value>,
      "userinterfacelayouts":<String_value>,
      "restrictdomains":<String_value>,
      "logindomains":<String_value>,
      "hidedomainfield":<String_value>,
      "agcallbackurl":<String_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/wisite/ sitepath_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/wisite

    HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"wisite":{
<b>      "sitepath":<String_value>,
</b>      "agurl":<String_value>,
      "staurl":<String_value>,
      "sessionreliability":<String_value>,
      "usetwotickets":<String_value>,
      "secondstaurl":<String_value>,
      "wiauthenticationmethods":<String[]_value>,
      "defaultaccessmethod":<String_value>,
      "defaultcustomtextlocale":<String_value>,
      "websessiontimeout":<Double_value>,
      "logintitle":<String_value>,
      "appwelcomemessage":<String_value>,
      "welcomemessage":<String_value>,
      "footertext":<String_value>,
      "loginsysmessage":<String_value>,
      "preloginbutton":<String_value>,
      "preloginmessage":<String_value>,
      "prelogintitle":<String_value>,
      "domainselection":<String_value>,
      "userinterfacebranding":<String_value>,
      "authenticationpoint":<String_value>,
      "agauthenticationmethod":<String_value>,
      "publishedresourcetype":<String_value>,
      "kioskmode":<String_value>,
      "showsearch":<String_value>,
      "showrefresh":<String_value>,
      "wiuserinterfacemodes":<String_value>,
      "userinterfacelayouts":<String_value>,
      "restrictdomains":<String_value>,
      "logindomains":<String_value>,
      "hidedomainfield":<String_value>,
      "agcallbackurl":<String_value>
}}

<!--NeedCopy-->

    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/wisite? action=unset

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"wisite":{
<b>      "sitepath":<String_value>,
</b>      "appwelcomemessage":true,
      "welcomemessage":true,
      "footertext":true,
      "loginsysmessage":true,
      "preloginbutton":true,
      "preloginmessage":true,
      "prelogintitle":true,
      "userinterfacebranding":true,
      "logindomains":true
}}

<!--NeedCopy-->

    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/wisite

    Query-parameters:

    attrs

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

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

    view

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

    Use this query-parameter to get the summary output of wisite 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/wisite? pagesize=#no;pageno=#no

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

    
{ "wisite": [ {
      "sitepath":<String_value>,
      "agurl":<String_value>,
      "staurl":<String_value>,
      "wiauthenticationmethods":<String[]_value>,
      "logintitle":<String_value>,
      "appwelcomemessage":<String_value>,
      "welcomemessage":<String_value>,
      "footertext":<String_value>,
      "loginsysmessage":<String_value>,
      "preloginbutton":<String_value>,
      "preloginmessage":<String_value>,
      "prelogintitle":<String_value>,
      "domainselection":<String_value>,
      "defaultcustomtextlocale":<String_value>,
      "websessiontimeout":<Double_value>,
      "sitetype":<String_value>,
      "userinterfacebranding":<String_value>,
      "showsearch":<String_value>,
      "showrefresh":<String_value>,
      "wiuserinterfacemodes":<String_value>,
      "userinterfacelayouts":<String_value>,
      "publishedresourcetype":<String_value>,
      "defaultaccessmethod":<String_value>,
      "agauthenticationmethod":<String_value>,
      "sessionreliability":<String_value>,
      "usetwotickets":<String_value>,
      "secondstaurl":<String_value>,
      "authenticationpoint":<String_value>,
      "kioskmode":<String_value>,
      "restrictdomains":<String_value>,
      "logindomains":<String_value>,
      "hidedomainfield":<String_value>,
      "agcallbackurl":<String_value>
}]}

<!--NeedCopy-->

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/wisite/ sitepath_value<String>

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/wisite/ sitepath_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/wisite/ sitepath_value<String> ? view=summary

    Use this query-parameter to get the summary output of wisite 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: 

    
{  "wisite": [ {
      "sitepath":<String_value>,
      "agurl":<String_value>,
      "staurl":<String_value>,
      "wiauthenticationmethods":<String[]_value>,
      "logintitle":<String_value>,
      "appwelcomemessage":<String_value>,
      "welcomemessage":<String_value>,
      "footertext":<String_value>,
      "loginsysmessage":<String_value>,
      "preloginbutton":<String_value>,
      "preloginmessage":<String_value>,
      "prelogintitle":<String_value>,
      "domainselection":<String_value>,
      "defaultcustomtextlocale":<String_value>,
      "websessiontimeout":<Double_value>,
      "sitetype":<String_value>,
      "userinterfacebranding":<String_value>,
      "showsearch":<String_value>,
      "showrefresh":<String_value>,
      "wiuserinterfacemodes":<String_value>,
      "userinterfacelayouts":<String_value>,
      "publishedresourcetype":<String_value>,
      "defaultaccessmethod":<String_value>,
      "agauthenticationmethod":<String_value>,
      "sessionreliability":<String_value>,
      "usetwotickets":<String_value>,
      "secondstaurl":<String_value>,
      "authenticationpoint":<String_value>,
      "kioskmode":<String_value>,
      "restrictdomains":<String_value>,
      "logindomains":<String_value>,
      "hidedomainfield":<String_value>,
      "agcallbackurl":<String_value>
}]}

<!--NeedCopy-->

    count

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

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

<!--NeedCopy-->
    wisite
    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.