Get-WFFarm

Updated: July 27, 2012

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

Get-WFFarm

You can use this cmdlet to retrieve the configuration of the workflow farm.

Syntax

Parameter Set: Default
Get-WFFarm [-WFFarmDBConnectionString <String> ] [ <CommonParameters>]

Detailed Description

Run Get-WFFarm to get the configuration of a workflow farm. When creating a workflow farm many parameters have default values. With this cmdlet you can examine both configuration time or default settings of the farm. The farm configuration contains a list of the hosts (computers), ports, admin users, database locations and more.

Parameters

-WFFarmDBConnectionString<String>

Represents the connection string for the SQL Server instance being used as the farm management database. Use this parameter if you wish to retrieve the configuration of a remote workflow farm.

<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

Retrieves the configuration for the workflow farm to which the current host belongs.

PS C:\> Get-WFFarm

Example 2

Retrieves the configuration for the workflow farm stored in the database server myDBServer.

PS C:\> Get-WFFarm  -WFFarmDBConnectionString “Data Source=myDBServer;Initial Catalog= WFManagementDB;Integrated Security=True”