Use the Set-CMSite cmdlet to configure one or more Configuration Manager sites. You can specify a site to configure by using a site name or a site code, or you can use the Get-CMSite cmdlet to specify a site.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Add a new Active Directory forest
This command adds a new Active Directory forest to which the site is published.
This command first uses the Get-CMSite cmdlet to get the ADC site. It then passes that object through the pipeline to the Set-CMSite cmdlet, which promotes the site server in passive mode to be the active site server.
Specifies an array of Active Directory forest objects to which the site is published. To get an Active Directory forest object, use the Get-CMActiveDirectoryForest cmdlet.
Parameter properties
Type:
IResultObject[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AddCertificateByPath
Specifies an array of paths to trusted root certification authorities.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AddClientRequestServiceType
Specifies a service type to add for a port that Configuration Manager uses to communicate with clients in this site.
Specify the store name where the client certificate is located in the Computer store when you don't use the default store of Personal.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ClientCertificateSelectionCriteriaType
Specifies the criteria type to match in a client certificate when more than one certificate is available. Use the -ClientCertificateSelectionCriteriaValue parameter to specify the value.
Indicates whether clients check the Certificate Revocation List (CRL) for site systems.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ClientComputerCommunicationType
Specifies the communication method for the site systems that use IIS. To use HTTPS, the servers need a valid PKI web server certificate for server authentication.
Parameter properties
Type:
ClientComputerCommunicationType
Default value:
None
Accepted values:
HttpsOnly, HttpsOrHttp
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Comment
Specifies a comment for a Configuration Manager site to help identify it.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ConcurrentSendingDelayBeforeRetryingMins
A site can send data concurrently to multiple sites. If it needs to retry, this integer value specifies the number of minutes to delay before it retries. By default, the value is 1. Use the -RetryNumberForConcurrentSending parameter to specify the number of retries.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
ConcurrentSendingDelayBeforeRetryingMinutes
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EnableLowFreeSpaceAlert
Generate an alert when the free disk space on the site database server is low. Use the -FreeSpaceThresholdWarningGB and -FreeSpaceThresholdCriticalGB parameters to specify the specific thresholds.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
GenerateAlertWhenFreeDiskSpaceOnSiteDatabaseIsLow
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EnableWakeOnLan
This parameter is for an earlier version of the feature. Instead, use the client settings for wake on LAN with the Set-CMClientSettingPowerManagement cmdlet.
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-FreeSpaceThresholdCriticalGB
When -EnableLowFreeSpaceAlert is $true, the site raises a critical alert when the free disk space falls below this value. Specify an integer for the free disk space in GB on the site database server.
When -EnableLowFreeSpaceAlert is $true, the site raises a warning alert when the free disk space falls below this value. Specify an integer for the free disk space in GB on the site database server.
Specifies a Configuration Manager site object to configure. To get a Configuration Manager site object, use the Get-CMSite cmdlet.
Parameter properties
Type:
IResultObject
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
SetByObject
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MaximumConcurrentSendingForAllSite
A site can send data concurrently to multiple sites. This value specifies the maximum number of simultaneous communications to all sites. By default, the value is 5.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MaximumConcurrentSendingForPerSite
A site can send data concurrently to multiple sites. This value specifies the maximum number of simultaneous communications to any single site. By default, the value is 3.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MaximumNumberOfSendingWakeupPacketBeforePausing
This parameter is for an earlier version of the feature. Instead, use the client settings for wake on LAN with the Set-CMClientSettingPowerManagement cmdlet.
When clients sign data and communicate with site systems by using HTTP, this option requires the clients to use SHA-256 to sign the data. Clients must support this hash algorithm. This option applies to clients that don't use PKI certificates.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-RequireSigning
This option requires that clients sign data when they send to management points.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-RetryInstallPassiveSite
Use this parameter to retry the installation for a site server in passive mode that previously failed.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-RetryNumberForConcurrentSending
A site can send data concurrently to multiple sites. If it needs to retry, this integer value specifies the number of times to retry a failed communication. By default, the value is 2. Use the -ConcurrentSendingDelayBeforeRetryingMins parameter to specify the delay in minutes before it retries.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-RetryNumberOfSendingWakeupPacketTransmission
This parameter is for an earlier version of the feature. Instead, use the client settings for wake on LAN with the Set-CMClientSettingPowerManagement cmdlet.
This parameter is for an earlier version of the feature. Instead, use the client settings for wake on LAN with the Set-CMClientSettingPowerManagement cmdlet.
This parameter is for an earlier version of the feature. Instead, use the client settings for wake on LAN with the Set-CMClientSettingPowerManagement cmdlet.
This parameter is for an earlier version of the feature. Instead, use the client settings for wake on LAN with the Set-CMClientSettingPowerManagement cmdlet.
This parameter is for an earlier version of the feature. Instead, use the client settings for wake on LAN with the Set-CMClientSettingPowerManagement cmdlet.
For deployment verification, configure the default collection size limit. The Select Collection window hides collections with membership that exceeds this default value. Specify 0 to disable.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
SizeOfCustomCollectionCanSelectByDefault
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ThresholdOfSelectCollectionMax
For deployment verification, configure the maximum collection size limit. The Select Collection window always hides collections that have more members than this maximum size. Specify 0 to disable.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
SizeOfCustomCollectionCanSelectMaximum
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-UseCustomWebsite
Indicates whether to use a custom web site. By default, Configuration Manager site system servers that require IIS to communicate with clients use the default web site.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-UseEncryption
Enable this option to use 3DES to encrypt the client inventory data and state messages that are sent to the management point.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-UsePkiClientCertificate
Indicates whether to use a PKI client certificate for client authentication when available.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-UseSmsGeneratedCert
Use this parameter to enable or disable the site property to Use Configuration Manager-generated certificates for HTTP site systems. For more information, see Enhanced HTTP.
Specifies the type of transmission method to use for Wake On LAN transmissions.
Parameter properties
Type:
WakeOnLanTransmissionMethodType
Default value:
None
Accepted values:
Unicast, SubnetDirectedBroadcasts
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WakeOnLanType
This parameter is for an earlier version of the feature. Instead, use the client settings for wake on LAN with the Set-CMClientSettingPowerManagement cmdlet.
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
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.