You are on page 1of 71

Contents

VMware vSphere Integration Pack for System Center 2012 - Orchestrator....................................2


Deploying the VMware vSphere Integration Pack for System Center 2012 - Orchestrator..........4
VMware vSphere Activities.......................................................................................................... 6
Add Network Adapter Activity.................................................................................................10
Add VM Disk Activity.............................................................................................................. 12
Clone Linux VM Activity.......................................................................................................... 13
Clone Windows VM Activity.................................................................................................... 18
Create VM Activity.................................................................................................................. 24
Customize VM Activity............................................................................................................ 27
Delete VM Activity.................................................................................................................. 29
Get Cluster Properties Activity................................................................................................ 30
Get Datastore Capacity Activity.............................................................................................. 31
Get Host Datastores Activity................................................................................................... 33
Get Host Properties Activity.................................................................................................... 34
Get Hosts Activity................................................................................................................... 36
Get Resource Pool Runtime Info Activity...............................................................................37
Get Resource Pools Activity................................................................................................... 39
Get VM List Activity................................................................................................................ 40
Get VM Properties Activity...................................................................................................... 42
Get VM Status Activity............................................................................................................ 43
Maintenance Mode Activity..................................................................................................... 45
Migrate VM Activity................................................................................................................. 47
Move VM Activity.................................................................................................................... 49
Reconfigure VM Activity......................................................................................................... 51
Reset VM Activity................................................................................................................... 56
Revert VM Snapshot Activity.................................................................................................. 57
Set VM CD/DVD to ISO Image Activity..................................................................................59
Set VM Networks Activity....................................................................................................... 60
Start VM Activity..................................................................................................................... 62
Stop VM Activity..................................................................................................................... 63
Suspend VM Activity.............................................................................................................. 64
Take VM Snapshot Activity..................................................................................................... 66

VMware vSphere Integration Pack for System


Center 2012 - Orchestrator
The integration pack for VMware vSphere is an add-on for System Center 2012 - Orchestrator
that assists you in automating actions in VMware vSphere, enabling full management of your
virtualized computing infrastructure.
Microsoft is committed to protecting your privacy, while delivering software that brings you the
performance, power, and convenience you want. For more information, see the Privacy
Statement for System Center 2012 - Orchestrator Release Candidate
(http://go.microsoft.com/fwlink/?LinkID=216995).

Known Issues
You might see the following issues when using this VMware vSphere integration pack.

The Set VM Networks activity supports VMs with a maximum of four network adapters. If you use
this activity on a VM with more than four adapters, you will see an Index was out of range error.

The Reconfigure VM activity provides an options list for the number of CPUs ranging from 1 to 4,
even if the vSpherethe vSphere server supports VMs with more than 4 CPUs. To work around this
limitation, you can enter the valid number in the field manually.

In the Add Network Adapter activity, you can manually enter any Network label for the adapter. This
network will be applied to the adapter in vSphere even if it is unavailable or does not exist.

The Create VM activity does not provide an option to browse for valid networks for each of the NIC
properties.

In the Reconfigure VM activity, the return values of After Power On Script, After Resume Script,
Before Guest Standby Script, and Before Guest Standby Script do not match the input values
supplied.

The Add VM Disk activity does not provide the option to browse for available data stores.

The Set VM CD/DVD to ISO Image activity can be supplied with a Relative File Path to a nonexistent file. The activity completes successfully rather than producing an error message.

The Clone Windows VM and Clone Linux VM activities do not filter unavailable resource pools from
the Resource Pool Path browser.

The Clone Windows VM and Clone Linux VM activities do not filter source VMs based on their guest
operating system.

If you inadvertently import the Opalis global configurations, you might see the following errors:
When adding or editing configurations:
2

Failed to load the assembly containing the service class

When editing the properties of any vSphere activity:


Failed to load the assembly containing the service class

Runtime Error!
This application has requested the Runtime to terminate it in an unusual way. Please
contact the applications support tem for more information.

If you attempt to start a VM that is already powered on by using the Start VM activity, supplying a
Timeout value of greater than 2,147,483 will cause the integration pack to report success even though
the vSphere server indicates that the VM cannot be started.

Exporting workflows that contain vSphere activities from Opalis Integration Server 6.3 and importing
them into Orchestrator corrupts vSphere configurations stored in Orchestrator. To address this issue,
omit the global configurations from the import process, and then manually create the matching
configurations in Orchestrator.
Workaround: Use the following steps when exporting and importing Opalis workflows.
Warning
It is highly recommended that you perform a full backup of the Orchestrator database
before importing runbooks. Importing global configurations from another system can
overwrite local changes or leave the Orchestrator database in an unstable state. If
the Runbook Designer or runbook server exhibit problems after performing a runbook
import, restore the Orchestrator database from the backup.
Stage 1: Export the Opalis workflows and import them into Orchestrator.
a.

Export the workflows from Opalis Integration Server Client using the conventional method. No
changes to this process are required.

b.

In the Orchestrator Runbook Designer, import the runbooks to the appropriate location using the
Import option from the folder context menu or the Actions item from the main menu.

c.

In the Import dialog, select the file the location of the .ois_export file.

d.

Configure the options under Import the following global settings as necessary for your
runbooks.

e.

Ensure that the Import global configurations checkbox is not checked. This will prevent Opalis
global configurations from being imported into Orchestrator.

f.

Click Finish.

Stage 2: After the workflows are imported, create new vSphere configurations:
a.

Record the details of the vSphere configuration settings used by the exported workflows from the
source Opalis 6.3 system. These can be found in the Options -> VMWare vSphere item in the
3

main menu of the Opalis Integration server client.


Note the Name, Server, User, Password, and SSL property values for each vSphere
configuration. The Name of the configuration is case-sensitive.
b.

In the Orchestrator Runbook Designer, create a new vSphere configuration for each configuration
used by the imported runbooks.
i.

Click Options, and then click VMWare vSphere to open the Prerequisite
Configuration window.

ii.

Click Add to add a new configuration.

iii. Enter the name for the configuration as it appeared in the Opalis 6.3 system. Note
the Name field is case-sensitive.
iv. Select the configuration Type of vSphere Setting.
v.

Enter the Server, User, Password, and SSL property values as recorded from the
Opalis 6.3 system.

The Port and Webservice Timeout settings can be left blank at this
stage.
vi. Click OK to save your changes and create a new configuration.
c.

Repeat step 2 for all the configurations used by the imported runbooks.

d.

When you have created all the configurations used by the imported runbooks, click Finish on the
Prerequisite Configurations window.

e.

Test that the imported runbooks run successfully.

The activity Get Resource Pool Runtime Info fails with an empty Resource Pool (without any VMs
under it). The error summary is StartIndex cannot be less than zero. Parameter name: startIndex.

When clicking on a vSphere activity in the Runbook Tester, the following error may appear:
Error
Details: password
Exception: IntegrationPackException
Target site: ServiceBase.Design
This message can be safely ignored; however, the options list of various properties will not be
automatically populated in the Runbook Tester. If required, the value of these properties may
be edited manually.

Deploying the VMware vSphere Integration Pack


for System Center 2012 - Orchestrator
The following sections provide important information about downloading and deploying the
VMware vSphere integration pack for System Center 2012 - Orchestrator.

System Requirements
The Integration Pack for VMware vSphere requires the following software to be installed and
configured prior to implementing the integration. For more information about installing and
configuring Orchestrator and the VMware vSphere application, refer to the respective product
documentation.

VMware vSphere 4.1 or 5.0

System Center 2012 - Orchestrator Release Candidate

Downloading the Integration Pack


You can download the integration pack from the Microsoft Download Center
(http://go.microsoft.com/fwlink/?LinkId=223169).

Registering and Deploying the Integration Pack


After you download the integration pack file, you must register it with the Orchestrator
management server and then deploy it to a runbook server.
To register the integration pack
1. Copy the VMware vSphere integration pack file to the management server. Confirm that the
file is not set to Read Only. This can prevent unregistering the integration pack later.
2. From the Start menu, right-click Deployment Manager, and then click Run as
administrator.
3. In the left pane of the Deployment Manager, expand Orchestrator Management Server,
right-click Integration Packs, and then click Register IP with the Orchestrator
Management Server. The Integration Pack Registration Wizard opens.
4. Click Next.
5. In the Integration Pack or Hotfix Selection dialog box, click Add.
6. Locate and select the VMware vSphere file that you copied to the management server and
click Open. Then click Next.
7. In the Completing Integration Pack Registration Wizard dialog box, click Finish. The
License Agreement dialog box appears.
8. Click Accept. The Log Entries pane displays a confirmation message when the integration
pack is successfully registered.

To deploy the integration pack


1. In the left pane of Deployment Manager, right-click Integration Packs, and then click Deploy
IP to Runbook Server or Runbook Designer.
5

2. Select System Center Integration Pack for VMWare vSphere and then click Next.
3. Enter the name of the computer where you want to deploy the integration pack, click Add,
and then click Next.
4. Select the Installation Configuration options that apply to this deployment, and then click
Next.
5. Click Finish. The Log Entries pane displays a confirmation message that the integration
pack is successfully deployed.

Configuring the VMware vSphere connections


A connection establishes a reusable link between Orchestrator and a VMware vSphere server.
You can create as many connections as you require to link to multiple servers running VMware
vSphere. You can also create multiple connections to the same server to allow for differences in
security permissions for different user accounts.
To set up a VMware vSphere connection
1. In Runbook Designer, click Options, and then click VMware vSphere. The VMware vSphere
dialog appears.
2. On the Add Configurations tab, click Add to begin the connection setup. The
Configuration dialog appears.
3. In the Name box, enter a name for the connection. This can be a descriptive name to
distinguish the type of connection.
4. In the Type list box, select vSphere Settings.
5. In the Properties box, in the Server line, enter the computer name or IP address of the
VMware vSphere computer. For the server name, you can enter the NetBIOS name or the
fully qualified domain name (FQDN).
6. In the User and Password boxes, enter the Orchestrator credentials to connect to the
VMware vSphere server.
7. In the SSL box, enter True if a secure connection is required to the VMware vSphere server.
Enter False if this is not required.
8. In the Port box, enter the port number that the VMware vSphere server is listening on.
9. In the Webservice Timeout box, enter an integer value for the number of seconds that the
activities will wait for a response from the VMware vSphere server before an error is flagged.
10. Click OK to close the Add Configuration dialog box.
11. Add additional connections if applicable.
6

12. Click Finish.

VMware vSphere Activities


This integration pack adds the VMware vSphere category to the Activities pane in the Runbook
Designer. This category contains the following activities:
Add Network Adapter Activity
Add VM Disk Activity
Clone Linux VM Activity
Clone Windows VM Activity
Create VM Activity
Customize VM Activity
Delete Network Adapter
Delete VM Activity
Delete VM Disk Activity
Get Cluster Properties Activity
Get Datastore Capacity Activity
Get Host Datastores Activity
Get Host Properties Activity
Get Hosts Activity
Get Resource Pool Runtime Info Activity
Get Resource Pools Activity
Get VM List Activity
Get VM Properties Activity
Get VM Status Activity
Maintenance Mode Activity
Migrate VM Activity
Modify VM Disk Activity
Move VM Activity
Reconfigure VM Activity
Reset VM Activity
Revert VM Snapshot Activity
Set VM CD/DVD to ISO Image Activity
Set VM Networks Activity
Start VM Activity
Stop VM Activity
7

Suspend VM Activity
Take VM Snapshot Activity

Common Configuration Instructions for All Activities


The following configuration instructions apply to all activities in this integration pack. Links to this
section are included in the configuration instructions for each activity.

Activity Properties
Each activity has a set of required or optional properties that define the configuration of that
activity. This includes how it connects to other activities or how the activity performs its actions.
You can view or modify activity properties when the activity is placed in the runbook window.
To configure the properties for an activity
1. Double-click the activity. Alternatively, you can right-click the activity, and then click
Properties.
2. To save your configuration entries, click Finish.
In the activity properties dialog box, several tabs along the left side provide access to general and
specific settings for the activity. Although the number of available tabs for activity properties differs
from activity to activity, all activities will have a General tab, a Properties tab, and a Run
Behavior tab. Some activities may have additional tabs.

General Tab
This tab contains the Name and Description properties for the activity. By default, the Name of
the activity is the same as its activity type, and the Description is blank. You can modify these
properties to create more descriptive names or provide detailed descriptions of the actions of the
activity.

Properties Tab
This tab contains properties that are specific to the activity.
All activities in this integration pack have the Configuration property at the top of the Properties
tab. This property is used to specify the connection to the VMware vSphere vCenter server.

To configure the Configuration property


Click the ellipsis () button next to the Name field, and then select the applicable connection name.

Filter Behavior
The Monitor and Get activities use filters to determine the values that will invoke a runbook or
retrieve activities. Property values of potential candidates are compared to the values of the filters
to determine if they meet the criteria. When matching against values, you select one of the
8

available methods of comparison. An option is provided to either match or not match the filter
using each method. For example, the "Does not" version of a method causes alerts that do not
match the filter to invoke the runbook.

Equals: the property of the alert exactly matches the text or number specified in the filter.

Does not equal: the property of the alert does not exactly match the text or number specified in the
filter.

Contains: the property of the alert contains the exact text specified in the filter. Unlike the Equals
behavior, there can be other text surrounding the matching text.

Does not contain: the property of the alert does not contain the exact text specified in the filter. Unlike
the Equals behavior, there can be other text surrounding the matching text.

Matches pattern: use wildcards to specify a pattern that the text must match. The two wildcard values
are the asterisk (*) and the question mark (?). The behavior of the wildcards is similar to the Command
Prompt. The asterisk will match any number of characters, while the question mark will only match
one character. For example, if you have a filter specified as "a*b", the pattern would match any text
that has an "a" at the beginning and a "b" at the end. So, it will match "aab", "abbbbbb", and "abbcb",
but it will not match "ba" or "abba". Using the question mark, if you have a filter specified as "a?b",
the pattern will match any text that has an "a" at the beginning, any single character in the middle, and
"b" at the end. So this filter will match "a b", "abb", and "aqb", but it will not match "abbb" or "ab".

Does not match pattern: use wildcards to specify a pattern that the text must not match.

Starts with: the property of the alert starts with the exact text specified in the filter.

Ends with: the property of the alert starts with the exact text specified in the filter.

Run Behavior Tab


This tab contains the properties that determine how the activity handles multi-value published
data and what notifications will be sent if the activity fails or runs for an excessive period of time.
Multi-Value Published Data Behavior
The Get activities retrieve information from another activity or outside source, and can return one
or more values in the published data. For example, when you use the Get Hosts activity, the data
output from that activity will be a list of hosts managed by the vSphere server.
By default, the data from the Get activity will be passed on as multiple individual outputs. This
triggers the next activity as many times as there are items in the output. Alternatively, you can
provide a single output for the activity by enabling the Flatten option. When you enable this
option, you also choose a formatting option:

Separate with line breaks. Each item is on a new line. This format is useful for creating humanreadable text files for the output.

Separate with _ . Each item is separated by one or more characters of your choice.

Use CSV format. All items are in CSV (comma-separated value) format. This format is useful for
9

importing data into spreadsheets or other applications.


The activity will produce a new set of data every time it runs. The Flatten feature does not flatten
data across multiple instances of the same activity.
Event Notifications
Some activities are expected to take a limited amount of time to complete. If they do not complete
within that time they may be stalled or there may be another issue preventing them from
completing. You can define the number of seconds to wait for completion of the action. After this
period a platform event will be sent and the issue will be reported. You can also choose whether
to generate a platform event if the activity returns a failure.
To be notified when the activity takes longer than a specified time to run or fails to
run
1. In the Event Notifications box, enter the number of seconds of run time before a
notification is generated.
2.

Select Report if activity fails to run to generate run failure notifications.


Note
For more information see Activity Events.

Published Data
Published data is the foundation of a working runbook. It is the data produced as a result of the
actions of an activity. This data is published to an internal data bus that is unique for each
runbook. Subsequent activities in the workflow can subscribe to this data and use it in their
configuration. Link conditions also use this information to add decision-making capabilities to
policies.
An activity can only subscribe to published data from the activities that are linked before it in the
runbook. You can use published data to automatically populate the property values needed by
activities.
To use published data
1.

Right-click the property value box, click Subscribe, and then click Published Data.

2.

Click the Activity drop-down box and select the activity from which you want to obtain the data.
To view additional data elements common to all policies, select Show Common Published
Data.

3.

Click the data element that you want to use, and then click OK.

10

For a list of the data elements published by each activity, see the Published Data tables in the
activity topic. For information about the Common Published Data items, see Common Published
Data.

Add Network Adapter Activity


The Add Network Adapter activity is used in a runbook to add a virtual network adapter to a virtual
machine controlled by the VMware vSphere server. This can be used to connect the virtual
machine to multiple networks in a multi-homed environment or to add the first network adapter as
part of a provisioning process.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Add Network Adapter Activity Required Properties
Element

Description

Valid

Adapter Type

The virtual network adapter type. Supported types are


Flexible, VMXNET 2 (Enhanced),VMXNET 3 and E1000.

Strin

Connection at Power On

Indicates whether the adapter will be connected when the


virtual machine is powered on.

Bool

Network

The vSphere network that the adapter will connect to.

Strin

VM Path

The path of the virtual machine.

Strin

Add Network Adapter Activity Optional Properties


No optional properties are provided for this
activity.

Add Network Adapter Activity Published Data


Name

Description

Value Type

Adapter type

The selected adapter type

String

Connection at Power On

Whether the adapter will be connected when


the virtual machine is powered on

Boolean

Network

The network that the adapter is connected to

String

11

VM path

The path of the virtual machine that the adapter


belongs to

Configuring the Add Network Adapter Activity


The following procedure describes the steps required to configure an Add Network Adapter
activity.
To configure the Add Network Adapter Activity
1.

From the Activities pane, drag an Add Network Adapter activity to the active runbook.

2.

Double-click the Add Network Adapter Activity] activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Add VM Disk Activity


The Add VM Disk activity is used in a runbook to add a virtual disk to a virtual machine controlled
by the VMware vSphere server. This can be used to increase the amount of disk space allocated
to an existing virtual machine.
If a SCSI controller is not associated with the SCSI bus number specified in the activity, choosing
a SCSI controller type will add a new controller and attach the new disk to it.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.

12

String

Add VM Disk Activity Required Properties


Element

Description

Valid Values

Disk size (GB)

The disk size in gigabytes to allocate to the virtual


machine disk.

Integer

VM Path

The path of the source virtual machine.

String

Add VM Disk Activity Optional Properties


Element

Description

Valid Values

Datastore

The path of the data store that will hold the new
disk.

String

SCSI Bus Number

The SCSI bus number of the SCSI controller

Integer

SCSI Unit Key

The SCSI unit key of the SCSI controller

Integer

SCSI Controller Type

The type of SCSI controller to add if one does not


exist on the chosen SCSI bus.

String

Add VM Disk Activity Published Data


Name

Description

Value Type

Datastore

The datastore that holds the


disk that was added.

String

Disk size (GB)

The amount of disk size in


gigabytes allocated to the
virtual machine.

Integer

SCSI Bus Number

The SCSI bus number setting


specified

Integer

SCSI Unit Key

The SCSI unit key setting


specified

Integer

VM Path

The path of the virtual machine


that this disk belongs to.

String

SCSI Controller Type

The type of SCSI controller to


add if one does not exist on the
chosen SCSI bus.

String

13

Configuring the Add VM Disk Activity


The following procedure describes the steps required to configure an Add VM Disk activity.
To configure the Add VM Disk Activity
1.

From the Activities pane, drag an Add VM Disk activity to the active runbook.

2.

Double-click the Add VM Disk activity icon.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Clone Linux VM Activity


The Clone Linux VM activity is used in a runbook to create a copy of an existing Linux virtual
machine or template. This can be used to create new virtual machines quickly and easily using
existing virtual machines or templates as models.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
With the exception of Source VM/Template Path, all properties and published data refer to the
destination VM produced by the clone operation.
In order to support multiple network adapters the IP Address, Subnet Mask, Gateway and DNS
Suffix Optional Properties can support a comma separated list of values. Each list must have the
same number of items. For example, to assign network details to three network adapters use the
following format:
IP Address = 192.168.0.2, DHCP, 10.0.0.3
Subnet Mask = 255.255.255.0, DHCP, 255.0.0.0
Gateway = 192.168.0.1, DHCP, 10.0.0.1
14

DNS Suffix = a.com, b.com, c.com


The value DHCP can be used to assign the network adapter values via DHCP.
If an IP address is not specified for a network adapter it will be assigned via DHCP.

Clone Linux VM Activity Required Properties


Element

Description

Valid Val

Clone Task Timeout in seconds

The number of seconds to wait for the clone


operation to complete. After the timeout has been
reached the activity will fail if the clone operation has
not completed.

Integer

Customize

Indicates whether the virtual machine guest settings


are customized after the virtual machine is cloned. If
set to False, guest customizations (IP address, DNS
name, etc) will not be applied.

Boolean

Datastore Path

The data store name for the cloned virtual machine.

String

Folder Path

The path to the folder where the cloned virtual


machine will be saved.

String

Host System Path

The path to the host system of the cloned virtual


machine.

String

Memory Size (MB)

The amount of memory, in megabytes, to assign to


the cloned virtual machine.

Integer

New Virtual Machine Name

The name of the cloned virtual machine.

String

Power on after creation

Indicates whether the cloned virtual machine is


turned on after it is created.

Boolean

Resource Pool Path

The path to the resource pool that the cloned virtual


machine will use.

String

Source VM/Template Path

The name of the virtual machine or template that you


want to clone.

String

Virtual Processors

The number of virtual processors to assign to the


cloned virtual machine.

Integer

15

Clone Linux VM Activity Optional Properties


Element

Description

Valid Values

DHCP

Indicates whether to use DHCP for assigning an IP


address to the cloned virtual machine.

Boolean

DNS Name

The fully qualified domain name of the cloned virtual


machine.

String

DNS Server

The name of the DNS server that will resolve name


requests for the clone virtual machine.

String

Domain Name

The name of the domain that the cloned virtual


machine will belong to.

String

Gateway

The gateway that the cloned virtual machine will use

String

IP Address

The IP address that will be assigned to the cloned


virtual machine.

String

Subnet Mask

The subnet mask that the cloned virtual machine will


use.

String

DNS Suffix

The DNS Suffix that will be assigned to the network


adapter of the cloned virtual machine. E.gE.g.
example.com

String

Clone Linux VM Activity Published Data


Name

Description

Value Type

Clone Task Timeout in seconds

The timeout setting for the clone operation.

Integer

Customize

Indicates whether the virtual machine computer


settings were customized after cloning.

Boolean

Datastore Path

The path of the data store.

String

DHCP

Indicates which type of IP address allocation


the cloned virtual machine uses: DHCP or
static.

Boolean

DNS Name

The name of the virtual machine in the domain


naming service.

String

DNS Server

The name of the DNS server.

String

Domain Name

The name of the domain that the cloned virtual

String

16

machine uses.
Folder Path

The path to the destination folder for the cloned


virtual machine.

String

Gateway

The gateway that the cloned virtual machine


uses.

String

Host System Path

The path of the destination vSphere host


system.

String

IP Address

The static IP address of the cloned virtual


machine.

String

Memory Size(MB)

The amount of memory, in megabytes,


assigned to the cloned virtual machine.

Integer

Power on after creation

Indicates whether the cloned virtual machine


was turned on after creation.

Boolean

Resource Pool Path

The path to the resource pool that the cloned


virtual machine uses.

String

Source VM/Template Path

The name of the virtual machine or template


that you want to clone.

String

Subnet Mask

The subnet mask that the cloned virtual


machine will use.

String

DNS Suffix

The DNS Suffix that will be assigned to the


network adapter of the cloned virtual machine.

String

New Virtual Machine Name

The name of the cloned virtual machine.

String

Virtual Processors

The number of virtual processors assigned to


the cloned virtual machine.

Integer

Configuring the Clone Linux VM Activity


The following procedure describes the steps required to configure a Clone Linux VM activity.
To configure the Clone Linux VM Activity
1.

From the Activities pane, drag a Clone Linux VM activity to the active runbook.

2.

Double-click the Clone Linux VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere

17

server connection that you want to use for this activity. Click OK.
b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Clone Windows VM Activity


The Clone Windows VM activity is used in a runbook to create a copy of an existing Windows
virtual machine or template. This creates virtual machines quickly and easily using existing virtual
machines or templates as models.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
With the exception of Source VM/Template Path, all properties and published data refer to the
destination VM produced by the clone operation.
In order to support multiple network adapters, the IP Address, Subnet Mask, Gateway and DNS
Suffix Optional Properties can support a comma separated list of values. Each list must have the
same number of items. For example, to assign network details to three network adapters use the
following format:
IP Address = 192.168.0.2, DHCP, 10.0.0.3
Subnet Mask = 255.255.255.0, DHCP, 255.0.0.0
Gateway = 192.168.0.1, DHCP, 10.0.0.1
DNS Suffix = a.com, b.com, c.com
The value DHCP can be used to assign the network adapter values via DHCP.
If an IP address is not specified for a network adapter it will be assigned via DHCP.
If you clone an existing Windows virtual machine with some guest customizations, e.g. IP
Address, Admin Password, Computer Name etc., and want to check these customizations on the
new cloned virtual machine, you need to follow the steps below:
o
o
o
o

Clone operation completes.


Cloned VM is powered on in vSphere client.
Cloned VM boots to lock screen.
Wait 2 minutes.
18

o
o
o
o
o
o

Cloned VM automatically reboots.


VMware customization message appears.
Cloned VM reboots for second time.
VM boots to lock screen.
Wait 2 minutes.
Check all the customizations (which you specified in the Properties dialog box of this
activity) in vSphere client. You can view some of these customizations on the Virtual
Machine Properties dialog box, or the Summary tab window, or you can even log into the
guest OS in vSphere console.

Clone Windows VM Activity Required Properties


Element

Description

Valid Val

Clone Task Timeout in seconds

The number of seconds for the clone activity to


complete before timing out. The activity will fail if the
clone operation has not completed within the
configured time.

Integer

Customize

Indicates whether the virtual machine computer


settings are customized after the virtual machine is
cloned. If set to False, guest customizations (IP
address, DNS name, etc) will not be applied.

Boolean

Datastore Path

The data store name that the cloned virtual machine


will use.

String

Folder Path

The path to the folder containing the cloned virtual


machine.

String

Host System Path

The path to the host operating system of the cloned


virtual machine.

String

Memory Size (MB)

The amount of memory, in megabytes, assigned to


the cloned virtual machine.

Integer

New Virtual Machine Name

The name of the cloned virtual machine.

String

Resource Pool Path

The path to the resource pool of the cloned virtual


machine.

String

Source VM/Template Path

The name of the virtual machine or template to clone.

String

Virtual Processors

The number of virtual processors assigned to the


cloned virtual machine.

Integer

19

Clone Windows VM Activity Optional Properties


Element

Description

Valid Values

Look up

Admin Password

The password of the


Administrator account
of the cloned virtual
machine.

String

No

Computer Name

The name of the


cloned virtual
machine.

String

No

DHCP

Indicates whether to
use DHCP for
assigning an IP
address to the cloned
virtual machine.

Boolean

Yes

DNS Name

The complete domain


name for the cloned
virtual machine.

String

No

DNS Server

The name of the DNS


server to resolve
name requests for the
cloned virtual
machine.

String

No

Domain Name

The domain of the


cloned virtual
machine.

String

No

Domain User Name

The domain user


account that has
permission to add the
computer to the
domain.

String

No

Domain User
Password

The password of the


domain user account.

String

No

Gateway

The gateway for the


cloned virtual
machine.

String

No

Include Server
License Information

Indicates whether
configuring the

Boolean

Yes

20

Windows Server
license is part of the
cloning process.
IP Address

The IP address
assigned to the
cloned virtual
machine.

String

No

License Mode

The type of license


mode configured for
the Windows Server
licensing settings.

String

Yes

Maximum
Connections

The maximum
number of client
connections
configured as part of
the Windows Server
licensing settings.

Integer

No

Computer
Membership

The name of the


workgroup if the
computer is part of a
Windows workgroup,
or the domain name if
the computer is part
of an Active Directory
domain.

String

Yes

Organization Name

The name of the


owners organization
of the cloned virtual
machine.

String

No

Owners Name

The name of the


owner of the cloned
virtual machine.

String

No

Power on after
creation

Indicates whether the


cloned virtual
machine is turned on
after it is created.

Boolean

Yes

Product ID

The product ID of the


cloned virtual
machine. You must
add a dash after

String

No

21

every fifth character


to divide the product
ID number into five
parts. For example,
enter AAAAA-BBBBBCCCCC-DDDDDEEEEE.
Subnet Mask

The subnet mask for


the cloned virtual
machine.

String

No

DNS Suffix

The DNS Suffix that


will be assigned to the
network adapter of
the cloned virtual
machine. E.gE.g.
example.com

String

No

Workgroup

The name of the


workgroup the cloned
virtual machine
belongs to.

String

No

Clone Windows VM Activity Published Data


Name

Description

Value Type

Clone Task Timeout in seconds

The timeout setting for the clone operation.

Integer

Computer Membership

The name of the workgroup if the computer is


part of a Windows workgroup, or the domain
name if the computer is part of an Active
Directory domain.

String

Computer Name

The name of the computer.

String

Customize

Indicates whether the virtual machine settings


are customized after cloning.

Boolean

Datastore Path

The path of the data store.

String

DHCP

Indicates the type of IP address allocation of the


cloned virtual machine: DHCP or static.

Boolean

DNS Name

The complete domain name for the cloned


virtual machine.

String

22

DNS Server

The name of the DNS server to resolve name


requests for the cloned virtual machine.

String

Domain Name

The name of the domain that the cloned virtual


machine uses.

String

Domain User Name

The username that the cloned virtual machine


uses to connect to the domain.

String

Domain User Password

The password of the domain user account.

String

Folder Path

The path to the destination folder for the cloned


virtual machine.

String

Gateway

The gateway that the cloned virtual machine


uses.

String

Host System Path

The path to the destination host system.

String

IP Address

The static IP address of the cloned virtual


machine.

String

Include Server License Information

Indicates whether configuring the Windows


Server license is part of the cloning process.

Boolean

License mode

The type of license mode configured for the


Windows Server licensing settings.

String

Maximum Connections

The maximum number of client connections


configured as part of the Windows Server
licensing settings.

Integer

Memory Size (MB)

The amount of memory, in megabytes, assigned


to the cloned virtual machine.

Integer

Organization Name

The organization name.

String

Owners Name

The name of the owner of the cloned virtual


machine.

String

Power on after creation

Indicates whether the cloned virtual machine is


turned on after it is created.

Boolean

Product ID

The Windows product ID.

String

Resource Pool Path

The path to the resource pool used by the


cloned virtual machine.

String

Source VM/Template Path

The name of the virtual machine or template to


clone.

String

Subnet Mask

The subnet mask for the cloned virtual machine.

String

DNS Suffix

The DNS Suffix that will be assigned to the

String
23

network adapter of the cloned virtual machine.


E.gE.g. example.com
New Virtual Machine Name

The name of the cloned virtual machine.

String

Virtual Processors

The number of virtual processors assigned to


the cloned virtual machine.

Integer

Workgroup

The name of the workgroup for the cloned virtual


machine.

String

Configuring the Clone Windows VM Activity


The following procedure describes the steps required to configure a Clone Windows VM activity.
To configure the Clone Windows VM Activity
1.

From the Activities pane, drag a Clone Windows VM activity to the active runbook.

2.

Double-click the Clone Windows VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Create VM Activity
The Create VM activity is added to a runbook to create a new virtual machine. The runbook can
be used to create virtual machines on demand based on self-service provisioning processes.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.

24

Create VM Activity Required Properties


Element

Description

Valid Values

Datastore Path

The name of the data store used by the virtual


machine.

String

Folder Path

The path to the folder containing the virtual


machine.

String

Guest Operating System

The name of the guest operating system installed


on this virtual machine.

String

Host System Path

The path to the host system of the virtual machine.


This field can be blank.

String

Memory (MB)

The amount of memory, in megabytes, assigned to


the virtual machine.

Integer

Nic (1-4)

The name of the virtual network. You must enter a


value for Nic1, but can leave Nics 2-4 blank if
there are no additional networks.

String

Number Processors

The number of processors assigned to the virtual


machine.

Integer

Power on after creation

Indicates whether to turn on the virtual machine


after it is created.

Boolean

Resource Pool Path

The path to the resource pool used by the virtual


machine. You can leave this field blank.

String

Virtual Disk Size(GB)

The size of the virtual hard disk assigned to this


virtual machine.

Integer

Virtual Machine Name

The name of the virtual machine as it will appear in


the vSphere user interface.

String

Create VM Activity Optional Properties


Element

Description

Valid Values

Relative ISO Image Path

The path of the CD ISO image containing the


operating system installed on the virtual machine.
This path is relative to the host computer where the
virtual machine is located.

String

25

Create VM Activity Published Data


Name

Description

Value Type

Datastore Path

The path of the data store

String

Folder Path

The path to the folder on the host computer


where the virtual machine is stored.

String

Guest Operating System

The name of the guest operating system


installed on the virtual machine.

String

Host System Path

The path of the host system.

String

Memory(MB)

The amount of memory, in megabytes assigned


to the virtual machine.

Integer

NIC 1

The first virtual network adapter assigned to the


virtual machine.

String

NIC 2

The second virtual network adapter assigned to


the virtual machine.

String

NIC 3

The third virtual network adapter assigned to


the virtual machine.

String

NIC 4

The fourth virtual network adapter assigned to


the virtual machine.

String

Power on after creation

Indicates whether to turn on the virtual machine


after it is created.

Boolean

Relative ISO Image Path

The path of the CD ISO image containing the


operating system installed on the virtual
machine.

String

Resource Pool Path

The path to the resource pool used by the


virtual machine. You can leave this field blank.

String

Virtual Disk Size (GB)

The size of the virtual hard disk assigned to this


virtual machine.

Integer

Virtual Machine Name

The name of the virtual machine as it appears


in the vSphere user interface.

String

Configuring the Create VM Activity


The following procedure describes the steps required to configure a Create VM activity.
To configure the Create VM Activity
26

1.

From the Activities pane, drag a Create VM activity to the active runbook.

2.

Double-click the Create VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Customize VM Activity
The Customize VM activity is used in a runbook to customize a virtual machine using a
designated script. This allows the runbook to perform advanced customization using a pre-made
Customization Spec.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Customize VM Activity Required Properties
Element

Description

Valid Va

Customization Spec

The customization spec that will be used to


customize the virtual machine.

String

VM Path

The path to the virtual machine being customized.

String

Customize VM Activity Optional Properties


No optional properties are provided for this
activity.

27

Customize VM Activity Published Data


Name

Description

Value Type

Customization Spec

The customization specification used to


customize the virtual machine.

String

VM Path

The path to the virtual machine that was


customized.

String

Configuring the Customize VM Activity


The following procedure describes the steps required to configure a Customize VM activity.
To configure the Customize VM Activity
1.

From the Activities pane, drag a Customize VM activity to the active runbook.

2.

Double-click the Customize VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Delete Network Adapter Activity


The Delete Network Adapter activity is used in a runbook to remove a virtual network adapter
from a virtual machine controlled by the VMware vSphere server. The network adapter to remove
is identified by its MAC address. A list of MAC addresses associated with a virtual machine can
be found using the Get VM Properties activity.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
28

Delete Network Adapter Activity Required Properties


Element

Description

Valid Values

Look up

VM Path

The path of the virtual


machine containing the
adapter to delete.

String

Yes

MAC Address

The MAC address of


the network adapter to
remove. The formats
00:11:22:33:44:55
and 00-11-22-33-4455 are accepted.

String

No

Delete Network Adapter Activity Optional Properties


No optional properties are provided for this
activity.

Delete Network Adapter Activity Published Data


Name

Description

Value Type

VM Path

The path of the virtual


machine containing the
adapter to delete.

String

MAC Address

The MAC address of the


network adapter to remove.
The output format will always
be 00:11:22:33:44:55.

String

Configuring the Delete Network Adapter Activity


The following procedure describes the steps required to configure a Delete Network Adapter
activity.
To configure the Delete Network Adapter Activity
1.

From the Activities pane, drag a Delete Network Adapter activity to the active runbook.

2.

Double-click the Delete Network Adapter activity icon. The Properties dialog box opens.
29

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Delete VM Activity
The Delete VM activity is used in a runbook to permanently delete a virtual machine and all of its
associated files that has already been added to the VMware ESX server host. Using the Delete
VM activity is the same as selecting Delete from disk from the VMware VirtualCenter server
console. This allows the runbook to delete a virtual machine that is no longer needed.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Delete VM Activity Required Properties
Element

Description

Valid Values

VM Path

The path to the virtual machine being deleted.

String

Delete VM Activity Optional Properties


No optional properties are provided for this
activity.

Delete VM Activity Published Data


Name

Description

Value Type

VM Path

The path to the virtual machine that was deleted

String

30

Configuring the Delete VM Activity


The following procedure describes the steps required to configure a Delete VM activity.
To configure the Delete VM Activity
1.

From the Activities pane, drag a Delete VM activity to the active runbook.

2.

Double-click the Delete VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Delete VM Disk Activity


The Delete VM Disk activity is used in a runbook to remove or delete a virtual disk from a virtual
machine controlled by the VMware vSphere server.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Delete VM Disk Activity Required Properties
Element

Description

Valid Values

Look up

VM Path

The path of the


source virtual
machine.

String

Yes

SCSI Bus Number

The SCSI bus


number of the SCSI
controller.

Integer

No

SCSI Unit Key

The SCSI unit key of

Integer

No
31

the SCSI controller.

Delete VM Disk Activity Optional Properties


Element

Description

Valid Values

Look up

Delete Disk File

Determines if the
underlying VMDK file of
the virtual disk will be
deleted from the
datastore. A value of
true removes the disk
from the virtual machine
and deletes the backing
file. A value of false
removes the disk but
preserves the backing
file.

Boolean

Yes

Delete VM Disk Activity Published Data


Name

Description

Value Type

VM Path

The path of the source virtual


machine.

String

SCSI Bus Number

The SCSI bus number of the


SCSI controller.

Integer

SCSI Unit Key

The SCSI unit key of the SCSI


controller.

Integer

Delete Disk File

Determines if the underlying


VMDK file of the virtual disk
will be deleted from the
datastore. A value of true
removes the disk from the
virtual machine and deletes
the backing file. A value of
false removes the disk but
preserves the backing file.

Boolean

32

Configuring the Delete VM Disk Activity


The following procedure describes the steps required to configure ana Delete VM Disk activity.
To configure the Delete VM Disk Activity
1.

From the Activities pane, drag a Delete VM Disk activity to the active runbook.

2.

Double-click the Delete VM Disk activity icon.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Get Cluster Properties Activity


The Get Cluster Properties activity is used in a runbook to retrieve information about a virtual
machine cluster in VMware vSphere. This allows the runbook to obtain the information about a
cluster before cloning or creating virtual machines on that cluster.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Get Cluster Properties Activity Required Properties
Element

Description

Valid Values

Cluster Path

The path to the virtual machine cluster whose


properties are being retrieved

String

Get Cluster Properties Activity Optional Properties


No optional properties are provided for this
activity.
33

Get Cluster Properties Activity Published Data


Name

Description

Value Type

Cluster Path

The path of the virtual machine cluster.

String

Datastore Names

The names of the datastores assigned to the


cluster.

String

Effective CPU (MHz)

The total CPU MHZ available for virtual


machines.

Integer

Effective Memory (MB)

The total memory available for virtual machines.

Integer

Number of CPU Cores

The total number of CPU cores assigned to the


virtual machine cluster.

Integer

Number of CPU Threads

The total number of available CPU threads on


the virtual machine cluster.

Integer

Number of Effective Hosts

The total number of hosts available for hosting


virtual machines.

Integer

Number of Hosts

The total number of hosts in the virtual machine


cluster.

Integer

Total CPU (MHz)

The total CPU MHz available on the virtual


machine cluster.

Integer

Total Memory (MB)

The total memory available on the virtual


machine cluster.

Integer

Configuring the Get Cluster Properties Activity


The following procedure describes the steps required to configure a Get Cluster Properties
activity.
To configure the Get Cluster Properties Activity
1.

From the Activities pane, drag a Get Cluster Properties activity to the active runbook.

2.

Double-click the Get Cluster Properties activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
34

to the text box to browse for a value.


You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.
4.

Click Finish.

Get Datastore Capacity Activity


The Get Datastore Capacity activity is used in a runbook to retrieve the capacity available on a
specific data store. This allows the runbook to retrieve the available capacity of a data store
before cloning or creating virtual machines in the data store.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Get Datastore Capacity Activity Required Properties
Element

Description

Valid Values

Datastore

The name of the data store for which to retrieve the


capacity.

String

Get Datastore Capacity Activity Optional Properties


No optional properties are provided for this
activity.

Get Datastore Capacity Activity Published Data


Name

Description

Value Type

Capacity

The total capacity of the data store.

Integer

Free Space

The total amount of available space.

Integer

Percent Free

The amount of available space as a percentage


of the available capacity.

Integer

35

Configuring the Get Datastore Capacity Activity


The following procedure describes the steps required to configure a Get Datastore Capacity
activity.
To configure the Get Datastore Capacity Activity
1.

From the Activities pane, drag a Get Datastore Capacity activity to the active runbook.

2.

Double-click the Get Datastore Capacity activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Get Host Datastores Activity


The Get Host Datastores activity is used in a runbook to retrieve a list of datastores available for
a specified host managed by the VMware vSphere server. This can be used to check capacity of
the system when automatically adding a new VM to the managed host.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Get Host Datastores Activity Required Properties
Element

Description

Valid Values

Host

The path of the managed host controlled by the


VMware vCenter server.

String

Get Host Datastores Activity Optional Properties


No optional properties are provided for this
36

activity.

Get Host Datastores Activity Published Data


Name

Description

Value Type

Datastore

A list of all available data stores that are


connected to the specified host

String

Host

Identifier of the host

String

Configuring the Get Host Datastores Activity


The following procedure describes the steps required to configure a Get Host Datastores activity.
To configure the Get Host Datastores Activity
1.

From the Activities pane, drag a Get Host Datastores activity to the active runbook.

2.

Double-click the Get Host Datastores activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Get Host Properties Activity


The Get Host Properties activity is used in a runbook to retrieve a list of properties for a specified
host in the VMware vSphere cluster. Examples of these properties include Connection Status
(Powered on, disconnected, etc) and Maintenance Mode state.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
37

Get Host Properties Activity Required Properties


Element

Description

Valid Values

Host

The name of the managed host controlled by the


VMware vCenter server

String

Get Host Properties Activity Optional Properties


No optional properties are provided for this
activity

Get Host Properties Activity Published Data


Name

Description

Value Type

Connection State

The connection state of the host.

Connected
Not Responding
Disconnected

Host

The identifier of the host.

String

In Maintenance Mode

Indicates whether the host is in maintenance


mode.

True

Name

The name of the managed host.

String

Overall Status

The overall status of the host.

Gray (unknown)

False

Green (OK)
Yellow (warning)
Red (alarm)
Port

The management port for the managed host.

Integer

Power State

The power state of the host.

Powered On
Powered Off
Standby

Unknown (e.g. disc


Product

The full product name and version of the host


hypervisor.

String

Reboot Required

Indicates whether a reboot is required.

True
False
38

vMotion Enabled

Indicates whether vMotion is enabled.

True
False

Configuring the Get Host Properties Activity


The following procedure describes the steps required to configure a Get Host Properties activity.
To configure the Get Host Properties Activity
1.

From the Activities pane, drag a Get Host Properties activity to the active runbook.

2.

Double-click the Get Host Properties activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Get Hosts Activity


The Get Hosts activity is used in a runbook to retrieve all the hosts attached to a vCenter
instance. This allows the runbook to determine the list of hosts before cloning or creating virtual
machines on a designated host.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Get Hosts Activity Required Properties
No required properties are provided for this
activity.

Get Hosts Activity Optional Properties


No optional properties are provided for this
39

activity.

Get Hosts Activity Published Data


Name

Description

Value Type

Host

A list of host paths managed by the vCenter


server.

String

Configuring the Get Hosts Activity


The following procedure describes the steps required to configure a Get Hosts activity.
To configure the Get Hosts Activity
1. From the Activities pane, drag a Get Hosts activity to the active runbook.
2. Double-click the Get Hosts activity icon. The Properties dialog box opens.
3. Configure the settings in the Properties tab as follows:
a. In the Configuration section, click the ellipsis button (...), and then select the VMware
vSphere server connection that you want to use for this activity. Click OK.
4. Click Finish.

Get Resource Pool Runtime InfoProperties Activity


The Get Resource Pool Runtime InfoProperties activity is used in a runbook to retrieve all the
runtime and static configuration information for a resource pool. This allows the runbook to
retrieve the runtime information of a resource pool and populate a performance report.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Get Resource Pool Runtime InfoProperties Activity Required Properties
Element

Description

Valid Valu

ResourcePool Path

The path to the resource pool.

String
40

Get Resource Pool Runtime InfoProperties Activity Optional Properties


No optional properties are provided for this
activity.

Get Resource Pool Runtime InfoProperties Activity Published Data


Name

Description

Value Type

CPUmaxUsage

The maximum available CPU


cycles for the resource pool
(in megahertz).

Integer

CPUoverallUsage

The amount of CPU cycles


used by the resource pool
and VMs (in megahertz).

Integer

CPUreservationUsed

The amount of CPU cycles


currently being used by the
pool (in megahertz).

Integer

CPUreservationUsedforVm

The amount of CPU cycles


currently being used by the
VMs (in megahertz).

Integer

CPUunreservedForPool

The amount of CPU cycles


not currently being used by
the pool (in megahertz).

Integer

CPUunreservedforVm

The amount of CPU cycles


not currently being used by
the VMs (in megahertz).

Integer

CpuSharesLevel

CPU allocation shares level.


Can be the preset levels low,
normal, high or custom. If
custom the allocation is
described in the CPUShares
property.

String

CpuShares

The number of CPU Shares


allocated. Set to -1 if
CpuSharesLevel has a
preset level.

Integer

CpuReservation

The guaranteed CPU MHz


allocation available to the
resource pool.

Integer

41

CpuLimit

The CPU MHz limit of the


resource pool.

Integer

CpuExpandableReservation

True if the CPU reservation


can grow beyond the value
specified in CpuReservation.

Boolean

CpuUnlimited

True, if the CPU usage is


unlimited. Otherwise, false.

Boolean

MemoryMaxUsage

The maximum amount of


RAM available (in bytes).

Integer

MemoryOverallUsage

The amount of memory that


is currently being used (in
bytes).

Integer

MemoryReservationUsed

The amount of memory that


is in use for the pool (in
bytes).

Integer

MemoryReservationUsedForVm

The amount of memory that


is in use for the VMs (in
bytes).

Integer

MemoryUnreservedForPool

The amount of memory that


is not in use for the pool (in
bytes).

Integer

MemoryUnreservedForVm

The amount of memory that


is not in use for the VMs (in
bytes).

Integer

MemorySharesLevel

Memory allocation shares


level. Can be the preset
levels low, normal, high or
custom. If custom the
allocation is described in the
MemoryShares property.

String

MemoryShares

The number of Memory


Shares allocated. Set to -1 if
MemorySharesLevel has a
preset level.

Integer

MemoryReservation

The guaranteed memory MB


allocation available to the
resource pool.

Integer

MemoryLimit

The memory MB limit of the

Integer
42

resource pool. Set to -1 if the


memory usage is unlimited.
MemoryExpandableReservation

True if the memory


reservation can grow beyond
the value specified in
MemoryReservation.

Boolean

MemoryUnlimited

True, if the memory usage is


unlimited. Otherwise, false.

Boolean

Overall Health

The overall health of the


resource pool. Green
indicates under committed;
yellow indicates
overcommitted, and red
indicates inconsistent.

String

Resource Pool Path

The path of the resource


pool.

String

Virtual Machine Path

The paths of all the virtual


machines in the resource
pool.

String

Configuring the Get Resource Pool Runtime InfoProperties Activity


The following procedure describes the steps required to configure a Get Resource Pool Runtime
InfoProperties activity.
To configure the Get Resource Pool Runtime InfoProperties activity
1.

From the Activities pane, drag a Get Resource Pool Runtime InfoProperties activity to the active
runbook.

2.

Double-click the Get Resource Pool Runtime InfoProperties activity icon. The Properties dialog
box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
43

the data output by a previous activity in the workflow.


4.

Click Finish.

Get Resource Pools Activity


The Get Resource Pools activity is used in a runbook to retrieve a list of all the resource pools in
managed by the VMware vSphere system. This allows the runbook to retrieve the resources
pools before using the Get Resource Pool Runtime Info Activity.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Get Resource Pools Activity Required Properties
No required properties are provided for this
activity.

Get Resource Pools Activity Optional Properties


No optional properties are provided for this
activity.

Get Resource Pools Activity Published Data


Name

Description

Value Type

Resource Pool

A list of resource pool paths within the vCenter


server.

String

Configuring the Get Resource Pools Activity


The following procedure describes the steps required to configure a Get Resource Pools activity.
To configure the Get Resource Pools Activity
1. From the Activities pane, drag a Get Resource Pools activity to the active runbook.
2. Double-click the Get Resource Pools activity icon. The Properties dialog box opens.
3. Configure the settings in the Properties tab as follows:
44

a. In the Configuration section, click the ellipsis button (...), and then select the VMware
vSphere server connection that you want to use for this activity. Click OK.
4. Click Finish.

Get VM List Activity


The Get VM List activity is used in a runbook retrieve the virtual hardware information about a
virtual machine in the VMware vSphere inventory. This allows the runbook to retrieve the
information of the virtual machine and populate it into a CMDB.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Get VM List Activity Required Properties
No required properties are provided for this
activity.

Get VM List Activity Optional Properties


No optional properties are provided for this
activity

Get VM List Activity Filters


Name

Description

Value Type

Datacenter

The datacenter hosting the VMs.

String

Host/Cluster

The vSphere Host hosting the VMs.

String

ID

The identifier of the VM.

String

VM Name

The name of the VM.

String

VM path

The full path of the VM.

String

45

Get VM List Activity Published Data


Name

Description

Value Type

ID

The identifier of the VM.

String

VM Count

The number of VMs returned.

String

VM Name

The name of the VM.

String

VM Path

The full path of the VM on the vCenter server.

String

Configuring the Get VM List Activity


The following procedure describes the steps required to configure a Get VM List activity.
To configure the Get VM List Activity
1. From the Activities pane, drag a Get VM List activity to the active runbook.
2. Double-click the Get VM List activity icon. The Properties dialog box opens.
3. Configure the settings in the Properties tab as follows:
a. In the Configuration section, click the ellipsis button (...), and then select the VMware
vSphere server connection that you want to use for this activity. Click OK.
4. On the Filters tab, click Add to add the filters required to restrict the published data.
5. Click Finish.

Get VM Properties Activity


The Get VM Properties activity is used in a runbook retrieve the virtual hardware information
about a virtual machine in the VMware vSphere inventory. This, for example, enables the runbook
to retrieve the information of the virtual machine and populate it into a CMDB.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.

46

Get VM Properties Activity Required Properties


Name

Description

Valid Values

VM Path

The path of the virtual machine in the vSphere


hierarchy.

String

Get VM Properties Activity Optional Properties


No optional properties are provided for this
activity

Get VM Properties Activity Published Data


Name

Description

Value Type

Address Type

Theee address type of the Network Interface


MAC address

String

Hard Disks

A list of device IDs for the virtual disks connected


to the VM.

Integer

Host name

The DNS host name assigned to the guest VM.

String

MAC Address

The MAC address of the VMs primary network


interface.

String

Memory MB

The memory allocated to the VM in megabytes.

String

VM Path

The path of the virtual machine in the vSphere


hierarchy.

String

Configuring the Get VM Properties Activity


The following procedure describes the steps required to configure a Get VM Properties activity.
To configure the Get VM Properties Activity
1.

From the Activities pane, drag a Get VM Properties activity to the active runbook.

2.

Double-click the Get VM Properties activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
47

server connection that you want to use for this activity. Click OK.
b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Get VM Status Activity


The Get VM Status activity is used in a runbook to retrieve the state and other related information
about a virtual machine. This, for example, enables the runbook to retrieve the current status of a
virtual machine to ensure that is has been properly shut down before performing a backup.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Get VM Status Activity Required Properties
Element

Description

Valid Values

VM Path

The path of the virtual machine to retrieve the


status for.

String

Get VM Status Activity Optional Properties


No optional properties are provided for this
activity.

Get VM Status Activity Published Data


Name

Description

Value Type

CPU Usage

The current CPU usage of the virtual machine

Integer

Computer Name

The computer name assigned to the guest


operating system.

String

Disk Capacity(MB)

The size of the virtual disk in megabytes.

Integer
48

IP Address

The primary IP address of the virtual machine.

String

Memory Size (MB)

The amount of memory assigned to the virtual


machine in megabytes.

Integer

Name

The name of the virtual machine.

String

Network List

The list of networks that this virtual machine is


connected to.

String

Number of CPU

The number of CPUs that are assigned to this


virtual machine.

Integer

Physical Path

The path on the file system where the virtual


machine configuration file can be found.

String

Power State

The current power state of the virtual machine.

String

VM Folder

The vCenter managed folder containing this


virtual machine.

String

VM OS Full Name

The full name of the guest operating system.

String

VM Path

The full path of the virtual machine on the


vCenter server.

String

VM UUID

The UUID of the virtual machine as assigned by


the vCenter server.

String

Configuring the Get VM Status Activity


The following procedure describes the steps required to configure a Get VM Status activity.
To configure the Get VM Status Activity
1.

From the Activities pane, drag a Get VM Status activity to the active runbook.

2.

Double-click the Get VM Status activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.
49

4.

Click Finish.

Maintenance Mode Activity


The Maintenance Mode activity is used in a runbook to enter and exit maintenance mode for an
ESX host controlled by the VMware vSphere vCenter server. Entering maintenance mode
prevents VMs powering up or failing over to the host if it is taking part in a high availability cluster.
This allows the runbook to enable Maintenance mode before powering off the host for hardware
maintenance.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Maintenance Mode Activity Required Properties
Element

Description

Valid Values

Host

The path of the managed host controlled by the


vSphere VMware server.

String

Operation

The action that is to be performed, selected from


a drop-down list.

Enter causes the


Exit causes the

Maintenance Mode Activity Optional Properties


Element

Description

Valid Values

Evacuate Powered Off VMs

If true, the activity will not succeed on a non-DRS


cluster unless all powered-off virtual machines have
been manually reregistered.

Boolean

On a DRS-enabled cluster, vCenter will


automatically reregister powered-off virtual
machines.
Timeout (Seconds)

The time in seconds for the operation to complete

50

Integer

Maintenance Mode Activity Published Data


Name

Description

Value Type

Host

The path of the managed host controlled by the


vSphere VMware server.

String

Operation

The action that is to be performed, selected from


a drop-down list.

String

Evacuate Powered Off VMs

If true, the activity will not succeed on a nonDRS cluster unless all powered-off virtual
machines have been manually reregistered. On
a DRS-enabled cluster, vCenter will
automatically reregister powered off virtual
machines.

Boolean

Timeout (Seconds)

The time in seconds for the operation to


complete.

Integer

Configuring the Maintenance Mode Activity


The following procedure describes the steps required to configure a Maintenance Mode activity.
To configure the Maintenance Mode Activity
1.

From the Activities pane, drag a Maintenance Mode activity to the active runbook.

2.

Double-click the Maintenance Mode activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

51

Migrate VM Activity
The Migrate VM activity is used in a runbook to migrate a virtual machine in any state (powered
on, powered off, or suspended) to another computer. This allows the runbook to change the host
system association when the host computer is upgraded. When a virtual machine is migrated only
the host computer association is changed, the disk files are not moved. To move the disk files and
change the host association, the Move VM activity must be used.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Migrate VM Activity Required Properties
Element

Description

Valid Values

Destination Host System

The path to the destination host system.

String

Destination Resource Pool

The path to the destination resource pool that the


migrated virtual machine will use.

String

Move Priority

The priority level for the migration operation

String

VM Path

The path to the virtual machine to be migrated

String

Migrate VM Activity Optional Properties


No optional properties are provided for this
activity.

Migrate VM Activity Published Data


Name

Description

Value Type

Destination Host System.

The path to the destination host system

String

Destination Resource Pool

The path to the destination resource pool.

String

Move Priority

The priority level assigned to the migration.

String

VM Path

The path to the virtual machine that was


migrated.

String

52

Configuring the Migrate VM Activity


The following procedure describes the steps required to configure a Migrate VM activity.
To configure the Migrate VM Activity
1.

From the Activities pane, drag a Migrate VM activity to the active runbook.

2.

Double-click the Migrate VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware
vSphere server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the
applicable optional properties. If the property is Lookup-enabled, you can click the ellipsis
() button next to the text box to browse for a value.
You can also use published data to automatically populate the value of the
property from the data output by a previous activity in the workflow.

4.

Click Finish.

Modify VM Disk Activity


The Modify VM Disk activity is used in a runbook to attach a virtual disk to a different virtual
device node within a virtual machine. When targeting version vCenter 5.0 or greater it can also be
used to extend the disk size of the selected disk.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Modify VM Disk Activity Required Properties
Element

Description

Valid Values

Look up

VM Path

The path of the virtual


machine containing
the virtual disk.

String

Yes

SCSI Bus Number

The SCSI bus


number of the SCSI
controller which the
disk is attached to.

Integer

No

SCSI Unit Key

The SCSI unit key of

Integer

No
53

the disk.

Modify VM Disk Activity Optional Properties


Element

Description

Valid Values

Look up

New Disk Size (GB)

The desired size of


the extended disk in
gigabytes.

Integer

No

New SCSI Bus


Number

The SCSI bus


number of the target
SCSI controller to
attach the disk to.

Integer

No

New SCSI Unit Key

The new SCSI unit


key of the disk.

Integer

No

Modify VM Disk Activity Published Data


Name

Description

Value Type

VM Path

The path of the virtual machine


containing the virtual disk.

String

SCSI Bus Number

The SCSI bus number of the


SCSI controller which the disk
is attached to.

Integer

SCSI Unit Key

The SCSI unit key of the disk.

Integer

New Disk Size (GB)

The desired size of the


extended disk in gigabytes.

Integer

New SCSI Bus Number

The SCSI bus number of the


target SCSI controller to attach
the disk to.

Integer

New SCSI Unit Key

The new SCSI unit key of the


disk.

Integer

Configuring the Modify VM Disk Activity


The following procedure describes the steps required to configure ana Modify VM Disk activity.
To configure the Modify VM Disk Activity

54

1.

From the Activities pane, drag a Modify VM Disk activity to the active runbook.

2.

Double-click the Modify VM Disk activity icon.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Move VM Activity
The Move VM activity is used in a runbook to move the virtual disk to a specific location, and can
also associate the virtual machine with a different host. This allows the runbook to move virtual
machines from one host to another. When a virtual machine is moved, the disk files are moved
and the host association is changed. To change the host association without moving the disk files,
use the Migrate VM activity.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Move VM Activity Required Properties
Element

Description

Valid Values

Destination Datastore

The name of the data store that the moved virtual


machine will use. If you leave this field blank, the
current data store is used.

String

Destination Host System

The path of the destination host system.

String

Destination Resource Pool

The path of the destination resource pool that the


moved virtual machine will use. If you leave this
field blank:

String

The current host is used if the resource pool is not


specified.
55

VM Path

If the resource pool is specified, and the target pool


represents a stand-alone host, the stand-alone host
is used.

If the resource pool is specified, and the target pool


represents a DRS-enabled cluster, a host selected
by DRS is used. You cannot specify a target pool
that represents a cluster where DRS is not enabled.

The path to the virtual machine to be moved.

String

Move VM Activity Optional Properties


No optional properties are provided for this
activity.

Move VM Activity Published Data


Name

Description

Value Type

Destination Datastore

The name of the datastore that the moved


virtual machine will use.

String

Destination Host System

The path of the destination host system.

String

Destination Resource Pool

The path of the destination resource pool.

String

VM Path

The path to the virtual machine that was moved.

String

Configuring the Move VM Activity


The following procedure describes the steps required to configure a Move VM activity.
To configure the Move VM Activity
1.

From the Activities pane, drag a Move VM activity to the active runbook.

2.

Double-click the Move VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
56

You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.
4.

Click Finish.

Reconfigure VM Activity
The Reconfigure VM activity is used in a runbook to change the hardware settings of a virtual
machine. This allows the runbook to increase the number of CPUs and Memory to increase the
availability of the application running in the guest operating system.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Reconfigure VM Activity Required Properties
Element

Description

Valid Values

Notes

The notes associated with the virtual machine.

String

VM Path

The path of the virtual machine to be reconfigured.

String

Reconfigure VM Activity Optional Properties


Element

Description

Valid Values

After Power On Script

Indicates whether a script will be run after the


virtual machine is powered on.

String

After Resume Script

Indicates whether a script will be run after the


virtual machine is resumed from standby.

String

Before Guest Shutdown Script

Indicates whether a script will be run before the


virtual machine is shut down.

String

Before Guest Standby Script

Indicates whether a script will be run before the


virtual machine is put into standby.

String

CPUs

The number of CPUs assigned to the virtual


machine

Integer

CPU Limit Specified

Must be true if a CPU Limit has been specified.

Boolean

CPU Reservation (MHz)

The amount of CPU resources that are reserved

Integer

57

for the VM, in megahertz.


CPU Reservation Specified

Must be true if CPU Reservation is specified.

Boolean

CPU Shares Level

The relative CPU priority given to this VM. Custom,


low, normal, high.

String

CPU Limit(-1 means unlimited)

The CPU utilization limit for the VM within the


resource pool.

Integer

Custom CPU Shares Level

The CPU Shares Level property must be set to


custom for this property to be processed.

Integer

Custom Memory Shares Level

The Memory Shares Level property must be set to


custom for this property to be processed.

Integer

Memory

The amount of memory assigned to the virtual


machine

Integer

Memory Limit Specified

Must be true if a Memory Limit has been specified.

Boolean

Memory Limit(-1 means unlimited)

The memory utilization limit for the VM within the


resource pool.

Integer

Memory Reservation (MB)

The amount of memory resources that are


reserved for the VM, in megabytes.

Integer

Memory Reservation Specified

Must be true if Memory Reservation is specified.

Boolean

Memory Shares Level

The relative Memory priority given to this VM.


Custom, low, normal, high.

String

Power Off Type

The action that will occur when the virtual machine


is instructed to power off.

String

Reset Type

The action that will occur when the virtual machine


is instructed to reset.

String

Suspend Type

The action that will occur when the virtual machine


is instructed to suspend.

String

VM Name

The new name of the virtual machine.

String

Reconfigure VM Activity Published Data


Name

Description

Value Type

After Power On Script

Indicates whether a script will be run after the


virtual machine is powered on.

String

After Resume Script

Indicates whether a script will be run after the

String

58

virtual machine is resumed from standby.


Before Guest Shutdown Script

Indicates whether a script will be run before the


virtual machine is shut down.

String

Before Guest Standby Script

Indicates whether a script will be run before the


virtual machine is put into standby.

String

CPUs

The number of CPUs assigned to the virtual


machine.

Integer

CPU Limit Specified

Must be true if a CPU Limit has been specified.

Boolean

CPU Reservation (MHz)

The amount of CPU resources that are reserved


for the VM, in megahertz.

Integer

CPU Reservation Specified

Must be true if CPU Reservation is specified.

Boolean

Custom CPU Shares Level

The relative CPU priority given to this VM.


Custom, low, normal, high.

String

CPU Limit

The CPU utilization limit for the VM within the


resource pool.

Integer

Custom CPU Shares Level

The CPU Shares Level property must be set to


custom for this property to be processed.

Integer

Custom Memory Shares Level

The Memory Shares Level property must be set


to custom for this property to be processed.

Integer

Memory

The amount of memory assigned to the virtual


machine.

Integer

Memory Limit Specified

Must be true if a Memory Limit has been


specified.

Boolean

Memory Limit

The memory utilization limit for the VM within the


resource pool.

Integer

Memory Reservation (MB)

The amount of memory resources that are


reserved for the VM, in megabytes.

Integer

Memory Reservation Specified

Must be true if Memory Reservation is specified.

Boolean

Memory Shares Level

The relative Memory priority given to this VM.


Custom, low, normal, high.

String

Notes

The notes associated with the virtual machine.

String

Power Off Type

The action that occurs when the virtual machine


is instructed to power off.

String

Reset Type

The action that occurs when the virtual machine

String

59

is instructed to reset.
Suspend Type

The action that occurs when the virtual machine


is instructed to suspend.

String

VM Name

The new name of the virtual machine.

String

VM Path

The path to the virtual machine to be


reconfigured.

String

Configuring the Reconfigure VM Activity


The following procedure describes the steps required to configure a Reconfigure VM activity.
To configure the Reconfigure VM Activity
1.

From the Activities pane, drag a Reconfigure VM activity to the active runbook.

2.

Double-click the Reconfigure VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Reset VM Activity
The Reset VM activity is used in a runbook to stop and restart a running virtual machine. This
allows the runbook to reset a virtual machine of a VMware vSphere server that is no longer
responding to ping commands.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.

60

Reset VM Activity Required Properties


Element

Description

Valid Values

VM Path

The path of the virtual machine to be reset.

String

Reset VM Activity Optional Properties


No optional properties are provided for this
activity

Reset VM Activity Published Data


Name

Description

Value Type

VM Path

The path of the virtual machine.

String

Configuring the Reset VM Activity


The following procedure describes the steps required to configure a Reset VM activity.
To configure the Reset VM Activity
1.

From the Activities pane, drag a Reset VM activity to the active runbook.

2.

Double-click the Reset VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

61

Revert VM Snapshot Activity


The Revert VM Snapshot activity is used in a runbook to revert a virtual machine to the last
available snapshot. This allows the runbook to revert a snapshot to its previous state after you
have finished using it.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Revert VM Snapshot Activity Required Properties
Element

Description

Valid Values

VM Path

The path of the VM to be reverted.

String

Revert VM Snapshot Activity Optional Properties


Name

Description

Valid Values

Revert to Snapshot

The path of the snapshot to be reverted.

String

Revert VM Snapshot Activity Published Data


Name

Description

Value Type

VM Path

The path of the VM that was reverted.

String

Revert to Snapshot

The path of the snapshot that was reverted.

String

Configuring the Revert VM Snapshot Activity


The following procedure describes the steps required to configure a Revert VM Snapshot activity.
To configure the Revert VM Snapshot Activity
1.

From the Activities pane, drag a Revert VM Snapshot activity to the active runbook.

2.

Double-click the Revert VM Snapshot activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
62

server connection that you want to use for this activity. Click OK.
b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Set VM CD/DVD to ISO Image Activity


The Set VM CD/DVD to ISO Image activity is used in a runbook to set the CD/DVD drive of a
virtual machine to an ISO image. This allows the runbook to attach a CD/DVD image of a
software application for automatic provisioning.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Set VM CD/DVD to ISO Image Activity Required Properties
Element

Description

Valid Values

Datastore

The path of the datastore that contains the ISO


image.

String

Relative File Path

The path to the ISO image relative to the host and


datastore.

String

VM Path

The path to the virtual machine.

String

Set VM CD/DVD to ISO Image Activity Optional Properties


No optional properties are provided for this
activity.

Set VM CD/DVD to ISO Image Activity Published Data


Name

Description

Valid Values

Datastore

The path of the datastore that contains the ISO

String

63

image.
VM Path

The path to the virtual machine.

String

Configuring the Set VM CD/DVD to ISO Image Activity


The following procedure describes the steps required to configure a Set VM CD/DVD to ISO
Image activity.
To configure the Set VM CD/DVD to ISO Image Activity
1.

From the Activities pane, drag a Set VM CD/DVD to ISO Image activity to the active runbook.

2.

Double-click the Set VM CD/DVD to ISO Image activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Set VM Networks Activity


The Set VM Networks activity is used in a runbook to replace the first virtual machine network
switch with one that is specified. This allows the runbook to change the network switch that a
virtual machine is using.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Set VM Networks Activity Required Properties
Element

Description

Valid Values

Network Adapter 1

The name of the network that the first network

String

64

adapter is attached to.


Network Adapter 2

The name of the network that the second network


adapter is attached to.

String

Network Adapter 3

The name of the network that the third network


adapter is attached to.

String

Network Adapter 4

The name of the network that the fourth network


adapter is attached to.

String

VM Path

The path to the virtual machine.

String

Set VM Networks Activity Optional Properties


No optional properties are provided for this
activity.

Set VM Networks Activity Published Data


Name

Description

Value Type

Network Adapter 1

The name of the network that the first network


adapter is attached to.

String

Network Adapter 2

The name of the network that the second


network adapter is attached to.

String

Network Adapter 3

The name of the network that the third network


adapter is attached to.

String

Network Adapter 4

The name of the network that the fourth network


adapter is attached to.

String

VM Path

The path to the virtual machine.

String

Configuring the Set VM Networks Activity


The following procedure describes the steps required to configure a Set VM Networks activity.
To configure the Set VM Networks Activity
1.

From the Activities pane, drag a Set VM Networks activity to the active runbook.

2.

Double-click the Set VM Networks activity icon. The Properties dialog box opens.

65

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Start VM Activity
The Start VM activity is used in a runbook to start a virtual machine that has been added to a
VMware vSphere server and is not already running. The Start VM activity waits for the guest
operating system to complete its boot up sequence before continuing to the next object in the
runbook. This allows the runbook to start a virtual machine after it has been paused by the
Suspend VM activity.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Start VM Activity Required Properties
Element

Description

Valid Values

VM Path

The path of the virtual machine to be started.

String

Start VM Activity Optional Properties


Element

Description

Valid Values

Timeout (seconds)

The time allowed for the start operation to


complete.

Integer

66

Start VM Activity Published Data


Name

Description

Value Type

VM Path

The path of the virtual machine that was started.

String

Configuring the Start VM Activity


The following procedure describes the steps required to configure a Start VM activity.
To configure the Start VM activity
1.

From the Activities pane, drag a Start VM activity to the active runbook.

2.

Double-click the Start VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Stop VM Activity
The Stop VM activity is used in a runbook to stop a virtual machine that has already been added
to a VMware vSphere server. This allows the runbook to stop a virtual machine before deleting it
using the Delete VM activity.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.

67

Stop VM Activity Required Properties


Element

Description

Valid Values

Gracefully shutdown

Indicates whether the guest operating system is


shut down instead of powered off.

Boolean

VM Path

The path to the virtual machine.

String

Stop VM Activity Optional Properties


No optional properties are provided for this
activity.

Stop VM Activity Published Data


Name

Description

Value Type

Gracefully shut down

Indicates whether the guest operating system is


shut down instead of powered off.

Boolean

VM Path

The path to the virtual machine.

String

Configuring the Stop VM Activity


The following procedure describes the steps required to configure a Stop VM activity.
To configure the Stop VM Activity
1.

From the Activities pane, drag a Stop VM activity to the active runbook.

2.

Double-click the Stop VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

68

4.

Click Finish.

Suspend VM Activity
The Suspend VM activity is used in a runbook to suspend a virtual machine that has already been
added to a VMware vSphere server and is already running. This, for example, enables the
runbook to suspend a running virtual machine before backing it up. Then use the Start VM activity
to start it again.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Suspend VM Activity Required Properties
Element

Description

Valid Values

Enter standby mode

Indicates that the guest operating system will be


put in standby mode. If standby mode is not
supported by the guest operating system, this
option will be ignored.

Boolean

VM Path

The path to the virtual machine to be suspended

String

Suspend VM Activity Optional Properties


No optional properties are provided for this
activity.

Suspend VM Activity Published Data


Name

Description

Value Type

Enter standby mode

Indicates whether the Enter standby mode


option was selected

Boolean

VM Path

The path to the virtual machine that was


suspended

String

69

Configuring the Suspend VM Activity


The following procedure describes the steps required to configure a Suspend VM activity.
To configure the Suspend VM Activity
1.

From the Activities pane, drag a Suspend VM activity to the active runbook.

2.

Double-click the Suspend VM activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

Take VM Snapshot Activity


The Take VM Snapshot activity is used in a runbook to take a snapshot of a running virtual
machine on a VMware vSphere server and enable a new name and description to be assigned to
the snapshot. This allows the runbook to create a new virtual machine based on the configuration
of an existing one.
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data.
Additional published data is generated based on the class that you select when you define the
activity.
Take VM Snapshot Activity Required Properties
Element

Description

Valid Values

Snapshot Name

A name for the snapshot being created.

String

Snapshot VM Memory

Indicates whether the source virtual machines


memory is included in the snapshot

Boolean

VM Path

The path to the virtual machine to take a snapshot


of

String

70

Take VM Snapshot Activity Optional Properties


Element

Description

Valid Values

Snapshot Description

A description of the snapshot to be created.

String

Take VM Snapshot Activity Published Data


Name

Description

Value Type

Snapshot Description

A description of the snapshot that was created.

String

Snapshot Name

The name of the snapshot.

String

Snapshot VM Memory

Indicates whether the source virtual machines


memory was included in the snapshot.

Boolean

VM Path

The path to the virtual machine from which the


snapshot was taken.

String

Configuring the Take VM Snapshot Activity


The following procedure describes the steps required to configure a Take VM Snapshot activity.
To configure the Take VM Snapshot activity
1.

From the Activities pane, drag a Take VM Snapshot activity to the active runbook.

2.

Double-click the Take VM Snapshot activity icon. The Properties dialog box opens.

3.

Configure the settings in the Properties tab as follows:


a.

In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere
server connection that you want to use for this activity. Click OK.

b.

In the Properties section, enter a value for each of the required properties and the applicable
optional properties. If the property is Lookup-enabled, you can click the ellipsis () button next
to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from
the data output by a previous activity in the workflow.

4.

Click Finish.

71

You might also like