Citrix Virtual Apps and Desktops SDK

New-MonitorLhcReports

Introduced in: Citrix Virtual Apps and Desktop 7 2311

Returns a boolean

Syntax

New-MonitorLhcReports
   -EndDate <DateTime>
   -Duration <Single>
   -MachineInZoneCount <Int32>
   -MachineRegisteredCount <Int32>
   -ReconnectedSessionCount <Int32>
   -SessionBrokeredCount <Int32>
   -ZoneName <String>
   -ControllerName <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Returns a boolean stating whether a new lhc report was added or not

Examples

EXAMPLE 1

Inserts multiple attributes into LhcReport after the cloud connector outage is over

New-MonitorLhcReports -Duration 120 -EndDate 2023-09-05T09:13:39.1835337Z -MachineInZoneCount 1 -MachineRegisteredCount 2 -SessionBrokeredCount 3 -ReconnectedSessionCount 4 -ZoneName "Bangalore" -ControllerName "Dynasty"
<!--NeedCopy-->

Parameters

-EndDate

End date of LHC

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

-Duration

Duration of LHC in minutes

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

-MachineInZoneCount

Count of Machines in zone

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

-MachineRegisteredCount

Count of machines registered

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

-ReconnectedSessionCount

Count of sessions reconnected

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

-SessionBrokeredCount

Count of sessions brokered

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

-ZoneName

Name of zone

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

-ControllerName

Name of Controller/Cloud connector

Type: String
Position: Named
Default value: None
Required: True
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

Boolean

Returns a bool stating LhcReport was saved into db

New-MonitorLhcReports