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

Set-DhcpServerAuditLog

ps_dhcpserverauditlog_v1.0.0.cdxml

Synopsis

Sets the Dynamic Host Configuration Protocol (DHCP) server service audit log configuration on the DHCP server service running on the computer.

Syntax

Set-DhcpServerAuditLog [-Enable] [-Path] [-AsJob] [-CimSession] [-ComputerName] [-DiskCheckInterval] [-MaxMBFileSize] [-MinMBDiskSpace] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

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

-DiskCheckInterval <UInt32>

Specifies the number of audit log events after which the DHCP server service will check the available disk space as specifies in the MinMBDiskSpace parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Enable <Boolean>

Specifies the enabled state of the DHCP server service audit log. The acceptable values for this parameter are:  True or False.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-MaxMBFileSize <UInt32>

Specifies the maximum size of the audit log, in megabytes (MB).

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-MinMBDiskSpace <UInt32>

Specifies the minimum required disk space, in megabytes (MB), for audit log storage. Before logging a new 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, then the DHCP server service stops audit logging until the required minimum disk space is available. If this parameter value is set to 0 or left as default, then the minimum disk space is set to 20 MB.

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

-Path <String>

Specifies the path to the directory where the audit log files are created by the DHCP server service.

Aliases

None

Required?

false

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

Return Type

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

Notes

None

Examples

EXAMPLE 1

This example enables the audit log of the DHCP server service and sets the path for the audit log to D:\dhcpauditlog\ directory. This cmdlet also sets the maximum size for the audit log file to 100 MB.

PS C:\>Set-DhcpServerAuditLog -ComputerName dhcpserver.contoso.com -Enable True -Path D:\dhcpauditlog\ -MaxMBFileSize 100

Online Version
Get-DhcpServerAuditLog