Set-IpamServerInventory

Article
06/30/2015

Set-IpamServerInventory

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

Syntax

Parameter Set: SetIpamServerInventory1
Set-IpamServerInventory [-Name] <String> [[-NewName] <String> ] [-AddCustomConfiguration <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-Force] [-ManageabilityStatus <ManageabilityStatus> ] [-Owner <String> ] [-PassThru] [-RemoveCustomConfiguration <String> ] [-ServerType <ServerRole[]> ] [-ThrottleLimit <Int32> ] [-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

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

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

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

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

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

IpamServerInventory

Represents an infrastructure server in IPAM system.

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

Add-IpamServerInventory

Get-IpamServerInventory

Remove-IpamServerInventory

Set-IpamServerInventory