Module for the VMware vCloud adapter


This section provides information about the VMware vCloud application adapter module. Each command supported by the application adapter has a corresponding process in the adapter module. Top-level processes perform high-level functions and call specialized processes in subdirectories. Each subdirectory contains process directories that correspond to the operation types for that command.

Top-level processes

The top-level processes perform high-level functions and call specialized processes in the subdirectories of the v1.0 directory.

The top-level processes in the Project Explorer window execute the following version-specific vCloud processes:

  • Delete Items 
  • Perform Operations 
  • Retrieve Items 
  • Update Items

The following table describes the elements for the top-level processes.

Elements for the top-level processes

Element

Definition

Required

<adapter name>

Specifies the name of the adapter

No

<items>

Contains the <item> XML elements used to perform an operation in VMware vCloud

Yes

<version>

Specifies the current supported version of VMware vCloud software

Yes

<item type>

Specifies the operation name for the process that you want to execute

Yes

<connection parameters>

Contains the following elements needed for the adapter to connect to the target:

  • <vcloud-organization>
  • <user-name>
  • <password>

No

Setup_Validation directory

The processes in the Setup_Validation directory contain sample values for the request elements. These sample values can be quickly changed to reflect the values in your environment. A process is provided to test each supported method of executing operations in vCloud.

Utilities directory

The Utilities directory contains constructor processes that create the XML inputs used in version-specific processes. The functional processes require complex XML inputs. You can generate these complex XML inputs by using the constructor processes.

The constructor processes are organized into general utilities and subdirectories that correspond to the supported operation types.

Version directory

The v1.0 directory contains functional processes specific to vCloud. A process is available for each supported operation. Processes are grouped in subdirectories based on the type of the operation.

The following table shows the mapping between processes and operation names.

Mapping between processes and operation names

Process name

Operation name

Catalog Management operations

 

Get Catalog Details

Get_Catalog_Details

Get Catalog Item Details

Get_Catalog_Item_Details

Organization Management operations

 

Get Organization Details

Get_Organization_Details

Get Organization List

Get_Organization_List

Create Organization

Create_Organization

Delete Organization

Delete_Organization

Modify Organization

Modify_Organization

vApp Access Management operations

 

Acquire vApp Access Control Information

Acquire_vApp_Access _Control_Information

Acquire vApp Screen Ticket

Acquire_vApp_Screen_Ticket

vApp Configuration Management operations

 

Get vApp Template Configuration

Get_vApp_Template_Configuration

Get vApp Configuration

Get_vApp_Configuration

Instantiate vApp Template

Instantiate_vApp_Template

Deploy vApp

Deploy_vApp

Undeploy vApp

Undeploy_vApp

Clone vApp

Clone_vApp

Capture vApp

Capture_vApp

Compose vApp

Compose_vApp

Delete vApp

Delete_vApp

Update vApp Child VM Network Connection

Update_vApp_Child_VM_Network_Connection

vApp State Management operations

 

Power On vApp

Power_On_vApp

Power Off vApp

Power_Off_vApp

Reset vApp

Reset_vApp

Suspend vApp

Suspend_vApp

Shutdown OS

Shutdown_OS

Reboot OS

Reboot_OS

vDC Management operation

 

Get vDC Details

Get_vDC_Details

Network Management operations

 

Get Organization Network Details

Get_Organization_Network_Details

Add Organization Network

Add_Organization_Network

Modify Organization Network

Modify_Organization_Network

Delete Organization Network

Delete_Organization_Network

Task Management operations

 

Get Task Status

Get_Task_Status

Get Task List

Get_Task_List

Template Management operations

 

Clone vApp Template

Clone_vApp_Template

Get vApp Template OVF Descriptor

Get_vApp_Template_Ovf_Descriptor

Import OVF As vApp Template

Import_Ovf_As_vApp_Template

Delete vApp Template

Delete_vApp_Template

Export vApp Template As OVF

Export_vApp_Template_As_Ovf

VM Management operations

 

Get VM Network Connection

Get_VM_Network_Connection

Update VM Network Connection

Update_VM_Network_Connection

Get VM Guest Customization Section

Get_VM_Guest_Customization_Section

Get VM Operating System Section

Get_VM_Operating_System_Section

Get VM CPU Configuration

Get_VM_CPU_Configuration

Get VM Virtual Hardware Section

Get_VM_Virtual_Hardware_Section

Get VM Memory Item from Virtual Hardware Section

Get_VM_Memory_Item_From_Virtual_Hardware_Section

Update VM Guest Customization Section

Update_VM_Guest_Customization_Section

Update VM Operating System Section

Update_VM_Operating_System_Section

Update VM CPU Configuration

Update_VM_CPU_Configuration

Update VM Memory Item

Update_VM_Memory_Item

Get Network Card Items from the Virtual Hardware Section

Get_VM_Network_Card_Items

Get Virtual Disk Items from the Virtual Hardware Section

Get_VM_Virtual_Disk_Items

Get VM Removable Media Drive Items

Get_VM_Removable_Media_Drive_Items

Process inputs

The following table describes the input elements used by a process in the adapter module:

Process input elements

Inputs

Description

Required

<adapter name>

Specifies the name of the adapter that handles the request

No

<items>

Contains the <item> XML elements used to execute the process

Yes

<connection parameters>

Contains the elements needed for the adapter to connect to the target
The <connection parameters> element contains the following elements:

  • <vcloud-organization>
  • <user-name>
  • <password>

No

The following table describes the <connection parameters> elements used by a process in the adapter module:

<connection parameters> elements

Inputs

Description

Required

<vcloud-organization>

Specifies the name of the vCloud organization

Conditional:

  • Required in the request if not specified in the configuration
  • If used, requires <user-name> and <password>
<user-name>

Specifies the user name required for basic HTTP authentication on vCloud

Conditional:

  • Required in the request if not specified in the configuration
  • If used, requires <vcloud-organization> and <password>
<password>

Specifies the password corresponding to the specified user name

Conditional:

  • Required in the request if not specified in the configuration
  • If used, requires <vcloud-organization> and <user-name>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 20.19.01