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

Get-LogHighLevelOperation

March 11, 2024
Contributed by: 
C

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>] [-Property <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

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

Parameters

Name Description Required? Pipeline Input Default Value
Id Gets the high level operation with the specified identifier. false true (ByPropertyName)  
Text Gets high level operations with the specified text false false  
StartTime Gets high level operations with the specified start time false false  
Source Gets high level operations with the specified source. false false  
EndTime Gets high level operations with the specified end time. false false  
IsSuccessful Gets high level operations with the specified success indicator. false false  
User Gets high level operations logged by the specified user. false false  
AdminMachineIP Gets high level operations logged from the machine with the specified IP address. false false  
OperationType Gets high level operations with the specified operation type. Values can be      

o AdminActivity - to get operations which log administration activity. o ConfigurationChange - to get operations which log configuration changes. | false | 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". | false | 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. | false | 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](/en-us/citrix-virtual-apps-desktops-sdk/2305/ConfigLogging/about_Log_Filtering.html) for details. | false | false | False | | MaxRecordCount | Specifies the maximum number of records to return. | false | false | 250 | | Skip | Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. | false | false | 0 | | 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. | false | false | The default sort order is by name or unique identifier. | | Filter | Gets records that match a PowerShell-style filter expression. See [about_Log_Filtering](/en-us/citrix-virtual-apps-desktops-sdk/2305/ConfigLogging/about_Log_Filtering.html) 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 use | false | false | | | VirtualSiteId | Specifies the virtual site id the PowerShell snap-in will connect to. | false | false | | | AdminAddress | Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value becomes the default. |

Input Type

Return Values

Citrix.Configurationlogging.Sdk.Highleveloperation

The returned HighLevelOperation object has the following properties: o Id - The unique identifier of the operation. o Text - A description of the operation. o StartTime - The date and time that the operation started. o 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. o 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. o User - The identifier of the administrator who performed the operation. o AdminMachineIP - The IP address of the machine that the operation was initiated from. o Source - Identifies the XenDesktop console, or custom script, where the operation was initiated from. For example, “Desktop Studio”, “Desktop Director”, “My custom script”. o OperationType - The operation type. This can be ‘AdminActivity’ or ‘ConfigurationChange’. o TargetTypes - Identifies the type of objects that were affected by the operation. For example, “Catalog” or “Desktop”,”Machine”. o Parameters - The names and values of the parameters that were supplied for the operation.

Examples

Example 1 


C:\PS> Get-LogHighLevelOperation

<!--NeedCopy-->

Description

Get all high level operations

Example 2 


C:\PS> Get-LogHighLevelOperation -OperationType ConfigurationChange

<!--NeedCopy-->

Description

Get high level operations which log configuration changes.

Example 3 


C:\PS> Get-LogHighLevelOperation -OperationType AdminActivity

<!--NeedCopy-->

Description

Get high level operations which log administration activities.

Example 4 


C:\PS> Get-LogHighLevelOperation -Filter{ StartTime -ge "2013-02-27 09:00:00" -and EndTime -le "2013-02-27 18:00:00"}

<!--NeedCopy-->

Description

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

Example 5 


C:\PS> Get-LogHighLevelOperation -EndTime $null

C:\PS> Get-LogHighLevelOperation -IsSuccessful $null

<!--NeedCopy-->

Description

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

Example 6 


C:\PS> Get-LogHighLevelOperation -User "DOMAIN\UserName"

<!--NeedCopy-->

Description

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

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

In this article

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