Citrix Daas SDK

Get-ProvOperationEvent

Gets a list of MCS operation events.

Syntax

Get-ProvOperationEvent
   [-EventRecordId <Int64>]
   [-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>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Allows you to retrieve the list of MCS operation events.

Examples

EXAMPLE 1

Returns the operation event with a record ID of 42.

Get-ProvOperationEvent -EventRecordId 42
<!--NeedCopy-->

EXAMPLE 2

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

Get-ProvOperationEvent -LinkedObjectType ProvisioningScheme -LinkedObjectUid 93f2c1b3-3015-4d63-92fe-678f1523b4de
<!--NeedCopy-->

Parameters

-EventRecordId

The record id of the operation event to retrieve.

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

-EventCategory

The category of the operation event to retrieve.

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

-EventSeverity

The severity of the operation event to retrieve.

Type: String
Accepted values: Critical, Important, Significant, Urgent
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EventSource

The source of the operation event to retrieve.

Type: String
Accepted values: AwsEc2Plugin, AzureRmPlugin, GcpPlugin, Mcs
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OperationType

The type of the operation event to retrieve.

Type: String
Accepted values: ConfigurationManagement, ImageManagement, None, PowerManagement, PreflightCheck, ProvisioningSchemeManagement, ProvisioningVmManagement, ResourceManagement
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OperationTargetType

The target type of the operation event to retrieve.

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

-LinkedObjectType

The type of the linked object to get the operation events of.

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

-LinkedObjectUid

The unique identifier of the linked object to get the operation events of.

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

-Locale

The locale to get the operation event message and recommendation of.

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

-ReturnTotalRecordCount

See about_Prov_Filtering for details.

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

-MaxRecordCount

See about_Prov_Filtering for details.

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

-Skip

See about_Prov_Filtering for details.

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

-SortBy

See about_Prov_Filtering for details.

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

-Filter

See about_Prov_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

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.MachineCreation.Sdk.OperationEvent

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

EventRecordId <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.

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.

Get-ProvOperationEvent