Export (0) Print
Expand All

IPAM Server Cmdlets in Windows PowerShell

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

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

Adds a new free form or multi-valued custom field to the computer running the IP Address Management (IPAM) server.

Add-IpamCustomValue

Adds a new custom value to a multi-valued, custom field in IP Address Management (IPAM).

Export-IpamAddress

Exports all of the IP addresses of the specified address family from the computer running the IP Address Management (IPAM) server as a comma-separated value (.csv) file or as an array of Windows PowerShell® objects or both.

Export-IpamRange

Exports all of the IP address ranges of the specified address family from the computer running the IP Address Management (IPAM) server as a comma-separated values (.csv) file or as an array of Windows PowerShell® objects or both.

Get-IpamConfiguration

Gets the configuration for the computer running the IP Address Management (IPAM) server.

Get-IpamCustomField

Gets the IP Address Management (IPAM) custom field information.

Import-IpamAddress

Imports one or more IP address objects from the specified comma-separated values (.csv) file into the computer running the IP Address Management (IPAM) server.

Import-IpamRange

Imports one or more IP address range objects from the specified comma-separated values (.csv) file into the computer running the IP Address Management (IPAM) server.

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 IP Address Management (IPAM) server.

Set-IpamConfiguration

Sets the configuration for the computer running the IP Address Management (IPAM) server, including the TCP port number over which the computer running the IPAM Remote Server Administration Tools (RSAT) client connects with the computer running the IPAM server.

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

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
Get-Help <cmdlet name> -Full

The IPAM module supports the Windows PowerShell configuration file named Microsoft.IPAM to allow non-local administrators to run IPAM cmdlets while following the role-based access control that is determined through the use of the IPAM-specific security groups membership.

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