Citrix Virtual Apps and Desktops SDK

Export-LogReportHtml

March 11, 2024

Contributed by:

Exports Configuration Logging data into a HTML report.

Syntax

Export-LogReportHtml [-OutputDirectory <String>] [-RawReport] [-StartDateRange <DateTime>] [-EndDateRange <DateTime>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

This cmdlet exports the Configuration Logging data into a HTML report. The report consists of two HTML files:

Summary.Html - this shows summary information from the high level operation logs.
Details.Html - this shows additional logging data from the low level operation and operation detail logs. Hyperlinks in summary.html allow drill-down into the associated low level logging data contained within details.html.

Export-LogReportCsv

Parameters

Name	Description	Required?	Pipeline Input	Default Value
OutputDirectory	Specifies the path to a directory where the HTML report files will will be saved.	false	false
RawReport	Get a HTML raw string report without saving it to a file.	false	false
StartDateRange	Specifies the start time of the earliest operation to include.	false	false	DateTime.Min
EndDateRange	Specifies the end time of the latest operation to include.	false	false	DateTime.UtcNow
BearerToken	Specifies the bearer token assigned to the calling user.	false	false
AdminClientIP	Specifies the Client IP of the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site id the PowerShell snap-in will connect to.	false	false
AdminAddress	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.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Examples

Example 1

C:\PS> Export-LogReportHtml -OutputDirectory "c:\MyReports"

<!--NeedCopy-->

Description

Export all logged operations to HTML.

Example 2

C:\PS> Export-LogReportHtml -OutputDirectory "c:\MyReports" -StartDateRange "2012-12-21 09:00"

<!--NeedCopy-->

Description

Export to a HTML logged operations started on or after a specified datetime..

Example 3

C:\PS> Export-LogReportHtml -OutputDirectory "c:\MyReports" -StartDateRange "2012-12-21 09:00" -EndDateRange "2012-12-311 18:00"

<!--NeedCopy-->

Description

Export to HTML logged operations started and completed between a date range.

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

Export-LogReportHtml

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Export-LogReportHtml

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Examples

Example 1

Description

Example 2

Description

Example 3

Description

In this article