Windows PowerShell Core Cmdlet Help Topics

Applies To: Windows PowerShell 2.0, Windows PowerShell 3.0

This section consists of an alphabetical list of the commands (cmdlets, functions, CIM commands, and workflows) that are installed with Windows PowerShell. To find the help topics that describe the commands, click the command-name link.

For a list of commands in each module, see Windows PowerShell Core Modules.

Cmdlet Help Topics

Name Description

Add-Computer

Adds computers to a domain or workgroup.

Add-Content

Adds content to the specified items, such as adding words to a file.

Add-History

Appends entries to the session history.

Add-JobTrigger

Adds job triggers to scheduled jobs.

Add-Member

Adds a user-defined custom member to an instance of a Windows PowerShell object.

Add-PSSnapin

Adds one or more Windows PowerShell snap-ins to the current session.

Add-Type

Adds a .NET type (a class) to a Windows PowerShell session.

Checkpoint-Computer

Creates a system restore point on the local computer.

Clear-Content

Deletes the contents of a item, such as deleting the text from a file, but does not delete the item.

Clear-EventLog

Deletes all entries from specified event logs on the local or remote computers.

Clear-History

Deletes entries from the command history.

Clear-Host

Clears the display in the host program.

Clear-Item

Deletes the value of an item, but does not delete the item.

Clear-ItemProperty

Deletes the value of a property but it does not delete the property.

Clear-Variable

Deletes the value of a variable.

Compare-Object

Compares two sets of objects.

Complete-Transaction

Commits the active transaction.

Connect-PSSession

Reconnects to disconnected sessions.

Connect-WSMan

Connects to the WinRM service on a remote computer.

Convert-Path

Converts a path from a Windows PowerShell path to a Windows PowerShell provider path.

ConvertFrom-Csv

Converts object properties in CSV format into CSV versions of the original objects.

ConvertFrom-Json

Converts a JSON-formatted string to a custom object.

ConvertFrom-SecureString

Converts a secure string into an encrypted standard string.

ConvertFrom-StringData

Converts a string containing one or more "name=value" pairs to a hash table.

ConvertTo-Csv

Converts .NET objects into a series of comma-separated, variable-length (CSV) strings.

ConvertTo-Html

Converts .NET objects into HTML that can be displayed in a Web browser.

ConvertTo-Json

Converts an object to a JSON-formatted string.

ConvertTo-SecureString

Converts encrypted standard strings to secure strings. It can also convert plain text to secure strings. It is used with ConvertFrom-SecureString and Read-Host.

ConvertTo-Xml

Creates an XML-based representation of an object.

Copy-Item

Copies an item from one location to another within a namespace.

Copy-ItemProperty

Copies a property and value from a specified location to another location.

Debug-Process

Debugs one or more processes running on the local computer.

Disable-ComputerRestore

Disables the System Restore feature on the specified file system drive.

Disable-JobTrigger

Disables the job triggers of scheduled jobs.

Disable-PSBreakpoint

Disables the breakpoints in the current console.

Disable-PSRemoting

Prevents the computer from receiving remote Windows PowerShell commands.

Disable-PSSessionConfiguration

Denies access to the session configurations on the local computer.

Disable-WSManCredSSP

Disables Credential Security Service Provider (CredSSP) authentication on a client computer.

Disconnect-PSSession

Disconnects from a session.

Disconnect-WSMan

Disconnects the client from the WinRM service on a remote computer.

Disable-ScheduledJob

Disables a scheduled job.

Enable-ComputerRestore

Enables the System Restore feature on the specified file system drive.

Enable-JobTrigger

Enables the job triggers of scheduled jobs.

Enable-PSBreakpoint

Enables the breakpoints in the current console.

Enable-PSRemoting

Configures the computer to receive remote commands.

Enable-PSSessionConfiguration

Configures the computer to receive remote commands.

Enable-ScheduledJob

Enables a scheduled job.

Enable-WSManCredSSP

Enables Credential Security Service Provider (CredSSP) authentication on a client computer.

