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-LogLowLevelOperation

August 9, 2024
Contributed by: 
C

Gets low level operations

Syntax

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

Description

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

Examples

EXAMPLE 1

Get all low level operations

Get-LogLowLevelOperation
<!--NeedCopy-->

EXAMPLE 2

Get low level operations which log configuration changes.

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

EXAMPLE 3

Get low level operations which log administration activities.

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

EXAMPLE 4

Use advanced filtering to get low 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-LogLowLevelOperation -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 low level operations which have not yet been completed.

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

EXAMPLE 6

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

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

Parameters

-Id

Gets the low level operation with the specified identifier.

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

-HighLevelOperationId

Gets low level operations for the high level operation with the specified identifier.

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

-StartTime

Gets low level operations with the specified start time

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

-EndTime

Gets low 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 low 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 low level operations logged by the specified administrator.

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

-AdminMachineIP

Gets low 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

-Text

Gets low level operations with the specified text

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

-Source

Gets low level operations with the specified source.

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

-SourceSdk

Gets low level operations logged from the SDK with the specified identifier.

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

-OperationType

Gets low 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 low 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

-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
Introduced in: Citrix Virtual Apps and Desktop 7 2106

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

The returned LowLevelOperation object has the following properties:

  • Id - The unique identifier of the operation.
  • Text - A description of the operation.

  • HighLevelOperationId - The unique identifier of the related

    high level 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.

  • AdminSid - The identifier of the administrator who performed

    the operation.

  • AdminMachineIP - The IP address of the machine that the

    operation was performed on.

  • Source - The name of the XenDesktop service that the

    operation was performed on; for example, “MachineCreation”, “DelegatedAdmin”.

  • SourceSdk - The identifier of the XenDesktop service SDK

    through which the operation was performed; for example, “Prov”, “Admin”.

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

  • Details - A collection of OperationDetail objects containing

    specific information about each object affected by the operation.

Each OperationDetail object in the ‘Details’ collection has the following properties:

  • TargetUid - The unique identifier of the target object affected

    by the operation.

  • TargetName - The name of the target object affected by the

    operation.

  • TargetType - The type of the target object.
  • Text - The description of operation performed on the target object.
  • 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 didn’t complete.

The following properties will be set if the operation changed a property on the object:

  • PropertyName - The name of the changed property.
  • NewValue - The new property value.
  • PreviousValue - The previous property value.

  • AddValue - If the object property contains a set of values,

    this specifies the new value which was added to the set.

  • RemoveValue- If the object property contains a set of values,

    this specifies the value which was removed from the set.

Get-LogLowLevelOperation
August 9, 2024
Contributed by: 
C
August 9, 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.