powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-Variable



NAME
Get-Variable

SYNOPSIS
Gets the variables in the current console.

SYNTAX
Get-Variable [[-Name] ] [-Exclude ] [-Include ] [-Scope ] [-ValueOnly] [ onParameters>]


DESCRIPTION
The Get-Variable cmdlet gets the Windows PowerShell variables in the current console. You can retrieve just the val
ues of the variables by specifying the ValueOnly parameter, and you can filter the variables returned by name.


PARAMETERS
-Exclude
Omits the specified items. Wildcards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Include
Specifies only the items upon which the cmdlet will act, excluding all others. Wildcards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Name
Specifies the name of the variable.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Scope
Gets only the variables in the specified scope. Valid values are "Global", "Local", or "Script", or a number re
lative to the current scope (0 through the number of scopes, where 0 is the current scope and 1 is its parent).
"Local" is the default. For more information, see about_Scopes.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ValueOnly []
Gets only the value of the variable.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.String
You can pipe a string that contains the variable name to Get-Variable.


OUTPUTS
Variable object
Get-Variable returns a System.Management.Automation variable object for each variable that it gets. The object
type depends on the variable.


NOTES


This cmdlet does not manage environment variables. To manage environment variables, you can use the environment
variable provider.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>get-variable m*


Description
-----------
This command displays variables with names that begin with the letter "m". The value of the variables is also displ
ayed.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>get-variable m* -valueonly


Description
-----------
This command displays only the values of the variables with names that begin with the letter "m".





-------------------------- EXAMPLE 3 --------------------------

C:\PS>get-variable -include M*,P* | sort-object name


Description
-----------
This command gets information about the variables that begin with either the letter "M" or the letter "P". The resu
lts are piped to the Sort-Object cmdlet, sorted by name, and displayed.





-------------------------- EXAMPLE 4 --------------------------

C:\PS>get-variable -scope 0

C:\PS> compare-object (get-variable -scope 0) (get-variable -scope 1)


Description
-----------
The first command gets only the variables that are defined in the local scope. It is equivalent to "get-variable -s
cope local" and can be abbreviated as "gv -s 0".

The second command uses the Compare-Object cmdlet to find the variables that are defined in the parent scope (Scope
1) but are visible only in the local scope (Scope 0).






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113336
Set-Variable
New-Variable
Clear-Variable
Remove-Variable