Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

Adapter operation to VIS API mapping

The following tables map the operations in the BMC Atrium Orchestrator Application Adapter for VMware Infrastructure to the VMware Infrastructure APIs:

Basic VM operations

Adapter operation

Operation API

Dependent operation

Dependent API

Power_On_VM

PowerOnVM_Task

None

None

Power_Off_VM

PowerOffVM_Task

None

None

Suspend_VM

SuspendVM_Task

None

None

Resume_VM

PowerOnVM_Task

None

None

Reset_VM

ResetVM_Task

None

None

Restart_Guest_
 OS

RebootGuest

None

None

Shut_Down_Guest_
OS

ShutdownGuest

None

None

Convert_Template_To_VM

MarkAsVM

None

None

Convert_VM_To_Template

MarkAsTemplate

None

None

Register_VM

RegisterVM_Task

None

None

Unregister_VM

UnregisterVM_Task

None

None

Advanced VM operations

Adapter operation

Operation API

Dependent operation

Dependent API

Create_VM_Snapshot

CreateSnapshot_Task

None

None

Revert_VM_Snapshot

RevertToSnapshot_Task

Get_Vm_SnapshotInfo

RetrieveProperties

Move_Virtual_Disk

RelocateVM_Task

GetDiskByVm

RetrieveProperties

Validate_VM_Migration

ValidateMigration

None

None

Migrate_VM

MigrateVM_Task

None

None

Relocate_VM

RelocateVM_Task

GetDiskByVm

RetrieveProperties

Acquire_Mks_Ticket

AcquireMksTicket

None

None

Retrieve_VM_File_Info

RetrieveProperties

  • Retrieve_Host_
    Datastore_Browser
  • Search_Datastore_Sub_
    Folders_Task
  • RetrieveProperties
  • SearchDatastore
     SubFolders_Task

Update_VM_Snapshot

RenameSnapshot

Get_Vm_SnapshotInfo

RetrieveProperties

Delete_VM_Snapshot

RemoveSnapshot_Task

Get_Vm_SnapshotInfo

RetrieveProperties

VM Configuration operations

Adapter operation

Operation API

Dependent operation

Dependent API

Create_VM

CreateVM_Task

None

None

Create_VM_With_
Custom_Settings

CreateVM_Task

None

None

Clone_VM

CloneVM_Task

None

None

Clone_VM_With_
Custom_Settings

CloneVM_Task

GetDiskByVm

RetrieveProperties

Customize_VM

CustomizeVM_Task

None

None

Add_Hard_Disk

ReconfigVM_Task

Retrieve_Hard_
Disk_Configuration

RetrieveProperties

Add_Ethernet_Adapter

ReconfigVM_Task

  • Retrieve_VM_
    Host_Info
  • Retrieve_Host_
    DVS_Configuration
  • RetrieveProperties
  • QueryDvsConfigTarget

Add_CD_ROM

ReconfigVM_Task

GetIDEControllerByVm

RetrieveProperties

Retrieve_VM_
Configuration

RetrieveProperties

None

None

Retrieve_CPU_
Configuration

RetrieveProperties

None

None

Retrieve_Memory_
Configuration

RetrieveProperties

None

None

Retrieve_Hard_Disk_
Configuration

RetrieveProperties

None

None

Retrieve_CD_ROM_
Configuration

RetrieveProperties

None

None

Retrieve_Ethernet_
 Adapter_ Configuration

RetrieveProperties

None

None

Update_CD_ROM_
Configuration

ReconfigVM_Task

GetVirtualDeviceByVm

RetrieveProperties

Update_VM_
Configuration

ReconfigVM_Task

  • GetAllVMByDataStore
  • GetIDEControllerByVm
  • GetDiskByVm
  • GetVirtualDeviceByVm
  • RetrieveProperties
  • RetrieveProperties
  • RetrieveProperties
  • RetrieveProperties

Update_CPU_
Configuration

ReconfigVM_Task

None

None

Update_Memory_
 Configuration

ReconfigVM_Task

None

None

Update_Ethernet_
 Adapter_Configuration

ReconfigVM_Task

  • GetVirtualDeviceByVm
  • Retrieve_VM_Host_Info
  • Retrieve_Host_
    DVS_Configuration
  • RetrieveProperties
  • RetrieveProperties
  • QueryDvsConfigTarget

Update_Hard_Disk_
Configuration

ReconfigVM_Task

GetDiskByVm

RetrieveProperties

Delete_VM

Destroy_Task

None

None

Remove_Hard_Disk

ReconfigVM_Task

GetDiskByVm

RetrieveProperties

Remove_Ethernet_
Adapter

ReconfigVM_Task

GetVirtualDeviceByVm

RetrieveProperties

Remove_CD_ROM

ReconfigVM_Task

