PSParallel

1.8

en-us/PSParallel.dll-Help.xml

<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
    <!--Edited with: SAPIEN PowerShell HelpWriter 2015 v1.0.10-->
    <!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.10-->
    <!--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">
        <!--Command-->
        <command:details>
            <command:name>Invoke-Parallel</command:name>
            <maml:description>
                <maml:para>Invokes the provided scriptblock once for each input, in parallel.</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para/>
            </maml:copyright>
            <command:verb>Invoke</command:verb>
            <command:noun>Parallel</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
            <maml:para>Th</maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem>
                <maml:name>Invoke-Parallel</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="">
                    <maml:name>ScriptBlock</maml:name>
                    <maml:description>
                        <maml:para>Specifies the operation that is performed on each input object. Enter a script block that describes the operation.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>
                    <dev:defaultValue/>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>ParentProgressId</maml:name>
                    <maml:description>
                        <maml:para>Identifies the parent activity of the current activity. Use the value -1 if the current activity has no parent activity.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>ProgressId</maml:name>
                    <maml:description>
                        <maml:para>Specifies an ID that distinguishes each progress bar from the others. Use this parameter when you are creating more than
 one progress bar in a single command. If the progress bars do not have different IDs, they are superimposed instead of
being displayed in a series.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>ProgressActivity</maml:name>
                    <maml:description>
                        <maml:para>Specifies the first line of progress text in the heading above the status bar. This text describes the activity whose pr
ogress is being reported.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>ThrottleLimit</maml:name>
                    <maml:description>
                        <maml:para>Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this
parameter or enter a value of 0, the default value, 16, is used.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                    <dev:defaultValue/>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>ImportModule</maml:name>
                    <maml:description>
                        <maml:para>Specify the names of the modules to import into the runspaces running the scriptblock to process.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                    <maml:name>InputObject</maml:name>
                    <maml:description>
                        <maml:para>Specifies the input objects. Invoke-Parallel runs the script block on each input object in parallel. Enter a variable th
at contains the objects, or type a command or expression that gets the objects.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InformationAction</maml:name>
                    <maml:description>
                        <maml:para/>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">ActionPreference</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InformationVariable</maml:name>
                    <maml:description>
                        <maml:para/>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem>
                <maml:name>Invoke-Parallel</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="">
                    <maml:name>ScriptBlock</maml:name>
                    <maml:description>
                        <maml:para>Specifies the operation that is performed on each input object. Enter a script block that describes the operation.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>
                    <dev:defaultValue/>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>ParentProgressId</maml:name>
                    <maml:description>
                        <maml:para>Identifies the parent activity of the current activity. Use the value -1 if the current activity has no parent activity.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>ProgressId</maml:name>
                    <maml:description>
                        <maml:para>Specifies an ID that distinguishes each progress bar from the others. Use this parameter when you are creating more than
 one progress bar in a single command. If the progress bars do not have different IDs, they are superimposed instead of
being displayed in a series.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>ProgressActivity</maml:name>
                    <maml:description>
                        <maml:para>Specifies the first line of progress text in the heading above the status bar. This text describes the activity whose pr
ogress is being reported.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>ThrottleLimit</maml:name>
                    <maml:description>
                        <maml:para>Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this
parameter or enter a value of 0, the default value, 16, is used.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                    <dev:defaultValue/>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InitialSessionState</maml:name>
                    <maml:description>
                        <maml:para>The session state used by the runspaces when invoking ScriptBlock. This provides the functions, variables, drives, etc a
vailable to the ScriptBlock.
By default, InitialSessionState.Create2() is used and the functions and variables from the current scope is then importe
d.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">InitialSessionState</command:parameterValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                    <maml:name>InputObject</maml:name>
                    <maml:description>
                        <maml:para>Specifies the input objects. Invoke-Parallel runs the script block on each input object in parallel. Enter a variable th
at contains the objects, or type a command or expression that gets the objects.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InformationAction</maml:name>
                    <maml:description>
                        <maml:para/>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">ActionPreference</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InformationVariable</maml:name>
                    <maml:description>
                        <maml:para/>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem>
                <maml:name>Invoke-Parallel</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="">
                    <maml:name>ScriptBlock</maml:name>
                    <maml:description>
                        <maml:para>Specifies the operation that is performed on each input object. Enter a script block that describes the operation.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>
                    <dev:defaultValue/>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>ThrottleLimit</maml:name>
                    <maml:description>
                        <maml:para>Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this
parameter or enter a value of 0, the default value, 16, is used.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                    <dev:defaultValue/>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InitialSessionState</maml:name>
                    <maml:description>
                        <maml:para>The session state used by the runspaces when invoking ScriptBlock. This provides the functions, variables, drives, etc a
vailable to the ScriptBlock.
By default, InitialSessionState.Create2() is used and the functions and variables from the current scope is then importe
d.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">InitialSessionState</command:parameterValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                    <maml:name>InputObject</maml:name>
                    <maml:description>
                        <maml:para>Specifies the input objects. Invoke-Parallel runs the script block on each input object in parallel. Enter a variable th
