Set-CMMulticastServicePoint

Sets a multicast service point.

Syntax

Set-CMMulticastServicePoint
   [-ClientTransferRate <NetworkProfile>]
   [-EnableScheduledMulticast <Boolean>]
   [-EndIPAddress <String>]
   [-EndUdpPort <Int32>]
   [-InputObject] <IResultObject>
   [-MaximumClientCount <Int32>]
   [-MinimumClientCount <Int32>]
   [-PassThru]
   [-SessionStartDelayMins <Int32>]
   [-StartIPAddress <String>]
   [-StartUdpPort <Int32>]
   [-UseAnyRangeIP]
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMMulticastServicePoint
   [-ClientTransferRate <NetworkProfile>]
   [-EnableScheduledMulticast <Boolean>]
   [-EndIPAddress <String>]
   [-EndUdpPort <Int32>]
   [-MaximumClientCount <Int32>]
   [-MinimumClientCount <Int32>]
   [-PassThru]
   [-SessionStartDelayMins <Int32>]
   [-SiteCode <String>]
   [-SiteSystemServerName] <String>
   [-StartIPAddress <String>]
   [-StartUdpPort <Int32>]
   [-UseAnyRangeIP]
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-CMMulticastServicePoint cmdlet updates the configuration of multicast settings for a distribution point.

Note

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

Examples

Example 1: Modify a multicast service point by using the pipeline

PS XYZ:\> Get-CMMulticastServicePoint -SiteSystemServerName "server01.contoso.com" | Set-CMMulticastServicePoint -UserName $null -StartIPAddress 224.0.1.0 -EndIPAddress 239.255.255.255 -StartUdpPort 64001 -EndUdpPort 65000 -ClientTransferRate Profile100Mbps -MaximumClientCount 100 -EnableScheduledMulticast $true -SessionStartDelayMins 15 -MinimumClientCount 20

This command gets the multicast service point object with the site system server name server1.contoso.com and uses the pipeline operator to pass the object to Set-CMMulticastServicePoint. Set-CMMulticastServicePoint updates the multicast settings on the distribution point object by creating an IP address range of 224.0.1.0 to 239.255.255.255, and a UDP port range of 64001 to 65000. The command also sets the minimum and maximum client count, and sets a start delay of 15 minutes.

Example 2: Modify a multicast service point

PS XYZ:\> Set-CMMulticastServicePoint -SiteSystemServerName "server02.contoso.com" -UserName "contoso\administrator" -StartIPAddress 224.0.1.0 -EndIPAddress 239.255.255.255 -StartUdpPort 64001 -EndUdpPort 65000 -ClientTransferRate "Profile100Mbps" -MaximumClientCount 100 -EnableScheduledMulticast $true -SessionStartDelayMins 15 -MinimumClientCount 20

This command updates the multicast service point settings for the site system server named server1.contoso.com using the administrator account. The command creates an IP address range of 224.0.1.0 to 239.255.255.255, and a UDP port range of 64001 to 65000. The command also sets the minimum and maximum client count, and sets a start delay of 15 minutes.

Parameters

-ClientTransferRate

No longer used. Transfer speed is dynamic.

Specifies the client transfer rate. Valid values are:

  • None
  • Profile100Mbps
  • Profile10Mbps
  • Profile1Gbps
  • ProfileCustom
Type:NetworkProfile
Accepted values:None, ProfileCustom, Profile10Mbps, Profile100Mbps, Profile1Gbps
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-EnableScheduledMulticast

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

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

-EndIPAddress

Specifies the ending IP address in the range of IP addresses that Configuration Manager uses to send data to the destination computers.

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

-EndUdpPort

Specifies the ending port in the range of user datagram protocol (UDP) ports that Configuration Manager uses to send data to the destination computers.

Type:Int32
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

Specifies a multicast service point object. To obtain a multicast service point object, use the Get-CMMulticastServicePoint cmdlet.

Type:IResultObject
Aliases:MulticastServicePoint
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MaximumClientCount

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

Type:Int32
Aliases:MulticastMaximumClientCount
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MinimumClientCount

Specifies the minimum number of requests that must be received before Configuration Manager starts to deploy the operating system.

Type:Int32
Aliases:MinimumSessionSize
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Returns an object that represents the multicast service point. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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
Aliases:SessionStartDelayMinutes
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SiteCode

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

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

-SiteSystemServerName

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

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

-StartIPAddress

Specifies the starting IP address in the range of IP addresses that Configuration Manager uses to send data to the destination computers.

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

-StartUdpPort

Specifies the starting port in the range of UDP ports that Configuration Manager uses to send data to the destination computers.

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

-UseAnyRangeIP

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

-UserName

Specifies the name of the user that the distribution site system components use to connect to the primary site database. If the UserName parameter is not specified, the cmdlet uses the computer account of the distribution point to the primary site database.

Type:String
Position:Named
Default value:None
Required:False
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

Outputs

System.Object