Export-DhcpServer
Export-DhcpServer
Exports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, to the specified file.
Syntax
Parameter Set: __AllParameterSets
Export-DhcpServer [-File] <String> [-CimSession <CimSession> ] [-ComputerName <String> ] [-Force] [-Leases] [-Prefix <IPAddress[]> ] [-ScopeId <IPAddress[]> ] [ <CommonParameters>]
Detailed Description
The Export-DhcpServer cmdlet exports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, to the specified file.
If the ScopeId or Prefix parameter is specified, then only the specified scopes or prefixes and all server level settings are exported.
If neither ScopeId nor Prefix is specified, then the entire DHCP server service configuration including all scopes, v4 and v6 and optionally the lease data, is exported.
If Leases parameter is specified, then the lease data is also exported in addition to configuration data.
Parameters
-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 to which the data will be exported. If the complete file path is not specified, then the file will be created in the current working directory. If there is an existing file by the same name, then an error will be returned.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Specifies that, if there is a file that already exists with the specified name, the file will be overwritten.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Leases
Specifies that IP address leases will also be exported.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Prefix<IPAddress[]>
Specifies one or more subnet prefixes of the IPv6 scopes which are to be exported.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ScopeId<IPAddress[]>
Specifies the scope identifiers, in IPv4 address format, which are to be exported.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
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.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example exports all of the DHCP server, DHCPv4 and DHCPv6, configurations including scopes present on the DHCP server service to the specified export file in XML file format.
PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml
EXAMPLE 2
This example exports the specified scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service to the specified export file in XML file format. The DHCPv4 server level configuration will also be exported to the specified file.
PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -ScopeId 10.10.10.0,20.20.20.0
EXAMPLE 3
This example exports the specified scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service to the specified export file in XML file format, including the leases present in the specified scopes. The DHCPv4 server level configuration will also be exported to the specified file.
PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -ScopeId 10.10.10.0,20.20.20.0 -Leases
EXAMPLE 4
This example exports the specified scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: present on the DHCP server service to the specified export file in XML file format. The DHCPv6 server level configuration will also be exported to the specified file.
PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030::
EXAMPLE 5
This example exports the specified scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: present on the DHCP server service to the specified export file in XML file format, including the leases present in the specified scopes. The DHCP server level configuration will also be exported to the specified file.
PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030:: -Leases
EXAMPLE 6
This example exports a list of scopes specified in file named ScopeList.txt to the specified export file in XML file format. The Import-Csv cmdlet returns the objects containing the scope IDs output and pipes the objects into this cmdlet, which exports the specified scopes.
The file named ScopeList.txt should contain the following format:
ScopeId
10.10.10.0
20.20.20.0
30.30.30.0
PS C:\> Import-Csv –Path ScopeList.txt | Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -Leases