Export (0) Print
Expand All

Set-IpamConfiguration

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

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.

Syntax

Parameter Set: __AllParameterSets
Set-IpamConfiguration [-Port] <UInt16> [-Force] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-IpamConfiguration cmdlet sets the IP Address Management (IPAM) server configuration, including the TCP port over which the computer running the IPAM Remote Server Administration Tools (RSAT) client connects and communicates with the computer running the IPAM server. This cmdlet can be leveraged to specify an alternate firewall port number for remotely managing the computer running the IPAM server, in the event of a port conflict. The default port number used by IPAM is 48885. The cmdlet configures appropriate custom IPAM server firewall rules for the specified new port, enables appropriate custom IPAM server firewall rules for the specified new port, and restarts the IPAM application pool to listen on the specified new port. This cmdlet must be run from an elevated Windows PowerShell® prompt with administrator privileges on the computer running the IPAM server.

Parameters

-Force

Suppresses the default confirmation text.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Port<UInt16>

Specifies the TCP port number being configured for communication between computers running the IPAM RSAT client and IPAM server. The required firewall rules are also set up for this port. Although IPAM allows any port number from 1 through 65535 to be configured for communication between computers running the IPAM client and server; it is recommended, to avoid port conflicts with well-known ports, that a port from the unassigned port range 48620 through 49150 is selected.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

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.

  • None

Outputs

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

  • Microsoft.Windows.Ipam.Commands.IpamConfiguration

    This object contains an IPAM configuration.


Examples

EXAMPLE 1

This example changes the IPAM server management port to 45000 and suppresses the default confirmation text and returns the modified IPAM server configuration object.


PS C:\> Set-IpamServerConfiguration -Port 45000 -PassThru -Force
Version : 1.3 
 
Port : 45000 

Related topics

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