Set-DhcpServerv4MulticastScope
Set-DhcpServerv4MulticastScope is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Modifies the properties of a multicast scope.
Description
The Set-DhcpServerv4MulticastScope cmdlet modifies the properties of a multicast scope on the Dynamic Host Configuration Protocol (DHCP) server.
Parameters
-AsJob
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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.
Type: | CimSession[] |
Aliases: | Session |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ComputerName
Specifies the DNS name or IP address of the target computer that runs the DHCP Server service.
Type: | String |
Aliases: | Cn |
Position: | Named |
Default value: | None |
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 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Specifies a description for the scope. The default value is null.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-EndRange
Specifies the end address of the range for the scope.
Type: | IPAddress |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ExpiryTime
Specifies the expiry time of the multicast scope. The default value is infinite.
Type: | DateTime |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LeaseDuration
Specifies the duration of the IP address lease. The default value 30 days.
Type: | TimeSpan |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of a multicast scope.
Type: | String |
Position: | 1 |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NewName
Specifies a new name for the multicast scope.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StartRange
Specifies the start address of the range of IP addresses for the scope.
Type: | IPAddress |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-State
Specifies the state of the scope. Only an active scope responds to client requests. An inactive scope exists on the server but is dormant and not functional. It does not respond. The acceptable values for this parameter are:
- Active
- Inactive
The default value is Active.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ThrottleLimit
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.
Type: | Int32 |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Ttl
Specifies the number of routers through which multicast traffic can pass. The default value is 32.
Type: | UInt32 |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Syntax
Set-DhcpServerv4MulticastScope [-ComputerName <String>] [-Description <String>] [-EndRange <IPAddress>] [-LeaseDuration <TimeSpan>] [-Name] <String> [-PassThru] [-StartRange <IPAddress>] [-State <String>] [-Ttl <UInt32>] [-NewName <String>] [-ExpiryTime <DateTime>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
—————EXAMPLE 1—————
Modify the properties of a multicast scope
PS C:> Set-DhcpServerv4MulticastScope Name “Multicast_VideoConference” -ComputerName “dhcpsrv.TOSSolution.com” -ExpiryTime “1/1/2021 0:01 AM” -LeaseDuration 40 -NewName “Multicast_VideoConferenceBuilding1” -State Active
This command activates the multicast scope named Multicast_VideoConference and renames it Multicast_VideoConferenceBuilding1. The command sets the lease duration to 40 days and sets the expiry time of the multicast scope.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Set-DhcpServerv4MulticastScope
You can also read about
- Get-DhcpServerv4MulticastScope
- Add-DhcpServerv4MulticastScope
- Get-DhcpServerv4MulticastScopeStatistics
To know more PowerShell cmdlets(Commands) on DHCPServer click here