Set-WebSitesVirtualFarm
Sets the property values of a virtual server farm.
Syntax
Set-WebSitesVirtualFarm
[-Name] <String>
[-OwnerName <String>]
[-MaximumSiteWeight <Int32>]
[-ExclusiveAssignment <Boolean>]
[-TargetNumberOfWorkers <Int32>]
[-TargetWorkerSize <Int32>]
[-RemoteSettings <RemoteSettings>]
[-SuppressRequestIdLine]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-WebSitesVirtualFarm cmdlet sets the property values of 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 provide capabilities like: server consolidation; redundancy for failover; and high availability. This cmdlet enables you to do such things as manage the workers assigned to a farm; change the name of a farm; and assign ownership of a farm.
Examples
Example 1: Modify a virtual server farm
PS C:\> Set-WebSitesVirtualFarm -Name "Farm01" -ExclusiveAssignment $True -TargetWorkerSize "Large"
This command updates the virtual server farm Farm01, setting the target worker size to Large and specifying that Farm01 workers cannot be simultaneously assigned to other servers farms.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExclusiveAssignment
Indicates whether a worker is exclusive to the virtual server farm. Set this value to True ($True) to limit workers to the specified farm. Set this value to False ($False) to allow workers to process tasks for other server farms.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MaximumSiteWeight
Specifies the maximum site weight for the virtual server farm. Site weights are used in load balancing, with higher values taking priority over lower values. For example:
-MaximumSiteWeight 25
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of the virtual server farm being modified.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-OwnerName
Specifies the name of the farm owner. For example:
-OwnerName "PattiF"
Type: | String |
Position: | Named |
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 |
-TargetNumberOfWorkers
Specifies the number of web workers allocated to the server farm. The number of allowed works varies depending on the site mode:
- If the site mode is Free, you can allocate 1 worker to the site.
- If the site mode is Shared, you can allocate between 1 and 6 workers, inclusive, to the site.
- If the site mode is Standard, you can allocate between 1 and 10 workers, inclusive, to the site.
This parameter is ignored if a site is in reserve mode.
For example:
-TargetNumberOfWorkers 3
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetWorkerSize
Specifies the size of the target worker for the virtual server farm. Valid values are:
- Small
- Medium
- Large
For example:
-TargetWorkerSize "Medium"
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |