Citrix Virtual Apps and Desktops SDK

Get-LogHighLevelOperation

March 11, 2024

Contributed by:

Gets high level operations

Syntax

Get-LogHighLevelOperation
   [-Id <Guid>]
   [-Text <String>]
   [-StartTime <DateTime>]
   [-Source <String>]
   [-EndTime <DateTime>]
   [-IsSuccessful <Boolean>]
   [-User <String>]
   [-AdminMachineIP <String>]
   [-OperationType <OperationType>]
   [-TargetType <String>]
   [-Metadata <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieves high level operations matching the specified criteria. If no parameters are specified this cmdlet returns all high level operations.

Examples

EXAMPLE 1

Get all high level operations

Get-LogHighLevelOperation
<!--NeedCopy-->

EXAMPLE 2

Get high level operations which log configuration changes.

Get-LogHighLevelOperation -OperationType ConfigurationChange
<!--NeedCopy-->

EXAMPLE 3

Get high level operations which log administration activities.

Get-LogHighLevelOperation -OperationType AdminActivity
<!--NeedCopy-->

EXAMPLE 4

Use advanced filtering to get high level operations with a start time on or after “2013-02-27 09:00:00” and an end time on or before “2013-02-27 18:00:00”.

Get-LogHighLevelOperation -Filter{ StartTime -ge "2013-02-27 09:00:00" -and EndTime -le "2013-02-27 18:00:00"}
<!--NeedCopy-->

EXAMPLE 5

Either of these commands will get high level operations which have not yet been completed.

Get-LogHighLevelOperation -EndTime $null
Get-LogHighLevelOperation -IsSuccessful $null
<!--NeedCopy-->

EXAMPLE 6

Get high level operations performed by user “DOMAIN\UserName”.

Get-LogHighLevelOperation -User "DOMAIN\UserName"
<!--NeedCopy-->

Parameters

-Id

Gets the high level operation with the specified identifier.

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

-Text

Gets high level operations with the specified text

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

-StartTime

Gets high level operations with the specified start time

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

-Source

Gets high level operations with the specified source.

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

-EndTime

Gets high level operations with the specified end time.

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

-IsSuccessful

Gets high level operations with the specified success indicator.

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

-User

Gets high level operations logged by the specified user.

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

-AdminMachineIP

Gets high level operations logged from the machine with the specified IP address.

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

-OperationType

Gets high level operations with the specified operation type. Values can be:

AdminActivity - to get operations which log administration activity.
ConfigurationChange - to get operations which log configuration changes.

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

-TargetType

Gets high level operations with the specified target type.

The target type describes the type of object that was the target of the

configuration change. For example, “Session” or “Machine”.

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

-Metadata

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.

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

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

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

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Log_Filtering for details.

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

-MaxRecordCount

Specifies the maximum number of records to return.

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

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

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

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type:	String
Position:	Named
Default value:	The default sort order is by name or unique identifier.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

Gets records that match a PowerShell-style filter expression. See about_Log_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.ConfigurationLogging.Sdk.HighLevelOperation

The returned HighLevelOperation object has the following properties:

Id - The unique identifier of the operation.
Text - A description of the operation.
StartTime - The date and time that the operation started.
EndTime - The date and time that the operation completed. This

will be null if the operation is still in progress, or if the operation never completed.
IsSuccessful - Indicates whether the operation completed

successfully or not. This will be null if the operation is still in progress, or if the operation never completed.
User - The identifier of the administrator who performed

the operation.
AdminMachineIP - The IP address of the machine that the

operation was initiated from.
Source - Identifies the XenDesktop console, or custom script,

where the operation was initiated from. For example, “Studio”, “Desktop Director”, “My custom script”.
OperationType - The operation type. This can be ‘AdminActivity’

or ‘ConfigurationChange’.
TargetTypes - Identifies the type of objects that were

affected by the operation. For example, “Catalog” or “Desktop”,”Machine”.
Parameters - The names and values of the parameters

that were supplied for the operation.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-LogHighLevelOperation

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Get-LogHighLevelOperation

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

EXAMPLE 5

EXAMPLE 6

Parameters

-Id

-Text

-StartTime

-Source

-EndTime

-IsSuccessful

-User

-AdminMachineIP

-OperationType

-TargetType

-Metadata

-Property

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.ConfigurationLogging.Sdk.HighLevelOperation

Related Links

In this article