> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell-universal/powershell-commands/new-psuvariable.md). # New-PSUVariable ## SYNOPSIS Creates a new variable in PSU. ## SYNTAX ### Value (Default) ``` New-PSUVariable -Name [-Value ] [-Type ] [-Description ] [-DisableRunAsSupport] [-Database] [-Role ] [-Force] [-Scope ] [-Tag ] [-PasswordNotRequired] [-ComputerName ] [-AppToken ] [-Credential ] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies] [] ``` ### Secret ``` New-PSUVariable -Name [-Value ] [-InputObject ] -Vault [-Type ] [-Description ] [-DisableRunAsSupport] [-Database] [-Role ] [-Force] [-Scope ] [-Tag ] [-PasswordNotRequired] [-ComputerName ] [-AppToken ] [-Credential ] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies] [] ``` ### InputObject ``` New-PSUVariable -Name [-InputObject ] [-Type ] [-Description ] [-DisableRunAsSupport] [-Database] [-Role ] [-Force] [-Scope ] [-Tag ] [-PasswordNotRequired] [-ComputerName ] [-AppToken ] [-Credential ] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies] [] ``` ## DESCRIPTION Creates a new variable in PSU. Variables are available in all scripts that run within PSU. ## EXAMPLES ### Example 1 ``` PS C:\> New-UAVariable -Name 'UserName' -Value 'Adam' ``` Creates a new variable in PSU named \`UserName\`. You can use the $UserName variable in all your scripts. ### Example 2 ``` PS C:\> New-UAVariable -Name 'UserName' -Value 'Adam' -Vault "Vault" ``` Creates a new variable in the vault named \`Vault\`. The variable's value is not stored in PSU and will only be retrieved when running scripts. ## PARAMETERS ### -AppToken An app token to access the PSU API. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ComputerName The HTTP address of the PSU REST API server. ```yaml Type: String Parameter Sets: (All) Aliases: Uri Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Description A description for this variable. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DisableRunAsSupport Prevents a credential from being used for Run As support. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InputObject An input object to store as a variable. ```yaml Type: Object Parameter Sets: Secret, InputObject Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Integrated Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Name The name of the variable. You can reference this in your scripts just as you would with other variables. ```yaml Type: String Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Type The .NET type of object . ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -UseDefaultCredentials Use default credentials when connecting to the management API ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Value The value of the variable. ```yaml Type: Object Parameter Sets: Value, Secret Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Vault The vault to store the variable within. ```yaml Type: String Parameter Sets: Secret Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Database Stores the variable value in the database. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Force Overwrites existing variables with the same name. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Role The roles that can access this variable. ```yaml Type: String[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Credential Credentials to login to the PowerShell Universal Management API. ```yaml Type: PSCredential Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Scope The variable scope for this variable. Global variable changes will cause resources to restart. Script scoped variables will not. ```yaml Type: VariableScope Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tag Tags for this variable. ```yaml Type: Tag[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TrustCertificate Whether the cmdlet should ignore certificate issues. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PasswordNotRequired Specifies that the password is not required for this variable. This is useful for accounts like Group Managed Service Accounts. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Cookies Reuses and persists authentication cookies for the current PowerShell session. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None ## OUTPUTS ### System.Object ## NOTES ## RELATED LINKS --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.devolutions.net/powershell-universal/powershell-commands/new-psuvariable.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.