NetworkConnection

0.2.0

Kaguwa.Commands.Network.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
 <?xml version="1.0" encoding="utf-8" ?>
<helpItems
  xmlns="http://msh" schema="maml">
  <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>Get-NetworkConnection</command:name>
      <command:verb>Get</command:verb>
      <command:noun>NetworkConnection</command:noun>
      <maml:description>
        <maml:para>Gets network connections on local host.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
    </command:details>
    <maml:description>
      <maml:para>The Get-NetworkConnection cmdlet gets the active TCP/UDP connections on the local hostand returns them as a list of NetworkConnection objects.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-NetworkConnection</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="0" aliases="Name,Process">
          <maml:name>ProcessName</maml:name>
          <maml:description>
            <maml:para>Filters the connections by process name.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="Id,PID">
          <maml:name>ProcessId</maml:name>
          <maml:description>
            <maml:para>Filters the connections by process id.</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="1" aliases="Connection">
          <maml:name>State</maml:name>
          <maml:description>
            <maml:para>Filters the connections state.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="0" aliases="Name,Process">
        <maml:name>ProcessName</maml:name>
        <maml:description>
          <maml:para>Filters the connections by process name.</maml:para>
        </maml:description>
        <command:parameterValue required="false">String[]</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="Id,PID">
        <maml:name>ProcessId</maml:name>
        <maml:description>
          <maml:para>Filters the connections by process id.</maml:para>
        </maml:description>
        <command:parameterValue required="false">Int32[]</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="Connection">
        <maml:name>State</maml:name>
        <maml:description>
          <maml:para>Filters the connections state.</maml:para>
        </maml:description>
        <command:parameterValue required="false">String</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri></maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri></maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <command:examples>
      <command:example>
        <maml:title>Example 1: Get all active TCP/UDP connections.</maml:title>
        <maml:introduction></maml:introduction>
        <dev:code>PS C:\&gt;Get-NetworkConnection</dev:code>
        <dev:remarks>
          <maml:para>This command lists all active TCP/UDP connections.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 2: Get all active TCP/UDP connections with process name svchost.</maml:title>
        <maml:introduction></maml:introduction>
        <dev:code>PS C:\&gt;Get-NetworkConnection -ProcessName svchost</dev:code>
        <dev:remarks>
          <maml:para>This command lists all active TCP/UDP connections with process name svchost.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 3: Get all active TCP/UDP connections with process name svchost through pipeline.</maml:title>
        <maml:introduction></maml:introduction>
        <dev:code>PS C:\&gt;svchost | Get-NetworkConnection</dev:code>
        <dev:remarks>
          <maml:para>This command lists all active TCP/UDP connections with process name svchost.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 4: Get all active TCP/UDP connections with process name Skype and stop the related processes.</maml:title>
        <maml:introduction></maml:introduction>
        <dev:code>PS C:\&gt;Get-NetworkConnection -ProcessName Skype | Stop-Process</dev:code>
        <dev:remarks>
          <maml:para>First it gets all processes that has the name Skype, then it pipes it to Stop-Processes which in turn stops the processes.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
  </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"
    xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-NetworkConnectionHost</command:name>
      <command:verb>Get</command:verb>
      <command:noun>NetworkConnectionHost</command:noun>
      <maml:description>
        <maml:para>Returns host name and IP address from a provided hostname or IP address.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
    </command:details>
    <maml:description>
      <maml:para>The Get-NetworkConnectionHost cmdlet gets host name and IP address from a provided hostname or IP address.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-NetworkConnectionHost</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="0" aliases="IPAddress,Address,RemoteAddress">
          <maml:name>Host</maml:name>
          <maml:description>
            <maml:para>Host name/IP address to resolve.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="0" aliases="IPAddress,Address,RemoteAddress">
        <maml:name>Host</maml:name>
        <maml:description>
          <maml:para>Host name/IP address to resolve.</maml:para>
        </maml:description>
        <command:parameterValue required="false">String[]</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri></maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri></maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <command:examples>
      <command:example>
        <maml:title>Example 1: Get the host name and IP address from local host.</maml:title>
        <maml:introduction></maml:introduction>
        <dev:code>PS C:\&gt;Get-NetworkConnectionHost</dev:code>
        <dev:remarks>
          <maml:para>This command lists the host name and IP Address of the local host.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 2: Get resolve multiple entries.</maml:title>
        <maml:introduction></maml:introduction>
        <dev:code>PS C:\&gt;Get-NetworkConnectionHost -Host 192.168.0.10,codecloudandrants.io,google.com</dev:code>
        <dev:remarks>
          <maml:para>This command resolves the host name/IP Address of 192.168.0.10 and codecloudandrants.io.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 3: Resolve multiple entries from pipeline..</maml:title>
        <maml:introduction></maml:introduction>
        <dev:code>PS C:\&gt;"codecloudandrants.io","google.com" | Get-NetworkConnectionHost</dev:code>
        <dev:remarks>
          <maml:para>This command resolves the host name/IP Address of 192.168.0.10 and codecloudandrants.io.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 4: resolve entries from Get-NetworkConnection that has process name chrome.</maml:title>
        <maml:introduction></maml:introduction>
        <dev:code>PS C:\&gt;Get-NetworkConnection -ProcessName chrome | Get-NetworkConnectionHost</dev:code>
        <dev:remarks>
          <maml:para>Get all connections with process name chrome and resolve the RemoteAddress of these with Get-NetworkConnectionHost.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
  </command:command>
</helpItems>