IP Address Management (IPAM) Server Cmdlets in Windows PowerShell

Artikel
11/16/2015

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

IP Address Management (IPAM) Server

This reference provides cmdlet descriptions and syntax for all IP Address Management (IPAM) Server-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

cmdlet	Description
Add-IpamAddress	Adds an IP address to IPAM.
Add-IpamAddressSpace	Adds an address space to IPAM.
Add-IpamBlock	Adds an IP address block to IPAM.
Add-IpamCustomField	Adds a free-form or multivalued custom field to IPAM.
Add-IpamCustomFieldAssociation	Adds an association between values for custom fields that are defined in IPAM.
Add-IpamCustomValue	Adds a value to a custom field in IPAM.
Add-IpamDiscoveryDomain	Adds a new Active Directory domain to the list of domains in which IPAM discovers infrastructure servers.
Add-IpamRange	Adds an IP address range to the configuration of an IPAM server.
Add-IpamServerInventory	Adds an infrastructure server to an IPAM database.
Add-IpamSubnet	Adds a subnet to IPAM.
Disable-IpamCapability	Disables an optional capability in IPAM.
Enable-IpamCapability	Enables an optional capability on the IPAM server.
Export-IpamAddress	Exports IP addresses from IPAM.
Export-IpamRange	Exports all of the IP address ranges as a file or as an array of objects or both.
Export-IpamSubnet	Exports the IP address subnets of an address family on the computer that runs IPAM.
Find-IpamFreeAddress	Gets one or more free IP addresses from a range of IP addresses in IPAM.
Get-IpamAddress	Gets IP addresses from IPAM.
Get-IpamAddressSpace	Gets address spaces in IPAM.
Get-IpamAddressUtilizationThreshold	Retrieves the threshold configuration for address utilization alerts.
Get-IpamBlock	Gets a set of address blocks from IPAM.
Get-IpamCapability	Gets all optional capabilities in IPAM.
Get-IpamConfiguration	Gets the configuration for the computer that runs IPAM.
Get-IpamConfigurationEvent	Gets IPAM configuration events from the IPAM database.
Get-IpamCustomField	Gets custom fields in IPAM.
Get-IpamCustomFieldAssociation	Gets associations between two custom fields defined in IPAM.
Get-IpamDatabase	Gets configuration settings for the IPAM database.
Get-IpamDhcpConfigurationEvent	Gets configuration events for DHCP servers from the IPAM database.
Get-IpamDiscoveryDomain	Retrieves the list of Active Directory domains in which IPAM discovers infrastructure servers.
Get-IpamIpAddressAuditEvent	Retrieves all IP address audit events in IPAM.
Get-IpamRange	Retrieves a set of IP address ranges from an IPAM server.
Get-IpamServerInventory	Retrieves the properties of managed servers in the IPAM server inventory.
Get-IpamSubnet	Retrieves a set of subnets from IPAM.
Import-IpamAddress	Imports IP address into the IPAM server.
Import-IpamRange	Imports one or more IP address range objects from the specified file into the computer running the IPAM server.
Import-IpamSubnet	Imports IP address subnet objects from the specified file into the computer running IPAM.
Invoke-IpamGpoProvisioning	Creates and links group policies in the specified domain for provisioning required access settings on the servers managed by the computer running the IPAM server.
Invoke-IpamServerProvisioning	Automates the provisioning of IPAM server.
Move-IpamDatabase	Migrates the IPAM database to a SQL Server database.
Remove-IpamAddress	Removes a set of addresses from IPAM.
Remove-IpamAddressSpace	Removes address spaces from IPAM.
Remove-IpamBlock	Removes an address block from IPAM.
Remove-IpamConfigurationEvent	Removes IPAM server configuration events.
Remove-IpamCustomField	Removes a custom field from IPAM.
Remove-IpamCustomFieldAssociation	Removes an association between two custom fields that are defined in IPAM.
Remove-IpamCustomValue	Removes a custom value from IPAM.
Remove-IpamDhcpConfigurationEvent	Removes configuration events for DHCP servers from the IPAM database.
Remove-IpamDiscoveryDomain	Removes a domain from IPAM.
Remove-IpamIpAddressAuditEvent	Removes IP address audit events from the IPAM database.
Remove-IpamRange	Removes a range of IP addresses from an IPAM server configuration.
Remove-IpamServerInventory	Removes a server from an IPAM server inventory.
Remove-IpamSubnet	Removes a subnet from IPAM.
Rename-IpamCustomField	Renames a custom field in IPAM.
Rename-IpamCustomValue	Changes a value for a custom field.
Set-IpamAddress	Modifies an IP address in IPAM.
Set-IpamAddressSpace	Modifies address spaces in IPAM.
Set-IpamAddressUtilizationThreshold	Modifies the address utilization thresholds in IPAM.
Set-IpamBlock	Modifies an IP address block in IPAM.
Set-IpamConfiguration	Modifies the configuration for the computer that runs the IPAM server.
Set-IpamCustomFieldAssociation	Modifies associations of values for custom fields defined in IPAM.
Set-IpamDatabase	Modifies settings that IPAM uses to connect to the IPAM database.
Set-IpamDiscoveryDomain	Modifies the IPAM discovery configuration.
Set-IpamRange	Modifies an existing IP address range.
Set-IpamServerInventory	Modifies the properties of an infrastructure server in the IPAM server inventory.
Set-IpamSubnet	Modifies an existing IP subnet in IPAM.
Update-IpamServer	Updates an IPAM server following an operating system upgrade.

Hinweis

To list all the cmdlets that are available, use the Get-Command -Module IpamServer cmdlet.

Um weitere Informationen zur Syntax beliebiger Cmdlets zu erhalten, verwenden Sie das Get-Help <Cmdlet-Name>-Cmdlet, wobei <Cmdlet-Name> der Name des Cmdlets ist, zu dem Sie Informationen wünschen. Um ausführlichere Informationen zu erhalten, können Sie die folgenden Cmdlets ausführen:

● Get-Help <Cmdlet-Name> -Detailed
● Get-Help <Cmdlet-Name> -Examples
● Get-Help <Cmdlet-Name> -Full

To enable non-local administrators to run IPAM cmdlets when using the role-based access control involving IPAM-specific security group memberships, follow these steps:

Log into the IPAM server.
Start a new Windows PowerShell console with administrator permissions.
Run the following commands, confirming the actions when prompted:
```
New-PSSessionConfigurationFile –Path ./ipam.pssc
Register-PSSessionConfiguration –Name Microsoft.ipam –path .\ipam.pssc
Set-PSSessionConfiguration –Name Microsoft.ipam –ShowSecurityDescriptorUI
```
Then add the following groups from the local machine scope:
- IPAM Administrators
- IPAM ASM Administrators
Make sure they have full control permissions. You can also add any other group whose users have permission to access IPAM.

Now you should be able to see the Microsoft.ipam PowerShell session configuration.
```
Get-PSSessionConfiguration *ipam
```
The following command should now run for any non-local user who belongs to any of the configured IPAM access groups.
```
$TestSession=New-PSSession –computerName <ipamFQDN> -configurationName Microsoft.ipam
```

IP Address Management (IPAM) Server Cmdlets in Windows PowerShell

IP Address Management (IPAM) Server

Zusätzliche Ressourcen