VIS actor adapter requests and responses

The adapter requests for the actor adapter uses a set of elements, operation-type and operation-name, in the adapter request node to execute an API call. The set of values used to make each 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 Call Adapter activity and Creating and configuring the Call Adapter activity.

The adapter can perform the following categories of operations:

  • Basic VM operations
  • Basic VApp operations
  • Advanced VM operations
  • Configure VM operations
  • Monitor VM operations
  • Host operations
  • Datastore operations
  • Cluster operations
  • Datacenter operations
  • Folder operations
  • Discovery operations
  • Resource Pool operations
  • VApp Configuration operations
 Adapter operations for VMware Infrastructure

Operation Type

Sub-folder
(if applicable)

Operation name

Description

Basic_Vm

Power_On_VM

Powers on the virtual machine and boots the guest OS, if the guest OS is installed

Basic_Vm

Power_Off_VM

Powers off the virtual machine
The virtual machine does not attempt to shut down the guest operating system (OS) gracefully.

Basic_Vm

Suspend_VM

Pauses the virtual machine activity
All transactions are frozen until the virtual machine gets a Resume command.

Basic_Vm

Resume_VM

Allows virtual machine activity to continue when the virtual machine is in suspended state

Basic_Vm

Reset_VM

Shuts down and restarts the guest OS

Basic_Vm

Shut_Down_Guest_OS

Shuts down the guest OS gracefully

Basic_Vm

Restart_Guest_OS

Shuts down and restarts the guest OS without powering off the virtual machine

Basic_VApp

Power_On_VApp

Starts the specified vApp

Basic_VApp

Power_Off_VApp

Stops the specified vApp

Basic_VApp

Unregister_VApp

Removes the vApp from the inventory without removing any of the files associated with the relevant virtual machines from the disk

Advanced_Vm

Create_VM_Snapshot

Creates a snapshot of the specified virtual machine

Advanced_Vm

Revert_VM_Snapshot

Reverts the current virtual machine to a specified snapshot

Advanced_Vm

Move_Virtual_Disk

Relocates the virtual disks of a virtual machine to the specific location

Advanced_VM

Validate_VM_Migration

Checks the validity of proposed VM migration before conducting the actual migration

Advanced_Vm

Migrate_VM

Migrates a virtual machine execution to a specific resource pool or host

Advanced_Vm

Relocate_VM

Relocates the virtual disks for a virtual machine to a specified location
You can also use this operation to move a virtual machine to a different datastore or a different host.

Advanced_Vm

Acquire_Mks_Ticket

Creates and returns a one-time usable credential for establishing a remote mouse-keyboard-screen connection to the specified virtual machine

Advanced_Vm

Retrieve_VM_File_Info

Returns details about the files that match the specified search criteria

Advanced_Vm

Update_VM_Snapshot

Updates the name and description of the snapshot

Advanced_Vm

Delete_VM_Snapshot

Removes the specified snapshot and deletes any storage associated with the snapshot.

Configure_VM

Create_VM

Creates a new virtual machine with specified configuration parameters

Configure_VM

Create_VM_With_Custom_Settings

Creates a new virtual machine with advanced configuration options
This operation enables you to add virtual devices like a hard disk or an ethernet card while creating the virtual machine.

Configure_VM

Clone_VM

Clones a VM with the same configuration as the specified virtual machine
This operation can also be used to clone a VM into a template.

Configure_VM

Clone_VM_With_Custom_Settings

Clones a virtual machine with advanced configuration options
This operation can also be used to clone a virtual machine into a template. This operation enables you to add additional virtual devices such as a hard disk or an ethernet card to the cloned virtual machine.

Configure_VM

Add Hardware

Add_Hard_Disk

Adds a virtual disk on the specified virtual machine

Configure_VM

Add Hardware

Add_Ethernet_Adapter

Adds an ethernet adapter to the specified virtual machine

Configure_VM

Add Hardware

Add_CD_ROM

Adds the specified CD-ROM device to the specified virtual machine

Configure_VM

Retrieve_VM_Configuration

Retrieves the specified virtual machine configuration parameters

Configure_VM

Retrieve Hardware

Retrieve_CPU_Configuration

Retrieves the configuration details of the CPU for the specified virtual machine

Configure_VM

Retrieve Hardware

Retrieve_Memory_Configuration

Retrieves the memory configuration details for the specified virtual machine

Configure_VM

Retrieve Hardware

Retrieve_Hard_Disk_Configuration

Retrieves the configuration details of the hard disk for the specified virtual machine

Configure_VM

Retrieve Hardware

Retrieve_Ethernet_Adapter_Configuration

Retrieves the configuration details of the ethernet adapter for the specified virtual machine

Configure_VM

Retrieve Hardware

Retrieve_CD_ROM_Configuration

Retrieves the configuration of a CD-ROM device for the specified virtual machine

Configure_VM

Update_VM_Configuration

Modifies one or more configuration parameters for a virtual machine
This operation can be used to add or remove a hard disk, CD-ROM, or an ethernet adapter from a virtual machine.

Configure_VM

Update Hardware

Update_CD_ROM_Configuration

