aboutsummaryrefslogtreecommitdiff
path: root/docs/Recon/Remove-RemoteConnection.md
blob: fe6f3b36e84fd1d479e0aa95c70b8a144b41cdc1 (plain)
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
# Remove-RemoteConnection

## SYNOPSIS
Destroys a connection created by New-RemoteConnection.

Author: Will Schroeder (@harmj0y)  
License: BSD 3-Clause  
Required Dependencies: PSReflect

## SYNTAX

### ComputerName (Default)
```
Remove-RemoteConnection [-ComputerName] <String[]>
```

### Path
```
Remove-RemoteConnection [-Path] <String[]>
```

## DESCRIPTION
This function uses WNetCancelConnection2 to destroy a connection created by
New-RemoteConnection.
If a -Path isn't specified, a -ComputerName is required to
'unmount' \\\\$ComputerName\IPC$.

## EXAMPLES

### -------------------------- EXAMPLE 1 --------------------------
```
Remove-RemoteConnection -ComputerName 'PRIMARY.testlab.local'
```

### -------------------------- EXAMPLE 2 --------------------------
```
Remove-RemoteConnection -Path '\\PRIMARY.testlab.local\C$\'
```

### -------------------------- EXAMPLE 3 --------------------------
```
@('PRIMARY.testlab.local','SECONDARY.testlab.local') | Remove-RemoteConnection
```

## PARAMETERS

### -ComputerName
Specifies the system to remove a \\\\ComputerName\IPC$ connection for.

```yaml
Type: String[]
Parameter Sets: ComputerName
Aliases: HostName, dnshostname, name

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```

### -Path
Specifies the remote \\\\UNC\path to remove the connection for.

```yaml
Type: String[]
Parameter Sets: Path
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS