Set-IpamServerInventory
Modifies the properties of an infrastructure server in the IPAM server inventory.
Syntax
Set-IpamServerInventory
[-Name] <String>
[[-NewName] <String>]
[-ManageabilityStatus <ManageabilityStatus>]
[-Owner <String>]
[-ServerType <ServerRole[]>]
[-Description <String>]
[-AddCustomConfiguration <String>]
[-RemoveCustomConfiguration <String>]
[-Force]
[-PassThru]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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.
Examples
Example 1: Modify the properties of a server
PS C:\> Set-IpamServerInventory -Name "Dhcp01" -ManageabilityStatus Managed -PassThru
This command modifies the properties of an infrastructure server named Dhcp01, and makes it manageable by IPAM.
The command includes the PassThru parameter, so it displays results to the console.
Parameters
-AddCustomConfiguration
Specifies custom configuration to add to the server inventory.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
Required: | False |
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 |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Specifies a description for the server.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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.
Type: | ManageabilityStatus |
Accepted values: | Unspecified, Unmanaged, Managed |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the FQDN of the infrastructure server to modify.
Type: | String |
Aliases: | ServerName |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NewName
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.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Owner
Specifies the owner of the Dynamic Host Configuration Protocol (DHCP) server.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemoveCustomConfiguration
Specifies the metadata fields to modify. List the metadata as a series of custom field names, separated by semicolons (;).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ServerType
Specifies an array of server roles that are present on the server.
The acceptable values for this parameter are:
- DHCP
- DC
- DNS
- NPS
Type: | ServerRole[] |
Accepted values: | DC, DNS, DHCP, NPS |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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 |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
IpamServerInventory
This cmdlet returns an object that represents an infrastructure server in IPAM system.