GetVirtualDeviceByVm

RetrieveProperties

Export_VM_As_
OVF_Template

ExportVm

None

None

Import_OVF_
Template_As_VM

ImportVApp

None

None

Monitor VM operations

Adapter operation

Operation API

Dependent operation

Dependent API

Retrieve_VM_
CPU_Usage

QueryPerf

  • QueryVm_Perf_
    Available_Metric
  • QueryVm_Perf_Counter
  • FindQuerySpecBy
    InventoryPath
  • QueryAvailablePerfMetric
  • QueryPerfCounter
  • None

Retrieve_VM_
Disk_Usage

QueryPerf

  • QueryVm_Perf_
    Available_Metric
  • QueryVm_Perf_Counter
  • FindQuerySpecBy
    InventoryPath
  • QueryAvailable
    PerfMetric
  • QueryPerfCounter
  • None

Retrieve_VM_
Memory_Usage

QueryPerf

  • QueryVm_Perf_
    Available_Metric
  • QueryVm_Perf_Counter
  • FindQuerySpecBy
    InventoryPath
  • QueryAvailablePerfMetric
  • QueryPerfCounter
  • None

Retrieve_VM_
Network_Usage

QueryPerf

  • QueryVm_Perf_
    Available_Metric
  • QueryVm_Perf_Counter
  • FindQuerySpecBy
    InventoryPath
  • QueryAvailable
    PerfMetric
  • QueryPerfCounter
  • None

Retrieve_VM_Status

RetrieveProperties

None

None

Retrieve_Task_Status

RetrieveProperties

None

None

Retrieve_VM_
Alarm_List

GetAlarm

None

None

Delete_VM_Alarm

RemoveAlarm

Retrieve_VM_Alarm_List

GetAlarm

Host operations

Adapter operation

Operation API

Dependent operation

Dependent API

Create_Host

AddStandaloneHost_Task

None

None

Add_Host_
To_Cluster

AddHost_Task

None

None

Add_Virtual_Switch

UpdateNetworkConfig

GetHostNetworkSystem

RetrieveProperties

Update_Virtual_Switch

UpdateNetworkConfig

GetHostNetworkSystem

RetrieveProperties

Add_Virtual_NIC

UpdateNetworkConfig

GetHostNetworkSystem

RetrieveProperties

Update_Virtual_NIC

UpdateNetworkConfig

GetHostNetworkSystem

RetrieveProperties

Add_Port_Group

UpdateNetworkConfig

GetHostNetworkSystem

RetrieveProperties

Update_Port_Group

UpdateNetworkConfig

GetHostNetworkSystem

RetrieveProperties

Add_NAS_Datastore

CreateNasDatastore

Retrieve_Host_
Datastore_System

RetrieveProperties

Add_Vmfs_Datastore

CreateVmfsDatastore

  • Retrieve_Host_
    Datastore_System
  • Retrieve_Available_Disks_
    For_Vmfs
  • Query_Vmfs_Datastore_
    Create_Options
  • RetrieveProperties
  • QueryAvailableDisks
     ForVmfs
  • QueryVmfsDatastore
     CreateOptions

Add_Internet_Scsi_
Send_Targets

AddInternetScsi
SendTargets

Retrieve_Host_
Storage_System

RetrieveProperties

Move_Host_
To_Cluster

MoveHostInto_Task

None

None

Retrieve_Host_
Configuration

RetrieveProperties

None

None

Retrieve_Host_
DVS_Configuration

QueryDvsConfigTarget

None

None

Retrieve_Host_Network_
Configuration

RetrieveProperties

GetHostNetworkSystem

RetrieveProperties

Retrieve_Host_
Datastore_Configuration

RetrieveProperties

Retrieve_Host_
Datastore_List

RetrieveProperties

Retrieve_Virtual
_Switch_Configuration

RetrieveProperties

GetHostNetworkSystem

RetrieveProperties

Retrieve_Virtual
_NIC_Configuration

RetrieveProperties

GetHostNetworkSystem

RetrieveProperties

Retrieve_Port_
Group_Configuration

RetrieveProperties

GetHostNetworkSystem

RetrieveProperties

Retrieve_Available_
Disks_For_Vmfs

QueryAvailableDisks
ForVmfs

Retrieve_Host_
Datastore_System

RetrieveProperties

Retrieve_Host_
CPU_Usage

RetrieveProperties

None

None

Retrieve_Host_
Memory_Usage

RetrieveProperties

None

None

Retrieve_ESX_
Hosts

RetrieveProperties

None

None

Retrieve_Host_
Scsi_Topology

RetrieveProperties

Retrieve_Host_Storage_
System

RetrieveProperties

Rescan_Hba

RescanHba

Retrieve_Host_Storage_
System

RetrieveProperties

