From f3f0715524d7597ff604ead89883363555ebe49a Mon Sep 17 00:00:00 2001 From: Wojciech Sciesinski Date: Sat, 11 Aug 2018 02:15:18 +0200 Subject: [PATCH] Replace Windows PowerShell with PowerShell --- .../Microsoft.PowerShell.Core/Add-History.md | 8 ++-- .../Connect-PSSession.md | 18 ++++---- .../Disable-PSSessionConfiguration.md | 2 +- .../Disconnect-PSSession.md | 6 +-- .../Enter-PSHostProcess.md | 14 +++--- .../Enter-PSSession.md | 14 +++--- .../Exit-PSSession.md | 4 +- .../ForEach-Object.md | 8 ++-- .../Microsoft.PowerShell.Core/Get-Command.md | 18 ++++---- .../6/Microsoft.PowerShell.Core/Get-Help.md | 18 ++++---- .../Microsoft.PowerShell.Core/Get-History.md | 6 +-- .../6/Microsoft.PowerShell.Core/Get-Job.md | 8 ++-- .../6/Microsoft.PowerShell.Core/Get-Module.md | 28 +++++------ .../Get-PSSession.md | 32 ++++++------- .../Get-PSSessionCapability.md | 2 +- .../Import-Module.md | 42 ++++++++--------- .../Invoke-Command.md | 46 +++++++++---------- .../Invoke-History.md | 2 +- .../New-ModuleManifest.md | 26 +++++------ .../New-PSRoleCapabilityFile.md | 18 ++++---- .../New-PSSession.md | 26 +++++------ .../New-PSSessionOption.md | 12 ++--- .../Microsoft.PowerShell.Core/Out-Default.md | 2 +- .../6/Microsoft.PowerShell.Core/Out-Host.md | 4 +- .../6/Microsoft.PowerShell.Core/Out-Null.md | 2 +- .../Providers/Environment-Provider.md | 12 ++--- .../Providers/FileSystem-Provider.md | 14 +++--- .../Get-ChildItem-for-FileSystem.md | 2 +- .../Get-Content-for-FileSystem.md | 2 +- .../Get-Item-for-FileSystem.md | 2 +- .../Test-Path-for-FileSystem.md | 10 ++-- .../Providers/Function-Provider.md | 14 +++--- .../Providers/Registry-Provider.md | 6 +-- .../Providers/Variable-Provider.md | 20 ++++---- .../Microsoft.PowerShell.Core/Receive-Job.md | 12 ++--- .../Receive-PSSession.md | 28 +++++------ .../Register-ArgumentCompleter.md | 2 +- .../Register-PSSessionConfiguration.md | 18 ++++---- .../6/Microsoft.PowerShell.Core/Remove-Job.md | 6 +-- .../Remove-Module.md | 2 +- .../Remove-PSSession.md | 6 +-- .../6/Microsoft.PowerShell.Core/Save-Help.md | 16 +++---- .../Microsoft.PowerShell.Core/Set-PSDebug.md | 6 +-- .../Set-PSSessionConfiguration.md | 6 +-- .../Set-StrictMode.md | 8 ++-- .../6/Microsoft.PowerShell.Core/Start-Job.md | 12 ++--- .../6/Microsoft.PowerShell.Core/Stop-Job.md | 8 ++-- .../Unregister-PSSessionConfiguration.md | 2 +- .../Microsoft.PowerShell.Core/Update-Help.md | 18 ++++---- .../6/Microsoft.PowerShell.Core/Wait-Job.md | 10 ++-- .../Microsoft.PowerShell.Core/Where-Object.md | 24 +++++----- 51 files changed, 316 insertions(+), 316 deletions(-) diff --git a/reference/6/Microsoft.PowerShell.Core/Add-History.md b/reference/6/Microsoft.PowerShell.Core/Add-History.md index cb26837761e8..31ed3bdc72f5 100644 --- a/reference/6/Microsoft.PowerShell.Core/Add-History.md +++ b/reference/6/Microsoft.PowerShell.Core/Add-History.md @@ -33,7 +33,7 @@ PS C:\> Get-History | Export-Csv c:\testing\history.csv PS C:\> Import-Csv history.csv | Add-History ``` -These commands add the commands typed in one Windows PowerShell session to the history of a different Windows PowerShell session. +These commands add the commands typed in one PowerShell session to the history of a different PowerShell session. The first command gets objects representing the commands in the history and exports them to the History.csv file. @@ -63,7 +63,7 @@ PS C:\> Get-History -Id 5 -Count 5 | Add-History This command adds the first five commands in the history to the end of the history list. It uses the Get-History cmdlet to get the five commands ending in command 5. The pipeline operator passes them to the **Add-History** cmdlet, which appends them to the current history. -The **Add-History** command does not include any parameters, but Windows PowerShell associates the objects passed through the pipeline with the *InputObject* parameter of **Add-History**. +The **Add-History** command does not include any parameters, but PowerShell associates the objects passed through the pipeline with the *InputObject* parameter of **Add-History**. ### Example 4: Add commands in a .csv file to the current history ``` @@ -86,7 +86,7 @@ PS C:\> Add-History -InputObject (Import-Clixml c:\temp\history01.xml) This command adds the commands in the History01.xml file to the current session history. It uses the *InputObject* parameter to pass the results of the command in parentheses to the **Add-History** cmdlet. -The command in parentheses, which is executed first, imports the History01.xml file into Windows PowerShell. +The command in parentheses, which is executed first, imports the History01.xml file into PowerShell. The **Add-History** cmdlet then adds the commands in the file to the session history. ## PARAMETERS @@ -138,7 +138,7 @@ This cmdlet returns a **HistoryInfo** object if you specify the *PassThru* param Otherwise, this cmdlet does not generate any output. ## NOTES -* The session history is a list of the commands entered during the session together with the ID. The session history represents the order of execution, the status, and the start and end times of the command. As you enter each command, Windows PowerShell adds it to the history so that you can reuse it. For more information about the session history, see about_History. +* The session history is a list of the commands entered during the session together with the ID. The session history represents the order of execution, the status, and the start and end times of the command. As you enter each command, PowerShell adds it to the history so that you can reuse it. For more information about the session history, see about_History. To specify the commands to add to the history, use the *InputObject* parameter. The **Add-History** command accepts only **HistoryInfo** objects, such as those returned for each command by the **Get-History** cmdlet. diff --git a/reference/6/Microsoft.PowerShell.Core/Connect-PSSession.md b/reference/6/Microsoft.PowerShell.Core/Connect-PSSession.md index bc36b71d307d..c13b5c4c6890 100644 --- a/reference/6/Microsoft.PowerShell.Core/Connect-PSSession.md +++ b/reference/6/Microsoft.PowerShell.Core/Connect-PSSession.md @@ -67,7 +67,7 @@ Connect-PSSession [-ThrottleLimit ] [-Id] [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The **Connect-PSSession** cmdlet reconnects to user-managed Windows PowerShell sessions (**PSSessions**) that were disconnected. +The **Connect-PSSession** cmdlet reconnects to user-managed PowerShell sessions (**PSSessions**) that were disconnected. It works on sessions that are disconnected intentionally, such as by using the Disconnect-PSSession cmdlet or the *InDisconnectedSession* parameter of the Invoke-Command cmdlet, and those that were disconnected unintentionally, such as by a temporary network outage. **Connect-PSSession** can connect to any disconnected session that was started by the same user. @@ -153,7 +153,7 @@ Id Name ComputerName State ConfigurationName Availabil -- ---- ------------ ----- ----------------- ------------ 1 ITTask Server01 Disconnected ITTasks None -Later that evening, the administrator starts her home computer, logs on to the corporate network, and starts Windows PowerShell. The fourth command uses the Get-PSSession cmdlet to get the sessions on the Server01 computer. The command finds the ITTask session.The fifth command uses the **Connect-PSSession** cmdlet to connect to the ITTask session. The command saves the session in the $s variable. +Later that evening, the administrator starts her home computer, logs on to the corporate network, and starts PowerShell. The fourth command uses the Get-PSSession cmdlet to get the sessions on the Server01 computer. The command finds the ITTask session.The fifth command uses the **Connect-PSSession** cmdlet to connect to the ITTask session. The command saves the session in the $s variable. PS C:\> Get-PSSession -ComputerName Server01 -Name ITTask Id Name ComputerName State ConfigurationName Availability @@ -181,7 +181,7 @@ PS C:\> Invoke-Command -Session $s {$BackupSpecs = Receive-Job -JobName Job2} PS C:\> Invoke-Command -Session $s {\\Server30\Scripts\New-SQLDatabase.ps1 -InitData $BackupSpecs.Initialization} -The ninth command disconnects from the session in the $s variable.The administrator closes Windows PowerShell and closes the computer. She can reconnect to the session on the next day and check the script status from her work computer. +The ninth command disconnects from the session in the $s variable.The administrator closes PowerShell and closes the computer. She can reconnect to the session on the next day and check the script status from her work computer. PS C:\> Disconnect-PSSession -Session $s -OutputBufferingMode Drop -IdleTimeoutSec 60*60*15 Id Name ComputerName State ConfigurationName Availability -- ---- ------------ ----- ----------------- ------------ @@ -199,7 +199,7 @@ Later that evening, the administrator logs on to her home computer and verifies Indicates that this cmdlet allows redirection of this connection to an alternate URI. When you use the *ConnectionURI* parameter, the remote destination can return an instruction to redirect to a different URI. -By default, Windows PowerShell does not redirect connections, but you can use this parameter to allow it to redirect the connection. +By default, PowerShell does not redirect connections, but you can use this parameter to allow it to redirect the connection. You can also limit the number of times the connection is redirected by changing the **MaximumConnectionRedirectionCount** session option value. Use the *MaximumRedirection* parameter of the New-PSSessionOption cmdlet or set the **MaximumConnectionRedirectionCount** property of the **$PSSessionOption** preference variable. @@ -281,7 +281,7 @@ Certificates are used in client certificate-based authentication. They can be mapped only to local user accounts. They do not work with domain accounts. -To get a certificate thumbprint, use a Get-Item or Get-ChildItem command in the Windows PowerShell Cert: drive. +To get a certificate thumbprint, use a Get-Item or Get-ChildItem command in the PowerShell Cert: drive. ```yaml Type: String @@ -371,9 +371,9 @@ If you do not specify a connection URI, you can use the *UseSSL* and *Port* para Valid values for the **Transport** segment of the URI are HTTP and HTTPS. If you specify a connection URI with a Transport segment, but do not specify a port, the session is created with standards ports: 80 for HTTP and 443 for HTTPS. -To use the default ports for Windows PowerShell remoting, specify port 5985 for HTTP or 5986 for HTTPS. +To use the default ports for PowerShell remoting, specify port 5985 for HTTP or 5986 for HTTPS. -If the destination computer redirects the connection to a different URI, Windows PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. +If the destination computer redirects the connection to a different URI, PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. ```yaml Type: Uri[] @@ -477,7 +477,7 @@ To connect to a remote computer, the remote computer must be listening on the po The default ports are 5985, which is the WinRM port for HTTP, and 5986, which is the WinRM port for HTTPS. Before using an alternate port, you must configure the WinRM listener on the remote computer to listen at that port. -To configure the listener, type the following two commands at the Windows PowerShell prompt: +To configure the listener, type the following two commands at the PowerShell prompt: `Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse` @@ -563,7 +563,7 @@ Accept wildcard characters: False Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to connect to the disconnected session. By default, SSL is not used. -WS-Management encrypts all Windows PowerShell content transmitted over the network. +WS-Management encrypts all PowerShell content transmitted over the network. The *UseSSL* parameter is an additional protection that sends the data across an HTTPS connection instead of an HTTP connection. If you use this parameter, but SSL is not available on the port that is used for the command, the command fails. diff --git a/reference/6/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md b/reference/6/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md index 387bae677324..979eb4211102 100644 --- a/reference/6/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md +++ b/reference/6/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md @@ -209,7 +209,7 @@ You can pipe a session configuration object or a string that contains the name o This cmdlet does not return any objects. ## NOTES -* To run this cmdlet on Windows Vista, Windows Server 2008, and later versions of the Windows operating system, you must start Windows PowerShell by using the Run as administrator option. +* To run this cmdlet on Windows Vista, Windows Server 2008, and later versions of the Windows operating system, you must start PowerShell by using the Run as administrator option. * diff --git a/reference/6/Microsoft.PowerShell.Core/Disconnect-PSSession.md b/reference/6/Microsoft.PowerShell.Core/Disconnect-PSSession.md index 2f8047e60af9..1ecf4d805876 100644 --- a/reference/6/Microsoft.PowerShell.Core/Disconnect-PSSession.md +++ b/reference/6/Microsoft.PowerShell.Core/Disconnect-PSSession.md @@ -41,7 +41,7 @@ Disconnect-PSSession [-IdleTimeoutSec ] [-OutputBufferingMode Get-PSSession -ComputerName Srv1 -Name ITTask -Credential Domain01\User01 Id Name ComputerName State ConfigurationName Availability -- ---- ------------ ----- ----------------- ------------ @@ -447,7 +447,7 @@ You can pipe a session to this cmdlet. This cmdlet returns an object that represents the session that it disconnected. ## NOTES -* The **Disconnect-PSSession** cmdlet works only when the local and remote computers are running Windows PowerShell 3.0 or later versions of Windows PowerShell. +* The **Disconnect-PSSession** cmdlet works only when the local and remote computers are running Windows PowerShell 3.0 or later versions of Windows PowerShell or PowerShell Core. * If you use **Disconnect-PSSession** on a disconnected session, the command does not affect the session and it does not generate errors. * Disconnected loopback sessions with interactive security tokens, which are created by using the *EnableNetworkAccess* parameter, can be reconnected only from the computer on which the session was created. This restriction protects the computer from malicious access. * When you disconnect a **PSSession**, the session state is **Disconnected** and the availability is **None**. diff --git a/reference/6/Microsoft.PowerShell.Core/Enter-PSHostProcess.md b/reference/6/Microsoft.PowerShell.Core/Enter-PSHostProcess.md index 3a467614cd38..f1a77dddb652 100644 --- a/reference/6/Microsoft.PowerShell.Core/Enter-PSHostProcess.md +++ b/reference/6/Microsoft.PowerShell.Core/Enter-PSHostProcess.md @@ -38,10 +38,10 @@ Enter-PSHostProcess [-HostProcessInfo] [[-AppDomainName] Enter-PSSession -ComputerName Server01 [Server01]: PS C:\> -The second command gets the Windows PowerShell process and redirects the output to the Process.txt file. The command is submitted to the remote computer, and the file is saved on the remote computer. +The second command gets the PowerShell process and redirects the output to the Process.txt file. The command is submitted to the remote computer, and the file is saved on the remote computer. [Server01]: PS C:\> Get-Process Powershell > C:\ps-test\Process.txt The third command uses the **Exit** keyword to end the interactive session and close the connection. @@ -127,7 +127,7 @@ PS C:\> Enter-PSSession -Session $s [Server01]: PS C:\> ``` -These commands use the *Session* parameter of **Enter-PSSession** to run the interactive session in an existing Windows PowerShell session (**PSSession**). +These commands use the *Session* parameter of **Enter-PSSession** to run the interactive session in an existing PowerShell session (**PSSession**). ### Example 4: Start an interactive session and specify the Port and Credential parameters ``` @@ -173,7 +173,7 @@ Allows redirection of this connection to an alternate Uniform Resource Identifie By default, redirection is not allowed. When you use the *ConnectionURI* parameter, the remote destination can return an instruction to redirect to a different URI. -By default, Windows PowerShell does not redirect connections, but you can use this parameter to allow it to redirect the connection. +By default, PowerShell does not redirect connections, but you can use this parameter to allow it to redirect the connection. You can also limit the number of times the connection is redirected by changing the **MaximumConnectionRedirectionCount** session option value. Use the *MaximumRedirection* parameter of the New-PSSessionOption cmdlet or set the **MaximumConnectionRedirectionCount** property of the $PSSessionOption preference variable. @@ -257,7 +257,7 @@ Enter the certificate thumbprint of the certificate. Certificates are used in client certificate-based authentication. They can be mapped only to local user accounts; they do not work with domain accounts. -To get a certificate, use the Get-Item or Get-ChildItem command in the Windows PowerShell Cert: drive. +To get a certificate, use the Get-Item or Get-ChildItem command in the PowerShell Cert: drive. ```yaml Type: String @@ -284,7 +284,7 @@ To use an IP address in the value of the *ComputerName* parameter, the command m Also, the computer must be configured for HTTPS transport or the IP address of the remote computer must be included in the WinRM TrustedHosts list on the local computer. For instructions for adding a computer name to the TrustedHosts list, see "How to Add a Computer to the Trusted Host List" in about_Remote_Troubleshooting. -Note: In Windows Vista and later versions of the Windows operating system, to include the local computer in the value of the *ComputerName* parameter, you must start Windows PowerShell with the Run as administrator option. +Note: In Windows Vista and later versions of the Windows operating system, to include the local computer in the value of the *ComputerName* parameter, you must start PowerShell with the Run as administrator option. ```yaml Type: String @@ -338,9 +338,9 @@ If you do not specify a *ConnectionURI*, you can use the *UseSSL*, *ComputerName Valid values for the Transport segment of the URI are HTTP and HTTPS. If you specify a connection URI with a Transport segment, but do not specify a port, the session is created by using standards ports: 80 for HTTP and 443 for HTTPS. -To use the default ports for Windows PowerShell remoting, specify port 5985 for HTTP or 5986 for HTTPS. +To use the default ports for PowerShell remoting, specify port 5985 for HTTP or 5986 for HTTPS. -If the destination computer redirects the connection to a different URI, Windows PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. +If the destination computer redirects the connection to a different URI, PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. ```yaml Type: Uri diff --git a/reference/6/Microsoft.PowerShell.Core/Exit-PSSession.md b/reference/6/Microsoft.PowerShell.Core/Exit-PSSession.md index 5eaebcf60ca3..66eb6e6be669 100644 --- a/reference/6/Microsoft.PowerShell.Core/Exit-PSSession.md +++ b/reference/6/Microsoft.PowerShell.Core/Exit-PSSession.md @@ -47,9 +47,9 @@ Id Name ComputerName State ConfigurationName 1 Session1 Server01 Opened Microsoft.PowerShell ``` -These commands start and stop an interactive session with the Server01 computer that uses a Windows PowerShell session (**PSSession**). +These commands start and stop an interactive session with the Server01 computer that uses a PowerShell session (**PSSession**). -Because the interactive session was started by using a Windows PowerShell session, the **PSSession** is still available when the interactive session ends. +Because the interactive session was started by using a PowerShell session, the **PSSession** is still available when the interactive session ends. If you use the *ComputerName* parameter, **Enter-PSSession** creates a temporary session that it closes when the interactive session ends. The first command uses the New-PSSession cmdlet to create a **PSSession** on the Server01 computer. diff --git a/reference/6/Microsoft.PowerShell.Core/ForEach-Object.md b/reference/6/Microsoft.PowerShell.Core/ForEach-Object.md index ca01a46e056d..a2a8c16aea77 100644 --- a/reference/6/Microsoft.PowerShell.Core/ForEach-Object.md +++ b/reference/6/Microsoft.PowerShell.Core/ForEach-Object.md @@ -40,7 +40,7 @@ Starting in Windows PowerShell 3.0, there are two different ways to construct a You can use a script block to specify the operation. Within the script block, use the `$_` variable to represent the current object. The script block is the value of the *Process* parameter. - The script block can contain any Windows PowerShell script. + The script block can contain any PowerShell script. For example, the following command gets the value of the **ProcessName** property of each process on the computer. @@ -81,7 +81,7 @@ This command takes an array of three integers and divides each one of them by 10 Get-ChildItem $pshome | ForEach-Object -Process {if (!$_.PSIsContainer) {$_.Name; $_.Length / 1024; " " }} ``` -This command gets the files and directories in the Windows PowerShell installation directory `$pshome` and passes them to the `ForEach-Object` cmdlet. +This command gets the files and directories in the PowerShell installation directory `$pshome` and passes them to the `ForEach-Object` cmdlet. If the object is not a directory, the script block gets the name of the file, divides the value of its **Length** property by 1024, and adds a space (" ") to separate it from the next entry. The cmdlet uses the **PSISContainer** property to determine whether an object is a directory. @@ -134,7 +134,7 @@ Hello This example shows the effect of piping the `$Null` automatic variable to the `ForEach-Object` cmdlet. -Because Windows PowerShell treats null as an explicit placeholder, the `ForEach-Object` cmdlet generates a value for `$Null`, just as it does for other objects that you pipe to it. +Because PowerShell treats null as an explicit placeholder, the `ForEach-Object` cmdlet generates a value for `$Null`, just as it does for other objects that you pipe to it. For more information about the `$Null` automatic variable, see about_Automatic_Variables. @@ -145,7 +145,7 @@ Get-Module -ListAvailable | ForEach-Object -MemberName Path Get-Module -ListAvailable | Foreach Path ``` -These commands gets the value of the **Path** property of all installed Windows PowerShell modules. +These commands gets the value of the **Path** property of all installed PowerShell modules. They use the *MemberName* parameter to specify the **Path** property of modules. The second command is equivalent to the first. diff --git a/reference/6/Microsoft.PowerShell.Core/Get-Command.md b/reference/6/Microsoft.PowerShell.Core/Get-Command.md index a9ce26366241..e255223ec9a7 100644 --- a/reference/6/Microsoft.PowerShell.Core/Get-Command.md +++ b/reference/6/Microsoft.PowerShell.Core/Get-Command.md @@ -57,7 +57,7 @@ A new **Version** property has been added to the **CommandInfo** class. PS C:\> Get-Command ``` -This command gets the Windows PowerShell cmdlets, functions, and aliases that are installed on the computer. +This command gets the PowerShell cmdlets, functions, and aliases that are installed on the computer. ### Example 2: Get commands in the current session ``` @@ -100,7 +100,7 @@ PS C:\> Get-Command Get-Childitem -Args Cert: -Syntax ``` This command uses the *ArgumentList* and *Syntax* parameters to get the syntax of the Get-ChildItem cmdlet when it is used in the Cert: drive. -The Cert: drive is a Windows PowerShell drive that the Certificate Provider adds to the session. +The Cert: drive is a PowerShell drive that the Certificate Provider adds to the session. When you compare the syntax displayed in the output with the syntax that is displayed when you omit the *Args* (*ArgumentList*) parameter, you'll see that the **Certificate provider** adds a dynamic parameter, **CodeSigningCert**, to the Get-ChildItem cmdlet. @@ -186,7 +186,7 @@ Microsoft.PowerShell.Utility This command gets the name of the snap-in or module in which the Get-Date cmdlet originated. The command uses the **ModuleName** property of all commands. -This command format works on commands in Windows PowerShell modules and snap-ins, even if they are not imported into the session. +This command format works on commands in PowerShell modules and snap-ins, even if they are not imported into the session. ### Example 13: Get cmdlets and functions that have an output type ``` @@ -225,7 +225,7 @@ To get the **PSTypeNames** property of a net adapter, and not the **PSTypeNames* Indicates that this cmdlet gets all commands, including commands of the same type that have the same name. By default, **Get-Command** gets only the commands that run when you type the command name. -For more information about the method that Windows PowerShell uses to select the command to run when multiple commands have the same name, see about_Command_Precedence (http://go.microsoft.com/fwlink/?LinkID=113214) in the TechNet library. +For more information about the method that PowerShell uses to select the command to run when multiple commands have the same name, see about_Command_Precedence (http://go.microsoft.com/fwlink/?LinkID=113214) in the TechNet library. For information about module-qualified command names and running commands that do not run by default because of a name conflict, see about_Modules (http://go.microsoft.com/fwlink/?LinkID=144311). This parameter was introduced in Windows PowerShell 3.0. @@ -252,7 +252,7 @@ The alias for *ArgumentList* is *Args*. To detect dynamic parameters that are available only when certain other parameters are used, set the value of *ArgumentList* to the parameters that trigger the dynamic parameters. To detect the dynamic parameters that a provider adds to a cmdlet, set the value of the *ArgumentList* parameter to a path in the provider drive, such as WSMan:, HKLM:, or Cert:. -When the command is a Windows PowerShell provider cmdlet, enter only one path in each command. +When the command is a PowerShell provider cmdlet, enter only one path in each command. The provider cmdlets return only the dynamic parameters for the first path the value of *ArgumentList*. For information about the provider cmdlets, see [about_Providers](About/about_Providers.md). @@ -276,13 +276,13 @@ By default, **Get-Command** gets all cmdlets, functions, and aliases. The acceptable values for this parameter are: -- Alias. Gets the aliases of all Windows PowerShell commands. For more information, see about_Aliases. +- Alias. Gets the aliases of all PowerShell commands. For more information, see about_Aliases. - All. Gets all command types. This parameter value is the equivalent of `Get-Command *`. - Application. Gets non-Windows-PowerShell files in paths listed in the **Path** environment variable ($env:path), including .txt, .exe, and .dll files. For more information about the **Path** environment variable, see about_Environment_Variables. - Cmdlet. Gets all cmdlets. - ExternalScript. Gets all .ps1 files in the paths listed in the **Path** environment variable ($env:path). -- Filter and Function. Gets all Windows PowerShell advanced and simple functions and filters. -- Script. Gets all script blocks. To get Windows PowerShell scripts (.ps1 files), use the ExternalScript value. +- Filter and Function. Gets all PowerShell advanced and simple functions and filters. +- Script. Gets all script blocks. To get PowerShell scripts (.ps1 files), use the ExternalScript value. ```yaml Type: CommandTypes @@ -445,7 +445,7 @@ Accept wildcard characters: False ### -ShowCommandInfo Indicates that this cmdlet displays command information. -For more information about the method that Windows PowerShell uses to select the command to run when multiple commands have the same name, see about_Command_Precedence. +For more information about the method that PowerShell uses to select the command to run when multiple commands have the same name, see about_Command_Precedence. For information about module-qualified command names and running commands that do not run by default because of a name conflict, see about_Modules. This parameter was introduced in Windows PowerShell 3.0. diff --git a/reference/6/Microsoft.PowerShell.Core/Get-Help.md b/reference/6/Microsoft.PowerShell.Core/Get-Help.md index 626e238aea9d..ae8fa6ae1385 100644 --- a/reference/6/Microsoft.PowerShell.Core/Get-Help.md +++ b/reference/6/Microsoft.PowerShell.Core/Get-Help.md @@ -11,7 +11,7 @@ title: Get-Help # Get-Help ## SYNOPSIS -Displays information about Windows PowerShell commands and concepts. +Displays information about PowerShell commands and concepts. ## SYNTAX @@ -173,7 +173,7 @@ This command displays a list of all help topics available on your system. PS C:\> Get-Help about_* ``` -This command displays a list of the conceptual topics included in Windows PowerShell help. +This command displays a list of the conceptual topics included in PowerShell help. All of these topics begin with the characters about_. To display a particular help file, type get-help \, for example, `Get-Help about_Signing`. @@ -406,7 +406,7 @@ If you enter the exact name of a help topic, **Get-Help** displays the topic con If you enter a word or word pattern that appears in several help topic titles, **Get-Help** displays a list of the matching titles. If you enter a word that does not match any help topic titles, **Get-Help** displays a list of topics that include that word in their contents. -The names of conceptual topics, such as `about_Objects`, must be entered in English, even in non-English versions of Windows PowerShell. +The names of conceptual topics, such as `about_Objects`, must be entered in English, even in non-English versions of PowerShell. ```yaml Type: String @@ -459,9 +459,9 @@ Accept wildcard characters: False ### -Path Gets help that explains how the cmdlet works in the specified provider path. -Enter a Windows PowerShell provider path. +Enter a PowerShell provider path. -This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet works in the specified Windows PowerShell provider path. +This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet works in the specified PowerShell provider path. This parameter is effective only for help about a provider cmdlet and only when the provider includes a custom version of the provider cmdlet help topic in its help file. To use this parameter, install the help file for the module that includes the provider. @@ -469,7 +469,7 @@ To see the custom cmdlet help for a provider path, go to the provider path locat You can also find custom cmdlet help online in the provider help section of the help topics. For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path (http://go.microsoft.com/fwlink/?LinkID=158676). -For more information about Windows PowerShell providers, see [about_Providers](About/about_Providers.md). +For more information about PowerShell providers, see [about_Providers](About/about_Providers.md). ```yaml Type: String @@ -524,9 +524,9 @@ If you get a conceptual help topic, **Get-Help** returns it as a string. If you get a command that has a help file, **Get-Help** returns a **MamlCommandHelpInfo** object. ## NOTES -* Windows PowerShell 3.0 does not include help files. To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. You can use the **Update-Help** cmdlet to download and install help files for the core commands that come with Windows PowerShell and for any modules that you install. You can also use it to update the help files so that the help on your computer is never outdated. +* Windows PowerShell 3.0 does not include help files. To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. You can use the **Update-Help** cmdlet to download and install help files for the core commands that come with PowerShell and for any modules that you install. You can also use it to update the help files so that the help on your computer is never outdated. - You can also read the help topics about the commands that come with Windows PowerShell online starting at Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116). + You can also read the help topics about the commands that come with PowerShell online starting at Scripting with PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116). * **Get-Help** displays help in the locale set for the Windows operating system or in the fallback language for that locale. If you do not have help files for the primary or fallback locale, **Get-Help** behaves as if there are no help files on the computer. To get help for a different locale, use Region and Language in Control Panel to change the settings. * The full view of help includes a table of information about the parameters. The table includes the following fields: @@ -545,7 +545,7 @@ For example, "2" indicates that when the parameter name is omitted, the paramete When the parameter name is used, the parameter can appear anywhere in the command. - Default value. -The parameter value that Windows PowerShell uses if you do not include the parameter in the command. +The parameter value that PowerShell uses if you do not include the parameter in the command. - Accepts pipeline input. Indicates whether you can (true) or cannot (false) send objects to the parameter through a pipeline. diff --git a/reference/6/Microsoft.PowerShell.Core/Get-History.md b/reference/6/Microsoft.PowerShell.Core/Get-History.md index d31995871a58..3d61b6b8811c 100644 --- a/reference/6/Microsoft.PowerShell.Core/Get-History.md +++ b/reference/6/Microsoft.PowerShell.Core/Get-History.md @@ -22,14 +22,14 @@ Get-History [[-Id] ] [[-Count] ] [] ## DESCRIPTION The **Get-History** cmdlet gets the session history, that is, the list of commands entered during the current session. -Windows PowerShell automatically maintains a history of each session. +PowerShell automatically maintains a history of each session. The number of entries in the session history is determined by the value of the $MaximumHistoryCount preference variable. Beginning in Windows PowerShell 3.0, the default value is 4096. You can save the session history in XML or CSV format. By default, history files are saved in the home directory, but you can save the file in any location. -For more information about the history features in Windows PowerShell, see about_History (http://go.microsoft.com/fwlink/?LinkID=113233) in the Microsoft TechNet library. +For more information about the history features in PowerShell, see about_History (http://go.microsoft.com/fwlink/?LinkID=113233) in the Microsoft TechNet library. ## EXAMPLES @@ -132,7 +132,7 @@ You can pipe a history ID to this cmdlet. This cmdlet returns a history object for each history item that it gets. ## NOTES -* The session history is a list of the commands entered during the session. The session history represents the run order, the status, and the start and end times of the command. As you enter each command, Windows PowerShell adds it to the history so that you can reuse it. For more information about the command history, see about_History. +* The session history is a list of the commands entered during the session. The session history represents the run order, the status, and the start and end times of the command. As you enter each command, PowerShell adds it to the history so that you can reuse it. For more information about the command history, see about_History. * Starting in Windows PowerShell 3.0, the default value of the $MaximumHistoryCount preference variable is 4096. In Windows PowerShell 2.0, the default value is 64. For more information about the $MaximumHistoryCount variable, see [about_Preference_Variables](About/about_Preference_Variables.md) in the TechNet library. ## RELATED LINKS diff --git a/reference/6/Microsoft.PowerShell.Core/Get-Job.md b/reference/6/Microsoft.PowerShell.Core/Get-Job.md index e6ed9a8afc64..3e4bea7556bd 100644 --- a/reference/6/Microsoft.PowerShell.Core/Get-Job.md +++ b/reference/6/Microsoft.PowerShell.Core/Get-Job.md @@ -11,7 +11,7 @@ title: Get-Job # Get-Job ## SYNOPSIS -Gets Windows PowerShell background jobs that are running in the current session. +Gets PowerShell background jobs that are running in the current session. ## SYNTAX @@ -60,9 +60,9 @@ You can use the parameters of **Get-Job** to get particular jobs. The job object that **Get-Job** returns contains useful information about the job, but it does not contain the job results. To get the results, use the Receive-Job cmdlet. -A Windows PowerShell background job is a command that runs in the background without interacting with the current session. +A PowerShell background job is a command that runs in the background without interacting with the current session. Typically, you use a background job to run a complex command that takes a long time to finish. -For more information about background jobs in Windows PowerShell, see about_Jobs. +For more information about background jobs in PowerShell, see about_Jobs. Beginning in Windows PowerShell 3.0, the **Get-Job** cmdlet also gets custom job types, such as workflow jobs and instances of scheduled jobs. To find the job type of a job, use the **PSJobTypeName** property of the job. @@ -222,7 +222,7 @@ Debug : {} Warning : {} StateChanged : -The fourth command uses **Get-Job** to get the job object that represents the Job2 child job. This is the job in which the command actually ran. It uses the dot method to get the **Reason** property of the **JobStateInfo** property.The result shows that the job failed because of an Access Denied error. In this case, the user forgot to use the Run as administrator option when starting Windows PowerShell.Because background jobs use the remoting features of Windows PowerShell, the computer must be configured for remoting to run a job, even when the job runs on the local computer.For information about requirements for remoting in Windows PowerShell, see about_Remote_Requirements. For troubleshooting tips, see about_Remote_Troubleshooting. +The fourth command uses **Get-Job** to get the job object that represents the Job2 child job. This is the job in which the command actually ran. It uses the dot method to get the **Reason** property of the **JobStateInfo** property.The result shows that the job failed because of an Access Denied error. In this case, the user forgot to use the Run as administrator option when starting PowerShell.Because background jobs use the remoting features of PowerShell, the computer must be configured for remoting to run a job, even when the job runs on the local computer.For information about requirements for remoting in PowerShell, see about_Remote_Requirements. For troubleshooting tips, see about_Remote_Troubleshooting. PS C:\> (Get-Job -Name job2).JobStateInfo.Reason Connecting to remote server using WSManCreateShellEx api failed. The async callback gave the following error message: Access is denied. ``` diff --git a/reference/6/Microsoft.PowerShell.Core/Get-Module.md b/reference/6/Microsoft.PowerShell.Core/Get-Module.md index 828183bd7515..bfd10265fe38 100644 --- a/reference/6/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/6/Microsoft.PowerShell.Core/Get-Module.md @@ -45,7 +45,7 @@ Get-Module [[-Name] ] [-FullyQualifiedName ] [- ## DESCRIPTION -The `Get-Module` cmdlet gets the Windows PowerShell modules that have been imported, or that can be imported, into a Windows PowerShell session. +The `Get-Module` cmdlet gets the PowerShell modules that have been imported, or that can be imported, into a PowerShell session. The module object that `Get-Module` returns contains valuable information about the module. You can also pipe the module objects to other cmdlets, such as the `Import-Module` and `Remove-Module` cmdlets. @@ -57,7 +57,7 @@ Starting in Windows PowerShell 3.0, modules are automatically imported when you You can also import the modules into your session by using the `Import-Module` cmdlet. Starting in Windows PowerShell 3.0, you can get and then, import modules from remote sessions into the local session. -This strategy uses the Implicit Remoting feature of Windows PowerShell and is equivalent to using the `Import-PSSession` cmdlet. +This strategy uses the Implicit Remoting feature of PowerShell and is equivalent to using the `Import-PSSession` cmdlet. When you use commands in modules imported from another session, the commands run implicitly in the remote session. This feature lets you manage the remote computer from the local session. @@ -66,12 +66,12 @@ This feature lets you use cmdlets that are implemented in non-managed code assem With these new features, the `Get-Module` and `Import-Module` cmdlets become primary tools for managing heterogeneous enterprises that include computers that run the Windows operating system and computers that run other operating systems. -To manage remote computers that run the Windows operating system that have Windows PowerShell and Windows PowerShell remoting enabled, create a **PSSession** on the remote computer and then use the **PSSession** parameter of `Get-Module` to get the Windows PowerShell modules in the **PSSession**. +To manage remote computers that run the Windows operating system that have PowerShell and PowerShell remoting enabled, create a **PSSession** on the remote computer and then use the **PSSession** parameter of `Get-Module` to get the PowerShell modules in the **PSSession**. When you import the modules, and then use the imported commands in the current session, the commands run implicitly in the **PSSession** on the remote computer. You can use this strategy to manage the remote computer. -You can use a similar strategy to manage computers that do not have Windows PowerShell remoting enabled. -These include computers that are not running the Windows operating system, and computers that have Windows PowerShell but do not have Windows PowerShell remoting enabled. +You can use a similar strategy to manage computers that do not have PowerShell remoting enabled. +These include computers that are not running the Windows operating system, and computers that have PowerShell but do not have PowerShell remoting enabled. Start by creating a CIM session on the remote computer. A CIM session is a connection to Windows Management Instrumentation (WMI) on the remote computer. @@ -223,7 +223,7 @@ This lets you see the module files that each script is exporting. ### Example 7: Display the contents of a module manifest -These commands display the contents of the module manifest for the Windows PowerShell **BitsTransfer** module. +These commands display the contents of the module manifest for the PowerShell **BitsTransfer** module. Modules are not required to have manifest files. When they do have a manifest file, the manifest file is required only to include a version number. @@ -328,7 +328,7 @@ The first command uses the `New-CimSession` cmdlet to create a session on the RS The second command uses the CIM session in the `$cs` variable to run a `Get-Module` command on the RSDGF03 computer. The command uses the Name parameter to specify the Storage module. The command uses a pipeline operator (|) to send the Storage module to the `Import-Module` cmdlet, which imports it into the local session. -The third command runs the `Get-Command` cmdlet on the `Get-Disk` command in the Storage module. When you import a CIM module into the local session, Windows PowerShell converts the CDXML files that represent the CIM module into Windows PowerShell scripts, which appear as functions in the local session. +The third command runs the `Get-Command` cmdlet on the `Get-Disk` command in the Storage module. When you import a CIM module into the local session, PowerShell converts the CDXML files that represent the CIM module into PowerShell scripts, which appear as functions in the local session. The fourth command runs the `Get-Disk` command. Although the command is typed in the local session, it runs implicitly on the remote computer from which it was imported. The command gets objects from the remote computer and returns them to the local session. @@ -401,7 +401,7 @@ Enter a variable that contains the CIM session or a command that gets the CIM se `Get-Module` uses the CIM session connection to get modules from the remote computer. When you import the module by using the `Import-Module` cmdlet and use the commands from the imported module in the current session, the commands actually run on the remote computer. -You can use this parameter to get modules from computers and devices that are not running the Windows operating system, and computers that have Windows PowerShell, but do not have Windows PowerShell remoting enabled. +You can use this parameter to get modules from computers and devices that are not running the Windows operating system, and computers that have PowerShell, but do not have PowerShell remoting enabled. The **CimSession** parameter gets all modules in the **CIMSession**. However, you can import only CIM-based and Cmdlet Definition XML (CDXML)-based modules. @@ -498,7 +498,7 @@ Accept wildcard characters: False ### -PSSession -Gets the modules in the specified user-managed Windows PowerShell session (**PSSession**). +Gets the modules in the specified user-managed PowerShell session (**PSSession**). Enter a variable that contains the session, a command that gets the session, such as a `Get-PSSession` command, or a command that creates the session, such as a `New-PSSession` command. When the session is connected to a remote computer, you must specify the **ListAvailable** parameter. @@ -589,8 +589,8 @@ When you specify the **ListAvailable** parameter, `Get-Module` returns a **Modul ## NOTES -- Beginning in Windows PowerShell 3.0, the core commands that are included in Windows PowerShell are packaged in modules. The exception is **Microsoft.PowerShell.Core**, which is a snap-in (**PSSnapin**). By default, only the **Microsoft.PowerShell.Core** snap-in is added to the session. Modules are imported automatically on first use and you can use the `Import-Module` cmdlet to import them. -- 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 (**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. +- Beginning in Windows PowerShell 3.0, the core commands that are included in PowerShell are packaged in modules. The exception is **Microsoft.PowerShell.Core**, which is a snap-in (**PSSnapin**). By default, only the **Microsoft.PowerShell.Core** snap-in is added to the session. Modules are imported automatically on first use and you can use the `Import-Module` cmdlet to import them. +- Starting in Windows PowerShell 3.0, the core commands that are installed with PowerShell are packaged in modules. In Windows PowerShell 2.0, and in host programs that create older-style sessions in later versions of 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](https://msdn.microsoft.com/library/system.management.automation.runspaces.initialsessionstate.createdefault2) in the MSDN library. @@ -602,11 +602,11 @@ When you specify the **ListAvailable** parameter, `Get-Module` returns a **Modul - To use the CIM session feature, the remote computer must have WS-Management remoting and Windows Management Instrumentation (WMI), which is the Microsoft implementation of the Common Information Model (CIM) standard. The computer must also have the Module Discovery WMI provider or an alternate WMI provider that has the same basic features. - You can use the CIM session feature on computers that are not running the Windows operating system and on Windows computers that have Windows PowerShell, but do not have Windows PowerShell remoting enabled. + You can use the CIM session feature on computers that are not running the Windows operating system and on Windows computers that have PowerShell, but do not have PowerShell remoting enabled. - You can also use the CIM parameters to get CIM modules from computers that have Windows PowerShell remoting enabled. + You can also use the CIM parameters to get CIM modules from computers that have PowerShell remoting enabled. This includes the local computer. -When you create a CIM session on the local computer, Windows PowerShell uses DCOM, instead of WMI, to create the session. +When you create a CIM session on the local computer, PowerShell uses DCOM, instead of WMI, to create the session. ## RELATED LINKS diff --git a/reference/6/Microsoft.PowerShell.Core/Get-PSSession.md b/reference/6/Microsoft.PowerShell.Core/Get-PSSession.md index c5973622119e..d9a542065c55 100644 --- a/reference/6/Microsoft.PowerShell.Core/Get-PSSession.md +++ b/reference/6/Microsoft.PowerShell.Core/Get-PSSession.md @@ -11,7 +11,7 @@ title: Get-PSSession # Get-PSSession ## SYNOPSIS -Gets the Windows PowerShell sessions on local and remote computers. +Gets the PowerShell sessions on local and remote computers. ## SYNTAX @@ -97,7 +97,7 @@ Get-PSSession [-Id] [] ``` ## DESCRIPTION -The **Get-PSSession** cmdlet gets the user-managed Windows PowerShell sessions (**PSSessions**) on local and remote computers. +The **Get-PSSession** cmdlet gets the user-managed PowerShell sessions (**PSSessions**) on local and remote computers. Starting in Windows PowerShell 3.0, sessions are stored on the computers at the remote end of each connection. You can use the *ComputerName* or *ConnectionUri* parameters of **Get-PSSession** to get the sessions that connect to the local computer or remote computers, even if they were not created in the current session. @@ -111,7 +111,7 @@ Use the remaining parameters to configure the temporary connection in which the NOTE: In Windows PowerShell 2.0, without parameters, **Get-PSSession** gets all sessions that were created in the current session. The *ComputerName* parameter gets sessions that were created in the current session and connect to the specified computer. -For more information about Windows PowerShell sessions, see about_PSSessions (http://go.microsoft.com/fwlink/?LinkID=135181). +For more information about PowerShell sessions, see about_PSSessions (http://go.microsoft.com/fwlink/?LinkID=135181). ## EXAMPLES @@ -164,7 +164,7 @@ The first command uses the **New-PSSession** cmdlet to create **PSSessions** on The second command uses a **Get-PSSession** cmdlet to get the three **PSSessions**. It then saves each of the **PSSessions** in a separate variable. -When Windows PowerShell assigns an array of objects to an array of variables, it assigns the first object to the first variable, the second object to the second variable, and so on. +When PowerShell assigns an array of objects to an array of variables, it assigns the first object to the first variable, the second object to the second variable, and so on. If there are more objects than variables, it assigns all remaining objects to the last variable in the array. If there are more variables than objects, the extra variables are not used. @@ -218,7 +218,7 @@ Because the value of the **ID** property is unique only in the current session, ### -AllowRedirection Indicates that this cmdlet allows redirection of this connection to an alternate Uniform Resource Identifier (URI). -By default, Windows PowerShell does not redirect connections. +By default, PowerShell does not redirect connections. This parameter configures the temporary connection that is created to run a **Get-PSSession** command with the *ConnectionUri* parameter. @@ -306,7 +306,7 @@ This parameter configures the temporary connection that is created to run a **Ge Certificates are used in client certificate-based authentication. They can be mapped only to local user accounts; they do not work with domain accounts. -To get a certificate thumbprint, use a Get-Item or Get-ChildItem command in the Windows PowerShell Cert: drive. +To get a certificate thumbprint, use a Get-Item or Get-ChildItem command in the PowerShell Cert: drive. This parameter was introduced in Windows PowerShell 3.0. @@ -329,12 +329,12 @@ Wildcard characters are not permitted. There is no default value. Beginning in Windows PowerShell 3.0, **PSSession** objects are stored on the computers at the remote end of each connection. -To get the sessions on the specified computers, Windows PowerShell creates a temporary connection to each computer and runs a **Get-PSSession** command. +To get the sessions on the specified computers, PowerShell creates a temporary connection to each computer and runs a **Get-PSSession** command. Type the NetBIOS name, an IP address, or a fully-qualified domain name of one or more computers. To specify the local computer, type the computer name, localhost, or a dot (.). -Note: This parameter gets sessions only from computers that run Windows PowerShell 3.0 or later versions of Windows PowerShell. +Note: This parameter gets sessions only from computers that run Windows PowerShell 3.0 or later versions of PowerShell. Earlier versions do not store sessions. ```yaml @@ -389,13 +389,13 @@ The default value is: http://localhost:5985/WSMAN. If you do not specify a *ConnectionUri*, you can use the *UseSSL*, *ComputerName*, *Port*, and *ApplicationName* parameters to specify the *ConnectionURI* values. Valid values for the Transport segment of the URI are HTTP and HTTPS. If you specify a connection URI with a Transport segment, but do not specify a port, the session is created with standards ports: 80 for HTTP and 443 for HTTPS. -To use the default ports for Windows PowerShell remoting, specify port 5985 for HTTP or 5986 for HTTPS. +To use the default ports for PowerShell remoting, specify port 5985 for HTTP or 5986 for HTTPS. -If the destination computer redirects the connection to a different URI, Windows PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. +If the destination computer redirects the connection to a different URI, PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. This parameter was introduced in Windows PowerShell 3.0. -This parameter gets sessions only from computers that run Windows PowerShell 3.0 or later versions of Windows PowerShell. +This parameter gets sessions only from computers that run Windows PowerShell 3.0 or later versions of Windows PowerShell or PowerShell Core. Earlier versions do not store sessions. ```yaml @@ -461,7 +461,7 @@ Specifies an array of instance IDs of sessions. This cmdlet gets only the sessions with the specified instance IDs. The instance ID is a GUID that uniquely identifies a session on a local or remote computer. -The **InstanceID** is unique, even when you have multiple sessions running in Windows PowerShell. +The **InstanceID** is unique, even when you have multiple sessions running in PowerShell. The instance ID of a session is stored in the **InstanceID** property of the session. @@ -526,7 +526,7 @@ To connect to a remote computer, the remote computer must be listening on the po The default ports are 5985, which is the WinRM port for HTTP, and 5986, which is the WinRM port for HTTPS. Before using an alternate port, you must configure the WinRM listener on the remote computer to listen at that port. -To configure the listener, type the following two commands at the Windows PowerShell prompt: +To configure the listener, type the following two commands at the PowerShell prompt: `Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse` @@ -710,10 +710,10 @@ You cannot pipe input to this cmdlet. ### System.Management.Automation.Runspaces.PSSession ## NOTES -* This cmdlet gets user-managed sessions **PSSession** objects" such as those that are created by using the New-PSSession, **Enter-PSSession**, and Invoke-Command cmdlets. It does not get the system-managed session that is created when you start Windows PowerShell. -* Starting in Windows PowerShell 3.0, **PSSession** objects are stored on the computer that is at the server-side or receiving end of a connection. To get the sessions that are stored on the local computer or a remote computer, Windows PowerShell establishes a temporary session to the specified computer and runs query commands in the session. +* This cmdlet gets user-managed sessions **PSSession** objects" such as those that are created by using the New-PSSession, **Enter-PSSession**, and Invoke-Command cmdlets. It does not get the system-managed session that is created when you start PowerShell. +* Starting in Windows PowerShell 3.0, **PSSession** objects are stored on the computer that is at the server-side or receiving end of a connection. To get the sessions that are stored on the local computer or a remote computer, PowerShell establishes a temporary session to the specified computer and runs query commands in the session. * To get sessions that connect to a remote computer, use the *ComputerName* or *ConnectionUri* parameters to specify the remote computer. To filter the sessions that **Get-PSSession** gets, use the *Name*, *ID*, *InstanceID*, and *State* parameters. Use the remaining parameters to configure the temporary session that **Get-PSSession** uses. -* When you use the *ComputerName* or *ConnectionUri* parameters, **Get-PSSession** gets only sessions from computers running Windows PowerShell 3.0 and later versions of Windows PowerShell. +* When you use the *ComputerName* or *ConnectionUri* parameters, **Get-PSSession** gets only sessions from computers running Windows PowerShell 3.0 and later versions of PowerShell. * The value of the **State** property of a **PSSession** is relative to the current session. Therefore, a value of **Disconnected** means that the **PSSession** is not connected to the current session. However, it does not mean that the **PSSession** is disconnected from all sessions. It might be connected to a different session. To determine whether you can connect or reconnect to the **PSSession** from the current session, use the **Availability** property. An **Availability** value of **None** indicates that you can connect to the session. diff --git a/reference/6/Microsoft.PowerShell.Core/Get-PSSessionCapability.md b/reference/6/Microsoft.PowerShell.Core/Get-PSSessionCapability.md index 4b98e0148c00..ddbdf00f240d 100644 --- a/reference/6/Microsoft.PowerShell.Core/Get-PSSessionCapability.md +++ b/reference/6/Microsoft.PowerShell.Core/Get-PSSessionCapability.md @@ -30,7 +30,7 @@ The **Get-PSSessionCapability** cmdlet reduces complexity when auditing these en By default, the **Get-PSSessionCapability** cmdlet returns a list of commands the specified user can run in the specified endpoint. This is equivalent to the user running **Get-Command** in the specified endpoint. When run with the *Full* parameter, this cmdlet returns an **InitialSessionState** object. -This object contains details about the Windows PowerShell runspace the specified user would interact with for the specified endpoint. +This object contains details about the PowerShell runspace the specified user would interact with for the specified endpoint. It includes information such as Language Mode, Execution Policy, and Environmental Variables. ## EXAMPLES diff --git a/reference/6/Microsoft.PowerShell.Core/Import-Module.md b/reference/6/Microsoft.PowerShell.Core/Import-Module.md index 5085845a010a..d73def7943c2 100644 --- a/reference/6/Microsoft.PowerShell.Core/Import-Module.md +++ b/reference/6/Microsoft.PowerShell.Core/Import-Module.md @@ -78,7 +78,7 @@ However, you can still use the **Import-Module** command to import a module and For more information about modules, see about_Modules (http://go.microsoft.com/fwlink/?LinkID=144311). For more information about the $PSModuleAutoloadingPreference variable, see [about_Preference_Variables](About/about_Preference_Variables.md). -A module is a package that contains members that can be used in Windows PowerShell. +A module is a package that contains members that can be used in PowerShell. Members include cmdlets, providers, scripts, functions, variables, and other tools and files. After a module is imported, you can use the module members in your session. @@ -87,7 +87,7 @@ By default, **Import-Module** imports all members that the module exports, but y You can also use the *NoClobber* parameter to prevent **Import-Module** from importing members that have the same names as members in the current session. **Import-Module** imports a module only into the current session. -To import the module into all sessions, add an **Import-Module** command to your Windows PowerShell profile. +To import the module into all sessions, add an **Import-Module** command to your PowerShell profile. For more information about profiles, see about_Profiles (http://go.microsoft.com/fwlink/?LinkID=113729). Starting in Windows PowerShell 3.0, you can use **Import-Module** to import Common Information Model (CIM) modules, in which the cmdlets are defined in Cmdlet Definition XML (CDXML) files. @@ -95,11 +95,11 @@ This feature allows you to use cmdlets that are implemented in non-managed code With these new features, **Import-Module** cmdlet becomes a primary tool for managing heterogeneous enterprises that include computers that run the Windows operating system and computers that are running other operating systems. -To manage remote computers that run the Windows operating system that have Windows PowerShell and Windows PowerShell remoting enabled, create a **PSSession** on the remote computer and then use the *PSSession* parameter of **Get-Module** to get the Windows PowerShell modules in the **PSSession**. +To manage remote computers that run the Windows operating system that have PowerShell and PowerShell remoting enabled, create a **PSSession** on the remote computer and then use the *PSSession* parameter of **Get-Module** to get the PowerShell modules in the **PSSession**. When you import the modules, and then use the imported commands in the current session, the commands run implicitly in the **PSSession** on the remote computer. You can use this strategy to manage the remote computer. -You can use a similar strategy to manage computers that do not have Windows PowerShell remoting enabled, including computers that are not running the Windows operating system, and Windows computers that have Windows PowerShell, but do not have Windows PowerShell remoting enabled. +You can use a similar strategy to manage computers that do not have PowerShell remoting enabled, including computers that are not running the Windows operating system, and Windows computers that have PowerShell, but do not have PowerShell remoting enabled. Start by creating a CIM session on the remote computer, which is a connection to Windows Management Instrumentation (WMI) on the remote computer. Then use the *CIMSession* parameter of **Import-Module** to import CIM modules from the remote computer. @@ -338,7 +338,7 @@ The results show that there are two **Get-Date** commands in the session, a func The fifth command runs the hidden cmdlet by qualifying the command name with the module name. -For more information about command precedence in Windows PowerShell, see about_Command_Precedence (http://go.microsoft.com/fwlink/?LinkID=113214). +For more information about command precedence in PowerShell, see about_Command_Precedence (http://go.microsoft.com/fwlink/?LinkID=113214). ### Example 10: Import a minimum version of a module ``` @@ -389,7 +389,7 @@ Windows Remote Management - Compatibility Mode (HTTP-In) WINRM-HTTP-Compat-In-TC ``` This example shows how to use the **Import-Module** cmdlet to import a module from a remote computer. -This command uses the Implicit Remoting feature of Windows PowerShell. +This command uses the Implicit Remoting feature of PowerShell. When you import modules from another session, you can use the cmdlets in the current session. However, commands that use the cmdlets actually run in the remote session. @@ -402,7 +402,7 @@ PS C:\> $cs = New-CimSession -ComputerName RSDGF03 The second command uses the CIM session in the $cs variable to run an **Import-Module** command on the RSDGF03 computer. The command uses the *Name* parameter to specify the **Storage** CIM module. PS C:\> Import-Module -CimSession $cs -Name Storage -The third command runs the **Get-Command** command on the **Get-Disk** command in the **Storage** module.When you import a CIM module into the local session, Windows PowerShell converts the CDXML files for each command into Windows PowerShell scripts, which appear as functions in the local session. +The third command runs the **Get-Command** command on the **Get-Disk** command in the **Storage** module.When you import a CIM module into the local session, PowerShell converts the CDXML files for each command into PowerShell scripts, which appear as functions in the local session. PS C:\> Get-Command Get-Disk CommandType Name ModuleName ----------- ---- ---------- @@ -547,7 +547,7 @@ Enter a variable that contains the CIM session or a command that gets the CIM se **Import-Module** uses the CIM session connection to import modules from the remote computer into the current session. When you use the commands from the imported module in the current session, the commands actually run on the remote computer. -You can use this parameter to import modules from computers and devices that are not running the Windows operating system, and Windows computers that have Windows PowerShell, but do not have Windows PowerShell remoting enabled. +You can use this parameter to import modules from computers and devices that are not running the Windows operating system, and Windows computers that have PowerShell, but do not have PowerShell remoting enabled. This parameter was introduced in Windows PowerShell 3.0. @@ -585,7 +585,7 @@ Accept wildcard characters: False ### -DisableNameChecking Indicates that this cmdlet suppresses the message that warns you when you import a cmdlet or function whose name includes an unapproved verb or a prohibited character. -By default, when a module that you import exports cmdlets or functions that have unapproved verbs in their names, Windows PowerShell displays the following warning message: +By default, when a module that you import exports cmdlets or functions that have unapproved verbs in their names, PowerShell displays the following warning message: "WARNING: Some imported command names include unapproved verbs which might make them less discoverable. Use the Verbose parameter for more detail or type Get-Verb to see the list of approved verbs." @@ -769,17 +769,17 @@ Accept wildcard characters: False ``` ### -PSSession -Specifies a Windows PowerShell user-managed session (**PSSession**) from which this cmdlet import modules into the current session. +Specifies a PowerShell user-managed session (**PSSession**) from which this cmdlet import modules into the current session. Enter a variable that contains a **PSSession** or a command that gets a **PSSession**, such as a Get-PSSession command. When you import a module from a different session into the current session, you can use the cmdlets from the module in the current session, just as you would use cmdlets from a local module. -Commands that use the remote cmdlets actually run in the remote session, but the remoting details are managed in the background by Windows PowerShell. +Commands that use the remote cmdlets actually run in the remote session, but the remoting details are managed in the background by PowerShell. -This parameter uses the Implicit Remoting feature of Windows PowerShell. +This parameter uses the Implicit Remoting feature of PowerShell. It is equivalent to using the Import-PSSession cmdlet to import particular modules from a session. -**Import-Module** cannot import Windows PowerShell Core modules from another session. -The Windows PowerShell Core modules have names that begin with Microsoft.PowerShell. +**Import-Module** cannot import PowerShell Core modules from another session. +The PowerShell Core modules have names that begin with Microsoft.PowerShell. This parameter was introduced in Windows PowerShell 3.0. @@ -847,7 +847,7 @@ You can also use the *Module* and *Version* parameters of the **#Requires** keyw This parameter was introduced in Windows PowerShell 3.0. Scripts that use *RequiredVersion* to import modules that are included with existing releases of the Windows operating system do not automatically run in future releases of the Windows operating system. -This is because Windows PowerShell module version numbers in future releases of the Windows operating system are higher than module version numbers in existing releases of the Windows operating system. +This is because PowerShell module version numbers in future releases of the Windows operating system are higher than module version numbers in existing releases of the Windows operating system. ```yaml Type: Version @@ -951,13 +951,13 @@ If you specify the *AsCustomObject* parameter, it generates a **PSCustomObject** You can also use the *PSSession* and *CIMSession* parameters to import modules that are installed on remote computers. However, commands that use the cmdlets in these modules actually run in the remote session on the remote computer. -* If you import members with the same name and the same type into your session, Windows PowerShell uses the member imported last by default. Variables and aliases are replaced, and the originals are not accessible. Functions, cmdlets and providers are merely shadowed by the new members. They can be accessed by qualifying the command name with the name of its snap-in, module, or function path. +* If you import members with the same name and the same type into your session, PowerShell uses the member imported last by default. Variables and aliases are replaced, and the originals are not accessible. Functions, cmdlets and providers are merely shadowed by the new members. They can be accessed by qualifying the command name with the name of its snap-in, module, or function path. * To update the formatting data for commands that have been imported from a module, use the Update-FormatData cmdlet. **Update-FormatData** also updates the formatting data for commands in the session that were imported from modules. If the formatting file for a module changes, you can run an **Update-FormatData** command to update the formatting data for imported commands. You do not need to import the module again. -* 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 (**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. +* Starting in Windows PowerShell 3.0, the core commands that are installed with PowerShell are packaged in modules. In Windows PowerShell 2.0, and in host programs that create older-style sessions in later versions of 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](https://msdn.microsoft.com/library/system.management.automation.runspaces.initialsessionstate.createdefault2) in the MSDN library. -* **Import-Module** cannot import Windows PowerShell Core modules from another session. The Windows PowerShell Core modules have names that begin with Microsoft.PowerShell. +* **Import-Module** cannot import PowerShell Core modules from another session. The PowerShell Core modules have names that begin with Microsoft.PowerShell. * In Windows PowerShell 2.0, some of the property values of the module object, such as the **ExportedCmdlets** and **NestedModules** property values, were not populated until the module was imported and were not available on the module object that the *PassThru* parameter returns. In Windows PowerShell 3.0, all module property values are populated. * If you attempt to import a module that contains mixed-mode assemblies that are not compatible with Windows PowerShell 3.0, **Import-Module** returns an error message like the following one. @@ -971,10 +971,10 @@ However, commands that use the cmdlets in these modules actually run in the remo * To use the CIM session feature, the remote computer must have WS-Management remoting and Windows Management Instrumentation (WMI), which is the Microsoft implementation of the Common Information Model (CIM) standard. The computer must also have the Module Discovery WMI provider or an alternate CIM provider that has the same basic features. - You can use the CIM session feature on computers that are not running a Windows operating system and on Windows computers that have Windows PowerShell, but do not have Windows PowerShell remoting enabled. + You can use the CIM session feature on computers that are not running a Windows operating system and on Windows computers that have PowerShell, but do not have PowerShell remoting enabled. - You can also use the CIM parameters to get CIM modules from computers that have Windows PowerShell remoting enabled, including the local computer. -When you create a CIM session on the local computer, Windows PowerShell uses DCOM, instead of WMI, to create the session. + You can also use the CIM parameters to get CIM modules from computers that have PowerShell remoting enabled, including the local computer. +When you create a CIM session on the local computer, PowerShell uses DCOM, instead of WMI, to create the session. ## RELATED LINKS diff --git a/reference/6/Microsoft.PowerShell.Core/Invoke-Command.md b/reference/6/Microsoft.PowerShell.Core/Invoke-Command.md index e380b61572b1..f488f455a05e 100644 --- a/reference/6/Microsoft.PowerShell.Core/Invoke-Command.md +++ b/reference/6/Microsoft.PowerShell.Core/Invoke-Command.md @@ -150,7 +150,7 @@ To run a command in a disconnected session, use the *InDisconnectedSession* para To run a command in a background job, use the *AsJob* parameter. You can also use **Invoke-Command** on a local computer to evaluate or run a string in a script block as a command. -Windows PowerShell converts the script block to a command and runs the command immediately in the current scope, instead of just echoing the string at the command line. +PowerShell converts the script block to a command and runs the command immediately in the current scope, instead of just echoing the string at the command line. To start an interactive session with a remote computer, use the Enter-PSSession cmdlet. To establish a persistent connection to a remote computer, use the **New-PSSession** cmdlet. @@ -181,7 +181,7 @@ This command runs a Get-Culture command on the Server01 remote computer. It uses the *ComputerName* parameter to specify the computer name and the *Credential* parameter to run the command in the security context of Domain01\User01, a user who has permission to run commands. It uses the *ScriptBlock* parameter to specify the command to be run on the remote computer. -In response, Windows PowerShell displays a dialog box that requests the password and an authentication method for the User01 account. +In response, PowerShell displays a dialog box that requests the password and an authentication method for the User01 account. It then runs the command on the Server01 computer and returns the result. ### Example 3: Run a command in a persistent connection @@ -199,7 +199,7 @@ Then, it saves the session in the $s variable. The second command uses the **Invoke-Command** cmdlet to run the Get-Culture command on Server02. It uses the *Session* parameter to specify the session saved in the $s variable. -In response, Windows PowerShell runs the command in the session on the Server02 computer. +In response, PowerShell runs the command in the session on the Server02 computer. ### Example 4: Use a session to run a series of commands that share data ``` @@ -220,7 +220,7 @@ The first command uses the Get-Process cmdlet to get the PowerShell process on t The second command gets the value of the **VirtualMemorySize** property of the PowerShell process. The first command succeeds. -But the second command fails, because when you use the *ComputerName* parameter, Windows PowerShell creates a connection just to run the command. +But the second command fails, because when you use the *ComputerName* parameter, PowerShell creates a connection just to run the command. Then, it closes the connection when the command is completed. The $p variable was created in one connection, but it does not exist in the connection created for the second command. @@ -268,13 +268,13 @@ In this example, the command in the script block gets the events in the Windows PS C:\> $version = Invoke-Command -ComputerName (Get-Content Machines.txt) -ScriptBlock {(Get-Host).Version} ``` -This command gets the version of the Windows PowerShell host program running on 200 remote computers. +This command gets the version of the PowerShell host program running on 200 remote computers. Because only one command is run, you do not have to create persistent connections to each of the computers. Instead, the command uses the *ComputerName* parameter to indicate the computers. The command uses the **Invoke-Command** cmdlet to run a Get-Host command. -It uses dot notation to get the **Version** property of the Windows PowerShell host. +It uses dot notation to get the **Version** property of the PowerShell host. To specify the computers, it uses the Get-Content cmdlet to get the contents of the Machine.txt file, a file of computer names. @@ -396,7 +396,7 @@ PS C:\> Invoke-Command -ConfigurationName Microsoft.Exchange -ConnectionUri http This example shows how to run a command on a remote computer that is identified by a URI. This particular example runs a **Set-Mailbox** command on a remote Exchange server. -The backtick (\`) in the command is the Windows PowerShell continuation character. +The backtick (\`) in the command is the PowerShell continuation character. The first command uses the Get-Credential cmdlet to store Windows Live ID credentials in the $LiveCred variable. A credentials dialog box prompts the user to enter Windows Live ID credentials. @@ -425,7 +425,7 @@ The second command uses the **Invoke-Command** cmdlet to run a **Get-Mailbox** c The command uses the *AllowRedirection* parameter to provide explicit permission to redirect the connection to an alternate endpoint. It also uses the *SessionOption* parameter to specify the session object in the $max variable. -As a result, if the remote computer specified by *ConnectionURI* returns a redirection message, Windows PowerShell redirects the connection, but if the new destination returns another redirection message, the redirection count value of 1 is exceeded, and *Invoke-Command* returns a non-terminating error. +As a result, if the remote computer specified by *ConnectionURI* returns a redirection message, PowerShell redirects the connection, but if the new destination returns another redirection message, the redirection count value of 1 is exceeded, and *Invoke-Command* returns a non-terminating error. ### Example 14: Use a session option ``` @@ -517,7 +517,7 @@ This example shows how to run a script file on multiple remote computers using S Allows redirection of this connection to an alternate Uniform Resource Identifier (URI). When you use the *ConnectionURI* parameter, the remote destination can return an instruction to redirect to a different URI. -By default, Windows PowerShell does not redirect connections, but you can use this parameter to allow it to redirect the connection. +By default, PowerShell does not redirect connections, but you can use this parameter to allow it to redirect the connection. You can also limit the number of times the connection is redirected by changing the **MaximumConnectionRedirectionCount** session option value. Use the *MaximumRedirection* parameter of the New-PSSessionOption cmdlet or set the **MaximumConnectionRedirectionCount** property of the $PSSessionOption preference variable. @@ -599,7 +599,7 @@ To get the job results, use the Receive-Job cmdlet. The *AsJob* parameter resembles using the **Invoke-Command** cmdlet to run a Start-Job command remotely. However, with *AsJob*, the job is created on the local computer, even though the job runs on a remote computer, and the results of the remote job are automatically returned to the local computer. -For more information about Windows PowerShell background jobs, see [about_Jobs](About/about_Jobs.md) and [about_Remote_Jobs](About/about_Remote_Jobs.md). +For more information about PowerShell background jobs, see [about_Jobs](About/about_Jobs.md) and [about_Remote_Jobs](About/about_Remote_Jobs.md). ```yaml Type: SwitchParameter @@ -655,7 +655,7 @@ Enter the certificate thumbprint of the certificate. Certificates are used in client certificate-based authentication. They can be mapped only to local user accounts; they do not work with domain accounts. -To get a certificate thumbprint, use a Get-Item or Get-ChildItem command in the Windows PowerShell Cert: drive. +To get a certificate thumbprint, use a Get-Item or Get-ChildItem command in the PowerShell Cert: drive. ```yaml Type: String @@ -673,7 +673,7 @@ Accept wildcard characters: False Specifies the computers on which the command runs. The default is the local computer. -When you use the *ComputerName* parameter, Windows PowerShell creates a temporary connection that is used only to run the specified command and is then closed. +When you use the *ComputerName* parameter, PowerShell creates a temporary connection that is used only to run the specified command and is then closed. If you need a persistent connection, use the *Session* parameter. Type the NETBIOS name, IP address, or fully qualified domain name of one or more computers in a comma-separated list. @@ -683,7 +683,7 @@ To use an IP address in the value of *ComputerName*, the command must include th Also, the computer must be configured for HTTPS transport or the IP address of the remote computer must be included in the WinRM TrustedHosts list on the local computer. For instructions for adding a computer name to the TrustedHosts list, see "How to Add a Computer to the Trusted Host List" in about_Remote_Troubleshooting. -On Windows Vista and later versions of the Windows operating system, to include the local computer in the value of *ComputerName*, you must open Windows PowerShell by using the Run as administrator option. +On Windows Vista and later versions of the Windows operating system, to include the local computer in the value of *ComputerName*, you must open PowerShell by using the Run as administrator option. ```yaml Type: String[] @@ -738,9 +738,9 @@ If you do not specify a connection URI, you can use the *UseSSL* and *Port* para Valid values for the **Transport** segment of the URI are HTTP and HTTPS. If you specify a connection URI with a Transport segment, but do not specify a port, the session is created with standards ports: 80 for HTTP and 443 for HTTPS. -To use the default ports for Windows PowerShell remoting, specify port 5985 for HTTP or 5986 for HTTPS. +To use the default ports for PowerShell remoting, specify port 5985 for HTTP or 5986 for HTTPS. -If the destination computer redirects the connection to a different URI, Windows PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. +If the destination computer redirects the connection to a different URI, PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. ```yaml Type: Uri[] @@ -826,7 +826,7 @@ Enter the path and file name of the script, or pipe a script path to **Invoke-Co The script must reside on the local computer or in a directory that the local computer can access. Use *ArgumentList* to specify the values of parameters in the script. -When you use this parameter, Windows PowerShell converts the contents of the specified script file to a script block, transmits the script block to the remote computer, and runs it on the remote computer. +When you use this parameter, PowerShell converts the contents of the specified script file to a script block, transmits the script block to the remote computer, and runs it on the remote computer. ```yaml Type: String @@ -919,7 +919,7 @@ By default, jobs are named Job\, where \ is an ordinal number. If you use the *JobName* parameter in a command, the command is run as a job, and **Invoke-Command** returns a job object, even if you do not include *AsJob* in the command. -For more information about Windows PowerShell background jobs, see [about_Jobs](About/about_Jobs.md). +For more information about PowerShell background jobs, see [about_Jobs](About/about_Jobs.md). ```yaml Type: String @@ -959,7 +959,7 @@ To connect to a remote computer, the remote computer must be listening on the po The default ports are 5985, which is the WinRM port for HTTP, and 5986, which is the WinRM port for HTTPS. Before using an alternate port, configure the WinRM listener on the remote computer to listen at that port. -To configure the listener, type the following two commands at the Windows PowerShell prompt: +To configure the listener, type the following two commands at the PowerShell prompt: `Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse` @@ -1005,7 +1005,7 @@ Accept wildcard characters: False Specifies an array of sessions in which this cmdlet runs the command. Enter a variable that contains **PSSession** objects or a command that creates or gets the **PSSession** objects, such as a **New-PSSession** or **Get-PSSession** command. -When you create a **PSSession**, Windows PowerShell establishes a persistent connection to the remote computer. +When you create a **PSSession**, PowerShell establishes a persistent connection to the remote computer. Use a **PSSession** to run a series of related commands that share data. To run a single command or a series of unrelated commands, use the *ComputerName* parameter. For more information, see about_PSSessions. @@ -1089,7 +1089,7 @@ Accept wildcard characters: False Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to establish a connection to the remote computer. By default, SSL is not used. -WS-Management encrypts all Windows PowerShell content transmitted over the network. +WS-Management encrypts all PowerShell content transmitted over the network. The *UseSSL* parameter is an additional protection that sends the data across an HTTPS, instead of HTTP. If you use this parameter, but SSL is not available on the port that is used for the command, the command fails. @@ -1282,8 +1282,8 @@ If you specify the *InDisconnectedSession* parameter, **Invoke-Command** returns Otherwise, it returns the output of the invoked command, which is the value of the *ScriptBlock* parameter. ## NOTES -* On Windows Vista, and later versions of the Windows operating system, to use the *ComputerName* parameter of **Invoke-Command** to run a command on the local computer, you must open Windows PowerShell by using the Run as administrator option. -* When you run commands on multiple computers, Windows PowerShell connects to the computers in the order in which they appear in the list. However, the command output is displayed in the order that it is received from the remote computers, which might be different. +* On Windows Vista, and later versions of the Windows operating system, to use the *ComputerName* parameter of **Invoke-Command** to run a command on the local computer, you must open PowerShell by using the Run as administrator option. +* When you run commands on multiple computers, PowerShell connects to the computers in the order in which they appear in the list. However, the command output is displayed in the order that it is received from the remote computers, which might be different. * Errors that result from the command that **Invoke-Command** runs are included in the command results. Errors that would be terminating errors in a local command are treated as non-terminating errors in a remote command. This strategy makes sure that terminating errors on one computer do not close the command on all computers on which it is run. This practice is used even when a remote command is run on a single computer. * If the remote computer is not in a domain that the local computer trusts, the computer might not be able to authenticate the credentials of the user. To add the remote computer to the list of trusted hosts in WS-Management, use the following command in the WSMAN provider, where \ is the name of the remote computer: @@ -1291,7 +1291,7 @@ Otherwise, it returns the output of the invoked command, which is the value of t * In Windows PowerShell 2.0, you cannot use the Select-Object cmdlet to select the **PSComputerName** property of the object that **Invoke-Command** returns. Instead, to display the value of the **PSComputerName** property, use the dot method to get the **PSComputerName** property value ($result.PSComputerName), use a **Format** cmdlet, such as the Format-Table cmdlet, to display the value of the **PSComputerName** property, or use a Select-Object command where the value of the property parameter is a calculated property that has a label other than PSComputerName. - This limitation does not apply to Windows PowerShell 3.0 or later versions of Windows PowerShell. + This limitation does not apply to Windows PowerShell 3.0 or later versions of Windows PowerShell or PowerShell Core. * When you disconnect a **PSSession**, such as by using *InDisconnectedSession*, the session state is Disconnected and the availability is None. diff --git a/reference/6/Microsoft.PowerShell.Core/Invoke-History.md b/reference/6/Microsoft.PowerShell.Core/Invoke-History.md index c591d80f2cb9..612a21b6fd24 100644 --- a/reference/6/Microsoft.PowerShell.Core/Invoke-History.md +++ b/reference/6/Microsoft.PowerShell.Core/Invoke-History.md @@ -134,7 +134,7 @@ You can pipe a history ID to this cmdlet. This cmdlet does not generate any output, but output might be generated by the commands that **Invoke-History** runs. ## NOTES -* The session history is a list of the commands entered during the session together with the ID. The session history represents the order of execution, the status, and the start and end times of the command. As you enter each command, Windows PowerShell adds it to the history so that you can reuse it. For more information about the session history, see about_History (http://go.microsoft.com/fwlink/?LinkID=113233). +* The session history is a list of the commands entered during the session together with the ID. The session history represents the order of execution, the status, and the start and end times of the command. As you enter each command, PowerShell adds it to the history so that you can reuse it. For more information about the session history, see about_History (http://go.microsoft.com/fwlink/?LinkID=113233). You can also refer to **Invoke-History** by its built-in aliases, "r" and "ihy". For more information, see about_Aliases (http://go.microsoft.com/fwlink/?LinkID=113207). diff --git a/reference/6/Microsoft.PowerShell.Core/New-ModuleManifest.md b/reference/6/Microsoft.PowerShell.Core/New-ModuleManifest.md index bf0b3d8a1f01..a5f332f8365e 100644 --- a/reference/6/Microsoft.PowerShell.Core/New-ModuleManifest.md +++ b/reference/6/Microsoft.PowerShell.Core/New-ModuleManifest.md @@ -68,11 +68,11 @@ PS C:\> New-ModuleManifest -Path C:\Users\User01\Documents\WindowsPowerShell\Mod # Copyright statement for this moduleCopyright = '(c) 2012 User01. All rights reserved.' # Description of the functionality provided by this module # Description = '' -# Minimum version of the Windows PowerShell engine required by this module +# Minimum version of the PowerShell engine required by this module # PowerShellVersion = '' -# Name of the Windows PowerShell host required by this module +# Name of the PowerShell host required by this module # PowerShellHostName = '' -# Minimum version of the Windows PowerShell host required by this module +# Minimum version of the PowerShell host required by this module # PowerShellHostVersion = '' # Minimum version of the .NET Framework required by this module # DotNetFrameworkVersion = '' @@ -436,7 +436,7 @@ Accept wildcard characters: False ### -FormatsToProcess Specifies the formatting files (.ps1xml) that run when the module is imported. -When you import a module, Windows PowerShell runs the Update-FormatData cmdlet with the specified files. +When you import a module, PowerShell runs the Update-FormatData cmdlet with the specified files. Because formatting files are not scoped, they affect all session states in the session. ```yaml @@ -478,7 +478,7 @@ The GUID can be used to distinguish among modules with the same name. If you omit this parameter, **New-ModuleManifest** creates a **GUID** key in the manifest and generates a GUID for the value. -To create a new GUID in Windows PowerShell, type "\[guid\]::NewGuid()". +To create a new GUID in PowerShell, type "\[guid\]::NewGuid()". ```yaml Type: Guid @@ -656,7 +656,7 @@ Accept wildcard characters: False ``` ### -PowerShellHostName -Specifies the name of the Windows PowerShell host program that the module requires. +Specifies the name of the PowerShell host program that the module requires. Enter the name of the host program, such as `Windows PowerShell ISE Host` or `ConsoleHost`. Wildcard characters are not permitted. @@ -675,7 +675,7 @@ Accept wildcard characters: False ``` ### -PowerShellHostVersion -Specifies the minimum version of the Windows PowerShell host program that works with the module. +Specifies the minimum version of the PowerShell host program that works with the module. Enter a version number, such as 1.1. ```yaml @@ -691,7 +691,7 @@ Accept wildcard characters: False ``` ### -PowerShellVersion -Specifies the minimum version of Windows PowerShell that works with this module. +Specifies the minimum version of PowerShell that works with this module. For example, you can enter 3.0, 4.0, or 5.0 as the value of this parameter. ```yaml @@ -772,7 +772,7 @@ Accept wildcard characters: False ### -RequiredAssemblies Specifies the assembly (.dll) files that the module requires. Enter the assembly file names. -Windows PowerShell loads the specified assemblies before updating types or formats, importing nested modules, or importing the module file that is specified in the value of the **RootModule** key. +PowerShell loads the specified assemblies before updating types or formats, importing nested modules, or importing the module file that is specified in the value of the **RootModule** key. Use this parameter to list all the assemblies that the module requires. This includes assemblies that must be loaded to update any formatting or type files that are listed in the **FormatsToProcess** or **TypesToProcess** keys, even if those assemblies are also listed as binary modules in the **NestedModules** key. @@ -791,7 +791,7 @@ Accept wildcard characters: False ### -RequiredModules Specifies modules that must be in the global session state. -If the required modules are not in the global session state, Windows PowerShell imports them. +If the required modules are not in the global session state, PowerShell imports them. If the required modules are not available, the Import-Module command fails. Enter each module name as a string or as a hash table with **ModuleName** and **ModuleVersion** keys. @@ -875,7 +875,7 @@ Accept wildcard characters: False ### -TypesToProcess Specifies the type files (.ps1xml) that run when the module is imported. -When you import the module, Windows PowerShell runs the Update-TypeData cmdlet with the specified files. +When you import the module, PowerShell runs the Update-TypeData cmdlet with the specified files. Because type files are not scoped, they affect all session states in the session. ```yaml @@ -960,9 +960,9 @@ However, if you use the *PassThru* parameter, it generates a **System.String** o ## NOTES * Module manifests are usually optional. However, a module manifest is required to export an assembly that is installed in the global assembly cache. -* To add or change files in the $pshome\Modules directory (%Windir%\System32\WindowsPowerShell\v1.0\Modules), start Windows PowerShell by using the Run as administrator option. +* To add or change files in the $pshome\Modules directory (%Windir%\System32\WindowsPowerShell\v1.0\Modules), start PowerShell by using the Run as administrator option. * In Windows PowerShell 2.0, many parameters of **New-ModuleManifest** are mandatory, even though they are not required in a module manifest. In Windows PowerShell 3.0, only the *Path* parameter is mandatory. -* A session is an instance of the Windows PowerShell run environment. A session can have one or more session states. By default, a session has only a global session state, but each imported module has its own session state. Session states allow the commands in a module to run without affecting the global session state. +* A session is an instance of the PowerShell run environment. A session can have one or more session states. By default, a session has only a global session state, but each imported module has its own session state. Session states allow the commands in a module to run without affecting the global session state. The caller's session state is the session state into which a module is imported. Typically, it refers to the global session state, but when a module imports nested modules, the caller is the module and the caller's session state is the module's session state. diff --git a/reference/6/Microsoft.PowerShell.Core/New-PSRoleCapabilityFile.md b/reference/6/Microsoft.PowerShell.Core/New-PSRoleCapabilityFile.md index 89dd368aec9b..ce4536b3c6e9 100644 --- a/reference/6/Microsoft.PowerShell.Core/New-PSRoleCapabilityFile.md +++ b/reference/6/Microsoft.PowerShell.Core/New-PSRoleCapabilityFile.md @@ -35,7 +35,7 @@ All the parameters of **New-PSRoleCapabilityFile** are optional except for the * If you do not include a parameter when you run the cmdlet, the corresponding key in the session configuration file will be commented-out, except where noted in the parameter description. For example, if you do not include the *AssembliesToLoad* parameter then that section of the session configuration file will be commented out. -To use the role capability file in a session configuration, first place the file in a **RoleCapabilities** subfolder of a valid Windows PowerShell module folder. +To use the role capability file in a session configuration, first place the file in a **RoleCapabilities** subfolder of a valid PowerShell module folder. Then reference the file by name in the **RoleDefinitions** field in a PowerShell Session Configuration (.pssc) file. This cmdlet was introduced in Windows PowerShell 5.0. @@ -238,7 +238,7 @@ Accept wildcard characters: False ### -Guid Specifies a unique identifier for the role capability file. If you omit this parameter, **New-PSRoleCapabilityFile** generates a GUID for the file. -To create a new GUID in Windows PowerShell, type `\[guid\]::NewGuid()`. +To create a new GUID in PowerShell, type `\[guid\]::NewGuid()`. ```yaml Type: Guid @@ -362,11 +362,11 @@ Accept wildcard characters: False ### -VisibleAliases Limits the aliases in the session to those aliases specified in the value of this parameter, plus any aliases that you define in the *AliasDefinition* parameter. Wildcard characters are supported. -By default, all aliases that are defined by the Windows PowerShell engine and all aliases that modules export are visible in the session. +By default, all aliases that are defined by the PowerShell engine and all aliases that modules export are visible in the session. For example, to limit the available aliases to gm and gcm use this syntax: `VisibleAliases="gcm", "gp"` -When any *Visible* parameter is included in the role capability file, Windows PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. +When any *Visible* parameter is included in the role capability file, PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. ```yaml Type: String[] @@ -388,7 +388,7 @@ By default, all cmdlets that the modules in the session export are visible in th Use the *SessionType* and *ModulesToImport* parameters to determine which modules and snap-ins are imported into the session. If no modules in **ModulesToImport** expose the cmdlet, **New-PSRoleCapabilityFile** will try load the appropriate module. -When any *Visible* parameter is included in the session configuration file, Windows PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. +When any *Visible* parameter is included in the session configuration file, PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. ```yaml Type: Object[] @@ -408,7 +408,7 @@ Wildcard characters are supported. By default, no external commands are visible in this session. -When any *Visible* parameter is included in the session configuration file, Windows PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. +When any *Visible* parameter is included in the session configuration file, PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. ```yaml Type: String[] @@ -429,7 +429,7 @@ Wildcard characters are supported. By default, all functions exported by modules in the session are visible in that session. Use the *SessionType* and *ModulesToImport* parameters to determine which modules are imported into the session. -When any *Visible* parameter is included in the session configuration file, Windows PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. +When any *Visible* parameter is included in the session configuration file, PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. ```yaml Type: Object[] @@ -444,13 +444,13 @@ Accept wildcard characters: False ``` ### -VisibleProviders -Limits the Windows PowerShell providers in the session to those specified in the value of this parameter. +Limits the PowerShell providers in the session to those specified in the value of this parameter. Wildcard characters are supported. By default, all providers exported by a module in the session are visible in the session. Use the *SessionType* and *ModulesToImport* parameters to determine which modules are imported into the session. -When any *Visible* parameter is included in the session configuration file, Windows PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. +When any *Visible* parameter is included in the session configuration file, PowerShell removes the **Import-Module** cmdlet and its ipmo alias from the session. ```yaml Type: String[] diff --git a/reference/6/Microsoft.PowerShell.Core/New-PSSession.md b/reference/6/Microsoft.PowerShell.Core/New-PSSession.md index 365f4141b7e9..488f61ee1f35 100644 --- a/reference/6/Microsoft.PowerShell.Core/New-PSSession.md +++ b/reference/6/Microsoft.PowerShell.Core/New-PSSession.md @@ -68,8 +68,8 @@ New-PSSession [-Name ] -SSHConnection [] [] ## DESCRIPTION The **Out-Default** cmdlet sends output to the default formatter and the default output cmdlet. -This cmdlet has no effect on the formatting or output of Windows PowerShell commands. +This cmdlet has no effect on the formatting or output of PowerShell commands. It is a placeholder that lets you write your own **Out-Default** function or cmdlet. ## EXAMPLES diff --git a/reference/6/Microsoft.PowerShell.Core/Out-Host.md b/reference/6/Microsoft.PowerShell.Core/Out-Host.md index d1b1b1ae8b3a..f6d6e2ba28dd 100644 --- a/reference/6/Microsoft.PowerShell.Core/Out-Host.md +++ b/reference/6/Microsoft.PowerShell.Core/Out-Host.md @@ -20,7 +20,7 @@ Out-Host [-Paging] [-InputObject ] [] ``` ## DESCRIPTION -The **Out-Host** cmdlet sends output to the Windows PowerShell host for display. +The **Out-Host** cmdlet sends output to the PowerShell host for display. The host displays the output at the command line. Because **Out-Host** is the default, you do not have to specify it unless you want to use its parameters to change the display. @@ -97,7 +97,7 @@ However, the host might display the objects that **Out-Host** sends to it. ## NOTES * The cmdlets that contain the **Out** verb (the **Out** cmdlets) do not format objects. They just render objects and send them to the specified display destination. If you send an unformatted object to an **Out** cmdlet, the cmdlet sends it to a formatting cmdlet before rendering it. -* The **Out** cmdlets do not have parameters for names or file paths. To send data to an **Out** cmdlet, use a pipeline operator (|) to send the output of a Windows PowerShell command to the cmdlet. You can also store data in a variable and use the *InputObject* parameter to pass the data to the cmdlet. For help, see the examples. +* The **Out** cmdlets do not have parameters for names or file paths. To send data to an **Out** cmdlet, use a pipeline operator (|) to send the output of a PowerShell command to the cmdlet. You can also store data in a variable and use the *InputObject* parameter to pass the data to the cmdlet. For help, see the examples. * **Out-Host** sends data, but it does not emit any output objects. If you pipe the output of **Out-Host** to the Get-Member cmdlet, **Get-Member** reports that no objects have been specified. * diff --git a/reference/6/Microsoft.PowerShell.Core/Out-Null.md b/reference/6/Microsoft.PowerShell.Core/Out-Null.md index cea1f013d0ac..8522afe24589 100644 --- a/reference/6/Microsoft.PowerShell.Core/Out-Null.md +++ b/reference/6/Microsoft.PowerShell.Core/Out-Null.md @@ -67,7 +67,7 @@ You can pipe any object to this cmdlet. This cmdlet does not generate any output. ## NOTES -* The cmdlets that contain the **Out** verb (the **Out** cmdlets) do not have parameters for names or file paths. To send data to an **Out** cmdlet, use a pipeline operator (|) to send the output of a Windows PowerShell command to the cmdlet. You can also store data in a variable and use the *InputObject* parameter to pass the data to the cmdlet. For more information, see the examples. +* The cmdlets that contain the **Out** verb (the **Out** cmdlets) do not have parameters for names or file paths. To send data to an **Out** cmdlet, use a pipeline operator (|) to send the output of a PowerShell command to the cmdlet. You can also store data in a variable and use the *InputObject* parameter to pass the data to the cmdlet. For more information, see the examples. * **Out-Null** does not return any output objects. If you pipe the output of **Out-Null** to the Get-Member cmdlet, **Get-Member** reports that no objects have been specified. ## RELATED LINKS diff --git a/reference/6/Microsoft.PowerShell.Core/Providers/Environment-Provider.md b/reference/6/Microsoft.PowerShell.Core/Providers/Environment-Provider.md index 0ec94cf8e5fb..f47696935cbb 100644 --- a/reference/6/Microsoft.PowerShell.Core/Providers/Environment-Provider.md +++ b/reference/6/Microsoft.PowerShell.Core/Providers/Environment-Provider.md @@ -28,13 +28,13 @@ online version: https://go.microsoft.com/fwlink/?linkid=834944 ## Detailed description - The Windows PowerShell **Environment** provider lets you get, add, change, clear, and delete Windows environment variables in Windows PowerShell. + The PowerShell **Environment** provider lets you get, add, change, clear, and delete Windows environment variables in PowerShell. The **Environment** provider is a flat namespace that contains only objects that represent the environment variables. The variables have no child items. Each environment variable is an instance of the [System.Collections.DictionaryEntry](https://msdn.microsoft.com/library/system.collections.dictionaryentry) class. The name of the variable is the dictionary key. The value of the environment variable is the dictionary value. - The **Environment** provider exposes its data store in the `Env:` drive. To work with environment variables, change your location to the `Env:` drive (`set-location Env:`), or work from another Windows PowerShell drive. To reference an environment variable from another location, use the `Env:` drive name in the path. + The **Environment** provider exposes its data store in the `Env:` drive. To work with environment variables, change your location to the `Env:` drive (`set-location Env:`), or work from another PowerShell drive. To reference an environment variable from another location, use the `Env:` drive name in the path. The **Environment** provider supports all the cmdlets that contain the *Item* noun except for [Invoke-Item](../../Microsoft.PowerShell.Management/Invoke-Item.md). And, it supports the [Get-Content](../../Microsoft.PowerShell.Management/Get-Content.md) and [Set-Content](../../Microsoft.PowerShell.Management/Set-Content.md) cmdlets. However, it does not support the cmdlets that contain the *ItemProperty* noun, and it does not support the `-Filter` parameter in any cmdlet. @@ -59,7 +59,7 @@ online version: https://go.microsoft.com/fwlink/?linkid=834944 Set-Location Env: ``` - You can use this command from any drive in Windows PowerShell. To return to a file system drive, type the drive name. For example, type: + You can use this command from any drive in PowerShell. To return to a file system drive, type the drive name. For example, type: ```powershell Set-Location c: ``` @@ -76,7 +76,7 @@ Set-Location c: Get-ChildItem -Path Env: ``` - You can use this command from any Windows PowerShell drive. + You can use this command from any PowerShell drive. #### Example 2 @@ -96,7 +96,7 @@ Get-ChildItem -Path Env:windir Get-ChildItem | Sort-Object -Property name ``` - By default, the environment variables appear in the order that Windows PowerShell discovers them. This command is submitted in the `Env:` drive. + By default, the environment variables appear in the order that PowerShell discovers them. This command is submitted in the `Env:` drive. When you run this command from another drive, add the `-Path` parameter with a value of `Env:`. @@ -195,7 +195,7 @@ Copy-Item -Path Env:USERROLE -Destination Env:USERROLE2 Remove-Item -Path Env:USERROLE2 ``` - You can use this command in any Windows PowerShell drive. If you are in the `Env:` drive, you can omit the drive name from the path. + You can use this command in any PowerShell drive. If you are in the `Env:` drive, you can omit the drive name from the path. #### Example 2 diff --git a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider.md b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider.md index 827aa238db13..9145794b4fd2 100644 --- a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider.md +++ b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider.md @@ -28,13 +28,13 @@ Provides access to files and directories. ## Detailed description -The Windows PowerShell **FileSystem** provider lets you get, add, change, clear, and delete files and directories in Windows PowerShell. +The PowerShell **FileSystem** provider lets you get, add, change, clear, and delete files and directories in PowerShell. -The **FileSystem** provider exposes Windows PowerShell drives that correspond to the logical drives on your computer, including drives that are mapped to network shares. This lets you reference these drives from within Windows PowerShell. +The **FileSystem** provider exposes PowerShell drives that correspond to the logical drives on your computer, including drives that are mapped to network shares. This lets you reference these drives from within PowerShell. -The **FileSystem** provider lets you refer to files and folders in Windows PowerShell in the same way that you refer to them in Windows. +The **FileSystem** provider lets you refer to files and folders in PowerShell in the same way that you refer to them in Windows. -To refer to a drive, specify the drive name followed by a colon. Like most of Windows PowerShell, the **FileSystem** provider is not case-sensitive. For example, to get the files and folders on the "C" drive, you refer to the `C:` drive or the `c:` drive. +To refer to a drive, specify the drive name followed by a colon. Like most of PowerShell, the **FileSystem** provider is not case-sensitive. For example, to get the files and folders on the "C" drive, you refer to the `C:` drive or the `c:` drive. A fully qualified name includes the drive name, followed by a colon `:`, any directory and subdirectory names, and the file name (when applicable). Each element of the fully qualified name must be separated either by a backslash `\` or a forward slash `/`. @@ -58,7 +58,7 @@ For example, the current location is the `C:\Windows\System32` directory, then y .\Shell.dll ``` -To use the **FileSystem** provider to view and manage files and folders, use the provider cmdlets, such as [Get-ChildItem](../../Microsoft.PowerShell.Management/Get-ChildItem.md) (`dir`, `ls`) and [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md) (`cd`). Windows PowerShell also includes a `mkdir` function (alias `md`) that uses the [New-Item](../../Microsoft.PowerShell.Management/New-Item.md) cmdlet to create a new directory. +To use the **FileSystem** provider to view and manage files and folders, use the provider cmdlets, such as [Get-ChildItem](../../Microsoft.PowerShell.Management/Get-ChildItem.md) (`dir`, `ls`) and [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md) (`cd`). PowerShell also includes a `mkdir` function (alias `md`) that uses the [New-Item](../../Microsoft.PowerShell.Management/New-Item.md) cmdlet to create a new directory. Beginning in Windows PowerShell 3.0, you can get customized help topics for provider cmdlets that explain how those cmdlets behave in a file system drive. @@ -98,7 +98,7 @@ You can use the `-Delimiter` parameter to specify an alternate delimiter. If you The first command gets the `Employees.txt` file and splits it into sections, each of which ends with the words "End of Employee Record" and it saves it in the `$e` variable. -The second command uses array notation to get the first item in the collection in `$e`. It uses an index of 0, because Windows PowerShell arrays are zero-based. +The second command uses array notation to get the first item in the collection in `$e`. It uses an index of 0, because PowerShell arrays are zero-based. For more information about `Get-Content` cmdlet, see the help topic for the [Get-Content](../../Microsoft.PowerShell.Management/Get-Content.md). @@ -448,7 +448,7 @@ Get-ChildItem -Attributes Compressed,Encrypted ## Dynamic parameters -Dynamic parameters are cmdlet parameters that are added by a Windows PowerShell provider and are available only when the cmdlet is being used in the provider-enabled drive. +Dynamic parameters are cmdlet parameters that are added by a PowerShell provider and are available only when the cmdlet is being used in the provider-enabled drive. ### `Encoding` <[Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding](https://msdn.microsoft.com/library/microsoft.powershell.commands.filesystemcmdletproviderencoding)> diff --git a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-ChildItem-for-FileSystem.md b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-ChildItem-for-FileSystem.md index 551ad14526c1..a4876b1d2695 100644 --- a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-ChildItem-for-FileSystem.md +++ b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-ChildItem-for-FileSystem.md @@ -243,7 +243,7 @@ Description ----------- This command gets all of the .txt files in the current directory and its subdirectories. -The dot (.) represents the current directory. The Include parameter specifies the file name extension. The Recurse parameter directs Windows PowerShell to search for objects recursively, and it indicates that the subject of the command is the specified directory and its contents. The Force parameter adds hidden files to the display. +The dot (.) represents the current directory. The Include parameter specifies the file name extension. The Recurse parameter directs PowerShell to search for objects recursively, and it indicates that the subject of the command is the specified directory and its contents. The Force parameter adds hidden files to the display. ``` diff --git a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-Content-for-FileSystem.md b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-Content-for-FileSystem.md index 98a2d10c61c2..ac3ffc54a4bf 100644 --- a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-Content-for-FileSystem.md +++ b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-Content-for-FileSystem.md @@ -154,7 +154,7 @@ Description ----------- This command gets the content of the Chapter1.txt file and displays it in the console. It uses the Path parameter to specify the name of the item. -Get-Content actually passes the content down the pipeline, but because there are no other cmdlets in the pipeline, Windows PowerShell formats the contents and displays it in the console. +Get-Content actually passes the content down the pipeline, but because there are no other cmdlets in the pipeline, PowerShell formats the contents and displays it in the console. ``` diff --git a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-Item-for-FileSystem.md b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-Item-for-FileSystem.md index 0ca81fa85423..d8d8217e74cf 100644 --- a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-Item-for-FileSystem.md +++ b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Get-Item-for-FileSystem.md @@ -143,7 +143,7 @@ Description ----------- This command gets the items in the C: drive. The wildcard character (*) represents all the items in the container, not just the container. -In Windows PowerShell, use a single asterisk (*) to get contents, instead of the traditional "*.*". The format is interpreted literally, so "*.*" would not retrieve directories or file names without a dot. +In PowerShell, use a single asterisk (*) to get contents, instead of the traditional "*.*". The format is interpreted literally, so "*.*" would not retrieve directories or file names without a dot. ``` diff --git a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Test-Path-for-FileSystem.md b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Test-Path-for-FileSystem.md index d78df2d26922..6bf537a57e86 100644 --- a/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Test-Path-for-FileSystem.md +++ b/reference/6/Microsoft.PowerShell.Core/Providers/FileSystem-Provider/Test-Path-for-FileSystem.md @@ -81,7 +81,7 @@ C:\PS>Test-Path -Path $profile -IsValid Description ----------- -These commands test the path to the Windows PowerShell profile. +These commands test the path to the PowerShell profile. The first command determines whether all elements in the path exist. The second command determines whether the syntax of the path is correct. In this case, the path is FALSE, but the syntax is correct (TRUE). These commands use $profile, the automatic variable that points to the location for the profile, even if the profile does not exist. @@ -113,7 +113,7 @@ C:\PS>Test-Path -Path $profile -PathType Leaf Description ----------- -This command tells whether the path stored in the $profile variable leads to a file. In this case, because the Windows PowerShell profile is a .ps1 file, the cmdlet returns TRUE. +This command tells whether the path stored in the $profile variable leads to a file. In this case, because the PowerShell profile is a .ps1 file, the cmdlet returns TRUE. ``` @@ -129,11 +129,11 @@ FALSE Description ----------- -These commands use the Test-Path cmdlet with the Windows PowerShell registry provider. +These commands use the Test-Path cmdlet with the PowerShell registry provider. -The first command tests whether the registry path to the Microsoft.PowerShell registry key is correct on the system. If Windows PowerShell is installed correctly, the cmdlet returns TRUE. +The first command tests whether the registry path to the Microsoft.PowerShell registry key is correct on the system. If PowerShell is installed correctly, the cmdlet returns TRUE. -Test-Path does not work correctly with all Windows PowerShell providers. For example, you can use Test-Path to test the path to a registry key, but if you use it to test the path to a registry entry, it always returns FALSE, even if the registry entry is present. +Test-Path does not work correctly with all PowerShell providers. For example, you can use Test-Path to test the path to a registry key, but if you use it to test the path to a registry entry, it always returns FALSE, even if the registry entry is present. ``` diff --git a/reference/6/Microsoft.PowerShell.Core/Providers/Function-Provider.md b/reference/6/Microsoft.PowerShell.Core/Providers/Function-Provider.md index c0898f7760cb..41f3e7b0068e 100644 --- a/reference/6/Microsoft.PowerShell.Core/Providers/Function-Provider.md +++ b/reference/6/Microsoft.PowerShell.Core/Providers/Function-Provider.md @@ -23,12 +23,12 @@ online version: http://go.microsoft.com/fwlink/?LinkId=834961 ## Short description - Provides access to the functions defined in Windows PowerShell. + Provides access to the functions defined in PowerShell. ## Detailed description - The Windows PowerShell **Function** provider lets you get, add, change, clear, and delete the functions and filters in Windows PowerShell. + The PowerShell **Function** provider lets you get, add, change, clear, and delete the functions and filters in PowerShell. A function is a named block of code that performs an action. When you type the function name, the code in the function runs. A filter is a named block of code that establishes conditions for an action. You can type the name of the filter in place of the condition, such as in a [Where-Object](../Where-Object.md) command. @@ -40,7 +40,7 @@ online version: http://go.microsoft.com/fwlink/?LinkId=834961 The examples in this section show how to manage functions, but the same methods can be used with filters. - The **Function** provider exposes its data store in the `Function:` drive. To work with functions, you can change your location to the `Function:` drive (`set-location Function:`). Or, you can work from another Windows PowerShell drive. To reference a function from another location, use the drive name (`Function:`) in the path. + The **Function** provider exposes its data store in the `Function:` drive. To work with functions, you can change your location to the `Function:` drive (`set-location Function:`). Or, you can work from another PowerShell drive. To reference a function from another location, use the drive name (`Function:`) in the path. The **Function** provider supports all of the cmdlets whose names contain the *Item* noun (the `*-Item` cmdlets), except for [Invoke-Item](../../Microsoft.PowerShell.Management/Invoke-Item.md). And, it supports the [Get-Content](../../Microsoft.PowerShell.Management/Get-Content.md) and [Set-Content](../../Microsoft.PowerShell.Management/Set-Content.md) cmdlets. However, it does not support the cmdlets whose names contain the *ItemProperty* noun (the `*-ItemProperty` cmdlets), and it does not support the `-Filter` parameter in any cmdlet. @@ -58,7 +58,7 @@ online version: http://go.microsoft.com/fwlink/?LinkId=834961 #### Example 1 - Changes the current location to the `Function:` drive. You can use this command from any drive in Windows PowerShell. To return to a file system drive, type the drive name. For example, type `set-location c:`. + Changes the current location to the `Function:` drive. You can use this command from any drive in PowerShell. To return to a file system drive, type the drive name. For example, type `set-location c:`. ```powershell Set-Location Function: @@ -70,7 +70,7 @@ Set-Location Function: #### Example 1 - This command gets the list of all the functions in the current session. You can use this command from any Windows PowerShell drive. + This command gets the list of all the functions in the current session. You can use this command from any PowerShell drive. ```powershell Get-ChildItem -Path Function: @@ -113,7 +113,7 @@ PS Function> Get-Item -Path .\c: New-Item -Path Function:HKLM: -Value {Set-Location HKLM:} ``` - You can also create a function by typing it at the Windows PowerShell command line. For example, tpe `Function:HKLM: {set-location HKLM:}`. If you are in the `Function:` drive, you can omit the drive name. + You can also create a function by typing it at the PowerShell command line. For example, tpe `Function:HKLM: {set-location HKLM:}`. If you are in the `Function:` drive, you can omit the drive name. Because you cannot specify the "Filter" label in [New-Item](../../Microsoft.PowerShell.Management/New-Item.md), filters are labeled as functions, but they operate properly with any label. To create a filter with the "Filter" label, type the filter at the command line. For example, type `filter:Running {$_.Status -eq "Running"}`. @@ -225,7 +225,7 @@ Copy-Item -Path Function:prompt -Destination Function:oldPrompt ## Dynamic parameters - Dynamic parameters are cmdlet parameters that are added by a Windows PowerShell provider and are available only when the cmdlet is being used in the provider-enabled drive. + Dynamic parameters are cmdlet parameters that are added by a PowerShell provider and are available only when the cmdlet is being used in the provider-enabled drive. ### `Options` <[System.Management.Automation.ScopedItemOptions](https://msdn.microsoft.com/library/system.management.automation.scopeditemoptions)> diff --git a/reference/6/Microsoft.PowerShell.Core/Providers/Registry-Provider.md b/reference/6/Microsoft.PowerShell.Core/Providers/Registry-Provider.md index 22678fc6cec3..0504ad3f83cd 100644 --- a/reference/6/Microsoft.PowerShell.Core/Providers/Registry-Provider.md +++ b/reference/6/Microsoft.PowerShell.Core/Providers/Registry-Provider.md @@ -23,12 +23,12 @@ online version: http://go.microsoft.com/fwlink/?LinkId=821468 ## Short description - Provides access to the registry keys, entries, and values in Windows PowerShell. + Provides access to the registry keys, entries, and values in PowerShell. ## Detailed description - The Windows PowerShell **Registry** provider lets you get, add, change, clear, and delete registry keys, entries, and values in Windows PowerShell. + The PowerShell **Registry** provider lets you get, add, change, clear, and delete registry keys, entries, and values in PowerShell. Registry keys are represented as instances of the [Microsoft.Win32.RegistryKey](https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.registrykey) class. Registry entries are represented as instances of the [PSCustomObject](https://msdn.microsoft.com/library/system.management.automation.pscustomobject) class. @@ -254,7 +254,7 @@ Set-Item -Path hkcu:\environment\testnew -Value "another default value" ## Dynamic parameters - Dynamic parameters are cmdlet parameters that are added by a Windows PowerShell provider and are available only when the cmdlet is being used in the provider-enabled drive. + Dynamic parameters are cmdlet parameters that are added by a PowerShell provider and are available only when the cmdlet is being used in the provider-enabled drive. ### `Type` <[Microsoft.Win32.RegistryValueKind](https://msdn.microsoft.com/library/microsoft.win32.registryvaluekind)> diff --git a/reference/6/Microsoft.PowerShell.Core/Providers/Variable-Provider.md b/reference/6/Microsoft.PowerShell.Core/Providers/Variable-Provider.md index cfb2d46e649e..aed6607db0b1 100644 --- a/reference/6/Microsoft.PowerShell.Core/Providers/Variable-Provider.md +++ b/reference/6/Microsoft.PowerShell.Core/Providers/Variable-Provider.md @@ -23,22 +23,22 @@ online version: http://go.microsoft.com/fwlink/?LinkId=834963 ## Short description - Provides access to the Windows PowerShell variables and to their values. + Provides access to the PowerShell variables and to their values. ## Detailed description - The Windows PowerShell **Variable** provider lets you get, add, change, clear, and delete Windows PowerShell variables in the current console. + The PowerShell **Variable** provider lets you get, add, change, clear, and delete PowerShell variables in the current console. - The Windows PowerShell **Variable** provider supports the variables that Windows PowerShell creates, including the automatic variables, the preference variables, and the variables that you create. + The PowerShell **Variable** provider supports the variables that PowerShell creates, including the automatic variables, the preference variables, and the variables that you create. The **Variable** provider is a flat namespace that contains only the variable objects. The variables have no child items. Most of the variables are instances of the [System.Management.Automation.PSVariable](https://msdn.microsoft.com/library/system.management.automation.psvariable) class. However, there are some variations. For example, the `?` variable is a member of the `QuestionMarkVariable` internal class, and the `MaximumVariableCount` variable is a member of the `SessionStateCapacityVariable` internal class. - The **Variable** provider exposes its data store in the `Variable:` drive. To work with variables, you can change your location to the `Variable:` drive (`set-location Variable:`), or you can work from any other Windows PowerShell drive. To reference a variable from another location, use the drive name (`Variable:`) in the path. + The **Variable** provider exposes its data store in the `Variable:` drive. To work with variables, you can change your location to the `Variable:` drive (`set-location Variable:`), or you can work from any other PowerShell drive. To reference a variable from another location, use the drive name (`Variable:`) in the path. - Windows PowerShell includes a set of cmdlets designed especially to view and to change variables: + PowerShell includes a set of cmdlets designed especially to view and to change variables: - [Get-Variable](../../Microsoft.PowerShell.Utility/Get-Variable.md) - [New-Variable](../../Microsoft.PowerShell.Utility/New-Variable.md) @@ -50,7 +50,7 @@ online version: http://go.microsoft.com/fwlink/?LinkId=834963 The **Variable** provider supports all of the cmdlets whose names contain the *Item* noun (the `*-Item` cmdlets), except for [Invoke-Item](../../Microsoft.PowerShell.Management/Invoke-Item.md). The **Variable** provider supports the [Get-Content](../../Microsoft.PowerShell.Management/Get-Content.md) and [Set-Content](../../Microsoft.PowerShell.Management/Set-Content.md) cmdlets. However, it does not support the cmdlets whose names contain the *ItemProperty* noun (the `*-ItemProperty` cmdlets), and it does not support the `-Filter` parameter in any cmdlet. - You can also use the Windows PowerShell expression parser to create, view, and change the values of variables without using the cmdlets. When working with variables directly, use a dollar sign (`$`) to identify the name as a variable and the assignment operator (`=`) to establish and change its value. For example, `$p = Get-Process` creates the `p` variable and stores the results of a `Get-Process` command in it. + You can also use the PowerShell expression parser to create, view, and change the values of variables without using the cmdlets. When working with variables directly, use a dollar sign (`$`) to identify the name as a variable and the assignment operator (`=`) to establish and change its value. For example, `$p = Get-Process` creates the `p` variable and stores the results of a `Get-Process` command in it. ## Capabilities @@ -66,7 +66,7 @@ online version: http://go.microsoft.com/fwlink/?LinkId=834963 #### Example 1 - This command changes the current location to the `Variable:` drive. You can use this command from any drive in Windows PowerShell. To return to a file system drive, type the drive name. For example, type `set-location c:`. + This command changes the current location to the `Variable:` drive. You can use this command from any drive in PowerShell. To return to a file system drive, type the drive name. For example, type `set-location c:`. ```powershell Set-Location Variable: @@ -78,7 +78,7 @@ Set-Location Variable: #### Example 1 - This command gets the list of all the variables and their values in the current session. You can use this command from any Windows PowerShell drive. + This command gets the list of all the variables and their values in the current session. You can use this command from any PowerShell drive. ```powershell Get-ChildItem -Path Variable: @@ -87,7 +87,7 @@ Get-ChildItem -Path Variable: #### Example 2 - This command gets the variables with names that begin with "max". You can use this command from any Windows PowerShell drive. + This command gets the variables with names that begin with "max". You can use this command from any PowerShell drive. ```powershell Get-ChildItem -Path Variable:max* @@ -240,7 +240,7 @@ $old_processes = $processes #### Example 1 - This command deletes the `serv` variable from the current session. You can use this command in any Windows PowerShell drive. + This command deletes the `serv` variable from the current session. You can use this command in any PowerShell drive. ```powershell Remove-Variable -Path Variable:serv diff --git a/reference/6/Microsoft.PowerShell.Core/Receive-Job.md b/reference/6/Microsoft.PowerShell.Core/Receive-Job.md index 1f5b6cf2256d..d548b8982ba6 100644 --- a/reference/6/Microsoft.PowerShell.Core/Receive-Job.md +++ b/reference/6/Microsoft.PowerShell.Core/Receive-Job.md @@ -11,7 +11,7 @@ title: Receive-Job # Receive-Job ## SYNOPSIS -Gets the results of the Windows PowerShell background jobs in the current session. +Gets the results of the PowerShell background jobs in the current session. ## SYNTAX @@ -52,14 +52,14 @@ Receive-Job [-Keep] [-NoRecurse] [-Force] [-Wait] [-AutoRemoveJob] [-WriteEvents ``` ## DESCRIPTION -The **Receive-Job** cmdlet gets the results of Windows PowerShell background jobs, such as those started by using the Start-Job cmdlet or the *AsJob* parameter of any cmdlet. +The **Receive-Job** cmdlet gets the results of PowerShell background jobs, such as those started by using the Start-Job cmdlet or the *AsJob* parameter of any cmdlet. You can get the results of all jobs or identify jobs by their name, ID, instance ID, computer name, location, or session, or by submitting a job object. -When you start a Windows PowerShell background job, the job starts, but the results do not appear immediately. +When you start a PowerShell background job, the job starts, but the results do not appear immediately. Instead, the command returns an object that represents the background job. The job object contains useful information about the job, but it does not contain the results. This method lets you continue to work in the session while the job runs. -For more information about background jobs in Windows PowerShell, see about_Jobs. +For more information about background jobs in PowerShell, see about_Jobs. The **Receive-Job** cmdlet gets the results that have been generated by the time that the **Receive-Job** command is submitted. If the results are not yet complete, you can run additional **Receive-Job** commands to get the remaining results. @@ -98,7 +98,7 @@ As a result, the command does not need a *Job* parameter to specify the job. ### Example 3: Get results of several background jobs ``` -The first command uses the Invoke-Command cmdlet to start a background job that runs a Get-Service command on three remote computers. The command uses the *AsJob* parameter to run the command as a background job. The command saves the resulting job object in the $j variable.When you use the *AsJob* parameter of **Invoke-Command** to start a job, the job object is created on the local computer, even though the job runs on the remote computers. As a result, you use local commands to manage the job.Also, when you use *AsJob*, Windows PowerShell returns one job object that contains a child job for each job that was started. In this case, the job object contains three child jobs, one for each job on each remote computer. +The first command uses the Invoke-Command cmdlet to start a background job that runs a Get-Service command on three remote computers. The command uses the *AsJob* parameter to run the command as a background job. The command saves the resulting job object in the $j variable.When you use the *AsJob* parameter of **Invoke-Command** to start a job, the job object is created on the local computer, even though the job runs on the remote computers. As a result, you use local commands to manage the job.Also, when you use *AsJob*, PowerShell returns one job object that contains a child job for each job that was started. In this case, the job object contains three child jobs, one for each job on each remote computer. PS C:\> $j = Invoke-Command -ComputerName Server01, Server02, Server03 -ScriptBlock {Get-Service} -AsJob @@ -348,7 +348,7 @@ Accept wildcard characters: False ### -Session Specifies an array of sessions. -This cmdlet gets the results of jobs that were run in the specified Windows PowerShell session (**PSSession**). +This cmdlet gets the results of jobs that were run in the specified PowerShell session (**PSSession**). Enter a variable that contains the **PSSession** or a command that gets the **PSSession**, such as a Get-PSSession command. The default is all jobs in the current session. diff --git a/reference/6/Microsoft.PowerShell.Core/Receive-PSSession.md b/reference/6/Microsoft.PowerShell.Core/Receive-PSSession.md index ab77eafa381f..38f2bc4faab7 100644 --- a/reference/6/Microsoft.PowerShell.Core/Receive-PSSession.md +++ b/reference/6/Microsoft.PowerShell.Core/Receive-PSSession.md @@ -72,7 +72,7 @@ Receive-PSSession -Name [-OutTarget ] [-JobName ] [- ``` ## DESCRIPTION -The **Receive-PSSession** cmdlet gets the results of commands running in Windows PowerShell sessions (**PSSession**) that were disconnected. +The **Receive-PSSession** cmdlet gets the results of commands running in PowerShell sessions (**PSSession**) that were disconnected. If the session is currently connected, **Receive-PSSession** gets the results of commands that were running when the session was disconnected. If the session is still disconnected, **Receive-PSSession** connects to the session, resumes any commands that were suspended, and gets the results of commands running in the session. @@ -144,7 +144,7 @@ PS C:\> Invoke-Command -Session $s -FilePath \\Server12\Scripts\SharedScripts\Ne # Restart local computer # Network access is not re-established within 4 minutes -When the computer restarts, the user starts Windows PowerShell and runs a Get-PSSession command to get sessions on the Server01 computer. The output shows that the AD session still exists on the Server01 computer. The **State** indicates that it is disconnected and the **Availability** value, None, indicates that it is not connected to any client sessions. +When the computer restarts, the user starts PowerShell and runs a Get-PSSession command to get sessions on the Server01 computer. The output shows that the AD session still exists on the Server01 computer. The **State** indicates that it is disconnected and the **Availability** value, None, indicates that it is not connected to any client sessions. PS C:\> Get-PSSession -ComputerName Server01 Id Name ComputerName State ConfigurationName Availability @@ -168,16 +168,16 @@ Id Name ComputerName State ConfigurationName Availability ``` This example uses the **Receive-PSSession** cmdlet to get the results of a job after a network outage disrupts a session connection. -Windows PowerShell automatically attempts to reconnect the session one time each second for the next four minutes and abandons the effort only if all attempts in the four-minute interval fail. +PowerShell automatically attempts to reconnect the session one time each second for the next four minutes and abandons the effort only if all attempts in the four-minute interval fail. ### Example 5: Reconnect to disconnected sessions ``` -The first command uses the Invoke-Command cmdlet to run a script on the three remote computers. Because the scripts gathers and summarize data from multiple databases, it often takes the script an extended time to finish. The command uses the *InDisconnectedSession* parameter, which starts the scripts and then immediately disconnects the sessions.The command uses the *SessionOption* parameter to extend the **IdleTimeout** value of the disconnected session. Disconnected sessions are considered to be idle from the moment they are disconnected, so it is important to set the idle time-out for long enough that the commands can complete and you can reconnect to the session, if necessary. You can set the **IdleTimeout** only when you create the **PSSession** and change it only when you disconnect from it. You cannot change the **IdleTimeout** value when you connect to a **PSSession** or receiving its results.After running the command, the user exits Windows PowerShell and closes the computer . +The first command uses the Invoke-Command cmdlet to run a script on the three remote computers. Because the scripts gathers and summarize data from multiple databases, it often takes the script an extended time to finish. The command uses the *InDisconnectedSession* parameter, which starts the scripts and then immediately disconnects the sessions.The command uses the *SessionOption* parameter to extend the **IdleTimeout** value of the disconnected session. Disconnected sessions are considered to be idle from the moment they are disconnected, so it is important to set the idle time-out for long enough that the commands can complete and you can reconnect to the session, if necessary. You can set the **IdleTimeout** only when you create the **PSSession** and change it only when you disconnect from it. You cannot change the **IdleTimeout** value when you connect to a **PSSession** or receiving its results.After running the command, the user exits PowerShell and closes the computer . PS C:\> Invoke-Command -InDisconnectedSession -ComputerName Server01, Server02, Server30 -FilePath \\Server12\Scripts\SharedScripts\Get-BugStatus.ps1 -Name BugStatus -SessionOption @{IdleTimeout = 86400000} -ConfigurationName ITTasks# Exit -# Start Windows PowerShell on a different computer. +# Start PowerShell on a different computer. -On the next day, the user resumes Windows and starts Windows PowerShell. The second command uses the Get-PSSession cmdlet to get the sessions in which the scripts were running. The command identifies the sessions by the computer name, session name, and the name of the session configuration and saves the sessions in the $s variable.The third command displays the value of the $s variable. The output shows that the sessions are disconnected, but not busy, as expected. +On the next day, the user resumes Windows and starts PowerShell. The second command uses the Get-PSSession cmdlet to get the sessions in which the scripts were running. The command identifies the sessions by the computer name, session name, and the name of the session configuration and saves the sessions in the $s variable.The third command displays the value of the $s variable. The output shows that the sessions are disconnected, but not busy, as expected. PS C:\> $s = Get-PSSession -ComputerName Server01, Server02, Server30 -Name BugStatus PS C:\> $s Id Name ComputerName State ConfigurationName Availability @@ -256,7 +256,7 @@ This example shows what happens to a job that is running in a disconnected sessi Indicates that this cmdlet allows redirection of this connection to an alternate Uniform Resource Identifier (URI). When you use the *ConnectionURI* parameter, the remote destination can return an instruction to redirect to a different URI. -By default, Windows PowerShell does not redirect connections, but you can use this parameter to enable it to redirect the connection. +By default, PowerShell does not redirect connections, but you can use this parameter to enable it to redirect the connection. You can also limit the number of times the connection is redirected by changing the **MaximumConnectionRedirectionCount** session option value. Use the *MaximumRedirection* parameter of the New-PSSessionOption cmdlet or set the **MaximumConnectionRedirectionCount** property of the $PSSessionOption preference variable. @@ -338,7 +338,7 @@ Certificates are used in client certificate-based authentication. They can be mapped only to local user accounts. They do not work with domain accounts. -To get a certificate thumbprint, use a Get-Item or Get-ChildItem command in the Windows PowerShell Cert: drive. +To get a certificate thumbprint, use a Get-Item or Get-ChildItem command in the PowerShell Cert: drive. ```yaml Type: String @@ -433,7 +433,7 @@ Valid values for the Transport segment of the URI are HTTP and HTTPS. If you specify a connection URI with a Transport segment, but do not specify a port, the session is created with standards ports: 80 for HTTP and 443 for HTTPS. To use the default ports for Windows PowerShell remoting, specify port 5985 for HTTP or 5986 for HTTPS. -If the destination computer redirects the connection to a different URI, Windows PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. +If the destination computer redirects the connection to a different URI, PowerShell prevents the redirection unless you use the *AllowRedirection* parameter in the command. ```yaml Type: Uri @@ -521,9 +521,9 @@ Specifies a friendly name for the job that **Receive-PSSession** returns. **Receive-PSSession** returns a job when the value of the *OutTarget* parameter is Job or the job that is running in the disconnected session was started in the current session. -If the job that is running in the disconnected session was started in the current session, Windows PowerShell reuses the original job object in the session and ignores the value of the *JobName* parameter. +If the job that is running in the disconnected session was started in the current session, PowerShell reuses the original job object in the session and ignores the value of the *JobName* parameter. -If the job that is running in the disconnected session was started in a different session, Windows PowerShell creates a new job object. +If the job that is running in the disconnected session was started in a different session, PowerShell creates a new job object. It uses a default name, but you can use this parameter to change the name. If the default value or explicit value of the *OutTarget* parameter is not Job, the command succeeds, but the *JobName* parameter has no effect. @@ -604,7 +604,7 @@ To connect to a remote computer, the remote computer must be listening on the po The default ports are 5985, which is the WinRM port for HTTP, and 5986, which is the WinRM port for HTTPS. Before using an alternate port, you must configure the WinRM listener on the remote computer to listen at that port. -To configure the listener, type the following two commands at the Windows PowerShell prompt: +To configure the listener, type the following two commands at the PowerShell prompt: `Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse` @@ -672,7 +672,7 @@ Accept wildcard characters: False Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to connect to the disconnected session. By default, SSL is not used. -WS-Management encrypts all Windows PowerShell content transmitted over the network. +WS-Management encrypts all PowerShell content transmitted over the network. *UseSSL* is an additional protection that sends the data across an HTTPS connection instead of an HTTP connection. If you use this parameter, but SSL is not available on the port that is used for the command, the command fails. @@ -755,7 +755,7 @@ In this case, the job object is created in the remote session. You cannot use the **Receive-PSSession** cmdlet to get the job results. Instead, use the **Connect-PSSession** cmdlet to connect to the session and then use the **Invoke-Command** cmdlet to run a Receive-Job command in the session. -* When a session that contains a running job is disconnected and then reconnected, the original job object is reused only if the job is disconnected and reconnected to the same session, and the command to reconnect does not specify a new job name. If the session is reconnected to a different client session or a new job name is specified, Windows PowerShell creates a new job object for the new session. +* When a session that contains a running job is disconnected and then reconnected, the original job object is reused only if the job is disconnected and reconnected to the same session, and the command to reconnect does not specify a new job name. If the session is reconnected to a different client session or a new job name is specified, PowerShell creates a new job object for the new session. * When you disconnect a **PSSession**, the session state is Disconnected and the availability is None. The value of the **State** property is relative to the current session. diff --git a/reference/6/Microsoft.PowerShell.Core/Register-ArgumentCompleter.md b/reference/6/Microsoft.PowerShell.Core/Register-ArgumentCompleter.md index 5492628db6ad..02e2af4a8ff6 100644 --- a/reference/6/Microsoft.PowerShell.Core/Register-ArgumentCompleter.md +++ b/reference/6/Microsoft.PowerShell.Core/Register-ArgumentCompleter.md @@ -87,7 +87,7 @@ Accept wildcard characters: False ``` ### -Native -Indicates that the argument completer is for a native command where Windows PowerShell cannot complete parameter names. +Indicates that the argument completer is for a native command where PowerShell cannot complete parameter names. ```yaml Type: SwitchParameter diff --git a/reference/6/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md b/reference/6/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md index 77e2193ab2fc..d75096740c2b 100644 --- a/reference/6/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md +++ b/reference/6/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md @@ -53,8 +53,8 @@ Register-PSSessionConfiguration [-ProcessorArchitecture ] [-Name] dir WSMan:\LocalHost\Plugin Name Type Keys ---- ---- ---- @@ -160,7 +160,7 @@ PS C:\> Register-PSSessionConfiguration -Name WithProfile -StartupScript Add-Pro ``` This command creates and registers the WithProfile session configuration on the local computer. -The command uses the *StartupScript* parameter to direct Windows PowerShell to run the specified script in any session that uses the session configuration. +The command uses the *StartupScript* parameter to direct PowerShell to run the specified script in any session that uses the session configuration. The content of the specified script, Add-Profile.ps1, is also displayed. The script contains a single command that uses dot sourcing to run the user's **CurrentUserAllHosts** profile in the current scope of the session. @@ -198,7 +198,7 @@ Before The commands in this example compare a no-language session to a restricted-language session. The example shows the effect of using the *LanguageMode* parameter of **New-PSSessionConfigurationFile** to limit the types of commands and statements that users can run in a session that uses a custom session configuration. -To run the commands in this example, start Windows PowerShell by using the Run as administrator option. +To run the commands in this example, start PowerShell by using the Run as administrator option. This option is required to run the Register-PSSessionConfiguration cmdlet. ## PARAMETERS @@ -424,7 +424,7 @@ Accept wildcard characters: False ``` ### -PSVersion -Specifies the version of Windows PowerShell in sessions that use this session configuration. +Specifies the version of PowerShell in sessions that use this session configuration. The value of this parameter takes precedence over the value of the **PowerShellVersion** key in the session configuration file. @@ -461,7 +461,7 @@ Accept wildcard characters: False ``` ### -ProcessorArchitecture -Determines whether a 32-bit or 64-bit version of the Windows PowerShell process is started in sessions that use this session configuration. +Determines whether a 32-bit or 64-bit version of the PowerShell process is started in sessions that use this session configuration. The acceptable values for this parameter are: x86 (32-bit) and AMD64 (64-bit). The default value is determined by the processor architecture of the computer that hosts the session configuration. @@ -601,7 +601,7 @@ Accept wildcard characters: False ``` ### -StartupScript -Specifies the fully qualified path of a Windows PowerShell script. +Specifies the fully qualified path of a PowerShell script. The specified script runs in the new session that uses the session configuration. You can use the script to additionally configure the session. @@ -727,7 +727,7 @@ You cannot pipe input to this cmdlet. ### Microsoft.WSMan.Management.WSManConfigContainerElement ## NOTES -* To run this cmdlet on Windows Vista, Windows Server 2008, and later versions of the Windows operating system, start Windows PowerShell by using the Run as administrator option. +* To run this cmdlet on Windows Vista, Windows Server 2008, and later versions of the Windows operating system, start PowerShell by using the Run as administrator option. * This cmdlet generates XML that represents a Web Services for Management (WS-Management) plug-in configuration and sends the XML to WS-Management, which registers the plug-in on the local computer (`New-Item wsman:\localhost\plugin`). * The properties of a session configuration object vary with the options set for the session configuration and the values of those options. Also, session configurations that use a session configuration file have additional properties. diff --git a/reference/6/Microsoft.PowerShell.Core/Remove-Job.md b/reference/6/Microsoft.PowerShell.Core/Remove-Job.md index 5353cfb4fd5c..20e78f4999c0 100644 --- a/reference/6/Microsoft.PowerShell.Core/Remove-Job.md +++ b/reference/6/Microsoft.PowerShell.Core/Remove-Job.md @@ -11,7 +11,7 @@ title: Remove-Job # Remove-Job ## SYNOPSIS -Deletes a Windows PowerShell background job. +Deletes a PowerShell background job. ## SYNTAX @@ -51,7 +51,7 @@ Remove-Job [-Command ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Remove-Job** cmdlet deletes Windows PowerShell background jobs. +The **Remove-Job** cmdlet deletes PowerShell background jobs. You can start jobs by using the Start-Job or the *AsJob* parameter of any cmdlet. You can use this cmdlet to delete all jobs or delete jobs based on their name, ID, instance ID, command, or state, or by passing a job object to **Remove-Job**. @@ -166,7 +166,7 @@ Debug : {} Warning : {} StateChanged : -The third command uses a **Remove-Job** command to remove the job from the current session. To generate the command, you can copy and paste the *InstanceID* value from the object display.To copy a value in the Windows PowerShell console, use the mouse to select the value, and then press Enter to copy it. To paste a value, right-click. +The third command uses a **Remove-Job** command to remove the job from the current session. To generate the command, you can copy and paste the *InstanceID* value from the object display.To copy a value in the PowerShell console, use the mouse to select the value, and then press Enter to copy it. To paste a value, right-click. PS C:\> Remove-Job -InstanceID dce2ee73-f8c9-483e-bdd7-a549d8687eed ``` diff --git a/reference/6/Microsoft.PowerShell.Core/Remove-Module.md b/reference/6/Microsoft.PowerShell.Core/Remove-Module.md index a681b6d31257..f91b4c35f951 100644 --- a/reference/6/Microsoft.PowerShell.Core/Remove-Module.md +++ b/reference/6/Microsoft.PowerShell.Core/Remove-Module.md @@ -36,7 +36,7 @@ The **Remove-Module** cmdlet removes the members of a module, such as cmdlets an If the module includes an assembly (.dll), all members that are implemented by the assembly are removed, but the assembly is not unloaded. This cmdlet does not uninstall the module or delete it from the computer. -It affects only the current Windows PowerShell session. +It affects only the current PowerShell session. ## EXAMPLES diff --git a/reference/6/Microsoft.PowerShell.Core/Remove-PSSession.md b/reference/6/Microsoft.PowerShell.Core/Remove-PSSession.md index 6fe203a72e45..1fbc6509a869 100644 --- a/reference/6/Microsoft.PowerShell.Core/Remove-PSSession.md +++ b/reference/6/Microsoft.PowerShell.Core/Remove-PSSession.md @@ -11,7 +11,7 @@ title: Remove-PSSession # Remove-PSSession ## SYNOPSIS -Closes one or more Windows PowerShell sessions (PSSessions). +Closes one or more PowerShell sessions (PSSessions). ## SYNTAX @@ -56,7 +56,7 @@ Remove-PSSession [-ComputerName] [-WhatIf] [-Confirm] [ Function EndPSS { Get-PSSession | Remove-PSSession } ``` This function deletes all of the **PSSessions** in the current session. -After you add this function to your Windows PowerShell profile, to delete all sessions, type `EndPSS`. +After you add this function to your PowerShell profile, to delete all sessions, type `EndPSS`. ## PARAMETERS diff --git a/reference/6/Microsoft.PowerShell.Core/Save-Help.md b/reference/6/Microsoft.PowerShell.Core/Save-Help.md index fccb75554237..81e45b83f0c6 100644 --- a/reference/6/Microsoft.PowerShell.Core/Save-Help.md +++ b/reference/6/Microsoft.PowerShell.Core/Save-Help.md @@ -30,13 +30,13 @@ Save-Help -LiteralPath [[-Module] ] [-FullyQualifiedM ``` ## DESCRIPTION -The **Save-Help** cmdlet downloads the newest help files for Windows PowerShell modules and saves them to a directory that you specify. +The **Save-Help** cmdlet downloads the newest help files for PowerShell modules and saves them to a directory that you specify. This feature lets you update the help files on computers that do not have access to the Internet, and makes it easier to update the help files on multiple computers. In Windows PowerShell 3.0, **Save-Help** worked only for modules that are installed on the local computer. Although it was possible to import a module from a remote computer, or obtain a reference to a **PSModuleInfo** object from a remote computer by using Windows PowerShell remoting, the **HelpInfoUri** property was not preserved, and **Save-Help** would not work for remote module Help. -In Windows PowerShell 4.0, the **HelpInfoUri** property is preserved over Windows PowerShell remoting, which enables **Save-Help** to work for modules that are installed on remote computers. +In Windows PowerShell 4.0, the **HelpInfoUri** property is preserved over PowerShell remoting, which enables **Save-Help** to work for modules that are installed on remote computers. It is also possible to save a **PSModuleInfo** object to disk or removable media by running Export-Clixml on a computer that does not have Internet access, import the object on a computer that does have Internet access, and then run **Save-Help** on the **PSModuleInfo** object. The saved help can be transported to the remote computer by using removable storage media, such as a USB drive. The help can be installed on the remote computer by running **Update-Help**. @@ -56,7 +56,7 @@ The saved help for each module consists of one help information (HelpInfo XML) f You do not have to extract the help files from the cabinet file. The **Update-Help** cmdlet extracts the help files, validates the XML for safety, and then installs the help files and the help information file in a language-specific subfolder of the module folder. -To save the help files for modules in the Windows PowerShell installation folder ($pshome\Modules), start Windows PowerShell by using the Run as administrator option. +To save the help files for modules in the PowerShell installation folder ($pshome\Modules), start PowerShell by using the Run as administrator option. You must be a member of the Administrators group on the computer to download the help files for these modules. This cmdlet was introduced in Windows PowerShell 3.0. @@ -141,7 +141,7 @@ When a module is not installed on the computer, **Save-Help** needs the module o PS C:\> Save-Help -Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath "D:\Help" ``` -This command saves help for the Windows PowerShell Core modules in four different UI cultures. +This command saves help for the PowerShell Core modules in four different UI cultures. The language packs for these locales do not have to be installed on the computer. **Save-Help** can download help files for modules in different UI cultures only when the module owner makes the translated files available on the Internet. @@ -203,7 +203,7 @@ Indicates that this cmdlet does not follow the once-per-day limitation, skips ve Without this parameter, only one **Save-Help** command for each module is permitted in each 24-hour period, downloads are limited to 1 GB of uncompressed content per module, and help files for a module are installed only when they are newer than the files on the computer. -The once-per-day limit protects the servers that host the help files, and makes it practical for you to add a **Save-Help** command to your Windows PowerShell profile. +The once-per-day limit protects the servers that host the help files, and makes it practical for you to add a **Save-Help** command to your PowerShell profile. To save help for a module in multiple UI cultures without the *Force* parameter, include all UI cultures in the same command, such as: `Save-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR` @@ -244,7 +244,7 @@ Specifies a path of the destination folder. Unlike the value of the *DestinationPath* parameter, the value of the *LiteralPath* parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. -Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. +Single quotation marks tell PowerShell not to interpret any characters as escape sequences. ```yaml Type: String[] @@ -345,12 +345,12 @@ You can pipe a module object from the **Get-Module** cmdlet to the *Module* para This cmdlet does not generate any output. ## NOTES -* To save help for modules in the $pshome\Modules folder, start Windows PowerShell by using the Run as administrator option. Only members of the Administrators group on the computer can download help for modules in the $pshome\Modules folder. +* To save help for modules in the $pshome\Modules folder, start PowerShell by using the Run as administrator option. Only members of the Administrators group on the computer can download help for modules in the $pshome\Modules folder. * The saved help for each module consists of one help information (HelpInfo XML) file and one cabinet (.cab) file for the help files each UI culture. You do not have to extract the help files from the cabinet file. The Update-Help cmdlet extracts the help files, validates the XML, and then installs the help files and the help information file in a language-specific subfolder of the module folder. * The **Save-Help** cmdlet can save help for modules that are not installed on the computer. However, because help files are installed in the module folder, the **Update-Help** cmdlet can install updated help file only for modules that are installed on the computer. * If **Save-Help** cannot find updated help files for a module, or cannot find updated help files in the specified language, it continues silently without displaying an error message. To see which files were saved by the command, specify the *Verbose* parameter. * Modules are the smallest unit of updatable help. You cannot save help for a particular cmdlet, only for all cmdlets in module. To find the module that contains a particular cmdlet, use the **ModuleName** property together with the Get-Command cmdlet, for example, `(Get-Command \).ModuleName` -* **Save-Help** supports all modules and the Windows PowerShell Core snap-ins. It does not support any other snap-ins. +* **Save-Help** supports all modules and the PowerShell Core snap-ins. It does not support any other snap-ins. * The **Update-Help** and **Save-Help** cmdlets use the following ports to download help files: Port 80 for HTTP and port 443 for HTTPS. * The **Update-Help** and **Save-Help** cmdlets are not supported on Windows Preinstallation Environment (Windows PE). diff --git a/reference/6/Microsoft.PowerShell.Core/Set-PSDebug.md b/reference/6/Microsoft.PowerShell.Core/Set-PSDebug.md index 90b6820238c6..e03f8c0ced34 100644 --- a/reference/6/Microsoft.PowerShell.Core/Set-PSDebug.md +++ b/reference/6/Microsoft.PowerShell.Core/Set-PSDebug.md @@ -84,7 +84,7 @@ At line:1 char:28 + Set-PsDebug -strict;$NewVar <<<< ``` -This command puts Windows PowerShell in strict mode, and then attempts to access a variable that has not yet been set. +This command puts PowerShell in strict mode, and then attempts to access a variable that has not yet been set. ## PARAMETERS @@ -108,7 +108,7 @@ Accept wildcard characters: False ### -Step Indicates that this cmdlet turns on script stepping. -Before each line runs, Windows PowerShell prompts you to stop, continue, or enter a new interpreter level to inspect the state of the script. +Before each line runs, PowerShell prompts you to stop, continue, or enter a new interpreter level to inspect the state of the script. Specifying the *Step* parameter automatically sets a trace level of 1. @@ -125,7 +125,7 @@ Accept wildcard characters: False ``` ### -Strict -Indicates that Windows PowerShell returns an exception if a variable is referenced before a value is assigned to the variable. +Indicates that PowerShell returns an exception if a variable is referenced before a value is assigned to the variable. A `Set-StrictMode -Off` command disables the verification set by a `Set-PSDebug -Strict` command. For more information, see **Set-StrictMode**. diff --git a/reference/6/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md b/reference/6/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md index d35d999daa53..e400283bcac8 100644 --- a/reference/6/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md +++ b/reference/6/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md @@ -376,7 +376,7 @@ Accept wildcard characters: False ``` ### -PSVersion -Specifies the version of Windows PowerShell in sessions that use this session configuration. +Specifies the version of PowerShell in sessions that use this session configuration. The value of this parameter takes precedence over the value of the **PowerShellVersion** key in the session configuration file. @@ -500,7 +500,7 @@ Accept wildcard characters: False ### -StartupScript Specifies the startup script for the configuration. -Enter the fully qualified path of a Windows PowerShell script. +Enter the fully qualified path of a PowerShell script. The specified script runs in the new session that uses the session configuration. To delete a startup script from a session configuration, enter an empty string ("") or a value of $Null. @@ -634,7 +634,7 @@ You cannot pipe input to this cmdlet. ### Microsoft.WSMan.Management.WSManConfigLeafElement ## NOTES -* To run this cmdlet, start Windows PowerShell by using the Run as administrator option. +* To run this cmdlet, start PowerShell by using the Run as administrator option. * The **Set-PSSessionConfiguration** cmdlet does not change the configuration name and the **WSMan** provider does not support the Rename-Item cmdlet. To change the name of a session configuration, use the Unregister-PSSessionConfiguration cmdlet to delete the configuration and then use the **Register-PSSessionConfiguration** cmdlet to create and register a new session configuration. * You can use the **Set-PSSessionConfiguration** cmdlet to change the default Microsoft.PowerShell and Microsoft.PowerShell32 session configurations. They are not protected. To revert to the original version of a default session configuration, use the **Unregister-PSSessionConfiguration** cmdlet to delete the default session configuration and then use the Enable-PSRemoting cmdlet to restore it. * The properties of a session configuration object vary with the options set for the session configuration and the values of those options. Also, session configurations that use a session configuration file have additional properties. diff --git a/reference/6/Microsoft.PowerShell.Core/Set-StrictMode.md b/reference/6/Microsoft.PowerShell.Core/Set-StrictMode.md index 6a33c0507c93..c78cb03f9134 100644 --- a/reference/6/Microsoft.PowerShell.Core/Set-StrictMode.md +++ b/reference/6/Microsoft.PowerShell.Core/Set-StrictMode.md @@ -27,7 +27,7 @@ Set-StrictMode [-Off] [] ## DESCRIPTION The **Set-StrictMode** cmdlet configures strict mode for the current scope and all child scopes, and turns it on and off. -When strict mode is on, Windows PowerShell generates a terminating error when the content of an expression, script, or script block violates basic best-practice coding rules. +When strict mode is on, PowerShell generates a terminating error when the content of an expression, script, or script block violates basic best-practice coding rules. Use the *Version* parameter to determine which coding rules are enforced. @@ -98,7 +98,7 @@ At line:1 char:9 ``` This command turns strict mode on and sets it to version 2.0. -As a result, Windows PowerShell returns an error if you use method syntax, which uses parentheses and commas, for a function call or reference uninitialized variables or non-existent properties. +As a result, PowerShell returns an error if you use method syntax, which uses parentheses and commas, for a function call or reference uninitialized variables or non-existent properties. The sample output shows the effect of version 2.0 strict mode. @@ -145,7 +145,7 @@ Latest ---- Selects the latest version available. The latest version is the most strict. -Use this value to make sure that scripts use the strictest available version, even when new versions are added to Windows PowerShell. +Use this value to make sure that scripts use the strictest available version, even when new versions are added to PowerShell. ```yaml Type: Version @@ -173,7 +173,7 @@ You cannot pipe input to this cmdlet. This cmdlet does not return any output. ## NOTES -* **Set-StrictMode** is like the *Strict* parameter of **Set-PSDebug**. `Set-StrictMode -Version 1` is equivalent to `Set-PSDebug -Strict`, except that **Set-PSDebug** is effective in all scopes. **Set-StrictMode** is effective only in the scope in which it is set and in its child scopes. For more information about scopes in Windows PowerShell, see about_Scopes. +* **Set-StrictMode** is like the *Strict* parameter of **Set-PSDebug**. `Set-StrictMode -Version 1` is equivalent to `Set-PSDebug -Strict`, except that **Set-PSDebug** is effective in all scopes. **Set-StrictMode** is effective only in the scope in which it is set and in its child scopes. For more information about scopes in PowerShell, see about_Scopes. * diff --git a/reference/6/Microsoft.PowerShell.Core/Start-Job.md b/reference/6/Microsoft.PowerShell.Core/Start-Job.md index 140f42fe14c8..eed8430738c4 100644 --- a/reference/6/Microsoft.PowerShell.Core/Start-Job.md +++ b/reference/6/Microsoft.PowerShell.Core/Start-Job.md @@ -11,7 +11,7 @@ title: Start-Job # Start-Job ## SYNOPSIS -Starts a Windows PowerShell background job. +Starts a PowerShell background job. ## SYNTAX @@ -42,9 +42,9 @@ Start-Job [-Name ] [-Credential ] [-FilePath] ``` ## DESCRIPTION -The **Start-Job** cmdlet starts a Windows PowerShell background job on the local computer. +The **Start-Job** cmdlet starts a PowerShell background job on the local computer. -A Windows PowerShell background job runs a command without interacting with the current session. +A PowerShell background job runs a command without interacting with the current session. When you start a background job, a job object returns immediately, even if the job takes an extended time to finish. You can continue to work in the session without interruption while the job runs. @@ -288,7 +288,7 @@ Specifies a local script that this cmdlet runs as a background job. Enter the path and file name of the script or pipe a script path to **Start-Job**. The script must be on the local computer or in a folder that the local computer can access. -When you use this parameter, Windows PowerShell converts the contents of the specified script file to a script block and runs the script block as a background job. +When you use this parameter, PowerShell converts the contents of the specified script file to a script block and runs the script block as a background job. ```yaml Type: String @@ -346,7 +346,7 @@ Enter the path of a script on the local computer. Unlike the *FilePath* parameter, this cmdlet uses the value of the *LiteralPath* parameter exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. -Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. +Single quotation marks tell PowerShell not to interpret any characters as escape sequences. ```yaml Type: String @@ -380,7 +380,7 @@ Accept wildcard characters: False ### -PSVersion Specifies a version. -This cmdlet runs the job with the version of Windows PowerShell. +This cmdlet runs the job with the version of PowerShell. The acceptable values for this parameter are: 2.0 and 3.0. This parameter was introduced in Windows PowerShell 3.0. diff --git a/reference/6/Microsoft.PowerShell.Core/Stop-Job.md b/reference/6/Microsoft.PowerShell.Core/Stop-Job.md index c8dd76d2b058..7a0ba66b7ea2 100644 --- a/reference/6/Microsoft.PowerShell.Core/Stop-Job.md +++ b/reference/6/Microsoft.PowerShell.Core/Stop-Job.md @@ -11,7 +11,7 @@ title: Stop-Job # Stop-Job ## SYNOPSIS -Stops a Windows PowerShell background job. +Stops a PowerShell background job. ## SYNTAX @@ -46,11 +46,11 @@ Stop-Job [-PassThru] [-Filter] [-WhatIf] [-Confirm] [ Update-Help This command updates help for all installed modules that support Updatable Help in the language specified by the UI culture that is set for Windows. -To run this command, start Windows PowerShell by using the Run as administrator option (`Start-Process PowerShell -Verb RunAs`). +To run this command, start PowerShell by using the Run as administrator option (`Start-Process PowerShell -Verb RunAs`). ### Example 2: Update help for specified modules ``` @@ -80,7 +80,7 @@ PS C:\> Update-Help -Module ServerManager, Microsoft.PowerShell* This command updates help only for the ServerManager module and for modules that have names that begin with Microsoft.PowerShell. -Because these modules are in the $pshome\Modules folder, to run this command, start Windows PowerShell by using the Run as administrator option. +Because these modules are in the $pshome\Modules folder, to run this command, start PowerShell by using the Run as administrator option. ### Example 3: Update help in different languages ``` @@ -108,8 +108,8 @@ The command uses the Register-ScheduledJob cmdlet to create a scheduled job that The command uses the *Credential* parameter to run **Update-Help** by using the credentials of a member of the Administrators group on the computer. The value of the *Trigger* parameter is a New-JobTrigger command that creates a job trigger that starts the job every day at 3:00 AM. -To run the **Register-ScheduledJob** command, start Windows PowerShell by using the Run as administrator option. -When you run the command, Windows PowerShell prompts you for the password of the user specified in the value of the **Credential** parameter. +To run the **Register-ScheduledJob** command, start PowerShell by using the Run as administrator option. +When you run the command, PowerShell prompts you for the password of the user specified in the value of the **Credential** parameter. The credentials are stored with the scheduled job. You are not prompted when the job runs. @@ -129,7 +129,7 @@ These commands download updated help files for system modules from the Internet Then the commands install the updated help files from the file share on multiple computers. You can use a strategy such as the one shown here to update the help files on many computers, even those that are behind firewalls or are not connected to the Internet. -All of the commands in this example were run in a Windows PowerShell session that was started by using the Run as administrator option. +All of the commands in this example were run in a PowerShell session that was started by using the Run as administrator option. ### Example 6: Get a List of Updated Help Files ``` @@ -245,7 +245,7 @@ Indicates that this cmdlet does not follow the once-per-day limitation, skips ve Without this parameter, **Update-Help** runs only once in each 24-hour period, downloads are limited to 1 GB of uncompressed content per module and help files are installed only when they are newer than the files on the computer. -The once-per-day limit protects the servers that host the help files and makes it practical for you to add an **Update-Help** command to your Windows PowerShell profile without incurring the resource cost of repeated connections or downloads. +The once-per-day limit protects the servers that host the help files and makes it practical for you to add an **Update-Help** command to your PowerShell profile without incurring the resource cost of repeated connections or downloads. To update help for a module in multiple UI cultures without the *Force* parameter, include all UI cultures in the same command, such as: `Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR` @@ -290,7 +290,7 @@ You can also pipe a directory object, such as one from the Get-Item or Get-Child Unlike the value of *SourcePath*, the value of *LiteralPath* is used exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. -Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. +Single quotation marks tell PowerShell not to interpret any characters as escape sequences. ```yaml Type: String[] @@ -448,9 +448,9 @@ You can pipe a module object from the Get-Module cmdlet to this cmdlet. This cmdlet does not generate any output. ## NOTES -* To update help for the Windows PowerShell Core modules, which contain the commands that are installed with Windows PowerShell, or any module in the $pshome\Modules folder, start Windows PowerShell by using the Run as administrator option. +* To update help for the PowerShell Core modules, which contain the commands that are installed with PowerShell, or any module in the $pshome\Modules folder, start PowerShell by using the Run as administrator option. - Only members of the Administrators group on the computer can update help for the for the Windows PowerShell Core modules, the commands that are installed together with Windows PowerShell, and for modules in the $pshome\Modules folder. + Only members of the Administrators group on the computer can update help for the for the PowerShell Core modules, the commands that are installed together with PowerShell, and for modules in the $pshome\Modules folder. If you do not have permission to update help files, you might be able to read the help topics online. To open the online version of any cmdlet help topic, type `Get-Help \ -Online `. diff --git a/reference/6/Microsoft.PowerShell.Core/Wait-Job.md b/reference/6/Microsoft.PowerShell.Core/Wait-Job.md index 3f1226899087..75b314e94277 100644 --- a/reference/6/Microsoft.PowerShell.Core/Wait-Job.md +++ b/reference/6/Microsoft.PowerShell.Core/Wait-Job.md @@ -11,7 +11,7 @@ title: Wait-Job # Wait-Job ## SYNOPSIS -Suppresses the command prompt until one or all of the Windows PowerShell background jobs running in the session are completed. +Suppresses the command prompt until one or all of the PowerShell background jobs running in the session are completed. ## SYNTAX @@ -46,13 +46,13 @@ Wait-Job [-Any] [-Timeout ] [-Force] [-Filter] [ $j | Wait-Job This example shows how to use the **Wait-Job** cmdlet with jobs started on the local computer by using **Start-Job**. -These commands start a job that gets the Windows PowerShell script files that were added or updated in the last week. +These commands start a job that gets the PowerShell script files that were added or updated in the last week. The first command uses **Start-Job** to start a background job on the local computer. The job runs a Get-ChildItem command that gets all of the files that have a .ps1 file name extension that were added or updated in the last week. diff --git a/reference/6/Microsoft.PowerShell.Core/Where-Object.md b/reference/6/Microsoft.PowerShell.Core/Where-Object.md index e44b3582c6de..839ab28af328 100644 --- a/reference/6/Microsoft.PowerShell.Core/Where-Object.md +++ b/reference/6/Microsoft.PowerShell.Core/Where-Object.md @@ -223,7 +223,7 @@ Starting in Windows PowerShell 3.0, there are two different ways to construct a `Get-Process | Where-Object {$_.PriorityClass -eq "Normal"}` - All Windows PowerShell comparison operators are valid in the script block format. + All PowerShell comparison operators are valid in the script block format. For more information about comparison operators, see [about_Comparison_Operators](./About/about_Comparison_Operators.md). - **Comparison statement**. @@ -239,7 +239,7 @@ Starting in Windows PowerShell 3.0, there are two different ways to construct a Starting in Windows PowerShell 3.0, **Where-Object** adds comparison operators as parameters in a **Where-Object** command. Unless specified, all operators are case-insensitive. - Prior to Windows PowerShell 3.0, the comparison operators in the Windows PowerShell language could be used only in script blocks. + Prior to Windows PowerShell 3.0, the comparison operators in the PowerShell language could be used only in script blocks. ## Examples @@ -334,14 +334,14 @@ This example shows how to create a `Where-Object` command with multiple conditio This command gets non-core modules that support the Updatable Help feature. The command uses the *ListAvailable* parameter of the `Get-Module` cmdlet to get all modules on the computer. -A pipeline operator (|) sends the modules to the `Where-Object` cmdlet, which gets modules whose names do not begin with Microsoft or PS, and have a value for the **HelpInfoURI** property, which tells Windows PowerShell where to find updated help files for the module. +A pipeline operator (|) sends the modules to the `Where-Object` cmdlet, which gets modules whose names do not begin with Microsoft or PS, and have a value for the **HelpInfoURI** property, which tells PowerShell where to find updated help files for the module. The comparison statements are connected by the **And** logical operator. The example uses the script block command format. Logical operators, such as **And** and **Or**, are valid only in script blocks. You cannot use them in the comparison statement format of a `Where-Object` command. -- For more information about Windows PowerShell logical operators, see [about_Logical_Operators](./About/about_logical_operators.md). +- For more information about PowerShell logical operators, see [about_Logical_Operators](./About/about_logical_operators.md). - For more information about the Updatable Help feature, see [about_Updatable_Help](./About/about_Updatable_Help.md). ## PARAMETERS @@ -354,7 +354,7 @@ This operation is case-sensitive. For example: `Get-Process | where ProcessName -CContains "svchost"` *CContains* refers to a collection of values and is true if the collection contains an item that is an exact match for the specified value. -If the input is a single object, Windows PowerShell converts it to a collection of one object. +If the input is a single object, PowerShell converts it to a collection of one object. This parameter was introduced in Windows PowerShell 3.0. @@ -563,7 +563,7 @@ This operation is case-sensitive. For example: `Get-Process | where ProcessName -CNotContains "svchost"` "NotContains" and "CNotContains refer to a collection of values and are true when the collection does not contains any items that are an exact match for the specified value. -If the input is a single object, Windows PowerShell converts it to a collection of one object. +If the input is a single object, PowerShell converts it to a collection of one object. This parameter was introduced in Windows PowerShell 3.0. @@ -654,7 +654,7 @@ Indicates that this cmdlet gets objects if any item in the property value of the For example: `Get-Process | where ProcessName -Contains "Svchost"` -If the property value contains a single object, Windows PowerShell converts it to a collection of one object. +If the property value contains a single object, PowerShell converts it to a collection of one object. This parameter was introduced in Windows PowerShell 3.0. @@ -749,9 +749,9 @@ Indicates that this cmdlet gets objects if the property value matches any of the For example: `Get-Process | where -Property ProcessName -in -Value "Svchost", "TaskHost", "WsmProvHost"` -If the value of the *Value* parameter is a single object, Windows PowerShell converts it to a collection of one object. +If the value of the *Value* parameter is a single object, PowerShell converts it to a collection of one object. -If the property value of an object is an array, Windows PowerShell uses reference equality to determine a match. +If the property value of an object is an array, PowerShell uses reference equality to determine a match. `Where-Object` returns the object only if the value of the *Property* parameter and any value of *Value* are the same instance of an object. This parameter was introduced in Windows PowerShell 3.0. @@ -932,7 +932,7 @@ Indicates that this cmdlet gets objects if none of the items in the property val For example: `Get-Process | where ProcessName -NotContains "Svchost"` *NotContains* refers to a collection of values and is true if the collection does not contain any items that are an exact match for the specified value. -If the input is a single object, Windows PowerShell converts it to a collection of one object. +If the input is a single object, PowerShell converts it to a collection of one object. This parameter was introduced in Windows PowerShell 3.0. @@ -954,9 +954,9 @@ Indicates that this cmdlet gets objects if the property value is not an exact ma For example: `Get-Process | where -Value "svchost" -NotIn -Property ProcessName` -If the value of *Value* is a single object, Windows PowerShell converts it to a collection of one object. +If the value of *Value* is a single object, PowerShell converts it to a collection of one object. -If the property value of an object is an array, Windows PowerShell uses reference equality to determine a match. +If the property value of an object is an array, PowerShell uses reference equality to determine a match. `Where-Object` returns the object only if the value of *Property* and any value of *Value* are not the same instance of an object. This parameter was introduced in Windows PowerShell 3.0.