Citrix Virtual Apps and Desktops SDK

New-MonitorCloudConnectorHealth

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Returns a boolean

Syntax

New-MonitorCloudConnectorHealth
   -HealthData <String>
   -ConnectorName <String>
   -ZoneName <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Returns a boolean stating whether a new cloud connector service status was added or not

Examples

EXAMPLE 1

Inserts multiple metrices from cloud connector into CloudConnectorServiceStatus

New-MonitorCloudConnectorHealth -HealthData {"ServiceStatus":"[{\"Name\":\"CdfCaptureService\",\"Status\":4}]} -ConnectorName "CloudConnector.domain" -ZoneName "Bangalore"
<!--NeedCopy-->

Parameters

-HealthData

List of all Services as a string which include Service Name and Status

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

-ConnectorName

Name of connector

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Length range: 0 to 255

-ZoneName

Name of zone

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Length range: 0 to 255

-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 CloudConnectorServiceStatus was saved into db

New-MonitorCloudConnectorHealth