Citrix Virtual Apps and Desktops SDK

Get-LogLowLevelOperationDetails

Introduced in: Citrix Virtual Apps and Desktop 7 2603

Gets operation details

Syntax

Get-LogLowLevelOperationDetails
   [-Id <String>]
   [-OperationId <Int32>]
   [-TargetObjectUid <String>]
   [-TargetObjectName <String>]
   [-TargetObjectType <String>]
   [-Text <String>]
   [-NewValue <String>]
   [-PreviousValue <String>]
   [-AddValue <String>]
   [-RemoveValue <String>]
   [-StartTime <DateTime>]
   [-EndTime <DateTime>]
   [-IsSuccessful <Boolean>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieves operation details matching the specified criteria. If no parameters are specified this cmdlet returns all operation details.

Examples

EXAMPLE 1

Get all operation details

Get-LogLowLevelOperationDetails
<!--NeedCopy-->

EXAMPLE 2

Use advanced filtering to get operation details 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-LogLowLevelOperationDetails -Filter{ StartTime -ge "2013-02-27 09:00:00" -and EndTime -le "2013-02-27 18:00:00"}
<!--NeedCopy-->

EXAMPLE 3

Either of these commands will get operation details which have not yet been completed.

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

Parameters

-Id

Gets operation details with the specified identifier.

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

-OperationId

Gets the operation details of the low level operation with this integer id.

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

-TargetObjectUid

Gets operation details which relate to operations where specified object UID indicates the target of the operation. The target UID describes the unique identifier of the object that was the target of the configuration change. For example, a machine’s unique identifier.

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

-TargetObjectName

Gets operation details which relate to operations where specified object Name indicates the target of the operation. The target Object name describes name of the object that was the target of the configuration change. For example, a machine’s name.

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

-TargetObjectType

Gets operation details which relate to operations where specified object type indicates the target of the operation. 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

-Text

Gets operation details with the specified text.

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

-NewValue

Gets operation details which have operation details with the specified new value.

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

-PreviousValue

Gets operation details which have operation details with the specified previous value.

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

-AddValue

Gets operation details which have operation details with the specified add value.

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

-RemoveValue

Gets operation details which have operation details with the specified remove value.

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

-StartTime

Gets operation details with the specified start time.

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

-EndTime

Gets operation details with the specified end time.

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

-IsSuccessful

Gets operation details with the specified success indicator.

Type: Boolean
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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
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.OperationDetail

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

  • Id - The unique identifier of the operation detail.
  • OperationId - The integer id of the low level operation.
  • 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-LogLowLevelOperationDetails