Skip to content

Request-vRAToken

Synopsis

Connects to the specified VMware Aria Automation and obtains authorization token

Syntax

Request-vRAToken [-fqdn] <String> [-username] <String> [-password] <String> [[-tenant] <String>]
 [-displayToken] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

The Request-vRAToken cmdlet connects to the specified VMware Aria Automation and obtains an authorization token. It is required once per session before running all other cmdlets.

Examples

Example 1

Request-vRAToken -fqdn xint-vra01.rainpole.io -username configadmin -password VMware1!

This example shows how to connect to the VMware Aria Automation appliance

Example 2

Request-vRAToken -fqdn xint-vra01.rainpole.io -username configadmin -password VMware1! -displayToken

This example shows how to connect to the VMware Aria Automation appliance and display the token needed for Terraform.

Parameters

-fqdn

The fully qualified domain name of the VMware Aria Automation appliance.

Type: String
Parameter Sets: (All)
Aliases:

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

-username

The username to connect to the VMware Aria Automation appliance.

Type: String
Parameter Sets: (All)
Aliases:

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

-password

The password to connect to the VMware Aria Automation appliance.

Type: String
Parameter Sets: (All)
Aliases:

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

-tenant

The tenant to connect to the VMware Aria Automation appliance.

Type: String
Parameter Sets: (All)
Aliases:

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

-displayToken

Displays the token needed for Terraform

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ProgressAction

Progress Action

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

Common Parameters

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