Invoke ADCUnsetRdpclientprofile - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUnsetRdpclientprofile

SYNOPSIS

Unset Rdp configuration Object.

SYNTAX

Invoke-ADCUnsetRdpclientprofile [[-Name] <String>] [[-rdpurloverride] <Boolean>]
 [[-redirectclipboard] <Boolean>] [[-redirectdrives] <Boolean>] [[-redirectprinters] <Boolean>]
 [[-redirectcomports] <Boolean>] [[-redirectpnpdevices] <Boolean>] [[-keyboardhook] <Boolean>]
 [[-audiocapturemode] <Boolean>] [[-videoplaybackmode] <Boolean>] [[-multimonitorsupport] <Boolean>]
 [[-rdpcookievalidity] <Boolean>] [[-addusernameinrdpfile] <Boolean>] [[-rdpfilename] <Boolean>]
 [[-rdphost] <Boolean>] [[-rdplistener] <Boolean>] [[-rdpcustomparams] <Boolean>] [[-psk] <Boolean>]
 [[-randomizerdpfilename] <Boolean>] [[-rdplinkattribute] <Boolean>] [[-rdpvalidateclientip] <Boolean>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for RDP clientprofile resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUnsetRdpclientprofile -name <string>

An example how to unset rdpclientprofile configuration Object(s).

PARAMETERS

-Name

The name of the rdp profile.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-rdpurloverride

This setting determines whether the RDP parameters supplied in the vpn url override those specified in the RDP profile. Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-redirectclipboard

This setting corresponds to the Clipboard check box on the Local Resources tab under Options in RDC. Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-redirectdrives

This setting corresponds to the selections for Drives under More on the Local Resources tab under Options in RDC. Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-redirectprinters

This setting corresponds to the selection in the Printers check box on the Local Resources tab under Options in RDC. Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-redirectcomports

This setting corresponds to the selections for comports under More on the Local Resources tab under Options in RDC. Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-redirectpnpdevices

This setting corresponds to the selections for pnpdevices under More on the Local Resources tab under Options in RDC. Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-keyboardhook

This setting corresponds to the selection in the Keyboard drop-down list on the Local Resources tab under Options in RDC. Possible values = OnLocal, OnRemote, InFullScreenMode

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-audiocapturemode

This setting corresponds to the selections in the Remote audio area on the Local Resources tab under Options in RDC. Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-videoplaybackmode

This setting determines if Remote Desktop Connection (RDC) will use RDP efficient multimedia streaming for video playback. Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-multimonitorsupport

Enable/Disable Multiple Monitor Support for Remote Desktop Connection (RDC). Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-rdpcookievalidity

RDP cookie validity period. RDP cookie validity time is applicable for new connection and also for any re-connection that might happen, mostly due to network disruption or during fail-over.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-addusernameinrdpfile

Add username in rdp file. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-rdpfilename

RDP file name to be sent to End User.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-rdphost

Fully-qualified domain name (FQDN) of the RDP Listener.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-rdplistener

IP address (or) Fully-qualified domain name(FQDN) of the RDP Listener with the port in the format IP:Port (or) FQDN:Port.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-rdpcustomparams

Option for RDP custom parameters settings (if any). Custom params needs to be separated by ';'.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-psk

Pre shared key value.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-randomizerdpfilename

Will generate unique filename everytime rdp file is downloaded by appending output of time() function in the format <rdpfileName>_<time>.rdp. This tries to avoid the pop-up for replacement of existing rdp file during each rdp connection launch, hence providing better end-user experience. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-rdplinkattribute

Citrix Gateway allows the configuration of rdpLinkAttribute parameter which can be used to fetch a list of RDP servers(IP/FQDN) that a user can access, from an Authentication server attribute(Example: LDAP, SAML). Based on the list received, the RDP links will be generated and displayed to the user. Note: The Attribute mentioned in the rdpLinkAttribute should be fetched through corresponding authentication method.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-rdpvalidateclientip

This setting determines whether RDC launch is initiated by the valid client IP. Possible values = ENABLE, DISABLE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows 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: False

-Confirm

Prompts 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: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCUnsetRdpclientprofile Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/rdp/rdpclientprofile Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️