Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-IpamServerInventory

Add-IpamServerInventory

ipamserverinventory.cdxml

Synopsis

Adds an infrastructure server to an IPAM database.

Syntax

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

Detailed 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.

Parameters

-AsJob <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <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.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CustomConfiguration <String>

Specifies custom metadata for the server.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Description <String>

Specifies a description for the server.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ManageabilityStatus <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.

Aliases

None

Required?

false

Position

named

Default value

Unspecified

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

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

Aliases

ServerName

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Owner <String>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-ServerType <ServerRole[]>

Specifies an array of server roles that are present on the server. The acceptable values for this parameter are:  -- DC -- DHCP -- DNS -- NPS

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

IpamServerInventory

Notes

None

Examples

Example 1: Add a server to the IPAM server inventory

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

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

Online Version
Get-IpamServerInventory
Remove-IpamServerInventory
Set-IpamServerInventory