Skip to content

Establishing a connection to AUCloud platform via PowerCLI


VMware PowerCLI is a Microsoft PowerShell based command line interface tool which was developed by VMware to manage and automate tasks on various VMware platforms such as vSphere, VMware Cloud Director, Horizon, etc.

The latest version of PowerCLI is available from the VMware website.

If your system has connection to the internet, you can perform the following to install the PowerCLI module:

> Install-Module VMware.PowerCLI -Scope CurrentUser

To connect to the AUCloud platform via PowerCLI, you need the API-URL, Org-ID, and User-ID which can be found by:

  1. Logging into the AUCloud Portal
  2. Selecting API Management under your User ICON in the top right menu
  3. Select the Cloud Services tab.

Below are screenshots for details:
API Management

VMware Cloud Director Doc

The API Url is listed in https://<address\> format and the Username is listed in User-Id_@_Org-Id format.


There are two methods to authenticate with VMware Cloud Director using PowerCLI: username/password or session token. Both methods are discussed in this document.

To establish a connection to AUCloud platform via username and password, perform the following command:

> Connect-CIServer -Server <API-Url> \-org <Org-Id> \-User <User-Id> \-Password <Portal\_Password>


API-Url : remove https:// from the API Url listed on the AUCloud Portal API

User-Id : enter the User-Id without @Org-Id

Org-Id : enter the Org-Id listed under username

To establish a connection to the AUCloud platform via session token, first, a session token must be generated. This can be achieved using the following PowerShell module :

$Global:Authorization = ""

$Global:Accept = "application/*+xml;version=36.3"

$Global:xvCloudAuthorization = ""

Function New-CloudToken($Username,$Password,$URL)


    $Pair = "$($Username):$($Password)"

    $Bytes = [System.Text.Encoding]::ASCII.GetBytes($Pair)

    $Base64 = [System.Convert]::ToBase64String($Bytes)

    $Global:Authorization = "Basic $base64"

    $headers = @{ Authorization = $Global:Authorization; Accept = $Global:Accept}

    $Res = Invoke-WebRequest -Method Post -Headers $headers -Uri "https://$($URL)/api/sessions"

    $Global:Server = $($URL)

    $Global:SessionID = $res.headers["X-Vcloud-Authorization"]

    Write-Output "$SessionID"

    Write-Output "$Server"


To use the above module, copy and paste the above code into a local file named New-CloudToken.psm1. Then in a new PowerShell window, enter the following command :

> Import-Module <Path to .psm1 file>


The above command imports the module for the current session only.

To import the module for all sessions, update your PowerShell profile to include the above command as documented by Microsoft.

Using the username (including the Org-ID) and the API-URL copied from the Portal earlier, along with your Portal Password, generate a new Session Token using the imported module :

> New-CloudToken -User <User-Id@Org-Id> \-Password <Portal\_Password> \-Server <API-Url>


API-Url :  remove https:// from the API URL listed on the AUCloud Portal API

User-Id :  enter the User-Id including @Org-Id

A new session token, along with the API-URL will be the output of this command :

Output Example

In the example above, "71337106a838432097fbf78d869194e6" is the Session-Token and "" is the API-URL.

Using this information, you can then establish a connection to the AUCloud platform by performing the following command.

> Connect-CIServer -Server <API-URL> -Session <Session-Token>

Once connected, you can start using PowerCLI commands to retrieve information/manage the ecosystem within your vDC Organisation. To verify that you have logged in to the environment successfully, you can perform a simple command line to retrieve all VMs in your tenancy by running the command below :

> Get-CIVM

Example of the output:

Output Example