Product Documentation

Get-LogHighLevelOperation

Nov 06, 2015

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>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

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

Parameters

-Id<Guid>

Gets the high level operation with the specified identifier.

Required? false
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-Text<String>

Gets high level operations with the specified text

Required? false
Default Value  
Accept Pipeline Input? false

-StartTime<DateTime>

Gets high level operations with the specified start time

Required? false
Default Value  
Accept Pipeline Input? false

-Source<String>

Gets high level operations with the specified source.

Required? false
Default Value  
Accept Pipeline Input? false

-EndTime<DateTime>

Gets high level operations with the specified end time.

Required? false
Default Value  
Accept Pipeline Input? false

-IsSuccessful<Boolean>

Gets high level operations with the specified success indicator.

Required? false
Default Value  
Accept Pipeline Input? false

-User<String>

Gets high level operations logged by the specified user.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminMachineIP<String>

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

Required? false
Default Value  
Accept Pipeline Input? false

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

Required? false
Default Value  
Accept Pipeline Input? false

-TargetType<String>

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

Required? false
Default Value  
Accept Pipeline Input? false

-ReturnTotalRecordCount<SwitchParameter>

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.

Required? false
Default Value False
Accept Pipeline Input? false

-MaxRecordCount<Int32>

Specifies the maximum number of records to return.

Required? false
Default Value 250
Accept Pipeline Input? false

-Skip<Int32>

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

Required? false
Default Value 0
Accept Pipeline Input? false

-SortBy<String>

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.

Required? false
Default Value The default sort order is by name or unique identifier.
Accept Pipeline Input? false

-Filter<String>

Gets records that match a PowerShell-style filter expression. See about_Log_Filtering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

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.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

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

Get all high level operations

-------------------------- EXAMPLE 2 --------------------------

C:\PS> Get-LogHighLevelOperation -OperationType ConfigurationChange

Get high level operations which log configuration changes.

-------------------------- EXAMPLE 3 --------------------------

C:\PS> Get-LogHighLevelOperation -OperationType AdminActivity

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"}

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

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

-------------------------- EXAMPLE 6 --------------------------

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

Get high level operations performed by user "DOMAIN\UserName".