Export-DhcpServer

Export-DhcpServer

Exports the DHCP server service configuration and lease data.

Syntax

Parameter Set: Default
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 you specify the ScopeId or Prefix parameter,only the specified scopes or prefixes and all server level settings are exported.

If you specify neither ScopeId or Prefix, the DHCP server service configuration including all scopes, v4 and v6 and optionally the lease data, is exported.

If you specify the Leases parameter, 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

Session

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 that runs the DHCP server service.


Aliases

Cn

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, the file is created in the current working directory. If there is an existing file by the same name, an error is 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 is overwritten.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Leases

Specifies that IP address leases is also 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 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 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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

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.

  • None

Examples

Example 1: Export all DHCP configurations

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: Export the specified scopes

This example exports the scopes 10.10.10.0 and 10.20.20.0 present on the DHCP server service to the specified export file in XML file format. The DHCPv4 server level configuration is also exported to the specified file.


PS C:\> Export-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exportdir\dhcpexport.xml" -ScopeId 10.10.10.0,10.20.20.0

Example 3: Export specified scopes and their leases

This example exports the scopes 10.10.10.0 and 10.20.20.0 present on the DHCP server service to the specified export file in XML file format. This includes 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,10.20.20.0 -Leases

Example 4: Export the specified scopes and DHCPv6 server level configuration

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 is also 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: Export the specified scopes, their leases, and DHCPv6 server level configuration

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. This includes the leases present in the specified scopes. The DHCP server level configuration is also 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: Export scopes specified in a file

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 that contain 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

Related topics

Community Additions

ADD
Show: