Module for the VIS adapter

Each operation supported by the application adapter has a corresponding process in the module. Top-level processes perform high-level functions and call operations in sub-directories. Each sub-directory contains process directories corresponding to the supported operation types.

Top-level processes

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

Create Items

Delete Items
Find Items
Perform Operations
Update Items

The top-level processes perform higher level functions and calls specialized processes in the sub directories.

SetupValidation directory

The processes in the SetupValidation 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 VMware Infrastructure.

Utilities directory

The Utilities directory contains constructor processes that create the XML inputs used in version-specific processes. The constructor processes are organized into general utilities and sub-directories that correspond to the supported operation types.

The functional processes require complex XML inputs. You can generate these complex XML inputs using the constructor processes.

Example

For the Power On VM operation, you can use the complex XML generated by the Construct Item for Power On VM constructor process.

The following table provides information about the available constructor processes:

Constructor wrapper Name	Description
Basic VM operations
Construct Item for Power On VM	Constructs Items XML for the Power On VM wrapper
Construct Item for Power Off VM	Constructs Items XML for the Power Off VM wrapper
Construct Item for Reset VM	Constructs Items XML for the Reset VM wrapper
Construct Item for Suspend VM	Constructs Items XML for the Suspend VM wrapper
Construct Item for Resume VM	Constructs Items XML for the Resume VM wrapper
Construct Item for Shut Down Guest OS	Constructs Items XML for the Shut Down Guest OS wrapper
Construct Item for Restart Guest OS	Constructs Items XML for the Restart Guest OS wrapper
Basic vApp operations
Construct Item for Power On VApp	Constructs Items XML for the Power On VApp wrapper
Construct Item for Power Off VApp	Constructs Items XML for the Power Off VApp wrapper
Construct Item for Unregister VApp	Constructs Items XML for the Unregister VApp wrapper
Advanced VM Operations
Construct Item for Create VM Snapshot	Constructs Items XML for the Create VM Snapshot wrapper
Construct Item for Revert VM Snapshot	Constructs Items XML for the Revert VM Snapshot wrapper
Construct Item for Validate VM Migration	Constructs Items XML for the Validate VM Migration wrapper
Construct Item for Migrate VM	Constructs Items XML for the Migrate VM wrapper
Construct Item for Move Virtual Disk	Constructs Items XML for the Move Virtual Disk wrapper
Construct Item for Relocate VM	Constructs Items XML for the Relocate VM wrapper
Construct Item for Acquire Mks Ticket	Constructs Items XML for the Acquire Mks Ticket wrapper
Construct Item for Retrieve VM File Info	Constructs Items XML for the Retrieve VM File Info wrapper
Construct Item for Update VM Snapshot	Constructs Items XML for the Update VM Snapshot wrapper
Construct Item for Delete VM Snapshot	Constructs Items XML for the Delete VM Snapshot wrapper
Configure VM Operations
Construct Item for Create VM	Constructs Items XML for the Create VM wrapper
Construct Item for Create VM with Custom Settings	Constructs Items XML for the Create VM with Custom Settings wrapper
Construct Item for Clone VM	Constructs Items XML for the Clone VM wrapper
Construct Item for Clone VM with Custom Settings	Constructs Items XML for the Clone VM with Custom Settings wrapper
Construct Item for Add Hard Disk	Constructs Items XML for the Add Hard Disk wrapper
Construct Item for Delete VM	Constructs Items XML for the Delete VM wrapper
Construct Item for Export VM as OVF Template	Constructs Items XML for the Export VM as OVF Template wrapper
Construct Item for Import OVF Template as VM	Constructs Items XML for the Import OVF Template as VM wrapper
Construct Item for Retrieve VM Configuration	Constructs Items XML for the Retrieve VM Configuration wrapper
Construct Item for Update VM Configuration	Constructs Items XML for the Update VM Configuration wrapper
Construct Item for Remove Ethernet Adapter	Constructs Items XML for the Remove Ethernet Adapter wrapper
Construct Item for Remove Hard Disk	Constructs Items XML for the Remove Hard Disk wrapper
Construct Item for Remove CD ROM	Constructs Items XML for the Remove CD ROM wrapper
Construct Item for Add Ethernet Adapter	Constructs Items XML for the Add Ethernet Adapter wrapper
Construct Item for Add CD ROM	Constructs Items XML for the Add CD ROM wrapper
Construct Item for Retrieve CPU Configuration	Constructs Items XML for the Retrieve CPU Configuration wrapper
Construct Item for Retrieve Memory Configuration	Constructs Items XML for the Retrieve Memory Configuration wrapper
Construct Item for Retrieve Hard Disk Configuration	Constructs Items XML for the Retrieve Hard Disk Configuration wrapper
Construct Item for Retrieve Ethernet Adapter Configuration	Constructs Items XML for the Retrieve Ethernet Adapter Configuration wrapper
Construct Item for Retrieve CD ROM Configuration	Constructs Items XML the Retrieve CD ROM Configuration wrapper
Construct Item for Update CD ROM Configuration	Constructs Items XML for the Update CD ROM Configuration wrapper
Construct Item for Update CPU Configuration	Constructs Items XML for the Update CPU Configuration wrapper
Construct Item for Update Memory Configuration	Constructs Items XML for the Update Memory Configuration wrapper
Construct Item for Update Ethernet Adapter Configuration	Constructs Items XML for the Update Ethernet Adapter Configuration wrapper
Construct Item for Update Hard Disk Configuration	Constructs Items XML for the Update Hard Disk Configuration wrapper
Monitor VM operations
Construct Item for Retrieve VM CPU Usage	Constructs Items XML for the Retrieve VM CPU Usage wrapper
Construct Item for Retrieve VM Disk Usage	Constructs Items XML for the Retrieve VM Disk Usage wrapper
Construct Item for Retrieve VM Memory Usage	Constructs Items XML for the Retrieve VM Memory Usage wrapper
Construct Item for Retrieve VM Network Usage	Constructs Items XML for the Retrieve VM Network Usage wrapper
Construct Item for Retrieve VM Status	Constructs Items XML for the Retrieve VM Status wrapper
Construct Item for Retrieve Task Status	Constructs Items XML for the Retrieve Task Status wrapper
Construct Item for Retrieve VM Alarm List	Constructs Items XML for the Retrieve VM Alarm List wrapper
Construct Item for Delete VM Alarm	Constructs Items XML for the Delete VM Alarm wrapper
Host Operations
Construct Item for Create Host	Constructs Items XML for the Create Host wrapper
Construct Item for Move Host to Cluster	Constructs Items XML for the Move Host to Cluster wrapper
Construct Item for Add Host to Cluster	Constructs Items XML for the Add Host to Cluster wrapper
Construct Item for Remove Host from Cluster	Constructs Items XML for the Remove Host from Cluster wrapper
Construct Item for Update Host Network Configuration	Constructs Items XML for the Update Host Network Configuration wrapper
Construct Item for Retrieve Host Configuration	Constructs Items XML for the Retrieve Host Configuration wrapper
Construct Item for Retrieve Host DVS Configuration	Constructs Items XML for the Retrieve Host DVS Configuration wrapper
Construct Item for Retrieve Host Network Configuration	Constructs Items XML for the Retrieve Host Network Configuration wrapper
Construct Item for Retrieve Host Datastore Configuration	Constructs Items XML for the Retrieve Host Datastore Configuration wrapper
Construct Item for Retrieve Virtual Switch Configuration	Constructs Items XML for the Retrieve Virtual Switch Configuration wrapper
Construct Item for Retrieve Virtual NIC Configuration	Constructs Items XML for the Retrieve Virtual NIC Configuration wrapper
Construct Item for Retrieve Port Group Configuration	Constructs Items XML for the Retrieve Port Group Configuration wrapper
Construct Item for Add Virtual Switch	Constructs Items XML for the Add Virtual Switch wrapper
Construct Item for Add Virtual NIC	Constructs Items XML for the Add Virtual NIC wrapper
Construct Item for Add Port Group	Constructs Items XML for the Add Port Group wrapper
Construct Item for Remove Virtual Switch	Constructs Items XML for the Remove Virtual Switch wrapper
Construct Item for Remove Virtual NIC	Constructs Items XML for the Remove Virtual NIC wrapper
Construct Item for Remove Port Group	Constructs Items XML for the Remove Port Group wrapper
Construct Item for Add NAS Datastore	Constructs Items XML for the Add NAS Datastore wrapper
Construct Item for Add Vmfs Datastore	Constructs Items XML for the Add Vmfs Datastore wrapper
Construct Item for Add Internet SCSI Send Targets	Constructs Items XML for the Add Internet SCSI Send Targets wrapper
Construct Item for Retrieve Available Disks For Vmfs	Constructs Items XML for the Retrieve Available Disks For Vmfs wrapper
Construct Item for Retrieve Host CPU	Constructs Items XML for the Retrieve Host CPU wrapper
Construct Item for Retrieve Host Memory	Constructs Items XML for the Retrieve Host Memory wrapper
Construct Item for Retrieve ESX Hosts	Constructs Items XML for the Retrieve ESX Hosts wrapper
Construct Item for Retrieve Host Scsi Topology	Constructs Items XML for the Retrieve Host Scsi Topology wrapper
Construct Item for Rescan Hba	Constructs Items XML for the Rescan Hba wrapper
Construct Item for Rescan All Hba	Constructs Items XML for the Rescan All Hba wrapper
Construct Item for Extend Vmfs Datastore	Constructs Items XML for the Extend Vmfs Datastore wrapper
Construct Item for Update Software Internet SCSI Enabled	Constructs Items XML for the Update Software Internet SCSI Enabled wrapper
Construct Item for Update Internet SCSI Name	Constructs Items XML for the Update Internet SCSI Name wrapper
Construct Item for Remove Datastore	Constructs Items XML for the Remove Datastore wrapper
Construct Item for Enter Maintenance Mode	Constructs Items XML for the Enter Maintenance Mode wrapper
Construct Item for Exit Maintenance Mode	Constructs Items XML for the Exit Maintenance Mode wrapper
Datastore operations
Construct Item for Retrieve Datastore List	Constructs Items XML for the Retrieve Datastore List wrapper
Construct Item for Retrieve Datastore Virtual Machines	Constructs Items XML for the Retrieve Datastore Virtual Machines wrapper
Construct Item for Retrieve Vmfs Datastore Storage Controller	Constructs Items XML for the Retrieve Vmfs Datastore Storage Controller wrapper
Cluster Operations
Construct Item for Retrieve Cluster Configuration	Constructs Items XML for the Retrieve Cluster Configuration wrapper
Construct Item for Retrieve Cluster Datastore Configuration	Constructs Items XML for the Retrieve Cluster Datastore Configuration wrapper
Construct Item for Retrieve Clusters	Constructs Items XML for the Retrieve Clusters wrapper
Construct Item for Retrieve Selected Cluster Configuration Properties	Constructs Items XML for the Retrieve Selected Cluster Configuration Properties wrapper
Datacenter operations
Construct Item for Retrieve Datacenters	Constructs Items XML for the Retrieve Datacenters wrapper
Folder operations
Construct Item for Create Folder	Constructs Items XML for the Create Folder wrapper
Construct Item for Retrieve Folders	Constructs Items XML for the Retrieve Folders wrapper
Construct Item for Destroy Folder	Constructs Items XML for the Destroy Folder wrapper
Discovery operations
Construct Item for Retrieve MOB Reference By Display Name	Constructs Item XML for the Retrieve MOB Reference By Display Name wrapper
Construct Item for Retrieve Display Name By MOB Reference	Constructs Item XML for the Retrieve Display Name By MOB Reference wrapper
Resource Pool operations
Construct Item for Retrieve Resource Pool Children	Constructs Item XML for the Retrieve Resource Pool Children wrapper
Configure VApp operations
Construct Item for Export VApp as OVF Template	Constructs Item XML for the Export VApp as OVF Template wrapper
Construct Item for Import OVF Template as VApp	Constructs Item XML for the Import OVF Template as VApp wrapper
Construct Item for Create VApp	Constructs Item XML for the Create VApp wrapper
Construct Item for Clone VApp	Constructs Item XML for Clone VApp wrapper
Construct Item for Update VApp Configuration	Constructs Item XML for the Update VApp Configuration wrapper

