VMware vCloud actor adapter


The adapter requests for the actor adapter use a set of elements to execute a Representational State Transfer (REST) API call on vCloud. The set of elements used to make an API call is referred to as an operation.

You can use the information in this topic with the Call Adapter activity to create an adapter request. For detailed instructions about how to use the Call Adapter activity, see see Call-Adapter-activity and Creating-and-configuring-the-Call-Adapter-activity.

Supported operations

The actor adapter can perform the following categories of operations:

Adapter operations

Type of operation

Process name

Description

Catalog Management

Get Catalog Details

Retrieves the specified catalog and the list of associated catalog items

Catalog Management

Get Catalog Item Details

Retrieves the specified catalog item

Organization Management

Get Organization Details

Retrieves information about the specified organization

Organization Management

Get Organization List

Retrieves the list of the organizations to which the authenticated user has access

Organization Management

Create Organization

Creates an organization

Organization Management

Delete Organization

Removes an organization

Organization Management

Modify Organization

Updates an organization

vApp Access Management

Acquire vApp Access Control Information

Retrieves access control information for the specified vApp

vApp Access Management

Acquire vApp Screen Ticket

Retrieves a ticket that the client can use for opening a screen connection to the child vApp

vApp Configuration Management

Get vApp Template Configuration

Retrieves summary information about the specified vApp template configuration

vApp Configuration Management

Get vApp Configuration

Retrieves summary information about the specified vApp configuration

vApp Configuration Management

Instantiate vApp Template

Binds the abstract resource requirements specified in a template to specific resources in a cloud

vApp Configuration Management

Deploy vApp

Deploys an instantiated vApp in the target operating environment

vApp Configuration Management

Undeploy vApp

Releases resources reserved for the specified vApp and undeploys the vApp

vApp Configuration Management

Clone vApp

Clones a vApp with the same configuration as a specified vApp

vApp Configuration Management

Capture vApp

Creates a vApp template from an instantiated vApp
You must undeploy a vApp before you capture it.

vApp Configuration Management

Compose vApp

Composes a vApp from a specified combination of vApp templates, vApps, or virtual machines

vApp Configuration Management

Delete vApp

Deletes a vApp
You must power off and un-deploy a vApp before you delete it. This is a long-running operation and returns a new task that tracks the progress of the operation.

vApp Configuration Management

Update vApp Child VM Network Connection

Updates a vApp's child VM network connection

vApp State Management

Power On vApp

Powers on the specified virtual appliance (vApp)

vApp State Management

Power Off vApp

Powers off the specified vApp
This process does not attempt to shut down the vApp gracefully.

vApp State Management

Reset vApp

Resets the specified vApp

vApp State Management

Suspend vApp

Puts the specified vApp in the suspend mode

vApp State Management

Shutdown OS

Shuts down the guest Operating system (OS) gracefully

vApp State Management

Reboot OS

Shuts down and restarts the guest OS gracefully without powering off the vApp

vDC Management

Get vDC Details

Retrieves information about the virtual data center (vDC)
The retrieved information includes details about infrastructure services and details about the network, CPU, and memory resources.

Network Management

Get Organization Network Details

Fetches an administrative view of an organization's network

Network Management

Add Organization Network

Creates an organization network

Network Management

Modify Organization Network

Updates an organization network

Network Management

Delete Organization Network

Removes an organization network

Task Management

Get Task Status

Retrieves the contents (status, owner, and so on) of an individual task

Task Management

Get Task List

Retrieves a list of all the tasks owned by an organization

Template Management

Clone vApp Template

Clones a vApp template

Template Management

Get vApp Template OVF Descriptor

Retrieves a vApp template's Open Virtualization Format (OVF) descriptor

Template Management

Import OVF As vApp Template

Creates a vApp template from an OVF package

Template Management

Delete vApp Template

Deletes a vApp template

Template Management

Export vApp Template As OVF

Downlaods a vApp Template as an OVF package

VM Management

Get VM Network Connection

Retrieves the network connection details of a specified VM

VM Management

Update VM Network Connection

Modifies the network connection details of a specified VM

VM Management

Get VM Guest Customization Section

Retrieves the details of the guest customization section of a specified VM

VM Management

Get VM Operating System Section

Retrieves the details of the operating system section of a specified VM

VM Management

Get VM CPU Configuration

Retrieves the CPU configuration details of a specified VM

VM Management

Get VM Virtual Hardware Section

Retrieves the virtual hardware section details of a specified VM

VM Management

Get VM Memory Item from Virtual Hardware Section

Retrieves the memory item details from the virtual hardware section of a specified VM

VM Management

Update VM Guest Customization Section

Modifies the guest customization section details of a specified VM

VM Management

Update VM Operating System Section

Modifies the operating system section details of a specified VM

VM Management

Update VM CPU Configuration

Modifies the CPU configuration details of a specified VM

VM Management

Update VM Memory Item

Modifies the details of a memory item within the virtual hardware section of the specified VM

VM Management

Get Network Card Items

Retrieves the network card items details from the virtual hardware section of the specified VM

VM Management

Get VM Virtual Disk Items

Retrieves the virtual disk items details from the virtual hardware section of the specified VM

VM Management

Get VM Removable Media Drive Items

Retrieves the details of the removable media drive items from the specified VM

 

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

TrueSight Orchestration Content 20.19.01