Citrix Virtual Apps and Desktops SDK

Test-ConfigServiceInstanceAvailability

August 9, 2024

Contributed by:

Tests whether the supplied service instances are responding to requests.

Syntax

Test-ConfigServiceInstanceAvailability
    [-ServiceInstance] <ServiceInstance[]>
    [-MaxDelaySeconds <Int32>]
    [-ForceWaitForOneOfEachType]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Examples

EXAMPLE 1

Test all the service instances that are registered in the Configuration Service, returning when one of each type is responding.

C:\>Get-ConfigRegisteredServiceInstance | Test-ConfigServiceInstanceAvailability -ForceWaitForOneOfEachType
<!--NeedCopy-->

EXAMPLE 2

Test each of the given services, allowing a 5 second time-out.

C:\>Test-ConfigServiceInstanceAvailability -ServiceInstance $services -MaxDelaySeconds 5
<!--NeedCopy-->

Parameters

-ServiceInstance

The service instances to test.

Type:	ServiceInstance[]
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-MaxDelaySeconds

The timeout period to wait before concluding that services are unresponsive.

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

-ForceWaitForOneOfEachType

If at least one of each type of service responds, finish immediately.

Type:	SwitchParameter
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

PSObject

This represents a service instance and has the following parameters:

ServiceGroupUid <Guid>

The unique identifer for the service group to which the service instance belongs.
ServiceGroupName <string>

The name of the service group that the service instance is part of.
ServiceInstanceUid <Guid>

The unique identifier for the service instance.
ServiceType <string>

The type of the service group.
Address <string>

The contact address for the service instance.
Binding <string>

The binding to use for connections to the service instance.
Version <int>

The version of the service instance.
ServiceAccount <string>

The AD computer account for the computer that is providing the service instance.
ServiceAccountSid <string>

The AD computer account SID for the computer that is providing the service instance.
InterfaceType <string>

The interface type for the service instance.
Metadata <Citrix.Configuration.Sdk.Metadata[]>

The metadata for the service instance.
Status <Citrix.Configuration.Sdk.Commands.Availability>

An enumeration value indicating whether the service is Responding, NotResponding, Unknown, or BadBindingType.
ResponseTime <System.TimeSpan>

The interval elapsed between hailing the service and getting a definite response

Notes

The Availability Status Codes are

Responding: Got a positive response
NotResponding: Got a response, but it was negative or the connection was refused
Unknown: Did not respond in time / timed-out
BadBindingType: Binding parameter in ServiceInstance is not wcf_HTTP_kerb

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

Test-ConfigServiceInstanceAvailability

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Test-ConfigServiceInstanceAvailability

Syntax

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ServiceInstance

-MaxDelaySeconds

-ForceWaitForOneOfEachType

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

PSObject

Notes

Related Links

In this article