Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912

Export-LogReportHtml

August 9, 2024
Contributed by: 
C

Exports Configuration Logging data into a HTML report.

Syntax

Export-LogReportHtml
      [-OutputDirectory <String>]
      [-RawReport]
      [-StartDateRange <DateTime>]
      [-EndDateRange <DateTime>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

This cmdlet exports the Configuration Logging data into a HTML report.

When using cmdlets from Citrix Virtual Apps and Desktop 7 2407 or later the produced files include a timestamp, of the format yyyy-MM-dd_HH-mm-ss in the file name:

  • Summary-2024-04-28_01-14-56.html - this shows summary information from the high level operation logs.
  • Details-2024-04-28_01-14-56.html - this shows additional logging data from the low level operation and operation detail logs.

Cmdlets from Citrix Virtual Apps and Desktop 7 2402 and earlier will produce files called:

  • 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 the summary html allow drill-down into the associated low level logging data contained within details html.

Examples

EXAMPLE 1

Export all logged operations to HTML.

Export-LogReportHtml -OutputDirectory "c:\MyReports"
<!--NeedCopy-->

EXAMPLE 2

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

Export-LogReportHtml -OutputDirectory "C:\MyReports" -StartDateRange "2023-12-21 09:00"
<!--NeedCopy-->

EXAMPLE 3

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

Export-LogReportHtml -OutputDirectory "C:\MyReports" -StartDateRange "2023-12-21 09:00" -EndDateRange "2023-12-311 18:00"
<!--NeedCopy-->

Parameters

-OutputDirectory

Specifies the path to a directory where the HTML report files will will be saved.

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

-RawReport

Get a HTML raw string report without saving it to a file.

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

-StartDateRange

Specifies the start time of the earliest operation to include.

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 operation to include.

Type: DateTime
Position: Named
Default value: DateTime.UtcNow
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.

Export-LogReportHtml
August 9, 2024
Contributed by: 
C
August 9, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.