Skip to content

wi-site

The following operations can be performed on "wi-site":

unset| bind| unbind| rm| set| show| add|

unset wi site

Use this command to remove wi site settings.Refer to the set wi site command for meanings of the arguments.NOTE: This command is deprecated.

Synopsis

bind wi site

Binds XenApp or XenDesktop farms to a Web Interface site and optionally, defines access methods for different client IP addresses or networks. NOTE: This command is deprecated.Web Interface feature will be deprecated and StoreFront should be used instead

Synopsis

Arguments

sitePath Path to the Web Interface site.

farmName Name for the logical representation of a XenApp or XenDesktop farm to be bound to the Web Interface site. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

xmlServerAddresses Comma-separated IP addresses or host names of XenApp or XenDesktop servers providing XML services.

groups Active Directory groups that are permitted to enumerate resources from server farms. Including a setting for this parameter activates the user roaming feature. A maximum of 512 user groups can be specified for each farm defined with the Farm parameter. The groups must be comma separated.

recoveryFarm Binded farm is set as a recovery farm.

Possible values: ON, OFF Default value: OFF

xmlPort Port number at which to contact the XML service. Default value: 80 Minimum value: 1 Maximum value: 65535

transport Transport protocol to use for transferring data, related to the Web Interface site, between the Citrix ADC and the XML service.

Possible values: HTTP, HTTPS, SSLRELAY Default value: HTTP

sslRelayPort TCP port at which the XenApp or XenDesktop servers listenfor SSL Relay traffic from the Citrix ADC. This parameter is required if you have set SSL Relay as the transport protocol. Web Interface uses root certificates when authenticating a server running SSL Relay. Make sure that all the servers running SSL Relay are configured to listen on the same port. Default value: 443 Minimum value: 1 Maximum value: 65535

loadBalance Use all the XML servers (load balancing mode) or only one server (failover mode).

Possible values: ON, OFF Default value: ON

accessMethod Secure access method to be applied to the IPv4 or network address of the client specified by the Client IP Address parameter. 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.

Possible values: Direct, Alternate, Translated, GatewayDirect, GatewayAlternate, GatewayTranslated

clientIpAddress IPv4 or network address of the client for which you want to associate an access method. Default value: 0

clientNetMask Subnet mask associated with the IPv4 or network address specified by the Client IP Address parameter. Default value: 0

translationInternalIp IP address of the server for which you want to associate an external IP address. (Clients access the server through the associated external address and port.) Default value: 0

translationInternalPort Port number of the server for which you want to associate an external port. (Clients access the server through the associated external address and port.)

translationExternalIp External IP address associated with server's IP address.

translationExternalPort External port number associated with the server's port number.

accessType Type of access to the XenApp or XenDesktop server. Available settings function as follows: * User Device - Clients can use the translated address of the mapping entry to connect to the XenApp or XenDesktop server. * Gateway - Access Gateway can use the translated address of the mapping entry to connect to the XenApp or XenDesktop server. * User Device and Gateway - Both clients and Access Gateway can use the translated address of the mapping entry to connect to the XenApp or XenDesktop server.

Possible values: UserDevice, Gateway, UserDeviceAndGateway Default value: UserDevice

Example

bind wi site /Citrix/XenApp Farm2 10.10.10.11

unbind wi site

Unbinds XenApp or XenDesktop farms from the Web Interface site and removes the existing access method definition for a client IP address or network. NOTE: This command is deprecated.Web Interface feature will be deprecated and StoreFront should be used instead

Synopsis

Arguments

sitePath Path to the Web Interface site.

farmName Name of the XenApp farm to be unbound from the Web Interface site.

clientIpAddress IPv4 address or network address of the client for which you want to remove the defined access method. Default value: 0

clientNetMask Subnet mask associated with the IPv4 or network address. Default value: 0

translationInternalIp Internal IP address of a mapping entry to be removed. Default value: 0

translationInternalPort Internal port of a mapping entry to be removed.

translationExternalIp External IP address of a mapping entry to be removed. (The external IP address is mapped to an internal address.)

translationExternalPort External port of a mapping entry to be removed. (The external port is mapped to an internal port.)

Example

unbind wi site /Citrix/XenApp Farm2

rm wi site

Removes a Web Interface site from the Citrix ADC. NOTE: This command is deprecated.Web Interface feature will be deprecated and StoreFront should be used instead

Synopsis

Arguments

sitePath Path to the Web Interface site being created on the Citrix ADC.

Example

rm wi site /Citrix/PNAgent

set wi site

Modifies the parameters of a Web Interface site configured on the Citrix ADC. NOTE: This command is deprecated.

Synopsis

Arguments

sitePath Path to the Web Interface site being created on the Citrix ADC.

agURL Call back URL of the Gateway.

staURL URL of the Secure Ticket Authority (STA) server.

sessionReliability Enable session reliability through Access Gateway.

Possible values: ON, OFF Default value: OFF

useTwoTickets Request tickets issued by two separate Secure Ticket Authorities (STA) when a resource is accessed.

