SidCloner

2.1.0-beta2

en-us/SidCloner.dll-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Copy-Sid</command:name>

      <command:verb>Copy</command:verb>

      <command:noun>Sid</command:noun>

      <maml:description>

        <maml:para>Command copies SID from SourcePrincipal in SourceDomain to SID History of TargetPrincipal in TargetDomain.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Command copies SID from SourcePrincipal in SourceDomain to SID History of TargetPrincipal in TargetDomain.

Command uses explicit domain controllers in Source or Target domain, or discovers suiteble Domain Controllers itself, if not specified.

Command uses explicit credentials to authorize the operation, if provided, or identity of caller, if explicit credentials not provided.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Copy-Sid</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none">

          <maml:name>SourcePrincipal</maml:name>

          <maml:Description>

            <maml:para>sAMAccountName of principal to copy the SID from.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none">

          <maml:name>TargetPrincipal</maml:name>

          <maml:Description>

            <maml:para>sAMAccountName of principal that receives SID to its SID History from SourcePrincipal</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

          <maml:name>SourceDomain</maml:name>

          <maml:Description>

            <maml:para>DNS name of domain hosting SourcePrincipal</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">

          <maml:name>TargetDomain</maml:name>

          <maml:Description>

            <maml:para>DNS name of domain hosting TargetPrincipal</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">

          <maml:name>SourceDC</maml:name>

          <maml:Description>

            <maml:para>FQDN of Domain Controller in SourceDomain that will be used by the operation</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none">

          <maml:name>TargetDC</maml:name>

          <maml:Description>

            <maml:para>FQDN of Domain Controller in TargetDomain that will be used by the operation</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none">

          <maml:name>SourceCredential</maml:name>

          <maml:Description>

            <maml:para>Explicit credentials to authorize operation is SourceDomain</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.PSCredential</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none">

          <maml:name>TargetCredential</maml:name>

          <maml:Description>

            <maml:para>Explicit credentials to authorize operation is TargetDomain</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.PSCredential</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none">

        <maml:name>SourceCredential</maml:name>

        <maml:Description>

          <maml:para>Explicit credentials to authorize operation is SourceDomain</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</command:parameterValue>

        <dev:type>

          <maml:name>System.Management.Automation.PSCredential</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">

        <maml:name>SourceDC</maml:name>

        <maml:Description>

          <maml:para>FQDN of Domain Controller in SourceDomain that will be used by the operation</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

        <maml:name>SourceDomain</maml:name>

        <maml:Description>

          <maml:para>DNS name of domain hosting SourcePrincipal</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none">

        <maml:name>SourcePrincipal</maml:name>

        <maml:Description>

          <maml:para>sAMAccountName of principal to copy the SID from.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none">

        <maml:name>TargetCredential</maml:name>

        <maml:Description>

          <maml:para>Explicit credentials to authorize operation is TargetDomain</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</command:parameterValue>

        <dev:type>

          <maml:name>System.Management.Automation.PSCredential</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none">

        <maml:name>TargetDC</maml:name>

        <maml:Description>

          <maml:para>FQDN of Domain Controller in TargetDomain that will be used by the operation</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">

        <maml:name>TargetDomain</maml:name>

        <maml:Description>

          <maml:para>DNS name of domain hosting TargetPrincipal</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none">

        <maml:name>TargetPrincipal</maml:name>

        <maml:Description>

          <maml:para>sAMAccountName of principal that receives SID to its SID History from SourcePrincipal</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

      <command:inputType>

        <dev:type>

          <maml:name>System.Management.Automation.PSCredential</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>GreyCorbel.CloneResult</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>All prerequisites for usage of DsAddSidHistory API as spefied in Microsoft Documentation (https://docs.microsoft.com/en-us/windows/win32/ad/using-dsaddsidhistory)must be fulfilled for command to succeed.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; 

$sourceCred=Get-Credential

$targetCred=Get-Credential

Import-Csv .\inputFile.csv | Copy-Sid -SourceDomain domain1.com -TargetDomain domain2.com -SourceCredential $sourceCred -TargetCredential $targetCred</dev:code>

        <dev:remarks>

          <maml:para>Clones SIDs of accounts in inputFile.csv from domain1.com to accounts in domain2.com. Input file is CSV that needs to have 2 mandatory columns: SourcePrincipal and TargetPrincipal. CSV can contain additional columns as needed.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>