Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

6/28/2023 PM Publish #10215

Merged
merged 4 commits into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 32 additions & 24 deletions reference/5.1/Microsoft.PowerShell.Core/Add-PSSnapin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: System.Management.Automation.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Core
ms.date: 06/09/2017
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/add-pssnapin?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Add-PSSnapin
Expand Down Expand Up @@ -159,29 +159,37 @@ This cmdlet returns a PSSnapInInfo object that represents the snap-in if you spe

## NOTES

- Beginning in Windows PowerShell 3.0, the core commands that are installed with Windows PowerShell
are packaged in modules. In Windows PowerShell 2.0, and in host programs that create older-style
sessions in later versions of Windows PowerShell, the core commands are packaged in snap-ins
(PSSnapins). The exception is **Microsoft.PowerShell.Core**, which is always a snap-in. Also,
remote sessions, such as those started by the New-PSSession cmdlet, are older-style sessions that
include core snap-ins.

For information about the **CreateDefault2** method that creates newer-style sessions with core
modules, see
[CreateDefault2 Method](/dotnet/api/system.management.automation.runspaces.initialsessionstate.createdefault2#System_Management_Automation_Runspaces_InitialSessionState_CreateDefault2).

- For more information about snap-ins, see [about_PSSnapins](About/about_PSSnapins.md) and
[How to Create a Windows PowerShell Snap-in](/powershell/scripting/developer/cmdlet/how-to-create-a-windows-powershell-snap-in).
- `Add-PSSnapin` adds the snap-in only to the current session. To add the snap-in to all Windows
PowerShell sessions, add it to your Windows PowerShell profile. For more information, see
[about_Profiles](About/about_Profiles.md).
- You can add any snap-in that has been registered using the Microsoft .NET Framework install
utility. For more information, see
[How to Register Cmdlets, Providers, and Host Applications](/previous-versions//ms714644(v=vs.85)).
- To get a list of snap-ins that are registered on your computer, type `Get-PSSnapin -Registered`.
- Before adding a snap-in, `Add-PSSnapin` checks the version of the snap-in to verify that it is
compatible with the current version of Windows PowerShell. If the snap-in fails the version check,
Windows PowerShell reports an error.
Windows PowerShell includes the following aliases for `Add-PSSnapin`:

- `asnp`

Beginning in Windows PowerShell 3.0, the core commands that are installed with Windows PowerShell
are packaged in modules. In Windows PowerShell 2.0, and in host programs that create older-style
sessions in later versions of Windows PowerShell, the core commands are packaged in snap-ins
(PSSnapins). The exception is **Microsoft.PowerShell.Core**, which is always a snap-in. Also, remote
sessions, such as those started by the New-PSSession cmdlet, are older-style sessions that include
core snap-ins.

For information about the **CreateDefault2** method that creates newer-style sessions with core
modules, see
[CreateDefault2 Method](/dotnet/api/system.management.automation.runspaces.initialsessionstate.createdefault2#System_Management_Automation_Runspaces_InitialSessionState_CreateDefault2).

For more information about snap-ins, see [about_PSSnapins](About/about_PSSnapins.md) and
[How to Create a Windows PowerShell Snap-in](/powershell/scripting/developer/cmdlet/how-to-create-a-windows-powershell-snap-in).

`Add-PSSnapin` adds the snap-in only to the current session. To add the snap-in to all Windows
PowerShell sessions, add it to your Windows PowerShell profile. For more information, see
[about_Profiles](About/about_Profiles.md).

You can add any snap-in that has been registered using the Microsoft .NET Framework install utility.
For more information, see
[How to Register Cmdlets, Providers, and Host Applications](/previous-versions//ms714644(v=vs.85)).

To get a list of snap-ins that are registered on your computer, type `Get-PSSnapin -Registered`.

Before adding a snap-in, `Add-PSSnapin` checks the version of the snap-in to verify that it is
compatible with the current version of Windows PowerShell. If the snap-in fails the version check,
Windows PowerShell reports an error.

## RELATED LINKS

Expand Down
12 changes: 8 additions & 4 deletions reference/5.1/Microsoft.PowerShell.Core/Get-PSSnapin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: System.Management.Automation.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Core
ms.date: 06/09/2017
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-pssnapin?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Get-PSSnapin
Expand Down Expand Up @@ -127,16 +127,20 @@ You cannot pipe input to this cmdlet.

## NOTES

Windows PowerShell includes the following aliases for `Get-PSSnapin`:

- `gsnp`

Starting in Windows PowerShell 3.0, the core commands that are installed with Windows PowerShell are
packaged in modules. In Windows PowerShell 2.0, and in host programs that create older-style
sessions in later versions of Windows PowerShell, the core commands are packaged in snap-ins
(**PSSnapin**). The exception is **Microsoft.PowerShell.Core**, which is always a snap-in. Also,
remote sessions, such as those started by the `New-PSSession` cmdlet, are older-style sessions that
include core snap-ins.

For information about the **CreateDefault2** method that creates newer-style sessions with core
modules, see
[CreateDefault2 Method](/dotnet/api/system.management.automation.runspaces.initialsessionstate.createdefault2#System_Management_Automation_Runspaces_InitialSessionState_CreateDefault2).
For information about the **CreateDefault2** method that creates newer-style sessions with core
modules, see
[CreateDefault2 Method](/dotnet/api/system.management.automation.runspaces.initialsessionstate.createdefault2#System_Management_Automation_Runspaces_InitialSessionState_CreateDefault2).

## RELATED LINKS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: System.Management.Automation.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Core
ms.date: 12/09/2022
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionconfigurationfile?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: New-PSSessionConfigurationFile
Expand Down Expand Up @@ -1068,24 +1068,29 @@ This cmdlet returns no output.

## NOTES

- Parameters, such as **VisibleCmdlets** and **VisibleProviders**, do not import items into the
session. Instead, they select from among the items imported into the session. For example, if the
value of the **VisibleProviders** parameter is the Certificate provider, but the
**ModulesToImport** parameter does not specify the **Microsoft.PowerShell.Security** module that
contains the Certificate provider, the Certificate provider is not visible in the session.
- `New-PSSessionConfigurationFile` creates a session configuration file that has a .pssc file name
extension in the path that you specify in the **Path** parameter. When you use the session
configuration file to create a session configuration, the `Register-PSSessionConfiguration` cmdlet
copies the configuration file and saves an active copy of the file in the **SessionConfig**
subdirectory of the `$PSHOME` directory.

The **ConfigFilePath** property of the session configuration contains the fully qualified path of
the active session configuration file. You can modify the active configuration file in the
`$PSHOME` directory at any time using any text editor. The changes that you make affect all new
sessions that use the session configuration, but not existing sessions.

Before using an edited session configuration file, use the `Test-PSSessionConfigurationFile`
cmdlet to verify that the configuration file entries are valid.
Windows PowerShell includes the following aliases for `New-PSSessionConfigurationFile`:

- `npssc`

Parameters, such as **VisibleCmdlets** and **VisibleProviders**, do not import items into the
session. Instead, they select from among the items imported into the session. For example, if the
value of the **VisibleProviders** parameter is the Certificate provider, but the **ModulesToImport**
parameter does not specify the **Microsoft.PowerShell.Security** module that contains the
Certificate provider, the Certificate provider is not visible in the session.

`New-PSSessionConfigurationFile` creates a session configuration file that has a .pssc file name
extension in the path that you specify in the **Path** parameter. When you use the session
configuration file to create a session configuration, the `Register-PSSessionConfiguration` cmdlet
copies the configuration file and saves an active copy of the file in the **SessionConfig**
subdirectory of the `$PSHOME` directory.

The **ConfigFilePath** property of the session configuration contains the fully qualified path of
the active session configuration file. You can modify the active configuration file in the `$PSHOME`
directory at any time using any text editor. The changes that you make affect all new sessions that
use the session configuration, but not existing sessions.

Before using an edited session configuration file, use the `Test-PSSessionConfigurationFile` cmdlet
to verify that the configuration file entries are valid.

## RELATED LINKS

Expand Down
11 changes: 6 additions & 5 deletions reference/5.1/Microsoft.PowerShell.Core/Remove-PSSnapin.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,12 @@ Windows PowerShell includes the following aliases for `Remove-PSSnapin`:

- `rsnp`

- `Remove-PSSnapin` does not check the version of Windows PowerShell before removing a snap-in from
the session. If a snap-in cannot be removed, a warning appears and the command fails.
- `Remove-PSSnapin` affects only the current session. If you have added an `Add-PSSnapin` command to
your Windows PowerShell profile, you should delete the command to remove the snap-in from future
sessions. For instructions, type `Get-Help about_Profiles`.
`Remove-PSSnapin` does not check the version of Windows PowerShell before removing a snap-in from
the session. If a snap-in cannot be removed, a warning appears and the command fails.

`Remove-PSSnapin` affects only the current session. If you have added an `Add-PSSnapin` command to
your Windows PowerShell profile, you should delete the command to remove the snap-in from future
sessions. For instructions, type `Get-Help about_Profiles`.

## RELATED LINKS

Expand Down
33 changes: 20 additions & 13 deletions reference/5.1/Microsoft.PowerShell.Core/Suspend-Job.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: System.Management.Automation.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Core
ms.date: 06/09/2017
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/suspend-job?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Suspend-Job
Expand Down Expand Up @@ -402,24 +402,31 @@ unsupported type, it returns a terminating error.
## OUTPUTS

### System.Management.Automation.Job

This cmdlet returns the jobs that it suspended.

## NOTES

- The mechanism and location for saving a suspended job might vary depending on the job type. For
example, suspended workflow jobs are saved in a flat file store by default, but can also be saved
in a database.
- If you submit a workflow job that is not in the Running state, `Suspend-Job` displays a warning
message. To suppress the warning, use the **WarningAction** common parameter with a value of
SilentlyContinue.
Windows PowerShell includes the following aliases for `Suspend-Job`:

- `sujb`

The mechanism and location for saving a suspended job might vary depending on the job type. For
example, suspended workflow jobs are saved in a flat file store by default, but can also be saved in
a database.

If you submit a workflow job that is not in the Running state, `Suspend-Job` displays a warning
message. To suppress the warning, use the **WarningAction** common parameter with a value of
SilentlyContinue.

If a job is not of a type that supports suspending, `Suspend-Job` returns a terminating error.

If a job is not of a type that supports suspending, `Suspend-Job` returns a terminating error.
To find the workflow jobs that are suspended, including those that were suspended by this cmdlet,
use the **State** parameter of the `Get-Job` cmdlet to get workflow jobs in the Suspended state.

- To find the workflow jobs that are suspended, including those that were suspended by this cmdlet,
use the **State** parameter of the `Get-Job` cmdlet to get workflow jobs in the Suspended state.
- Some job types have options or properties that prevent Windows PowerShell from suspending the job.
If attempts to suspend the job fail, verify that the job options and properties allow for
suspending.
Some job types have options or properties that prevent Windows PowerShell from suspending the job.
If attempts to suspend the job fail, verify that the job options and properties allow for
suspending.

## RELATED LINKS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.Powershell.LocalAccounts.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.LocalAccounts
ms.date: 12/13/2022
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.localaccounts/add-localgroupmember?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Add-LocalGroupMember
Expand Down Expand Up @@ -190,6 +190,10 @@ This cmdlet returns no output.

## NOTES

Windows PowerShell includes the following aliases for `Add-LocalGroupMember`:

- `algm`

The Microsoft.PowerShell.LocalAccounts module is not available in 32-bit PowerShell on a 64-bit
system.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.Powershell.LocalAccounts.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.LocalAccounts
ms.date: 12/13/2022
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.localaccounts/disable-localuser?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Disable-LocalUser
Expand Down Expand Up @@ -172,9 +172,13 @@ This cmdlet returns no output.

## NOTES

- The **PrincipalSource** property is a property on **LocalUser**, **LocalGroup**, and
**LocalPrincipal** objects that describes the source of the object. The possible sources are as
follows:
Windows PowerShell includes the following aliases for `Disable-LocalUser`:

- `dlu`

The **PrincipalSource** property is a property on **LocalUser**, **LocalGroup**, and
**LocalPrincipal** objects that describes the source of the object. The possible sources are as
follows:

- Local
- Active Directory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.Powershell.LocalAccounts.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.LocalAccounts
ms.date: 12/13/2022
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.localaccounts/enable-localuser?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Enable-LocalUser
Expand Down Expand Up @@ -173,9 +173,13 @@ This cmdlet returns no output.

## NOTES

- The **PrincipalSource** property is a property on **LocalUser**, **LocalGroup**, and
**LocalPrincipal** objects that describes the source of the object. The possible sources are as
follows:
Windows PowerShell includes the following aliases for `Enable-LocalUser`:

- `elu`

The **PrincipalSource** property is a property on **LocalUser**, **LocalGroup**, and
**LocalPrincipal** objects that describes the source of the object. The possible sources are as
follows:

- Local
- Active Directory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.Powershell.LocalAccounts.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.LocalAccounts
ms.date: 12/13/2022
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.localaccounts/get-localgroup?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Get-LocalGroup
Expand Down Expand Up @@ -86,7 +86,8 @@ Accept wildcard characters: False

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

## INPUTS

Expand All @@ -106,9 +107,13 @@ This cmdlet returns a local group.

## NOTES

- The **PrincipalSource** property is a property on **LocalUser**, **LocalGroup**, and
**LocalPrincipal** objects that describes the source of the object. The possible sources are as
follows:
Windows PowerShell includes the following aliases for `Get-LocalGroup`:

- `glg`

The **PrincipalSource** property is a property on **LocalUser**, **LocalGroup**, and
**LocalPrincipal** objects that describes the source of the object. The possible sources are as
follows:

- Local
- Active Directory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.Powershell.LocalAccounts.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.LocalAccounts
ms.date: 12/13/2022
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.localaccounts/get-localgroupmember?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Get-LocalGroupMember
Expand Down Expand Up @@ -123,7 +123,8 @@ Accept wildcard characters: False

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

## INPUTS

Expand All @@ -147,9 +148,13 @@ This cmdlet returns local principals.

## NOTES

- The **PrincipalSource** property is a property on **LocalUser**, **LocalGroup**, and
**LocalPrincipal** objects that describes the source of the object. The possible sources are as
follows:
Windows PowerShell includes the following aliases for `Get-LocalGroupMember`:

- `glgm`

The **PrincipalSource** property is a property on **LocalUser**, **LocalGroup**, and
**LocalPrincipal** objects that describes the source of the object. The possible sources are as
follows:

- Local
- Active Directory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.Powershell.LocalAccounts.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.LocalAccounts
ms.date: 12/13/2022
ms.date: 06/28/2023
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.localaccounts/get-localuser?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Get-LocalUser
Expand Down Expand Up @@ -142,6 +142,10 @@ This cmdlet returns local user accounts.

## NOTES

Windows PowerShell includes the following aliases for `Get-LocalUser`:

- `glu`

The **PrincipalSource** property on **LocalUser**, **LocalGroup**, and **LocalPrincipal** objects
describes the source of the object. The possible sources are as follows:

Expand Down
Loading