Edit

Share via

Remove-IpamDhcpConfigurationEvent

  • Reference
Module:
IpamServer

Removes configuration events for DHCP servers from the IPAM database.

Syntax

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

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.

Examples

Example 1: Remove events through the previous day

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

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.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EndDate

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.

Type:DateTime
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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
Required:False
Accept pipeline input:False
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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

IpamDhcpConfigurationEvent

Represents a DHCP server configuration event in IPAM.