Invoke ADCUpdateWisite - j81blog/J81.ADCToolkit GitHub Wiki
Update WebInterface configuration Object.
Invoke-ADCUpdateWisite [-Sitepath] <String> [[-Agurl] <String>] [[-Staurl] <String>]
[[-Sessionreliability] <String>] [[-Usetwotickets] <String>] [[-Secondstaurl] <String>]
[[-Wiauthenticationmethods] <String[]>] [[-Defaultaccessmethod] <String>]
[[-Defaultcustomtextlocale] <String>] [[-Websessiontimeout] <Double>] [[-Logintitle] <String>]
[[-Appwelcomemessage] <String>] [[-Welcomemessage] <String>] [[-Footertext] <String>]
[[-Loginsysmessage] <String>] [[-Preloginbutton] <String>] [[-Preloginmessage] <String>]
[[-Prelogintitle] <String>] [[-Domainselection] <String>] [[-Userinterfacebranding] <String>]
[[-Authenticationpoint] <String>] [[-Agauthenticationmethod] <String>] [[-Publishedresourcetype] <String>]
[[-Kioskmode] <String>] [[-Showsearch] <String>] [[-Showrefresh] <String>] [[-Wiuserinterfacemodes] <String>]
[[-Userinterfacelayouts] <String>] [[-Restrictdomains] <String>] [[-Logindomains] <String>]
[[-Hidedomainfield] <String>] [[-Agcallbackurl] <String>] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
Configuration for WI site resource.
Invoke-ADCUpdateWisite -sitepath <string>
An example how to update wisite configuration Object(s).
Path to the Web Interface site being created on the Citrix ADC.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseCall back URL of the Gateway.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseURL of the Secure Ticket Authority (STA) server.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseEnable session reliability through Access Gateway. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRequest tickets issued by two separate Secure Ticket Authorities (STA) when a resource is accessed. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseURL of the second Secure Ticket Authority (STA) server.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe method of authentication to be used at Web Interface. Possible values = Explicit, Anonymous
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDefault 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
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDefault language for the Web Interface site. Possible values = German, English, Spanish, French, Japanese, Korean, Russian, Chinese_simplified, Chinese_traditional
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseTime-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.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseA custom login page title for the Web Interface site.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseLocalized welcome message that appears on the welcome area of the login screen.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseLocalized text that appears in the footer area of all pages.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseLocalized text that appears at the bottom of the main content area of the login screen.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseLocalized text that appears as the name of the pre-login message confirmation button.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseLocalized text that appears on the pre-login message page.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseLocalized text that appears as the title of the pre-login message page.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDomain names listed on the login screen for explicit authentication.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 21
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAuthentication point for the Web Interface site. Possible values = WebInterface, AccessGateway
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 22
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseMethod 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
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 23
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseMethod 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
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 24
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUser settings do not persist from one session to another. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 25
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseEnables search option on XenApp websites. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 26
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseProvides the Refresh button on the applications screen. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 27
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAppearance 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
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 28
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether or not to use the compact user interface. Possible values = AUTO, NORMAL, COMPACT
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 29
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe 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
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 30
Default value: None
Accept pipeline input: False
Accept wildcard characters: False[List of NetBIOS domain names], Domain names to use for access restriction. Only takes effect when used in conjunction with the RestrictDomains setting.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 31
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe HideDomainField setting is used to control whether the domain field is displayed on the logon screen. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 32
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseCallback AGURL to which Web Interface contacts. .
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 33
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseReturn details about the created wisite item.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
File Name : Invoke-ADCUpdateWisite Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/wi/wisite/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.