Citrix Virtual Apps and Desktops SDK

Get-ProvSchemeWarning

Gets a list of provisioning schemes warnings.

Syntax


Get-ProvSchemeWarning [-ProvisioningSchemeUid <Guid>] [-ProvisioningSchemeName <String>] [-WarningId <Int32>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Allows you to retrieve the list of provisioning scheme warnings.

Parameters

Name Description Required? Pipeline Input Default Value
ProvisioningSchemeUid The unique identifier of the provisioning scheme to get the warnings of. false false  
ProvisioningSchemeName The name of the provisioning scheme to get the warnings of. false false  
WarningId The id of the warning to retrieve. false false  
ReturnTotalRecordCount See about_Prov_Filtering for details. false false false
MaxRecordCount See about_Prov_Filtering for details. false false false
Skip See about_Prov_Filtering for details. false false 0
SortBy See about_Prov_Filtering for details. false false  
Filter See about_Prov_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. 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 user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller that the PowerShell snap-in connects to. You can provide this as a host name or an IP address. false false LocalHost. When a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Citrix.Machinecreation.Sdk.Provwarning

This object provides details of the provisioning scheme warning and contains the following information:

  • WarningId <int> The Unique identifier of this warning.

  • ProvisioningSchemeUid <Guid> The unique identifier for this provisioning scheme this warning is associated with.

  • ProvisioningSchemeName <Guid> The name for this provisioning scheme this warning is associated with.

  • WarningMessage <string[]> The warning description.

  • RecommendedAction <string> The optional recommended action to take to help resolve the warning.

  • AdditionalData <string> Optional, additional data related to the warning.

  • WarningStateType <string> The warning state of this provisioning scheme warning, either New or Acknowledged.

  • OperationName <string> The operation which triggered the warning.

  • WarningReportingDateTime <DateTime> The date and time the warning was created (UTC).

Notes

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

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.

Examples

Example 1


C:\PS>Get-ProvSchemeWarning -WarningId 42

                  ProvisioningSchemeName       : CatalogWindows11AWS

                  ProvisioningSchemeUid        : 7585f0de-192e-4847-a6d8-22713c3a2f42

                  WarningId                    : 42

                  WarningMessage               : Deprecated custom attribute

                  RecommendedAction            : Remove obsolete custom attribute

                  AdditionalData               : AwsCaptureInstanceProperties is now deprecated

                  WarningStateType             : New

                  OperationName                : New-ProvScheme

                  WarningReportingDateTime     : 17/05/2022 09:27:50

<!--NeedCopy-->

Description

Returns the warning with a warning Id of 42.

Get-ProvSchemeWarning