en-US/DHCPMigration.psm1-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.44--> <!--Generated by: SAPIEN PowerShell HelpWriter 2019 v2.3.44--> <!-- Root Module: DHCPMigration Root Version: 1.0.0 Module: DHCPMigration Version: 0.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Copy-DhcpLease</command:name> <maml:description> <maml:para>Copies DHCP leases from one server to another.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>DhcpLease</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Copies DHCP leases from scopes or an entire DHCP server to the specified destination. Individual scopes can be specified as well. The leases are recreated exactly as they were on the source DHCP instance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByCredential" default="true"> <!--NAME: ByCredential--> <!--TAG: DEFAULT--> <maml:name>Copy-DhcpLease</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The DHCP server the leases will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The DHCP server the leases will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$env:COMPUTERNAME</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="sid"> <maml:name>ScopeId</maml:name> <maml:description> <maml:para>Specifies the IP Addresses of the scopes to pull from and copy the leases to. If this is left $null then all leases from all scopes on the source DHCP server will be copied over to the new one.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress[]</command:parameterValue> <dev:type> <maml:name>IPAddress[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeReservations</maml:name> <maml:description> <maml:para>Specifies to not create any scope reservations that may be found on the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByCimSession"> <!--NAME: ByCimSession--> <maml:name>Copy-DhcpLease</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="sid"> <maml:name>ScopeId</maml:name> <maml:description> <maml:para>Specifies the IP Addresses of the scopes to pull from and copy the leases to. If this is left $null then all leases from all scopes on the source DHCP server will be copied over to the new one.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress[]</command:parameterValue> <dev:type> <maml:name>IPAddress[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeReservations</maml:name> <maml:description> <maml:para>Specifies to not create any scope reservations that may be found on the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The DHCP server the leases will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$env:COMPUTERNAME</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The DHCP server the leases will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="sid"> <maml:name>ScopeId</maml:name> <maml:description> <maml:para>Specifies the IP Addresses of the scopes to pull from and copy the leases to. If this is left $null then all leases from all scopes on the source DHCP server will be copied over to the new one.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress[]</command:parameterValue> <dev:type> <maml:name>IPAddress[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeReservations</maml:name> <maml:description> <maml:para>Specifies to not create any scope reservations that may be found on the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Copy all leases from a source DHCP server to the localhost</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpLease -FromServer 'dhcp1.contoso.com'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Copy all leases from the specified scopes and exclude any reservations to a remote DHCP server</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpLease -FromServer 'dhcp1.contoso.com' -ToServer 'dhcp2.contoso.com' -ScopeId "10.1.1.0", "10.1.2.0" -ExcludeReservations</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Yevrag35/DHCPMigration/wiki/Copy-DhcpLease</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DhcpServerv4Lease</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/add-dhcpserverv4lease</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DhcpServerv4Reservation</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/add-dhcpserverv4reservation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DhcpServerv4Lease</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/get-dhcpserverv4lease</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DhcpServerv4Reservation</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/get-dhcpserverv4reservation</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Copy-DhcpPolicy</command:name> <maml:description> <maml:para>Copies a new policy either at the server or scope level.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>DhcpPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Either all server, all scope, or specific policies by name will be copied from the source DHCP server to its destination.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ServerPoliciesByCredential" default="true"> <!--NAME: ServerPoliciesByCredential--> <!--TAG: DEFAULT--> <maml:name>Copy-DhcpPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The DHCP server the policies will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The DHCP server the policies will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="name"> <maml:name>PolicyName</maml:name> <maml:description> <maml:para>Specifies specific policy names to copy to the destination server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ScopePoliciesByCredential"> <!--NAME: ScopePoliciesByCredential--> <maml:name>Copy-DhcpPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The DHCP server the policies will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The DHCP server the policies will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="name"> <maml:name>PolicyName</maml:name> <maml:description> <maml:para>Specifies specific policy names to copy to the destination server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToScopeId</maml:name> <maml:description> <maml:para>Specifies an IP Address of the destination scope to copy the policies to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromScopeId</maml:name> <maml:description> <maml:para>Specifies an IP Address of the source server scope to copy the policies from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ScopePoliciesByCimSession"> <!--NAME: ScopePoliciesByCimSession--> <maml:name>Copy-DhcpPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="name"> <maml:name>PolicyName</maml:name> <maml:description> <maml:para>Specifies specific policy names to copy to the destination server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToScopeId</maml:name> <maml:description> <maml:para>Specifies an IP Address of the destination scope to copy the policies to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromScopeId</maml:name> <maml:description> <maml:para>Specifies an IP Address of the source server scope to copy the policies from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ServerPoliciesByCimSession"> <!--NAME: ServerPoliciesByCimSession--> <maml:name>Copy-DhcpPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="name"> <maml:name>PolicyName</maml:name> <maml:description> <maml:para>Specifies specific policy names to copy to the destination server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The DHCP server the policies will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The DHCP server the policies will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="name"> <maml:name>PolicyName</maml:name> <maml:description> <maml:para>Specifies specific policy names to copy to the destination server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToScopeId</maml:name> <maml:description> <maml:para>Specifies an IP Address of the destination scope to copy the policies to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromScopeId</maml:name> <maml:description> <maml:para>Specifies an IP Address of the source server scope to copy the policies from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Copies all policies from a source DHCP server to the localhost</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpPolicy -FromServer 'dhcp1.contoso.com'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Copies specific policies from a source DHCP server to the localhost</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpPolicy -FromServer 'dhcp1.contoso.com' -PolicyName 'All HQ Clients', 'All Warehouse Devices'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Copies the specified source scope's policies to a different scope on the localhost</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpPolicy -FromServer 'dhcp1.contoso.com' -FromScopeId '10.1.1.0' -ToScopeId '172.16.35.0'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Yevrag35/DHCPMigration/wiki/Copy-DhcpPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DhcpServerv4Policy</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/add-dhcpserverv4policy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DhcpServerv4PolicyIPRange</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/add-dhcpserverv4policyiprange</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-DhcpServerv4Policy</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/set-dhcpserverv4policy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DhcpServerv4Policy</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/get-dhcpserverv4policy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DhcpServerv4PolicyIPRange</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/get-dhcpserverv4policyiprange</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Copy-DhcpScope</command:name> <maml:description> <maml:para>Copies DHCP scopes from one server to another.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>DhcpScope</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Copies an IPv4 scope from a source DHCP server to a destination DHCP server. Individual scope id's can be specified, but if left $null, it will copy over all scopes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByCredential" default="true"> <!--NAME: ByCredential--> <!--TAG: DEFAULT--> <maml:name>Copy-DhcpScope</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The DHCP server the scopes will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The DHCP server the scopes will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="sid"> <maml:name>ScopeId</maml:name> <maml:description> <maml:para>Specifies the IP Addresses of the scopes to copy. If this is left $null then all scopes on the source DHCP server will be copied over to the new one.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress[]</command:parameterValue> <dev:type> <maml:name>IPAddress[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByCimSession"> <!--NAME: ByCimSession--> <maml:name>Copy-DhcpScope</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="sid"> <maml:name>ScopeId</maml:name> <maml:description> <maml:para>Specifies the IP Addresses of the scopes to copy. If this is left $null then all scopes on the source DHCP server will be copied over to the new one.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress[]</command:parameterValue> <dev:type> <maml:name>IPAddress[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The DHCP server the scopes will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The DHCP server the scopes will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="sid"> <maml:name>ScopeId</maml:name> <maml:description> <maml:para>Specifies the IP Addresses of the scopes to copy. If this is left $null then all scopes on the source DHCP server will be copied over to the new one.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress[]</command:parameterValue> <dev:type> <maml:name>IPAddress[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>ExcludeScopeOptions</maml:name> <maml:description> <maml:para>Indicates to not copy the source scope's Option values to the new destination scope.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Copies all scopes from a remote DHCP server to the localhost</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpScope -FromServer 'dhcp1.contoso.com'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Copies only specific scopes from a source server to a remote destination server</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpScope -FromServer 'dhcp1.contoso.com' -ToServer 'dhcp2.contoso.com' -ScopeId "10.1.1.0", "10.1.2.0"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Yevrag35/DHCPMigration/wiki/Copy-DhcpScope</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DhcpServerv4Scope</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/add-dhcpserverv4scope</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-DhcpServerv4Scope</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/set-dhcpserverv4scope</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DhcpServerv4Scope</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/get-dhcpserverv4scope</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Copy-DhcpServerOptionDefinition</command:name> <maml:description> <maml:para>Copies DHCP server option definitions from one server to another.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>DhcpServerOptionDefinition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Recreates all or specific DHCP server option definitions on the target DHCP server. If the OptionId on the destination already exists, then no action is taken.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByCredential" default="true"> <!--NAME: ByCredential--> <!--TAG: DEFAULT--> <maml:name>Copy-DhcpServerOptionDefinition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The source server the DHCP server option definitions will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The source server the DHCP server option definitions will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="id"> <maml:name>OptionId</maml:name> <maml:description> <maml:para>Specifies specific OptionId's to copy over.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByCimSession"> <!--NAME: ByCimSession--> <maml:name>Copy-DhcpServerOptionDefinition</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="id"> <maml:name>OptionId</maml:name> <maml:description> <maml:para>Specifies specific OptionId's to copy over.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The source server the DHCP server option definitions will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The source server the DHCP server option definitions will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="id"> <maml:name>OptionId</maml:name> <maml:description> <maml:para>Specifies specific OptionId's to copy over.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Copies all source server options to the localhost</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpServerOptionDefinition -FromServer 'dhcp1.contoso.com'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Copies only specific OptionId's to the destination server.</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpServerOptionDefinition -FromServer 'dhcp1.contoso.com' -ToServer 'dhcp2.contoso.com' -OptionId 60, 132, 150</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Yevrag35/DHCPMigration/wiki/Copy-DhcpServerOptionDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DhcpServerv4OptionDefinition</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/add-dhcpserverv4optiondefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-DhcpServerv4OptionDefinition</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/set-dhcpserverv4optiondefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DhcpServerv4OptionDefinition</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/get-dhcpserverv4optiondefinition</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Copy-DhcpServerOptionValue</command:name> <maml:description> <maml:para>Copies DHCP server option values from one server to another.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>DhcpServerOptionValue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets the destination's server option values with the values from the source DHCP server. An error is thrown if the destination does not contain the OptionId definition. By default, if the destination has a value for a given OptionId, the incoming value is ignored. This behavior can be overridden with the '-OverwriteValues' switch.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByCredential" default="true"> <!--NAME: ByCredential--> <!--TAG: DEFAULT--> <maml:name>Copy-DhcpServerOptionValue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The source server the DHCP server option values will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The source server the DHCP server option definitions will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="id"> <maml:name>OptionId</maml:name> <maml:description> <maml:para>Specifies specific OptionId's to copy over.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverwriteExisting</maml:name> <maml:description> <maml:para>Specifies if the copy process finds that the destination DHCP server has an existing value set for a particular OptionId, it will be overridden with the incoming value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByCimSession"> <!--NAME: ByCimSession--> <maml:name>Copy-DhcpServerOptionValue</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="id"> <maml:name>OptionId</maml:name> <maml:description> <maml:para>Specifies specific OptionId's to copy over.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverwriteExisting</maml:name> <maml:description> <maml:para>Specifies if the copy process finds that the destination DHCP server has an existing value set for a particular OptionId, it will be overridden with the incoming value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="t , to"> <maml:name>ToServer</maml:name> <maml:description> <maml:para>The source server the DHCP server option values will be copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="f , from"> <maml:name>FromServer</maml:name> <maml:description> <maml:para>The source server the DHCP server option definitions will be copied from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="id"> <maml:name>OptionId</maml:name> <maml:description> <maml:para>Specifies specific OptionId's to copy over.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OverwriteExisting</maml:name> <maml:description> <maml:para>Specifies if the copy process finds that the destination DHCP server has an existing value set for a particular OptionId, it will be overridden with the incoming value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="toc"> <maml:name>ToCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="froc"> <maml:name>FromCredential</maml:name> <maml:description> <maml:para>Specifies credentials to use when contacting the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="tcim"> <maml:name>ToCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the destination DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="fcim"> <maml:name>FromCimSession</maml:name> <maml:description> <maml:para>Specifies an already established CimSession to the source DHCP server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CimSession</command:parameterValue> <dev:type> <maml:name>CimSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Copies all server option values to the localhost</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpServerOptionValue -FromServer 'dhcp1.contoso.com'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Copies specific OptionId values to a remote DHCP server</maml:para> </maml:introduction> <dev:code>C:\PS> Copy-DhcpServerOptionValue -FromServer 'dhcp1.contoso.com' -ToServer 'dhcp2.contoso.com' -OptionId 60, 132, 150</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Yevrag35/DHCPMigration/wiki/Copy-DhcpServerOptionValue</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DhcpServerv4OptionValue</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/get-dhcpserverv4optionvalue</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-DhcpServerv4OptionValue</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/dhcpserver/set-dhcpserverv4optionvalue</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2019 v2.3.44--> </helpItems> |