Possible values: ON, OFF Default value: OFF

secondSTAURL URL of the second Secure Ticket Authority (STA) server.

wiAuthenticationMethods The method of authentication to be used at Web Interface Default value: Explicit

defaultAccessMethod 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

defaultCustomTextLocale Default language for the Web Interface site.

Possible values: German, English, Spanish, French, Japanese, Korean, Russian, Chinese_simplified, Chinese_traditional Default value: English

webSessionTimeout 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

loginTitle A custom login page title for the Web Interface site. Default value: "Welcome to Web Interface on NetScaler"

appWelcomeMessage 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.

welcomeMessage Localized welcome message that appears on the welcome area of the login screen.

footerText Localized text that appears in the footer area of all pages.

loginSysMessage Localized text that appears at the bottom of the main content area of the login screen.

preLoginButton Localized text that appears as the name of the pre-login message confirmation button.

preLoginMessage Localized text that appears on the pre-login message page.

preLoginTitle Localized text that appears as the title of the pre-login message page.

domainSelection Domain names listed on the login screen for explicit authentication.

userInterfaceBranding 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.

Possible values: Desktops, Applications Default value: Applications

authenticationPoint Authentication point for the Web Interface site.

Possible values: WebInterface, AccessGateway

agAuthenticationMethod 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

publishedResourceType 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.

Possible values: Online, Offline, DualMode Default value: Online

kioskMode User settings do not persist from one session to another.

Possible values: ON, OFF Default value: OFF

ShowSearch Enables search option on XenApp websites

Possible values: ON, OFF Default value: OFF

ShowRefresh Provides the Refresh button on the applications screen.

Possible values: ON, OFF Default value: OFF

wiUserInterfaceModes 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.

Possible values: SIMPLE, ADVANCED Default value: SIMPLE

UserInterfaceLayouts Specifies whether or not to use the compact user interface.

Possible values: AUTO, NORMAL, COMPACT Default value: AUTO

restrictDomains 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

Possible values: ON, OFF Default value: OFF

loginDomains [List of NetBIOS domain names], Domain names to use for access restriction. Only takes effect when used in conjunction with the RestrictDomains setting.

hideDomainField The HideDomainField setting is used to control whether the domain field is displayed on the logon screen.

Possible values: ON, OFF Default value: OFF

agCallbackURL Callback AGURL to which Web Interface contacts.

Example

set wi site /Citrix/PNAgent -staURL http://myStaServer

show wi site

Displays settings of all the Web Interface sites, or of a specified site. To display settings of all the Web Interface sites, run the command without any parameters. NOTE: This command is deprecated.Web Interface feature will be deprecated and StoreFront should be used instead

Synopsis

Arguments

sitePath Path of a Web Interface site whose details you want the Citrix ADC to display.

Output

stateflag agURL Call back URL of the Gateway.

staURL The URL of Secure Ticketing Authortity server

wiAuthenticationMethods The method of authentication to be used at Web Interface

loginTitle A custom login page title for the Web Interface site.

appWelcomeMessage 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.

welcomeMessage Localized welcome message that appears on the welcome area of the login screen.

footerText Localized text that appears in the footer area of all pages.

loginSysMessage Localized text that appears at the bottom of the main content area of the login screen.

preLoginButton Localized text that appears as the name of the pre-login message confirmation button.

preLoginMessage Localized text that appears on the pre-login message page.

preLoginTitle Localized text that appears as the title of the pre-login message page.

domainSelection Domain names listed on the login screen for explicit authentication.

defaultCustomTextLocale Default language for the Web Interface site.

webSessionTimeout 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.

siteType 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.

userInterfaceBranding 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.

ShowSearch Enables search option on XenApp websites

ShowRefresh Provides the Refresh button on the applications screen.

wiUserInterfaceModes 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.

UserInterfaceLayouts Specifies whether or not to use the compact user interface.

publishedResourceType 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.

defaultAccessMethod 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.

farmName Name for the logical representation of a XenApp or XenDesktop farm to be bound to the Web Interface site. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

accessMethod Secure access method to be applied to the IPv4 or network address of the client specified by the Client IP Address parameter. 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.

clientIpAddress IPv4 or network address of the client for which you want to associate an access method.

clientNetMask Subnet mask associated with the IPv4 or network address specified by the Client IP Address parameter.

translationInternalIp IP address of the server for which you want to associate an external IP address. (Clients access the server through the associated external address and port.)

translationInternalPort Port number of the server for which you want to associate an external port. (Clients access the server through the associated external address and port.)

translationExternalIp External IP address associated with server's IP address.

translationExternalPort External port number associated with the server's port number.

accessType Type of access to the XenApp or XenDesktop server. Available settings function as follows: * User Device - Clients can use the translated address of the mapping entry to connect to the XenApp or XenDesktop server. * Gateway - Access Gateway can use the translated address of the mapping entry to connect to the XenApp or XenDesktop server. * User Device and Gateway - Both clients and Access Gateway can use the translated address of the mapping entry to connect to the XenApp or XenDesktop server.