at contains the objects, or type a command or expression that gets the objects.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>NoProgress</maml:name>
                    <maml:description>
                        <maml:para>Will now show progress from Invoke-Progress. Progress from the scriptblock will still be displayed.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InformationAction</maml:name>
                    <maml:description>
                        <maml:para/>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">ActionPreference</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InformationVariable</maml:name>
                    <maml:description>
                        <maml:para/>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem>
                <maml:name>Invoke-Parallel</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="">
                    <maml:name>ScriptBlock</maml:name>
                    <maml:description>
                        <maml:para>Specifies the operation that is performed on each input object. Enter a script block that describes the operation.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>
                    <dev:defaultValue/>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>ThrottleLimit</maml:name>
                    <maml:description>
                        <maml:para>Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this
parameter or enter a value of 0, the default value, 16, is used.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                    <dev:defaultValue/>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>ImportModule</maml:name>
                    <maml:description>
                        <maml:para>Specify the names of the modules to import into the runspaces running the scriptblock to process.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
                    <maml:name>InputObject</maml:name>
                    <maml:description>
                        <maml:para>Specifies the input objects. Invoke-Parallel runs the script block on each input object in parallel. Enter a variable th
at contains the objects, or type a command or expression that gets the objects.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>NoProgress</maml:name>
                    <maml:description>
                        <maml:para>Will now show progress from Invoke-Progress. Progress from the scriptblock will still be displayed.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InformationAction</maml:name>
                    <maml:description>
                        <maml:para/>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">ActionPreference</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>InformationVariable</maml:name>
                    <maml:description>
                        <maml:para/>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="">
                <maml:name>ScriptBlock</maml:name>
                <maml:description>
                    <maml:para>Specifies the operation that is performed on each input object. Enter a script block that describes the operation.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>
                <dev:type>
                    <maml:name>ScriptBlock</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue/>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>ParentProgressId</maml:name>
                <maml:description>
                    <maml:para>Identifies the parent activity of the current activity. Use the value -1 if the current activity has no parent activity.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                <dev:type>
                    <maml:name>Int32</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue/>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>ProgressId</maml:name>
                <maml:description>
                    <maml:para>Specifies an ID that distinguishes each progress bar from the others. Use this parameter when you are creating more than
 one progress bar in a single command. If the progress bars do not have different IDs, they are superimposed instead of
being displayed in a series.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                <dev:type>
                    <maml:name>Int32</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue/>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>ProgressActivity</maml:name>
                <maml:description>
                    <maml:para>Specifies the first line of progress text in the heading above the status bar. This text describes the activity whose pr
ogress is being reported.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                <dev:type>
                    <maml:name>String</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue/>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                <maml:name>ThrottleLimit</maml:name>
                <maml:description>
                    <maml:para>Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this
parameter or enter a value of 0, the default value, 16, is used.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                <dev:type>
                    <maml:name>Int32</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue/>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                <maml:name>ImportModule</maml:name>
                <maml:description>
                    <maml:para>Specify the names of the modules to import into the runspaces running the scriptblock to process.</maml:para>
                </maml:description>
                <command:parameterValue required="false" 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="True (ByValue)" position="named">
                <maml:name>InputObject</maml:name>
                <maml:description>
                    <maml:para>Specifies the input objects. Invoke-Parallel runs the script block on each input object in parallel. Enter a variable th
at contains the objects, or type a command or expression that gets the objects.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                <dev:type>
                    <maml:name>PSObject</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue/>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>InformationAction</maml:name>
                <maml:description>
                    <maml:para/>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">ActionPreference</command:parameterValue>
                <dev:type>
                    <maml:name>ActionPreference</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue/>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>InformationVariable</maml:name>
                <maml:description>
                    <maml:para/>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                <dev:type>
                    <maml:name>String</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue/>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>InitialSessionState</maml:name>
                <maml:description>
                    <maml:para>The session state used by the runspaces when invoking ScriptBlock. This provides the functions, variables, drives, etc a
vailable to the ScriptBlock.
By default, InitialSessionState.Create2() is used and the functions and variables from the current scope is then importe
d.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">InitialSessionState</command:parameterValue>
                <dev:type>
                    <maml:name>InitialSessionState</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue/>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>NoProgress</maml:name>
                <maml:description>
                    <maml:para>Will now show progress from Invoke-Progress. Progress from the scriptblock will still be displayed.</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>System.Management.Automation.PSObject</maml:name>
                    <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para/>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>(1..255).ForEach{&quot;192.168.0.$_&quot;} | Invoke-Parallel {$ip = $_; $res = ping.exe -4 -w 20 $_; [PSCustomObject] @{IP=$ip;Res=$res}} -ThrottleLimit 64</dev:code>
                <dev:remarks>
                    <maml:para>This example pings all iP v4 addresses on a subnet, specifying Throttlelimit to 64, i.e. running up to 64 runspaces in p
arallel.</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.10-->
</helpItems>