Citrix Virtual Apps and Desktops SDK

Set-AppLibPackageDiscoveryProfile

Introduced in: Citrix Virtual Apps and Desktop 7 2206

Updates a package discovery profile defined in the AppLibrary with the specified new details

Syntax

Set-AppLibPackageDiscoveryProfile
   -Uid <Int32>
   [-Name <String>]
   [-DesktopGroupUid <Int32>]
   [-ManagementServer <String>]
   [-PublishingServer <String>]
   [-Username <String>]
   [-Password <SecureString>]
   [-AutomateDiscovery <Boolean>]
   [-AutoDiscoveryPeriod <String>]
   [-AutoDiscoveryCadence <Int32>]
   [-CleanupAbsentPackages <Boolean>]
   [-InplaceUpgrade <Boolean>]
   [-IgnoreDowngrade <Boolean>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-AppLibPackageDiscoveryProfile
   -Uid <Int32>
   [-Name <String>]
   [-DesktopGroupUid <Int32>]
   [-CloudpagerConsoleUrl <String>]
   [-CloudpagerSubscriptionKey <String>]
   [-CloudpagerMsid <Guid>]
   [-AutomateDiscovery <Boolean>]
   [-AutoDiscoveryPeriod <String>]
   [-AutoDiscoveryCadence <Int32>]
   [-CleanupAbsentPackages <Boolean>]
   [-InplaceUpgrade <Boolean>]
   [-IgnoreDowngrade <Boolean>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-AppLibPackageDiscoveryProfile
   -Uid <Int32>
   [-Name <String>]
   [-DesktopGroupUid <Int32>]
   -Path <String>
   [-Recurse <Boolean>]
   [-DiscoverAppV <Boolean>]
   [-DiscoverMsix <Boolean>]
   [-DiscoverAppAttach <Boolean>]
   [-DiscoverFlexApp <Boolean>]
   [-DiscoverElasticAppLayers <Boolean>]
   [-DiscoverCloudpaging <Boolean>]
   [-AutomateDiscovery <Boolean>]
   [-AutoDiscoveryPeriod <String>]
   [-AutoDiscoveryCadence <Int32>]
   [-CleanupAbsentPackages <Boolean>]
   [-InplaceUpgrade <Boolean>]
   [-IgnoreDowngrade <Boolean>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

A package discovery can be used by the AppLibrary Service to automatically (or periodically) search for application packages to import into the AppLibrary

Examples

EXAMPLE 1

Updates the package discovery profile with a Uid of 1 with the supplied values

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

EXAMPLE 2

Updates the package discovery profile by changing the properties on the object and passing it to the pipeline

$PackageDiscoveryProfile = Get-PackageDiscoveryProfile -Uid 1
$PackageDiscoveryProfile.AutoDiscoveryPeriod = "Hour"
$PackageDiscoveryProfile.AutoDiscoveryCadence "6"
$PackageDiscoveryProfile | Set-PackageDiscoveryProfile
<!--NeedCopy-->

Parameters

-Uid

The Uid of the package discovery profile that will be updated with the new details

Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
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: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 0 to 250

-Name

The name of the package discovery profile

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

-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: False
Accept pipeline input: True (ByPropertyName)
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: True (ByPropertyName)
Accept wildcard characters: False

-DiscoverAppV

A value indicating whether the discovery will include App-V packages

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

-DiscoverMsix

A value indicating whether the discovery will include Msix packages

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

-DiscoverAppAttach

A value indicating whether the discovery will include AppAttach packages

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

-DiscoverFlexApp

A value indicating whether the discovery will include FlexApp packages

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2311

-DiscoverElasticAppLayers

A value indicating whether the discovery will include Elastic App Layer packages

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

-DiscoverCloudpaging

A value indicating whether the discovery will include Numecent Cloudpaging packages

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

-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: True (ByPropertyName)
Accept wildcard characters: False

-AutoDiscoveryPeriod

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

Type: String
Accepted values: None, Hour, Day, Week
Position: Named
Default value: Day
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AutoDiscoveryCadence

The number of periods that should elapse between discovery sessions

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: True (ByPropertyName)
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: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2212

-InplaceUpgrade

Gets or sets a value indicating whether the discovery should update existing packages with the new information when the version is higher

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2603

-IgnoreDowngrade

Gets or sets a value indicating whether the discovery should ignore packages where the version is lower than one that already exists

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2603

-ManagementServer

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

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 0 to 250

-PublishingServer

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

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 0 to 250

-Username

The username of the App-V server administrator

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

-Password

The password of the App-V server administrator

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

-CloudpagerConsoleUrl

The Url of the Cloudpager console from which packages will be discovered

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

-CloudpagerSubscriptionKey

The Cloudpager PowerShell API key that will be used to query the console

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

-CloudpagerMsid

The Cloudpager MSID used to interact with the Cloudpager Player on the VDA

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

-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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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.

Set-AppLibPackageDiscoveryProfile