Enter-PSSession

Starts an interactive session with a remote computer.

Exit-PSSession

Ends an interactive session with a remote computer.

Export-Alias

Exports information about currently-defined aliases to a file.

Export-Clixml

Creates an XML-based representation of an object or objects and stores it in a file.

Export-Console

Exports the names of snap-ins in the current session to a console file.

Export-Counter

The Export-Counter cmdlet exports performance counter data to log files.

Export-Csv

Converts .NET objects into a series of comma-separated, variable-length (CSV) strings and saves the strings in a CSV file.

Export-FormatData

Saves formatting data from the current session in a formatting file.

Export-ModuleMember

Specifies the module members that are exported.

Export-PSSession

Saves commands from another session in a module file.

ForEach-Object

Performs an operation against each of a set of input objects.

Format-Custom

Uses a customized view to format the output.

Format-List

Formats the output as a list of properties in which each property appears on a new line.

Format-Table

Formats the output as a table.

Format-Wide

Formats objects as a wide table that displays only one property of each object.

Get-Acl

Gets the security descriptor for a resource, such as a file or registry key.

Get-Alias

Gets the aliases for the current session.

Get-AuthenticodeSignature

Gets information about the Authenticode signature in a file.

Get-ChildItem

Gets the items and child items in one or more specified locations. (Like "dir".)

Get-Command

Gets all commands.

Get-ComputerRestorePoint

Gets the restore points on the local computer.

Get-Content

Gets the content of the item at the specified location.

Get-ControlPanelItem

Gets control panel items.

Get-Counter

Gets performance counter data from local and remote computers.

Get-Credential

Gets a credential object based on a user name and password.

Get-Culture

Gets the culture currently set in the operating system.

Get-Date

Gets the current date and time.

Get-Event

Gets the events in the event queue.

Get-EventLog

Gets the events in a specified event log or a list of the event logs on a computer.

Get-EventSubscriber

Gets the event subscribers in the current session.

Get-ExecutionPolicy

Gets the execution policies in the current session.

Get-FormatData

Gets the formatting data in the current session.

Get-Host

Gets an object that represents the current host program.

Get-HotFix

Gets the hotfixes that have been applied to the local and remote computers.

Get-Help

Displays information about Windows PowerShell cmdlets and concepts.

Get-History

Gets a list of the commands entered during the current session.

Get-IseSnippet

Gets snippets that the user created.

Get-Item

Gets the item at the specified location.

Get-ItemProperty

Gets the properties of a specified item.

Get-Job

Gets Windows PowerShell background jobs (PsJobs) that are running in the current console.

Get-JobTrigger

Gets the job triggers of scheduled jobs.

Get-Location

Gets information about the current working location.

Get-Member

Gets the properties and methods of objects.

Get-Module

Gets the modules that have been imported, or can be imported, into the current session.

Get-PfxCertificate

Gets information about .pfx certificate files on the computer.

Get-Process

Gets the processes that are running on the local computer or a remote computer.

Get-PSBreakpoint

Gets the breakpoints set in the current console.

Get-PSCallStack

Displays the current call stack.

Get-PSDrive

Gets the Windows PowerShell drives in the current console.

Get-PSProvider

Gets information about the specified Windows PowerShell provider.

Get-PSSession

Gets the Windows PowerShell sessions (PSSessions) in the current session.

Get-PSSessionConfiguration

Gets the session configurations registered on the computer.

Get-PSSnapin

Gets the Windows PowerShell snap-ins on the computer.

Get-Random

Gets a random number or selects objects randomly from a collection.

Get-ScheduledJob

Gets scheduled jobs on the local computer.

Get-ScheduledJobOption

Gets the job options of scheduled jobs.

Get-Service

Gets the services on a local or remote computer.

Get-TraceSource

Gets the Windows PowerShell components that are instrumented for tracing.

Get-Transaction

Gets the current (active) transaction.

Get-TypeData

Gets the extended type data in the current session.

Get-UICulture

Gets the current user interface culture set in the operating system.

