Add-DhcpServerv4Scope

Add-DhcpServerv4Scope

Adds an IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service.

Syntax

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

Detailed Description

The Add-DhcpServerv4Scope cmdlet adds an IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters.

Parameters

-ActivatePolicies<Boolean>

Specifies the enabled state of the policy enforcement on the scope being added.

Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-AsJob

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 number of milliseconds by which the DHCP server service should wait before responding to the client requests. This parameter should be configured if the scope is part of a split scope deployment and this DHCP server service should act as a secondary DHCP server service for the scope being added.

Aliases

none

Required?

false

Position?

named

Default Value

0

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Description<String>

Specifies the description string for the IPv4 scope being added.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-EndRange<IPAddress>

Specifies the ending IP address of the range within the subnet from which IP addresses should be leased by the DHCP server service.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-LeaseDuration<TimeSpan>

Specifies the time interval for which an IP address should be leased to a client in this scope. This should be specified in the format day.hrs:mins:secs.

Aliases

none

Required?

false

Position?

named

Default Value

8.00:00:00

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-MaxBootpClients<UInt32>

Specifies, if the scope type is specified as Both to allow for both DHCP and BootP clients, the maximum number of BootP clients which should be leased an IP address from this scope.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the IPv4 scope being added.

Aliases

none

Required?

true

Position?

4

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-NapEnable

Specifies the enabled state of Network Access Protection (NAP) for this scope. If NAP is enabled, then the DHCP server service passes the statement of health (SoH) received from the client to the network policy server (NPS). Based on the NAP profile set, the NPS determines the network access to be granted to the client.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-NapProfile<String>

Specifies that the NAP profile should be set only if NAP is enabled on the scope. The NAP profile refers to the MS Service Class which is a condition used in network policies on NPS.

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

-StartRange<IPAddress>

Specifies the starting IP address of the range within the subnet from which IP addresses should be leased by the DHCP server service.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-State<String>

Specifies the state of the scope when created. The acceptable values for this parameter are: Active or Inactive. Only an active scope will respond to client requests. The default value is Active.

Aliases

none

Required?

false

Position?

named

Default Value

Active

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SubnetMask<IPAddress>

Specifies the subnet mask for the scope specified in IP address format. For example: 255.255.255.0.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SuperscopeName<String>

Specifies the name of the superscope to which the scope will be 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 clients to be serviced by the scope. The acceptable values for this parameter are: DHCP, BootP, or 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

DHCP

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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 adds a new scope for 10.10.10.0/24 subnet on the DHCP server service running on the local computer.

PS C:\> Add-DhcpServerv4Scope -Name "Lab-4 Network" -StartRange 10.10.10.1 -EndRange 10.10.10.254 -SubnetMask 255.255.255.0

EXAMPLE 2

This example adds the specified inactive scope for 20.20.20.0/24 subnet on the DHCP server service. The scope is enabled for NAP.

PS C:\> Add-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -Name "Lab-5 Network" -StartRange 20.20.20.1 -EndRange 20.20.20.254 -SubnetMask 255.255.255.0 -State InActive -NapEnable

EXAMPLE 3

This example adds a new scope for 30.30.30.0/24 subnet on the DHCP server service running on the local computer. The scope is added as part of the superscope named Expanded Lab-6 Network.

PS C:\> Add-DhcpServerv4Scope -Name "Lab-6 Network" -StartRange 30.30.30.1 -EndRange 30.30.30.254 -SubnetMask 255.255.255.0 -SuperScope "Expanded Lab-6 Network"

Get-DhcpServerv4Scope

Get-DhcpServerv4ScopeStatistics

Remove-DhcpServerv4Scope

Set-DhcpServerv4Scope