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

Get-ProvOperationEvent

March 11, 2024
Contributed by: 
C

Gets a list of MCS operation events.

Syntax


Get-ProvOperationEvent [-EventId <Int32>] [-EventCategory <String>] [-EventSeverity <String>] [-EventSource <String>] [-OperationType <String>] [-OperationTargetType <String>] [-LinkedObjectType <String>] [-LinkedObjectUid <Guid>] [-Locale <String>] [-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 MCS operation events.

Parameters

Name Description Required? Pipeline Input Default Value
EventId The id of the operation event to retrieve. false false  
EventCategory The category of the operation event to retrieve. false false  
EventSeverity The severity of the operation event to retrieve. false false  
EventSource The source of the operation event to retrieve. false false  
OperationType The type of the operation event to retrieve. false false  
OperationTargetType The target type of the operation event to retrieve. false false  
LinkedObjectType The type of the linked object to get the operation events of. false false  
LinkedObjectUid The unique identifier of the linked object to get the operation events of. false false  
Locale The locale to get the operation event message and recommendation of. 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.Operationevent

This object provides details of the operation event and contains the following information:

  • EventId <int> The unique identifier of this operation event.

  • LinkedObjectUid <Guid> The unique identifier for the linked resource this operation event is associated with.

  • LinkedObjectType <string> The type of the linked resource (e.g. ProvisioningScheme) this operation event is associated with.

  • EventCategory <string> The category of this operation event.

  • EventSeverity <string> The severity of this operation event.

  • EventSource <string> The source of this operation event.

  • EventState <string> The state of this operation event.

  • EventMessage <string> The description of this operation event.

  • EventDateTime <DateTime> The date and time this operation event was created (UTC).

  • EventAdditionalData <string> Optional, additional data related to this operation event.

  • OperationType <string> The description of this operation event.

  • OperationName <string> The description of this operation event.

  • OperationTargetType <string> The description of this operation event.

  • OperationTargetName <string> The description of this operation event.

  • Recommendation <string> Optional, the recommended action of this operation event.

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-ProvOperationEvent -EventId 42

<!--NeedCopy-->

Description

Returns the operation event with a Id of 42.

Example 2 


C:\PS>Get-ProvOperationEvent -LinkedObjectType ProvisioningScheme -LinkedObjectUid 93f2c1b3-3015-4d63-92fe-678f1523b4de

<!--NeedCopy-->

Description

Returns the operation events for provisioning scheme with ID 93f2c1b3-3015-4d63-92fe-678f1523b4de.

Get-ProvOperationEvent
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

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