Set-DhcpServerDatabase
Set-DhcpServerDatabase is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Modifies one or more configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service.
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
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 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BackupInterval
Specifies the interval of time between automatic database backups, in minutes.
Type: | UInt32 |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-BackupPath
Specifies the path of the directory where the database is backed up.
Type: | String |
Position: | 2 |
Default value: | None |
Accept pipeline input: | True |
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 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CleanupInterval
Specifies the interval of time for database cleanup, in minutes.
Type: | UInt32 |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
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 |
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 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FileName
Specifies the name of the database backup file.
Type: | String |
Position: | 1 |
Default value: | None |
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 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RestoreFromBackup
Indicates that database has to be restored from backup.
Type: | Boolean |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
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 |
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 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Syntax
Set-DhcpServerDatabase [[-FileName] <String>] [[-BackupPath] <String>] [-BackupInterval <UInt32>] [-CleanupInterval <UInt32>] [-RestoreFromBackup <Boolean>] [-ComputerName <String>] [-PassThru] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
—————EXAMPLE 1—————
PS C:>Set-DhcpServerDatabase -ComputerName dhcpsrv.TOSSolution.com -FileName E:\NewPath\dhcp.mdb -BackupPath E:\NewPath\backup -BackupInterval 30 -CleanupInterval 120
This example sets the file name to E:\NewPath\dhcp.mdb and the backup path to E:\NewPath\backup. This cmdlet also sets the periodicity of the database backup to 30 minutes and the periodic cleanup of the database to 120 minutes.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Set-DhcpServerDatabase
You can also read about
- Get-DhcpServerDatabase
To know more PowerShell cmdlets(Commands) on DHCPServer click here