Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

New-AppLibPackageDiscoveryProfile

March 11, 2024
Contributed by: 
C

Creates a new package discovery profile in the AppLibrary

Syntax


New-AppLibPackageDiscoveryProfile -Name <String> -DesktopGroupUid <Int32> -Path <String> [-Recurse <Boolean>] [-DiscoverAppV <Boolean>] [-DiscoverMsix <Boolean>] [-DiscoverAppAttach <Boolean>] [-AutomateDiscovery <Boolean>] [-AutoDiscoveryPeriod <String>] [-AutoDiscoveryCadence <Int32>] [-CleanupAbsentPackages <Boolean>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

New-AppLibPackageDiscoveryProfile -Name <String> -DesktopGroupUid <Int32> -ManagementServer <String> -PublishingServer <String> -Username <String> -Password <SecureString> [-AutomateDiscovery <Boolean>] [-AutoDiscoveryPeriod <String>] [-AutoDiscoveryCadence <Int32>] [-CleanupAbsentPackages <Boolean>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

The package discovery profile tells the AppLibrary service where to look for packages to autmatically inport to the AppLibrary, what types of packages should be included and how often the discovery should be done

Parameters

Name Description Required? Pipeline Input Default Value
Name The name of the package discovery profile true false null
DesktopGroupUid The Uid of the desktop group from which the broker will select a VDA to run the discovery true false 0
Path The UNC path of the shared network folder (or file) location where the discovery will start true false null
ManagementServer The URL of the App-V Management Server where the discovery will take place true false null
PublishingServer The URL of the App-V Publishing Server that will be used to publish the discovered packages true false null
Username The username of the App-V server administrator true false null
Password The password of the App-V server administrator true false null
Recurse A value indicating whether the discovery will search through the child folder tree from the discovery root false false True
DiscoverAppV A value indicating whether the discovery will include App-V packages. Note: This parameter is reserved for future use and will always be interpreted as true regardless of the value supplied false false True
DiscoverMsix A value indicating whether the discovery will include Msix packages. Note: This parameter is reserved for future use and will always be interpreted as false regardless of the value supplied false false False
DiscoverAppAttach A value indicating whether the discovery will include AppAttach packages. Note: This parameter is reserved for future use and will always be interpreted as false regardless of the value supplied false false False
AutomateDiscovery A value indicating whether the discovery will run automatically according to the configured discovery cadence false false False
AutoDiscoveryPeriod The period of time to measure the discovery cadence in E.g. Hours, Days or Weeks. false false Day
AutoDiscoveryCadence The minimum number of periods that should elaps between discovery sessions false false 0
CleanupAbsentPackages A value indicating whether the discovery should attempt to remove packages from the library that were not present in the discovery location false false 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. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the Client IP of the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Citrix.Applibrary.Sdk.Packagediscoveryprofile

An object representing the configured discovery profile

Notes

The discovery root path and pair of Management and Publishing servers are mutually exclusive. I.e. a discovery session will run against either a network folder or an App-V Management and Publishing server Setting a discovery cadence of 0 (on any period) is equivilent to setting AutomateDiscovery to False DiscoverMsix and DiscoverAppAttach are not yet implemented and will always be interpreted as false regardles of the value supplied DiscoverAppV is the only active use case and will always be interpreted as true regardles of the value supplied

Examples

Example 1 


New-AppLibPackageDiscoveryProfile -Name "App-V Package Share" -DesktopGroupUid $BrokerDesktopGroup.Uid -Path "\\FileServer.company.com\AppVShare" -Recurse $true -AutomateDiscovery $true -AutoDiscoveryPeriod "Day" AutoDiscoveryCadence "1"

<!--NeedCopy-->

Description

Creates a new package discovery profile that will be automatically run once per day by the AppLibrary Service

Example 2 


$SecurePassword = ConvertTo-SecureString -String "password" -AsPlainText -Force

          New-AppLibPackageDiscoveryProfile -Name "App-V Server" -DesktopGroupUid $BrokerDesktopGroup.Uid -ManagementServer "http://AppVServer.company.com" -PublishingServer "http://AppVServer.company.com:8001" -Username "AppVServer\Username" -Password $SecurePassword -AutomateDiscovery $false

<!--NeedCopy-->

Description

Creates a new package discovery profile that will target an App-V Management and Publishing server, but will not run automatically

New-AppLibPackageDiscoveryProfile
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.