This cmdlet is part of the Vexasoft Cmdlet Library. You can download it now or click here to find out more.

Get-StartUpApplication

Synopsis

Gets the programs or executables set to run at logon for the users currently logged in to a local or remote computer.

Syntax

  • Get-StartUpApplication [-Name] [-Executable] [-User] [-RunOnce] [-ComputerName] [-Credential]

Description

The Get-StartUpApplication cmdlet is used to determine which programs are set to run at user logon for the users currently logged on to a local or remote computer.

Parameters

  • Name The name of the program. The startup applications returned will be filtered by the name specified and only applications matching the name specified will be returned.
  • Executable The name of the program executable. The startup applications returned will be filtered by the executable name specified and only applications matching the executable specified will be returned.
  • User Return startup applications for the specified user only. The startup applications returned will be filtered by user name specified and only applications matching the user specified will be returned.
  • RunOnce Whether the information returned should include or exclude applications set to run once. Specify $True or $False. Results will be filtered in line with the value specified.
  • ComputerName The computer against which to run the cmdlet. By default this parameter will be populated with the name of the local computer.
  • Credential The credentials under which to run the cmdlet. By default this cmdlet will run as the current user. Using this parameter and the Get-PSCredential cmdlet you can specify an alternate set of credentials under which to execute this command.

Inputs

Get-StartUpApplication accepts input object with a Computer, ComputerName or CN property, for use with the ComputerName parameter.

Outputs

Get-StartUpApplication outputs a Vexasoft.StartupApplication object for each startup application.

Notes

The Get-StartUpApplication cmdlet requires that the RPC service is started on the computer it is trying to access and that DNS services are available to resolve target host names.

Example 1

This command will retrieve all applications set to run on startup on the local computer for the currently logged on users:

C:\PS>Get-StartupApplication

Example 2

This command will retrieve any applications set to run at startup on the local computer, whose name begins with 'sidebar':

C:\PS>Get-StartupApplication -Name sidebar*

Example 3

This command will retrieve any applications set to run at startup on the local computer, whose executable ends with 'sidebar.exe':

C:\PS>Get-StartupApplication -Executable *sidebar.exe

Example 4

This command will retrieve any applications set to run at startup on the local computer, whose executable exactly matches 'C:\Program Files\Windows Sidebar\sidebar.exe':

C:\PS>Get-StartupApplication -Executable 'C:\Program Files\Windows Sidebar\sidebar.exe'

Example 5

This command will retrieve any applications set to run at startup on the remote computer PC01, and ignoring applications that are set to run once:

C:\PS>Get-StartupApplication -RunOnce $False -Computer PC01

Example 6

This command will retrieve any applications set to run at startup for the user ASmith on the remote computer PC01:

C:\PS>Get-StartupApplication -User ASmith -Computer PC01