Citrix Daas SDK

New-AppLibPackageDiscoveryProfile

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>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-AppLibPackageDiscoveryProfile
   -Name <String>
   -DesktopGroupUid <Int32>
   -ManagementServer <String>
   -PublishingServer <String>
   -Username <String>
   -Password <SecureString>
   [-AutomateDiscovery <Boolean>]
   [-AutoDiscoveryPeriod <String>]
   [-AutoDiscoveryCadence <Int32>]
   [-CleanupAbsentPackages <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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

Examples

EXAMPLE 1

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

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

EXAMPLE 2

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

$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-->

Parameters

-Name

The name of the package discovery profile

Type: String
Position: Named
Default value: Null
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-DesktopGroupUid

The Uid of the desktop group from which the broker will select a VDA to run the discovery

Type: Int32
Position: Named
Default value: 0
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Path

The UNC path of the shared network folder (or file) location where the discovery will start

Type: String
Position: Named
Default value: Null
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ManagementServer

The URL of the App-V Management Server where the discovery will take place

Type: String
Position: Named
Default value: Null
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-PublishingServer

The URL of the App-V Publishing Server that will be used to publish the discovered packages

Type: String
Position: Named
Default value: Null
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Username

The username of the App-V server administrator

Type: String
Position: Named
Default value: Null
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Password

The password of the App-V server administrator

Type: SecureString
Position: Named
Default value: Null
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Recurse

A value indicating whether the discovery will search through the child folder tree from the discovery root

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

-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

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

-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

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: 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

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

-AutomateDiscovery

A value indicating whether the discovery will run automatically according to the configured discovery cadence

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

-AutoDiscoveryPeriod

The period of time to measure the discovery cadence in E.g. Hours, Days or Weeks.

Type: String
Position: Named
Default value: Day
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoDiscoveryCadence

The minimum number of periods that should elaps between discovery sessions

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-CleanupAbsentPackages

A value indicating whether the discovery should attempt to remove packages from the library that were not present in the discovery location

Type: Boolean
Position: Named
Default value: False
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.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

New-AppLibPackageDiscoveryProfile