Citrix Daas SDK

Set-ProvRecommendation

Sets the State and RemindIn of a list of recommendations.

Syntax

Set-ProvRecommendation
   -RecommendationIds <Guid[]>
   [-RecommendationState <String>]
   [-Reason <String>]
   [-RemindInDateTimeInUTC <DateTime>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Allows you to set the RecommendationState from New to Dismiss or Accept and also set a reminder datetime.

Examples

EXAMPLE 1

Sets the State, Reason and RemindInDateTimeInUTC for given recommendation(s).

$reminder = [DateTime]::UtcNow.AddMinutes(10)
Set-ProvRecommendation -RecommedationIds @("Guid1", "Guid2") -RecommedationState Dismiss -RemindInDateTimeInUTC $reminder -Reason "Not applicable"
<!--NeedCopy-->

Parameters

-RecommendationIds

The id(s) of the recommendations to be updated.

Type: Guid[]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-RecommendationState

The state of the recommendations - Dismiss or Accept.

Type: String
Accepted values: Accept, Dismiss
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Reason

The reason why you want to dismiss the recommendation.

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

-RemindInDateTimeInUTC

The datetime by when you would be reminded of this recommendation.

Type: DateTime
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

In the case of failure, the following errors can result.

Error Codes


PartialData Only a subset of the available data was returned

CouldNotQueryDatabase The query to get the database was not defined.

PermissionDenied The user does not have administrative rights to perform this operation.

ConfigurationLoggingError The operation could not be performed because of a configuration logging error.

CommunicationError An error occurred while communicating with the service.

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

InvalidFilter A filtering expression was supplied that could not be interpreted for this cmdlet.

ExceptionThrown An unexpected error occurred. For more details, see the Windows event logs on the controller being used, or Citrix Virtual Apps and Desktops logs.

Set-ProvRecommendation