Set-ADTEnvironmentVariable

SYNOPSIS

Sets the value for the specified environment variable.

SYNTAX

Set-ADTEnvironmentVariable [-Variable] <String> [-Value] <String> [[-Target] <EnvironmentVariableTarget>]
 [<CommonParameters>]

DESCRIPTION

This function sets the value for the specified environment variable.

EXAMPLES

EXAMPLE 1

Set-ADTEnvironmentVariable -Variable Path -Value C:\Windows

Sets the value of the Path environment variable to C:\Windows.

EXAMPLE 2

Set-ADTEnvironmentVariable -Variable Path -Value C:\Windows -Target Machine

Sets the value of the Path environment variable to C:\Windows for the machine.

PARAMETERS

-Variable

The variable to set.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Value

The value to set to variable to.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Target

The target of the variable to set. This can be the machine, user, or process.

Type: EnvironmentVariableTarget
Parameter Sets: (All)
Aliases:
Accepted values: Process, User, Machine

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

You cannot pipe objects to this function.

OUTPUTS

None

This function does not return any output.

NOTES

An active ADT session is NOT required to use this function.

Tags: psadt
Website: https://psappdeploytoolkit.com
Copyright: (C) 2025 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough).
License: https://opensource.org/license/lgpl-3-0

RELATED LINKS

https://psappdeploytoolkit.com/docs/reference/functions/Set-ADTEnvironmentVariable