Connect-vRAServer
SYNOPSIS
Connect to a vRA Server
SYNTAX
Username (Default)
Connect-vRAServer -Server <String> -Username <String> -Password <SecureString> [-IgnoreCertRequirements]
[-SslProtocol <String>] [<CommonParameters>]
Credential
Connect-vRAServer -Server <String> -Credential <PSCredential> [-IgnoreCertRequirements] [-SslProtocol <String>]
[<CommonParameters>]
APIToken
Connect-vRAServer -Server <String> -APIToken <String> [-IgnoreCertRequirements] [-SslProtocol <String>]
[<CommonParameters>]
DESCRIPTION
Connect to a vRA Server and generate a connection object with Servername, Token etc
EXAMPLES
EXAMPLE 1
$cred = Get-Credential
Connect-vRAServer -Server vraappliance01.domain.local -Credential $cred
EXAMPLE 2
$SecurePassword = ConvertTo-SecureString "P@ssword" -AsPlainText -Force
Connect-vRAServer -Server vraappliance01.domain.local -Username TenantAdmin01@domain.com -Password $SecurePassword -IgnoreCertRequirements
EXAMPLE 3
Connect-vRAServer -Server api.mgmt.cloud.vmware.com -APIToken 'CuIKrjQgI6htiyRgIyd0ZtQM91fqg6AQyQhwPFJYgzBsaIKxKcWHLAGk81kknulQ'
EXAMPLE 4
Connect-vRAServer -Server vraappliance01.domain.local -APIToken 'CuIKrjQgI6htiyRgIyd0ZtQM91fqg6AQyQhwPFJYgzBsaIKxKcWHLAGk81kknulQ' -IgnoreCertRequirements
PARAMETERS
-Server
vRA Server to connect to
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Username
Username to connect with For domain accounts ensure to specify the Username in the format username@domain, not Domain\Username
Type: String
Parameter Sets: Username
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Password
Password to connect with
Type: SecureString
Parameter Sets: Username
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Credential
Credential object to connect with For domain accounts ensure to specify the Username in the format username@domain, not Domain\Username
Type: PSCredential
Parameter Sets: Credential
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-APIToken
API Token to connect with
Type: String
Parameter Sets: APIToken
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IgnoreCertRequirements
Ignore requirements to use fully signed certificates
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-SslProtocol
Alternative Ssl protocol to use from the default Requires vRA 7.x and above Windows PowerShell: Ssl3, Tls, Tls11, Tls12 PowerShell Core: Tls, Tls11, Tls12
Type: String
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, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.