Edit

Share via

Remove-CMSiteSystemServer

  • Reference
Module:
ConfigurationManager

Remove the site system server role.

Syntax

Remove-CMSiteSystemServer
      [-Force]
      -InputObject <IResultObject>
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMSiteSystemServer
      [-Force]
      [-SiteCode <String>]
      [-SiteSystemServerName] <String>
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Use this cmdlet to remove the site system server role. A server with the Site system role hosts one or more other roles for a Configuration Manager site.

If the server has other site system roles besides the site system role, this cmdlet fails.

To remove other roles, use one of the following cmdlets:

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Remove a site system server

This command first uses the Get-CMSiteSystemServer cmdlet to get the site system server object for Server2.contoso.com in the site MP5. It then uses the pipeline operator to pass the object to Remove-CMSiteSystemServer, which removes the site system server role.

Get-CMSiteSystemServer -SiteSystemServerName "Server2.contoso.com" -SiteCode "MP5" | Remove-CMSiteSystemServer -Force

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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-Force

Run the command without asking for confirmation.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-InputObject

Specify a site system server object to remove. To get this object, use the Get-CMSiteSystemServer cmdlet.

Type:IResultObject
Aliases:SiteSystem, SiteSystemServer
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SiteCode

Specify the Configuration Manager site code.

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

-SiteSystemServerName

Specify the name of the server with the site system role to remove.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject