en-us/PSParallel.dll-Help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<?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: 2.1.2
    -->
    <!--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>The cmdlet uses a RunspacePool an and invokes the provied scriptblock once for each input.
 
To control the environment of the scriptblock, the ImportModule, ImportVariable and ImportFunction parameters can be use
d.</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">
                    <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>
                </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>
                </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>
                </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 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">
                    <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>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="iss">
                    <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
available to the ScriptBlock.
By default, InitialSessionState.Create2() is used and the functions and variables from the current scope is then
imported.</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:syntaxItem>
            <command:syntaxItem>
                <maml:name>Invoke-Parallel</maml:name>
                <command:parameter required="true" pipelineinput="false" globbing="false" position="named">
                    <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">ScriptBlock</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" pipelineinput="false" globbing="false" position="named">
                    <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">Int32</command:parameterValue>
                </command:parameter>
                <command:parameter required="true" pipelineinput="True (ByValue)" globbing="false" 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">PSObject</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" pipelineinput="false" globbing="false" position="named">
                    <maml:name>NoProgress</maml:name>
                    <maml:description>
                        <maml:para>Will not show progress from Invoke-Progress. Progress from the scriptblock will still be displayed.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false">SwitchParameter</command:parameterValue>
                </command:parameter>
                <command:parameter required="true" pipelineinput="false" globbing="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
available to the ScriptBlock.
By default, InitialSessionState.Create2() is used and the functions and variables from the current scope is then
imported.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true">InitialSessionState</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
                <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" 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/>
            </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/>
            </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 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">
                <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">
                <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" aliases="">
                <maml:name>NoProgress</maml:name>
                <maml:description>
                    <maml:para>Will not 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:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="iss">
                <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
available to the ScriptBlock.
By default, InitialSessionState.Create2() is used and the functions and variables from the current scope is then
imported.</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" globbing="false" pipelineInput="false" position="named">
                <maml:name>Parameter8</maml:name>
                <maml:description>
                    <maml:para/>
                </maml:description>
                <command:parameterValue required="false"/>
                <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:para/>
                    <maml:para/>
                    <maml:para/>
                    <maml:para/>
                    <maml:para/>
                    <maml:para/>
                    <maml:para/>
                    <maml:para/>
                    <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 = [IPAddress]$_; $res = ping.exe -n 1 -4 -w 20 -a $_; [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 parallel.</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16-->
</helpItems>