Get-Unique

Returns the unique items from a sorted list.

Get-Variable

Gets the variables in the current console.

Get-Verb

Gets Windows PowerShell approved verbs.

Get-WinEvent

Gets events from event logs and event tracing log files on local and remote computers.

Get-WmiObject

Gets instances of WMI classes or information about available classes.

Get-WSManCredSSP

Gets the Credential Security Service Provider-related configuration for the client.

Get-WSManInstance

Displays management information for a resource instance specified by a Resource URI.

Group-Object

Groups objects that contain the same value for specified properties.

Import-Alias

Imports an alias list from a file.

Import-Clixml

Imports a CLIXML file and creates corresponding objects within Windows PowerShell.

Import-Counter

Imports performance counter log files (.blg, .csv, .tsv) and creates the objects that represent each counter sample in the log.

Import-Csv

Converts object properties in a CSV file into CSV versions of the original objects.

Import-IseSnippet

Imports ISE snippets into the current session.

Import-LocalizedData

Imports language-specific data into scripts and functions based on the current culture setting of the operating system.

Import-PSSession

Imports cmdlets, aliases, functions, and other command types from another session on a local or remote computer into the current session.

Import-Module

Adds modules to the current session.

Invoke-AsWorkflow

Runs a command or expression as a Windows PowerShell Workflow.

Invoke-Command

Runs commands on local and remote computers.

Invoke-Expression

Runs commands or expressions on the local computer.

Invoke-History

Runs commands from the session history.

Invoke-Item

Performs the default action on the specified item.

Invoke-RestMethod

Sends an HTTP or HTTPS request to a REST-compliant web service.

Invoke-WebRequest

Sends an HTTP or HTTPS request to a web service.

Invoke-WmiMethod

Calls WMI methods.

Invoke-WSManAction

Invokes an action on the object that is specified by the Resource URI and by the selectors.

Join-Path

Combines a path and child-path into a single path.

Limit-EventLog

Sets the event log properties that limit the size of the event log and the age of its entries.

Measure-Command

Measures the time it takes to run script blocks and cmdlets.

Measure-Object

Calculates the numeric properties of objects, and the characters, words, and lines in string objects, such as the text in files.

Move-Item

Moves an item from one location to another.

Move-ItemProperty

Moves a property from one location to another.

New-Alias

Creates a new alias.

New-Event

Creates a new event.

New-EventLog

Creates a new event log and a new event source on a local or remote computer.

New-IseSnippet

Creates a Windows PowerShell ISE snippet.

New-Item

Creates a new item.

New-ItemProperty

Creates a new property for an item and sets its value. For example, you can use New-ItemProperty to create and change registry values and data, which are properties of a registry key.

New-JobTrigger

Creates a job trigger for a scheduled job.

New-Object

Creates an instance of a .Net or COM object.

New-Module

Creates a new dynamic module that exists only in memory.

New-ModuleManifest

Creates a new module manifest.

New-PSDrive

Creates a Windows PowerShell drive in the current console.

New-PSSession

Creates a persistent connection to a local or remote computer.

New-PSSessionConfigurationFile

Creates a file that defines a session configuration.

New-PSSessionOption

Creates an object that contains advanced options for a session.

New-PSTransportOption

Creates an object that contains advanced options for a session configuration.

New-PSWorkflowExecutionOption

Creates an object that contains session configuration options for workflow sessions.

New-PSWorkflowSession

Creates a workflow session.

New-ScheduledJobOption

Creates an object that contains advanced options for a scheduled job.

New-Service

Creates a new Windows service.

New-TimeSpan

Creates an object that represents a time interval.

New-Variable

Creates a new variable.

New-WebServiceProxy

Creates a Web service proxy object that lets you use and manage the Web service in Windows PowerShell.

New-WinEvent

Creates a new Windows event for the specified event provider.

New-WSManInstance

Creates a new instance of a management resource.

New-WSManSessionOption

