PSParallel

1.0

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.16-->

    <!-- Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16-->

    <!--

         Module:         PSParallel

         Version:        1.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">

        <!-- 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>

                        </maml:para>

                    </maml:description>

                    <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>

                    <dev:defaultValue>

                    </dev:defaultValue>

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ppi">

                    <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:defaultValue>

                    </dev:defaultValue>

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="pi">

                    <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:defaultValue>

                    </dev:defaultValue>

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="pa">

                    <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 progress is being reported.</maml:para>

                    </maml:description>

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

                    <dev:defaultValue>

                    </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="True (ByValue)" position="named" aliases="">

                    <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 that 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:defaultValue>

                    </dev:defaultValue>

                </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>

                        </maml:para>

                    </maml:description>

                    <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>

                    <dev:defaultValue>

                    </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="True (ByValue)" position="named" aliases="">

                    <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 that 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:defaultValue>

                    </dev:defaultValue>

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">

                    <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:defaultValue/>

                </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>

                    </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>

                </dev:defaultValue>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ppi">

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

                </dev:defaultValue>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="pi">

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

                </dev:defaultValue>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="pa">

                <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 progress 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>

                </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="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="">

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

                </dev:defaultValue>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">

                <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:returnValues>

            <!-- Outputs-->

            <command:returnValue>

                <dev:type>

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

                    <maml:uri/>

                </dev:type>

                <maml:description>

                    <maml:para/>

                </maml:description>

            </command:returnValue>

        </command:returnValues>

        <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..256 | Invoke-Parallel {$ip = 192.168.0.$_; $res = ping.exe -v4 -w20 $ip; [PSCustomObject] @{IP=$ip;Res=$res}}</dev:code>

                <dev:remarks>

                    <maml:para>

                    </maml:para>

                </dev:remarks>

            </command:example>

        </command:examples>

    </command:command>

    <!-- Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16-->

</helpItems>