< Back

Connect-vRAServer

Sat Jan 18, 2020 9:54 pm

NAME Connect-vRAServer



SYNOPSIS

Connect to a vRA Server





SYNTAX

Connect-vRAServer -Server <String> [-Tenant <String>] -Username <String> -Password <SecureString>

[-IgnoreCertRequirements] [-SslProtocol <String>] [<CommonParameters>]



Connect-vRAServer -Server <String> [-Tenant <String>] -Credential <PSCredential> [-IgnoreCertRequirements]

[-SslProtocol <String>] [<CommonParameters>]





DESCRIPTION

Connect to a vRA Server and generate a connection object with Servername, Token etc





PARAMETERS

-Server <String>

vRA Server to connect to



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Tenant <String>

Tenant to connect to



Required? false

Position? named

Default value vsphere.local

Accept pipeline input? false

Accept wildcard characters? false



-Username <String>

Username to connect with

For domain accounts ensure to specify the Username in the format username@domain, not Domain\\Username



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Password <SecureString>

Password to connect with



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>

Credential object to connect with

For domain accounts ensure to specify the Username in the format username@domain, not Domain\\Username



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-IgnoreCertRequirements [<SwitchParameter>]

Ignore requirements to use fully signed certificates



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-SslProtocol <String>

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

System.SecureString

Management.Automation.PSCredential

Switch





OUTPUTS

System.Management.Automation.PSObject.





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$cred = Get-Credential



Connect-vRAServer -Server vraappliance01.domain.local -Tenant Tenant01 -Credential $cred









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>$SecurePassword = ConvertTo-SecureString ???????P@ssword??????? -AsPlainText -Force



Connect-vRAServer -Server vraappliance01.domain.local -Tenant Tenant01 -Username TenantAdmin01 -Password

$SecurePassword -IgnoreCertRequirements











RELATED LINKS