Setup


 

Setup Guide

This setup guide is a step-by-step explanation for getting the VMware Agent ready to use. The setup consists of the following steps:

  1. Welcome
  2. Connect to a vCenter Server
  3. Customers in vCenter
  4. Connect to a vCloud Director
  5. Customers in vCloud Director
  6. Connect to CloudBilling
  7. Application Settings
  8. Complete

1. Welcome

The welcome page is the first page the user will see after opening the VMware Agent for the first time (see figure 1). It explains that the user will be walked through the setup process.

Click "Next".

 
Figure 1: The Welcome screen.

Top


2. Connect to a vCenter Server

This step is to set up a connection with a vCenter Server, which will allow the user to map customers to virtual machine folders (see figure 2). Connecting to a vCenter Server is done by filling in the following fields:

  • Name: A name for the service
  • Url: The url of the vCenter Service (versions: 5.1 - 5.5). Format: "https://Hostname/sdk" Example: "https://10.10.10.10/sdk"
  • Username: The username that will be used to connect to the service. The user must have admin rights. Format: "Domain\Username" Example: "mydomain\john"
  • Password: The password that will be used to connect to the service.
  • Connection: Test to see if a successful connection can be made.

When done, click "Next".

Alternatively, this step can be skipped. A connection can be added later via the Services menu option. To skip, leave the fields empty and click "Next".

 
Figure 2: The Connect to a vCenter Server screen.

Top


3. Customers in vCenter Server

In this step, mappings between customers in CloudBilling and Virtual Machine folders in vCenter will be added (see figure 4).

  • Add a customer
    1. Click "Add". A new row will appear in the table.
    2. Double-click the empty cell in column "Customer Code" and fill in the code of the customer in CloudBilling. This code will appear on the purchases.
    3. Double-click the empty cell in column "Virtual Machine Folder". On the right side of the row, a button with "..." will show. This is the select button. Click this button. Select a folder and click "Ok". See figure 3.
      OR
      Double-click the empty cell in column "Virtual Machine Folder". Type in the directory of the folder manually.
  • Delete a customer
    1. Select an existing row by clicking on it. Or, select multiple rows by holding in the mouse button and dragging.
    2. Click "Delete".

When done, click "Next".

 
Figure 3: Adding a customer to vCenter Server.
 
Figure 4: The added customers in vCenter Server.

Top


4. Connect to a vCloud Director

This step is to set up a connection with a vCloud Director service, which will allow the user to map customers to organizations (see figure 5). Connecting to a vCloud Director service is done by filling in the following fields:

  • Name: A name for the service
  • Url: The url of the vCloud Director service (versions: 5.1 - 5.5). Format: "https://Hostname" Example: "https://10.10.10.10"
  • Username: The username that will be used to connect to the service. The user must have admin rights. Format: "Username@system" Example: "john@system"
  • Password: The password that will be used to connect to the service.
  • Connection: Test to see if a successful connection can be made.

When done, click "Next".

Alternatively this step can be skipped. A connection can be added later via the Services menu option. To skip, leave the fields empty and click "Next".

 
Figure 5: The Connect to a vCloud Director screen.

Top


5. Customers in vCloud Director

 

In this step, mappings between customers in CloudBilling and organisations in vCloud Director will be added (see figure 7).

  • Add a customer
    1. Click "Add". A new row in the table will show.
    2. Double-click the empty cell in column "Customer Code" and fill in a Customer Code (this will appear on the purchase).
    3. Double-click the empty cell in column "Organisation". On the right side of the row, a button with "..." will show. This is the select button. Click this button. Select an organisation and click "Ok". See figure 6.
      OR
      Double-click the empty cell in column "Organisation". Fill in the organisation manually.
  • Delete a customer
    1. Select an existing row by clicking on it. Or, select multiple rows by holding in the mouse button and dragging.
    2. Click "Delete".

When done, click "Next".

 
Figure 6: Adding a customer to vCloud Director.
 
Figure 7: The added customers in vCloud Director.

Top


6. Connect to CloudBilling

This step is to set up a connection with CloudBilling, which will allow purchases to be sent through to CloudBilling (see figure 8). Connecting to CloudBilling is done by filling in the following fields:

  • Name: A name for the service
  • Url: The url of the CloudBilling service (Version:V1_0). Format: "https://Hostname/ServiceEndpoint" Example: "https://api.billing.inter8.co/Kolonel.Public.Service.API.APIServiceEndpoint.svc"
  • Username: The username that will be used to connect to the service.
  • Password: The password that will be used to connect to the service.
  • Connection: Test to see if a successful connection can be made.

When done, click "Next".

 
Figure 8: The Connect to CloudBilling screen.

Top


7. Application Settings

 

These are general settings of the application (see figure 9).

  • Notification Settings
    • ​To: The email address that notifications will be sent to.
    • Host: The hostname or ip address of the SMTP server.
    • Port: The port of the SMTP server.
    • Username: The username required by the SMTP server.
    • Password: The password required by the SMTP server.
    • Ssl: Indicates if SSL required by the SMTP server.
  • Login
    These settings allow a login to be specified to secure the agent management UI. That is, the next time the agent management UI (this application) is started, it will prompt for a username and password. These can be specified here.
    • ​​Username: The username that is used to login.
    • Password: The password that is used to login.

When done, click "Next".

 
Figure 9: The Application Settings screen.

Top


8. Complete

This is the last page of the setup process (see figure 10). It gives an overview of the settings that have been entered by the user.

To save the settings and complete the setup guide, click "Finish". The user will now be directed to the Dashboard.

To go back and change settings, click "Previous".

 
Figure 10: An overview of everything that has been set up.

Top