CmdID / PowerShell / Cmdlets / Set
Set-Variable
Sets the value of a variable. PowerShell reference
From the PowerShell reference
12 parameters
Aliases set, sv
What it does
Sets the value of a variable. Creates the variable if one with the requested name does not exist. The Set-Variable cmdlet assigns a value to a specified variable or changes the current value. If the variable does not exist, the cmdlet creates it.
Set-Variable [-Name] <String[]> [[-Value] <Object>] [-Include <String[]>] [-Exclude <String[]>] [-Description <String>] [-Option <ScopedItemOptions>] [-Force] [-Visibility <SessionStateEntryVisibility>] [-PassThru] [-Scope <String>] [-WhatIf] [-Confirm] [<CommonParameters>]Set a variable and get its value
Set-Variable -Name "desc" -Value "A description"
Get-Variable -Name "desc"IdentifySet a global, read-only variable
Set-Variable -Name "processes" -Value (Get-Process) -Option Constant -Scope Global -Description "All processes" -PassThru |
Format-List -Property *IdentifyUnderstand public vs. private variables
New-Variable -Name "counter" -Visibility Public -Value 26
$CounterIdentifyIts page in the reference: Set-Variable.
Parameters
-DescriptionSpecifies the description of the variable.-ExcludeSpecifies an array of items that this cmdlet excludes from the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as *.txt. Wildcards are permitted.-ForceAllows you to create a variable with the same name as an existing read-only variable, or to change the value of a read-only variable.
By default, you can overwrite a variable, unless the variable has an option value of ReadOnly or Constant. For more information, see the Option parameter.-IncludeSpecifies an array of items that this cmdlet includes in the operation. The value of this parameter qualifies the Name parameter. Enter a name or name pattern, such as c*. Wildcards are permitted.-NameSpecifies the variable name.-OptionSpecifies the value of the Options property of the variable.
Valid values are:
- None: Sets no options. (None is the default.)
- ReadOnly: Can be deleted. Cannot be changed, except by using the Force parameter.
- Constant: Cannot be deleted or changed. Constant is valid only when you are creating a
variable. You cannot change the options of an existing variable to Constant.
- Private: The variable is available only in the current scope.
- AllScope: The variable is copied to any new scopes that are created.
These values are defined as a flag-based enumeration. You can combine multiple values together to set multiple flags using this parameter. The values can be passed to the Option parameter as an array of values or as a comma-separated string of those values. The cmdlet will combine the values using a binary-OR operation. Passing values as an array is the simplest option and also allows you to use tab-completion on the values.-PassThruReturns an object representing the new variable. By default, this cmdlet does not generate any output.-ScopeSpecifies the scope of the variable.The acceptable values for this parameter are:
- Global
- Local
- Script
- Private
- A number relative 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.-ValueSpecifies the value of the variable.-VisibilityDetermines whether the variable is visible outside of the session in which it was created. This parameter is designed for use in scripts and commands that will be delivered to other users.
Valid values are:
- Public: The variable is visible. (Public is the default.)
- Private: The variable is not visible.
When a variable is private, it does not appear in lists of variables, such as those returned by Get-Variable, or in displays of the Variable: drive. Commands to read or change the value of a private variable return an error. However, the user can run commands that use a private variable if the commands were written in the session in which the variable was defined.-ConfirmPrompts you for confirmation before running the cmdlet.-WhatIfShows what would happen if the cmdlet runs. The cmdlet is not run.