Add-Ipam Server Inventory

Module:
ipamserver
Adds an infrastructure server to an IPAM database.

Syntax 

Add-IpamServerInventory
   [-Name] <String>
   -ServerType <ServerRole[]>
   [-ManageabilityStatus <ManageabilityStatus>]
   [-ForestName <String>]
   [-Owner <String>]
   [-Description <String>]
   [-CustomConfiguration <String>]
   [-PassThru]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-IpamServerInventory cmdlet adds a new infrastructure server to the IP Address Management (IPAM) server inventory. Use the fully qualified domain name (FQDN) of the server to add to the server inventory.

Examples

Example 1: Add a server to the IPAM server inventory 

PS C:\> Add-IpamServerInventory -Name "Dhcp1.Contoso.com" -ServerType DHCP

This command adds a DHCP server named Dhcp01.Contoso.com to the IPAM server inventory.

Required Parameters

-Name

Specifies the FQDN of the infrastructure server to add to the server inventory.

Type: String
Aliases: ServerName
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ServerType

Specifies an array of server roles that are present on the server. The acceptable values for this parameter are:

  • DC
  • DHCP
  • DNS
  • NPS
Type: ServerRole[]
Parameter Sets: DC, DNS, DHCP, NPS
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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
-CustomConfiguration

Specifies custom metadata for the server.

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

Specifies a description for the server.

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

Specifies the Simple Mail Transfer Protocol (SMTP) domain name of the target forest.

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

Specifies the manageability status of a server. The acceptable values for this parameter are:

  • Unspecified
  • Managed
  • Unmanaged

IPAM gathers data from the server if this parameter is set to Managed.

Type: ManageabilityStatus
Parameter Sets: Unspecified, Unmanaged, Managed
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Owner

Specifies the owner of the Dynamic Host Configuration Protocol (DHCP) server.

Type: String
Position: Named
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

Outputs

IpamServerInventory

This cmdlet returns an object that represents an infrastructure server in the IPAM system.