Test-ConfigServiceInstanceAvailability

Last published : Oct 31, 2026
Tests whether the supplied service instances are responding to requests.
Related information
about_ConfigConfigurationSnapIn

Syntax

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

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

EXAMPLE 2

Test each of the given services, allowing a 5 second time-out.
C:\>Test-ConfigServiceInstanceAvailability -ServiceInstance $services -MaxDelaySeconds 5

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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
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 2511

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

This represents a service instance and has the following parameters:
  • ServiceGroupUid \&lt;Guid\>
    The unique identifer for the service group to which the service instance belongs.
  • ServiceGroupName \&lt;string\>
    The name of the service group that the service instance is part of.
  • ServiceInstanceUid \&lt;Guid\>
    The unique identifier for the service instance.
  • ServiceType \&lt;string\>
    The type of the service group.
  • Address \&lt;string\>
    The contact address for the service instance.
  • Binding \&lt;string\>
    The binding to use for connections to the service instance.
  • Version \&lt;int\>
    The version of the service instance.
  • ServiceAccount \&lt;string\>
    The AD computer account for the computer that is providing the service instance.
  • ServiceAccountSid \&lt;string\>
    The AD computer account SID for the computer that is providing the service instance.
  • InterfaceType \&lt;string\>
    The interface type for the service instance.
  • Metadata \&lt;Citrix.Configuration.Sdk.Metadata\[\]\>
    The metadata for the service instance.
  • Status \&lt;Citrix.Configuration.Sdk.Commands.Availability\>
    An enumeration value indicating whether the service is Responding, NotResponding, Unknown, or BadBindingType.
  • ResponseTime \&lt;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