Skip to content

Commit 2f72b78

Browse files
TylerLeonhardtsdwheeler
authored andcommitted
update docs for -CustomPipeName (#4032)
* update docs for -CustomPipeName * typo * warning fixed * update date and common parameters * delete new line after Synopsis
1 parent 8227a7c commit 2f72b78

File tree

2 files changed

+51
-7
lines changed

2 files changed

+51
-7
lines changed

reference/6/Microsoft.PowerShell.Core/About/about_pwsh.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
ms.date: 06/09/2017
2+
ms.date: 03/22/2019
33
schema: 2.0.0
4-
locale: en-us
54
keywords: powershell,cmdlet
65
title: about_PowerShell_exe
76
---
@@ -21,6 +20,7 @@ pwsh starts a PowerShell session.
2120
pwsh[.exe]
2221
[-Version]
2322
[-ConfigurationName]
23+
[-CustomPipeName <string>]
2424
[-EncodedCommand <Base64EncodedCommand>]
2525
[-ExecutionPolicy <ExecutionPolicy>]
2626
[-InputFormat {Text | XML}]
@@ -50,6 +50,17 @@ Specifies a configuration endpoint in which PowerShell is run.
5050
This can be any endpoint registered on the local machine including the default PowerShell
5151
remoting endpoints or a custom endpoint having specific user role capabilities.
5252

53+
#### -CustomPipeName <PipeName>
54+
55+
Specifies the name to use for an additional IPC server
56+
(named pipe)
57+
used for debugging and other cross-process communication.
58+
This offers a predictable mechanism for connecting to other PowerShell instances.
59+
Typically used with the
60+
`CustomPipeName`
61+
parameter on
62+
`Enter-PSHostProcess`.
63+
5364
#### -EncodedCommand <Base64EncodedCommand>
5465

5566
Accepts a base-64-encoded string version of a command. Use this parameter to
@@ -184,4 +195,10 @@ pwsh -SettingsFile ~/powershell.config.json
184195
185196
# Example of specifying a configuration name
186197
pwsh -ConfigurationName AdminRoles
187-
```
198+
199+
# Example of specifying a custom pipe name
200+
# PowerShell instance 1
201+
pwsh -CustomPipeName mycustompipe
202+
# PowerShell instance 2
203+
Enter-PSHostProcess -CustomPipeName mycustompipe
204+
```

reference/6/Microsoft.PowerShell.Core/Enter-PSHostProcess.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ external help file: System.Management.Automation.dll-Help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
55
Module Name: Microsoft.PowerShell.Core
6-
ms.date: 06/09/2017
6+
ms.date: 03/22/2019
77
online version: http://go.microsoft.com/fwlink/?LinkID=403736
88
schema: 2.0.0
99
title: Enter-PSHostProcess
@@ -39,6 +39,12 @@ Enter-PSHostProcess [-Name] <String> [[-AppDomainName] <String>] [<CommonParamet
3939
Enter-PSHostProcess [-HostProcessInfo] <PSHostProcessInfo> [[-AppDomainName] <String>] [<CommonParameters>]
4040
```
4141

42+
### PipeNameParameterSet
43+
44+
```
45+
Enter-PSHostProcess -CustomPipeName <String> [<CommonParameters>]
46+
```
47+
4248
## DESCRIPTION
4349

4450
The **Enter-PSHostProcess** cmdlet connects to and enters into an interactive session with a local process.
@@ -112,7 +118,7 @@ PS C:\>
112118

113119
```yaml
114120
Type: String
115-
Parameter Sets: (All)
121+
Parameter Sets: ProcessIdParameterSet, ProcessParameterSet, ProcessNameParameterSet, PSHostProcessInfoParameterSet
116122
Aliases:
117123

118124
Required: False
@@ -188,9 +194,30 @@ Accept pipeline input: True (ByValue)
188194
Accept wildcard characters: False
189195
```
190196
197+
### -CustomPipeName
198+
199+
Gets or sets the custom named pipe name to connect to.
200+
This is usually used in conjunction with
201+
`pwsh -CustomPipeName`.
202+
203+
```yaml
204+
Type: String
205+
Parameter Sets: PipeNameParameterSet
206+
Aliases:
207+
208+
Required: True
209+
Position: Named
210+
Default value: None
211+
Accept pipeline input: False
212+
Accept wildcard characters: False
213+
```
214+
191215
### CommonParameters
192216

193-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
217+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
218+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable,
219+
-Verbose, -WarningAction, and -WarningVariable. For more information, see
220+
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
194221

195222
## INPUTS
196223

@@ -209,4 +236,4 @@ That is, they have loaded the PowerShell engine.
209236

210237
## RELATED LINKS
211238

212-
[Exit-PSHostProcess](Exit-PSHostProcess.md)
239+
[Exit-PSHostProcess](Exit-PSHostProcess.md)

0 commit comments

Comments
 (0)