xmlServerAddresses Comma-separated IP addresses or host names of XenApp or XenDesktop servers providing XML services.

xmlPort Port number at which to contact the XML service.

transport Transport protocol to use for transferring data, related to the Web Interface site, between the Citrix ADC and the XML service.

sslRelayPort TCP port at which the XenApp or XenDesktop servers listenfor SSL Relay traffic from the Citrix ADC. This parameter is required if you have set SSL Relay as the transport protocol. Web Interface uses root certificates when authenticating a server running SSL Relay. Make sure that all the servers running SSL Relay are configured to listen on the same port.

agAuthenticationMethod 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.

groups Active Directory groups that are permitted to enumerate resources from server farms. Including a setting for this parameter activates the user roaming feature. A maximum of 512 user groups can be specified for each farm defined with the Farm parameter. The groups must be comma separated.

recoveryFarm Binded farm is set as a recovery farm.

sessionReliability Enable session reliability through Access Gateway.

useTwoTickets Request tickets issued by two separate Secure Ticket Authorities (STA) when a resource is accessed.

secondSTAURL URL of the second Secure Ticket Authority (STA) server.

loadBalance Use all the XML servers (load balancing mode) or only one server (failover mode).

authenticationPoint Authentication point for the Web Interface site.

kioskMode User settings do not persist from one session to another.

restrictDomains 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

loginDomains [List of NetBIOS domain names], Domain names to use for access restriction. Only takes effect when used in conjunction with the RestrictDomains setting.

hideDomainField The HideDomainField setting is used to control whether the domain field is displayed on the logon screen.

agCallbackURL Callback AGURL to which Web Interface contacts.

devno count

Example

show wi site

add wi site

Creates a Web Interface site on the Citrix ADC. The Citrix ADC Web Interface feature provides access to Citrix XenApp and Citrix XenDesktop applications. Users access resources through a standard web browser or by using the Citrix XenApp plug-in. NOTE: This command is deprecated.Web Interface feature will be deprecated and StoreFront should be used instead

Synopsis

Arguments

sitePath Path to the Web Interface site being created on the Citrix ADC.

agURL Call back URL of the Gateway.

staURL URL of the Secure Ticket Authority (STA) server.

secondSTAURL URL of the second Secure Ticket Authority (STA) server.

sessionReliability Enable session reliability through Access Gateway.

Possible values: ON, OFF Default value: OFF

useTwoTickets Request tickets issued by two separate Secure Ticket Authorities (STA) when a resource is accessed.

Possible values: ON, OFF Default value: OFF

authenticationPoint Authentication point for the Web Interface site.

Possible values: WebInterface, AccessGateway

agAuthenticationMethod 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 The method of authentication to be used at Web Interface Default value: Explicit

defaultCustomTextLocale Default language for the Web Interface site.

Possible values: German, English, Spanish, French, Japanese, Korean, Russian, Chinese_simplified, Chinese_traditional Default value: English

webSessionTimeout 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 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 A custom login page title for the Web Interface site. Default value: "Welcome to Web Interface on NetScaler"

appWelcomeMessage 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.

welcomeMessage Localized welcome message that appears on the welcome area of the login screen.

footerText Localized text that appears in the footer area of all pages.

loginSysMessage Localized text that appears at the bottom of the main content area of the login screen.

preLoginButton Localized text that appears as the name of the pre-login message confirmation button.

preLoginMessage Localized text that appears on the pre-login message page.

preLoginTitle Localized text that appears as the title of the pre-login message page.

domainSelection Domain names listed on the login screen for explicit authentication.

siteType 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.

Possible values: XenAppWeb, XenAppServices Default value: XenAppWeb

userInterfaceBranding 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.

Possible values: Desktops, Applications Default value: Applications

publishedResourceType 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.

Possible values: Online, Offline, DualMode Default value: Online

kioskMode User settings do not persist from one session to another.

Possible values: ON, OFF Default value: OFF

ShowSearch Enables search option on XenApp websites

Possible values: ON, OFF Default value: OFF

ShowRefresh Provides the Refresh button on the applications screen.

Possible values: ON, OFF Default value: OFF

wiUserInterfaceModes 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.

Possible values: SIMPLE, ADVANCED Default value: SIMPLE

UserInterfaceLayouts Specifies whether or not to use the compact user interface.

Possible values: AUTO, NORMAL, COMPACT Default value: AUTO

restrictDomains 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

Possible values: ON, OFF Default value: OFF

loginDomains [List of NetBIOS domain names], Domain names to use for access restriction. Only takes effect when used in conjunction with the RestrictDomains setting.

hideDomainField The HideDomainField setting is used to control whether the domain field is displayed on the logon screen.

Possible values: ON, OFF Default value: OFF

agCallbackURL Callback AGURL to which Web Interface contacts.

Example

add wi site /Citrix/PNAgent -siteType XenAppServices

Was this article helpful?