Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Set-DhcpServerv4Scope

Updated: January 9, 2013

Applies To: Windows Server 2012

Set-DhcpServerv4Scope

Sets the properties of an existing IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service.

Syntax

Parameter Set: WithoutRange
Set-DhcpServerv4Scope [-ScopeId] <IPAddress> [-ActivatePolicies <Boolean> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Delay <UInt16> ] [-Description <String> ] [-LeaseDuration <TimeSpan> ] [-MaxBootpClients <UInt32> ] [-Name <String> ] [-NapEnable <Boolean> ] [-NapProfile <String> ] [-PassThru] [-State <String> ] [-SuperscopeName <String> ] [-ThrottleLimit <Int32> ] [-Type <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: WithRange
Set-DhcpServerv4Scope [-ScopeId] <IPAddress> -EndRange <IPAddress> -StartRange <IPAddress> [-ActivatePolicies <Boolean> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Delay <UInt16> ] [-Description <String> ] [-LeaseDuration <TimeSpan> ] [-MaxBootpClients <UInt32> ] [-Name <String> ] [-NapEnable <Boolean> ] [-NapProfile <String> ] [-PassThru] [-State <String> ] [-SuperscopeName <String> ] [-ThrottleLimit <Int32> ] [-Type <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-DhcpServerv4Scope cmdlet sets the properties of an existing IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service.

Parameters

-ActivatePolicies<Boolean>

Specifies the enabled state for the policy enforcement on the scope. The acceptable values for this parameter are:  True or False.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

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.


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

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String>

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Delay<UInt16>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Description<String>

Specifies the description to set for the scope.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-EndRange<IPAddress>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-LeaseDuration<TimeSpan>

Specifies the duration of the IPv4 address lease to give for the clients of the scope.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-MaxBootpClients<UInt32>

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 set to Both.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name to set for the scope.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-NapEnable<Boolean>

Specifies the enabled state for network access protection (NAP) for the scope. The acceptable values for this parameter are:  True or False.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-NapProfile<String>

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 set to True.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ScopeId<IPAddress>

Specifies the scope identifier (ID), in IPv4 address format, for which the properties are being set.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-StartRange<IPAddress>

Specifies the starting address of the IPv4 range to set for the scope. If a new IP range is being set, then the previously set IP range of the scope is discarded.


Aliases

none

Required?

true

Position?

named

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SuperscopeName<String>

Specifies the name of the superscope to which this scope is added.


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

-Type<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope

    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 output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope

    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.


Examples

EXAMPLE 1

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


PS C:\> Set-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Name "Ext Lab Net VLAN100" -State Active -LeaseDuration 4.00:00:00

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.