Get-WebSitesVirtualFarm

  • Reference
Module:
WebSites

Gets information about a virtual server farm.

Syntax

Get-WebSitesVirtualFarm
   [[-Name] <String>]
   [-VirtualFarmOwnerName <String>]
   [-RemoteSettings <RemoteSettings>]
   [-SuppressRequestIdLine]
   [<CommonParameters>]

Description

The Get-WebSitesVirtualFarm cmdlet gets information about a virtual server farm. A virtual server farm is a networking environment that combines virtual machines running on multiple physical servers. Virtual servers farms are designed to such things as server consolidation; redundancy for failover; and high availability.

Used without any parameters, Get-WebSitesVirtualFarm returns information about all your virtual server farms. Alternatively, you can do such things as return information for a specific farm, or for all the farms owned by a specified user.

Examples

Example 1: Get information about a virtual farm

PS C:\> Get-WebSitesVirtualFarm -Name "DefaultVirtualFarm"

This command returns information about the virtual farm named DefaultVirtualFarm.

Parameters

-Name

Specifies the name of the virtual server farm being returned. Valid values include:

  • DefaultVirtualFarm
  • VirtualDedicatedWorkers
  • DefaultServerFarm

For example:

-Name "VirtualDedicatedWorkers"

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RemoteSettings

{{Fill RemoteSettings Description}}

Type:RemoteSettings
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SuppressRequestIdLine

{{Fill SuppressRequestIdLine Description}}

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualFarmOwnerName

Specifies the name of a virtual server farm owner. For example:

-VirtualFarmOwner "PattiF"

When this parameter is used, Get-WebSitesVirtualFarm returns information for all the server farms owned by this user.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False