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
 

Set-IpamServerInventory

Set-IpamServerInventory

ipamserverinventory.cdxml

Synopsis

Modifies the properties of an infrastructure server in the IPAM server inventory.

Syntax

Set-IpamServerInventory [-Name] [-NewName] [-AddCustomConfiguration] [-AsJob] [-CimSession] [-Description] [-Force] [-ManageabilityStatus] [-Owner] [-PassThru] [-RemoveCustomConfiguration] [-ServerType] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-IpamServerInventory cmdlet modifies the properties of an infrastructure server in an IP Address Management (IPAM) server inventory. Use the server name or fully qualified domain name (FQDN) to identify the server. If you only specify the server name, IPAM tries to resolve the server name.

Parameters

-AddCustomConfiguration <String>

Specifies custom configuration to add to the server inventory.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-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

-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

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ManageabilityStatus <ManageabilityStatus>

Specifies the manageability status of a server. The acceptable values for this parameter are:  -- Unspecified -- Managed -- Unmanaged If you specify a value of Managed for this parameter, IPAM gathers data from the server.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the FQDN of the infrastructure server to modify.

Aliases

ServerName

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NewName <String>

Specifies the new name or FQDN of an infrastructure server. IPAM tries to resolve the name to an IP address and reports an error if it cannot resolve the name.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Owner <String>

Specifies the owner of the 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

-RemoveCustomConfiguration <String>

Specifies the metadata fields to modify. List the metadata as a series of custom field names, separated by semicolons (;).

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:  -- DHCP -- DC -- DNS -- NPS

Aliases

None

Required?

false

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: Modify the properties of a server

This command modifies the properties of an infrastructure server named Dhcp01, and makes it manageable by IPAM.

PS C:\> Set-IpamServerInventory -Name "Dhcp01" -ManageabilityStatus Managed -PassThru

Online Version
Add-IpamServerInventory
Get-IpamServerInventory
Remove-IpamServerInventory