Set-IpamConfiguration

Modifies the configuration for the computer that runs the IPAM server.

Syntax

Set-IpamConfiguration
   [-ProvisioningMethod] <ProvisioningMethod>
   [[-GpoPrefix] <String>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-Force]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-WhatIf]
   [<CommonParameters>]
Set-IpamConfiguration
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-Force]
   -HmacKey <SecureString>
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-UpdateTables]
   [-WhatIf]
   [<CommonParameters>]
Set-IpamConfiguration
   [-Port] <UInt16>
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-Force]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-WhatIf]
   [<CommonParameters>]
Set-IpamConfiguration
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-Force]
   [-PassThru]
   [-RefreshHmacKey]
   [-ThrottleLimit <Int32>]
   [-WhatIf]
   [<CommonParameters>]
Set-IpamConfiguration
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-Force]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-UpdateTables]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-IpamConfiguration cmdlet modifies the IP Address Management (IPAM) server configuration, including the TCP port over which the computer that runs the IPAM Remote Server Administration Tools (RSAT) client connects and communicates with the computer that runs the IPAM server.

Examples

Example 1: Modify an IPAM configuration

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

 Port : 45000

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

The command includes the PassThru parameter, so it displays results to the console.

Required Parameters

-HmacKey

Specifies a keyed-hash message authentication code (HMAC).

Type:SecureString
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Port

Specifies the TCP port number for communication between computers that run the IPAM RSAT client and the IPAM server. IPAM lets you configure any port number in the range 1-65535 for communication between computers that run the IPAM client and server. To avoid port conflicts with well-known ports, choose a port from the unassigned port range, 48620-49150. By default, IPAM uses port number 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.

Type:UInt16
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ProvisioningMethod

Specifies a provisioning method.

The acceptable values for this parameter are: Automatic and Manual.

Type:ProvisioningMethod
Parameter Sets:Automatic, Manual
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-RefreshHmacKey

Indicates that the cmdlet refreshes the HMAC key, if the key has expired.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UpdateTables

Indicates that the cmdlet updates the database tables.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional 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
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
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GpoPrefix

Specifies the unique Group Policy Object (GPO) prefix name that IPAM uses to create the group policy objects. Use this parameter only when the value of the ProvisioningMethod parameter is set to Automatic.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
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.

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.Windows.Ipam.Commands.IpamConfiguration

This cmdlet returns an object that contains an IPAM configuration.