Test-Configserviceinstanceavailability¶
Tests whether the supplied service instances are responding to requests.
Syntax¶
Test-ConfigServiceInstanceAvailability [-ServiceInstance] <ServiceInstance[]> [-MaxDelaySeconds <Int32>] [-ForceWaitForOneOfEachType] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
Related Commands¶
- Register-ConfigServiceInstance
- Unregister-ConfigRegisteredServiceInstance
- Get-ConfigRegisteredServiceInstance
Parameters¶
Name | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|
ServiceInstance | The service instances to test. | true | true (ByValue) | |
MaxDelaySeconds | The timeout period to wait before concluding that services are unresponsive. | false | false | Infinite |
ForceWaitForOneOfEachType | If at least one of each type of service responds, finish immediately. | false | false | |
BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
AdminAddress | Specifies the host name or IP address of the controller to which the PowerShell snap-in connects. | false | false | 'LocalHost'. Once a value is specified by any command, this value becomes the new default. |
Input Type¶
¶
Return Values¶
System.Management.Automation.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.Tinespan>
The Interval Elapsed Between Hailing The Service And Getting A Definite Response¶
Notes¶
The Availability Status Codes are o Responding: Got a positive response o NotResponding: Got a response, but it was negative or the connection was refused o Unknown: Did not respond in time / timed-out o BadBindingType: Binding parameter in ServiceInstance is not wcf_HTTP_kerb
Examples¶
Example 1¶
C:\>Get-ConfigRegisteredServiceInstance | Test-ConfigServiceInstanceAvailability -ForceWaitForOneOfEachType
Description¶
Test all the service instances that are registered in the Configuration Service, returning when one of each type is responding.
Example 2¶
C:\>Test-ConfigServiceInstanceAvailability -ServiceInstance $services -MaxDelaySeconds 5
Description¶
Test each of the given services, allowing a 5 second time-out.