Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-DhcpServerv4MulticastScope

Add-DhcpServerv4MulticastScope

ps_dhcpserverv4multicastscope_v1.0.0.cdxml

Synopsis

Adds a multicast scope on the DHCP server.

Syntax

Add-DhcpServerv4MulticastScope [-Name] [-StartRange] [-EndRange] [-AsJob] [-CimSession] [-ComputerName] [-Description] [-ExpiryTime] [-LeaseDuration] [-PassThru] [-State] [-ThrottleLimit] [-Ttl] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-DhcpServerv4MulticastScope cmdlet adds a multicast scope on the Dynamic Host Configuration Protocol (DHCP) server.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ComputerName <String>

Specifies the DNS name or IP address of the target computer that runs the DHCP Server service.

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Description <String>

Specifies a description of the multicast scope. The default value is null.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-EndRange <IPAddress>

Specifies the end address of the range for the scope.

Aliases

None

Required?

true

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ExpiryTime <DateTime>

Specifies the expiry time of the multicast scope. The default value is infinite.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-LeaseDuration <TimeSpan>

Specifies the duration of the IP address lease. The default value 30 days.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies a name for the multicast scope.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-StartRange <IPAddress>

Specifies the start address of the range of IP addresses for the scope.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-State <String>

Specifies the state of the scope. The acceptable values for this parameter are:       -- Active      -- Inactive

The default value is Active.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Ttl <UInt32>

Specifies the number of routers through which multicast traffic passes. The default value is 32.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#DhcpServerv4MulticastScope

Notes

None

Examples

Example 1: Add an inactive multicast scope

This command creates an inactive multicast scope named Multicast_AudioConference on the DHCP server named DhcpServer01.Contoso.com. The command specifies the lease duration of 20 days for allocating addresses to participants of audio conferences. You can allocate a single multicast address to multiple clients. The command specifies that the traffic passes through 20 routers.

PS C:\> Add-DhcpServerv4MulticastScope -ComputerName "DhcpServer01.Contoso.com" -Name "Multicast_AudioConference" -StartRange 224.0.0.0 -EndRange 224.0.0.30 -State Inactive -Ttl 20-LeaseDuration 20

Example 2: Add an active multicast scope

This command creates an active multicast scope named Multicast_AudioConference on the DHCP server named DhcpServer01.Contoso.com. You can use the multicast scope on the DHCP server service for allocating addresses to participants of video conferences. You can allocate a single multicast address to multiple clients. The traffic passes through 32 routers, and the lease duration is 30 days.

PS C:\>Add-DhcpServerv4MulticastScope -ComputerName "DhcpServer01.Contoso.com" -Name "Multicast_VideoConference" -StartRange 224.0.0.50 -EndRange 224.0.0.80 

Online Version
Get-DhcpServerv4MulticastScope
Set-DhcpServerv4MulticastScope
Remove-DhcpServerv4MulticastScope