Import-DhcpServer
Import-DhcpServer
Imports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, from the specified file.
Syntax
Parameter Set: __AllParameterSets
Import-DhcpServer [-File] <String> [-BackupPath] <String> [-CimSession <CimSession> ] [-ComputerName <String> ] [-Force] [-Leases] [-Prefix <IPAddress[]> ] [-ScopeId <IPAddress[]> ] [-ScopeOverwrite] [-ServerConfigOnly] [ <CommonParameters>]
Detailed Description
The Import-DhcpServer cmdlet imports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, from the specified file. This cmdlet is only supported for the DHCP server services running on Windows Server® 2012.
If either the ScopeId or the Prefix parameter, or the ScopeId and Prefix parameters are specified, then only the specified scopes or prefixes will be imported.
If neither the ScopeId nor the Prefix parameter is specified, then all of the configurations contained in the file, and optionally any lease data, will be imported.
If the Leases parameter is specified, then the lease data in the specified file is imported in addition to configuration data.
If the ScopeOverWrite parameter is specified and the scope being imported exists on the destination server, then the scope on the target DHCP server service will be overwritten. If this parameter is not specified and the scope being imported exists on the destination DHCP server service, then a warning message is displayed and the import will proceed to process the next scope being imported.
If the ServerConfigOnly parameter is specified, then only the server level configuration will be imported on the destination DHCP server service. If the file specified contains any scope information, then the same information will not be imported on the destination DHCP server service.
Parameters
-BackupPath<String>
Specifies the path where DHCP server database is backed up before making any configuration changes as part of the import operation.
Aliases |
none |
Required? |
true |
Position? |
2 |
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-File<String>
Specifies the name of the file from which the data will be imported. If a complete file path is not specified, then the file will be read from the current working directory.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-Leases
Specifies that the lease data will also be imported.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Prefix<IPAddress[]>
Specifies the subnet prefixes of IPv6 scopes which are to be imported.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScopeId<IPAddress[]>
Specifies the scope identifiers (IDs), in IPv4 address format, which need to be imported.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScopeOverwrite
Specifies that, if the scope being imported exists on the target server, the scope on the destination DHCP server service will be overwritten.
If this parameter is not specified and the scope being imported exists on the destination DHCP server service, then a warning message is displayed and import will proceed to process the next scope being imported.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServerConfigOnly
Specifies that only server level configuration will be imported on the destination DHCP server service. If the file specified contains any scope information, then the same will not be imported on the destination DHCP server service.
Both DHCPv4 and DHCPv6 server level configurations will be imported.
The server level configuration comprises of (both v4 and v6):
-- Class definitions.
-- Option definitions.
-- Option values.
-- Server level Policies (DHCPv4).
-- MAC address filters (DHCPv4).
-- Other Server Properties (ConflicDetectionAttempts, DHCPv6 stateless store).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example imports the configuration data in the specified file onto the DHCP server service running one the computer named dhcpserver.contoso.com. The file can contain DHCPv4 as well as DHCPv6 configuration data.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exports\dhcpexport.xml -BackupPath C:\dhcpbackup\
EXAMPLE 2
This example imports the configuration and lease data in the specified file onto the DHCP server service running on the computer named dhcpserver.contoso.com. The file can contain DHCPv4 as well as DHCPv6 configuration data.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exports\dhcpexport.xml -BackupPath C:\dhcpbackup\ -Leases
EXAMPLE 3
This example imports the configuration data for scopes 10.10.10.0 and 20.20.20.0 from the specified file onto the DHCP server service running on the computer named dhcpserver.contoso.com. If the export file contains scopes besides 10.10.10.0 and 20.20.20.0, then those scopes are ignored. The DHCPv4 server level configuration data, if present in the export file, is also imported onto the DHCP server service.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exports\dhcpexport.xml -BackupPath C:\dhcpbackup\ -ScopeId 10.10.10.0,20.20.20.0
EXAMPLE 4
This example imports the configuration and lease data for scopes 10.10.10.0 and 20.20.20.0 from the specified file onto the DHCP server service running on the computer named dhcpserver.contoso.com. If the export file contains scopes besides 10.10.10.0 and 20.20.20.0, then those scopes are ignored. The DHCPv4 server level configuration data, if present in the export file, is also imported onto the DHCP server service.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exports\dhcpexport.xml -BackupPath C:\dhcpbackup\ -ScopeId 10.10.10.0,20.20.20.0 -Leases
EXAMPLE 5
This example imports the configuration and lease data for scopes 10.10.10.0 and 20.20.20.0 from the specified file onto the DHCP server service running on the computer named dhcpserver.contoso.com. If the export file contains scopes besides 10.10.10.0 and 20.20.20.0, then those scopes are ignored. The DHCPv4 server level configuration data, if present in the export file, is also imported onto the server. If the scopes 10.10.10.0 and 20.20.20.0 are already present on the DHCP server service running one the computer named dhcpserver.contoso.com, then the scopes are deleted and recreated from the data in the export file.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exports\dhcpexport.xml -BackupPath C:\dhcpbackup\ -ScopeId 10.10.10.0,20.20.20.0 -Leases -ScopeOverwrite
EXAMPLE 6
This example imports only the server level configuration data in the specified file onto the DHCP server service running on the computer named dhcpserver.contoso.com. Any scope configuration data, if present in the file, is ignored.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exports\dhcpexport.xml -BackupPath C:\dhcpbackup\ -ServerConfigOnly
EXAMPLE 7
This example imports the configuration data for scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: from the specified file onto the DHCP server service running on the computer named dhcpserver.contoso.com. If the export file contains scopes besides 2001:4898:7020:1020:: and 2001:4898:7020:1030::, then those scopes are ignored. The DHCPv6 server level configuration data, if present in the export file, is also imported onto the DHCP server service.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exports\dhcpexport.xml -BackupPath C:\dhcpbackup\ -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030::
EXAMPLE 8
This example imports the configuration and lease data for scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: from the specified file onto the DHCP server service running on the computer named dhcpserver.contoso.com. If the export file contains scopes besides 2001:4898:7020:1020:: and 2001:4898:7020:1030::, then those scopes are ignored. The DHCPv6 server level configuration data, if present in the export file, is also imported onto the DHCP server service.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exports\dhcpexport.xml -BackupPath C:\dhcpbackup\ -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030:: -Leases
EXAMPLE 9
This example imports the configuration and lease data for scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: from the specified file onto the DHCP server service running on the computer named dhcpserver.contoso.com. If the export file contains scopes besides 2001:4898:7020:1020:: and 2001:4898:7020:1030::, then those scopes are ignored. The DHCPv6 server level configuration data, if present in the export file, is also imported onto the DHCP server service. If the scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: are already present on the DHCP server service running on the computer named dhcpserver.contoso.com, then the scopes are deleted and recreated from the data in the export file.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exports\dhcpexport.xml -BackupPath C:\dhcpbackup\ -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030:: -Leases -ScopeOverwrite
EXAMPLE 10
This example imports a list of scopes specified in file named ScopeList.txt to the DHCP server service running on the computer named dhcpserver.contoso.com.
The file named ScopeList.txt should contain the following format:
ScopeID
10.10.10.0
20.20.20.0
30.30.30.0
The Import-Csv cmdlet gets the list of scopes to import and returns it in the variable named $scopeIdList.
PS C:\> $scopeIdList = Import-Csv –Path .\ScopeList.txt
This cmdlet imports the scopes using the variable named $scopeIdList as input for the ScopeId parameter.
PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -Leases -ScopeId $scopeIdList.ScopeId -BackupPath C:\dhcpbackup\