Citrix Virtual Apps and Desktops SDK

Remove-BrokerSessionPreLaunch

Removes a session pre-launch setting.

Syntax

Remove-BrokerSessionPreLaunch
      [-InputObject] <SessionPreLaunch[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-BrokerSessionPreLaunch
      [-DesktopGroupName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The Remove-BrokerSessionPreLaunch cmdlet is used to delete an existing session pre-launch setting.

Examples

EXAMPLE 1

Deletes every session pre-launch setting for all desktop groups.

Get-BrokerSessionPreLaunch | Remove-BrokerSessionPreLaunch
<!--NeedCopy-->

Parameters

-InputObject

The session pre-launch setting to be deleted.

Type: SessionPreLaunch[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DesktopGroupName

The name of the desktop group whose session pre-launch setting is to be removed.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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

Citrix.Broker.Admin.SDK.SessionPreLaunch

Session pre-launch settings may be specified through pipeline input.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerSessionPreLaunch