< Back

Connect-VCAV

Sat Jan 18, 2020 9:52 pm

NAME Connect-VCAV



SYNOPSIS

Connect-VCAV makes a connection to the vCloud Availability (VCAV) 3.0 API





SYNTAX

Connect-VCAV [-VCAVHost] <String> [[-VCDHost] <String>] [<CommonParameters>]





DESCRIPTION

Connect-VCAV uses the session secret of an existing vCloud Director

connection (obtained from Connect-CIServer). If more that one vCloud Director

connection exists both the VCAV host and VCD host must be specified. The VCAV

session is persisted in session variables for use by other commands in this

module (e.g. Invoke-VCAVQuery).





PARAMETERS

-VCAVHost <String>

A required parameter containing the API endpoint for the vCloud Availability

service, typically this will be the public URI for the VCAV service.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-VCDHost <String>

The API endpoint for vCloud Director, typically this will be the public URI for

the vCloud Director instance. This parameter is required if multiple vCD API

endpoints are currently connected, otherwise it is optional.



Required? false

Position? 2

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



OUTPUTS

A status message (success or failure) is given for the connection attempt.





NOTES





If more than one vCD environment is currently connected (Connect-CIServer), the

host name specified for the VCDHost must match the name used when the original

Connect-CIServer command was issued so that the correct session can be located

in the $Global:DefaultCIServers array.



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



PS C:\\>Connect-VCAV -VCAVHost 'myvcav.cloud.com' -VCDHost 'myvcd.cloud.com'















RELATED LINKS