Set-DhcpServerAuditLog
Set-DhcpServerAuditLog is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Sets the Dynamic Host Configuration Protocol (DHCP) server service audit log configuration on the DHCP server service running on the computer.
Description
The Set-DhcpServerAuditLog cmdlet sets the Dynamic Host Configuration Protocol (DHCP) server service audit log configuration on the DHCP server service running on the computer This cmdlet also sets the enabled state for the DHCP server service audit log.
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 |
-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 |
-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 |
-DiskCheckInterval
Specifies the number of audit log events after which the DHCP server service checks the available disk space as specifies in the MinMBDiskSpace parameter.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Enable
Specifies the enabled state of the DHCP server service audit log. The acceptable values for this parameter are: True or False.
| Type: | Boolean |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaxMBFileSize
Specifies the maximum disk space available for all DHCP service audit log files, in megabytes (MB).
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MinMBDiskSpace
Specifies the minimum required disk space, in megabytes (MB), for audit log storage. Before it logs an audit log message, the DHCP server service checks if the minimum disk space specified by this parameter is available on the disk. If minimum disk space is not available, the DHCP server service stops audit logging until the required minimum disk space is available. If you specify a value of zero (0) or do not specify this parameter, the minimum disk space is 20 MB.
| Type: | UInt32 |
| Position: | Named |
| 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 |
-Path
Specifies the path to the directory where the audit log files are created by the DHCP server service.
| Type: | String |
| Position: | 2 |
| 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-DhcpServerAuditLog [[-Enable] <Boolean>] [[-Path] <String>] [-MaxMBFileSize <UInt32>] [-DiskCheckInterval <UInt32>] [-MinMBDiskSpace <UInt32>] [-ComputerName <String>] [-PassThru] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
—————EXAMPLE 1—————
PS C:>Set-DhcpServerAuditLog -ComputerName dhcpsrv.TOSSolution.com -Enable True -Path E:\dhcpalog\ -MaxMBFileSize 200
This example enables the audit log of the DHCP server service and sets the path for the audit log to D:\dhcpalog\ directory. This cmdlet also sets the maximum size for the audit log file to 200 MB.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Set-DhcpServerAuditLog
You can also read about
- Get-DhcpServerAuditLog
To know more PowerShell cmdlets(Commands) on DHCPServer click here
