Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-IpamConfigurationEvent

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

Gets IPAM configuration events from the IPAM database.

Syntax

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




Detailed Description

The Get-IpamConfigurationEvent cmdlet gets IP Address Management (IPAM) configuration events from the IPAM database. If you do not specify any parameters, the cmdlet gets all configuration events for the IPAM server. You can specify the StartDate and EndDate to get configuration events that occur in a span of time. You can specify the UserDomainName parameter to filter configuration events that occur in a user domain. You can specify the UserName parameter to filter configuration changes made by a user.

Specify values for the StartDate and EndDate parameters in the time zone of the IPAM server. The cmdlet returns data that includes both the start date and end date. If you do not specify the StartDate parameter, the cmdlet uses the start date of the first IPAM configuration event in the IPAM database. If you do not specify the EndDate parameter, the cmdlet uses the date of the last available server configuration event in IPAM.

If there are more than 10,000 results for a command, the cmdlet returns only the first 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 configuration events through this date from the IPAM database. The cmdlet gets events from the start date 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

-StartDate<DateTime>

Specifies a start date as a DateTime object. The cmdlet gets configuration events from this date through the end 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

-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

-UserDomainName<String[]>

Specifies an array of names of user domains. The cmdlet filters configuration events that occur in this user domain.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UserName<String[]>

Specifies an array of names of user names. The cmdlet gets configuration events made by these users.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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.

  • IpamConfigurationEvent



    Represents a configuration event for the IPAM server.



Examples

Example 1: Get IPAM server configuration events for a span of time

This example gets all configuration events for the IPAM server in last 30 days.

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 subtracts 30 days from the DateTime object stored in the $Today variable, and then stores the result in the $LastMonth variable.

The third command gets the configuration events for the IPAM server in the last 30 days.


PS C:\> $Today = Get-Date
PS C:\> $LastMonth = $Today.AddDays(-30)
PS C:\> Get-IpamConfigurationEvent -StartDate $LastMonth -EndDate $Today

Example 2: Get IPAM configuration events for a user

This example gets all configuration events for the IPAM server in last 30 days for a user.

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.

The second command subtracts 30 days from the DateTime object stored in the $Today variable, and then stores the result in the $LastMonth variable.

The third command gets the configuration events for the IPAM server in the last 30 days for the user named Administrator.


PS C:\> $Today = Get-Date
PS C:\>$LastMonth = $Today.AddDays(-30)
PS C:\>Get-IpamConfigurationEvent -StartDate $lastMonth -EndDate $Today -UserName "Administrator"

Example 3: Get IPAM configuration events for User from domain

This example gets all the configuration events for the IPAM server in last 30 days for a user from a specified the domain.

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.

The second command subtracts 30 days from the DateTime object stored in the $Today variable, and then stores the result in the $LastMonth variable.

The third command gets all the configuration events for the IPAM server in last 30 days for the user named Administrator from the domain named Contoso.com.


PS C:\> $Today = Get-Date
PS C:\>$LastMonth = $Today.AddDays(-30)
PS C:\>Get-IpamConfigurationEvent -StartDate $LastMonth -EndDate $Today -UserName "Administrator" -UserDomainName "Contoso.com"

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.