Citrix StoreFront SDK PowerShell Modules

Get-STFStoreFarmsHealth

Get the health status of the Store’s CVAD/DaaS farms.

Syntax

Get-STFStoreFarmsHealth [-StoreService] <StoreService> [[-FarmName] <String>] [<CommonParameters>]



Get-STFStoreFarmsHealth [[-ServerAddresses] <List`1>] [-TransportType] <HTTP | HTTPS | SSL> [-Port] <Int32> [-UseAdvancedHealthCheck] <Boolean> [[-CommunicationTimeout] <TimeSpan>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Get the health status of the Store’s CVAD/DaaS farms.

Parameters

Name Description Required? Pipeline Input Default Value
StoreService The Store service to query true true (ByValue)  
FarmName The name of a specific farm to check. If not provided, all farms will be checked. false false  
ServerAddresses The farm to health check. false false  
TransportType The transport type used by the server to be checked. true false  
Port The port used by the server to be checked. true false  
UseAdvancedHealthCheck Use the advanced health check mechanism to test this new servers connectivity. true false  
CommunicationTimeout The timeout on the communication while performing the health check on the proposed server false false  

Input Type

Citrix.StoreFront.Model.Store.StoreService

Parameter StoreService: A .NET class representing the configuration of a StoreFront Store service

System.String

Parameter FarmName: The .NET System.String reference type

System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Parameter ServerAddresses: The .NET System.Collections.Generic.List1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]` reference type

Citrix.StoreFront.Model.Store.TransportType

Parameter TransportType: The .NET Citrix.StoreFront.Model.Store.TransportType value type

System.Int32

Parameter Port: The .NET System.Int32 value type

System.Boolean

Parameter UseAdvancedHealthCheck: The .NET System.Boolean value type

System.TimeSpan

Parameter CommunicationTimeout: The .NET System.TimeSpan value type

Return Values

FarmServerHealth

The .NET Citrix.StoreFront.Model.Store.ServerHealth.FarmServerHealth reference type

Examples

EXAMPLE 1 Get Store’s CVAD/DaaS farms health status

$storeservice = Get-STFStoreService
Get-STFStoreFarmsHealth -StoreService $storeservice
<!--NeedCopy-->

REMARKS

Retrieve the health status from the Store’s CVAD/Daas farms

OUTPUT

FarmName      : Farm1
ServerAddress : server1.domain.com        
HealthStatus  : Healthy    
IsConfigured  : True
<!--NeedCopy-->

EXAMPLE 2 Get specific farm health status

$storeservice = Get-STFStoreService
Get-STFStoreFarmsHealth -StoreService $storeservice -FarmName 'Farm1'
<!--NeedCopy-->

REMARKS

Retrieve the health status for a specific farm

OUTPUT

FarmName      : Farm1
ServerAddress : server1.domain.com        
HealthStatus  : Healthy    
IsConfigured  : True
<!--NeedCopy-->
Get-STFStoreFarmsHealth