Citrix Virtual Apps and Desktops SDK

Remove-LogOperation

August 9, 2024

Contributed by:

Deletes configuration logs

Syntax

Remove-LogOperation
      -DatabaseCredentials <PSCredential>
      [-StartDateRange <DateTime>]
      [-EndDateRange <DateTime>]
      [-IncludeIncomplete]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-LogOperation
      -SqlCredentials <PSCredential>
      [-StartDateRange <DateTime>]
      [-EndDateRange <DateTime>]
      [-IncludeIncomplete]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-LogOperation
      -SqlLogin <String>
      -SqlPassword <SecureString>
      [-StartDateRange <DateTime>]
      [-EndDateRange <DateTime>]
      [-IncludeIncomplete]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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

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

Description

Remove-LogOperation deletes logs from the Configuration Logging database. All high level operations within the specified time range are removed together with their associated low level operations.

Examples

EXAMPLE 1

Remove all completed operation logs

Remove-LogOperation  -UserName "DOMAIN\User"  -Password "UserPassword"
<!--NeedCopy-->

EXAMPLE 2

Remove all operations

Remove-LogOperation  -UserName "DOMAIN\User"  -Password "UserPassword" -IncludeIncomplete
<!--NeedCopy-->

EXAMPLE 3

Delete logs started on or after “2023-01-01 12:00:00” and completed on or before “2023-01-31 12:00:00”

Remove-LogOperation -username "domain\userName" -password "password" -StartDateRange "2023-01-01 12:00:00"  -EndDateRange "2023-01-31 12:00:00"
<!--NeedCopy-->

EXAMPLE 4

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

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

Parameters

-DatabaseCredentials

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

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

-UserName

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

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

-SecurePassword

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

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

-SqlCredentials

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

Type:	PSCredential
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2311

-SqlLogin

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2311

-SqlPassword

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

Type:	SecureString
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2311

-Password

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

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

-StartDateRange

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

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

-EndDateRange

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

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

-IncludeIncomplete

Specifies if incomplete high level operations should be deleted.

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

-LoggingId

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.

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

None

By default, this cmdlet returns no output.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Remove-LogOperation

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Remove-LogOperation

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

Parameters

-DatabaseCredentials

-UserName

-SecurePassword

-SqlCredentials

-SqlLogin

-SqlPassword

-Password

-StartDateRange

-EndDateRange

-IncludeIncomplete

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

None

Related Links

In this article