Creates a WSMan Session option hashtable to use as input parameters to the following WSMan cmdlets: Connect-WSMan, Get-WSManInstance, Invoke-WSManAction, Set-WSManInstance.

Out-Default

Sends the output to the default formatter and the default output cmdlet. It is a placeholder that lets you write your own Out-Default function or cmdlet.

Out-File

Sends output to a file.

Out-GridView

Sends output to an interactive table in a separate window.

Out-Host

Sends output to the console.

Out-Null

Deletes output instead of sending it to the console.

Out-Printer

Sends output to a printer.

Out-String

Sends objects to the host as a series of strings.

Pop-Location

Changes to the location most recently pushed onto the stack by Push-Location.

Push-Location

Adds the current location to the top of a list of locations ("stack").

Read-Host

Reads a line of input from the console.

Receive-Job

Gets the results of the Windows PowerShell background jobs in the current session.

Register-EngineEvent

Subscribes to events that are generated by the Windows PowerShell engine and by the New-Event cmdlet.

Register-ObjectEvent

Subscribes to the events that are generated by a .NET object.

Register-PSSessionConfiguration

Creates and registers a new session configuration.

Register-ScheduledJob

Creates a new scheduled job.

Register-WmiEvent

Subscribes to an event generated by a WMI object.

Remove-Computer

Removes computers from workgroups or domains.

Remove-Event

Deletes events from the event queue.

Remove-EventLog

Deletes an event log or unregisters an event source.

Remove-Item

Deletes the specified items.

Remove-ItemProperty

Deletes the property and its value from an item.

Remove-Job

Deletes a Windows PowerShell background job.

Remove-JobTrigger

Deletes job triggers from scheduled jobs.

Remove-Module

Removes modules from the current session.

Remove-PSBreakpoint

Deletes breakpoints from the current console.

Remove-PSDrive

Removes a Windows PowerShell drive from its location.

Remove-PSSession

Closes one or more Windows PowerShell sessions (PSSessions).

Remove-PSSnapin

Removes Windows PowerShell snap-ins from the current session.

Remove-TypeData

Deletes extended types from the current session.

Remove-Variable

Deletes a variable and its value.

Remove-WmiObject

Deletes WMI classes and instances.

Remove-WSManInstance

Deletes a management resource instance.

Rename-Computer

Renames a computer.

Rename-Item

Renames an item in a Windows PowerShell provider namespace.

Rename-ItemProperty

Renames a property of an item.

Reset-ComputerMachinePassword

Resets the machine account password for the computer.

Resolve-Path

Resolves the wildcard characters in a path and displays the path contents.

Restart-Computer

Restarts ("reboots") the operating system on local and remote computers.

Restart-Service

Stops and then starts one or more services.

Restore-Computer

Starts a system restore on the local computer.

Resume-Job

Restarts a suspended job.

Resume-Service

Resumes one or more suspended (paused) services.

Save-Help

Downloads and saves the newest help files to a file system directory.

Select-Object

Selects specified properties of an object or set of objects. It can also select unique objects from an array of objects or it can select a specified number of objects from the beginning or end of an array of objects.

Select-String

Finds text in strings and files.

Select-Xml

Finds text in an XML document.

Send-MailMessage

Sends an e-mail message.

Set-Acl

Changes the security descriptor of a specified resource, such as a file or a registry key.

Set-Alias

Creates or changes an alias (alternate name) for a cmdlet or command element.

Set-AuthenticodeSignature

Adds an Authenticode signature to a Windows PowerShell script or other file.

Set-Content

Writes or replaces the content in an item with new content.

Set-Date

Changes the system time on the computer to a time that you specify.

Set-ExecutionPolicy

Changes the user preference for the execution policy of the shell.

Set-Item

Changes the value of an item to the value specified in the command.

Set-ItemProperty

Creates or changes the value of a property of an item.

Set-JobTrigger

Changes the job trigger of a scheduled job.

Set-Location

Sets the current working location to a specified location.

Set-PSBreakpoint

Sets a breakpoint on a line, command, or variable.

Set-PSDebug

