Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -272,9 +272,9 @@ remote session, including startup scripts in the session configuration, can find
the **ApplicationArguments** property of the `$PSSenderInfo` automatic variable. You can use this
parameter to send data to the remote session.

For more information, see [about_Hash_Tables](about/about_Hash_Tables.md),
For more information, see [about_Hash_Tables](About/about_Hash_Tables.md),
[about_Session_Configurations](About/about_Session_Configurations.md), and
[about_Automatic_Variables](about/about_Automatic_Variables.md).
[about_Automatic_Variables](About/about_Automatic_Variables.md).

```yaml
Type: System.Management.Automation.PSPrimitiveDictionary
Expand Down Expand Up @@ -339,7 +339,7 @@ The idle time-out value is of significant importance if you intend to disconnect
session. You can reconnect only if the session has not timed out.

Enter a value in milliseconds. The minimum value is `60000` (1 minute). The maximum is the value of
the **MaxIdleTimeoutms** property of the session configuration. The default value, `-1`, does not
the **MaxIdleTimeoutMs** property of the session configuration. The default value, `-1`, does not
set an idle time-out.

The session uses the idle time-out that is set in the session options, if any. If none is set
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ session configuration is 40.

### Example 3: Setting a transport option

This command shows the effect of setting a transport option in a session configuration on the sessions that use the session configuration.
This command shows the effect of setting a transport option in a session configuration on the
sessions that use the session configuration.

```powershell
$t = New-PSTransportOption -IdleTimeoutSec 3600
Expand Down Expand Up @@ -245,8 +246,8 @@ Accept wildcard characters: False

### -MaxIdleTimeoutSec

Limits the idle time-out set for each session to the specified value. The default value is `[Int]::MaxValue`
(~25 days).
Limits the idle time-out set for each session to the specified value. The default value is
`[Int]::MaxValue` (~25 days).

The idle time-out value is of significant importance when the user intends to disconnect and
reconnect to a session. The user can reconnect only if the session has not timed out.
Expand Down Expand Up @@ -400,7 +401,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 Down
7 changes: 4 additions & 3 deletions reference/7.5/Microsoft.PowerShell.Core/Out-Default.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ transforms the objects into a stream of Formatting records (driven by the data i
definition) and `Out-Host` transforms the formatting records into calls on the Host interface.

This cmdlet isn't intended to be used by the end user. Other cmdlets are recommended for controlling
output like [Out-Host](Out-Host.md) or using `Format-*` cmdlets and the [Format.ps1xml](About/about_format.ps1xml.md)
file to control formatting.
output like [Out-Host](Out-Host.md) or using `Format-*` cmdlets and the
[Format.ps1xml](About/about_Format.ps1xml.md) file to control formatting.

## EXAMPLES

Expand Down Expand Up @@ -100,7 +100,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 Down
3 changes: 2 additions & 1 deletion reference/7.5/Microsoft.PowerShell.Core/Out-Host.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,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 Down
3 changes: 2 additions & 1 deletion reference/7.5/Microsoft.PowerShell.Core/Out-Null.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,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 Down
4 changes: 2 additions & 2 deletions reference/7.5/Microsoft.PowerShell.Core/Receive-Job.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ When you start a PowerShell background job, the job starts, but the results don'
immediately. Instead, the command returns an object that represents the background job. The job
object contains useful information about the job, but it doesn't contain the results. This method
lets you continue to work in the session while the job runs. For more information about background
jobs in PowerShell, see [about_Jobs](./About/about_Jobs.md).
jobs in PowerShell, see [about_Jobs](About/about_Jobs.md).

The `Receive-Job` cmdlet gets the results that have been generated by the time that the
`Receive-Job` command is submitted. If the results aren't yet complete, you can run additional
Expand Down Expand Up @@ -592,7 +592,7 @@ 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](./About/about_CommonParameters.md).
[about_CommonParameters](About/about_CommonParameters.md).

## INPUTS

Expand Down
25 changes: 12 additions & 13 deletions reference/7.5/Microsoft.PowerShell.Core/Receive-PSSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@ If you use the `Receive-PSSession` cmdlet to connect to a session in which no co
or suspended, `Receive-PSSession` connects to the session, but returns no output or errors.

For more information about the Disconnected Sessions feature, see
[about_Remote_Disconnected_Sessions](./About/about_Remote_Disconnected_Sessions.md).
[about_Remote_Disconnected_Sessions](About/about_Remote_Disconnected_Sessions.md).

Some examples use splatting to reduce the line length and improve readability. For more information,
see [about_Splatting](./About/about_Splatting.md).
see [about_Splatting](About/about_Splatting.md).