Version directories

The v3.0 directory contains processes specific to VMware Infrastructure 3.0. The v4.0 directory contains processes specific to VMware vSphere 4.0. A process is available for each supported operation. Processes are grouped in sub-directories based on the operation type.

Note

You can use the constructor processes to generate complex XML inputs that are consumed by the functional processes. For more information about constructor processes, see Utilities directory.

Process inputs

This section provides information about the process input elements for the processes in the adapter module.

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

Inputs	Description	Required
<adapter name>	Specifies the name of the adapter that will handle this request	No
<items>	Specifies the Items XML used to perform the wrapper process	Yes
<connection-parameters>	Contains the information needed for the adapter to connect to the target <connection-parameters> contains the <user-name> and<password> elements.	No

You can obtain the Items XML for a wrapper process by using the corresponding constructor process in Development Studio.

Example

For the Create Host wrapper process, you can obtain the Items XML by using the Construct Create Host Itemprocess in the Utilities folder in Project Explorer of the Development Studio.

You can also create a sample Items XML from the adapter requests detailed in this document in VIS actor adapter requests and responses.

For example, a sample adapter request for the Create_Host operation, as specified in this document, is illustrated in the following code sample:

<vmware-infrastructure-request>
    <operation-type>Host</operation-type>
    <operation-name>Create_Host</operation-name>
    <user-name></user-name>
    <password></password>
    <parameters>
        <folder>TestHostFolder</folder>
        <datacenter>BMC</datacenter>
        <spec>
            <force>false</force>
            <host-name>abc.bmc.com</host-name>
            <password></password>
            <port></port>
            <user-name>root</user-name>
            <vim-account-name></vim-account-name>
            <vim-account-password></vim-account-password>
            <folder>vm</folder>
        </spec>
        <add-connected>false</add-connected>
    </parameters>
</vmware-infrastructure-request>

You can obtain a sample Items XML for the Create Host wrapper process by:

Replacing the <vmware-infrastructure-request> tag with <items><item> tags
Replacing the </vmware-infrastructure-request> tag with </item></items> tags
Removing the <operation-type>, <operation-name>, <user-name>, and <password> tags

The sample Items XML obtained from the sample Create_Host operation is illustrated in the following code sample.

<items>
<item>
    <parameters>
        <folder>TestHostFolder</folder>
        <datacenter>BMC</datacenter>
        <spec>
            <force>false</force>
            <host-name>abc.bmc.com</host-name>
            <password></password>
            <port></port>
            <user-name>root</user-name>
            <vim-account-name></vim-account-name>
            <vim-account-password></vim-account-password>
            <folder>vm</folder>
        </spec>
        <add-connected>false</add-connected>
    </parameters>
</item>
<items>