Turns script debugging features on and off, sets the trace level and toggles strict mode.

Set-PSSessionConfiguration

Changes the properties of a registered session configuration.

Set-ScheduledJob

Changes scheduled jobs.

Set-ScheduledJobOption

Changes the job options of a scheduled job.

Set-Service

Starts, stops, and suspends a service, and changes its properties.

Set-StrictMode

Establishes and enforces coding rules in expressions, scripts, and script blocks.

Set-TraceSource

Configures, starts, and stops a trace of Windows PowerShell components.

Set-Variable

Sets the value of a variable. Creates the variable if one with the requested name does not exist.

Set-WmiInstance

Creates or modifies instances of WMI classes.

Set-WSManInstance

Modifies management information related to a resource.

Set-WSManQuickConfig

Configures the local machine for remote management.

Show-Command

Creates Windows PowerShell commands in a graphical command window.

Show-ControlPanelItem

Opens control panel items.

Show-EventLog

Displays the event logs of the local or a remote computer in Event Viewer.

Sort-Object

Sorts objects by property values.

Split-Path

Returns the specified part of a path.

Start-Job

Starts a Windows PowerShell background job.

Start-Process

Starts one or more processes on the local computer.

Start-Service

Starts one or more stopped services.

Start-Sleep

Suspend shell, script, or runspace activity for the specified period of time.

Start-Transaction

Starts a transaction.

Start-Transcript

Creates a record of all or part of a Windows PowerShell session in a text file.

Stop-Computer

Shuts down local and remote computers.

Stop-Job

Stops a Windows PowerShell background job.

Stop-Process

Stops one or more running processes.

Stop-Service

Stops one or more running services.

Stop-Transcript

Stops a transcript.

Suspend-Job

Temporarily stops workflow jobs.

Suspend-Service

Suspends (pauses) one or more running services.

Tee-Object

Saves command output in a file or variable and displays it in the console.

Test-ComputerSecureChannel

Tests and repairs the secure channel between the local computer and its domain.

Test-Connection

Sends ICMP echo request packets ("pings") to one or more computers.

Test-ModuleManifest

Verifies that a module manifest accurately describes the contents of a module.

Test-Path

Determines whether all elements of a path exist.

Test-PSSessionConfigurationFile

Verifies the keys and values in a session configuration file.

Trace-Command

Configures and starts a trace of the specified expression or command.

Unblock-File

Unblocks files that were downloaded from the Internet.

Undo-Transaction

Rolls back the active transaction.

Unregister-Event

Cancels an event subscription.

Unregister-PSSessionConfiguration

Deletes a registered session configurations from the computer.

Unregister-ScheduledJob

Deletes scheduled jobs from the local computer.

Update-FormatData

Updates and appends format data files.

Update-Help

Downloads and installs the newest help files on your computer.

Update-List

Adds and removes items from a property value that contains a collection of objects.

Update-TypeData

Updates the extended type data in the session.

Use-Transaction

Adds the script block to the active transaction.

Wait-Event

Waits until a particular event is raised before continuing to run.

Wait-Job

Suppresses the command prompt until one or all of the Windows PowerShell background jobs are complete.

Wait-Process

Waits for the processes to be stopped before accepting more input.

Where-Object

Creates a filter that controls which objects will be passed along a command pipeline.

Write-Debug

Writes a debugging message to the console.

Write-Error

Writes an object to the error pipeline.

Write-EventLog

Writes an event to an event log.

Write-Host

Writes customized output to a host.

Write-Output

Sends the objects to the next command in the pipeline. If the command is the last in the pipeline, the objects are displayed on the console.

Write-Progress

Displays a progress bar within a Windows PowerShell command window.

Write-Verbose

Writes text to the verbose message stream in Windows PowerShell.

Write-Warning

Writes a warning message.

See Also

Concepts

Windows PowerShell Core About Help Topics
Windows PowerShell Core Provider Help Topics
Windows PowerShell Core Modules
Getting Started with Windows PowerShell

Other Resources

Windows PowerShell SDK