Set-CMDistributionPoint

SYNOPSIS

Sets a distribution point.

SYNTAX

SetByValue (Default)

Set-CMDistributionPoint [-InputObject] <IResultObject> [-Description <String>]
 [-ClientCommunicationType <ComputerCommunicationType>] [-ClientConnectionType <ClientConnectionTypes>]
 [-AllowProxyTraffic <Boolean>] [-EnableAnonymous <Boolean>] [-CertificateExpirationTimeUtc <DateTime>]
 [-CertificatePath <String>] [-CertificatePassword <SecureString>] [-AllowPreStaging <Boolean>]
 [-EnablePxe <Boolean>] [-KeepWds <Boolean>] [-AllowPxeResponse <Boolean>]
 [-EnableUnknownComputerSupport <Boolean>] [-PxePassword <SecureString>]
 [-UserDeviceAffinity <UserDeviceAffinityType>] [-RespondToAllNetwork]
 [-MacAddressForRespondingPxeRequest <String[]>] [-AddMacAddressForRespondingPxeRequest <String[]>]
 [-RemoveMacAddressForRespondingPxeRequest <String[]>] [-ClearMacAddressForRespondingPxeRequest]
 [-PxeServerResponseDelaySec <Int32>] [-EnableMulticast <Boolean>] [-UseComputerAccount] [-UserName <String>]
 [-UseAnyRangeIP] [-StartIPAddress <String>] [-EndIPAddress <String>] [-StartUdpPort <Int32>]
 [-EndUdpPort <Int32>] [-ClientTransferRate <NetworkProfile>] [-MulticastMaximumClientCount <Int32>]
 [-EnableScheduledMulticast <Boolean>] [-SessionStartDelayMins <Int32>] [-MinimumSessionSize <Int32>]
 [-EnableContentValidation <Boolean>] [-ContentValidationSchedule <IResultObject>]
 [-ContentMonitoringPriority <Priority>] [-EnablePullDP <Boolean>] [-SourceDistributionPoint <String[]>]
 [-SourceDPRank <Int32[]>] [-AllowFallbackForContent <Boolean>] [-AddBoundaryGroupName <String[]>]
 [-RemoveBoundaryGroupName <String[]>] [-EnableBranchCache <Boolean>] [-PassThru] [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

SetByName

Set-CMDistributionPoint [-SiteSystemServerName] <String> [-SiteCode <String>] [-Description <String>]
 [-ClientCommunicationType <ComputerCommunicationType>] [-ClientConnectionType <ClientConnectionTypes>]
 [-AllowProxyTraffic <Boolean>] [-EnableAnonymous <Boolean>] [-CertificateExpirationTimeUtc <DateTime>]
 [-CertificatePath <String>] [-CertificatePassword <SecureString>] [-AllowPreStaging <Boolean>]
 [-EnablePxe <Boolean>] [-KeepWds <Boolean>] [-AllowPxeResponse <Boolean>]
 [-EnableUnknownComputerSupport <Boolean>] [-PxePassword <SecureString>]
 [-UserDeviceAffinity <UserDeviceAffinityType>] [-RespondToAllNetwork]
 [-MacAddressForRespondingPxeRequest <String[]>] [-AddMacAddressForRespondingPxeRequest <String[]>]
 [-RemoveMacAddressForRespondingPxeRequest <String[]>] [-ClearMacAddressForRespondingPxeRequest]
 [-PxeServerResponseDelaySec <Int32>] [-EnableMulticast <Boolean>] [-UseComputerAccount] [-UserName <String>]
 [-UseAnyRangeIP] [-StartIPAddress <String>] [-EndIPAddress <String>] [-StartUdpPort <Int32>]
 [-EndUdpPort <Int32>] [-ClientTransferRate <NetworkProfile>] [-MulticastMaximumClientCount <Int32>]
 [-EnableScheduledMulticast <Boolean>] [-SessionStartDelayMins <Int32>] [-MinimumSessionSize <Int32>]
 [-EnableContentValidation <Boolean>] [-ContentValidationSchedule <IResultObject>]
 [-ContentMonitoringPriority <Priority>] [-EnablePullDP <Boolean>] [-SourceDistributionPoint <String[]>]
 [-SourceDPRank <Int32[]>] [-AllowFallbackForContent <Boolean>] [-AddBoundaryGroupName <String[]>]
 [-RemoveBoundaryGroupName <String[]>] [-EnableBranchCache <Boolean>] [-PassThru] [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Set-CMDistributionPoint cmdlet modifies a distribution point on a site system server.

EXAMPLES

Example 1: Set properties of a distribution point

PS C:\> $DP = Get-CMDistributionPoint -SiteSystemServerName "MySiteSys_11310.Contoso.com"
PS C:\> Set-CMDistributionPoint -InputObject $DP -AllowFallbackForContent $True -AllowPreStaging $True -AllowPxeResponse $False -ClientCommunicationType Http -ClientConnectionType Internet -ContentMonitoringPriority High

The first command gets the distribution point object for the site system server named MySiteSys_11310.Contoso.com and stores the object in the $DP variable.

The second command modifies the distribution point object stored in $DP.

Example 2: Set properties of a distribution point by using the pipeline

PS C:\> Get-CMDistributionPoint -SiteSystemServerName "MySiteSys_11310.Contoso.com" | Set-CMDistributionPoint -AllowFallbackForContent $True -AllowPreStaging $True -AllowPxeResponse $True -ClientCommunicationType Http -ClientConnectionType Internet -ContentMonitoringPriority High

This command gets the distribution point object for the site system server named MySiteSys_11310.Contoso.com and uses the pipeline operator to pass the object to Set-CMDistributionPoint, which modifies the distribution point object.

PARAMETERS

-AddBoundaryGroupName

Adds an array of boundary groups, by name, to a distribution point.

Type: String[]
Parameter Sets: (All)
Aliases: AddBoundaryGroupNames

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

-AddMacAddressForRespondingPxeRequest

Adds an array of media access control (MAC) addresses that respond to Pre-boot eXecution Environment (PXE) requests for a PXE-enabled distribution point.

Type: String[]
Parameter Sets: (All)
Aliases: 

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

-AllowFallbackForContent

Indicates whether clients outside of the boundary groups associated with a site system can fall back and use this site system as a source location for content when no other site systems are available.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-AllowPreStaging

Indicates whether the distribution point is enabled for prestaged content.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-AllowProxyTraffic

Type: Boolean
Parameter Sets: (All)
Aliases: EnableCloudGateway

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

-AllowPxeResponse

Indicates whether the distribution point can respond to PXE requests.

Type: Boolean
Parameter Sets: (All)
Aliases: AllowRespondIncomingPxeRequest

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

-CertificateExpirationTimeUtc

Specifies, in UTC format, the date and time when the certificate expires.

Type: DateTime
Parameter Sets: (All)
Aliases: 

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

-CertificatePassword

Specifies, as a secure string, the password for a PKI client certificate.

Type: SecureString
Parameter Sets: (All)
Aliases: 

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

-CertificatePath

Specifies the import path for a PKI client certificate.

Type: String
Parameter Sets: (All)
Aliases: 

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

-ClearMacAddressForRespondingPxeRequest

Indicates that the cmdlet removes the array of MAC addresses that the distribution point uses to respond to PXE requests.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-ClientCommunicationType

Specifies how clients or devices communicate with the distribution point. Valid values are:

  • HTTP
  • HTTPS
Type: ComputerCommunicationType
Parameter Sets: (All)
Aliases: 
Accepted values: Http, Https

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

-ClientConnectionType

Specifies the client connection type. Valid values are:

  • Internet
  • InternetAndIntranet
  • Intranet
Type: ClientConnectionTypes
Parameter Sets: (All)
Aliases: 
Accepted values: Intranet, Internet, InternetAndIntranet

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

-ClientTransferRate

Specifies the client transfer rate. Valid values are:

  • None
  • Profile100Mbps
  • Profile10Mbps
  • Profile1Gbps
  • ProfileCustom
Type: NetworkProfile
Parameter Sets: (All)
Aliases: 
Accepted values: None, ProfileCustom, Profile10Mbps, Profile100Mbps, Profile1Gbps

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-ContentMonitoringPriority

Specifies the content monitoring priority. Valid values are:

  • High
  • Highest
  • Low
  • Lowest
  • Medium
Type: Priority
Parameter Sets: (All)
Aliases: 
Accepted values: Lowest, Low, Medium, High, Highest

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

-ContentValidationSchedule

Specifies a schedule token object that the distribution point uses to validate content on a scheduled basis. To create a schedule token object, use the New-CMSchedule cmdlet.

Type: IResultObject
Parameter Sets: (All)
Aliases: ValidateContentSchedule

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

-Description

Specifies a description for the distribution point.

Type: String
Parameter Sets: (All)
Aliases: 

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

-DisableWildcardHandling

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-EnableAnonymous

Indicates that the distribution point permits anonymous connections from Configuration Manager clients to the content library.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-EnableBranchCache

Indicates that clients that use Windows BranchCache are allowed to download content from an on-premises distribution point. Content downloads from cloud-based distribution points can always be shared by clients that use Windows BranchCache.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-EnableContentValidation

Indicates that content validation is enabled for this distribution point.

Type: Boolean
Parameter Sets: (All)
Aliases: EnableValidateContent

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

-EnableMulticast

Indicates whether multicast is enabled for the distribution point.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-EnablePullDP

Enables, when set to $True, the distribution point is able to pull content from other distribution points.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-EnablePxe

Indicates whether PXE is enabled on the distribution point.

When you enable PXE, Configuration Manager installs Windows Deployment Services on the server, if required. Windows Deployment Services is the service that performs the PXE boot to install operating systems. After you create the distribution point, Configuration Manager installs a provider in Windows Deployment Services that uses the PXE boot functions.

Type: Boolean
Parameter Sets: (All)
Aliases: EnablePxeSupport

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

-EnableScheduledMulticast

Indicates whether you can schedule when Configuration Manager deploys the operating system image from the distribution point.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-EnableUnknownComputerSupport

Indicates whether support for unknown computers is enabled. Unknown computers are computers that are not managed by Configuration Manager.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-EndIPAddress

Specifies the ending IP address in a range of multicast addresses that Configuration Manager uses to send data to clients.

Type: String
Parameter Sets: (All)
Aliases: 

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

-EndUdpPort

Specifies the ending UDP port in a range of multicast UDP ports that Configuration Manager uses to send data to clients.

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-ForceWildcardHandling

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-InputObject

Specifies a distribution point object. To obtain a distribution point object, use the Get-CMDistributionPoint cmdlet.

Type: IResultObject
Parameter Sets: SetByValue
Aliases: DistributionPoint

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-KeepWds

Indicates whether the distribution point keeps Windows Deployment Services (WDS) or removes WDS when PXE is disabled.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-MacAddressForRespondingPxeRequest

Specifies an array of MAC addresses that the distribution point uses to respond to PXE requests.

Type: String[]
Parameter Sets: (All)
Aliases: 

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

-MinimumSessionSize

Specifies how many client requests must be received before a scheduled multicast starts to deploy the operating system.

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-MulticastMaximumClientCount

Specifies the maximum number of clients that can download the operating system from this distribution point.

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-PassThru

Returns the current working object. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-PxePassword

Specifies, as a secure string, the PXE password.

Type: SecureString
Parameter Sets: (All)
Aliases: ComputersUsePxePassword

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

-PxeServerResponseDelaySec

Specifies, in seconds, how long the distribution point delays before it responds to computer requests when you are using multiple PXE-enabled distribution points. By default, the Configuration Manager PXE service point responds first to network PXE requests.

Type: Int32
Parameter Sets: (All)
Aliases: PxeServerResponseDelaySeconds

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

-RemoveBoundaryGroupName

Removes an array of boundary groups, by name, from the distribution point.

Type: String[]
Parameter Sets: (All)
Aliases: RemoveBoundaryGroupNames

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

-RemoveMacAddressForRespondingPxeRequest

Removes an array of MAC addresses that the distribution point uses to respond to PXE requests.

Type: String[]
Parameter Sets: (All)
Aliases: 

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

-RespondToAllNetwork

Indicates that the distribution point responds to PXE requests that arrive on any of its network interfaces.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-SessionStartDelayMins

Specifies the number of minutes that Configuration Manager waits before it responds to the first deployment request.

Type: Int32
Parameter Sets: (All)
Aliases: SessionStartDelayMinutes

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

-SiteCode

Specifies the site code for the Configuration Manager site that hosts this site system role.

Type: String
Parameter Sets: SetByName
Aliases: 

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

-SiteSystemServerName

Specifies the name of a server that hosts a site system role.

Type: String
Parameter Sets: SetByName
Aliases: Name, ServerName

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceDPRank

Specifies an array that contains the priorities for the distribution point sources from which this distribution point can pull content. Source distribution points that have the same priority are randomly selected.

Type: Int32[]
Parameter Sets: (All)
Aliases: SourceDPRanks

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

-SourceDistributionPoint

Specifies an array of distribution point sources from which this distribution point can pull content.

Type: String[]
Parameter Sets: (All)
Aliases: SourceDistributionPoints

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

-StartIPAddress

Specifies the starting IP address in a range of multicast addresses that Configuration Manager uses to send data to clients.

Type: String
Parameter Sets: (All)
Aliases: 

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

-StartUdpPort

Specifies the starting UDP port in a range of multicast UDP ports that Configuration Manager uses to send data to clients.

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-UseAnyRangeIP

Indicates that multicast uses IP addresses within any range.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-UseComputerAccount

Indicates that the distribution point uses its computer account as the multicast connection account when it connects to the primary site database.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-UserDeviceAffinity

Specifies how you want the distribution point to associate users with their devices for PXE deployments. Valid values are:

  • AllowWithAutomaticApproval
  • AllowWithManualApproval
  • DoNotUse
Type: UserDeviceAffinityType
Parameter Sets: (All)
Aliases: 
Accepted values: DoNotUse, AllowWithManualApproval, AllowWithAutomaticApproval

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

-UserName

Specifies the name of the user that the distribution point uses to connect to the primary site database. Use the format domain\username.

Type: String
Parameter Sets: (All)
Aliases: 

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

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

INPUTS

OUTPUTS

NOTES

Add-CMDistributionPoint

Get-CMDistributionPoint

Get-CMSiteSystemServer

New-CMSchedule

Remove-CMDistributionPoint

Update-CMDistributionPoint