Attaches a previously uploaded ISO file to the specified CD or the DVD drive

Configure_VM

Update Hardware

Update_CPU_Configuration

Modifies the CPU configuration of a virtual machine
This operation can modify the CPU configuration of a virtual machine, even if the machine is in the Power On or the Suspended state.

Configure_VM

Update Hardware

Update_Memory_Configuration

Modifies the memory configuration of a virtual machine.
This operation can modify the virtual machine's memory configuration, even if the machine is in the Power On or the Suspended state.

Configure_VM

Update Hardware

Update_Ethernet_Adapter_Configuration

Modifies the ethernet adapter configuration on a virtual machine
This operation can modify the virtual machine's ethernet adapter configuration, even if the machine is in the Power On or the Suspended state.

Configure_VM

Update Hardware

Update_Hard_Disk_Configuration

Enables you to increase the size of the hard disk attached to a virtual machine
This operation can also update the disk shares information.

Configure_VM

Delete_VM

Deletes the specified virtual machine

Configure_VM

Export_VM_As_OVF_Template

Exports the specified virtual machine as an OVF template and downloads the files associated with the VM entity

Configure_VM

Import_OVF_Template_As_VM

Creates a new virtual machine in the resource pool based on the specified OVF descriptor

Configure_VM

Remove Hardware

Remove_Ethernet_Adapter

Removes the specified ethernet adapter from a virtual machine
This operation must be performed only when the virtual machine is in the Powered Off state.

Configure_VM

Remove Hardware

Remove_Hard_Disk

Removes the specified virtual disk from a virtual machine

Configure_VM

Remove Hardware

Remove_CD_ROM

Removes the specified CD_ROM device from a virtual machine

Monitor_Vm

Retrieve_Task_Status

Retrieves the status of a specific task performed on a virtual machine by task ID

Monitor_Vm

Retrieve_VM_Alarm_List

Retrieves the list of alarms, including their state, for the specified virtual machine

Monitor_Vm

Retrieve_VM_CPU_Usage

Retrieves the CPU usage for the last collection interval from the specified virtual machine
The returned results are for average, minimum, and maximum, and are expressed in 0.01% percentage points (value is from 0 to 10,000).

Monitor_Vm

Retrieve_VM_Disk_Usage

Retrieves the sum of the data read and written for all disk instances of the host or virtual machine
Results returned are for average, minimum, and maximum, and expressed in Kbps.

Monitor_Vm

Retrieve_VM_Memory Usage

Retrieves the current memory in use for the specified virtual machine
Results returned are for average, minimum, and maximum, and are expressed in 0.01% percentage points (value is from 0 to 10,000).

Monitor_Vm

Delete_VM_Alarm

Removes the alarm from the list of alarms affecting the specified virtual machine

Monitor_Vm

Retrieve_VM_Network Usage

Retrieves the sum of data transmitted and received for all the NIC instances of the specified virtual machine

Monitor_Vm

Retrieve_VM_Status

Retrieves the operating status for the specified virtual machine

Host

Add_Host_To_Cluster

Adds an ESX server to a specified cluster on the VMware Virtual Center
The hostname provided should be a DNS resolvable name.
For example, host1.domain1.com

Host

Create_Host

Adds an ESX server to the VMware Virtual Center
The name of the host must be specified as a string.

Host

Add Networking Hardware

Add_Virtual_Switch

Updates the configuration of the host network to add a virtual switch

Host

Update Networking Hardware

Update_Virtual_Switch

Updates the configuration of the host network to update a virtual switch

Host

Add Networking Hardware

Add_Virtual_NIC

Updates the configuration of the host network to add a virtual NIC

Host

Update Networking Hardware

Update_Virtual_NIC

Updates the configuration of the host network to update a virtual NIC

Host

Add Networking Hardware

Add_Port_Group

Updates the configuration of the host network to add a port group

Host

Update Networking Hardware

Update_Port_Group

Updates the configuration of the host network to update a port group

Host

Add_NAS_Datastore

Creates a new storage datastore attached to the network

Host

Add_Vmfs_Datastore

Adds a new VMFS datastore to an ESX Server.

Host

Add_Internet_Scsi_Send_Targets

Adds Send Target entries to the host bus adapter discovery list.

Host

Move_Host_To Cluster

Moves the specified host into a specified cluster
The host must be part of the same datacenter, and if the host is part of a cluster, the host must be in maintenance mode.

Host

Retrieve_Host_Configuration

Retrieves the configuration details of the host computer including allocated and utilized CPU and memory

Host

Retrieve_Host_DVS_Configuration

Retrieves the DV Switch and DV Portgroup configured on the specified ESX host

Host

Retrieve_Host_ Network_Configuration

Retrieves the host network configuration details including details about the virtual switch, virtual NIC, and port group

Host

Retrieve_Host_Datastore_Configuration

Retrieves the configuration details of the host datastore

Host

Retrieve Networking Hardware

Retrieve_Virtual_Switch_Configuration

Retrieves the configuration details of the host network virtual switch

Host

Retrieve Networking Hardware

Retrieve_Virtual_NIC_Configuration

Retrieves the configuration details of the host network virtual NIC