## EXAMPLES

Expand Down Expand Up @@ -179,7 +179,7 @@ disrupts a session connection. PowerShell automatically attempts to reconnect th
second for the next four minutes and abandons the effort only if all attempts in the four-minute
interval fail.

```
```powershell
PS> $s = New-PSSession -ComputerName Server01 -Name AD -ConfigurationName ADEndpoint
PS> $s

Expand Down Expand Up @@ -248,7 +248,7 @@ commands. And, the script resumed execution and is getting the script results.
This example uses the `Receive-PSSession` cmdlet to reconnect to sessions that were intentionally
disconnected and get the results of jobs that were running in the sessions.

```
```powershell
PS> $parms = @{
InDisconnectedSession = $True
ComputerName = "Server01", "Server02", "Server30"
Expand Down Expand Up @@ -318,7 +318,7 @@ results are unexpected, the user can run commands in the sessions to investigate

This example shows what happens to a job that's running in a disconnected session.

```
```powershell
PS> $s = New-PSSession -ComputerName Server01 -Name Test
PS> $j = Invoke-Command -Session $s { 1..1500 | Foreach-Object {"Return $_"; sleep 30}} -AsJob
PS> $j
Expand Down Expand Up @@ -533,7 +533,7 @@ The parameter's value is used to select and filter sessions. It doesn't change t
configuration that the session uses.

For more information about session configurations, see
[about_Session_Configurations](./About/about_Session_Configurations.md).
[about_Session_Configurations](About/about_Session_Configurations.md).

```yaml
Type: System.String
Expand Down Expand Up @@ -786,9 +786,8 @@ precedence over maximum values, quotas, or limits set in the session configurati

For a description of the session options that includes the default values, see
`New-PSSessionOption`. For information about the **$PSSessionOption** preference variable, see
[about_Preference_Variables](./About/about_Preference_Variables.md). For more information about
session configurations, see
[about_Session_Configurations](./About/about_Session_Configurations.md).
[about_Preference_Variables](About/about_Preference_Variables.md). For more information about
session configurations, see [about_Session_Configurations](About/about_Session_Configurations.md).

```yaml
Type: System.Management.Automation.Remoting.PSSessionOption
Expand Down Expand Up @@ -977,13 +976,13 @@ When you disconnect a **PSSession**, the session state is Disconnected and the a

## RELATED LINKS

[about_PSSessions](./About/about_PSSessions.md)
[about_PSSessions](About/about_PSSessions.md)

[about_Remote](./About/about_Remote.md)
[about_Remote](About/about_Remote.md)

[about_Remote_Disconnected_Sessions](./About/about_Remote_Disconnected_Sessions.md)
[about_Remote_Disconnected_Sessions](About/about_Remote_Disconnected_Sessions.md)

[about_Session_Configurations](./About/about_Session_Configurations.md)
[about_Session_Configurations](About/about_Session_Configurations.md)

[Connect-PSSession](Connect-PSSession.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Specifies the name of the parameter the argument completer applies to. The type
parameters can't be an enumeration, such as the **ForegroundColor** parameter of the `Write-Host`
cmdlet.

For more information on enums, see [about_Enum](./About/about_Enum.md).
For more information on enums, see [about_Enum](About/about_Enum.md).

When registering an argument completer for PowerShell commands, always specify this parameter. When
you specify the **CommandName** parameter without the **ParameterName** or **Native** parameters,
Expand Down Expand Up @@ -272,7 +272,7 @@ parameters aren't important because PowerShell passes in the values by position.
[CommandAst Class](/dotnet/api/system.management.automation.language.commandast).
- `$fakeBoundParameters` (Position 4 **IDictionary**) - This parameter is set to a hashtable
containing the `$PSBoundParameters` for the cmdlet, before the user pressed <kbd>Tab</kbd>. For
more information, see [about_Automatic_Variables](./About/about_Automatic_Variables.md).
more information, see [about_Automatic_Variables](About/about_Automatic_Variables.md).

When you specify the **Native** parameter, the script block must take the following parameters in
the specified order. The names of the parameters aren't important because PowerShell passes in the
Expand All @@ -288,7 +288,7 @@ values by position.
when the user pressed <kbd>Tab</kbd>.

You can also provide an **ArgumentCompleter** as a parameter attribute. For more information, see
[about_Functions_Advanced_Parameters](./About/about_Functions_Advanced_Parameters.md).
[about_Functions_Advanced_Parameters](About/about_Functions_Advanced_Parameters.md).

```yaml
Type: System.Management.Automation.ScriptBlock
Expand All @@ -307,7 +307,7 @@ 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](./About/about_CommonParameters.md).
[about_CommonParameters](About/about_CommonParameters.md).

## INPUTS

Expand All @@ -325,4 +325,4 @@ This cmdlet returns no output.

## RELATED LINKS

[about_Functions_Argument_Completion](./About/about_Functions_Argument_Completion.md)
[about_Functions_Argument_Completion](About/about_Functions_Argument_Completion.md)
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ This example registers the **AdminShell** session configuration.

The `$sessionParams` variable is a hashtable containing all the parameter values. This hashtable is
passed to the cmdlet using PowerShell splatting. The `Register-PSSessionConfiguration` command uses
the **SecurityDescriptorSDDL** parameter to specify the SDDL in the value of the `$sddl` variable and
the **MaximumReceivedObjectSizeMB** parameter to increase the object size limit. It also uses the
**StartupScript** parameter to specify a script that configures the session.
the **SecurityDescriptorSDDL** parameter to specify the SDDL in the value of the `$sddl` variable
and the **MaximumReceivedObjectSizeMB** parameter to increase the object size limit. It also uses
the **StartupScript** parameter to specify a script that configures the session.

```powershell
$sddl = "O:NSG:BAD:P(A;;GA;;;BA)S:P(AU;FA;GA;;;WD)(AU;FASA;GWGX;;;WD)"
Expand Down Expand Up @@ -181,8 +181,8 @@ Register-PSSessionConfiguration -Name WithProfile -StartupScript Add-Profile.ps1
The script contains a single command that uses dot sourcing to run the user's
**CurrentUserAllHosts** profile in the current scope of the session.

For more information about profiles, see [about_Profiles](./About/about_Profiles.md). For more
information about dot sourcing, see [about_Scopes](./About/about_Scopes.md).
For more information about profiles, see [about_Profiles](About/about_Profiles.md). For more
information about dot sourcing, see [about_Scopes](About/about_Scopes.md).

## PARAMETERS

Expand Down Expand Up @@ -626,7 +626,8 @@ for this parameter are:

The default value is **UseCurrentThread**.

For more information, see [PSThreadOptions Enumeration](/dotnet/api/system.management.automation.runspaces.psthreadoptions?view=powershellsdk-1.1.0).
For more information, see
[PSThreadOptions Enumeration](/dotnet/api/system.management.automation.runspaces.psthreadoptions?view=powershellsdk-1.1.0).

```yaml
Type: System.Management.Automation.Runspaces.PSThreadOptions
Expand Down Expand Up @@ -714,7 +715,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 Down
13 changes: 7 additions & 6 deletions reference/7.5/Microsoft.PowerShell.Core/Remove-Job.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ An alternative is to use the **Job** parameter, such as `Remove-Job -Job $batch`
In this example, all the jobs in the current PowerShell session are deleted.

```powershell
Get-job | Remove-Job
Get-Job | Remove-Job
```

`Get-Job` gets all the jobs in the current PowerShell session. The job objects are sent down the
Expand All @@ -116,7 +116,7 @@ Remove-Job -State NotStarted

### Example 4: Delete jobs by using a friendly name

This example deletes all jobs from the current session with friendly names that end with *batch**,
This example deletes all jobs from the current session with friendly names that end with **batch**,
including jobs that are running.

```powershell
Expand Down Expand Up @@ -410,7 +410,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 Down Expand Up @@ -438,11 +439,11 @@ If a job stops before completion and its process hasn't exited, the process is f

## RELATED LINKS

[about_Jobs](./About/about_Jobs.md)
[about_Jobs](About/about_Jobs.md)

[about_Job_Details](./About/about_Job_Details.md)
[about_Job_Details](About/about_Job_Details.md)

[about_Remote_Jobs](./About/about_Remote_Jobs.md)
[about_Remote_Jobs](About/about_Remote_Jobs.md)

[Get-Job](Get-Job.md)

Expand Down
9 changes: 5 additions & 4 deletions reference/7.5/Microsoft.PowerShell.Core/Remove-PSSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,12 @@ with `Serv`.
### Example 4: Close sessions connected to a port

```powershell
Get-PSSession | where {$_.port -eq 90} | Remove-PSSession
Get-PSSession | Where-Object {$_.port -eq 90} | Remove-PSSession
```

This command closes the **PSSessions** that are connected to port 90. You can use this command
format to identify **PSSessions** by properties other than **ComputerName**, **Name**, **InstanceID**, and
**ID**.
format to identify **PSSessions** by properties other than **ComputerName**, **Name**,
**InstanceID**, and **ID**.

### Example 5: Close a session by instance ID

Expand Down Expand Up @@ -358,7 +358,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 Down
Loading