Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-DhcpServerSetting

Set-DhcpServerSetting

ps_dhcpserversetting_v1.0.0.cdxml

Synopsis

Sets one or more server level configuration parameters for the Dynamic Host Configuration Protocol (DHCP) server service.

Syntax

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

Detailed Description

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

Parameters

-ActivatePolicies <Boolean>

Specifies the enabled state for enforcement of policies. 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 <SwitchParameter>

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

Session

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

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ConflictDetectionAttempts <UInt32>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NapEnabled <Boolean>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NpsUnreachableAction <String>

Specifies that, if the NapEnabled parameter is set to 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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-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

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerSetting

Return Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerSetting

Notes

None

Examples

EXAMPLE 1

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

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

Online Version
Get-DhcpServerSetting