Skip to content

Commit 22d320d

Browse files
committed
Update description of SSH auth behavior and sync versions
1 parent aa5cab0 commit 22d320d

File tree

3 files changed

+18
-30
lines changed

3 files changed

+18
-30
lines changed

reference/7.4/Microsoft.PowerShell.Core/Enter-PSSession.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 06/14/2024
5+
ms.date: 03/23/2026
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/enter-pssession?view=powershell-7.4&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
aliases:
@@ -827,17 +827,13 @@ Accept wildcard characters: False
827827

828828
### -UserName
829829

830-
Specifies the user name for the account used to create a session on the remote computer. User
830+
Specifies the user name for the account used to create a session on the remote computer. If the
831+
**UserName** parameter isn't specified then the current logged on username is used. User
831832
authentication method depends on how Secure Shell (SSH) is configured on the remote computer.
832833

833-
If SSH is configured for basic password authentication then you are prompted for the user password.
834-
835-
If SSH is configured for key based user authentication then uou aren't prompted for a password. You
836-
must provide a path to an SSH key file. If the user key file is located in an SSH known location
837-
then the **KeyFilePath** parameter isn't needed. User authentication occurs automatically based on
838-
the user name. See SSH documentation about key based user authentication for more information.
839-
840-
If the **UserName** parameter isn't specified then the current logged on username is used.
834+
- If SSH is configured for password authentication then you are prompted for the user password.
835+
- If SSH is configured for key-based user authentication then you must have an SSH key file. If the
836+
user key file is located in an SSH-known location then the **KeyFilePath** parameter isn't needed.
841837

842838
This parameter was introduced in PowerShell 6.0.
843839

reference/7.5/Microsoft.PowerShell.Core/Enter-PSSession.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 06/14/2024
5+
ms.date: 03/23/2026
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/enter-pssession?view=powershell-7.5&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
aliases:
@@ -827,17 +827,13 @@ Accept wildcard characters: False
827827

828828
### -UserName
829829

830-
Specifies the user name for the account used to create a session on the remote computer. User
830+
Specifies the user name for the account used to create a session on the remote computer. If the
831+
**UserName** parameter isn't specified then the current logged on username is used. User
831832
authentication method depends on how Secure Shell (SSH) is configured on the remote computer.
832833

833-
If SSH is configured for basic password authentication then you are prompted for the user password.
834-
835-
If SSH is configured for key based user authentication then uou aren't prompted for a password. You
836-
must provide a path to an SSH key file. If the user key file is located in an SSH known location
837-
then the **KeyFilePath** parameter isn't needed. User authentication occurs automatically based on
838-
the user name. See SSH documentation about key based user authentication for more information.
839-
840-
If the **UserName** parameter isn't specified then the current logged on username is used.
834+
- If SSH is configured for password authentication then you are prompted for the user password.
835+
- If SSH is configured for key-based user authentication then you must have an SSH key file. If the
836+
user key file is located in an SSH-known location then the **KeyFilePath** parameter isn't needed.
841837

842838
This parameter was introduced in PowerShell 6.0.
843839

reference/7.6/Microsoft.PowerShell.Core/Enter-PSSession.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 06/14/2024
5+
ms.date: 03/23/2026
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/enter-pssession?view=powershell-7.6&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
aliases:
@@ -827,17 +827,13 @@ Accept wildcard characters: False
827827

828828
### -UserName
829829

830-
Specifies the user name for the account used to create a session on the remote computer. User
830+
Specifies the user name for the account used to create a session on the remote computer. If the
831+
**UserName** parameter isn't specified then the current logged on username is used. User
831832
authentication method depends on how Secure Shell (SSH) is configured on the remote computer.
832833

833-
If SSH is configured for basic password authentication then you are prompted for the user password.
834-
835-
If SSH is configured for key-based user authentication then you aren't prompted for a password. You
836-
must provide a path to an SSH key file. If the user key file is located in an SSH known location
837-
then the **KeyFilePath** parameter isn't needed. User authentication occurs automatically based on
838-
the user name. See SSH documentation about key-based user authentication for more information.
839-
840-
If the **UserName** parameter isn't specified then the current logged on username is used.
834+
- If SSH is configured for password authentication then you are prompted for the user password.
835+
- If SSH is configured for key-based user authentication then you must have an SSH key file. If the
836+
user key file is located in an SSH-known location then the **KeyFilePath** parameter isn't needed.
841837

842838
This parameter was introduced in PowerShell 6.0.
843839

0 commit comments

Comments
 (0)