-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
Start-LogHighLevelOperation
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Start-LogHighLevelOperation
Logs the start of a high level operation.
Syntax
Start-LogHighLevelOperation
[-StartTime <DateTime>]
-Text <String>
-Source <String>
[-OperationType <OperationType>]
[-TargetTypes <String[]>]
[-Parameters <Hashtable>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
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.
Examples
EXAMPLE 1
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.
$succeeded = $false #indicates if high level operation succeeded.
# Log high level operation start.
$highLevelOp = Start-LogHighLevelOperation -Text "Create catalog" -Source "My Custom Script"
try
{
# Create catalog object
$catalog = New-BrokerCatalog -Name "MyCatalog" -ProvisioningType Manual -AllocationType Permanent -MinimumFunctionalLevel 'LMAX' -LoggingId $highLevelOp.Id
# Add a machine to the catalog
$machine = New-BrokerMachine -CatalogUid $catalog.Uid -MachineName "DOMAIN\Machine" -LoggingId $highLevelOp.Id
$succeeded = $true
}
catch{ "Error encountered" }
finally{
# Log high level operation stop, and indicate its success
Stop-LogHighLevelOperation -HighLevelOperationId $highLevelOp.Id -IsSuccessful $succeeded
}
<!--NeedCopy-->
Parameters
-Text
Specifies text to describe the high level operation.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Source
Specifies the source of the high level operation.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StartTime
Specifies the start time of the high level operation.
Type: | DateTime |
Position: | Named |
Default value: | DateTime.UtcNow |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OperationType
Specifies the type of operation being logged. Values can be:
- AdminActivity - If the operation being logged performs an administration activity.
- ConfigurationChange - If the operation being logged performs a configuration change.
Type: | OperationType |
Position: | Named |
Default value: | ConfigurationChange |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TargetTypes
Specifies the names of the object types that will be affected
by the operation being logged.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Parameters
Specifies the names and values of parameters that are supplied to the operation being logged.
Type: | Hashtable |
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.HighLevelOperation
The newly logged high level operation start.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.