Professional Documents
Culture Documents
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
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
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.
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.
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.
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.
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.
Suspend VM Activity
Take VM Snapshot 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.
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.
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
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.
Description
Valid
Adapter Type
Strin
Connection at Power On
Bool
Network
Strin
VM Path
Strin
Description
Value Type
Adapter type
String
Connection at Power On
Boolean
Network
String
11
VM path
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.
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.
12
String
Description
Valid Values
Integer
VM Path
String
Description
Valid Values
Datastore
The path of the data store that will hold the new
disk.
String
Integer
Integer
String
Description
Value Type
Datastore
String
Integer
Integer
Integer
VM Path
String
String
13
From the Activities pane, drag an Add VM Disk activity to the active runbook.
2.
3.
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.
Description
Valid Val
Integer
Customize
Boolean
Datastore Path
String
Folder Path
String
String
Integer
String
Boolean
String
String
Virtual Processors
Integer
15
Description
Valid Values
DHCP
Boolean
DNS Name
String
DNS Server
String
Domain Name
String
Gateway
String
IP Address
String
Subnet Mask
String
DNS Suffix
String
Description
Value Type
Integer
Customize
Boolean
Datastore Path
String
DHCP
Boolean
DNS Name
String
DNS Server
String
Domain Name
String
16
machine uses.
Folder Path
String
Gateway
String
String
IP Address
String
Memory Size(MB)
Integer
Boolean
String
String
Subnet Mask
String
DNS Suffix
String
String
Virtual Processors
Integer
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.
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.
o
o
o
o
o
o
Description
Valid Val
Integer
Customize
Boolean
Datastore Path
String
Folder Path
String
String
Integer
String
String
String
Virtual Processors
Integer
19
Description
Valid Values
Look up
Admin Password
String
No
Computer Name
String
No
DHCP
Indicates whether to
use DHCP for
assigning an IP
address to the cloned
virtual machine.
Boolean
Yes
DNS Name
String
No
DNS Server
String
No
Domain Name
String
No
String
No
Domain User
Password
String
No
Gateway
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
String
Yes
Maximum
Connections
The maximum
number of client
connections
configured as part of
the Windows Server
licensing settings.
Integer
No
Computer
Membership
String
Yes
Organization Name
String
No
Owners Name
String
No
Power on after
creation
Boolean
Yes
Product ID
String
No
21
String
No
DNS Suffix
String
No
Workgroup
String
No
Description
Value Type
Integer
Computer Membership
String
Computer Name
String
Customize
Boolean
Datastore Path
String
DHCP
Boolean
DNS Name
String
22
DNS Server
String
Domain Name
String
String
String
Folder Path
String
Gateway
String
String
IP Address
String
Boolean
License mode
String
Maximum Connections
Integer
Integer
Organization Name
String
Owners Name
String
Boolean
Product ID
String
String
String
Subnet Mask
String
DNS Suffix
String
23
String
Virtual Processors
Integer
Workgroup
String
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.
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
Description
Valid Values
Datastore Path
String
Folder Path
String
String
String
Memory (MB)
Integer
Nic (1-4)
String
Number Processors
Integer
Boolean
String
Integer
String
Description
Valid Values
String
25
Description
Value Type
Datastore Path
String
Folder Path
String
String
String
Memory(MB)
Integer
NIC 1
String
NIC 2
String
NIC 3
String
NIC 4
String
Boolean
String
String
Integer
String
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.
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
String
VM Path
String
27
Description
Value Type
Customization Spec
String
VM Path
String
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.
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.
Description
Valid Values
Look up
VM Path
String
Yes
MAC Address
String
No
Description
Value Type
VM Path
String
MAC Address
String
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.
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
String
Description
Value Type
VM Path
String
30
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.
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.
Description
Valid Values
Look up
VM Path
String
Yes
Integer
No
Integer
No
31
Description
Valid Values
Look up
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
Description
Value Type
VM Path
String
Integer
Integer
Boolean
32
From the Activities pane, drag a Delete VM Disk activity to the active runbook.
2.
3.
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.
Description
Valid Values
Cluster Path
String
Description
Value Type
Cluster Path
String
Datastore Names
String
Integer
Integer
Integer
Integer
Integer
Number of Hosts
Integer
Integer
Integer
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.
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
Click Finish.
Description
Valid Values
Datastore
String
Description
Value Type
Capacity
Integer
Free Space
Integer
Percent Free
Integer
35
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.
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.
Description
Valid Values
Host
String
activity.
Description
Value Type
Datastore
String
Host
String
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.
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.
Description
Valid Values
Host
String
Description
Value Type
Connection State
Connected
Not Responding
Disconnected
Host
String
In Maintenance Mode
True
Name
String
Overall Status
Gray (unknown)
False
Green (OK)
Yellow (warning)
Red (alarm)
Port
Integer
Power State
Powered On
Powered Off
Standby
String
Reboot Required
True
False
38
vMotion Enabled
True
False
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.
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.
activity.
Description
Value Type
Host
String
Description
Valid Valu
ResourcePool Path
String
40
Description
Value Type
CPUmaxUsage
Integer
CPUoverallUsage
Integer
CPUreservationUsed
Integer
CPUreservationUsedforVm
Integer
CPUunreservedForPool
Integer
CPUunreservedforVm
Integer
CpuSharesLevel
String
CpuShares
Integer
CpuReservation
Integer
41
CpuLimit
Integer
CpuExpandableReservation
Boolean
CpuUnlimited
Boolean
MemoryMaxUsage
Integer
MemoryOverallUsage
Integer
MemoryReservationUsed
Integer
MemoryReservationUsedForVm
Integer
MemoryUnreservedForPool
Integer
MemoryUnreservedForVm
Integer
MemorySharesLevel
String
MemoryShares
Integer
MemoryReservation
Integer
MemoryLimit
Integer
42
Boolean
MemoryUnlimited
Boolean
Overall Health
String
String
String
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.
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
Click Finish.
Description
Value Type
Resource Pool
String
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.
Description
Value Type
Datacenter
String
Host/Cluster
String
ID
String
VM Name
String
VM path
String
45
Description
Value Type
ID
String
VM Count
String
VM Name
String
VM Path
String
46
Description
Valid Values
VM Path
String
Description
Value Type
Address Type
String
Hard Disks
Integer
Host name
String
MAC Address
String
Memory MB
String
VM Path
String
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.
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.
Description
Valid Values
VM Path
String
Description
Value Type
CPU Usage
Integer
Computer Name
String
Disk Capacity(MB)
Integer
48
IP Address
String
Integer
Name
String
Network List
String
Number of CPU
Integer
Physical Path
String
Power State
String
VM Folder
String
VM OS Full Name
String
VM Path
String
VM UUID
String
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.
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.
Description
Valid Values
Host
String
Operation
Description
Valid Values
Boolean
50
Integer
Description
Value Type
Host
String
Operation
String
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)
Integer
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.
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
String
String
Move Priority
String
VM Path
String
Description
Value Type
String
String
Move Priority
String
VM Path
String
52
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.
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.
Description
Valid Values
Look up
VM Path
String
Yes
Integer
No
Integer
No
53
the disk.
Description
Valid Values
Look up
Integer
No
Integer
No
Integer
No
Description
Value Type
VM Path
String
Integer
Integer
Integer
Integer
Integer
54
1.
From the Activities pane, drag a Modify VM Disk activity to the active runbook.
2.
3.
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
String
String
String
VM Path
String
Description
Value Type
Destination Datastore
String
String
String
VM Path
String
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.
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
String
VM Path
String
Description
Valid Values
String
String
String
String
CPUs
Integer
Boolean
Integer
57
Boolean
String
Integer
Integer
Integer
Memory
Integer
Boolean
Integer
Integer
Boolean
String
String
Reset Type
String
Suspend Type
String
VM Name
String
Description
Value Type
String
String
58
String
String
CPUs
Integer
Boolean
Integer
Boolean
String
CPU Limit
Integer
Integer
Integer
Memory
Integer
Boolean
Memory Limit
Integer
Integer
Boolean
String
Notes
String
String
Reset Type
String
59
is instructed to reset.
Suspend Type
String
VM Name
String
VM Path
String
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.
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
Description
Valid Values
VM Path
String
Description
Value Type
VM Path
String
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.
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
Description
Valid Values
VM Path
String
Description
Valid Values
Revert to Snapshot
String
Description
Value Type
VM Path
String
Revert to Snapshot
String
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.
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.
Description
Valid Values
Datastore
String
String
VM Path
String
Description
Valid Values
Datastore
String
63
image.
VM Path
String
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.
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.
Description
Valid Values
Network Adapter 1
String
64
String
Network Adapter 3
String
Network Adapter 4
String
VM Path
String
Description
Value Type
Network Adapter 1
String
Network Adapter 2
String
Network Adapter 3
String
Network Adapter 4
String
VM Path
String
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.
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
String
Description
Valid Values
Timeout (seconds)
Integer
66
Description
Value Type
VM Path
String
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.
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
Description
Valid Values
Gracefully shutdown
Boolean
VM Path
String
Description
Value Type
Boolean
VM Path
String
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.
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
Boolean
VM Path
String
Description
Value Type
Boolean
VM Path
String
69
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.
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.
Description
Valid Values
Snapshot Name
String
Snapshot VM Memory
Boolean
VM Path
String
70
Description
Valid Values
Snapshot Description
String
Description
Value Type
Snapshot Description
String
Snapshot Name
String
Snapshot VM Memory
Boolean
VM Path
String
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.
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