Export-DhcpServer
Export-DhcpServer is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Exports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, to the specified file.
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
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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.
| Type: | String |
| Aliases: | Cn |
| Position: | Named |
| Default value: | None |
| 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: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-File
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.
| Type: | String |
| Position: | 0 |
| 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Leases
Specifies that IP address leases is also exported.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Prefix
Specifies one or more subnet prefixes of the IPv6 scopes which are exported.
| Type: | IPAddress[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ScopeId
Specifies the scope identifiers, in IPv4 address format, which are exported.
| Type: | IPAddress[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| 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: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Syntax
Export-DhcpServer [-File] <String> [-ScopeId <IPAddress[]>] [-Prefix <IPAddress[]>] [-Leases] [-Force] [-ComputerName <String>] [-CimSession <CimSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
——————EXAMPLE 1——————
PS C:> Export-DhcpServer -ComputerName dhcpsrv.TOSSolution.com -File D:\dhcp\expo\dhcpexport.xml
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.
——————EXAMPLE 2——————
PS C:> Export-DhcpServer -ComputerName dhcpsrv.TOSSolution.com -File D:\dhcp\expo\dhcpexport.xml -ScopeId 192.168.1.0,192.168.2.0
This example exports the specified scopes 192.168.1.0 and 192.168.2.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.
——————EXAMPLE 3——————
PS C:> Import-Csv –Path ScopeList.txt | Export-DhcpServer -ComputerName dhcpsrv.TOSSolution.com -File D:\dhcp\expo\dhcpexport.xml -Leases
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.
——————EXAMPLE 4——————
PS C:> Export-DhcpServer -ComputerName dhcpsrv.TOSSolution.com -File D:\dhcp\expo\dhcpexport.xml -ScopeId 192.168.1.0,192.168.2.0 -Leases
This example exports the specified scopes 192.168.1.0 and 192.168.2.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.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Export-DhcpServer
You can also read about
- Import-Csv
- Backup-DhcpServer
- Import-DhcpServer
- Restore-DhcpServer
To know more PowerShell cmdlets(Commands) on DHCPServer click here
