New-AppLibAppVPackage

Last published : Oct 31, 2026
Adds a new package to the library.
Related information
about_AppLibAppLibrarySnapin

Syntax

New-AppLibAppVPackage
   -LibraryUid <Int32>
   -Path <String>
   [-RetrieveIcon <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-AppLibAppVPackage
   -Path <String>
   [-RetrieveIcon <Boolean>]
   -AppManifestXml <String>
   -AppManifestIcons <System.Collections.Generic.Dictionary`2[System.String,System.Byte[]]>
   -ManagementServer <String>
   -PublishingServer <String>
   -PackageProperties <System.Collections.Generic.Dictionary`2[System.String,System.Object]>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-AppLibAppVPackage
   -Path <String>
   -AppManifestXml <String>
   -AppManifestIcons <System.Collections.Generic.Dictionary`2[System.String,System.Byte[]]>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

The package and the applications that make it up are added to the library.

Examples

EXAMPLE 1

Adds the package at the specified network location to the library by interrogating the packge file and extrcting the neccesary informaion
New-AppLibAppVPackage -LibraryUid 1 -Path "\\NetworkStorage.enterprise.com\Managed App-V Packages\Package.appv"

EXAMPLE 2

Adds the package at the specified network location to the library by interpreting only the supplied AppManifest Xml when no physical access to the package is possible.
New-AppLibAppVPackage -Path "\\NetworkStorage.enterprise.com\Managed App-V Packages\Package.appv" -AppManifestXml $AppManifestxml -AppManifestIcons $DictinaryOfIcons

Parameters

-LibraryUid

The UID of the library to which the package is added.
Type: Int32
Aliases: Uid
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Path

The full path to the package on the network share.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 0 to 4000

-AppManifestXml

The Package's AppManifest Xml
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-AppManifestIcons

A dictionary containing data for icons containied in te package keyed by their path in the AppManifest Xml
Type: System.Collections.Generic.Dictionary`2[System.String,System.Byte[]]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ManagementServer

Fully qualified domain name of the machine hosting Microsoft App-V Management Server
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-PublishingServer

Url of App-V publishing server
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-PackageProperties

Extracted AppV Package properties
Type: System.Collections.Generic.Dictionary`2[System.String,System.Object]
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-RetrieveIcon

A switch to indicate whether to return the package and applications' icon data.
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

Citrix.AppLibrary.Sdk.AppVPackage

An object representing the details of the the new package.

Notes

If supplied, the value of the LibraryUid parameter must be 1. No other values are supported.
When a package is added to the library and a record of that package already exists, the existing package is updated with the details of the new package. A package is considered as already existing when the following are true: 1) The PackageGuid and VersionGuid are the same as the existing package and the Path is the same or different. 2) The Path is the same as the existing package and the PackageGuid and/or VersionGuid are the same or different.