Set-DhcpServerv4Scope
Sets the properties of an existing IPv4 scope on the DHCP server service.
Syntax
Set-DhcpServerv4Scope
[-ActivatePolicies <Boolean>]
[-PassThru]
[-Type <String>]
[-ScopeId] <IPAddress>
[-Description <String>]
[-LeaseDuration <TimeSpan>]
[-Name <String>]
[-NapEnable <Boolean>]
[-NapProfile <String>]
[-Delay <UInt16>]
[-State <String>]
[-SuperscopeName <String>]
[-ComputerName <String>]
[-MaxBootpClients <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-DhcpServerv4Scope
[-ActivatePolicies <Boolean>]
[-PassThru]
[-Type <String>]
[-ScopeId] <IPAddress>
[-Description <String>]
[-LeaseDuration <TimeSpan>]
[-Name <String>]
[-NapEnable <Boolean>]
[-NapProfile <String>]
[-Delay <UInt16>]
[-State <String>]
[-SuperscopeName <String>]
[-ComputerName <String>]
[-MaxBootpClients <UInt32>]
-StartRange <IPAddress>
-EndRange <IPAddress>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-DhcpServerv4Scope cmdlet sets the properties of an existing IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service.
Examples
Example 1: Set values for a scope
PS C:\> Set-DhcpServerv4Scope -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -Name "Ext Lab Net VLAN100" -State Active -LeaseDuration 4.00:00:00This example sets the name of the specified DHCPv4 scope to Ext Lab Net VLAN100, activates the scope, and sets the lease duration to 4 days.
Parameters
-ActivatePolicies
Specifies the enabled state for the policy enforcement on the scope.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-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 |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.
| Type: | String |
| Aliases: | Cn |
| 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 |
-Delay
Specifies the time, in milliseconds, by which the DHCP server service should delay sending a response to the clients. This parameter should be used on the secondary DHCP server service in a split scope configuration.
| Type: | UInt16 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Description
Specifies the description to set for the scope.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EndRange
Specifies the ending address of the IPv4 range to set for the scope. If a new IPv4 range is being set, then the previously set IPv4 range of the scope is discarded.
| Type: | IPAddress |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LeaseDuration
Specifies the duration of the IPv4 address lease to give for the clients of the scope.
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaxBootpClients
Specifies the maximum number of Bootp clients permitted to get an IP address lease from the scope. This parameter can only be used if the Type parameter value is Both.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name for the scope.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NapEnable
Specifies the enabled state for network access protection (NAP) for the scope.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NapProfile
Specifies the name of the NAP profile for clients in the scope. The NAP profile refers to the Microsoft Service Class which is a condition used in network policies on the network policy server (NPS). This parameter can only be used if the NapEnable parameter value is $True.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScopeId
Specifies the scope identifier (ID), in IPv4 address format, for which the properties are set.
| Type: | IPAddress |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StartRange
Specifies the starting address of the IPv4 range to set for the scope. If a new IP range is being set, the previously set IP range of the scope is discarded.
| Type: | IPAddress |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-State
Specifies the state of the scope. The acceptable values for this parameter are: Active and InActive.
| Type: | String |
| Accepted values: | Active, InActive |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SuperscopeName
Specifies the name of the superscope to which this scope is added.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Type
Specifies the type of the scope. The acceptable values for this parameter are: DHCP, BootP, and Both. The type of the scope determines if the DHCP server service responds to only DHCP client requests, only BootP client requests, or Both types of clients.
| Type: | String |
| Accepted values: | Dhcp, Bootp, Both |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Outputs
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.