Remove-DSGatewayFarm

Synopsis

Delete a gateway farm

Syntax

__AllParameterSets

Remove-DSGatewayFarm [-ID] <guid> [-DeleteMemberGateways] [<CommonParameters>]

Description

Delete a gateway farm. By default, the member gateways are kept and become standalone gateways. Use the DeleteMemberGateways switch to delete member gateways along with the farm.

Examples

Example 1

PS C:\> $farm = Get-DSGateway -Name "Production Farm"
PS C:\> Remove-DSGatewayFarm -ID $farm.Id

Delete a gateway farm while keeping its member gateways as standalone gateways.

Example 2

PS C:\> $farm = Get-DSGateway -Name "Production Farm"
PS C:\> Remove-DSGatewayFarm -ID $farm.Id -DeleteMemberGateways

Delete a gateway farm and all of its member gateways.

Parameters

-DeleteMemberGateways

Delete the member gateways along with the farm. When omitted, the member gateways are kept and become standalone gateways.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ID

ID of the gateway farm to delete.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

For more information, type "Get-Help Remove-DSGatewayFarm -detailed". For technical information, type "Get-Help Remove-DSGatewayFarm -full".