This is the built-in help made by Microsoft for the command 'Get-Credential', in PowerShell version 2 - as retrieved from
Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Gets a credential object based on a user name and password.
Get-Credential [-Credential] <PSCredential> [<CommonParameters>]
The Get-Credential cmdlet creates a credential object for a specified user name and password. You can use the credential object in security opera
tions.
The cmdlet prompts the user for a password or user name and password. Users are prompted through a dialog box or at the command line, depending o
n the system registry setting.
<
Online version: http://go.microsoft.com/fwlink/?LinkID=113311
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>$c = Get-Credential
Description
-----------
This command gets a credential object and saves it in the $c variable.
When you enter the command, a dialog box appears requesting a user name and password. When you enter the requested information, the cmdlet create
s a PSCredential object representing the credentials of the user and saves it in the $c variable.
You can use the object as input to cmdlets that request user authentication, such as those with a Credential parameter. However, the providers th
at are installed with Windows PowerShell do not support the Credential parameter.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>$c = Get-Credential
C:\PS>Get-WmiObject Win32_DiskDrive -ComputerName Server01 -Credential $c
Description
-----------
These commands use a credential object from Get-Credential to authenticate a user on a remote computer so they can use Windows Management Instrum
entation (WMI) to manage the computer.
The first command gets a credential object and saves it in the $c variable. The second command uses the credential object in a Get-WmiObject comm
and. This command gets information about the disk drives on the Server01 computer.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>C:\PS>Get-WmiObject Win32_BIOS -ComputerName Server01 '
-Credential (get-credential Domain01\User01)
Description
-----------
This command shows how to include a Get-Credential command in a Get-WmiObject command.
This command uses the Get-WmiObject cmdlet to get information about the BIOS on the Server01 computer. It uses the Credential parameter to authen
ticate the user, Domain01\User01, and a Get-Credential command as the value of the Credential parameter.
-------------------------- EXAMPLE 4 --------------------------
C:\PS>$c = Get-Credential -credential User01
C:\PS>$c.Username
\User01
Description
-----------
This example creates a credential that includes a user name without a domain name. It demonstrates that Get-Credential inserts a backslash before
the user name.
The first command gets a credential with the user name User01 and stores it in the $c variable.
The second command displays the value of the Username property of the resulting credential object.
-------------------------- EXAMPLE 5 --------------------------
C:\PS>$credential = $host.ui.PromptForCredential("Need credentials", "Please enter your user name and password.", "", "NetBiosUserName")
Description
-----------
This command uses the PromptForCredential method to prompt the user for their user name and password. The command saves the resulting credentials
in the $credential variable.
PromptForCredential is an alternative to using Get-Credential. When you use PromptForCredential, you can specify the caption, messages, and user
name that appear in the message box.
-------------------------- EXAMPLE 6 --------------------------
C:\PS>Set-ItemProperty 'HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds' ConsolePrompting $true
Description
-----------
When requiring a user name and password, as a default, a dialog box appears to prompt the user. To be prompted at the command line, modify the re
gistry by running this command in Windows PowerShell Run as administrator.
Use the same command with "ConsolePrompting $false" to be prompted with a dialog box.