Host

Retrieve Networking Hardware

Retrieve_Port_Group_Configuration

Retrieves the configuration details of the host network port group

Host

Retrieve_Available_Disks_For_Vmfs

Retrieves a list of disks that can be used to contain new VMFS datastores

Host

Retrieve_Host_CPU_Usage

Retrieves CPU information and current CPU usage on the specified host system

Host

Retrieve_Host_Memory_Usage

Retrieves the memory size and current memory usage for the specified host system

Host

Retrieve_ESX_Hosts

Retrieves the known ESX hosts and configuration on a VMware VirtualCenter, filtered by the specified cluster

Host

Retrieve_Host_Scsi_Topology

Retrieves the storage topology of SCSI storage devices for the specified host
This topology view organizes objects by SCSI interface, which contain targets, which in turn contain logical units.

Host

Rescan_Hba

Issues a request for rescanning the specified host bus adapter on an ESX Server to detect new storage devices

Host

Rescan_All_Hba

Issues a request to rescan all host bus adapters on a ESX server for detecting new storage devices

Host

Update_Host_Network_Configuration

Updates the network configuration of a host

Host

Extend_Vmfs_Datastore

Extends an existing VMFS datastore

Host

Update_Software_Internet_Scsi_Enabled

Enables or disables an Internet SCSI

Host

Update_Internet_Scsi_Name

Updates the name of an Internet SCSI host bus adapter

Host

Remove_Host_From Cluster

Removes a host from a cluster and makes it a standalone host

Host

Remove Networking Hardware

Remove_ Virtual_ Switch

Updates the configuration of the host network to remove a virtual switch

Host

Remove Networking Hardware

Remove_ Virtual_ NIC

Updates the configuration of the host network to remove a virtual NIC

Host

Remove Networking Hardware

Remove_ Port_ Group

Updates the configuration of the host network to remove a port group

Host

Remove_Datastore

Removes a datastore from a host system

Host

Enter_Maintenance_Mode

Puts the specified host in the maintenance mode

Host

Exit_Maintenance_Mode

Takes the specified host out of the maintenance mode

Datastore

Retrieve_Datastore_List


Retrieves a list of datastores on a datacenter including information about the total space and free space available on each datastore

Datastore

Retrieve_Datastore_Virtual Machines

Retrieves a list of all virtual machines registered on the specified datastore

Datastore

Retrieve_Vmfs_Datstore_Storage_Controller

Retrieves the volume information for the specified VMFS datastore and corresponding SCSI transport information about the target

Cluster

Retrieve_Cluster_Configuration

Retrieves the configuration details for a cluster including DRS settings

Cluster

Retrieve_Cluster_Datastore_Configuration

Retrieves the configuration details for a datastore of the cluster including total space and free space.

Cluster

Retrieve_Clusters

Retrieves all known clusters and configuration on a VMware VirtualCenter

Cluster

Retrieve_Cluster_Virtual_Machines

Retrieves the list of virtual machines in a cluster

Datacenter

Retrieve_Datacenters

Retrieves the known datacenters and configuration on a VMware VirtualCenter.

Folder

Create_Folder

Creates a sub-folder within a folder, with the specified name

Folder

Retrieve_Folders

Retrieves all the folders and the corresponding configuration on a VMware VirtualCenter, filtered by datacenter

Folder

Destroy_Folder

Destroys the specified folder object by deleting the contents of the folder and removing the folder from the parent folder, if the parent folder exists

Folder

Move_Into_Folder

Moves a set of managed entities into a specified folder

Discovery

Retrieve_MOB_Reference_By_Display_Name

Retrieves the Managed Object Reference for a VMware Infrastructure element using the display name

Discovery

Retrieve_Display_Name_By_MOB_Reference

Retrieves the display name, type, and the datacenter name of a VMware Infrastructure element using the Managed Object Reference of the element

ResourcePool

Retrieve_Resource_Pool_Children

Retrieves a list of all child resource pools associated with the specified resource pool

ResourcePool

Create_Resource_Pool

Creates a resource pool with the specified configuration

ResourcePool

Destroy_Resource_Pool

Destroys a resource pool object and its contents, and removes the object from its parent folder

ResourcePool

Destroy_Resource_Pool_Children

Removes all child resource pools recursively

ResourcePool

Move_Into_Resource_Pool

Moves a set of resource pools, vApps, or VMs into the specified pool

Configure_VApp

Export_VApp_As_OVF_Template

Exports the specified VApp as an OVF template and downloads the files that are associated with the VApp entity

Configure_VApp

Import_OVF_Template_As_VApp

Creates a new VApp in the resource pool based on the specified OVF descriptor

Configure_VApp

Create_VApp

Creates a new vApp container

Configure_VApp

Clone_VApp

Creates a new VApp container from the specified VApp

Configure_VApp

Update_VApp_Configuration

Updates the configuration of the specified vApp

Note

To override the default adapter configuration, you must specify the required arguments in the adapter requests.
The Basic VApp and the Configure VApp operations are supported with VMware vSphere 4.0.

Was this page helpful? Yes No Submitting... Thank you

Comments