Rescan_All_Hba

RescanAllHba

Retrieve_Host_Storage_
System

RetrieveProperties

Update_Host_
Network_Configuration

UpdateNetworkConfig

  • GetHostNetworkSystem
  • Retrieve_Virtual_NIC_
    Configuration
  • RetrieveProperties
  • RetrieveProperties

Extend_Vmfs_Datastore

ExtendVmfsDatastore

  • Retrieve_Host_
    Datastore_System
  • Retrieve_Available_Disks_
    For_Vmfs
  • Query_Vmfs_Datastore_
    Extend_Options
  • RetrieveProperties
  • QueryAvailableDisks
     ForVmfs
  • QueryVmfsDatastore
     ExtendOptions

Update_Software_
Internet_Scsi_Enabled

UpdateSoftwareInternet
ScsiEnabled

Retrieve_Host_Storage_
System

RetrieveProperties

Update_Internet_
 Scsi_Name

UpdateInternetScsiName

Retrieve_Host_
Storage_System

RetrieveProperties

Remove_Host_
 From_Cluster

MoveIntoFolder_Task

None

None

Remove_Virtual_Switch

UpdateNetworkConfig

GetHostNetworkSystem

RetrieveProperties

Remove_Virtual_NIC

UpdateNetworkConfig

GetHostNetworkSystem

RetrieveProperties

Remove_Port_Group

UpdateNetworkConfig

GetHostNetworkSystem

RetrieveProperties

Remove_Datastore

RemoveDatastore

Retrieve_Host_Datastore_
System

RetrieveProperties

Enter_Maintenance_Mode

EnterMaintenanceMode_Task

None

None

Exit_Maintenance_Mode

ExitMaintenanceMode_Task

None

None

Datastore operations

Adapter operation

Operation API

Dependent operation

Dependent API

Retrieve_Datastore_List

RetrieveProperties

Retrieve_Datastores

RetrieveProperties

Retrieve_Datastore_
 Virtual_Machines

RetrieveProperties

None

None

Retrieve_Vmfs_
 Datastore_Storage_
 Controller

RetrieveProperties

  • Retrieve_Datastore_Host_
    System
  • Dependent Retrieve_
    Host_Storage_System
  • Dependent Retrieve_
    Host_Scsi_Topology
  • RetrieveProperties
  • RetrieveProperties
  • RetrieveProperties
Cluster operations

Adapter operation

Operation API

Dependent operation

Dependent API

Retrieve_Cluster_
 Configuration

RetrieveProperties

None

None

Retrieve_Cluster_
 Datastore_Configuration

RetrieveProperties

Retrieve_Cluster_
Datastore_List

RetrieveProperties

Retrieve_Clusters

RetrieveProperties

None

None

Update_Cluster_DRS_
Configuration

ReconfigureCompute
Resource_Task

None

None

Retrieve_Cluster_Virtual_
Machines

RetrieveProperties

None

None

Datacenter operation

Adapter operation

Operation API

Dependent operation

Dependent API

Retrieve_Datacenters

RetrieveProperties

None

None

Folder operations

Adapter operation

Operation API

Dependent operation

Dependent API

Retrieve_Folders

RetrieveProperties

None

None

Destroy_Folder

Destroy_Task

None

None

Create_Folder

CreateFolder

None

None

Move_Into_Folder

MoveIntoFolder_Task

None

None

Discovery operations

Adapter operation

Operation API

Dependent operation

Dependent API

Retrieve_MOB_Reference_
By_Display_Name

None

None

None

Retrieve_Display_Name_By_
MOB_Reference

None

None

None

Resource Pool operations

Adapter operation

Operation API

Dependent operation

Dependent API

Retrieve_Resource_Pool_
Children

RetrieveProperties

None

None

Create_Resource_Pool

CreateResourcePool

None

None

Destroy_Resource_Pool

Destroy_Task

None

None

Destroy_Resource_Pool_
Children

DestroyChildren

None

None

Move_Into_Resource_Pool

MoveIntoResourcePool

None

None

Basic vApp operations

Adapter operation

Operation API

Dependent operation

Dependent API

Power_On_VApp

PowerOnVApp_Task

None

None

Power_Off_VApp

PowerOffVApp_Task

None

None

Unregister_VApp

unregisterVApp_Task

None

None

vApp Configuration operations

Adapter operation

Operation API

Dependent operation

Dependent API

Export_VApp_As_
OVF_Template

ExportVApp

Create_Import_Spec

CreateImportSpec

Import_OVF_Template_
As_VApp

ImportVApp

Create_Import_Spec

CreateImportSpec

Create_VApp

CreateVApp

None

None

Clone_VApp

CloneVApp_Task

None

None

Update_VApp_
Configuration

UpdateVAppConfig

None

None

 

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