description | external help file | Module Name | ms.date | schema | title |
---|---|---|---|---|---|
Adding distribution points. |
AdminUI.PS.dll-Help.xml |
ConfigurationManager |
09/06/2023 |
2.0.0 |
Add-CMDistributionPoint |
Add a distribution point role.
Add-CMDistributionPoint [-AllowFallbackForContent] [-AllowPreStaging] [-AllowProxyTraffic] [-AllowPxeResponse]
-CertificateExpirationTimeUtc <DateTime> [-ClientConnectionType <ClientConnectionTypes>]
[-ContentMonitoringPriority <Priority>] [-ContentValidationSchedule <IResultObject>] [-Description <String>]
[-EnableAnonymous] [-EnableBranchCache] [-EnableContentValidation] [-EnableLedbat] [-EnableMulticast]
[-EnableNonWdsPxe] [-EnablePullDP] [-EnablePxe] [-EnableScheduledMulticast <Boolean>] [-EnableSsl]
[-EnableUnknownComputerSupport] [-EndIPAddress <String>] [-EndUdpPort <Int32>] [-Force]
-InputObject <IResultObject> [-InstallInternetServer] [-MacAddressForRespondingPxeRequest <String[]>]
[-MinimumFreeSpaceMB <Int32>] [-MinimumSessionSize <Int32>] [-MulticastMaximumClientCount <Int32>]
[-PrimaryContentLibraryLocation <DriveType>] [-PrimaryPackageShareLocation <DriveType>]
[-PxePassword <SecureString>] [-PxeServerResponseDelaySec <Int32>]
[-SecondaryContentLibraryLocation <DriveType>] [-SecondaryPackageShareLocation <DriveType>]
[-SessionStartDelayMins <Int32>] [-SourceDistributionPoint <String[]>] [-SourceDPRank <Int32[]>]
[-StartIPAddress <String>] [-StartUdpPort <Int32>] [-UserDeviceAffinity <UserDeviceAffinityType>]
[-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
[<CommonParameters>]
Add-CMDistributionPoint [-AllowFallbackForContent] [-AllowPreStaging] [-AllowProxyTraffic] [-AllowPxeResponse]
-CertificateExpirationTimeUtc <DateTime> [-ClientConnectionType <ClientConnectionTypes>]
[-ContentMonitoringPriority <Priority>] [-ContentValidationSchedule <IResultObject>] [-Description <String>]
[-EnableAnonymous] [-EnableBranchCache] [-EnableContentValidation] [-EnableLedbat] [-EnableMulticast]
[-EnableNonWdsPxe] [-EnablePullDP] [-EnablePxe] [-EnableScheduledMulticast <Boolean>] [-EnableSsl]
[-EnableUnknownComputerSupport] [-EndIPAddress <String>] [-EndUdpPort <Int32>] [-Force]
[-InstallInternetServer] [-MacAddressForRespondingPxeRequest <String[]>] [-MinimumFreeSpaceMB <Int32>]
[-MinimumSessionSize <Int32>] [-MulticastMaximumClientCount <Int32>]
[-PrimaryContentLibraryLocation <DriveType>] [-PrimaryPackageShareLocation <DriveType>]
[-PxePassword <SecureString>] [-PxeServerResponseDelaySec <Int32>]
[-SecondaryContentLibraryLocation <DriveType>] [-SecondaryPackageShareLocation <DriveType>]
[-SessionStartDelayMins <Int32>] [-SiteCode <String>] [-SiteSystemServerName] <String>
[-SourceDistributionPoint <String[]>] [-SourceDPRank <Int32[]>] [-StartIPAddress <String>]
[-StartUdpPort <Int32>] [-UserDeviceAffinity <UserDeviceAffinityType>] [-UserName <String>]
[-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-CMDistributionPoint [-AllowFallbackForContent] [-AllowPreStaging] [-AllowProxyTraffic] [-AllowPxeResponse]
-CertificatePassword <SecureString> -CertificatePath <String> [-ClientConnectionType <ClientConnectionTypes>]
[-ContentMonitoringPriority <Priority>] [-ContentValidationSchedule <IResultObject>] [-Description <String>]
[-EnableAnonymous] [-EnableBranchCache] [-EnableContentValidation] [-EnableLedbat] [-EnableMulticast]
[-EnableNonWdsPxe] [-EnablePullDP] [-EnablePxe] [-EnableScheduledMulticast <Boolean>] [-EnableSsl]
[-EnableUnknownComputerSupport] [-EndIPAddress <String>] [-EndUdpPort <Int32>] [-Force]
[-InstallInternetServer] [-MacAddressForRespondingPxeRequest <String[]>] [-MinimumFreeSpaceMB <Int32>]
[-MinimumSessionSize <Int32>] [-MulticastMaximumClientCount <Int32>]
[-PrimaryContentLibraryLocation <DriveType>] [-PrimaryPackageShareLocation <DriveType>]
[-PxePassword <SecureString>] [-PxeServerResponseDelaySec <Int32>]
[-SecondaryContentLibraryLocation <DriveType>] [-SecondaryPackageShareLocation <DriveType>]
[-SessionStartDelayMins <Int32>] [-SiteCode <String>] [-SiteSystemServerName] <String>
[-SourceDistributionPoint <String[]>] [-SourceDPRank <Int32[]>] [-StartIPAddress <String>]
[-StartUdpPort <Int32>] [-UserDeviceAffinity <UserDeviceAffinityType>] [-UserName <String>]
[-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-CMDistributionPoint [-AllowFallbackForContent] [-AllowPreStaging] [-AllowProxyTraffic] [-AllowPxeResponse]
-CertificatePassword <SecureString> -CertificatePath <String> [-ClientConnectionType <ClientConnectionTypes>]
[-ContentMonitoringPriority <Priority>] [-ContentValidationSchedule <IResultObject>] [-Description <String>]
[-EnableAnonymous] [-EnableBranchCache] [-EnableContentValidation] [-EnableLedbat] [-EnableMulticast]
[-EnableNonWdsPxe] [-EnablePullDP] [-EnablePxe] [-EnableScheduledMulticast <Boolean>] [-EnableSsl]
[-EnableUnknownComputerSupport] [-EndIPAddress <String>] [-EndUdpPort <Int32>] [-Force]
-InputObject <IResultObject> [-InstallInternetServer] [-MacAddressForRespondingPxeRequest <String[]>]
[-MinimumFreeSpaceMB <Int32>] [-MinimumSessionSize <Int32>] [-MulticastMaximumClientCount <Int32>]
[-PrimaryContentLibraryLocation <DriveType>] [-PrimaryPackageShareLocation <DriveType>]
[-PxePassword <SecureString>] [-PxeServerResponseDelaySec <Int32>]
[-SecondaryContentLibraryLocation <DriveType>] [-SecondaryPackageShareLocation <DriveType>]
[-SessionStartDelayMins <Int32>] [-SourceDistributionPoint <String[]>] [-SourceDPRank <Int32[]>]
[-StartIPAddress <String>] [-StartUdpPort <Int32>] [-UserDeviceAffinity <UserDeviceAffinityType>]
[-UserName <String>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
[<CommonParameters>]
The Add-CMDistributionPoint cmdlet creates a distribution point on a site system server. A distribution point is a site system role that Configuration Manager uses to store files for clients to download. Files such as application content, software packages, software updates, operating system images, and boot images are stored.
Before you can make content available to client computers, assign a site system server as a distribution point. You can add the distribution point site role to a new site system server or add the site role to an existing site system server.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
The first command creates a date object for 30 years from the current date and stores the object in the $Date variable.
The second command gets the site system server object named MySiteSys_11310.Contoso.com and stores the object in the $SystemServer variable.
The third command adds a distribution point to the site system server stored in $SystemServer, and sets the certificate expiration to the date stored in $Date.
$Date = [DateTime]::Now.AddYears(30)
$SystemServer = Get-CMSiteSystemServer -SiteSystemServerName "MySiteSys_11310.Contoso.com"
Add-CMDistributionPoint -InputObject $SystemServer -CertificateExpirationTimeUtc $Date
The first command creates a date object for 30 years from the current date and stores the object in the $Date variable.
The second command gets the site system server object named MySiteSys_11310.Contoso.com. It then uses the pipeline operator to pass the object to Add-DistributionPoint, which adds a distribution point to the site system server object. It then sets the certificate expiration to the date stored in $Date.
$Date = [DateTime]::Now.AddYears(30)
Get-CMSiteSystemServer -SiteSystemServerName "MySiteSys_11310.Contoso.com" | Add-CMDistributionPoint -CertificateExpirationTimeUtc $Date
Indicates that clients outside of the boundary groups associated with a site system can fall back. Those clients can use this site system as a source location for content when no other site systems are available.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates that the distribution point can prestage contents.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Enables the site system to use a proxy server when it connects to the internet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: EnableCloudGateway
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates that the distribution point can respond to PXE requests.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: AllowRespondIncomingPxeRequest
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies, in UTC format, the date and time when the certificate expires.
Type: DateTime
Parameter Sets: DistributionPointWithSelfCertByValue, DistributionPointWithSelfCert
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies, as a secure string, the password for a PKI client certificate.
Type: SecureString
Parameter Sets: DistributionPointwithUserSpecifiedCert, DistributionPointwithUserSpecifiedCertByValue
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the import path for a PKI client certificate.
Type: String
Parameter Sets: DistributionPointwithUserSpecifiedCert, DistributionPointwithUserSpecifiedCertByValue
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the client connection type.
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
Specifies the content monitoring priority.
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
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
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
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates that the distribution point permits anonymous connections from Configuration Manager clients to the content library.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates that content validation is enabled for this distribution point.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: EnableValidateContent
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Enable distribution points to use network congestion control with Windows LEDBAT. This feature can adjust the download speed to use the unused network bandwidth.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates that multicast is enabled for this distribution point.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether the Configuration Manager PXE responder is enabled on the distribution point. When you enable a PXE responder without Windows Deployment Service (WDS), Configuration Manager installs its PXE responder service on the distribution point.
For more information, see enable PXE on the distribution point.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
When set to $True
, the distribution point is able to pull content from other distribution points.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates that PXE is enabled on the distribution point.
When you enable PXE, Configuration Manager installs Windows Deployment Services on the server, if necessary. Windows Deployment Service 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: SwitchParameter
Parameter Sets: (All)
Aliases: EnablePxeSupport
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Indicates that SSL is enabled on this distribution point.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates that support for unknown computers is enabled. Unknown computers are computers that aren't managed by Configuration Manager.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
Use this parameter to add a duplicate certificate without asking for confirmation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a site system server object to add the distribution point role. To get this object, use the Get-CMSiteSystemServer cmdlet.
Type: IResultObject
Parameter Sets: DistributionPointWithSelfCertByValue, DistributionPointwithUserSpecifiedCertByValue
Aliases: SiteServer
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
It's required (and requires) when providing -PreferredMPEnabled parameter. It expects a string input that represents different lookup MPs separated by the * symbol. MPs are filtered based on the Site code of the DP, if the MP's site code is different, an error is thrown.
Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates that Configuration Manager installs and configures Internet Information Services (IIS) on the server if it isn't already installed. The distribution point role requires IIS.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Specifies the amount of free space to reserve on each drive used by this distribution point. When this limit is reached, Configuration Manager chooses a different drive and continues the copy process to that drive. Content files can span multiple drives.
Starting in version 2107, the default minimum free space changed from 50 MB to 500 MB.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
It's a switch parameter. The presence of the parameter indicates that the dynamic MP usage is enabled. PXE has to be enabled on the Distribution Point before using this parameter.
Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the primary content location. Configuration Manager copies content to the primary content location until the amount of free space reaches the value that you specified for the MinimumFreeSpaceMB parameter.
Type: DriveType
Parameter Sets: (All)
Aliases:
Accepted values: Automatic, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the primary package share location. Configuration Manager copies content to the primary package share location until the amount of free space reaches the value that you specified for the MinimumFreeSpaceMB parameter.
Type: DriveType
Parameter Sets: (All)
Aliases:
Accepted values: Automatic, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Specifies, in seconds, how long the distribution point delays before it responds to computer requests when you're 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
Specifies the secondary content location.
Type: DriveType
Parameter Sets: (All)
Aliases:
Accepted values: Automatic, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the secondary package share location.
Type: DriveType
Parameter Sets: (All)
Aliases:
Accepted values: Automatic, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Specify the three-character code for the site that hosts this site system role.
Starting in version 2111, you can't specify the central administration site (CAS) for this parameter, which doesn't support any client-facing site system roles.
Type: String
Parameter Sets: DistributionPointWithSelfCert, DistributionPointwithUserSpecifiedCert
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the name of a server to host a site system role.
Type: String
Parameter Sets: DistributionPointWithSelfCert, DistributionPointwithUserSpecifiedCert
Aliases: Name, ServerName
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Specifies an array containing the priorities for the distribution point sources from which this distribution point can pull content. Source distribution points with 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
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
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
Specifies how you want the distribution point to associate users with their devices for PXE deployments.
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
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
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
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
For more information on this return object and its properties, see SMS_SCI_SysResUse server WMI class.
Install and configure distribution points in Configuration Manager