| Build Status | Gallery Version | Platform |
|---|---|---|
 |
 |
A PowerShell module to handle environment variables, supporting variable expansion.
Install-Module xEnvironmentVariablesPS> Import-Module xEnvironmentVariablesPS C:\> Set-EnvironmentVariable -name TestVar -Value 'TestValue' -Scope Machine -ValueType String -Inherit Auto
Name : TestVar
Value : TestValue
Scope : Machine
ValueType : String
BeforeExpansion :The BeforeExpansion Value is the true value of the environment variable.
PS C:\> Set-EnvironmentVariable -name TestPathVar -Value '%TEMP%\TestValue' -Scope Machine -ValueType ExpandString -Inherit Auto
Name : TestPathVar
Value : C:\Users\USERNAME\AppData\Local\Temp\TestValue
Scope : Machine
ValueType : ExpandString
BeforeExpansion : %TEMP%\TestValueThe BeforeExpansion Property value is the same as the Value Property because there are no EnvironmentVariables to expand.
PS C:\> Set-EnvironmentVariable -name TestPathVar -Value '%TEMP%\TestValue' -Scope Machine -ValueType String -Inherit Auto
Name : TestPathVar
Value : C:\Users\USERNAME\AppData\Local\Temp\TestValue
Scope : Machine
ValueType : String
BeforeExpansion : C:\Users\USERNAME\AppData\Local\Temp\TestValueThe ShowProperties switch results in the full Property Set being returned.
PS C:\> Get-EnvironmentVariable -name TestVar -Scope Machine -ShowProperties
Name : TestVar
Value : TestValue
Scope : Machine
ValueType : String
BeforeExpansion : TestValueThe ShowProperties switch results in the full Property Set being returned. The BeforeExpansion Property shows the unexpanded value of the Environment Variable.
PS C:\> Get-EnvironmentVariable -name TestPathVar -Scope Machine -ShowProperties
Name : TestPathVar
Value : C:\Users\rblea\AppData\Local\Temp\TestValue2
Scope : Machine
ValueType : String
BeforeExpansion : %TEMP%\TestValue2The expanded value of the TestPathVar Environment Variable is returned.
PS C:\> Get-EnvironmentVariable -name TestPathVar -Scope Machine
C:\Users\USER\AppData\Local\Temp\TestValue2The unexpanded value of the TestPathVar Environment Variable is returned.
PS C:\> Get-EnvironmentVariable -name TestPathVar -Scope Machine -Expanded
%TEMP%\TestValue2PS C:\> Get-EnvironmentVariables -Scope Machine
PROCESSOR_LEVEL : 23
TestPathVar2 : C:\Users\USER\AppData\Local\Temp\TestValue2
USERNAME : SYSTEM
PROCESSOR_ARCHITECTURE : AMD64
TestVar : TestValue
NUMBER_OF_PROCESSORS : 12
PROCESSOR_REVISION : 0802
...PS C:\> Get-EnvironmentVariables
USERDOMAIN : ComputerDomain
COLORTERM : truecolor
ComSpec : C:\WINDOWS\system32\cmd.exe
TERM_PROGRAM_VERSION : 1.40.0
TestPathVar2 : C:\WINDOWS\TEMP\TestValue2
CommonProgramFiles : C:\Program Files\Common Files
NUMBER_OF_PROCESSORS : 12
...PS C:\> Get-EnvironmentVariables -OutputType JSON
[
{
"Name": "PROCESSOR_IDENTIFIER",
"Value": "AMD64 Family 23 Model 8 Stepping 2, AuthenticAMD"
},
{
"Name": "PROCESSOR_ARCHITECTURE",
"Value": "AMD64"
},
{
"Name": "ProgramData",
"Value": "C:\\ProgramData"
},
{
"Name": "OS",
"Value": "Windows_NT"
},
{
"Name": "TestValue2",
"Value": "%TMP%\\TestValue3"
},
{
"Name": "USERPROFILE",
"Value": "C:\\Users\\USERNAME"
},
{
"Name": "ALLUSERSPROFILE",
"Value": "C:\\ProgramData"
},
{
"Name": "CommonProgramW6432",
"Value": "C:\\Program Files\\Common Files"
},
{
"Name": "TestPathVar2",
"Value": "C:\\WINDOWS\\TEMP\\TestValue2"
},
{
"Name": "PROCESSOR_LEVEL",
"Value": "23"
},
{
"Name": "ProgramFiles(x86)",
"Value": "C:\\Program Files (x86)"
},
{
"Name": "ProgramW6432",
"Value": "C:\\Program Files"
},
{
"Name": "HOMEDRIVE",
"Value": "C:"
},
...
]PS C:\> Get-EnvironmentVariables -OutputType CSV
PROCESSOR_IDENTIFIER,PROCESSOR_ARCHITECTURE,ProgramData,OS,TestValue2...
"AMD64 Family 23 Model 8 Stepping 2, AuthenticAMD",AMD64,C:\ProgramData,Windows_NT,%TMP%\TestValue3...PS C:\> Get-EnvironmentVariables -OutputType Array
Name Value
---- -----
PROCESSOR_IDENTIFIER AMD64 Family 23 Model 8 Stepping 2, AuthenticAMD
PROCESSOR_ARCHITECTURE AMD64
ProgramData C:\ProgramData
OS Windows_NT
TestValue2 %TMP%\TestValue3
...PS C:\> Get-EnvironmentVariables -OutputType Array -Names
Name
----
PROCESSOR_IDENTIFIER
PROCESSOR_ARCHITECTURE
ProgramData
OS
TestValue2
DriverData
ComSpec
USERPROFILE
ALLUSERSPROFILE
LOGONSERVER
USERDOMAIN_ROAMINGPROFILE
TERM_PROGRAM_VERSION
PSExecutionPolicyPreference
...When returning only names or values, you must specify another output type as the default output type is a Custom Object containing both Names and Values.