Product Documentation

Remove-LogOperation

Sep 29, 2015

Deletes configuration logs

Syntax

Remove-LogOperation -DatabaseCredentials <PSCredential> [-StartDateRange <DateTime>] [-EndDateRange <DateTime>] [-IncludeIncomplete] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Remove-LogOperation -UserName <String> -SecurePassword <SecureString> [-StartDateRange <DateTime>] [-EndDateRange <DateTime>] [-IncludeIncomplete] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Remove-LogOperation -UserName <String> [-Password <String>] [-StartDateRange <DateTime>] [-EndDateRange <DateTime>] [-IncludeIncomplete] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Remove-LogOperation deletes logs from the Configuration Logging database. This cmdlet targets high level operation logs for deletion. The associated low level operations logs are deleted as part of this operation via cascade deletion functionality present in the configuration logging database schema.

Related topics

Parameters

-DatabaseCredentials<PSCredential>

Specifies the credentials of a database user with permission to delete records from the Configuration Logging database.

Required? true
Default Value  
Accept Pipeline Input? false

-UserName<String>

Specifies the user name of a database user with permission to delete records from the Configuration Logging database.

Required? true
Default Value  
Accept Pipeline Input? false

-SecurePassword<SecureString>

Specifies the password a database user, in secure string form, with permission to delete records from the Configuration Logging database.

Required? true
Default Value  
Accept Pipeline Input? false

-Password<String>

Specifies the password of a database user with permission to delete records from the Configuration Logging database.

Required? false
Default Value  
Accept Pipeline Input? false

-StartDateRange<DateTime>

Specifies the start time of the earliest high level operation to delete

Required? false
Default Value DateTime.Min
Accept Pipeline Input? false

-EndDateRange<DateTime>

Specifies the end time of the latest high level operation to delete

Required? false
Default Value DateTime.UtcNow
Accept Pipeline Input? false

-IncludeIncomplete<SwitchParameter>

Specifies if incomplete high level operations should be deleted.

Required? false
Default Value  
Accept Pipeline Input? false

-LoggingId<Guid>

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Remove-LogOperation  -UserName "DOMAIN\User"  -Password "UserPassword"

Remove all completed operation logs

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

C:\PS> Remove-LogOperation  -UserName "DOMAIN\User"  -Password "UserPassword" -IncludeIncomplete

Remove all operations

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

C:\PS> Remove-LogOperation -username "domain\userName" -password "password" -StartDateRange "2013-01-01 12:00:00"  -EndDateRange "2013-01-31 12:00:00"

Delete logs started on or after "2013-01-01 12:00:00" and completed on or before "2013-01-31 12:00:00"

-------------------------- EXAMPLE 4 --------------------------

C:\PS> $securePassword = ConvertTo-SecureString -String "UserPassword" -AsPlainText -Force 
C:\PS> $credentials    = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList "DOMAIN\UserName", $securePassword 
C:\PS> Remove-LogOperation -StartDateRange -DatabaseCredentials $credentials

Delete logs by supplying database user credentials via a credentials object.