Citrix Virtual Apps and Desktops SDK

Start-LogHighLevelOperation

March 11, 2024

Contributed by:

Logs the start of a high level operation.

Syntax

Start-LogHighLevelOperation -Text <String> -Source <String> [-StartTime <DateTime>] [-OperationType <OperationType>] [-TargetTypes <String[]>] [-Parameters <Hashtable>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Start-LogHighLevelOperation creates a log entry to record the start of a high level operation.

Start-LogHighLevelOperation can be called to log high level configuration changes which originate from customized configuration scripts. Start-LogHighLevelOperation should be called before the script invokes service SDK cmdlets which execute the configuration changes.

Start-LogHighLevelOperation returns a HighLevelOperation object which contains information about the started high level operation. The “Id” property of the returned HighLevelOperation uniquely identifies the started high level operation. This can be supplied into the “-LoggingId” parameter which is implemented in all service SDK cmdlets which execute loggable configuration changes.

High level operation logs are automatically created by the XenDesktop consoles when:

Initiating an operation which performs configuration changes.
Initiating an operation which performs an administration activity. Configuration Change and Administrator Activity ———————————————– A configuration change is an operation which alters the configuration of the XenDesktop site. Examples of a configuration changes include:
Creating or editing a host.
Creating or editing a catalog.
Adding a user to a delivery group.
Deleting a machine. An administrator activity operation doesn’t directly alter site configuration, but it could be an operation carried out by an administrator as part of site management or helpdesk support. Examples of administrator activities include:
Shutdown/start/restart of a user desktop.
Studio or Director sending a message to a user.
Rebooting a user’s desktop. Once the change being logged has completed (whether successfully or not) the Stop-LogHighLevelOperation cmdlet should be called to log the completion of a started high level operation.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Text	Specifies text to describe the high level operation.	true	false
Source	Specifies the source of the high level operation.	true	false
StartTime	Specifies the start time of the high level operation.	false	false	DateTime.UtcNow
OperationType	Specifies the type of operation being logged. Values can be

Input Type

Return Values

Citrix.Configurationlogging.Sdk.Highleveloperation

The newly logged high level operation start.

Examples

Example 1

C:\PS> $succeeded = $false #indicates if high level operation succeeded.

C:\PS> # Log high level operation start.

C:\PS> $highLevelOp = Start-LogHighLevelOperation -Text "Create catalog" -Source "My Custom Script"

C:\PS>

C:\PS> try

C:\PS> {

C:\PS>   # Create catalog object

C:\PS>   $catalog = New-BrokerCatalog -Name "MyCatalog" -ProvisioningType Manual -AllocationType Permanent -MinimumFunctionalLevel 'LMAX' -LoggingId $highLevelOp.Id

C:\PS>

C:\PS>   # Add a machine to the catalog

C:\PS>   $machine = New-BrokerMachine -CatalogUid $catalog.Uid -MachineName "DOMAIN\Machine" -LoggingId $highLevelOp.Id

C:\PS>   $succeeded = $true

C:\PS> }

C:\PS> catch{ "Error encountered" }

C:\PS>

C:\PS> finally{

C:\PS>   # Log high level operation stop, and indicate its success

C:\PS>   Stop-LogHighLevelOperation -HighLevelOperationId $highLevelOp.Id -IsSuccessful $succeeded

C:\PS> }

<!--NeedCopy-->

Description

Creates an unmanaged catalog and assigns a machine to it, within the scope of a high level operation start and stop. The identifier of the high level operation is passed into the “-LoggingId” parameter of the service SDK cmdlets. The execution of the cmdlets in the services will create the low level operation logs for the supplied high level operation.

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

Start-LogHighLevelOperation

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Start-LogHighLevelOperation

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Configurationlogging.Sdk.Highleveloperation

Examples

Example 1

Description

In this article