Set-CMSite

Set-CMSite

Changes security scope settings for Configuration Manager sites.

Syntax

Parameter Set: SetByNameMandatory
Set-CMSite -Name <String> [-AddActiveDirectoryForest <IResultObject[]> ] [-AddCertificateByPath <String[]> ] [-AddClientRequestServiceType <ClientRequestServiceType> {ClientNotificationTcp | ClientRequestHttpTcp | ClientRequestHttpTcpDefault | ClientRequestsHttpsTcp | ClientRequestsHttpsTcpDefault | WakeOnLanUdp} ] [-ClientCertificateCustomStoreName <String> ] [-ClientCertificateSelectionCriteriaType <ClientCertificateSelectionCriteriaType> {CertificateSubjectContainsString | CertificateSubjectOrSanIncludesAtrributes | ClientAuthentication} ] [-ClientCertificateSelectionCriteriaValue <String> ] [-ClientCheckCertificateRevocationListForSiteSystem <Boolean> ] [-ClientComputerCommunicationType <ClientComputerCommunicationType> {HttpsOnly | HttpsOrHttp} ] [-Comment <String> ] [-ConcurrentSendingDelayBeforeRetryingMinutes <Int32> ] [-CriticalAlertWhenFreeDiskSpaceFallBelowFollowingValueGB <Int32> ] [-EnableWakeOnLan <Boolean> ] [-GenerateAlertWhenFreeDiskSpaceOnSiteDatabaseIsLow <Boolean> ] [-MaximumConcurrentSendingForAllSite <Int32> ] [-MaximumConcurrentSendingForPerSite <Int32> ] [-MaximumNumberOfSendingWakeUpPacketBeforePausing <Int32> ] [-PortForClientRequestServiceType <Int32> ] [-RemoveActiveDirectoryForest <IResultObject[]> ] [-RemoveCertificateByKey <String[]> ] [-RemoveClientRequestServiceType <ClientRequestServiceType> {ClientNotificationTcp | ClientRequestHttpTcp | ClientRequestHttpTcpDefault | ClientRequestsHttpsTcp | ClientRequestsHttpsTcpDefault | WakeOnLanUdp} ] [-RequireSha256 <Boolean> ] [-RequireSigning <Boolean> ] [-RetryNumberForConcurrentSending <Int32> ] [-RetryNumberOfSendingWakeUpPacketTransmission <Int32> ] [-SendingWakeUpPacketBeforePausingWaitSeconds <Int32> ] [-SendingWakeUpPacketTransmissionDelayMinutes <Int32> ] [-SendingWakeUpPacketTransmissionOffsetMinutes <Int32> ] [-TakeActionForMultipleCertificateMatchCriteria <TakeActionForMultipleCertificateMatchCriteria> {FailSelectionAndSendErrorMessage | SelectCertificateWithLongestValidityPeriod} ] [-ThreadNumberOfSendingWakeUpPacket <Int32> ] [-UseCustomWebSite <Boolean> ] [-UseEncryption <Boolean> ] [-UsePkiClientCertificate <Boolean> ] [-WakeOnLanTransmissionMethodType <WakeOnLanTransmissionMethodType> {SubnetDirectedBroadcasts | Unicast} ] [-WakeOnLanType <WakeOnLanType> {UseAmtPowerOnCommandsOnly | UseAmtPowerOnCommandsORWakeUpPackets | UseWakeUpPacketsOnly} ] [-WarningAlertWhenFreeDiskSpaceFallBelowFollowingValueGB <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetByObject
Set-CMSite -InputObject <IResultObject> [-AddActiveDirectoryForest <IResultObject[]> ] [-AddCertificateByPath <String[]> ] [-AddClientRequestServiceType <ClientRequestServiceType> {ClientNotificationTcp | ClientRequestHttpTcp | ClientRequestHttpTcpDefault | ClientRequestsHttpsTcp | ClientRequestsHttpsTcpDefault | WakeOnLanUdp} ] [-ClientCertificateCustomStoreName <String> ] [-ClientCertificateSelectionCriteriaType <ClientCertificateSelectionCriteriaType> {CertificateSubjectContainsString | CertificateSubjectOrSanIncludesAtrributes | ClientAuthentication} ] [-ClientCertificateSelectionCriteriaValue <String> ] [-ClientCheckCertificateRevocationListForSiteSystem <Boolean> ] [-ClientComputerCommunicationType <ClientComputerCommunicationType> {HttpsOnly | HttpsOrHttp} ] [-Comment <String> ] [-ConcurrentSendingDelayBeforeRetryingMinutes <Int32> ] [-CriticalAlertWhenFreeDiskSpaceFallBelowFollowingValueGB <Int32> ] [-EnableWakeOnLan <Boolean> ] [-GenerateAlertWhenFreeDiskSpaceOnSiteDatabaseIsLow <Boolean> ] [-MaximumConcurrentSendingForAllSite <Int32> ] [-MaximumConcurrentSendingForPerSite <Int32> ] [-MaximumNumberOfSendingWakeUpPacketBeforePausing <Int32> ] [-PortForClientRequestServiceType <Int32> ] [-RemoveActiveDirectoryForest <IResultObject[]> ] [-RemoveCertificateByKey <String[]> ] [-RemoveClientRequestServiceType <ClientRequestServiceType> {ClientNotificationTcp | ClientRequestHttpTcp | ClientRequestHttpTcpDefault | ClientRequestsHttpsTcp | ClientRequestsHttpsTcpDefault | WakeOnLanUdp} ] [-RequireSha256 <Boolean> ] [-RequireSigning <Boolean> ] [-RetryNumberForConcurrentSending <Int32> ] [-RetryNumberOfSendingWakeUpPacketTransmission <Int32> ] [-SendingWakeUpPacketBeforePausingWaitSeconds <Int32> ] [-SendingWakeUpPacketTransmissionDelayMinutes <Int32> ] [-SendingWakeUpPacketTransmissionOffsetMinutes <Int32> ] [-TakeActionForMultipleCertificateMatchCriteria <TakeActionForMultipleCertificateMatchCriteria> {FailSelectionAndSendErrorMessage | SelectCertificateWithLongestValidityPeriod} ] [-ThreadNumberOfSendingWakeUpPacket <Int32> ] [-UseCustomWebSite <Boolean> ] [-UseEncryption <Boolean> ] [-UsePkiClientCertificate <Boolean> ] [-WakeOnLanTransmissionMethodType <WakeOnLanTransmissionMethodType> {SubnetDirectedBroadcasts | Unicast} ] [-WakeOnLanType <WakeOnLanType> {UseAmtPowerOnCommandsOnly | UseAmtPowerOnCommandsORWakeUpPackets | UseWakeUpPacketsOnly} ] [-WarningAlertWhenFreeDiskSpaceFallBelowFollowingValueGB <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetBySiteCodeMandatory
Set-CMSite -SiteCode <String> [-AddActiveDirectoryForest <IResultObject[]> ] [-AddCertificateByPath <String[]> ] [-AddClientRequestServiceType <ClientRequestServiceType> {ClientNotificationTcp | ClientRequestHttpTcp | ClientRequestHttpTcpDefault | ClientRequestsHttpsTcp | ClientRequestsHttpsTcpDefault | WakeOnLanUdp} ] [-ClientCertificateCustomStoreName <String> ] [-ClientCertificateSelectionCriteriaType <ClientCertificateSelectionCriteriaType> {CertificateSubjectContainsString | CertificateSubjectOrSanIncludesAtrributes | ClientAuthentication} ] [-ClientCertificateSelectionCriteriaValue <String> ] [-ClientCheckCertificateRevocationListForSiteSystem <Boolean> ] [-ClientComputerCommunicationType <ClientComputerCommunicationType> {HttpsOnly | HttpsOrHttp} ] [-Comment <String> ] [-ConcurrentSendingDelayBeforeRetryingMinutes <Int32> ] [-CriticalAlertWhenFreeDiskSpaceFallBelowFollowingValueGB <Int32> ] [-EnableWakeOnLan <Boolean> ] [-GenerateAlertWhenFreeDiskSpaceOnSiteDatabaseIsLow <Boolean> ] [-MaximumConcurrentSendingForAllSite <Int32> ] [-MaximumConcurrentSendingForPerSite <Int32> ] [-MaximumNumberOfSendingWakeUpPacketBeforePausing <Int32> ] [-PortForClientRequestServiceType <Int32> ] [-RemoveActiveDirectoryForest <IResultObject[]> ] [-RemoveCertificateByKey <String[]> ] [-RemoveClientRequestServiceType <ClientRequestServiceType> {ClientNotificationTcp | ClientRequestHttpTcp | ClientRequestHttpTcpDefault | ClientRequestsHttpsTcp | ClientRequestsHttpsTcpDefault | WakeOnLanUdp} ] [-RequireSha256 <Boolean> ] [-RequireSigning <Boolean> ] [-RetryNumberForConcurrentSending <Int32> ] [-RetryNumberOfSendingWakeUpPacketTransmission <Int32> ] [-SendingWakeUpPacketBeforePausingWaitSeconds <Int32> ] [-SendingWakeUpPacketTransmissionDelayMinutes <Int32> ] [-SendingWakeUpPacketTransmissionOffsetMinutes <Int32> ] [-TakeActionForMultipleCertificateMatchCriteria <TakeActionForMultipleCertificateMatchCriteria> {FailSelectionAndSendErrorMessage | SelectCertificateWithLongestValidityPeriod} ] [-ThreadNumberOfSendingWakeUpPacket <Int32> ] [-UseCustomWebSite <Boolean> ] [-UseEncryption <Boolean> ] [-UsePkiClientCertificate <Boolean> ] [-WakeOnLanTransmissionMethodType <WakeOnLanTransmissionMethodType> {SubnetDirectedBroadcasts | Unicast} ] [-WakeOnLanType <WakeOnLanType> {UseAmtPowerOnCommandsOnly | UseAmtPowerOnCommandsORWakeUpPackets | UseWakeUpPacketsOnly} ] [-WarningAlertWhenFreeDiskSpaceFallBelowFollowingValueGB <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeByName
Set-CMSite -Name <String> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeBySiteCode
Set-CMSite -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> -SiteCode <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeByValue
Set-CMSite -InputObject <IResultObject> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-CMSite cmdlet changes security scope settings for one or more Microsoft System Center 2012 SP1 Configuration Manager sites. A security scope is a collection of permissions that, in conjunction with security roles, defines the configuration actions that an administrator can perform on the site. You can use this cmdlet to change the type of a security scope action and the name of a security scope for a System Center 2012 Configuration Manager site. You can specify a site for which you change security scope settings by using a site name or a site code, or you can use the Get-CMSite cmdlet to specify a site.

Parameters

-AddActiveDirectoryForest<IResultObject[]>

Specifies an array of Active Directory Forest objects to publish in Active Directory Domain Services. To obtain an Active Directory Forest object, use the Get-ADForest cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AddCertificateByPath<String[]>

Specifies an array of paths to certificates.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AddClientRequestServiceType<ClientRequestServiceType>

Specifies a service type to add. The acceptable values for this parameter are:

-- ClientNotificationTcp
-- ClientRequestHttpTcp
-- ClientRequestHttpTcpDefault
-- ClientRequestHttpsTcp
-- ClientRequestHttpsTcpDefault
-- WakeOnLanUdp

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ClientCertificateCustomStoreName<String>

Specifies the name of a custom store that contains client certificates.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ClientCertificateSelectionCriteriaType<ClientCertificateSelectionCriteriaType>

Specifies the criteria type to match in a client certificate, such as a string or attribute for a subject or an alternate name for a subject.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ClientCertificateSelectionCriteriaValue<String>

Specifies a value for the ClientCertificateSelectionCriteriaType.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ClientCheckCertificateRevocationListForSiteSystem<Boolean>

Indicates whether to check the Certificate Revocation List (CRL) for a certificate.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ClientComputerCommunicationType<ClientComputerCommunicationType>

Specifies the communication type. The acceptable values for this parameter are: HttpsOnly and HttpsOrHttp.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Comment<String>

Specifies a comment for a Configuration Manager site.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ConcurrentSendingDelayBeforeRetryingMinutes<Int32>

Specifies the number of minutes to wait before retrying failed communication.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CriticalAlertWhenFreeDiskSpaceFallBelowFollowingValueGB<Int32>

Specifies the free disk space threshold, in gigabytes, for a critical alert.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-EnableWakeOnLan<Boolean>

Indicates whether to send Wake On LAN packets for scheduled activities such as deployments of software updates.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-GenerateAlertWhenFreeDiskSpaceOnSiteDatabaseIsLow<Boolean>

Indicates whether to generate an alert when free disk space on the site database reaches a threshold.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-InputObject<IResultObject>

Specifies a Configuration Manager site object. To obtain a Configuration Manager site object, use the Get-CMSite cmdlet.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-MaximumConcurrentSendingForAllSite<Int32>

Specifies the maximum number of simultaneous communications to all sites.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-MaximumConcurrentSendingForPerSite<Int32>

Specifies the maximum number of simultaneous communications to any single site.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-MaximumNumberOfSendingWakeUpPacketBeforePausing<Int32>

Specifies the maximum number of wake-up packets transmitted by this site server before pausing.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Name<String>

Specifies the name of a Configuration Manager site.

Aliases	SiteName
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PortForClientRequestServiceType<Int32>

Specifies a port number, such as 80 or 8080, for client requests.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RemoveActiveDirectoryForest<IResultObject[]>

Specifies an array of Active Directory Forest objects to remove from Active Directory Domain Services.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RemoveCertificateByKey<String[]>

Specifies an array of certificates to remove.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RemoveClientRequestServiceType<ClientRequestServiceType>

Specifies a service type to remove. The acceptable values for this parameter are:

-- ClientNotificationTcp
-- ClientRequestHttpTcp
-- ClientRequestHttpTcpDefault
-- ClientRequestHttpsTcp
-- ClientRequestHttpsTcpDefault
-- WakeOnLanUdp

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RequireSha256<Boolean>

Indicates whether to use the SHA-256 algorithm to sign communications.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RequireSigning<Boolean>

Indicates whether to require Configuration Manager sites to sign communications with other sites.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RetryNumberForConcurrentSending<Int32>

Specifies the number of times to retry a failed communication.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RetryNumberOfSendingWakeUpPacketTransmission<Int32>

Specifies the number of times a wake-up packet is sent to a target computer.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SecurityScopeAction<SecurityScopeActionType>

Specifies an action for a security scope. The acceptable values for this parameter are: AddMembership and RemoveMembership.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SecurityScopeName<String>

Specifies the name of a security scope. A security scope name can be Default or the name of a custom security scope.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SendingWakeUpPacketBeforePausingWaitSeconds<Int32>

Specifies the number of wake-up packets to send before pausing. The default value is 10.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SendingWakeUpPacketTransmissionDelayMinutes<Int32>

Specifies the amount of time that wake-up packet transmission is halted between retries.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SendingWakeUpPacketTransmissionOffsetMinutes<Int32>

Specifies the amount of time that wake-up packets are sent prior to a scheduled activity that is enabled for Wake On LAN. The default value is 3.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SiteCode<String>

Specifies a site code for a Configuration Manager site to which you assign security scopes.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-TakeActionForMultipleCertificateMatchCriteria<TakeActionForMultipleCertificateMatchCriteria>

Specifies the action to take for multiple matches of certificate criteria.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ThreadNumberOfSendingWakeUpPacket<Int32>

Specifies the number of threads a site server uses when sending wake-up packets.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-UseCustomWebSite<Boolean>

Indicates whether to use a custom web site. Use a custom web site when you do not want to use the default web site.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-UseEncryption<Boolean>

Indicates whether to use encryption for communication between sites.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-UsePkiClientCertificate<Boolean>

Indicates whether to use a PKI certificate management solution.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-WakeOnLanTransmissionMethodType<WakeOnLanTransmissionMethodType>

Specifies the type of transmission method to use for Wake On LAN transmissions.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-WakeOnLanType<WakeOnLanType>

Specifies the type of Wake On LAN packet to use.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-WarningAlertWhenFreeDiskSpaceFallBelowFollowingValueGB<Int32>

Specifies a threshold, in gigabytes, for free disk space.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Add a site to a security scope by using a site name

This command assigns a custom security scope named Scope22 to a System Center 2012 Configuration Manager site named CMSiteSystem.

PS C:\> Set-CMSite -SecurityScopeAction AddMembership -SecurityScopeName "Scope22" -SiteName "CMSiteSystem"

Example 2: Remove a security scope for a site by using the site name

This command removes the custom security scope in the previous example from a System Center 2012 Configuration Manager site named CMSiteSystem.

PS C:\> Set-CMSite -SecurityScopeAction RemoveMembership -SecurityScopeName "Scope22" -SiteName "CMSiteSystem"

Related topics

Get-ADForest

Get-CMSite