Get-IpamConfigurationEvent
Gets IPAM configuration events from the IPAM database.
Syntax
Get-IpamConfigurationEvent
[-UserName <String[]>]
[-UserDomainName <String[]>]
[-UserForestName <String[]>]
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] 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 parameters 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.
Examples
Example 1: Get IPAM server configuration events for a span of time
PS C:\> $Today = Get-Date
PS C:\> $LastMonth = $Today.AddDays(-30)
PS C:\> Get-IpamConfigurationEvent -StartDate $LastMonth -EndDate $TodayThis 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.
Example 2: Get IPAM configuration events for a user
PS C:\> $Today = Get-Date
PS C:\> $LastMonth = $Today.AddDays(-30)
PS C:\> Get-IpamConfigurationEvent -StartDate $LastMonth -EndDate $Today -UserName "Administrator"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.
Example 3: Get IPAM configuration events for User from domain
PS C:\> $Today = Get-Date
PS C:\> $LastMonth = $Today.AddDays(-30)
PS C:\> Get-IpamConfigurationEvent -StartDate $LastMonth -EndDate $Today -UserName "Administrator" -UserDomainName "Contoso.com"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.
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.
| 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-CimSession or Get-CimSession 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 |
-EndDate
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.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartDate
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.
| Type: | DateTime |
| 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 |
-UserDomainName
Specifies an array of names of user domains. The cmdlet filters configuration events that occur in this user domain.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UserForestName
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UserName
Specifies an array of names of user names. The cmdlet gets configuration events made by these users.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Outputs
IpamConfigurationEvent
This cmdlet returns an object that represents a configuration event for the IPAM server.