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
 

Remove-IpamDhcpConfigurationEvent

Remove-IpamDhcpConfigurationEvent

ipamdhcpconfigurationevent.cdxml

Synopsis

Removes configuration events for DHCP servers from the IPAM database.

Syntax

Remove-IpamDhcpConfigurationEvent [-AsJob] [-CimSession] [-Force] [-PassThru] [-ThrottleLimit] [-EndDate] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-IpamDhcpConfigurationEvent cmdlet removes configuration events for Dynamic Host Configuration Protocol (DHCP) servers from the IP Address Management (IPAM) database. The cmdlet permanently deletes configuration events through the specified end date. The end date uses the time zone of the IPAM server.

Use the Get-IpamDhcpConfigurationEvent cmdlet to view configuration events from the IPAM database.

Do not specify the current date as the end date. The IPAM server collects the configuration events from DHCP servers as part of the next data gathering task, and, therefore, specifying the current date does not result in permanently deleting events from the current day.

The cmdlet does not delete the configuration events from the DHCP servers themselves.

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

-EndDate <DateTime>

Specifies the end date as a DateTime object. The cmdlet removes events through this date from the IPAM database. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.

Do not specify the current date.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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


Return Type

IpamDhcpConfigurationEvent

Notes

None

Examples

Example 1: Remove events through the previous day

This example removes all configuration events through the previous day.

The first command creates a DateTime object by using the Get-Date cmdlet, and then stores it in the $Today variable. By default, Get-Date creates the current date. For more information about Get-Date and DateTime objects, type Get-Help Get-Date.

The second command removes configuration events from the IPAM database through the previous day. The command subtracts one day from the DateTime object stored in the $Today variable, and then specifies that value for the EndDate parameter.

PS C:\> $Today = Get-DatePS C:\>Remove-IpamConfigurationEvent -EndDate $Today.AddDays(-1)

Online Version
Get-IpamDhcpConfigurationEvent