Citrix Virtual Apps and Desktops SDK

Remove-AppLibAppVPackage

Removes an App-V package from the library that is holding it

Syntax

Remove-AppLibAppVPackage
      [-Uid] <Int32>
      [-ServerUid <Int32>]
      [-Purge <Boolean>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to remove an App-V package from the application library.

Removing a package from the library optionally only marks it as not existing. In this case, re-adding the package later will restore the reference.

Examples

EXAMPLE 1

Permanently removes the specified package from the library including its associated applications and metadata.

Remove-AppLibAppVPackage -Uid 5
<!--NeedCopy-->

EXAMPLE 2

Permanently removes the specified package from the library including its associated applications and metadata.

Remove-AppLibAppVPackage -Uid 5 -Purge $true
<!--NeedCopy-->

EXAMPLE 3

Removes the specified package from the library that holds it by marking it as non-existing, but leaving associated records and metadata in place.

Remove-AppLibAppVPackage -Uid 5 -Purge $false
<!--NeedCopy-->

Parameters

-Uid

The App Library’s internal unique identifier of the App-V package.

Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ServerUid

Unique Identifier for AppVServer.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Purge

Indicates whether the package should be removed from the database. The default is true. Setting this parameter to false will leave the package and all of its associated applications and metadata in place but in a dormant state. This data will then be reactivated if the same package is ever re-added.

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

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Notes

If the command fails, the following errors can result.

Error Codes


UnknownObject

No package was found for the given uid. DatabaseError

An error occurred in the service while attempting a database operation. DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured. DataStoreException

An error occurred in the service while attempting a database operation - communication with the database failed for various reasons. PermissionDenied

You do not have permission to execute this command. AuthorizationError

There was a problem communicating with the Citrix Delegated Administration Service. CommunicationError

There was a problem communicating with the remote service. ExceptionThrown

An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.

Remove-AppLibAppVPackage