Export (0) Print
Expand All
Expand Minimize

Get-IpamDhcpConfigurationEvent

Windows Server 2012 R2 and Windows 8.1

Updated: December 18, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-IpamDhcpConfigurationEvent

Gets configuration events for DHCP servers from the IPAM database.

Syntax

Parameter Set: Query (cdxml)
Get-IpamDhcpConfigurationEvent [-AsJob] [-CimSession <CimSession[]> ] [-EndDate <DateTime> ] [-ServerName <String[]> ] [-StartDate <DateTime> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-IpamDhcpConfigurationEvent cmdlet gets configuration events for Dynamic Host Configuration Protocol (DHCP) servers from the IP Address Management (IPAM) database. You can specify fully qualified domain names (FQDNs) of DHCP servers, a start date, and an end date. If you do not specify a DHCP server, the cmdlet gets configuration events for all servers.

Use the Remove-IpamDhcpConfigurationEvent cmdlet to remove events from the database.

If you do not specify a start date, the cmdlet uses the date of the first IPAM configuration event in the database. If you do not specify an end date, the cmdlet uses the date of the last IPAM configuration event. All dates use the time zone of the IPAM server.

If there are more than 10,000 results for a command, the cmdlet returns only 10,000. The cmdlet warns that this is a partial result.

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.


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 gets events through this date from the IPAM database. To obtain a DateTime object, use the Get-Date cmdlet and specify the date in DD/MM/YYYY format. For more information, type Get-Help Get-Date.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServerName<String[]>

Specifies an array of FQDNs of DHCP servers.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-StartDate<DateTime>

Specifies the start date as a DateTime object. The cmdlet gets events beginning with this date. To obtain a DateTime object, use the Get-Date cmdlet and specify the date in DD/MM/YYYY format.


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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • IpamDhcpConfigurationEvent

    Represents a DHCP server configuration event in IPAM.


Examples

Example 1: Get events for all servers for a date range

This example gets the configuration events for all DHCP servers, and then saves them as a .csv file.

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 stores a new DateTime object in the $StartTime variable. That date is seven days prior to the date stored in the $Today variable.

The third command gets configuration events between the start date, stored in the $StartDate variable, and the end date, stored in the $Today variable, for all DHCP servers. The command passes the events to the Export-Csv cmdlet by using the pipeline operator. That cmdlet saves the results as a .csv file. For more information about this cmdlet, type Get-Help Export-Csv.


PS C:\> $Today = Get-Date
PS C:\>$StartDate= $Today.AddDays(-7)
PS C:\>Get-IpamDhcpConfigurationEvent -EndDate $Today -StartDate $StartDate | Export-Csv "C:\IpamEvents.csv"

Example 2: Get events for specified servers for a date range

This example gets the configuration events for two DHCP servers, and then saves them as a .csv file.

The first command creates a DateTime object by using the Get-Date cmdlet, and then stores it in the $Today variable.

The second command stores a new DateTime object in the $StartTime variable. That date is seven days prior to the date stored in the $Today variable.

The third command gets configuration events between the start date, stored in the $StartDate variable, and the end date, stored in the $Today variable. The command specifies the FQDNs of two DHCP servers. The command passes the events to the Export-Csv cmdlet by using the pipeline operator. That cmdlet saves the results as a .csv file.


PS C:\> $Today = Get-Date
PS C:\> $StartDate= $Today.AddDays(-7)
PS C:\> Get-IpamConfigurationEvent -EndDate $Today -ServerName "dhcp01.contoso.com","dhcp02.contoso.com" -StartDate $StartDate | Export-Csv "C:\IpamFilteredEvents.csv"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft