Set-DhcpServerSetting

  • Reference
Module:
DhcpServer

Sets server level configuration parameters for the DHCP server service.

Syntax

Set-DhcpServerSetting
   [-ConflictDetectionAttempts <UInt32>]
   [-NpsUnreachableAction <String>]
   [-NapEnabled <Boolean>]
   [-ComputerName <String>]
   [-ActivatePolicies <Boolean>]
   [-PassThru]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-DhcpServerSetting cmdlet sets one or more server level configuration parameters for the Dynamic Host Configuration Protocol (DHCP) server service.

Examples

Example 1: Set DHCP server settings

PS C:\> Set-DhcpServerSetting -ComputerName "dhcpserver.contoso.com" -NapEnabled $True -ConflictDetectionAttempts 1 -ActivatePolicies $False

This example enables the NAP check, sets the number of conflict detection attempts to 1, and disables policy enforcement on the DHCP server service that runs on the computer named dhcpserver.contoso.com.

Parameters

-ActivatePolicies

Specifies the enabled state for enforcement of policies.

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

-ConflictDetectionAttempts

Specifies the number of times that the DHCP server service attempts conflict detection before leasing an IP address. The acceptable values for this parameter are: 0 through 5. The default value is 0.

Type:UInt32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-NapEnabled

Specifies the enabled state for the Network Access Policy (NAP) check on the DHCP server service. If you set this parameter to $True, NAP is enabled and the DHCP server service uses the Network Policy Server (NPS) to perform a NAP check before leasing an IP address.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-NpsUnreachableAction

Specifies that, if the NapEnabled parameter is $True and the NPS server is unreachable, the default action that the DHCP server service performs. The acceptable values for this parameter are: Full, Restricted, or NoAccess.

Type:String
Accepted values:Full, Restricted, NoAccess
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

-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

-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

CimInstance

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

CimInstance

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.