Edit

Share via

Set-CMMulticastServicePoint

Module:
ConfigurationManager Module

Sets a multicast service point.

Syntax

ByValue (Default) 

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

ByName 

Set-CMMulticastServicePoint
    [-SiteSystemServerName] <String>
    [-ClientTransferRate <NetworkProfile>]
    [-EnableScheduledMulticast <Boolean>]
    [-EndIPAddress <String>]
    [-EndUdpPort <Int32>]
    [-MaximumClientCount <Int32>]
    [-MinimumClientCount <Int32>]
    [-PassThru]
    [-SessionStartDelayMins <Int32>]
    [-SiteCode <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

Parameter properties

Type:NetworkProfile
Default value:None
Accepted values:None, ProfileCustom, Profile10Mbps, Profile100Mbps, Profile1Gbps
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

-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

-EnableScheduledMulticast

Indicates whether you can schedule when Configuration Manager deploys the operating system image from the distribution 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

-EndIPAddress

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

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

-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.

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

-ForceWildcardHandling

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

-InputObject

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

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MulticastServicePoint

Parameter sets

ByValue
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-MaximumClientCount

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MulticastMaximumClientCount

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MinimumClientCount

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MinimumSessionSize

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

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

-SessionStartDelayMins

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SessionStartDelayMinutes

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SiteCode

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SiteSystemServerName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name, ServerName

Parameter sets

ByName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StartIPAddress

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

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

-StartUdpPort

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

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

-UseAnyRangeIP

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.

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

-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.

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

-WhatIf

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.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object