Storefront Powershell SDK 2411

New-STFStoreFarm

Create a new Farm config object

Syntax

New-STFStoreFarm [-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>] [[-MaximumFailedServersPerRequest] <Int32>] [[-Zones] <String[]>] [[-XMLValidationEnabled] <Boolean>] [[-XMLValidationSecret] <String>] [[-Product] <String>] [[-RestrictPoPs] <String>] [[-FarmGuid] <String>] [[-PassThru] <SwitchParameter>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Create a XenApp \ XenDesktop farm to be added to a Store service.

Parameters

Name Description Required? Pipeline Input Default Value
FarmName The friendly name of the farm true false  
FarmType The type of farm to be added. XenDesktop or XenApp for example true 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  
MaximumFailedServersPerRequest 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 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 service false false  

Input Type

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 MaximumFailedServersPerRequest: 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

Farm

A .NET class representing the configuration of a Farm in StoreFront Store service

Examples

EXAMPLE 1 Create a farm to be added to a Store service

$store = Get-STFStoreService
$farm = New-STFStoreFarm -FarmName "XenDesktop75" -FarmType XenDesktop -Port 80 -TransportType HTTP -Servers Xen1
Add-STFStoreFarm -StoreService $store -Farm $farm
<!--NeedCopy-->

REMARKS

Creates the XenDesktop75 farm with the Xen1 XenDesktop server and adds it to the store.

New-STFStoreFarm