New-WFFarm

Updated: September 7, 2012

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

New-WFFarm

You can use this cmdlet to create a new workflow farm.

Syntax

Parameter Set: AutoCert
New-WFFarm -CertificateAutoGenerationKey <SecureString> -WFFarmDBConnectionString <String> [-AdminGroup <String> ] [-HttpPort <Int32> ] [-HttpsPort <Int32> ] [-InstanceDBConnectionString <String> ] [-ResourceDBConnectionString <String> ] [-RunAsAccount <String> ] [ <CommonParameters>]

Parameter Set: CustomCert
New-WFFarm -OutboundCertificateThumbprint <String> -SslCertificateThumbprint <String> -WFFarmDBConnectionString <String> [-AdminGroup <String> ] [-EncryptionCertificateThumbprint <String> ] [-HttpPort <Int32> ] [-HttpsPort <Int32> ] [-InstanceDBConnectionString <String> ] [-ResourceDBConnectionString <String> ] [-RunAsAccount <String> ] [ <CommonParameters>]

Detailed Description

Run New-WFFarm to create a new workflow farm. This is the first step required for getting started with workflows.

A farm is a workflow configuration stored in a farm management database. A farm management database contains the settings required by the workflow, messages, and ports. The ports can be used externally with the clients, or internally between the hosts of the farm.

If an error occurs or you are forced to reboot during farm creation, the databases that are created may be left in a corrupt state. In that case, when you try to join a farm the process may display an error. This error may say that the computer you are trying to add to the farm is not a part of any farm. When you encounter such an error, you must drop the databases and recreate them before you can join any new nodes to the farm.

Parameters

-AdminGroup<String>

Represents the set of users who are considered workflow administrators.

Aliases	none
Required?	false
Position?	named
Default Value	BUILTIN\Administrators
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CertificateAutoGenerationKey<SecureString>

This passphrase is required for certificate auto generation. This is a mandatory parameter if you want certificates to be auto generated.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EncryptionCertificateThumbprint<String>

This certificate is used for securing the SQL connection strings. If not provided, it will take the value of the SslCertificate. Represents the encryption certificate.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-HttpPort<Int32>

Represents the port that will be used by the workflow for HTTP communication.

Aliases	none
Required?	false
Position?	named
Default Value	12291
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-HttpsPort<Int32>

Represents the port that will be used by the workflow for HTTPS communication.

Aliases	none
Required?	false
Position?	named
Default Value	12290
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InstanceDBConnectionString<String>

Represents a connection string of the instance management database for the workflow.

Aliases	none
Required?	false
Position?	named
Default Value	WFInstanceManagementDB
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-OutboundCertificateThumbprint<String>

Represents the certificate that is used for securing the outbound communication. Do not provide this if you are providing CertAutogenerationKey for auto generation of certificates.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ResourceDBConnectionString<String>

Represents a connection string of the resource management database.

Aliases	none
Required?	false
Position?	named
Default Value	WFResourceManagementDB
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RunAsAccount<String>

Represents the account under which the service will be running. This account must be a domain account.

Aliases	none
Required?	false
Position?	named
Default Value	The user executing the cmdlet
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SslCertificateThumbprint<String>

Represents the certificate that is used for securing the service communication. Do not provide this if you are providing CertAutogenerationKey for auto generation of certificates.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WFFarmDBConnectionString<String>

Represents a connection string of the configuration database.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1

PS C:\> New-WFFarm -FarmMgmtDBConnectionString "data source=localhost\sqlexpress;integrated security=true" -CertAutogenerationKey 'mycertkey'

Example 2

PS C:\> New-WFFarm -FarmMgmtDBConnectionString "data source=mySQLServer;integrated security=true" -RunAsAccount myServiceAccount -Admingroup myAdminsGroup -InstanceMgmtDBConnectionString "data source=myDedicatedWorkflowSQLServer;integrated security=true" -ResourceMgmtDBConnectionString "data source=myDedicatedWorkflowSQLServer;integrated security=true" -CertAutogenerationKey 'mycertkey'