Set-STFStoreFarm
Set the details of an exiting farm
Syntax
Set-STFStoreFarm [-Farm] <Farm> [[-FarmType] <XenApp | XenDesktop | AppController | VDIinaBox | Store | SPA>] [[-Servers] <String[]>] [[-ServiceUrls] <String[]>] [[-Port] <Int32>] [[-TransportType] <HTTP | HTTPS | SSL>] [[-SSLRelayPort] <Int32>] [[-LoadBalance] <Boolean>] [[-AllFailedBypassDuration] <Int32>] [[-BypassDuration] <Int32>] [[-TicketTimeToLive] <Int32>] [[-RadeTicketTimeToLive] <Int32>] [[-MaxFailedServersPerRequest] <Int32>] [[-Zones] <String[]>] [[-XMLValidationEnabled] <Boolean>] [[-XMLValidationSecret] <String>] [[-Product] <String>] [[-RestrictPoPs] <String>] [[-FarmGuid] <String>] [[-PassThru] <SwitchParameter>] [<CommonParameters>]
Set-STFStoreFarm [-StoreService] <StoreService> [-FarmName] <String> [[-FarmType] <XenApp | XenDesktop | AppController | VDIinaBox | Store | SPA>] [[-Servers] <String[]>] [[-ServiceUrls] <String[]>] [[-Port] <Int32>] [[-TransportType] <HTTP | HTTPS | SSL>] [[-SSLRelayPort] <Int32>] [[-LoadBalance] <Boolean>] [[-AllFailedBypassDuration] <Int32>] [[-BypassDuration] <Int32>] [[-TicketTimeToLive] <Int32>] [[-RadeTicketTimeToLive] <Int32>] [[-MaxFailedServersPerRequest] <Int32>] [[-Zones] <String[]>] [[-XMLValidationEnabled] <Boolean>] [[-XMLValidationSecret] <String>] [[-Product] <String>] [[-RestrictPoPs] <String>] [[-FarmGuid] <String>] [[-PassThru] <SwitchParameter>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Set the details of an existing farm.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Farm | The farm object to configure | true | true (ByValue) | |
| StoreService | The Store service the farm options should be updated for | true | true (ByValue) | |
| FarmName | The name of the Farm to update | true | false | |
| FarmType | The type of farm to be added. XenDesktop or XenApp for example | false | false | |
| Servers | The hostnames or IP addresses of the xml services | false | false | |
| ServiceUrls | The url to the service location used to provide web and SaaS apps via this farm. | false | false | |
| Port | Service communication port | false | false | |
| TransportType | Type of transport to use. Http, Https, SSL for example | false | false | |
| SSLRelayPort | The SSL Relay port | false | false | |
| LoadBalance | Round robin load balance the xml service servers | false | false | |
| AllFailedBypassDuration | Period of time to skip all xml service requests should all servers fail to respond | false | false | |
| BypassDuration | Period of time to skip a server when is fails to respond | false | false | |
| TicketTimeToLive | Period of time an ICA launch ticket is valid once requested on pre 7.0 XenApp and XenDesktop farms | false | false | |
| RadeTicketTimeToLive | Period of time a RADE launch ticket is valid once requested on pre 7.0 XenApp and XenDesktop farms | false | false | |
| MaxFailedServersPerRequest | Maximum number of servers within a single farm that can fail before aborting a request | false | false | |
| Zones | The list of Zone names associated with the Store Farm | false | false | |
| XMLValidationEnabled | Enable XML service endpoint validation | false | false | |
| XMLValidationSecret | XML service endpoint validation shared secret | false | false | |
| Product | Cloud deployments only otherwise ignored. The product name of the farm configured | false | false | |
| RestrictPoPs | Cloud deployments only otherwise ignored. Restricts GWaaS traffic to the specified POP | false | false | |
| FarmGuid | Cloud deployments only otherwise ignored. A tag indicating the scope of the farm | false | false | |
| PassThru | The resulting Store Farm | false | false |
Input Type
Citrix.StoreFront.Model.Store.Farm
Parameter Farm: A .NET class representing the configuration of a Farm in StoreFront Store service
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
Citrix.StoreFront.Model.Store.FarmType
Parameter FarmType: The .NET Citrix.StoreFront.Model.Store.FarmType value type
System.String[]
Parameter Servers: The .NET System.String reference type
System.String[]
Parameter ServiceUrls: The .NET System.String reference type
System.Int32
Parameter Port: The .NET System.Int32 value type
Citrix.StoreFront.Model.Store.TransportType
Parameter TransportType: The .NET Citrix.StoreFront.Model.Store.TransportType value type
System.Int32
Parameter SSLRelayPort: The .NET System.Int32 value type
System.Boolean
Parameter LoadBalance: The .NET System.Boolean value type
System.Int32
Parameter AllFailedBypassDuration: The .NET System.Int32 value type
System.Int32
Parameter BypassDuration: The .NET System.Int32 value type
System.Int32
Parameter TicketTimeToLive: The .NET System.Int32 value type
System.Int32
Parameter RadeTicketTimeToLive: The .NET System.Int32 value type
System.Int32
Parameter MaxFailedServersPerRequest: The .NET System.Int32 value type
System.String[]
Parameter Zones: The .NET System.String reference type
System.Boolean
Parameter XMLValidationEnabled: The .NET System.Boolean value type
System.String
Parameter XMLValidationSecret: The .NET System.String reference type
System.String
Parameter Product: The .NET System.String reference type
System.String
Parameter RestrictPoPs: The .NET System.String reference type
System.String
Parameter FarmGuid: The .NET System.String reference type
System.Management.Automation.SwitchParameter
Parameter PassThru: The .NET System.Management.Automation.SwitchParameter value type
Return Values
None
Examples
EXAMPLE 1 Reconfigure existing farm
$store = Get-STFStoreService
$farm = Get-STFStoreFarm -StoreService $storeService
Set-STFStoreFarm $farm -FarmType XenDesktop -Port 80 -TransportType HTTP -Servers Xen1,Xen2
<!--NeedCopy-->
REMARKS
Reconfigure the settings on an existing farm.
EXAMPLE 2 Set the details for a Secure Private Access farm with store path added automatically.
$store = Get-STFStoreService
Set-STFStoreFarm -StoreService $store -FarmName "SPA Apps" -FarmType SPA -ServiceUrls http://spa-service.com/secureAccess/enumeration/aHR0cHM6Ly9zdG9yZWZyb250L0NpdHJpeC9TdG9yZTE
<!--NeedCopy-->
REMARKS
Sets the spa-service.com SPA server to the SPA Apps farm. Since this URL has a path specified, the ServiceUrl will be configured exactly as specified
EXAMPLE 3 Set the details for a Secure Private Access farm with store path added manually.
$store = Get-STFStoreService
Set-STFStoreFarm -StoreService $store -FarmName "SPA Apps" -FarmType SPA -ServiceUrls https://spa-service.com
<!--NeedCopy-->
REMARKS
Sets the spa-service.com SPA ServiceUrl on the SPA Apps farm. Since this URL has no path, the SPA endpoint path and an encoded $store service URL will be appended ServiceUrl
EXAMPLE 4 Set details for an App Controller farm
$store = Get-STFStoreService
Set-STFStoreFarm -StoreService $store -FarmName "App Controller Farm" -FarmType AppController -ServiceUrls https://appcontroller.com
<!--NeedCopy-->
REMARKS
Sets the https://appcontroller.com ServiceUrl on the App Controller Farm.