Set-DhcpServerDatabase

Set-DhcpServerDatabase

Modifies one or more configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service.

Syntax

Parameter Set: Set1
Set-DhcpServerDatabase [[-FileName] <String> ] [[-BackupPath] <String> ] [-AsJob] [-BackupInterval <UInt32> ] [-CimSession <CimSession[]> ] [-CleanupInterval <UInt32> ] [-ComputerName <String> ] [-PassThru] [-RestoreFromBackup <Boolean> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-DhcpServerDatabase cmdlet modifies one or more configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service.

Parameters

-AsJob

-BackupInterval<UInt32>

Specifies the interval of time between automatic database backups, in minutes.

-BackupPath<String>

Specifies the path of the directory where the database should be backed up.

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

-CleanupInterval<UInt32>

Specifies the interval of time for database cleanup, in minutes.

-ComputerName<String>

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

-FileName<String>

Specifies the name of the database backup file.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-RestoreFromBackup<Boolean>

Indicates that database has to be restored from backup.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<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/DhcpServerDatabase

Outputs

The output type is the type of the objects that the cmdlet emits.

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

  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 file name to D:\NewDhcpPath\dhcp.mdb and the backup path to D:\NewDhcpPath\backup. This cmdlet also sets the periodicity of the database backup to 30 minutes and the periodic cleanup of the database to 120 minutes.

PS C:\> Set-DhcpServerDatabase -ComputerName dhcpserver.contoso.com -FileName D:\NewDhcpPath\dhcp.mdb -BackupPath D:\NewDhcpPath\backup -BackupInterval 30 -CleanupInterval 120

Related topics

Get-DhcpServerDatabase