Skip to content

Remove-UAVariable

SYNOPSIS

Removes a variable.

SYNTAX

Remove-UAVariable [-Variable] <Variable> [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
 [<CommonParameters>]

DESCRIPTION

Removes a variable. This also deletes the variable from the variables.psd1 file in the git repo.

EXAMPLES

Example 1

PS C:\> $Var = Get-UAVariable -Name 'username'
PS C:\> Remove-UAVariable -Variable $Var

Removes the username variable.

PARAMETERS

-AppToken

An app token to access the UA API.

Type: System.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 UA REST API server.

Type: System.String
Parameter Sets: (All)
Aliases: Uri

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

-Variable

The variable to remove. Use Get-UAVariable to retrieve a variable object.

Type: PowerShellUniversal.Variable
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-UseDefaultCredentials

Use default credentials when connecting to the management API

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

UniversalAutomation.Variable

OUTPUTS

System.Object

NOTES

Back to top