Cisco TEO Adapter Guide for VMware
Release 2.3.4
October 2012
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Text Part Number: OL-24933-02
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this
URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display
output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in
illustrative content is unintentional and coincidental.
Cisco TEO Adapter Guide for VMware
© 2011–2012 Cisco Systems, Inc. All rights reserved.
CONTENTS
New and Changed Information
Preface
ix
xi
Organization
xi
Conventions
xii
Product Documentation xiii
Documentation Formats xiii
Guides and Release Notes xiii
Online Help xiii
Open Source License Acknowledgements
xiv
Obtaining Documentation and Submitting a Service Request
CHAPTER
1
Configuring VMware Adapter
1-1
Adapter System Requirements
Supported VMware Products
xiv
1-2
1-2
Accessing VMware Adapter Properties
1-3
Configuring HTTPS Protocol 1-4
VMware Virtual Center HTTPS Protocol 1-4
Configuring the ESX HTTPS Protocol 1-4
Configuring the Keystore Password
1-5
Viewing VMware Adapter Prerequisites
1-6
Viewing VMware Adapter-Supported Objects
Viewing VMware Adapter History
CHAPTER
2
Managing VMware Targets
1-7
1-8
2-1
Accessing Definitions—Targets 2-2
Details Pane 2-3
Viewing Target Properties 2-3
Target Descriptions 2-4
Target Algorithms 2-4
Defining a VMware ESX Server Target
2-5
Defining a VMware Virtual Center Server Target
Managing Target Definitions
2-8
2-11
Cisco TEO Adapter Guide for VMware
OL-24933-02
iii
Contents
Enabling a Target 2-11
Disabling a Target 2-11
Modifying Targets 2-12
Defining Target Criteria 2-12
Comparison Operators 2-14
Inserting a Target Variable Reference 2-15
Creating a Copy of a Target 2-17
Deleting a Target 2-17
Viewing Member Of Properties 2-18
Viewing Extended Properties 2-18
Modifying Extended Property Values 2-19
Viewing Used By Properties 2-19
Viewing Targets History 2-20
CHAPTER
3
Managing Runtime Users
3-1
Accessing Definitions—Runtime Users
Actions Menu and Toolbar 3-3
Runtime User Details Pane 3-3
Defining a Runtime User Account
3-2
3-4
Managing Runtime User Definitions 3-6
Modifying a Runtime User Record 3-6
Deleting a Runtime User 3-6
Viewing Used By Properties 3-6
Viewing Runtime User History 3-7
CHAPTER
4
Managing VMware Triggers
4-1
Accessing Trigger Properties 4-2
VMware Trigger Descriptions 4-3
Common Wildcard Expressions 4-3
Defining a VMware Host Performance Event Trigger
4-4
Defining a VMware Virtual Machine Performance Event Trigger
Defining a VMware Virtual Machine Power Event Trigger
4-9
4-12
Managing Trigger Definitions 4-15
Enabling a Trigger 4-15
Disabling a Trigger 4-15
Modifying Triggers 4-15
Adding Basic Conditions to an Object 4-16
Adding Advanced Conditions to an Object 4-17
Defining Target Criteria for Trigger 4-19
Cisco TEO Adapter Guide for VMware
iv
OL-24933-02
Contents
Selecting Performance Counters to Monitor
Deleting Triggers 4-21
CHAPTER
5
VMware Activities Overview
5-1
Defining a VMware Activity
5-2
4-20
Managing VMware Activity Definitions 5-5
Modifying a VMware Activity 5-5
Selecting a Managed Object 5-6
Adding a Script Argument 5-6
Script Argument Syntax 5-7
Modifying a Script Argument 5-7
Removing a Script Argument 5-7
Inserting Activity Variable References 5-8
Viewing Activity Instance Information 5-11
Viewing Activity Status 5-11
Status Indicators 5-11
Color Indicators 5-11
Viewing Activity Instance Properties 5-12
Viewing Host Instance Information 5-12
Viewing VM Instance Information 5-14
CHAPTER
6
VMware Configuration Management Activities
VMware Configuration Activities
6-1
6-2
Defining the Add VM Hard Disk Activity 6-4
Adding a VM Hard Disk using an Existing Virtual Disk 6-7
Adding a VM Hard Disk using Raw Device Mappings 6-8
Defining the Add VM Network Adapter Activity
Defining the Clone VM Activity
6-13
Defining the Create Folder Activity
6-16
Defining the Create New VM Activity
6-19
Defining the Customize Linux VM Activity
6-21
Defining the Customize Windows VM Activity
Defining the Delete VM Activity
6-27
6-35
Defining the Enumerate Datastores Activity
Defining the Enumerate Networks Activity
6-38
6-40
Defining the Enumerate Resource Pools Activity
Defining the Migrate VM Activity
6-10
6-43
6-45
Cisco TEO Adapter Guide for VMware
OL-24933-02
v
Contents
Defining the Query VM Devices Activity
6-48
Defining the Query VM Network Adapters Activity
Defining the Query VM Properties Activity
Defining the Query VMs Activity
6-50
6-52
6-54
Defining the Reconfigure VM Activity
Defining the Relocate VM Activity
6-56
6-59
Defining the Remove VM Device Activity
Defining the Update VM Hard Disk
6-62
6-64
Defining the Update VM Network Adapter
6-67
Defining the Upgrade VM Hardware Activity
6-70
Defining the Upgrade VM Tools 6-72
VMware Command Line Options 6-74
Managing VMware Configuration Activity Definitions
Configuring IP Address Settings 6-76
Configuring Network Properties 6-77
6-76
Viewing VMware Configuration Activity Results 6-78
Viewing Enumerate Datastores Activity Results 6-78
Viewing Enumerate Networks Activity Results 6-79
Viewing Enumerate Resource Pools Activity Results 6-80
Viewing Query VMs Activity Results 6-82
Viewing Query VM Devices Activity Results 6-83
Viewing Query VM Network Adapters Activity Results 6-84
CHAPTER
7
VMware Host Management Activities
VMware Host Activities
7-1
7-2
Defining the Add Host Activity
7-3
Defining the Add Host Port Group Activity
7-7
Defining the Enter VM Host Maintenance Mode Activity
Defining the Exit VM Host Maintenance Mode Activity
Defining the Power Down Host to Standby Activity
7-14
Defining the Power Up Host from Standby Activity
7-17
Defining the Query Host Network Adapters Activity
Defining the Query Host Properties Activity
7-11
7-19
7-21
Defining the Query Host Storage Adapters Activity
Defining the Query Hosts Activity
7-9
7-23
7-25
Defining the Reboot VM Host Activity
7-27
Defining the Remove ESX Server Activity
7-30
Cisco TEO Adapter Guide for VMware
vi
OL-24933-02
Contents
Defining the Shutdown Host Activity
7-32
Defining the Update Host Port Group Activity
7-35
Viewing VMware Host Activity Results 7-37
Viewing Query Host Network Adapters Results 7-37
Viewing Query Host Storage Adapters Activity Results
Viewing Query Hosts Activity Results 7-40
CHAPTER
8
VMware Power Management Activities
VMware Power Activities
8-1
8-2
Defining the Execute PowerCLI Script Activity
PowerCLI Example 8-6
Defining the Power Off VM Activity
8-6
Defining the Power On VM Activity
8-8
Defining the Reboot Guest Activity
8-11
Defining the Reset VM Activity
Defining the Standby Guest Activity
Defining the Suspend VM Activity
8-15
8-18
8-20
Viewing Execute PowerCLI Script Results
9
8-22
VMware Snapshot Management Activities
VMware Snapshot Activities
8-3
8-13
Defining the Shutdown Guest Activity
CHAPTER
7-39
9-1
9-2
Defining the Create Snapshot Activity
9-3
Defining the Query VM Snapshots Activity
9-6
Defining the Remove All Snapshots Activity
Defining the Remove Snapshot Activity
9-10
Defining the Rename Snapshot Activity
9-12
9-8
Defining the Revert to Current Snapshot Activity
Defining the Revert to Snapshot Activity
9-14
9-17
INDEX
Cisco TEO Adapter Guide for VMware
OL-24933-02
vii
Contents
Cisco TEO Adapter Guide for VMware
viii
OL-24933-02
New and Changed Information
The primary goal for Tidal Enterprise Orchestrator 2.3 is to improve the product’s ability to address new
functionality provided by the supported VMware products in TEO. With the changes to the existing
features in the VMware adapter, TEO has added the ability to automate more cloud orchestration
scenarios.
The new VMware activities provide the ability to gather more data about the VMware hosts, virtual
centers, storage and network adapter settings. Additionally, new activities provide the ability to
customize specific operating system virtual machines, as well as add and modify VM devices. The
information queried can be used as input for other activities within TEO.
The following features have been added to this guide for Tidal Enterprise Orchestrator 2.3 and updated
for release 2.3.4.
Table 1
TEO 2.3 Release Feature Changes
Feature
Location
Improved the process for configuring SSL certificates for
VMware
Chapter 1, Configuring VMware
Adapter
New browse option provides the ability to query objects in Chapter 5, Using VMware Activities
hosts and virtual centers in activities based on defined
targets in TEO.
The following new activities have been created to improve Chapter 6, VMware Configuration
Management Activities
TEO’s cloud functionality using the VMware adapter.
•
Add VM Hard Disk
•
Add VM Network Adapter
•
Create Folder
•
Create New VM
•
Customize Linux VM
•
Customize Windows VM
•
Enumerate Datastores
•
Enumerate Networks
•
Enumerate Resource Pools
•
Query VM Devices
•
Update VM Hard Disk
•
Update VM Network Adapter
Cisco TEO Adapter Guide for VMware
OL-24933-02
ix
New and Changed Information
Table 1
TEO 2.3 Release Feature Changes
Feature
Location
The following new activities have been created to improve Chapter 7, VMware Host
TEO’s cloud functionality using the VMware adapter.
Management Activities
•
Add Host Port Group
•
Query Host Network Adapters
•
Update Host Port Group
The Execute PowerCLI Script specifies the script
Chapter 8, VMware Power
command to execute using the VMware vSphere PowerCLI Management Activities
module.
Cisco TEO Adapter Guide for VMware
x
OL-24933-02
Preface
Revised: October 2012, OL-24933-02
The VMware adapter on Tidal Enterprise Orchestrator allows users to connect a virtual infrastructure
(VMware Virtual Center and ESX server) and automate the process of managing virtual machines and
their hosts based on specific criteria. Users are able to set up a HTTP/HTTPS connection to the
ESX/ESXi Server and Virtual Center Server using the VMware adapter.
The VMware adapter supports the following VMware infrastructure environments:
•
VMware vSphere 4.0 or later
•
VMware Virtual Center v3.5
•
VMware ESX Server v3.0
•
VMware ESX/ESXi Server v3.5
This guide provides instructions for viewing VMware adapter properties, defining VMware targets,
triggers, and activities, as well as instructions for completing the property pages for each specific object.
With the improvements included in the TEO 2.3 release, the VMware adapter will contain functionality
to assist with cloud services. This includes providing additional data for user configuration and
additional activities to query and manage VMware hosts and virtual center servers.
Organization
The information is organized into the following chapters.
Chapter 1
Configuring VMware Adapter
Provides information on the VMware
adapter properties
Chapter 2
Managing Runtime Users
Provides information on creating and
managing runtime user accounts
Chapter 3
Managing VMware Targets
Provides information on viewing defined
targets that are available for execution by
a process.
Chapter 4
Managing VMware Triggers
Provides the specific criteria used to
determine when processes or activities are
triggered for execution.
Cisco TEO Adapter Guide for VMware
OL-24933-02
xi
Preface
Chapter 5
VMware Activities Overview
Overview information for VMware
activities
Chapter 6
VMware Configuration
Management Activities
Contains information on defining and
launching VMware configuration
activities.
Chapter 7
VMware Host Management
Activities
Contains information on defining and
launching VMware host activities.
Chapter 8
VMware Power Management
Activities
Contains information on defining and
launching VMware power activities.
Chapter 9
VMware Snapshot Management Contains information on defining and
Activities
launching VMware snapshot activities.
Conventions
This guide uses the following conventions:
Convention
Indication
bold font
Commands and keywords and user-entered text appear in bold font.
italic font
Document titles, new or emphasized terms, and arguments for which you supply
values are in italic font.
[ ]
Elements in square brackets are optional.
{x | y | z }
Required alternative keywords are grouped in braces and separated by
vertical bars.
[x|y|z]
Optional alternative keywords are grouped in brackets and separated by
vertical bars.
string
A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
courier
font
Terminal sessions and information the system displays appear in courier font.
< >
Nonprinting characters such as passwords are in angle brackets.
[ ]
Default responses to system prompts are in square brackets.
!, #
An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
Note
Means reader take note.
Tip
Means the following information will help you solve a problem.
Cisco TEO Adapter Guide for VMware
xii
OL-24933-02
Preface
Caution
Timesaver
Warning
Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.
Means the described action saves time. You can save time by performing the action described in
the paragraph.
Means reader be warned. In this situation, you might perform an action that could result in
bodily injury.
Product Documentation
Documentation Formats
Documentation is provided in the following electronic formats:
•
Adobe® Acrobat® PDF files
•
Online help
You must have Adobe® Reader® installed to read the PDF files. Adobe Reader installation programs for
common operating systems are available for free download from the Adobe Web site at www.adobe.com.
Guides and Release Notes
You can download the TEO product documentation from Cisco.com. Release Notes can be found on
Cisco.com and the product CD.
Online Help
Online help is available and can be accessed using the following methods:
•
Click Help on any dialog box in the application to open the help topic in a pane to the right of the
dialog box.
•
In the Tidal Enterprise Orchestrator console:
– Click the Help Pane
icon on the toolbar to open the help topic in a pane to the right of the
Results pane.
– Click Help on the menu bar.
Cisco TEO Adapter Guide for VMware
OL-24933-02
xiii
Preface
Open Source License Acknowledgements
Licenses and notices for open source software used in Tidal Enterprise Orchestrator can be found in the
Open Source License Acknowledgements on Cisco.com. If you have any questions about the open source
contained in this product, please email external-opensource-requests@cisco.com.
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional
information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and
revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as a RSS feed and set content to be delivered
directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently
supports RSS Version 2.0.
Cisco TEO Adapter Guide for VMware
xiv
OL-24933-02
CH A P T E R
1
Configuring VMware Adapter
Users can access the VMware adapter properties from the Administration—Adapters view in the
console. The VMware adapter properties dialog box displays general information about the functionality
provided by the adapter, version number, release date and install date, any prerequisites, and the history
of changes made to the adapter.
Although the VMware Adapter software is already installed as part of a normal installation of Tidal
Enterprise Orchestrator, it is recommended that the configuration steps contained in this section are
performed before attempting to execute any VMware objects in TEO.
This chapter provides an overview of what is required to configuring the VMware adapter properties to
ensure that the objects provided by the adapter can execute properly.
•
Adapter System Requirements, page 1-2
•
Supported VMware Products, page 1-2
•
Accessing VMware Adapter Properties, page 1-3
•
Configuring HTTPS Protocol, page 1-4
•
Configuring the Keystore Password, page 1-5
•
Viewing VMware Adapter Prerequisites, page 1-6
•
Viewing VMware Adapter-Supported Objects, page 1-7
•
Viewing VMware Adapter History, page 1-8
Cisco TEO Adapter Guide for VMware
OL-24933-02
1-1
Chapter 1
Configuring VMware Adapter
Adapter System Requirements
Adapter System Requirements
This section provides the system requirements for the VMware adapter. To verify whether the adapter
requirements have been met, see Viewing VMware Adapter Prerequisites, page 1-6.
Table 1-1
Minimum Adapter System Requirements
Component
Release
Java
1.6
Keystore password configuration for Required
HTTPS
Supported VMware Products
The VMware adapter supports the following VMware infrastructure environments to automate the
process managing virtual machines and provide cloud automation functionality.
The following table contains the list of supported VMware products by TEO.
Product
VMware Virtual Center
VMware ESX/ESXi Server
Version
•
4.1
•
5.0
•
4.0
•
4.1
•
5.0
Cisco TEO Adapter Guide for VMware
1-2
OL-24933-02
Chapter 1
Configuring VMware Adapter
Accessing VMware Adapter Properties
Accessing VMware Adapter Properties
To view adapter properties:
Step 1
On the Administration—Adapters view, highlight VMware Adapter, and use one of the following
methods:
•
Right-click and choose Properties.
-or-
•
On the Details pane, click the hyperlink name on any of the tabs.
The VMware Adapter Properties dialog box displays.
Figure 1-1
VMware Adapter Properties Dialog Box—General Tab
The General tab displays the following information about the adapter:
Step 2
Field
Description
Display name
Name of the adapter
Type
Object type
Description
Brief overview of the adapter
Company
Name of company that created or supplied the adapter
Version
Version number of the adapter
Release date
Date and time the adapter was available in the product
Install date
Date and time the adapter was installed
Review the properties and click OK to close the dialog box.
Cisco TEO Adapter Guide for VMware
OL-24933-02
1-3
Chapter 1
Configuring VMware Adapter
Configuring HTTPS Protocol
Configuring HTTPS Protocol
It is recommended that the VMware Virtual Center and ESX Servers be configured to use HTTPS
protocol. The default configuration is HTTPS. If your environment is configured to use HTTP, you can
skip this section.
VMware Virtual Center HTTPS Protocol
To configure the Virtual Center server to use HTTPS:
Step 1
In My Computer, use the following file path to open the vpxd.cfg file.
C:\Documents and Settings\All Users\Application Data\VMware\VMware VirtualCenter
Step 2
Under the <proxyDatabase> tag, modify the /sdk namespace in the <http> and <https> sections to
switch the redirect from HTTP to HTTPS.
Step 3
Save the configuration.
Step 4
To restart the VirtualCenter service, choose Start > All Programs > Administration > Services.
Configuring the ESX HTTPS Protocol
To configure ESX servers to use HTTPS:
Step 1
In My Computer, use the following file path to open the config.xml file.
/etc/vmware/hostd/config.xml
Step 2
Under the <proxyDatabase> tag, modify the /sdk namespace in the <http> and <https> sections to
switch the redirect from HTTP to HTTPS.
Step 3
Save the configuration.
Step 4
To restart the service use, service mgmt.vmware restart.
Cisco TEO Adapter Guide for VMware
1-4
OL-24933-02
Chapter 1
Configuring VMware Adapter
Configuring the Keystore Password
Configuring the Keystore Password
The VMware adapter requires security certificates for all target servers that use HTTPS protocol for
connection. Use the Keystore tab to enter the password that protects the Java Keystore file used to keep
SSL certificates for all configured VMware targets.
For new installations, this password can be set to a keytool password, which must be six characters or
more. For installation upgrades, this password must be set to the password that is already used to protect
the previously configured keystore file.
To configure Keystore password:
Step 1
On the Administration—Adapters view, highlight VMware Adapter, right-click and choose Properties.
The VMware Adapter Properties dialog box displays.
Step 2
Click the Keystore tab to continue.
Figure 1-2
VMware Adapter Properties Dialog Box—Keystore Tab
On the Keystore tab, enter the following keystore information:
Step 3
Field
Description
Keystore password
Enter the key file password which provides access to the
file.
Click OK to close the dialog box.
After the Keystore password is set, the VMware adapter will automatically import the required
certificates into a Java Keystore.
Cisco TEO Adapter Guide for VMware
OL-24933-02
1-5
Chapter 1
Configuring VMware Adapter
Viewing VMware Adapter Prerequisites
Viewing VMware Adapter Prerequisites
Use the Prerequisites tab to display the names and objects that are required by the VMware adapter on
the automation server.
To view adapter prerequisites:
Step 1
On the Administration—Adapters view, highlight VMware Adapter, right-click and choose Properties.
The VMware Adapter Properties dialog box displays.
Step 2
Click the Prerequisites tab to view the prerequisites that is required by the adapter.
Figure 1-3
Step 3
VMware Adapter Properties Dialog Box—Prerequisites Tab
Review the following information required by the adapter and click OK to close the dialog box.
Column
Description
Name
Name of the required item for the supported adapter
Importance
Indicates the importance of the prerequisite to the adapter
State
•
Optional
•
Required
Indicates whether the system has the required software or
hardware item for the adapter
•
Satisfied
•
Not satisfied
Minimum Value
Denotes the minimum system requirement for the item
Detected Value
Displays the actual level (version) of the software/hardware item
discovered on the automation server
Explanation
Displays the information related to the selected adapter
requirement
Cisco TEO Adapter Guide for VMware
1-6
OL-24933-02
Chapter 1
Configuring VMware Adapter
Viewing VMware Adapter-Supported Objects
Viewing VMware Adapter-Supported Objects
Use the Provides tab to view the name and type of component for each TEO object the VMware adapter
supports.
To view adapter-provided objects:
Step 1
On the Administration—Adapters view, highlight VMware Adapter, right-click and choose Properties.
The VMware Adapter Properties dialog box displays.
Step 2
Click the Provides tab to view the functionality that is provided by the adapter.
Figure 1-4
Step 3
VMware Adapter Properties Dialog Box—Provides Tab
Review the list of objects and click OK to close the dialog box.
Cisco TEO Adapter Guide for VMware
OL-24933-02
1-7
Chapter 1
Configuring VMware Adapter
Viewing VMware Adapter History
Viewing VMware Adapter History
Use the History tab to view a history of changes that have been made to the adapter.
To view adapter history:
Step 1
On the Administration—Adapters view, highlight VMware Adapter, right-click and choose Properties.
The VMware Adapter Properties dialog box displays.
Figure 1-5
Step 2
Step 3
VMware Adapter Properties Dialog Box—History Tab
Click the History tab to view the changes made to the adapter.
Column
Description
Created by
The user name of the person who created the object
Created time
The date and time the object was created
Time
The date and time the action occurred
Change Type
The action that occurred
User
The user name or group that performed the action
Description
Information about the action that was performed
To view the audit history for a specific action, highlight the appropriate object, right-click and choose
Properties.
The Audit Properties dialog box displays.
Cisco TEO Adapter Guide for VMware
1-8
OL-24933-02
Chapter 1
Configuring VMware Adapter
Viewing VMware Adapter History
Figure 1-6
Step 4
Step 5
Success Audit Properties Dialog Box
Review the display-only properties dialog box for information about system-related events that occurred
and their status.
Field
Description
Type
Type of event logged by the system
•
Success Audit—Indicates a successful change to the
object
•
Failure Audit—Indicates an attempted change to the
object has failed
Created By
System-generated record, such as an error condition, or the
user name of the person who initiated the process
Created Time
Date and time the event occurred
Description
Brief description of the event
Click OK to close the dialog box.
Cisco TEO Adapter Guide for VMware
OL-24933-02
1-9
Chapter 1
Configuring VMware Adapter
Viewing VMware Adapter History
Cisco TEO Adapter Guide for VMware
1-10
OL-24933-02
CH A P T E R
2
Managing VMware Targets
The Targets feature defines specific environments where activities, triggers and processes can be
executed. You can define a target to run a process or activity on a specific computer, database connection,
or application server. Using targets simplifies specifying where certain processes, activities, or triggers
will run. The target can be defined once and reused in several processes.
The VMware virtual infrastructure targets (e.g. VMware Virtual Center or ESX server) represents a
connection to a given VMware virtual infrastructure.
This chapter guides you through managing VMware targets.
•
Target Descriptions, page 2-4
•
Defining a VMware ESX Server Target, page 2-5
•
Defining a VMware Virtual Center Server Target, page 2-8
•
Managing Target Definitions, page 2-11
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-1
Chapter 2
Managing VMware Targets
Accessing Definitions—Targets
Accessing Definitions—Targets
The Definitions—Targets displays all the existing defined targets. You also use this view to create new
targets, modify the properties of a target, and delete targets.
To access the Targets view:
On the Definitions workspace, choose Targets.
The Results pane displays.
Figure 2-1
Definitions—Targets
Information about the target can be displayed in the following columns:
Column
Description
Display name
The name assigned to the target
Enabled
Indicates whether the target is enabled (True) or disabled
(False). A disabled target is unavailable for execution.
Type
The type of target based on the associated adapter
Status
Indicates the status of the target. The status is used to
determine whether the target is available or is not available
for process or activity execution.
•
Unknown—Status of the target unknown
•
Normal—No known problems with this target
•
Unreachable—TEO is experiencing problems
connecting to the target and executing activities
•
Disabled—Target is disabled and is not available for
activity execution
Cisco TEO Adapter Guide for VMware
2-2
OL-24933-02
Chapter 2
Managing VMware Targets
Accessing Definitions—Targets
Note
Column
Description
Status Information
Detailed information regarding the target status and the
reasons for target being unreachable
Automation Pack
Name of the automation pack associated with the target
Customizable
Indicates the customization setting for the object in the
automation pack
Owner
The user name of the person who owns the target in TEO
Last Modified Time
The time the target was last modified
Last Modified By
The user name of the person who last modified the target
Id
The unique identification number of the target definition
Description
A brief description of the target
Type Description
A brief overview of the target type
Created Time
The time at which the target was created
Created By
The user name of the person who created the target
To add, remove, or sort column headings on the display, see Cisco Tidal Enterprise Orchestrator
Reference Guide.
Details Pane
The Targets Details pane displays additional information about the selected object. The hyperlinks on
each of the detail pages launch the property pages for the selected target.
Tab
Description
General
Displays general information about the object including the
name, type, value, a brief description of the target, and the
ability to enable or disable a target.
Attributes
Displays the dates, times and process owner associated
with the creation and modification of the target.
Viewing Target Properties
To view target properties:
Step 1
On the Definitions—Targets view, highlight the appropriate target, and use one of the following
methods:
•
Right-click and choose Properties.
-or-
•
On the Details pane, click the hyperlink name on any of the tabs.
The Properties dialog box displays.
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-3
Chapter 2
Managing VMware Targets
Accessing Definitions—Targets
Step 2
Review the properties and click OK to close the dialog box.
Tab
Description
General
Displays general information about the target
Connection
Displays the connection properties for the defined target
Member Of
Displays the target groups associated with the defined
targets
Extended Properties
Displays the list of all extended target properties defined
for a specific target type. This tab will remain blank until
an extended target property is defined for the target type.
Provides
Displays the objects used by the target
History
Displays when the target was created or modified. The
column also displays audit log entries that are relevant to
the target.
Target Descriptions
The following table provides a list of the targets that are associated with the adapter. For additional
information on defining a VMware target, please refer to the appropriate section.
Target
Description
VMware ESX Server
Establishes connection to a standalone ESX server.
See Defining a VMware ESX Server Target, page 2-5.
VMware Virtual Center Server
Establishes connection to Virtual Center server
See Defining a VMware Virtual Center Server Target,
page 2-8.
Target Algorithms
The following table displays the list of target algorithms that may display for an activity.
Algorithm
Description
Choose the target with the specified Select this radio button to run the process on the member
name
of the group specified in the Name to match text field.
Choose any targets with the
specified criteria
Select this radio button to execute the process on any
targets defined by the criteria specified in the Target
Selection dialog box.
See Defining Target Criteria, page 2-12.
Cisco TEO Adapter Guide for VMware
2-4
OL-24933-02
Chapter 2
Managing VMware Targets
Defining a VMware ESX Server Target
Defining a VMware ESX Server Target
VMware ESX and VMware ESXi are "bare-metal" hypervisors, and are installed directly on top of the
physical server and partitioned into multiple virtual machines that can run simultaneously, sharing the
physical resources of the underlying server. The ESX/ESXi Server and host are one-one correspondence.
Use the VMware ESX Server target to specify the connection information to an ESX/ESXi server.
Step 1
On the Definitions—Targets view, right-click, and choose New > VMware ESX Server.
The New VMware ESX Server Properties dialog box displays.
Figure 2-2
Step 2
New VMware ESX Server Properties Dialog Box—General Tab
On the General tab, enter the appropriate general information:
Field
Description
Display name
Name of the target
Type
Display-only. Type of target
Owner
User name of the owner of the category. This is typically
the person who created the category.
Click Browse to launch the Select User or Group dialog
box to change the owner.
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-5
Chapter 2
Managing VMware Targets
Defining a VMware ESX Server Target
Field
Description
Status
Display-only. Status of the target
•
Unknown—Status of the target unknown
•
Normal—No known problems with this target
•
Unreachable—TEO is experiencing problems
connecting to the target and executing activities
•
Disabled—Target is disabled and is not available for
activity execution
Status Information
Display-only. Detailed information regarding the target
status and the reasons for target being unreachable
Organization
Name of the company which supports the target
Description
Brief description of the target
Enabled
Check the check box to enable the target. The check box is
checked by default which makes it available immediately
upon creation.
If you uncheck the check box, the target is disabled and will
be unavailable for execution.
Step 3
Note
Click the Connection tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 2-3
New VMware ESX Server Properties Dialog Box—Connection Tab
Cisco TEO Adapter Guide for VMware
2-6
OL-24933-02
Chapter 2
Managing VMware Targets
Defining a VMware ESX Server Target
Step 4
On the Connection tab, enter the appropriate target information:
Field
Description
ESX server name
Fully-qualified domain name (FQDN) or IP address of the
ESX/ESXi server
The Power Up Host and Power Down Host activities can
only be performed against the ESX/ESXi Server.
ESX service port
Port number used to access the ESX/ESXi server (Default:
443)
Use credentials of the following
runtime user
Select the default runtime user account that contains the
credentials to connect to the target.
Note
HTTPS
Step 5
To view the properties for the selected runtime
user, click the Properties
tool. To create a new
runtime user account, click New > Runtime User
to create a new Runtime User account. For
additional information, see Chapter 3, “Managing
Runtime Users.”
Check the check box to indicate that the ESX/ESXi server
web service has been configured to use HTTPS protocol.
Click OK to close the dialog box.
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-7
Chapter 2
Managing VMware Targets
Defining a VMware Virtual Center Server Target
Defining a VMware Virtual Center Server Target
Virtual Center Server provides unified management of all the hosts and VMs in your datacenter from a
single console with an aggregate performance monitoring of clusters, hosts and VMs. Use the VMware
Virtual Center Server target to specify the connection information to the VMware server.
Step 1
On the Definitions—Targets view, right-click, and choose New> VMware Virtual Center Server.
The New VMware Virtual Center Server Properties dialog box displays.
Figure 2-4
Step 2
New VMware Virtual Center Server Properties Dialog Box—General Tab
On the General tab, enter the appropriate general information:
Field
Description
Display name
Name of the target
Type
Display-only. Type of target
Owner
User name of the owner of the category. This is typically
the person who created the category.
Click Browse to launch the Select User or Group dialog
box to change the owner.
Status
Display-only. Status of the target
•
Unknown—Status of the target unknown
•
Normal—No known problems with this target
•
Unreachable—TEO is experiencing problems
connecting to the target and executing activities
•
Disabled—Target is disabled and is not available for
activity execution
Cisco TEO Adapter Guide for VMware
2-8
OL-24933-02
Chapter 2
Managing VMware Targets
Defining a VMware Virtual Center Server Target
Field
Description
Status Information
Display-only. Detailed information regarding the target
status and the reasons for target being unreachable
Organization
Name of the company which supports the target
Description
Brief description of the target
Enabled
Check the check box to enable the target. The check box is
checked by default which makes it available immediately
upon creation.
If you uncheck the check box, the target is disabled and will
be unavailable for execution.
Step 3
Note
Click the Connection tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 2-5
Step 4
New VMware Virtual Center Server Properties Dialog Box—Connection Tab
On the Connection tab, enter the appropriate target information:
Field
Description
Virtual Center server name
Host name or IP address of the Virtual Center server
Virtual Center service port
Port number used to access the Virtual Center server
(Default: 443)
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-9
Chapter 2
Managing VMware Targets
Defining a VMware Virtual Center Server Target
Field
Description
Use credentials of the following
runtime user
Select the default runtime user account that contains the
credentials to connect to the target.
Note
HTTPS
Step 5
To view the properties for the selected runtime
user, click the Properties
tool. To create a new
runtime user account, click New > Runtime User
to create a new Runtime User account. For
additional information, see Chapter 3, “Managing
Runtime Users.”
Check the check box to indicate that the Virtual Center
server web service has been configured to use HTTPS
protocol.
Click OK to close the dialog box.
Cisco TEO Adapter Guide for VMware
2-10
OL-24933-02
Chapter 2
Managing VMware Targets
Managing Target Definitions
Managing Target Definitions
Use the Definitions—Targets view to modify and review target information. This view can be used to
perform the following functions:
•
Enable/Disable targets
•
Modify target properties
•
Review the objects in the product that use the target
•
Review a history of changes made to the target
•
Delete the target
Enabling a Target
A target is enabled by default. If a target is manually disabled, the target must be enabled before it is
available for execution.
To enable a target:
On the Definitions—Target view, highlight the target, and then use one of the following methods:
•
On the Results pane, right-click and select Enable.
-or-
•
On the Details pane, select the Click here to enable option.
The Enabled column on the Results pane changes to True. If necessary, click Refresh
view.
to update the
Disabling a Target
Disabling a target prevents the object from being available for execution. The disabled target is not
removed from the list of targets in the in the Definitions—Target Results pane.
To disable a target:
On the Definitions—Target view, highlight the target, and then use one of the following methods:
•
On the Results pane, right-click and select Disable.
-or-
•
On the Details pane, select the Click here to disable option.
The Enabled column on the Results pane changes to False. If necessary, click the Refresh tool to update
the view.
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-11
Chapter 2
Managing VMware Targets
Managing Target Definitions
Modifying Targets
Use the Definitions—Targets view to modify the configured targets. After the initial creation, not all
fields are available for updating.
To modify a target:
Step 1
On the Definitions—Targets view, highlight the appropriate target, right-click and choose Properties.
The [Target] Properties dialog box displays.
Step 2
Modify the information on the target property tabs, as necessary.
Step 3
Click OK to save the changes and close the dialog box.
Defining Target Criteria
Use the Target Selection Criteria dialog box to specify the matching criteria for the selected target group.
To define the target selection criteria:
Step 1
On the Target tab, select the Execute on this target group radio button, and then select the appropriate
target group from the drop-down list.
Figure 2-6
Target Tab—Execute on this target group Section
Step 2
From the Choose a target using this algorithm drop-down list, select Choose the target that satisfies
the specified criteria.
Step 3
On the Criteria box, click Browse.
Cisco TEO Adapter Guide for VMware
2-12
OL-24933-02
Chapter 2
Managing VMware Targets
Managing Target Definitions
The Target Selection Criteria dialog box displays.
Figure 2-7
Step 4
Target Selection Criteria Dialog Box
On the Properties pane, specify the following information, as necessary:
Field
Description
Property
Choose the appropriate property to match within the target.
Click the Reference tool to select the variable from the
Insert Variable Reference dialog box.
See Inserting a Target Variable Reference, page 2-15.
Operators
The displayed operators depend on the type of selected
property.
Note
Value
Step 5
Step 6
For information on the displayed operators, see
Comparison Operators, page 2-14.
Enter the value
To modify the list of Properties pane containing target criteria, click one of the following buttons:
Button
Description
Add
Click this button to a new Properties pane to complete with
criteria for the target.
Remove
Click this button to remove the selected last Properties
pane in the display
Click OK to return to the Target tab.
The defined criteria displays in the display-only box.
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-13
Chapter 2
Managing VMware Targets
Managing Target Definitions
Comparison Operators
The following table contains operators that may display throughout TEO.
Operator
Description
contains
Iterates through the contents of the collection and
determines if the specified item exists (if this is a string
collection, this is case-insensitive)
contains (case-sensitive)
Iterates through the contents of the collection and
determines if the specified item exists (same as above, but
a case-insensitive version)
contains only
Iterates through the contents of the collection and
determines if the only item in the collection is the specified
item (if this is a string collection, this is case-insensitive)
contains only (case-sensitive)
Iterates through the contents of the collection and
determines if the only item in the collection is the specified
item (same as above, but a case-insensitive version)
does not match wildcard
Determines if the item does not match all items in the
wildcard example
is empty
Determines if there are items in the collection or not
equals
Determines if the left side equals the right side (if this is a
string comparison, this is case-insensitive)
not equals
Determines if the left side does not equal the right side
matches regular expression
Determines if the left side matches the regular expression
specified on the right side
matches wildcard
Determines if the left side matches the wildcard specified
on the right side
equals (case-sensitive)
Determines if the left side equals the right (this is the
case-sensitive version of Equals for string)
less than [<]
Determines if a value is less than another value
more than [>]
Determines if a value is greater than another value
equal [=]
Determines if a value is equal to another value
not equal [>]
Determines if a value is not equal to another value
greater than or equal [>=]
Determines if a value is greater than or equal to another
value
less than or equal [<=]
Determines if a value is less than or equal to another value
Cisco TEO Adapter Guide for VMware
2-14
OL-24933-02
Chapter 2
Managing VMware Targets
Managing Target Definitions
Inserting a Target Variable Reference
The Reference
icon to the right of a text field indicates that the field can be populated by referencing
a defined variable or the property of another activity or process. Use the Insert Variable Reference dialog
box to select a defined variable or reference an object to populate a field. The OK button does not activate
until a valid property or variable is selected.
To insert a target variable reference:
Step 1
To the right of a field on a property page, click the Reference tool.
The Insert Variable Reference dialog box displays.
Figure 2-8
Step 2
Insert Variable Reference Dialog Box
Check the Show Advanced check box to display all items that are available for referencing.
If the check box is not checked, then only the most commonly-used items are displayed for activities,
processes or events.
Note
Step 3
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Click the Target Expand (+) to display the reference objects for the target.
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-15
Chapter 2
Managing VMware Targets
Managing Target Definitions
Step 4
From the list of displayed objects, select the appropriate property.
Reference Variable
Description
Name
Display name of the target
Created by
User name or the owner of the target
Modified by
User name of the individual who modified the target
Type
Type of target
Is Normal Status
Status is normal and indicates that there are no known
problems with this target
Is Unreachable Status
Status is unreachable which indicates that no known problems
with this target
Status Information
Detailed information regarding the target status and the
reasons for target being unreachable
API Version
Version of the API as a dot-separated string. For example,
"1.0.0"
API Type
Indicates the type of API associated with the API
Build
Build string for the server on which this call is made. For
example, x.y.z-num. This string does not apply to the API.
Is HTTPS
Indicates VMware target is configured for HTTPS
Is Virtual Center
Indicates reference to Virtual Center server
OS Type
Operating system type and architecture of the VMware server
Example:
Product Line ID
Version
•
win32-x86—For x86-based Windows systems
•
linux-x86—For x86-based Linux systems
•
vmnix-x86—For the x86 ESX Server microkernel
Unique identifier for the product line
•
gsx—For the VMware Server product or the GSX Server
product
•
esx—For the ESX Server product
•
vpx—For the VirtualCenter product
Version of the VMware infrastructure server
Dot-separated version string.
Step 5
Virtual Center/ESX Server
Server Name
Host name or IP address of the Virtual Center/ESX Server
Virtual Center/ESX Server
Service Port
Port number used to access the Virtual Center/ESX Server
service
Click OK to add the selected reference variable to the related text field.
Cisco TEO Adapter Guide for VMware
2-16
OL-24933-02
Chapter 2
Managing VMware Targets
Managing Target Definitions
Creating a Copy of a Target
The copy option is used when there is an existing target that contains properties that can be used for
defining a new target without creating a completely new target. The following steps may not be available
for all targets.
To create a copy a target:
Step 1
On the Definitions—Targets view, highlight the appropriate target, right-click and choose Copy.
Step 2
On the Results pane, right-click and choose Paste.
A copy of the defined target is pasted into the Results pane.
Step 3
To rename the copied target or other properties, right-click and choose Properties.
Modify the target name, as appropriate, and click OK to close the dialog box.
Deleting a Target
Use the Definitions—Target view to delete targets that are no longer used. Before deleting a target,
access the properties, and click the Used By tab to view where objects are being referenced by the target.
If there are any objects referencing the target, the target will not able to deleted.
To delete a target:
Step 1
On the Definitions—Targets view, highlight the appropriate target, right-click and choose Delete.
The Confirm Delete dialog box displays.
Step 2
Click Yes to delete the target.
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-17
Chapter 2
Managing VMware Targets
Managing Target Definitions
Viewing Member Of Properties
Use the Member of tab to view the target groups to which a target belongs. The name and type of target
group displays in the list box.
To view the member of targets:
Step 1
On the Definitions—Targets view, highlight the appropriate target, right-click and choose Properties.
The [Target] Properties dialog box displays.
Step 2
Click the Member Of tab to view the target groups.
Field
Description
Display name
Name of the target group
Type
Display-only. Type of target group
Description
Brief description of the target
Step 3
To view the properties for a specific object, highlight the object, right-click and choose Properties.
Step 4
Click OK to close the dialog box.
Viewing Extended Properties
Use the Extended Properties tab to view the list of all extended target properties defined for a specific
target type. This tab will remain blank until an extended target property is defined for the target type.
For additional information on extended properties, refer to the Cisco Tidal Enterprise Orchestrator
Reference Guide.
To view the target extended properties:
Step 1
On the Definitions—Targets view, highlight the appropriate target, right-click and choose Properties.
The [Target] Properties dialog box displays.
Step 2
Click the Extended Properties tab to view the extended properties defined for the target.
Column
Description
Name
Name of the target property
Value
Displays value for the target property. If no value is
defined, then the default property value will display.
Using Default
Indicates whether the default property value is displayed.
Yes will display if no value is defined. No will display if a
value is defined for the target property.
Step 3
Click OK to close the dialog box.
Cisco TEO Adapter Guide for VMware
2-18
OL-24933-02
Chapter 2
Managing VMware Targets
Managing Target Definitions
Modifying Extended Property Values
To modify the extended properties:
On the Extended Properties tab, highlight the appropriate target property and click the appropriate button
to define or modify the value.
Button
Description
Edit
Click this button to defined or modify the value of a
specific target property.
The Edit button is disabled by default. The button will be
enabled only when a target property is selected in the list.
Reset Value
Click this button to reset the value of the target property to
its default value.
The Reset Value is enabled only if a value is specified for
a selected target property.
Viewing Used By Properties
Use the Used By tab to display the objects that directly reference the selected target in their
configuration. Because the Used By tab displays objects in a tree view, users can also display the objects
which directly reference the top level objects for the selected object.
The objects at the top level are the objects that reference the selected object directly, but users can expand
the listed objects and see their referenced objects.
Example:
If object A is used by objects X and Y and object X is used by object Q, then on the
property pages of object A, the user will see X and Y listed. If a user expands (+) object
X, then object Q will display.
To view used by objects:
Step 1
On the Definitions—Targets view, highlight the appropriate target, right-click and choose Properties.
The [Target] Properties dialog box displays.
Step 2
Click the Used By tab to view the objects referenced by the target.
Object
Description
Display name
Name of the object
Type
Type of object
Step 3
To view the properties for a specific object, highlight the object, right-click and choose Properties.
Step 4
Click OK to close the dialog box.
Cisco TEO Adapter Guide for VMware
OL-24933-02
2-19
Chapter 2
Managing VMware Targets
Managing Target Definitions
Viewing Targets History
Use the History tab to view a history of changes that have been made to the target.
Step 1
On the Definitions—Targets view, highlight the appropriate target, right-click and choose Properties.
The [Target] Properties dialog box displays.
Step 2
Click the History tab to view the changes made to the target.
Column
Description
Created by
The user name of the person who created the object
Created time
The date and time the object was created
Time
The date and time the action occurred
Change Type
The action that occurred
User
The user name of the person that performed the action
Description
Information about the action that was performed
Step 3
To view the details for a specific action, highlight the appropriate time, right-click and choose
Properties.
Step 4
Click OK to close the dialog box.
Cisco TEO Adapter Guide for VMware
2-20
OL-24933-02
CH A P T E R
3
Managing Runtime Users
Many operating system and application activities require credentials for proper execution. The Runtime
Users feature is used to create a runtime user record to store the information about the user security
context and to pass this information to the adapters for activity execution, event monitoring and some
target operations (such as availability monitoring and discovery). When defining a process or certain
activities, you can use the runtime user records that are defined in the product to assign credentials for
the process or activity.
The following sections in this chapter provide instructions on managing runtime user accounts:
•
Accessing Definitions—Runtime Users, page 3-2
•
Defining a Runtime User Account, page 3-4
•
Managing Runtime User Definitions, page 3-6
Cisco TEO Adapter Guide for VMware
OL-24933-02
3-1
Chapter 3
Managing Runtime Users
Accessing Definitions—Runtime Users
Accessing Definitions—Runtime Users
Use the Definitions—Runtime Users view to display the credentials of the runtime users and to specify
new runtime user credentials, update the credentials of users, or delete users.
To access the Runtime Users properties:
In the Definitions workspace, choose Runtime Users.
The Results pane displays.
Figure 3-1
Definitions—Runtime Users
Information about the runtime user accounts can be displayed in the following columns:
Column
Description
Display Name
The display name assigned to the runtime user account
Type
The type of user account
User Name
The user name assigned to the account
Owner
The user name of the person who created the account
Last Modified Time
The time the credentials were last modified
Last Modified By
The user name of the person who last modified the
credentials
Id
The unique identification number of the runtime user
definition
Description
A brief overview of the runtime user definition
Type Description
A brief description of the information in the Type column
Created Time
Date/time the runtime user account was created
Cisco TEO Adapter Guide for VMware
3-2
OL-24933-02
Chapter 3
Managing Runtime Users
Accessing Definitions—Runtime Users
Column
Description
Created By
The user name of the person who created the runtime user
definition
Automation Pack
Name of the automation pack from which the runtime user
record was imported
Actions Menu and Toolbar
The Runtime Actions menu and toolbar provide the option to create new runtime users to hold the
security credentials that are assigned to processes and activities. The New option is also available by
right-clicking Definitions—Runtime Users.
Figure 3-2
Runtime Actions Menu
Runtime User Details Pane
The Details pane in the lower portion of the page displays detailed information about the selected
runtime user. Clicking a link on a tab page opens the Properties dialog box for the runtime user.
Tab
Description
General
Displays general information about the object including the
name, type, value, a brief description of the runtime user
Attributes
Displays the dates, times and owner associated with the
creation and modification of the runtime user
Cisco TEO Adapter Guide for VMware
OL-24933-02
3-3
Chapter 3
Managing Runtime Users
Defining a Runtime User Account
Defining a Runtime User Account
The credentials specified for the runtime user are used to store the information about the simple user
security context consisting of a user name and password pair and to pass this information to the adapters.
To create a Runtime User:
Step 1
On the Definitions—Runtime Users view, right-click and choose New > Runtime User.
The New Runtime User Properties dialog box displays.
Figure 3-3
Note
Step 2
New Runtime User Properties Dialog Box—General Tab
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
On the General tab, specify the following information:
Field
Description
Display Name
This field is populated with the information specified in the
Domain and User name text fields.
Type
Display-only. Object type
Owner
The owner of the object. This is typically the creator of the
object.
Click Browse to launch the Select User or Group dialog
box and change the owner.
User name
The user name assigned to the user account
Cisco TEO Adapter Guide for VMware
3-4
OL-24933-02
Chapter 3
Managing Runtime Users
Defining a Runtime User Account
Field
Description
Password
Check the check box and then enter the password to be
assigned to the user account.
Description
Step 3
Step 4
Note
For existing runtime user records, check the check
box to enter the new password assigned to the user
account.
Note
There is no password verification that is done for
the simple (generic) runtime user. Therefore, the
above message will NEVER be displayed for the
runtime user object.
A description of the runtime user account
Click the Used By tab to display the objects which reference the runtime user. This tab will remain blank
until the runtime user is used by an object.
Object
Description
Display name
Name of the object
Type
Type of object
To view information about an object, highlight the object, right-click and choose Properties.
The dialog box displays the properties of the object.
Step 5
Step 6
Click the History tab to display the history of actions taken against the target. This tab remains blank
until after the initial target creation.
Column
Description
Created by
The user name of the person who created the object
Created time
The date and time the object was created
Time
The date and time the action occurred
Change Type
The action that occurred
User
The user name of the person that performed the action
Description
Information about the action that was performed
Click OK to exit the dialog box.
Cisco TEO Adapter Guide for VMware
OL-24933-02
3-5
Chapter 3
Managing Runtime Users
Managing Runtime User Definitions
Managing Runtime User Definitions
Use the following procedures to view and modify runtime user definitions.
Modifying a Runtime User Record
Use the Definitions—Runtime Users view to display the runtime user properties and modify the runtime
user records.
To modify a runtime user credentials:
Step 1
On the Definitions—Runtime Users view, highlight the appropriate runtime user record, right-click and
choose Properties.
The [Runtime User] Properties dialog box displays.
Step 2
On the General tab, modify the appropriate information, as necessary.
Step 3
Confirm the changes, and then click OK to close the dialog box.
Deleting a Runtime User
Use the Definitions—Runtime Users view to delete a runtime user record.
Step 1
On the Definitions—Runtime Users view, highlight the appropriate runtime user, right-click and choose
Delete.
The Confirm Delete dialog box displays.
Step 2
Click Yes to confirm the deletion.
Viewing Used By Properties
Use the Used By tab to display the objects that directly reference the selected runtime user in their
configuration. Because the Used By tab displays objects in a tree view, users can also display the objects
which directly reference the top level objects for the selected object.
The objects at the top level are the objects that reference the selected object directly, but users can expand
the listed objects and see their referenced objects.
Example:
If object A is used by objects X and Y and object X is used by object Q, then on the
property pages of object A, the user will see X and Y listed. If a user expands (+) object
X, then object Q will display.
Cisco TEO Adapter Guide for VMware
3-6
OL-24933-02
Chapter 3
Managing Runtime Users
Managing Runtime User Definitions
To view used by objects:
Step 1
On the Definitions—Runtime Users view, highlight the appropriate runtime user, right-click and choose
Properties.
The [Runtime User] Properties dialog box displays.
Step 2
Step 3
Click the Used By tab to view the objects which reference the runtime user.
Object
Description
Display Name
Name of the object
Type
Type of object
To view information about an object, highlight the object, right-click and choose Properties.
The display-only dialog box displays the properties of the object.
Step 4
Click OK to close the dialog box.
Viewing Runtime User History
Use the History tab to view a history of changes that have been made to the runtime user.
Step 1
On the Definitions—Runtime Users view, highlight the appropriate runtime user, right-click and choose
Properties.
The [Runtime User] Properties dialog box displays.
Step 2
Click the History tab to view the changes made to the runtime user.
The following information about the history of the runtime is displayed:
Column
Description
Created by
The user name of the person who created the object
Created time
The date and time the object was created
Time
The date and time the action occurred
User
The user name of the person that performed the action
Type
The action that occurred
Description
Information about the action that was performed
Step 3
To view the audit history for a specific action, highlight the appropriate time, right-click and choose
Properties.
Step 4
Click OK to close the dialog box.
Cisco TEO Adapter Guide for VMware
OL-24933-02
3-7
Chapter 3
Managing Runtime Users
Managing Runtime User Definitions
Cisco TEO Adapter Guide for VMware
3-8
OL-24933-02
CH A P T E R
4
Managing VMware Triggers
Triggers determine how or when the process will be executed. Multiple triggers can be added that can
be initiated when certain conditions are met. Process triggers are available for viewing within the process
editor. The Trigger tab displays all triggers associated with the process. On this tab, users are able to
create new triggers, modify the properties of a trigger, and delete triggers.
The VMware adapter monitors the following VMware events and triggers predefined processes based on
the criteria specified in the following events.
•
Power Event—Occur when the power state of a virtual machine changes to a specified state.
•
Performance Event—Occurs when the specified performance counter of a host or virtual machine
meets specified criteria.
This chapter provides information about the following sections:
•
Defining a VMware Host Performance Event Trigger, page 4-4
•
Defining a VMware Virtual Machine Performance Event Trigger, page 4-9
•
Defining a VMware Virtual Machine Power Event Trigger, page 4-12
•
Managing Trigger Definitions, page 4-15
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-1
Chapter 4
Managing VMware Triggers
Accessing Trigger Properties
Accessing Trigger Properties
Process triggers are available for viewing within the process editor. The Triggers tab displays all triggers
associated with the process. The Triggers tab displays all the existing defined targets associated with the
triggers. This tab can be used to create new targets, modify the properties of a target, and delete targets.
Use the following steps to view trigger properties in the process editor:
Step 1
On the Definitions—Processes view, use one of the following methods:
•
Highlight the appropriate process, right-click and choose Edit.
-or-
•
Step 2
On the Navigation pane, select Processes, right-click and choose New.
After the Process Editor dialog box displays, click the Triggers tab.
Figure 4-1
Process Editor—Triggers Tab
Information about the trigger is displayed in the following columns:
Step 3
Column
Description
Display name
Name assigned to the trigger
Target
Target which is executed by the trigger
On the Triggers tab, highlight the appropriate trigger, and click Properties.
The Trigger Properties dialog box displays.
Step 4
Click the appropriate tab to review the properties.
Tab
Description
General
Displays general information about the trigger
Trigger-Specific
Displays the properties of the selected trigger
Cisco TEO Adapter Guide for VMware
4-2
OL-24933-02
Chapter 4
Managing VMware Triggers
Accessing Trigger Properties
Step 5
Tab
Description
Target
Target on which to monitor for events that will trigger the
process.
Credentials
Runtime user whose credentials should be used to
monitored for events that will trigger the process.
Knowledge Base
Knowledge base article to be associated with the trigger
Conditions
Specifies when an action is to be taken based on an
evaluation of conditions that have been defined
Click OK to close the dialog box.
VMware Trigger Descriptions
The following table provides a list of the triggers that are associated with the VMware adapter. The
available triggers are dependent upon the installed adapters.
Trigger
Description
VMware Host Performance Event
Monitors the performance for a ESX host
See Defining a VMware Host Performance Event Trigger,
page 4-4.
VMware Virtual Machine
Performance Event
VMware Virtual Machine Power
Event
Monitors the performance for a ESX virtual machine
See Defining a VMware Virtual Machine Performance
Event Trigger, page 4-9.
Monitors the power state changes of a virtual machine
See Defining a VMware Virtual Machine Power Event
Trigger, page 4-12.
Common Wildcard Expressions
The following table describes commonly used wildcard special characters that display according to the
selected activity.
Character
Description
*
Match Any Character
?
Match Any Single Character
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-3
Chapter 4
Managing VMware Triggers
Defining a VMware Host Performance Event Trigger
Defining a VMware Host Performance Event Trigger
Use the VMware Host Performance Event trigger to specify the performance criteria for the ESXi server
to be monitored and used to trigger an event that must be matched to trigger the process.
To create a trigger:
Step 1
On the Process—Triggers tab, click New > VMware > VMware Host Performance Event.
The VMware Host Performance Event Properties dialog box displays.
Figure 4-2
Step 2
VMware Host Performance Event Dialog Box—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the trigger
Type
Display-only. Type of trigger
Description
Brief description of the trigger
Enabled
The check box is checked by default. The checked box
indicates the trigger is available for execution.
Check the check box to disable the trigger. If the check
box is unchecked, the trigger is disabled, and the
adapter is not monitoring for the event criteria
configured in the trigger. The process will not be
triggered or executed if the event matching the criteria
occurs.
Cisco TEO Adapter Guide for VMware
4-4
OL-24933-02
Chapter 4
Managing VMware Triggers
Defining a VMware Host Performance Event Trigger
Step 3
Note
Click the Host Performance Event to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 4-3
Step 4
VMware Host Performance Event Dialog Box—Host Performance Event Tab
On the Host Performance Event tab, enter the appropriate trigger information.
Field
Description
ESX host
Inventory path to the performance monitored host server or
host server where the monitored virtual machine resides.
Note
Performance counter
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Click Browse to launch the Performance dialog box to
select the appropriate performance counter to monitor for
the virtual machine.
For example, the counter with name "usage" for the "cpu"
group of performance counters is CPU_Usage.
See Selecting Performance Counters to Monitor,
page 4-20.
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-5
Chapter 4
Managing VMware Triggers
Defining a VMware Host Performance Event Trigger
Field
Description
Statistic
Display-only. Type of statistical values that are returned for
the counter
Operators
•
Current—Most recent value of the performance
counter over the summarization period
•
Minimum—Minimum value of the performance
counter value over the summarization period
•
Maximum—The maximum value of the performance
counter value over the summarization period
•
Average—The actual value collected or the average of
all values collected during the summary period
The displayed operators depend on the selected property.
Note
Step 5
For information on the displayed operators, see
Comparison Operators, page 2-14.
Expression
Expression associated with the selected operator
Unit
Display-only. The unit for the values of the performance
counter (Ex. KBps, MHz, etc.)
Sample size
Enter the number of samples to be returned by the trigger
Interval (in seconds)
Enter the interval, in seconds, for the performance statistics
Click the Target tab to specify the target on which to monitor for events that will trigger the process:
Field
Description
Monitor on this target
Select the appropriate target from the drop-down list to
specify where the event will be monitored.
Note
Choose a target reference
To view the properties for the target, click the
Properties
tool.
Select this radio button and then click the Reference tool
launch the Insert Variable Reference dialog box.
On the Insert Variable Reference dialog box, expand
Process > Target > Properties, select the appropriate
target reference property, and click OK.
The selected target reference property displays in the text
field.
Monitor using this target group
Select the appropriate target group where the event will be
monitored.
Note
To view the properties for the target group, click
the Properties
tool. To create a new target
group, click New > [Target Group] Name.
Cisco TEO Adapter Guide for VMware
4-6
OL-24933-02
Chapter 4
Managing VMware Triggers
Defining a VMware Host Performance Event Trigger
Field
Description
Monitor for events on
Select one of the following radio buttons to determine which members of the target group the
event will be monitored on.
All targets in this group
Select this radio button to monitor event on all members of
the target group.
Choose a target using this algorithm Select this radio button to monitor event on a specific
member of the target group or a random target in the target
group. Select the appropriate option from the drop-down
list to determine the target member parameters.
For algorithm descriptions, see Target Algorithms,
page 2-4.
Step 6
Click the Conditions tab, and then the appropriate panel, to specify when an action is to be taken based
on an evaluation of defined conditions.
Panel
Description
Basic
Creates simple conditions using variables to match to
operator criteria.
See Adding Basic Conditions to an Object, page 4-16.
Advanced
Creates a TEO-based condition.
•
Compound Condition—Compiles other conditions
(time condition, prior process instance condition,
variable condition, or another compound condition)
into a single condition. The Compound Condition is
created by the addition of another True/False option in
the Advanced Panel.
•
Prior Process Instance Condition—Determines that
when a process has occurred within a specific time
interval, the condition will evaluate to false. If no
process instance is selected, then the trigger will
search for all process instances.
•
Time Condition—Specify a condition based on a
defined calendar.
•
Variable Condition—Specify a variable to be used as
the condition under which the variable should evaluate
as true.
See Adding Advanced Conditions to an Object, page 4-17.
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-7
Chapter 4
Managing VMware Triggers
Defining a VMware Host Performance Event Trigger
Step 7
Click the Knowledge Base tab to assign a knowledge base article to the object.
Knowledge Base Field Options
Description
Knowledge Base
Display-only. Display name for the selected knowledge base
article(s)
Delete
Highlight the appropriate knowledge base article and click the
Delete
tool to remove the knowledge base article from the
list.
Browse
Click Browse to launch the Select Knowledge Base dialog box
for a list of existing knowledge base articles.
For additional information on knowledge base articles, refer to
the Cisco Tidal Enterprise Orchestrator Reference Guide.
Properties
Highlight the appropriate knowledge base article and click the
Properties
tool to view and/or modify the properties of the
defined knowledge base article.
The following information is displayed on the Knowledge Base tab.
Step 8
Field
Description
Summary
Brief description of the issue
Possible cause
Explanation of the condition that may be causing the issue
Possible resolution
List of actions that can be performed to attempt to resolve
the issue
Related information
Additional information related to the issue
On the Trigger tab, click OK to complete the trigger definition.
The new trigger displays on the Trigger property page.
Cisco TEO Adapter Guide for VMware
4-8
OL-24933-02
Chapter 4
Managing VMware Triggers
Defining a VMware Virtual Machine Performance Event Trigger
Defining a VMware Virtual Machine Performance Event Trigger
Use the VMware Virtual Machine Performance Event trigger to specify the performance counter criteria
for the virtual machine of the ESX server to be monitored and used to trigger an event that must be
matched to trigger the process.
To define a VMware Virtual Machine Performance Event trigger:
Step 1
In the Process—Triggers tab, click New > VMware > VMware Virtual Machine Performance Event.
The VMware Virtual Machine Performance Event Properties dialog box displays.
Figure 4-4
Step 2
VMware VM Performance Event Properties Dialog Box—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the trigger
Type
Display-only. Type of trigger
Description
Brief description of the trigger
Enabled
The check box is checked by default. The checked box
indicates the trigger is available for execution.
Check the check box to disable the trigger. If the check
box is unchecked, the trigger is disabled, and the
adapter is not monitoring for the event criteria
configured in the trigger. The process will not be
triggered or executed if the event matching the criteria
occurs.
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-9
Chapter 4
Managing VMware Triggers
Defining a VMware Virtual Machine Performance Event Trigger
Step 3
Note
Click the Virtual Machine Performance Event to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 4-5
Step 4
VMware VM Performance Event Dialog Box—Virtual Machine Performance Event Tab
On the Virtual Machine Performance Event tab, enter the appropriate trigger information.
Field
Description
ESX host
Inventory path to the performance monitored host server or
host server where the monitored virtual machine resides.
Please note the inventory path entered is case-sensitive.
Note
Virtual machine
Inventory path to the virtual machine to be monitored for
the event.
Note
Performance counter
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Click Browse to launch the Performance Event dialog box
to select the appropriate performance counter to monitor
for the virtual machine.
For example, the counter with name "usage" for the "cpu"
group of performance counters is CPU_Usage.
Cisco TEO Adapter Guide for VMware
4-10
OL-24933-02
Chapter 4
Managing VMware Triggers
Defining a VMware Virtual Machine Performance Event Trigger
Field
Description
Statistic
Display-only. Type of statistical values that are returned for
the counter
Operators
•
Current—Most recent value of the performance
counter over the summarization period
•
Minimum—Minimum value of the performance
counter value over the summarization period
•
Maximum—The maximum value of the performance
counter value over the summarization period
•
Average—The actual value collected or the average of
all values collected during the summary period
The displayed operators depend on the selected property.
Note
Step 5
For information on the displayed operators, see
Comparison Operators, page 2-14.
Expression
Expression associated with the selected operator
Unit
Display-only. The unit for the values of the performance
counter (Ex. KBps, MHz, etc.)
Sample size
Enter the number of samples to be returned by the trigger
Interval (in seconds)
Enter the interval, in seconds, for the performance statistics
Complete the appropriate information in the following tabs, as necessary, and then click OK to complete
the trigger definition.
•
Target—Specify the target on which to monitor for events that will trigger the process. See Step 5
in Defining a VMware Host Performance Event Trigger.
•
Conditions—Specify when an action is to be taken based on an evaluation of conditions that have
been defined. See Step 6 in Defining a VMware Host Performance Event Trigger.
•
Knowledge Base—Select the appropriate knowledge base article to associate with the trigger. See
Step 7 in Defining a VMware Host Performance Event Trigger.
The new VMware Virtual Performance Event trigger displays in the Trigger property page.
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-11
Chapter 4
Managing VMware Triggers
Defining a VMware Virtual Machine Power Event Trigger
Defining a VMware Virtual Machine Power Event Trigger
Use the VMware Virtual Machine Power Event trigger to specify the criteria for the Virtual Center to
monitor the power state of a virtual machine changes to that specified in the event.
To define a VMware Virtual Machine Power Event trigger:
Step 1
On the Process—Triggers tab, click New > VMware > VMware Virtual Machine Power Event.
The VMware Virtual Machine Power Event Properties dialog box displays.
Figure 4-6
Step 2
VMware Virtual Machine Power Event Properties Dialog Box—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the trigger
Type
Display-only. Type of trigger
Description
Brief description of the trigger
Enabled
The check box is checked by default. The checked box
indicates the trigger is available for execution.
Check the check box to disable the trigger. If the check
box is unchecked, the trigger is disabled, and the
adapter is not monitoring for the event criteria
configured in the trigger. The process will not be
triggered or executed if the event matching the criteria
occurs.
Cisco TEO Adapter Guide for VMware
4-12
OL-24933-02
Chapter 4
Managing VMware Triggers
Defining a VMware Virtual Machine Power Event Trigger
Step 3
Note
Click the VMware Power Event to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 4-7
Step 4
VMware Virtual Machine Power Event Dialog Box—VMware Power Event Tab
On the VMware Power Event tab, enter the appropriate trigger information.
Field
Description
ESX host
Performance monitored host server or host server where
the monitored virtual machine resides.
Note
Virtual machine
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Virtual machine to be monitored for the event.
Note
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-13
Chapter 4
Managing VMware Triggers
Defining a VMware Virtual Machine Power Event Trigger
Field
Description
Power state
Select the power state that will trigger the event:
Check trigger connect
•
Powered On—When the virtual machine and the guest
operating system that automatically starts up on
system boot is Powers up.
•
Tools Running—Triggered when the VMware tools
state is running
•
Powered Off—Powers down the virtual machine. The
virtual machine does not attempt to gracefully shut
down the guest operating system.
•
Suspended—Pauses the virtual machine activity. All
transactions are frozen until the Resume command is
executed.
•
Any State Change—Process is triggered when power
changes to any state
Check this check box to trigger the condition is detected
upon connection to the VMware infrastructure server.
Note
Step 5
If the power state is Powered On, the event based
upon connection to the VMware infrastructure
server.
Complete the appropriate information in the following tabs, as necessary, and then click OK to complete
the trigger definition.
•
Target—Specify the target on which to monitor for events that will trigger the process. See Step 5
in Defining a VMware Host Performance Event Trigger.
•
Conditions—Specify when an action is to be taken based on an evaluation of conditions that have
been defined. See Step 6 in Defining a VMware Host Performance Event Trigger.
•
Knowledge Base—Select the appropriate knowledge base article to associate with the trigger. See
Step 7 in Defining a VMware Host Performance Event Trigger.
The new VMware Virtual Power Event trigger displays in the Trigger property page.
Cisco TEO Adapter Guide for VMware
4-14
OL-24933-02
Chapter 4
Managing VMware Triggers
Managing Trigger Definitions
Managing Trigger Definitions
The information in this section provide instructions on modifying trigger properties. Use the
Process—Triggers property page to perform the following functions:
•
Enable/Disable triggers
•
Modify triggers properties
•
Delete the trigger
Enabling a Trigger
A trigger is enabled by default. If a trigger is manually disabled, the trigger must be enabled before it is
available for monitoring.
To enable a trigger:
On the Process—Trigger view, highlight the trigger, and then right-click and choose Enable.
The trigger becomes enabled in the trigger list.
Disabling a Trigger
Disabling a trigger prevents the object from being monitored. The disabled trigger is not removed from
the list of triggers in the Triggers tab.
To disable a trigger:
On the Process—Trigger view, highlight the trigger, and then right-click and choose Disable.
The trigger becomes disabled in the trigger list.
Modifying Triggers
Use the Triggers tab to modify the configured triggers. After the initial creation, not all fields are
available for updating.
To modify a trigger:
Step 1
On the Triggers tab, highlight the appropriate the trigger, and click Properties.
The selected trigger dialog box displays.
Step 2
Modify the information on the trigger tabs, as necessary, and click OK.
The modified trigger displays on the Trigger tab.
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-15
Chapter 4
Managing VMware Triggers
Managing Trigger Definitions
Adding Basic Conditions to an Object
Use the Basic panel to create simple conditions using variables to match to operator criteria.
To add a new condition to an object:
Step 1
On the [Object] property page or dialog box, click the Conditions tab.
The Conditions tab displays.
Figure 4-8
Step 2
Conditions Tab—Basic Panel
Under Conditions, the True/False link determines when the object should execute against the specified
conditions.
Option
Description
TRUE
Default link option indicates the process is always executed
when the event matching criteria in the "trigger-specific"
page happens or is detected by the VMware infrastructure.
A single condition is listed by default and is set to True. If
no other conditions are specified, this condition will
remain and cannot be deleted by the user.
FALSE
Step 3
Click this link to indicate the process is NEVER executed
when the event happens.
Click the appropriate button to modify the condition properties used to execute the object.
Button
Description
New
Click New to add a Properties pane to the condition.
Delete
Click this button to remove the last Properties section in the
list of properties.
Cisco TEO Adapter Guide for VMware
4-16
OL-24933-02
Chapter 4
Managing VMware Triggers
Managing Trigger Definitions
Step 4
Each time the New button is clicked, a Properties section is displayed for the condition. The following
table displays the fields for the Properties section.
Button
Description
Text field
Data for this field cannot be manually entered.
Click the Reference tool to select a property variable to use
as a condition.
Operators
Select the operator to be used to evaluate the variable
expression. The displayed operators depend on the selected
property.
Note
Value
Step 5
For information on the displayed operators, see
Comparison Operators, page 2-14.
Enter value for the property
Click OK to save the object.
Adding Advanced Conditions to an Object
Use the Advanced panel to create a more complex condition. Users have the ability to define the
properties of the conditions within the Advanced panel, as well as within the Properties dialog box.
The conditions specified on the Basic panel can also be configured on the Advanced pane, because they
transition to simple TEO-level variable conditions. All other TEO conditions on the Advanced panel
cannot transition to the Basic panel and will not display.
To add an advanced condition to an object:
Step 1
On the [Object] property page or dialog box, click the Conditions tab.
The Conditions tab displays.
Step 2
Click the Advanced panel to continue.
Figure 4-9
Conditions Tab—Advanced Panel
Variable Condition
Time Condition
Prior Process Condition
Compound Condition
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-17
Chapter 4
Managing VMware Triggers
Managing Trigger Definitions
Step 3
Under Conditions, the True/False link determines when the object should execute against the specified
conditions.
Option
Description
TRUE
Default link option indicates the process is always executed
when the event matching criteria in the "trigger-specific"
page happens or is detected by the VMware infrastructure.
A single condition is listed by default and is set to True. If
no other conditions are specified, this condition will
remain and cannot be deleted by the user.
FALSE
Step 4
Click this link to indicate the process is NEVER executed
when the event happens.
Click the appropriate button to modify the condition properties used to execute the object.
Button
Description
New
Click New > [Condition] to add a single condition to
Advanced panel. Repeat this step to add additional
condition properties to the Conditions tab.
Properties
•
Compound Condition—Combines other conditions
(time condition, prior process instance condition,
variable condition, or another compound condition)
into a single condition. The Compound Condition is
created by the addition of another True/False option in
the Advanced Panel.
•
Prior Process Instance Condition—Determines that
when a process has occurred within a specific time
interval, the condition will evaluate to false. If no
process instance is selected, then the trigger will
search for all process instances.
•
Time Condition—Specify a condition based on a
defined calendar.
•
Variable Condition—Specify a variable to be used as
the condition under which the variable should evaluate
as true.
Click anywhere around the appropriate condition. After the
area around the condition is shaded blue, click Properties
to launch the condition properties dialog box.
Note
Delete
Note
Condition properties can be modified on the tab or
within the conditions properties dialog box.
Highlight the appropriate condition and then click Delete
to remove the condition from the object.
For additional information on creating a condition, refer to the Cisco Tidal Enterprise Orchestrator
Reference Guide.
Cisco TEO Adapter Guide for VMware
4-18
OL-24933-02
Chapter 4
Managing VMware Triggers
Managing Trigger Definitions
After the first condition is added, the following operators are displayed. The operator is set to AND by
default.
Operator
Description
AND condition (All conditions must Click this option if an action is to be taken only when all
be met)
conditions in the list are true.
OR condition (One condition must
be met)
Step 5
Click this option if an action is to be taken when one
condition in the list is true.
Click OK to save the object.
Defining Target Criteria for Trigger
When defining a trigger, users can specify that the event should be monitored on VMware targets that
match specific criteria.
The Target Selection Criteria dialog box is launched from the Browse button on the Target property page
on the selected trigger. Use the Target Selection Criteria dialog box to specify the matching criteria for
the selected target group.
To define the target selection criteria:
Step 1
On the Trigger Target property page, select Monitor on this target group, and the appropriate target
group.
Step 2
Under Monitor for Events on, select Choose a target using this algorithm, and then select Choose the
target that satisfies the specified criteria.
Step 3
Click Browse to launch the Target Selection Criteria dialog box.
Figure 4-10
Target Selection Criteria Dialog Box
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-19
Chapter 4
Managing VMware Triggers
Managing Trigger Definitions
Step 4
On the Properties pane, specify the following information, as necessary:
Field
Description
Property
Choose the appropriate property in the to match within the
target.
Click the Reference tool to select the variable from the
Insert Variable Reference dialog box.
See Inserting a Target Variable Reference, page 2-15.
Operators
Select the appropriate operator to be used to evaluate the
expression. The displayed operators depend on the selected
property.
Note
Value
Step 5
Step 6
For information on the displayed operators, see
Comparison Operators, page 2-14.
Enter the appropriate value for the target
To modify the list of Properties pane containing target criteria, click one of the following buttons:
Button
Description
Add
Click this button to a new Properties pane to complete with
criteria for the target.
Remove
Click this button to remove the selected last Properties
pane in the display
Click OK to return to the Trigger—Target property page.
The defined criteria displays in the display only box.
Selecting Performance Counters to Monitor
When configuring a VMware performance event trigger, users are required to select performance
counters to monitor the trigger. Click Browse on the VMware performance event triggers to specify the
performance counters for the trigger.
To add performance counters:
Step 1
On the Performance Event tab, to the right of the Performance Counter field, click Browse.
The Performance dialog box displays.
Cisco TEO Adapter Guide for VMware
4-20
OL-24933-02
Chapter 4
Managing VMware Triggers
Managing Trigger Definitions
Figure 4-11
Step 2
Note
Performance Dialog Box
From the Use the following VMware Virtual Center or ESXi server drop-down list, select the appropriate
server from the drop down list.
To create a new VMware target containing the appropriate counters, click New [Target].
The VMware server performance counters display in the box.
Step 3
Highlight the appropriate performance counter, and click OK to select the performance counter to
display in the Performance Counter display-only field on the trigger.
Deleting Triggers
To delete a trigger:
On the Triggers tab, highlight the appropriate the trigger, and click Delete.
The selected trigger is removed from the Trigger tab.
Cisco TEO Adapter Guide for VMware
OL-24933-02
4-21
Chapter 4
Managing VMware Triggers
Managing Trigger Definitions
Cisco TEO Adapter Guide for VMware
4-22
OL-24933-02
CH A P T E R
5
VMware Activities Overview
This chapter provides instructions for defining VMware activities, instructions for completing the
property pages for each specific activity, and instructions on viewing the activity results.
•
Defining a VMware Activity, page 5-2
•
Managing VMware Activity Definitions, page 5-5
•
Viewing Activity Instance Information, page 5-11
Cisco TEO Adapter Guide for VMware
OL-24933-02
5-1
Chapter 5
VMware Activities Overview
Defining a VMware Activity
Defining a VMware Activity
Use the following steps to define a VMware activity in the Process Editor dialog box. The property pages
displayed depend on the selected activity.
To define a VMware activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the appropriate activity, then drag and drop the
activity onto the Workflow pane.
The [Activity Name] Properties dialog box displays.
Step 2
Step 3
Note
Step 4
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Type
Display-only. Type of activity
Description
Brief description of the activity
Click the activity definition property page to define the properties specific to the activity. Refer to the
appropriate section for instructions on defining the activity property.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Click the Reference
tool to choose a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
Click the Target tab to specify whether the process target should be used for activity execution or
overridden with a different target:
Field
Description
Execute on process target
Select this radio button to use the same target that was
specified in the process definition.
Execute on activity target
Select this radio button to execute this activity on the same
target as on e of the earlier activities in the process. The
selected target overrides the target specified in the process
definition.
Executed on this target
Select this radio button and then click Browse to launch the
Select Targets dialog box to select a specific target on
which to execute the activity.
The targets that display in the Select Targets dialog box are
targets already defined in TEO.
Note
To view the properties for the selected target, click
the Properties
tool. For additional information,
see Chapter 2, “Managing VMware Targets.”
Cisco TEO Adapter Guide for VMware
5-2
OL-24933-02
Chapter 5
VMware Activities Overview
Defining a VMware Activity
Field
Description
Execute on this target reference
Select this radio button and then click the Reference tool
launch the Insert Variable Reference dialog box.
On the Insert Variable Reference dialog box, expand
Process > Target > Properties, select the appropriate
target reference property, and click OK.
The selected target reference property displays in the text
field.
Execute on this target group
Select this radio button and then click Browse to launch the
Select Target Group dialog box to select a specific target on
which to execute the activity.
The target groups that display in the Select Target Group
dialog box are target groups already defined in TEO.
Note
To view the properties for the selected target group,
click the Properties
tool. For additional
information, see the Cisco Tidal Enterprise
Orchestrator Reference Guide.
Choose a target using this algorithm Select this radio button to execute the process using one of
the options from the drop-down list.
Note
Step 5
For algorithm descriptions, see Target Algorithms,
page 2-4.
Click the Credentials tab to specify the runtime user whose credentials should be used for process
execution:
Field
Description
Use target's default runtime user
Select this radio button to use the default runtime user for
the target that is specified in the activity
Use process runtime user
Select this radio button to use the credentials for the
runtime user that was specified in the process properties
Override process runtime user
Select this radio button to specify a runtime user whose
credentials are different than what was specified in the
process properties. The selected runtime user overrides the
runtime user that was specified for the process.
Note
To view the properties for the selected runtime
user, click the Properties
tool. To create a
runtime user record for the process, click New >
[Runtime User]. For additional information on
creating a runtime user, see Chapter 3, “Managing
Runtime Users.”
Cisco TEO Adapter Guide for VMware
OL-24933-02
5-3
Chapter 5
VMware Activities Overview
Defining a VMware Activity
Step 6
Click the Knowledge Base tab to assign a knowledge base article to the object.
Knowledge Base Field Options
Description
Knowledge Base
Display-only. Display name for the selected knowledge base
article(s)
Delete
Highlight the appropriate knowledge base article and click the
Delete
tool to remove the knowledge base article from the
list.
Browse
Click Browse to launch the Select Knowledge Base dialog box
for a list of existing knowledge base articles.
For additional information on knowledge base articles, refer to
the Cisco Tidal Enterprise Orchestrator Reference Guide.
Properties
Highlight the appropriate knowledge base article and click the
Properties
tool to view and/or modify the properties of the
defined knowledge base article.
The following information is displayed on the Knowledge Base tab.
Step 7
Step 8
Field
Description
Summary
Brief description of the issue
Possible cause
Explanation of the condition that may be causing the issue
Possible resolution
List of actions that can be performed to attempt to resolve
the issue
Related information
Additional information related to the issue
On the Result Handlers tab, click one of the following buttons to manage the condition branches on the
workflow, as necessary:
Button
Description
Add
Adds a condition branch
Remove
Removes the condition branch from the activity
Move Up
Moves the condition up one position in the list of conditions
Move Down
Moves the condition down one position in the list of
conditions
Click the Save
tool to save the activity definition.
Cisco TEO Adapter Guide for VMware
5-4
OL-24933-02
Chapter 5
VMware Activities Overview
Managing VMware Activity Definitions
Managing VMware Activity Definitions
The information in this section provide instructions on modifying the activity properties. Use the activity
property page to perform the following functions:
•
Modify activity properties
•
Inserting variable references
Modifying a VMware Activity
Modifying a process does not automatically modify an activity. Activity definitions are included in a
process definition and the activity properties must be modified separately from the process properties.
Activities can only be modified in the Process Editor. With the appropriate rights from the Operations
view, the Process Editor is launched when accessing the process properties.
When user rights are restricted, the Process Viewer is launched with the properties displaying a
display-only view after determining that the user cannot edit the activity.
Step 1
To modify an activity, use one of the following methods:
•
On the Definitions—Process view, highlight the appropriate process, right-click and choose Edit.
-or-
•
On the Operations workspace, select a process from any of the four process views, right-click and
choose Edit.
The Process Editor dialog box displays.
Step 2
On the Workflow pane, select the appropriate activity, and modify activity properties, as necessary, and
click Save.
Step 3
Make any additional changes, as necessary, and click Exit to close the Process Editor.
Cisco TEO Adapter Guide for VMware
OL-24933-02
5-5
Chapter 5
VMware Activities Overview
Managing VMware Activity Definitions
Selecting a Managed Object
Use the Select Managed Objects dialog box to retrieve the appropriate object defined on a specified
VMware target.
To select an object from a defined target:
Step 1
To the right of the field on the VMware activity field, click Browse to launch the Select Managed Objects
dialog box to query the appropriate managed object on a specified target.
Figure 5-1
Step 2
Note
Select Managed Object Dialog Box
From the drop-down list, select the appropriate target from the drop down list to display the managed
objects.
To create a new VMware connection containing the appropriate objects, click New [Target].
The Managed Objects section displays the objects managed by the selected target.
Step 3
To the left of a folder, click Expand (+) to view additional objects for selection.
Step 4
Select a valid object from the list, and click OK.
The Description display-only box provides the inventory path of the selected object.
Adding a Script Argument
Script arguments are a property for the Execute PowerCLI Script activity. The Add button on these
activities launches the Select Argument to Add dialog box for users to specify the script arguments to be
added to the list on the specified activity.
To add a script argument:
Step 1
On the appropriate activity property page, click Add.
Cisco TEO Adapter Guide for VMware
5-6
OL-24933-02
Chapter 5
VMware Activities Overview
Managing VMware Activity Definitions
The Select Arguments to Add dialog box displays.
Step 2
Specify the script argument value for the script.
Step 3
Click OK.
The script argument is added to the command line argument list on the activity property page.
Script Argument Syntax
Any command-line arguments can be accessed as shell variables inside a script. The following table
contains script arguments which can be used inside a script.
Syntax
Description
${0}
The name of the script being run
$?name
Returns 1 if the variable name is defined, or 0 if it is not
defined
$n
The value of the n argument passed to the script
$argv[n]
The value of the n argument passed to the script
$#argv
The number of arguments passed to the script
$*
All the arguments supplied to the script
$$
Process identification number (useful for making
temporary files with unique names)
Modifying a Script Argument
Use the Select Argument to Add dialog box to modify existing script arguments added to the script or
command activities.
To modify a script argument:
Step 1
On the appropriate activity property page, under the Arguments section, highlight the appropriate the
script argument, and click Edit.
The Select Argument to Add dialog box displays.
Step 2
Modify the information on the variable, as necessary, and click OK.
The modified script argument displays in the activity tab.
Removing a Script Argument
Removing a script argument from an activity does not delete the object from the TEO server. To delete
the object, refer to the appropriate object definition section.
To remove a script argument:
On the activity property page tab, highlight the appropriate the argument, and click Remove.
Cisco TEO Adapter Guide for VMware
OL-24933-02
5-7
Chapter 5
VMware Activities Overview
Managing VMware Activity Definitions
Inserting Activity Variable References
The Reference
icon to the right of a text field indicates that the field can be populated by referencing
a defined variable or the property of another activity or process. Use the Insert Variable Reference dialog
box to select a defined variable or object to populate a field.
Only variables valid for the selected field can be selected in this dialog box. The OK button does not
activate until a valid property or variable is selected.
To insert a variable reference:
Step 1
To the right of a field on a property page, click the Reference tool.
The Insert Variable Reference dialog box displays.
Step 2
Check the Show Advanced check box to display all items that are available for referencing.
Figure 5-2
Insert Variable Reference Dialog Box
If the check box is not checked, then only the most commonly-used items are displayed for activities,
processes or events.
Note
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Step 3
Click the Workflow Expand (+) to display the reference objects for the activities in the workflow. The
properties in the Insert Reference Variable dialog box depend on the activities.
Cisco TEO Adapter Guide for VMware
5-8
OL-24933-02
Chapter 5
VMware Activities Overview
Managing VMware Activity Definitions
Step 4
From the list of displayed objects, select the appropriate property.
Reference Variable
Description
Virtual Center/ESX server name Host name or IP address of the virtual center or ESX/ESXi
server
Virtual machine
Inventory path to the virtual machine
Parent
Inventory path to the folder to which the virtual machine
belongs
Resource pool
Inventory path to the current resource pool that specifies
resource allocation for this virtual machine
Notes
Description for the virtual machine
Version
Version string for the virtual machine
Power state
Current power state of the virtual machine
Host
Inventory path of the host that is responsible for running a
virtual machine
VM Connection state
Indicates whether the virtual machine is available for
management
VM Max CPU usage
Current upper-bound on CPU usage
VM Max memory usage
Current upper-bound on memory usage
VM Memory overhead
Amount of memory resource (in bytes) that will be used by
the virtual machine above its guest memory requirements.
VM Boot time
The timestamp when the virtual machine was most recently
powered on
VM Suspend time
The timestamp when the virtual machine was most recently
suspended
CPU Number
Number of virtual processors to allocate to the virtual
machine
Memory (MB)
Size of the virtual machine’s memory in MB
Name
Display name of the activity
Created by
User name or the owner of the activity
Modified by
User name of the individual who modified the activity
Type
Type of activity
Description
Description of the activity
Audit Starts
Date and time the process audit starts
Audit Successes
Indicates the number of successful audits
End Time
Date and time the activity stopped
Error Information
Description of the error that has occurred
Group Name
Name of toolbox activity group
Instance Cancelled
Indicates the process was cancelled manually
Instance Failed
Indicates the process has failed
Instance Failed (Completed)
Indicates the process has failed but the process execution was
completed
Cisco TEO Adapter Guide for VMware
OL-24933-02
5-9
Chapter 5
VMware Activities Overview
Managing VMware Activity Definitions
Reference Variable
Description
Instance Failed (Not Completed) Indicates the process has failed and did not complete the
process execution
Step 5
Skipped
Indicates whether the process was skipped due to being in the
expected power state
Snapshot Name
Display name for the snapshot
Snapshot Description
Description of the snapshot
Start Time
Date and time the activity was started
Time Out
Indicates whether the activity timed out
Host DNS Name
DNS name or IP address of the host server
Is Host in Maintenance Mode
Indicates whether the host server is in maintenance mode
Is VMotion Enabled
Indicates whether VMotion is enabled on this host
Is Standby Supported
Indicates the host is in a power down state, from which it can
be powered up automatically
Host Connection State
The host system connection state
Host Power State
The host system power state
Host Boot Time
The time when the host was booted
Host Date Time Configuration
The date time configuration information of the host
Click OK to add the related text field populates with the selected value.
Cisco TEO Adapter Guide for VMware
5-10
OL-24933-02
Chapter 5
VMware Activities Overview
Viewing Activity Instance Information
Viewing Activity Instance Information
This section describes what the user should expect to see after a process with a VMware activity is
launched. Certain activities generate and display additional activity instance information for review by
users.
For example, there will be certain activities that generate information based on the defined properties of
the activities. In those situations, the activity instance properties will display the display-only
configuration properties as well as the generated results of the configuration properties.
Viewing Activity Status
After a process is launched, status and color indicators display on the console to indicate the current
status for each process and activity instance.
Status Indicators
The State column displays the status of the individual process and activity. The following indicators
definitions display on the Results pane.
State
Description
Succeeded
Process has completed successfully
Running
Process is in progress
Failed (Not Completed)
Displays when the process has failed and did not complete
the process execution
Failed (Cancelled)
Displays when the process is cancelled manually
Color Indicators
The colors associated with the individual activities indicate the status of the process instances. The
following default colors display:
Note
Color Indicator
Description
Blue
Process is in progress
Green
Process has completed successfully
Red
Process has failed and did not complete the process
execution
Orange
Process has stopped.
To modify the fonts and colors on the Activity View status display, see Customizing the Fonts and Colors
in the Cisco Tidal Enterprise Orchestrator Reference Guide.
Cisco TEO Adapter Guide for VMware
OL-24933-02
5-11
Chapter 5
VMware Activities Overview
Viewing Activity Instance Information
Viewing Activity Instance Properties
The activity instance properties displayed from the Activity View are display-only.
To view activity instance properties:
Step 1
On the Operations workspace, select any of the four activity views to display the activity instances on
the Results pane.
Activity View
Description
View Triggered
Displays all process or activity instances that were
executed (manually or automatically) and are in progress,
have successfully completed, or failed during the selected
time period
View Adhoc
Displays all process or activity instances that were
executed manually and are in progress, have successfully
completed, or failed during the selected time period
View All
Displays all process, activity, and scheduled process and
activity instances that are in progress, have successfully
completed, or failed during the selected display time period
View Scheduled
Displays all process or activity instances that are in
progress, have successfully completed, or failed and are
also scheduled to execute during the selected time period
Step 2
On the Results pane, expand the appropriate activity instance to display the related activities.
Step 3
Highlight the appropriate activity, and use one of the following methods:
•
Double-click the appropriate activity instance.
•
Right-click and choose Observe.
•
On the Details pane, click the hyperlink of any options on the tabs.
The [Activity Name] Properties dialog box displays.
Viewing Host Instance Information
When a host-related VMware activity is executed, it collects information about the properties of
VMware host. This information is displayed in the property pages of the corresponding VMware activity
instance
To view the VMware activity host information:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Use one of the following methods:
•
Highlight the VMware activity instance, right-click and choose Properties.
-or-
•
Double-click the appropriate activity instance.
The [Activity Name] Properties dialog box displays.
Cisco TEO Adapter Guide for VMware
5-12
OL-24933-02
Chapter 5
VMware Activities Overview
Viewing Activity Instance Information
Step 3
Click the Host tab to display the display-only host-related output properties from the VMware activity.
The following information is displayed:
Field
Description
Virtual Center/ESX server name
Host name of IP address of the virtual center or ESX/ESXi
server
Name
Inventory path of the host server responsible for running a
virtual machine
Maintenance mode
Indicates whether the host server is in maintenance mode.
This flag is set when the host has entered the maintenance
mode. It is not set during the entering phase of maintenance
mode.
VMotion enabled
Indicates whether or not VMotion is enabled on this host
Standby supported
Indicates whether to put the host in a power down state, from
which it can be powered up automatically.
System connection state
The host connection state:
System power state
•
connected—Connected to the server. For ESX Server,
this is always the setting.
•
disconnected—The host was taken down by the user.
Virtual Center does not expect to receive heartbeats from
the host. The next time a heartbeat is received, the host
changes to the connected state again and an event is
logged.
•
notResponding—Virtual Center is not receiving
heartbeats from the server. The state automatically
changes to connected once heartbeats are received again.
This state is typically used to trigger an alarm on the host.
The host power state.
•
poweredOff—The host was specifically powered off by
the user through Virtual Center. This state is not a certain
state, because after Virtual Center issues the command to
power off the host, the host might crash, or kill all the
processes but fail to power off.
•
poweredOn—The host is powered on
•
standBy—The host was specifically put in standby mode,
either by the user or automatically by DPM. This state is
not a certain state, because after Virtual Center issues the
command to put the host in standby state, the host might
crash, or kill all the processes but fail to power off.
•
unknown—If the host is disconnected, or notResponding,
there is no knowledge of the host power state.
Host boot time
The time when the host was booted
Host date time information
The date time configuration information of the host.
Cisco TEO Adapter Guide for VMware
OL-24933-02
5-13
Chapter 5
VMware Activities Overview
Viewing Activity Instance Information
Viewing VM Instance Information
When a configuration or power VMware activity is executed, it collects information about VM image
that activity is executed against. This information can be viewed in the property pages of the
corresponding VMware activities.
To view the VMware activity virtual machine information:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Use one of the following methods:
•
Highlight the VMware activity instance, right-click and choose Properties.
-or-
•
Double-click the appropriate activity instance.
The [Activity Name] Properties dialog box displays.
Step 3
Click the Virtual Machine tab to display the display-only virtual machine-related output properties
from the VMware activity.
The following information is displayed:
Field
Description
Virtual Center/ESX server name
Host name or IP address of the virtual center or ESX/ESXi
server
Virtual machine
Inventory path to the virtual machine
Parent
Inventory path to the folder to which the virtual machine
belongs
Resource pool
Inventory path to the current resource pool that specifies
resource allocation for this virtual machine
Notes
Description for the virtual machine
Version
Version string for the virtual machine
Power state
Current power state of the virtual machine
Host
Inventory path of the host server that is responsible for
running a virtual machine. This field is empty if the virtual
machine is not running and is not assigned to run on a
particular host.
Connection state
Indicates whether the virtual machine is available for
management
Max CPU usage
Current upper-bound on CPU usage.
The upper-bound is based on the host the virtual machine is
current running on, as well as limits configured on the virtual
machine itself or any parent resource pool. Valid while the
virtual machine is running.
Max memory usage
Current upper-bound on memory usage.
The upper-bound is based on memory configuration of the
virtual machine, as well as limits configured on the virtual
machine itself or any parent resource pool. Valid while the
virtual machine is running.
Cisco TEO Adapter Guide for VMware
5-14
OL-24933-02
Chapter 5
VMware Activities Overview
Viewing Activity Instance Information
Field
Description
Memory overhead
Amount of memory resource (in bytes) that will be used by
the virtual machine above its guest memory requirements.
This value is determined if the virtual machine is registered
on a host that supports memory resource allocation features.
For powered off virtual machines, this is the minimum
overhead required to power on the virtual machine on the
registered host. For powered on virtual machines, this is the
current overhead reservation, a value which is almost always
larger than the minimum overhead, and which grows with
time.
Boot time
The timestamp when the virtual machine was most recently
powered on.
This property is updated when the virtual machine is powered
on from the poweredOff state, and is cleared when the virtual
machine is powered off. This property is not updated when a
virtual machine is resumed from a suspended state.
Suspend time
The timestamp when the virtual machine was most recently
suspended
CPU Number
Number of virtual processors to allocate to the virtual
machine
Memory (MB)
Size of the virtual machine’s memory in MB
Cisco TEO Adapter Guide for VMware
OL-24933-02
5-15
Chapter 5
VMware Activities Overview
Viewing Activity Instance Information
Cisco TEO Adapter Guide for VMware
5-16
OL-24933-02
CH A P T E R
6
VMware Configuration Management Activities
Use the following activities to modify the basic configuration of the virtual machine running in the
VMware environment.
This chapter provides instructions for defining VMware configuration activities, instructions for
completing the property pages for each specific activity, and instructions on viewing the activity results.
•
VMware Configuration Activities, page 6-2
•
Defining the Add VM Hard Disk Activity, page 6-4
•
Defining the Add VM Network Adapter Activity, page 6-10
•
Defining the Clone VM Activity, page 6-13
•
Defining the Create Folder Activity, page 6-16
•
Defining the Create New VM Activity, page 6-19
•
Defining the Customize Linux VM Activity, page 6-21
•
Defining the Customize Windows VM Activity, page 6-27
•
Defining the Delete VM Activity, page 6-35
•
Defining the Enumerate Datastores Activity, page 6-38
•
Defining the Enumerate Networks Activity, page 6-40
•
Defining the Enumerate Resource Pools Activity, page 6-43
•
Defining the Migrate VM Activity, page 6-45
•
Defining the Query VM Devices Activity, page 6-48
•
Defining the Query VM Network Adapters Activity, page 6-50
•
Defining the Query VM Properties Activity, page 6-52
•
Defining the Query VMs Activity, page 6-54
•
Defining the Reconfigure VM Activity, page 6-56
•
Defining the Relocate VM Activity, page 6-59
•
Defining the Update VM Hard Disk, page 6-64
•
Defining the Update VM Network Adapter, page 6-67
•
Defining the Upgrade VM Hardware Activity, page 6-70
•
Defining the Upgrade VM Tools, page 6-72
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-1
Chapter 6
VMware Configuration Management Activities
VMware Configuration Activities
•
Managing VMware Configuration Activity Definitions, page 6-76
•
Viewing VMware Configuration Activity Results, page 6-78
VMware Configuration Activities
The following table displays the configuration activities provided by the VMware Adapter:
Activity
Description
Add VM Hard Disk
Adds a hard disk to a specified virtual machine
See Defining the Add VM Hard Disk Activity, page 6-4.
Add VM Network Adapter
Adds a network adapter to a specified virtual machine
See Defining the Add VM Network Adapter Activity,
page 6-10.
Clone VM
Clones a specified virtual machine
See Defining the Clone VM Activity, page 6-13.
Create Folder
Creates a new folder within the VMware infrastructure
inventory
See Defining the Create Folder Activity, page 6-16
Create New VM
Creates a new virtual machine
See Defining the Create New VM Activity, page 6-19.
Customize Linux VM
Customizes the Linux operation system of a specified virtual
machine
See Defining the Customize Linux VM Activity, page 6-21.
Customize Windows VM
Customizes a Windows operating system of a specified
virtual machine
See Defining the Customize Windows VM Activity,
page 6-27.
Delete VM
Removes a virtual machine from the inventory or deletes a
virtual machine
See Defining the Delete VM Activity, page 6-35.
Enumerate Datastores
Retrieves all datastores configured within the specified
VMware infrastructure
See Defining the Enumerate Datastores Activity, page 6-38.
Enumerate Networks
Retrieves all networks configured within the specified
VMware infrastructure
See Defining the Enumerate Networks Activity, page 6-40.
Enumerate Resource Pools
Retrieves all resource pools configured within the VMware
infrastructure.
See Defining the Enumerate Resource Pools Activity,
page 6-43.
Cisco TEO Adapter Guide for VMware
6-2
OL-24933-02
Chapter 6
VMware Configuration Management Activities
VMware Configuration Activities
Activity
Description
Migrate VM
Migrates a specified virtual machine from one server to
another server
See Defining the Migrate VM Activity, page 6-45.
Query VM Devices
Queries the list of devices on a specified virtual machine
See Defining the Query VM Devices Activity, page 6-48.
Query VM Network Adapters
Queries information about network adapters configured for a
specified virtual machine
See Defining the Query VM Network Adapters Activity,
page 6-50.
Query VM Properties
Queries the properties of a specified virtual machine
See Defining the Query VM Properties Activity, page 6-52.
Query VMs
Queries the virtual machines on a given ESX server or
Virtual Center server
See Defining the Query VMs Activity, page 6-54.
Reconfigure VM
Reconfigures the memory, number of CPUs allocated, and
other settings
See Defining the Reconfigure VM Activity, page 6-56.
Relocate VM
Relocates a specified virtual machine from one server to
another server
See Defining the Relocate VM Activity, page 6-59.
Remove VM Device
Removes a device from a specified virtual machine
See Defining the Remove VM Device Activity, page 6-62.
Update VM Hard Disk
Updates configuration of a specified hard disk on a specified
virtual machine.
See Defining the Update VM Hard Disk, page 6-64.
Update VM Network Adapter
Updates network adapter properties on a virtual machine
See Defining the Update VM Network Adapter, page 6-67.
Upgrade VM Hardware
Upgrades the virtual machine's virtual hardware to the latest
revision that is supported
See Defining the Upgrade VM Hardware Activity,
page 6-70.
Upgrade VM Tools
Upgrades the VMware Tools on a Windows virtual machine
using the VMware Tools installer
See Defining the Upgrade VM Tools, page 6-72.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-3
Chapter 6
VMware Configuration Management Activities
Defining the Add VM Hard Disk Activity
Defining the Add VM Hard Disk Activity
Use the Add VM Hard Disk activity to add a hard disk to a specified virtual machine.
Because the fields on the property page change depending on how the new VM hard disk is added, the
following steps should be used when creating a new virtual disk.
To define the Add VM Hard Disk activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Add VM Hard Disk activity, then drag and
drop the activity onto the Workflow pane.
The Add VM Hard Disk property pages display.
Figure 6-1
Step 2
Step 3
Note
Add VM Hard Disk Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Add VM Hard Disk tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
6-4
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Add VM Hard Disk Activity
Figure 6-2
Note
Step 4
Add VM Hard Disk Properties Page—Hard Disk Settings Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Hard Disk Settings tab, specify the following properties to use to add a hard disk to a virtual
machine:
Field
Description
Virtual machine
Inventory path to the virtual machine. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-5
Chapter 6
VMware Configuration Management Activities
Defining the Add VM Hard Disk Activity
Step 5
Field
Description
Type
From the drop-down list, select the appropriate type of
virtual hard disk to be added.
•
Create a new virtual disk—New virtual disk from
original settings
•
Use an existing virtual disk—Adds an existing virtual
disk file. See Adding a VM Hard Disk using an
Existing Virtual Disk, page 6-7.
•
Raw Device Mappings—Creates a file that points the
data to the raw LUN. See Adding a VM Hard Disk
using Raw Device Mappings, page 6-8.
To create a new virtual disk, from the Type drop-down list, select Create a new virtual disk, and specify
the following properties:
Field
Description
Provisioned size
Enter the size of the new virtual disk. From the Unit
drop-down list, select the appropriate unit size for the disk.
Disk provisioning
Location
•
MB—Megabyte (1024 KB)
•
GB—Gigabyte (1024 MB)
•
TB—Terabyte (1024 GB)
Check the appropriate check box to indicate that the disk
space should be provisioned and how the resources should
be allocated or supported.
•
Allocate and commit space on demand (Thin
provisioning)—Indicates that a certain amount of
storage space on a datastore should be allocated to the
virtual disk files
•
Supporting clustering features such as Fault
Tolerance—Indicates the virtual disk can support a
cluster of hosts in the virtual environment.
From the drop-down list, select the appropriate location for
the hard disk
•
Store with the virtual machine—Select this radio to
indicate that the new hard disk should be stored on the
same datastore as the virtual machine.
•
Specify a datastore—Select this radio button and then
in the text field, enter the inventory path to the
appropriate datastore.
Click Browse to launch the Select Managed Objects
dialog box to query the appropriate managed object on
a specified target. See Selecting a Managed Object,
page 5-6.
Virtual device node
Enter the device node of the cluster.
Cisco TEO Adapter Guide for VMware
6-6
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Add VM Hard Disk Activity
Field
Description
Mode
From the drop-down list, select the appropriate mode for
the property of a virtual disk.
Time out if not completed within
•
independent_nonpersistent—The disk appears to
operate normally, but whenever the virtual machine is
powered off or reverted to a snapshot, the contents of
the disk return to their original state. All later changes
are discarded.
•
independent_persistent—The disk operates normally
except that changes to the disk are permanent even if
the virtual machine is reverted to a snapshot.
•
persistent—All disk writes issued by software running
inside a virtual machine are immediately and
permanently written to a virtual disk that is configured
as an independent disk.
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 6
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Adding a VM Hard Disk using an Existing Virtual Disk
Use the following steps to add a hard disk to a VM using an existing virtual disk file.
To add a new virtual disk:
Step 1
From the Type drop-down list, select Use an a existing virtual disk, and specify the following
properties:
Field
Description
Disk file path
Enter the virtual disk datastore path to the existing disk file.
Virtual device node
Enter the device node of the cluster.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-7
Chapter 6
VMware Configuration Management Activities
Defining the Add VM Hard Disk Activity
Field
Description
Mode
From the drop-down list, select the appropriate mode for
the property of a virtual disk.
Time out if not completed within
•
independent_nonpersistent—The disk appears to
operate normally, but whenever the virtual machine is
powered off or reverted to a snapshot, the contents of
the disk return to their original state. All later changes
are discarded.
•
independent_persistent—The disk operates normally
except that changes to the disk are permanent even if
the virtual machine is reverted to a snapshot.
•
persistent—All disk writes issued by software running
inside a virtual machine are immediately and
permanently written to a virtual disk that is configured
as an independent disk.
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 2
Click the time unit link to change the time interval.
Complete the information in the appropriate tabs, as necessary, and then click the Save
the activity definition.
tool to save
Adding a VM Hard Disk using Raw Device Mappings
Use the following steps to add a hard disk to a VM using a raw device mapping file that points to the raw
LUN.
To add a new virtual disk:
Step 1
From the Type drop-down list, select Raw Device Mappings, and specify the following properties:
Field
Description
Target LUN
Enter the inventory path to the target LUN mapping file.
Location
From the drop-down list, select the appropriate location for
the hard disk
•
Store with the virtual machine—Select this radio to
indicate that the new hard disk should be stored on the
same datastore as the virtual machine.
•
Specify a datastore—Select this radio button and then
in the text field, enter the inventory path to the
appropriate datastore.
Click Browse to launch the Select Managed Objects
dialog box to query the appropriate managed object on
a specified target. See Selecting a Managed Object,
page 5-6.
Cisco TEO Adapter Guide for VMware
6-8
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Add VM Hard Disk Activity
Field
Description
Compatibility
From the drop-down list, select the appropriate virtual disk
compatibility mode.
•
Physical—allows the guest operating system to access
the hardware directly. Physical compatibility is useful
if you are using SANaware applications in the virtual
machine. LUNs attached to powered-on virtual
machines and configured for physical compatibility
cannot be migrated if the migration involves copying
the disk. Such LUNs cannot be cloned or cloned to a
template. You can migrate the mapping file.
•
Virtual—Allows the virtual machine to use VMware
snapshots and other advanced functions. Virtual
compatibility allows the LUN to behave as if it were a
virtual disk, so that you can use features like disk
modes. When you clone the disk or make a template
out of it, the contents of the LUN are copied into a
.vmdk virtual disk file. When you migrate a virtual
compatibility mode RDM, you can migrate the
mapping file or copy the contents of the LUN into a
virtual disk.
Virtual device node
Enter the device node of the cluster.
Mode
From the drop-down list, select the appropriate mode for
the property of a virtual disk.
Time out if not completed within
•
independent_nonpersistent—The disk appears to
operate normally, but whenever the virtual machine is
powered off or reverted to a snapshot, the contents of
the disk return to their original state. All later changes
are discarded.
•
independent_persistent—The disk operates normally
except that changes to the disk are permanent even if
the virtual machine is reverted to a snapshot.
•
persistent—All disk writes issued by software running
inside a virtual machine are immediately and
permanently written to a virtual disk that is configured
as an independent disk.
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 2
Click the time unit link to change the time interval.
Complete the information in the appropriate tabs, as necessary, and then click the Save
the activity definition.
tool to save
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-9
Chapter 6
VMware Configuration Management Activities
Defining the Add VM Network Adapter Activity
Defining the Add VM Network Adapter Activity
Use the Add VM Network Adapter activity to add a network adapter to a specified virtual machine.
To define the Add VM Network Adapter activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Add VM Network Adapter activity, then drag
and drop the activity onto the Workflow pane.
The Add VM Network Adapter property pages display.
Figure 6-3
Step 2
Add VM Network Adapter Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
6-10
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Add VM Network Adapter Activity
Step 3
Note
Click the Network Adapter Settings tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-4
Add VM Network Adapter Properties Page—Network Adapter Settings Tab
Note
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
Step 4
On the Network Adapter Settings tab, specify the following properties for the new VM network adapter:
Field
Description
Virtual machine
Inventory path to the virtual machine. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-11
Chapter 6
VMware Configuration Management Activities
Defining the Add VM Network Adapter Activity
Field
Description
Adapter type
From the drop-down list, select the appropriate network
adapter type.
•
E1000—Emulates the functioning of an E1000
network card. It is the default adapter type for virtual
machines that run 64-bit guest operating systems.
•
Flexible—Supported on virtual machines that were
created on ESX Server 3.0 or greater and that run
32-bit guest operating systems.
•
Vlance—An emulated version of the AMD 79C970
PCnet32- LANCE NIC, an older 10Mbps NIC with
drivers available in most 32-bit guest operating
systems except Windows Vista and later.
•
VMXNET—This virtual network adapter has no
physical counterpart and is optimized for performance
in a virtual machine. Because operating system
vendors do not provide built-in drivers for this card,
VMware Tools must be installed to have a driver for
the VMXNET network adapter available.
•
VMXNET 2—Based on the VMXNET adapter but
provides some high-performance features commonly
used on modern networks, such as jumbo frames and
hardware offloads.
This virtual network adapter is available only for some
guest operating systems on ESX/ESXi 3.5 and later.
VMXNET 2 is supported only for a limited set of guest
operating systems
•
Network
VMXNET 3—Offers all the features available in
VMXNET 2, and adds several new features like
multiqueue support, IPv6 offloads, and MSI/MSI-X
interrupt delivery. VMXNET 3 is supported only for
virtual machines version 7 and later, with a limited set
of guest operating systems
Enter the inventory path of the virtual network to use for
this adapter.
Click Browse to launch the Select Managed Object to
query the appropriate managed object on a specified target.
Connect on power on
Check this check box to indicate that the host should be
connected when it was started
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
6-12
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Clone VM Activity
Step 5
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Clone VM Activity
Use the Clone VM activity to clone a virtual machine.
To define the Clone VM activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Clone VM activity, then drag and drop the
activity onto the Workflow pane.
The Clone VM property pages display.
Figure 6-5
Step 2
Clone VM Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-13
Chapter 6
VMware Configuration Management Activities
Defining the Clone VM Activity
Step 3
Note
Click the Clone Virtual Machine tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-6
Clone VM Properties Page—Clone Virtual Machine Tab
Note
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
Step 4
On the Clone Virtual Machine tab, specify the following properties to use to clone the virtual machine:
Field
Description
Virtual machine
Inventory path to the virtual machine to be cloned. The
information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Clone name
Name of the new virtual machine resulting from the
cloning process
Inventory location
Inventory path to the folder in the inventory where you
want to put the virtual machine you are cloning
Host
Inventory path of the target server for the new virtual
machine. The information in this field is case-sensitive.
Cisco TEO Adapter Guide for VMware
6-14
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Clone VM Activity
Field
Description
Resource pool
Inventory path of the target resource pool for the virtual
machine. The information in this field is case-sensitive.
If the pool parameter is left unset, the virtual machine’s
current pool is used as the target pool.
Datastore
Inventory path to the storage device attached to the host
you want to use as main disk storage for the virtual
machine you are cloning.
The information in this field is case-sensitive.
Disk format
Select the appropriate format of the new virtual disk to be
cloned
•
Same format as source
•
Thin provisioned format
•
Thick format
Power on
Check this check box to power on the cloned virtual
machine after it has been created
Create template
Check this check box to create a virtual machine template
from which other virtual machines can be cloned
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Clone VM activity instance, see Viewing VM Instance
Information, page 5-14.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-15
Chapter 6
VMware Configuration Management Activities
Defining the Create Folder Activity
Defining the Create Folder Activity
Use the Create Folder activity to create a new folder within the VMware infrastructure inventory so that
objects can be created or moved into the new folder.
To define the Create Folder activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Create Folder activity, then drag and drop the
activity onto the Workflow pane.
The Create Folder property pages display.
Figure 6-7
Step 2
Create Folder Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
6-16
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Create Folder Activity
Step 3
Note
Click the Create Folder tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-8
Note
Step 4
Create Folder Properties Page—Folder Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Folder tab, specify the following properties to use to create a new folder:
Field
Description
Parent folder
Inventory path to the parent folder in the VMware
infrastructure. The information in this field is
case-sensitive.
Example:
(Ex. TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02)
New folder name
Enter the name of the new folder to be created on the virtual
machine.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-17
Chapter 6
VMware Configuration Management Activities
Defining the Create Folder Activity
Field
Folder Type
Step 5
Description
•
From the drop-down list, select the appropriate type of
folder.
•
Hosts and Clusters—Identifies a folder containing
clusters and hosts
•
Virtual Machines and Templates—Identifies a virtual
machine folder. A virtual machine folder may contain
child virtual machine folders. It also can contain
VirtualMachine managed objects, templates, and
VirtualApp managed objects
•
Datastores—Identifies a datastore folder. Datastore
folders can contain child datastore folders and
Datastore managed objects. A collection of references
to the subset of datastore objects in the datacenter that
is used by this virtual machine
•
Networking—Identifies a network entity folder.
Network entity folders can contain Network,
DistributedVirtualSwitch, and DistributedVirtualPort
managed objects.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
6-18
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Create New VM Activity
Defining the Create New VM Activity
Use the Create New VM activity to create a new virtual machine on a specified Virtual Center server or
ESX host.
To define the Create New VM activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Create New VM activity, then drag and drop
the activity onto the Workflow pane.
The Create New VM property pages display.
Figure 6-9
Step 2
Step 3
Note
Create New VM Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Settings tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-19
Chapter 6
VMware Configuration Management Activities
Defining the Create New VM Activity
Figure 6-10
Note
Step 4
Create New VM Properties Page—Settings Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Settings tab, specify the following properties to use to create a new VM:
Field
Description
Virtual machine
Inventory path to the virtual machine. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Inventory location
Inventory file path to the virtual machine folder
Host
Inventory path of the target server for the new virtual
machine. The information in this field is case-sensitive.
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Resource pool
Inventory path of the target resource pool for the virtual
machine. The information in this field is case-sensitive.
If the default resource pool for the server is used, the virtual
machine’s current pool is used as the target pool.
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Datastore
Inventory path to the storage location for the virtual
machine files, such as a physical disk, a RAID, or a SAN.
Cisco TEO Adapter Guide for VMware
6-20
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Customize Linux VM Activity
Field
Description
Guest operating system
From the drop-down list, select the appropriate operating
system which the virtual machine will run.
Virtual disk size (GB)
Disk space allocated for the virtual disk
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Customize Linux VM Activity
Use the Customize Linux VM activity to customize the Linux operation system of a specified virtual
machine.
Note
The Customize Linux VM activity has several activity-specific tabs included with the default TEO
activity configuration tabs. Please ensure that all tabs are configured properly before attempting to
execute the process.
To define the Customize Linux VM activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Customize Linux VM activity, then drag and
drop the activity onto the Workflow pane.
The Customize Linux VM property pages display.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-21
Chapter 6
VMware Configuration Management Activities
Defining the Customize Linux VM Activity
Figure 6-11
Step 2
Step 3
Note
Customize Linux VM Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Computer Name tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
6-22
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Customize Linux VM Activity
Figure 6-12
Note
Step 4
Customize Linux VM Properties Page—Computer Name Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Computer Name tab, specify the following properties:
Field
Description
Virtual machine
Inventory path to the virtual machine. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Computer name
Name of the Linux computer
Domain
Fully-qualified domain name for Linux computer
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-23
Chapter 6
VMware Configuration Management Activities
Defining the Customize Linux VM Activity
Step 5
Click the Network tab to continue.
Figure 6-13
Step 6
Step 7
Customize Linux VM Properties Page—Network Tab
On the Network tab, specify the type of network settings to apply to the guest operating system:
Option
Description
Typical settings
Select this radio button to allow the vCenter Server to
configure all network interfaces from a DHCP server.
Customize settings
Select this radio button to enable the manual configuration
of network interface settings.
To modify the custom network settings, click the appropriate button:
Button
Description
New
Click this button to launch the IP Address dialog box to
configure the settings for the appropriate network.
See Configuring IP Address Settings, page 6-76.
Modify
Highlight the appropriate network setting and click this
button to modify the configuration.
Delete
Highlight the appropriate network setting and click this
button to remove the setting from the list.
The following columns display the configured network settings.
Option
Description
Network Adapter
Name of the VM Network Adapter
IP Address
IP address of the network adapter
Cisco TEO Adapter Guide for VMware
6-24
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Customize Linux VM Activity
Step 8
Click the DNS and Domain tab to continue.
Figure 6-14
Step 9
Customize Linux VM Properties Page—DNS and Domain Tab
On the DNS and Domain tab, configure the domain name server properties for the specified Linux virtual
machine:
Field
Description
Primary DNS
Enter the primary name server computer for where the
record of the domain name is stored
Secondary DNS
Enter the name server computer that will be used if the
primary DNS server is not available.
Tertiary DNS
Enter the name server to manage the DNS independently
from the domain registrar.
DNS search path
Enter the domain name(s) to try when trying to translate a
machine name into an IP address.
Click Add after each domain name to add to the list in the
Domain Name column.
Step 10
To modify the list of domain names to search and the order in which they are searched, click the
appropriate buttons:
Button
Description
Add
After a new domain is entered in the DNS search path, click
Add to add the domain to the search list.
Remove
Highlight the appropriate domain and click this button to
remove the domain from the list.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-25
Chapter 6
VMware Configuration Management Activities
Defining the Customize Linux VM Activity
Step 11
Note
Button
Description
Move Up
Highlight the appropriate domain and click this button to
move the domain name up the list.
Move Down
Highlight the appropriate domain and click the button to
move the domain down the list.
Click the Time Zone tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-15
Step 12
Customize Linux VM Properties Page—Time Zone Tab
On the Time Zone tab, configure the time zone for the network for the specified Linux virtual machine:
Field
Description
Select Area/Location
From the drop-down list, select the appropriate time zone
location for the network.
Area/Location
Enter the appropriate time zone to be used (Example:
Continent/Country)
Hardware clock set to
From the drop-down list, select the appropriate time
standard on which the computer clock is set.
UTC—Coordinated universal time
Local—Current local time
Cisco TEO Adapter Guide for VMware
6-26
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Customize Windows VM Activity
Step 13
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Customize Windows VM Activity
Use the Customize Windows VM activity to customize a Windows operating system of a specified
virtual machine.
According to VMware's KB 1005593 article, Sysprep file locations and versions, users must install
Microsoft Sysprep files on the vCenter server before customizing certain versions of Windows.
Note
The Customize Windows VM activity has several activity-specific tabs included with the default TEO
activity configuration tabs. Please ensure that all tabs are configured properly before attempting to
execute the process.
To define the Customize Windows VM activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Customize Windows VM activity, then drag
and drop the activity onto the Workflow pane.
The Customize Windows VM property pages display.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-27
Chapter 6
VMware Configuration Management Activities
Defining the Customize Windows VM Activity
Figure 6-16
Step 2
Step 3
Note
Customize Windows VM Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Computer Name tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
6-28
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Customize Windows VM Activity
Figure 6-17
Note
Step 4
Customize Windows VM Properties Page—Computer Name Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Computer Name tab, specify the following properties:
Field
Description
Virtual machine
Inventory path to the virtual machine. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Computer name
Full computer name
Registration Information
Name
Name of the owner to whom this OS should be registered
Organization
Organization to which this OS should be registered
Administration Password
Password
Enter the new password that VMware will use to set the
administrator's password.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-29
Chapter 6
VMware Configuration Management Activities
Defining the Customize Windows VM Activity
Field
Description
Automatically log on as the
administrator
Check this check box to automatically log into the
computer as an administrator and in the text box, enter the
number of times the system to attempt to log on.
Time Zone
Time zone
From the drop-down list, select the appropriate time zone
for the Windows computer.
Time zone name
Enter the name of the time zone.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the Domain tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-18
Step 6
Click the time unit link to change the time interval.
Customize Windows VM Properties Page—Domain Tab
On the Domain tab, configure the computer name credentials to be used for access to the Windows
domain.
Cisco TEO Adapter Guide for VMware
6-30
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Customize Windows VM Activity
For security reasons, users may want choose a runtime user with the appropriate credentials rather than
entering a password. specify the following properties:
Field
Description
Add computer to a workgroup
Select this radio button and in the text field, enter the
workgroup name.
Add computer to a windows domain Select this radio button and in the text field, enter the full
domain name. Select the appropriate radio button to
determine the credentials for the user account used to join
computer to the domain.
Use credentials of the following
runtime user
•
User name—Enter the user name to access the
Windows domain
•
Password—Enter the password to access the Windows
domain
Select the appropriate runtime user account. Select the
default runtime user from the drop-down list.
Note
Step 7
To view the properties for the selected runtime
user, click the Properties
tool. To create a new
runtime user account, click New > Runtime User
to create a new Runtime User account. For
additional information, see Chapter 3, “Managing
Runtime Users.”
Click the License tab to continue.
Figure 6-19
Customize Windows VM Properties Page—License Tab
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-31
Chapter 6
VMware Configuration Management Activities
Defining the Customize Windows VM Activity
Step 8
On the License tab, enter the product key and pertinent licensing information for the Windows operating
system for the specified virtual machine:
Field
Description
Product key
Enter the product key for the Windows operating system.
Include Server License Information Check this check box to indicate server information is
(Required for customizing a server required and to enable the server license mode fields and
guest OS)
select the appropriate license mode.
Server License Mode
Select the appropriate software license mode for the
Windows server.
•
Per seat—Software license mode based on the number
of individual users who have access to the software
•
Per server—Software license mode based on the
number of connections using the Windows server
When choosing Per server, enter the number of
maximum number of connections allowed to the
Windows server in the Maximum Connections field.
Step 9
Click the Run Once tab to continue.
Figure 6-20
Step 10
Customize Windows VM Properties Page—Run Once Tab
On the Run Once tab, enter the the commands to run in the specified virtual machine at the end of the
customization process:
Field
Description
Command
Enter the commands to run in the specified virtual machine.
Cisco TEO Adapter Guide for VMware
6-32
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Customize Windows VM Activity
Step 11
Step 12
To modify the list of commands to run, click the appropriate button:
Button
Description
Add
After a new command is entered in the text field, click Add
to add the command to the list.
Remove
Highlight the appropriate command and click this button to
remove the command from the list.
Up
Highlight the appropriate command and click this button to
move the command up the list
Down
Highlight the appropriate command and click the button to
move the command down the list.
Click the Network tab to continue.
Figure 6-21
Step 13
Customize Windows VM Properties Page—Network Tab
On the Network tab, specify the type of network settings to apply to the guest operating system:
Option
Description
Typical settings
Select this radio button to allow the vCenter Server to
configure all network interfaces from a DHCP server.
Customize settings
Select this radio button to enable the manual configuration
of network interface settings.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-33
Chapter 6
VMware Configuration Management Activities
Defining the Customize Windows VM Activity
Step 14
To modify the custom network settings, click the appropriate button:
Button
Description
New
Click this button to launch the IP Address dialog box to
configure the settings for the appropriate network.
See Configuring Network Properties, page 6-77.
Modify
Highlight the appropriate network setting and click this
button to modify the configuration.
Delete
Highlight the appropriate network setting and click this
button to remove the setting from the list.
The following columns display the configured network settings.
Step 15
Option
Description
Network Adapter
Name of the VM Network Adapter
IP Address
IP address of the network adapter
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
6-34
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Delete VM Activity
Defining the Delete VM Activity
Use the Delete VM activity to remove a virtual machine from the inventory or delete a virtual machine
and the corresponding VM file from disk on a specified virtual machine or ESX host.
To define the Delete VM activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Delete VM activity, then drag and drop the
activity onto the Workflow pane.
The Delete VM property pages display.
Figure 6-22
Step 2
Delete VM Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-35
Chapter 6
VMware Configuration Management Activities
Defining the Delete VM Activity
Step 3
Note
Click the Delete VM tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-23
Note
Step 4
Delete VM Properties Page—Delete VM Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Delete VM tab, specify the following properties:
Field
Description
Virtual machine
Inventory path to the virtual machine. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Remove from inventory (VM can be Select the radio button to remove the VM from the virtual
restored)
disk.
This option removes VM from the inventory, but leaves all
files and snapshots and allows the VM to be restored.
Cisco TEO Adapter Guide for VMware
6-36
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Delete VM Activity
Field
Description
Permanently delete all VM files
(including snapshot)
Select the radio button delete all VM files from the virtual
disk.
This option deletes all VM files including any snapshots,
and virtual machine cannot be restored.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-37
Chapter 6
VMware Configuration Management Activities
Defining the Enumerate Datastores Activity
Defining the Enumerate Datastores Activity
Use the Enumerate Datastores activity to retrieve all datastores configured within the specified VMware
infrastructure.
To define the Enumerate Datastores activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Enumerate Datastores activity, then drag and
drop the activity onto the Workflow pane.
The Enumerate Datastores property pages display.
Figure 6-24
Step 2
Enumerate Datastores Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
6-38
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Enumerate Datastores Activity
Step 3
Note
Click the Datacenter tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-25
Note
Step 4
Enumerate Datastores Properties Page—Datacenter Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Datacenter tab, specify the following properties:
Field
Description
Datacenter
Inventory path to the datacenter name containing the
datastores. The information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Note
Time out if not completed within
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-39
Chapter 6
VMware Configuration Management Activities
Defining the Enumerate Networks Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the Enumerate Datastores activity, see Viewing Enumerate Datastores Activity
Results, page 6-78.
Defining the Enumerate Networks Activity
Use the Enumerate Networks activity to retrieve all networks configured within the specified VMware
infrastructure.
To define the Enumerate Networks activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Enumerate Networks activity, then drag and
drop the activity onto the Workflow pane.
The Enumerate Networks property pages display.
Figure 6-26
Enumerate Networks Activity Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
6-40
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Enumerate Networks Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Datacenter tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-27
Note
Step 4
Enumerate Networks Properties Page—Datacenter Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Datacenter tab, specify the following properties:
Field
Description
Datacenter
Inventory path to the datacenter name containing the
networks. The information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Note
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-41
Chapter 6
VMware Configuration Management Activities
Defining the Enumerate Networks Activity
Field
Description
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the Enumerate Networks activity, see Viewing Enumerate Networks Activity
Results, page 6-79.
Cisco TEO Adapter Guide for VMware
6-42
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Enumerate Resource Pools Activity
Defining the Enumerate Resource Pools Activity
Use the Enumerate Resource Pools activity to retrieve all resource pools configured within the VMware
infrastructure.
To define the Enumerate Resource Pools activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Enumerate Resource Pools activity, then drag
and drop the activity onto the Workflow pane.
The Enumerate Resource Pools property pages display.
Figure 6-28
Step 2
Enumerate Resource Pools Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-43
Chapter 6
VMware Configuration Management Activities
Defining the Enumerate Resource Pools Activity
Step 3
Note
Click the Datacenter tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-29
Note
Step 4
Enumerate Resource Pools Properties Page—Datacenter Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Datacenter tab, specify the following properties:
Field
Description
Datacenter
Inventory path of the datacenter containing resource pool
for the virtual machine. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Note
Time out if not completed within
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
6-44
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Migrate VM Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the Enumerate Datastores activity, see Viewing Enumerate Resource Pools
Activity Results, page 6-80.
Defining the Migrate VM Activity
Use the Migrate VM activity to migrate a specified virtual machine from one server to a specific resource
pool or host.
To define the Migrate VM activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Migrate VM activity, then drag and drop the
activity onto the Workflow pane.
The Migrate VM property pages display.
Figure 6-30
Migrate VM Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-45
Chapter 6
VMware Configuration Management Activities
Defining the Migrate VM Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Migrate tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-31
Note
Step 4
Migrate VM Properties Page—Migrate Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Migrate tab, specify the following properties to use to migrate the virtual machine:
Field
Description
Virtual machine
Inventory path to the virtual machine targeted for
migration. The information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
6-46
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Migrate VM Activity
Field
Description
Target host
Inventory path to the host server to migrate the virtual
machine. The information in this field is case-sensitive.
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Target resource pool
Inventory path of the target resource pool for the virtual
machine. The information in this field is case-sensitive.
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Priority
Power State
Time out if not completed within
Select a priority for the migration to ensure that sufficient
CPU resources are available on both the source and target
hosts to perform the migration:
•
Default—Default priority for the operations
•
High—Reserve resources on both the source and
destination hosts to maintain virtual machine
availability during the migration. High priority
operations will not proceed if the resources are
unavailable.
•
Low—Low priority operations will always proceed,
but the virtual machine may become briefly
unavailable if sufficient host resources are unavailable.
Select the radio button to migrate the virtual machine only
if matches the specified power state:
•
Powered On—Virtual machine and the guest operating
system that automatically starts up on system boot is
Powers up.
•
Powered Off—Virtual machine is Powered down
•
Suspended—All activities on the virtual machine are
paused
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-47
Chapter 6
VMware Configuration Management Activities
Defining the Query VM Devices Activity
•
Note
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Migrate VM activity instance, see Viewing VM Instance
Information, page 5-14
Defining the Query VM Devices Activity
Use the Query VM devices activity to query the list of virtual machine devices on a given virtual
machine.
To define the Query VM Devices activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Query VM Devices activity, then drag and drop
the activity onto the Workflow pane.
The Query VM Devices property pages display.
Figure 6-32
Step 2
Step 3
Query VM Devices Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Virtual Machine tab to continue.
Cisco TEO Adapter Guide for VMware
6-48
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Query VM Devices Activity
Note
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-33
Note
Step 4
Query VM Devices Properties Page—Virtual Machine Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Virtual Machine tab, specify the following properties:
Field
Description
Virtual machine
Inventory path to the virtual machine. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-49
Chapter 6
VMware Configuration Management Activities
Defining the Query VM Network Adapters Activity
Note
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the Query VM Devices activity, see Viewing Query VM Devices Activity Results,
page 6-83.
Defining the Query VM Network Adapters Activity
Use the Query VM Network Adapters activity to query information about network adapters configured
for a specified virtual machine.
To define the Query VM Network Adapters activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Query VM Network Adapters activity, then
drag and drop the activity onto the Workflow pane.
The Query VM Network Adapters property pages display.
Figure 6-34
Step 2
Query VM Network Adapters Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
6-50
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Query VM Network Adapters Activity
Step 3
Note
Click the Query Virtual Machine Network Adapters tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-35
Note
Step 4
Query VM Network Adapters Properties Page—Query Virtual Machine Network
Adapters Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Query Virtual Machine Network Adapters tab, specify the virtual machine to be queried:
Field
Description
Virtual machine
Inventory path to the virtual machine to query for network
adapters. The information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects
dialog box to query the appropriate managed object on a
specified target. See Selecting a Managed Object,
page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-51
Chapter 6
VMware Configuration Management Activities
Defining the Query VM Properties Activity
Note
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the Query VM Network Adapter Properties activity instance, see Viewing Query
VM Network Adapters Activity Results, page 6-84.
Defining the Query VM Properties Activity
Use the Query VM Properties activity to query the properties of a specified virtual machine.
To define the Query VM Properties activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Query VM Properties activity, then drag and
drop the activity onto the Workflow pane.
The Query VM Properties property pages display.
Figure 6-36
Step 2
Step 3
Note
Query VM Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Virtual Machine tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
6-52
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Query VM Properties Activity
Figure 6-37
Note
Step 4
Query VM Properties Page—Virtual Machine Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Virtual Machine tab, specify the virtual machine to be queried:
Field
Description
Virtual machine
Inventory path to the virtual machine to be queried. The
information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-53
Chapter 6
VMware Configuration Management Activities
Defining the Query VMs Activity
•
Note
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Query VM Properties activity instance, see Viewing VM
Instance Information, page 5-14
Defining the Query VMs Activity
Use the Query VMs activity to query the list of virtual machines on a given ESX server or Virtual Center
server.
To define the Query VMs activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Query VMs activity, then drag and drop the
activity onto the Workflow pane.
The Query VMs property pages display.
Figure 6-38
Step 2
Step 3
Query VMs Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Virtual Machines tab to continue.
Cisco TEO Adapter Guide for VMware
6-54
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Query VMs Activity
Note
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-39
Note
Step 4
Query VMs Page—Virtual Machines Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Virtual Machines tab, specify the virtual machine to be queried:
Field
Description
Virtual Machine
Name of the virtual machine to be queried
Note
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Host
Name of the ESX host server to be queried
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Filter by
Click the time unit link to change the time interval.
From the drop-down list, select the appropriate option to
filter the list of virtual machines returned by the query.
•
Virtual machines and templates—Retrieves both
virtual machines and templates
•
Virtual machines only—Retrieves virtual machines
only
•
Templates only—Retrieves templates only
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-55
Chapter 6
VMware Configuration Management Activities
Defining the Reconfigure VM Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the Query VMs activity, see Viewing Query VMs Activity Results, page 6-82.
Defining the Reconfigure VM Activity
Use the Reconfigure VM activity to modify the memory and number of CPUs allocated to the virtual
machine on a given ESX server or Virtual Center server.
To define the Reconfigure VM activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Reconfigure VM activity, then drag and drop
the activity onto the Workflow pane.
The Reconfigure VM property pages display.
Figure 6-40
Step 2
Reconfigure VM Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Cisco TEO Adapter Guide for VMware
6-56
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Reconfigure VM Activity
Step 3
Note
Field
Description
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Reconfigure tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-41
Note
Reconfigure VM Properties Page—Reconfigure Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-57
Chapter 6
VMware Configuration Management Activities
Defining the Reconfigure VM Activity
Step 4
On the Reconfigure VM tab, specify the properties to modify the virtual machine configuration:
Field
Description
Virtual machine
Inventory path to the virtual machine to be reconfigured.
The information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Memory (MB)
Size of the memory should be integer multiple of 4,
otherwise the activity will fail.
This field can remain blank if activity should leave the
memory size unchanged.
Number of CPUs
Number of virtual processors to allocate to the virtual
machine.
This field can remain blank if CPU count does need to be
changed.
Config File (.vmx)
File path to the configuration file for the virtual machine
(.vmx file). This also implicitly defines the configuration
directory
Notes
Enter any relevant information that describes the activity.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Reconfigure VM activity instance, see Viewing VM Instance
Information, page 5-14.
Cisco TEO Adapter Guide for VMware
6-58
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Relocate VM Activity
Defining the Relocate VM Activity
Use the Relocate VM activity to relocate a specified virtual machine from one server to another server.
To define the Relocate VM activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Relocate VM activity, then drag and drop the
activity onto the Workflow pane.
The Relocate VM property pages display.
Figure 6-42
Step 2
Step 3
Note
Relocate VM Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Relocate VM tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-59
Chapter 6
VMware Configuration Management Activities
Defining the Relocate VM Activity
Figure 6-43
Note
Step 4
Relocate VM Properties Page—Relocate VM Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Relocate VM tab, specify the properties to on where to relocate the virtual machine:
Field
Description
Virtual machine
Inventory path to the virtual machine to be relocated. The
information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Host
Inventory path to the target server where the virtual
machine is to be relocated. The information in this field is
case-sensitive.
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Resource pool
Inventory path of the target resource pool for the virtual
machine. The information in this field is case-sensitive.
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
6-60
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Relocate VM Activity
Field
Description
Datastore
Inventory path to the storage device attached to the host to
be used as the main disk storage for the virtual machine you
are relocating.
The information in this field is case-sensitive.
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Relocate VM activity instance, see Viewing VM Instance
Information, page 5-14.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-61
Chapter 6
VMware Configuration Management Activities
Defining the Remove VM Device Activity
Defining the Remove VM Device Activity
Use the Remove VM Device activity to remove a virtual device from a specified Virtual Center server.
To define the Remove VM Device activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Remove VM Device activity, then drag and
drop the activity onto the Workflow pane.
The Remove VM Device property pages display.
Figure 6-44
Step 2
Remove VM Device Activity Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
6-62
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Remove VM Device Activity
Step 3
Note
Click the Remove Device tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-45
Note
Step 4
Remove VM Device Properties Page—Remove Device Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Remove Device tab, specify the following properties:
Field
Description
Virtual machine
Inventory path to the virtual machine. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Device name
Enter the device name to be removed from the virtual
machine. (Ex. Hard diskk 22)
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-63
Chapter 6
VMware Configuration Management Activities
Defining the Update VM Hard Disk
Step 5
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Update VM Hard Disk
Use the Update VM Hard Disk activity to update configuration of a specified hard disk on a specified
virtual machine.
To define the Update VM Hard Disk activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Update VM Hard Disk activity, then drag and
drop the activity onto the Workflow pane.
The Update VM Hard Disk property pages display.
Figure 6-46
Step 2
Update VM Hard Disk Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
6-64
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Update VM Hard Disk
Step 3
Note
Click the Hard Disk Settings tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-47
Note
Step 4
Update VM Hard Disk Properties Page—Hard Disk Settings Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Hard Disk Settings tab, specify the hard disk properties to update:
Field
Description
Virtual machine
Inventory path to the virtual machine of the hard disk that
should be updated. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Hard disk name
Enter the name of the hard disk to be updated.
Provisioned size
Enter the size of the new virtual disk. From the Unit
drop-down list, select the appropriate unit size for the disk.
Virtual device node
•
MB—Megabyte (1024 KB)
•
GB—Gigabyte (1024 MB)
•
TB—Terabyte (1024 GB)
Enter the device node of the cluster.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-65
Chapter 6
VMware Configuration Management Activities
Defining the Update VM Hard Disk
Field
Description
Mode
From the drop-down list, select the appropriate mode for
the property of a virtual disk.
Time out if not completed within
•
do not change current settings—Indicates that the
current settings of the hard disk are not changed
•
append—Changes are stored in a temporary .REDO
file. If a system administrator deletes the redo-log file,
the virtual machine returns to the state it was in the last
time it was used in persistent mode.
•
independent_nonpersistent—The disk appears to
operate normally, but whenever the virtual machine is
powered off or reverted to a snapshot, the contents of
the disk return to their original state. All later changes
are discarded.
•
independent_persistent—The disk operates normally
except that changes to the disk are permanent even if
the virtual machine is reverted to a snapshot.
•
nonpersistent—All disk writes issued by software
running inside a virtual machine appear to be written
to the independent disk. In fact, they are discarded
after the virtual machine is powered off. As a result, a
virtual disk or physical disk in
independent-nonpersistent mode is not modified by
activity in the virtual machine.
•
persistent—All disk writes issued by software running
inside a virtual machine are immediately and
permanently written to a virtual disk that is configured
as an independent disk.
•
undoable—The file that stores changes made to a disk
in all modes except the persistent and
independent-persistent modes. For a disk in
nonpersistent mode, the redo-log file is deleted when
you power off or reset the virtual machine without
writing any changes to the disk. You can permanently
apply the changes saved in the redo-log file to a disk in
undoable mode so that they become part of the main
disk files.
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
6-66
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Update VM Network Adapter
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Update VM Network Adapter
Use the Update VM Network Adapter activity to modify the configuration of a specified network adapter
on a specified virtual machine.
To define the Update VM Network Adapter activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Update VM Network Adapter activity, then
drag and drop the activity onto the Workflow pane.
The Update VM Network Adapter property pages display.
Figure 6-48
Step 2
Update VM Network Adapter Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-67
Chapter 6
VMware Configuration Management Activities
Defining the Update VM Network Adapter
Step 3
Note
Click the Network Adapter Settings tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-49
Note
Step 4
Update VM Network Adapter Properties Page—Network Adapter Settings Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Network Adapter Settings tab, specify the network adapter properties to update:
Field
Description
Virtual machine
Inventory path to the virtual machine containing network
adapter to be updated. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Name
Display name of the network adapter
Connected
Select the option to determine whether to modify
connection state of the network adapter.
•
DoNotChange
•
Yes
•
No
Cisco TEO Adapter Guide for VMware
6-68
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Update VM Network Adapter
Field
Description
Connect on Power On
Select the appropriate option to indicate whether the host
should be connected when it was Powered On.
MAC Address Type
•
DoNotChange
•
Yes
•
No
Select the appropriate option to indicate how the MAC
Address was assigned to the network adapter.
•
DoNotChange
•
Manual
•
Automatic
MAC Address
Modify the MAC Address assigned to the network adapter
in the virtual machine.
Network
Modify the name or IP address of the virtual network in the
VMware environment.
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-69
Chapter 6
VMware Configuration Management Activities
Defining the Upgrade VM Hardware Activity
Defining the Upgrade VM Hardware Activity
Use the Upgrade VM Hardware activity to upgrade the virtual machine’s virtual hardware to the latest
revision that is supported by the virtual machine’s current host.
To define the Upgrade VM Hardware activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Upgrade VM Hardware activity, then drag
and drop the activity onto the Workflow pane.
The Upgrade VM Hardware property pages display.
Figure 6-50
Step 2
Upgrade VM Hardware Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
6-70
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Upgrade VM Hardware Activity
Step 3
Note
Click the Virtual Hardware tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-51
Note
Step 4
Upgrade VM Hardware Properties Page—Virtual Hardware Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Virtual Hardware tab, specify the properties to use to upgrade the virtual machine hardware:
Field
Description
Virtual machine
Inventory path to the virtual machine containing the
hardware to be upgraded. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-71
Chapter 6
VMware Configuration Management Activities
Defining the Upgrade VM Tools
Field
Description
Version
Enter the appropriate version to specify which version to
upgrade the virtual hardware. (Ex: vmx-04 or vmx-07)
The versions supported will depend on the VMware
infrastructure.
Note
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Note
If the version is not specified, the virtual hardware
is upgraded to the most current virtual hardware
supported on the host.
Click the time unit link to change the time interval.
To view information for the Upgrade VM Hardware activity instance, see Viewing VM Instance
Information, page 5-14
Defining the Upgrade VM Tools
Use the Upgrade VM Tools activity to install or upgrade the VMware tools on a Windows virtual
machine using the VMware Tools installer.
To define the Upgrade VM Tools activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Upgrade VM Tools activity, then drag and drop
the activity onto the Workflow pane.
The Upgrade VM Tools property pages display.
Figure 6-52
Upgrade VM Tools Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
6-72
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Upgrade VM Tools
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Upgrade Tools tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 6-53
Note
Step 4
Upgrade VM Tools Properties Page—Upgrade Tools Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Upgrade Tools tab, specify the virtual machine using VMware Tools:
Field
Description
Virtual machine
Inventory path to the virtual machine on which to install or
upgrade the VMware tools. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-73
Chapter 6
VMware Configuration Management Activities
Defining the Upgrade VM Tools
Field
Description
Options
Enter the command line options to pass to the installer to
modify the installation procedure for tools.
Example:
Basic command line syntax
vmrun <host authentication flags> <guest
authentication flags> <command> <parameters>
Note
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
For additional information on the commands, see
VMware Command Line Options, page 6-74.
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Upgrade VM Tools activity instance, see Viewing VM
Instance Information, page 5-14.
VMware Command Line Options
The Upgrade VM Tools activity has an Options field that allows command lines to be used for advanced
installation options. Use the following options to specify the parameters in a command line.
Command Option
Description
-u user
Specifies a user with sufficient privileges on the target
virtual machine, including VirtualMachine.Config.*,
VirtualMachine.Interact.*, and
VirtualMachine.Provisioning.*
-p password
Specifies a password on the command line. If this is
omitted, the tool immediately prompts for a password.
Cisco TEO Adapter Guide for VMware
6-74
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Defining the Upgrade VM Tools
Command Option
Description
-n vmname
The name of the virtual machine to upgrade. This name
corresponds to the display name of a virtual machine.
Specify multiple virtual machines using multiple -n
parameters. The -n option is ignored if -h is specified
-h host
Attempts to upgrade all the virtual machines on a particular
host. Fails if the specified host if not version ESX 3.0 or
greater.
-m maxpowerons
On a particular host, power-on only this number of virtual
machines at a time
-o port
Specifies the Virtual Center Server port, if one other than
the default port 902 has been configured
-t maxpowerontime
After the tools upgrade is scheduled on a virtual machine,
the virtual machine is powered on and allowed to run
through the tools installation process. In most cases, the
guest powers off the machine when the process completes.
This parameter allows a user to set the maximum amount
of time for a virtual machine to be powered on in case the
guest is unable to shut down the machine itself.
-s
Skips the tools and does only the virtual hardware upgrade.
-q
Works quietly. Doesn’t produce status or completion
messages on shutdown.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-75
Chapter 6
VMware Configuration Management Activities
Managing VMware Configuration Activity Definitions
Managing VMware Configuration Activity Definitions
The information in this section provide instructions on modifying the activity properties. Use the activity
property page to perform the following functions.
Configuring IP Address Settings
Use IP Address dialog box to configure the IP address settings for the network.
To configure IP address settings for a new activity:
Step 1
On the Network tab, click New.
The IP Address dialog box displays.
Figure 6-54
Step 2
IP Address Dialog Box
Select the appropriate radio button and enter the required information in the text fields.
Option
Description
Use DHCP to obtain an IP address
automatically
Select this radio to use the DHCP server to obtain the IP
address for the computer.
Use an application configured on
vCenter to generate the IP address
Select this radio and then in the text field and enter the
argument to the application which can generate the IP
address automatically.
Cisco TEO Adapter Guide for VMware
6-76
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Managing VMware Configuration Activity Definitions
Option
Description
Use the following IP setting
Select this radio button and then enter the appropriate
information in the following text fields:
•
IP Address—IP address assigned to the network
•
Subnet mask—The numeric mask used to determine
the subnet an IP address belongs to on the network
•
Default gateway—Gateway in the network that a
computer will use to access another network if a
gateway is not specified for use
•
Alternate gateway—Alternate gateway in the network
that a computer will use to access another network if
the default gateway is not available
Configuring Network Properties
Use Network Properties dialog box to configure the IP address and DNS Server settings for the network.
To configure network properties:
Step 1
On the Network tab, click New.
The Network Properties dialog box displays.
Figure 6-55
Step 2
Network Properties Dialog Box
Select the appropriate radio button and enter the required information in the text fields.
Option
Description
IP Address
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-77
Chapter 6
VMware Configuration Management Activities
Viewing VMware Configuration Activity Results
Option
Description
Use DHCP to obtain an IP address
automatically
Select this radio to use the DHCP server to obtain the IP
address for the computer.
Use the following IP setting
Select this radio button and then enter the appropriate
information in the following text fields:
•
IP Address—IP address assigned to the network
•
Subnet mask—The numeric mask used to determine
the subnet an IP address belongs to on the network
•
Default gateway—Gateway in the network that a
computer will use to access another network if a
gateway is not specified for use
•
Alternate gateway—Alternate gateway in the network
that a computer will use to access another network if
the default gateway is not available
DNS Server
Use DHCP to obtain DNS address
automatically
Select this radio to use DHCP to obtain the IP address for
the queried VM network.
Use the following DNS server
address
Select this radio button and then enter the appropriate
information in the following text fields:
•
Preferred DNS server—Preferred IP address of a DNS
server
•
Alternate DNS server—Alternate IP address of a DNS
server that is used when the preferred IP address is not
available
Viewing VMware Configuration Activity Results
This section describes what the user should expect to see after a process with a VMware configuration
activity is launched.
Viewing Enumerate Datastores Activity Results
When the Enumerate Datastores activity is launched, the results of the activity are displayed from the
Operations Workspace activity instance view.
To view the Enumerate Datastores activity results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Enumerate Datastores activity instance, right-click and choose Properties.
The Enumerate Datastores Properties dialog box displays.
Cisco TEO Adapter Guide for VMware
6-78
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Viewing VMware Configuration Activity Results
Step 3
Click the Datastores display-only tab to view the datastores configured within the VMware
infrastructure and related information.
Figure 6-56
Enumerate Datastores Activity Instance Properties Page—Datastores Tab
The following information is displayed:
Column
Description
Name
The name of the datastore
Location
The unique locator for the datastore
Hosts Connected
Number of hosts attached to the datastore
VMs Connected
Number of virtual machines stored on the datastore
Capacity(GB)
Maximum capacity of the datastore, in gigabytes
Provisioned space (GB)
Provisioned space of the datastore, in gigabytes
Free space (GB)
Available space of the datastore, in gigabytes
Viewing Enumerate Networks Activity Results
When the Enumerate Networks activity is launched, the results of the activity are displayed from the
Operations Workspace activity instance view.
To view the Enumerate Networks activity results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Enumerate Networks activity instance, right-click and choose Properties.
The Enumerate Networks Properties dialog box displays.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-79
Chapter 6
VMware Configuration Management Activities
Viewing VMware Configuration Activity Results
Step 3
Click the Networks display-only tab to view all networks configured within the VMware infrastructure.
Figure 6-57
Enumerate Networks Activity Instance Properties Page—Networks Tab
The following information is displayed:
Column
Description
Name
The name of the network on the specified datacenter
Viewing Enumerate Resource Pools Activity Results
When the Enumerate Resource Pools activity is launched, the results of the activity are displayed from
the Operations Workspace activity instance view.
To view the Enumerate Resource Pools activity results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Enumerate Resource Pools activity instance, right-click and choose Properties.
The Enumerate Resource Pools Properties dialog box displays.
Cisco TEO Adapter Guide for VMware
6-80
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Viewing VMware Configuration Activity Results
Step 3
Click the Resource Pools display-only tab to view all resource pools configured within the VMware
infrastructure and related information.
Figure 6-58
Enumerate Resource Pools Activity Instance Properties Page—Resource Pools Tab
The following information is displayed:
Column
Description
Name
Name of the resource pool
CPU Shares Level
The CPU allocation level for the resource pool
•
Custom
•
Low
•
Normal
•
High
CPU Shares
Resource allocation for CPU
CPU Reservation (Mhz)
Amount of CPU resources that are guaranteed available to
the resource pool (in Mhz)
CPU Expandable Reservation
The amount of resources the CPU reservation can expand
in a resource pool beyond the specified value if the
resource pool has unreserved resources
CPU Limit (Mhz)
Determines the limit on the CPU Mhz the resource pool
cannot exceed regardless of available of resources
Memory Shares Level
The memory allocation level for the resource pool
Memory Shares
•
Custom
•
Low
•
Normal
•
High
Resource allocation for memory
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-81
Chapter 6
VMware Configuration Management Activities
Viewing VMware Configuration Activity Results
Column
Description
Memory Reservation (MB)
Amount of memory that is guaranteed available to the
resource pool (in MB)
Memory Expandable Reservation
The amount of memory the reservation can expand in a
resource pool beyond the specified value if the resource
pool has unreserved resources
Memory Limit (MB)
Determines the limit on the amount of memory the resource
pool cannot exceed regardless of available of resources
Viewing Query VMs Activity Results
When the Query VMs activity is launched, the results of the Query VMs activity are displayed from the
Operations Workspace activity instance view.
To view the Query VMs results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Query VMs activity instance, right-click and choose Properties.
The Query VMs dialog box displays.
Step 3
Click the Virtual Machines display-only tab to view the virtual machines queried on a given ESX server
or Virtual Center server.
Figure 6-59
Query VMs Instance Properties Page—Virtual Machines Tab
Cisco TEO Adapter Guide for VMware
6-82
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Viewing VMware Configuration Activity Results
The following information is displayed:
Column
Description
Name
Inventory path of the virtual machine listed
State
The host power state
Host
•
Powered Off
•
Powered On
Inventory path of the host server where the VM is located
Viewing Query VM Devices Activity Results
When the Query VM Devices activity is launched, the results of the activity are displayed from the
Operations Workspace activity instance view.
To view the Query Virtual Machines results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Query VM Devices activity instance, right-click and choose Properties.
The Query VM Devices Properties dialog box displays.
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-83
Chapter 6
VMware Configuration Management Activities
Viewing VMware Configuration Activity Results
Step 3
Click the Devices display-only tab to view the list of devices configured on the virtual machine retrieved
by the query.
Figure 6-60
Query VM Devices Activity Instance Properties Page—Devices Tab
The following information is displayed:
Column
Description
Type
Type of device configured on the virtual machine
Name
Virtual device name
Summary
Basic information about the VM device
Viewing Query VM Network Adapters Activity Results
When the Query VM Network Adapters activity is launched, the results of the Query VM Network
Adapters activity are displayed from the Operations Workspace activity instance view.
To view the Query VM Network Adapters results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Query VM Network Adapters activity instance, right-click and choose Properties.
The Query VM Network Adapters Properties dialog box displays.
Cisco TEO Adapter Guide for VMware
6-84
OL-24933-02
Chapter 6
VMware Configuration Management Activities
Viewing VMware Configuration Activity Results
Step 3
Click the Network Adapters display-only tab to view the queried information retrieved about the virtual
machine network adapters.
Figure 6-61
Query VM Network Adapters Instance Properties Page—Network Adapters Tab
The following information is displayed:
Column
Description
Name
Display name of the network adapter
Summary
Name or IP address of the virtual network
Adapter Type
Type of adapter configured on the virtual network
•
Flexible—Supported on virtual machines that were
created on ESX Server 3.0 or greater and that run
32-bit guest operating systems.
•
E1000—Emulates the functioning of an E1000
network card. It is the default adapter type for virtual
machines that run 64-bit guest operating systems.
•
Enhanced vmxnet—An upgraded version of the
Vmxnet device with enhanced performance
•
vmxnet 3—Next generation Vmxnet device with
enhanced performance and enhanced networking
features
Connected
Indicates whether the virtual network is connected or
disconnected
Connect on Power On
Indicates whether the virtual network is connected when it
was started
MAC Address
MAC Address assigned to the network adapter in the
virtual machine
Cisco TEO Adapter Guide for VMware
OL-24933-02
6-85
Chapter 6
VMware Configuration Management Activities
Viewing VMware Configuration Activity Results
Column
Description
MAC Address Type
Indicates how the MAC Address was assigned to the
network adapter
•
Manual
•
Automatic
Network Label
Inventory path for the network assigned to the adapter
Network Port
Port of the virtual network in the VMware environment
Cisco TEO Adapter Guide for VMware
6-86
OL-24933-02
CH A P T E R
7
VMware Host Management Activities
Use the following activities to perform basic management of the host using a VI connection. This chapter
provides instructions for defining VMware host activities, instructions for completing the property pages
for each specific activity, and instructions on viewing the activity results.
•
VMware Host Activities, page 7-2
•
Defining the Add Host Activity, page 7-3
•
Defining the Add Host Port Group Activity, page 7-7
•
Defining the Enter VM Host Maintenance Mode Activity, page 7-9
•
Defining the Exit VM Host Maintenance Mode Activity, page 7-11
•
Defining the Power Down Host to Standby Activity, page 7-14
•
Defining the Power Up Host from Standby Activity, page 7-17
•
Defining the Query Host Network Adapters Activity, page 7-19
•
Defining the Query Host Properties Activity, page 7-21
•
Defining the Query Host Storage Adapters Activity, page 7-23
•
Defining the Query Hosts Activity, page 7-25
•
Defining the Reboot VM Host Activity, page 7-27
•
Defining the Remove ESX Server Activity, page 7-30
•
Defining the Shutdown Host Activity, page 7-32
•
Defining the Update Host Port Group Activity, page 7-35
•
Viewing VMware Host Activity Results, page 7-37
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-1
Chapter 7
VMware Host Management Activities
VMware Host Activities
VMware Host Activities
The following table displays the string activities provided by the VMware Adapter:
Activity
Description
Add Host
Adds a new ESX/ESXi to a VMware environment
See Defining the Add Host Activity, page 7-3.
Add Host Port Group
Creates a new network port group for a specified ESX server.
See Defining the Add Host Port Group Activity, page 7-7.
Enter VM Host Maintenance
Mode
Moves a host server offline so that maintenance can be
performed
See Defining the Enter VM Host Maintenance Mode
Activity, page 7-9.
Exit VM Host Maintenance Mode Brings a host server back online after maintenance has been
performed
See Defining the Exit VM Host Maintenance Mode Activity,
page 7-11.
Power Down Host to Standby
Powers down the host to standby mode, a state from which
the host can be powered up remotely
See Defining the Power Down Host to Standby Activity,
page 7-14.
Power Up Host from Standby
Powers up the host out of standby mode
See Defining the Power Up Host from Standby Activity,
page 7-17.
Query Host Properties
Queries the properties of a specified ESX/ESXi host
See Defining the Query Host Properties Activity, page 7-21.
Query Hosts
Retrieves the hosts within a VMware infrastructure
See Defining the Query Hosts Activity, page 7-25.
Query Host Network Adapter
Enumerates the network adapters configured on a specified
ESX server
See Defining the Query Host Network Adapters Activity,
page 7-19.
Query Host Storage Adapters
Retrieves information about storage adapters configured for
a specified host
See Defining the Query Host Storage Adapters Activity,
page 7-23.
Reboot VM Host
Restart an ESX host
See Defining the Reboot VM Host Activity, page 7-27.
Remove ESX Host
Removes a host from the VMware infrastructure
See Defining the Remove ESX Server Activity, page 7-30.
Cisco TEO Adapter Guide for VMware
7-2
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Add Host Activity
Activity
Description
Shut Down Host
Powers off a host server
See Defining the Shutdown Host Activity, page 7-32.
Update Host Port Group
Modifies VLAN ID of the specified port group.
See Defining the Update Host Port Group Activity,
page 7-35.
Defining the Add Host Activity
Use the Add Host activity to add a new host to the VMware infrastructure. There are two types of hosts
that can be added to the VMware infrastructure: standalone hosts, which can be added to any data center
or folder, and hosts that are intended to be part of a VMware cluster. This activity may not be able to add
hosts if the hosts contains invalid SSL certificates.
While this activity is running and when the host is in maintenance mode, no virtual machines can be
powered on and no provisioning operations can be performed on the host.
To define the Add Host activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Add Host activity, then drag and drop the
activity onto the Workflow pane.
The Add Host property pages display.
Figure 7-1
Step 2
Add Host Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-3
Chapter 7
VMware Host Management Activities
Defining the Add Host Activity
Step 3
Note
Click the Add Host tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-2
Note
Step 4
Add Host Properties Page—Add Host Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Add Host tab, specify the following information to be used to add a host:
Field
Description
Location
Inventory path to the location in VMware infrastructure
where the host server is to be added. This could be a folder,
data center, or cluster.
The information in this field is case-sensitive.
Connection Settings
Host
DNS name or IP address of the host server
Port
Check the check box and enter the port number used to
access the ESX/ESXi server
Username
Enter the administrative account used to connect to the host
Password
Enter the encrypted password associated with the host
username
SSL Certificate
Accept host's certificate
Select this radio button to accept the host certificate.
Cisco TEO Adapter Guide for VMware
7-4
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Add Host Activity
Field
Description
Certificate thumbprint
If the host does not have a certificate, select this radio
button and then specify the parameter containing the SSL
certificate thumbprint.
Connect after adding
Check the check box to indicate that the newly added host
should be connected after being added to VMware.
If the check box remains unchecked, then the host will
remain disconnected after being added.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Click the Advanced tab to continue.
Figure 7-3
Add Host Properties Page—Advanced Tab
Note
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
Step 6
On the Advanced tab, specify the additional host properties upon adding to the VMware infrastructure:
Field
Description
Resource pool
Name of the resource pool for the root resource pool from
the host
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-5
Chapter 7
VMware Host Management Activities
Defining the Add Host Activity
Field
Description
Folder for virtual machines
Enter the name of the folder in which to store the existing
virtual machines on the host.
Add even if connected to another
virtual center
Check this check box to add host even if it is already being
managed by another virtual center server. The host
connection to the original virtual center is severed.
If the check box is unchecked, then the host cannot be
added to the new virtual center server.
Step 7
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the host properties for the activity instance, see Viewing Host Instance Information, page 5-12.
Cisco TEO Adapter Guide for VMware
7-6
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Add Host Port Group Activity
Defining the Add Host Port Group Activity
Use the Add Host Port Group activity to create a new network port group for a specified ESX server.
To define the Add Host Port Group activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Add Host Port Group activity, then drag and
drop the activity onto the Workflow pane.
The Add Host Port Group property pages display.
Figure 7-4
Step 2
Step 3
Note
Add Host Port Group Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Port Group tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-7
Chapter 7
VMware Host Management Activities
Defining the Add Host Port Group Activity
Figure 7-5
Note
Step 4
Add Host Port Group Properties Page—Port Group Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Port Group tab, specify the following information to be used to add a port group:
Field
Description
Host
Enter the inventory path of the host. The information in this
field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Switch name
Enter the virtual switch name for the port group.
Port group
Enter the name of the port group to add.
VLAN ID
Enter the integer number that corresponds to the VLAN ID.
The valid values are integers between 0 and 4095.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
7-8
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Enter VM Host Maintenance Mode Activity
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Enter VM Host Maintenance Mode Activity
Use the Enter VM Host Maintenance Mode activity to move a host server offline so that maintenance
can be performed. While this activity is running and when the host is in maintenance mode, no virtual
machines can be powered on and no provisioning operations can be performed on the host.
To define the Enter VM Host Maintenance Mode from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Enter VM Host Maintenance Mode activity,
then drag and drop the activity onto the Workflow pane.
The Enter VM Host Maintenance Mode property pages display.
Figure 7-6
Step 2
Step 3
Note
Enter VM Host Maintenance Mode Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Enter Maintenance tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-9
Chapter 7
VMware Host Management Activities
Defining the Enter VM Host Maintenance Mode Activity
Figure 7-7
Note
Step 4
Enter VM Host Maintenance Mode Properties Page—Enter Maintenance Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Enter Maintenance tab, specify the following information:
Field
Description
Host
Inventory path to the ESX host server to be entering
maintenance mode. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is in maintenance mode.
If the check box is not checked and the ESX host is already
in entering maintenance mode, the activity will complete
with an error message stating the operation is not allowed
in the current state or could not connect the host.
Evacuate guests
Check this check box to migrate all virtual machines
currently associated with the host server to other available
hosts in the computer resource pool before entering
maintenance mode.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
7-10
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Exit VM Host Maintenance Mode Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the host properties for the activity instance, see Viewing Host Instance Information, page 5-12.
Defining the Exit VM Host Maintenance Mode Activity
Use the Exit VM Host Maintenance Mode activity to bring a host server back online after the
maintenance on the server has been completed. Using this activity, blocks any concurrent running
maintenance-only host configurations operations are being performed. For example, if VMFS (Virtual
Machine File System) volumes are being upgraded.
To define the Exit VM Host Maintenance Mode from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Exit VM Host Maintenance Mode activity,
then drag and drop the activity onto the Workflow pane.
The Exit VM Host Maintenance Mode property pages display.
Figure 7-8
Exit VM Host Maintenance Mode Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-11
Chapter 7
VMware Host Management Activities
Defining the Exit VM Host Maintenance Mode Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Exit Maintenance tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-9
Note
Step 4
Exit VM Host Maintenance Mode Properties Page—Exit Maintenance Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Enter Maintenance tab, specify the following information:
Field
Description
Host
Inventory path to the ESX host server that will be exiting
maintenance mode. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
7-12
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Exit VM Host Maintenance Mode Activity
Field
Description
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is exiting maintenance mode.
If the check box is not checked and the ESX host is already
in entering maintenance mode, the activity will complete
with an error message stating the operation is not allowed
in the current state or could not connect the host.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the host properties for the activity instance, see Viewing Host Instance Information, page 5-12.
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-13
Chapter 7
VMware Host Management Activities
Defining the Power Down Host to Standby Activity
Defining the Power Down Host to Standby Activity
Use the Power Down Host to Standby activity to power down an ESX host server to standby state.
To define the Power Down Host to Standby from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Power Down Host to Standby activity, then
drag and drop the activity onto the Workflow pane.
The Power Down Host to Standby property pages display.
Figure 7-10
Step 2
Power Down Host to Standby Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
7-14
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Power Down Host to Standby Activity
Step 3
Note
Click the Power Down tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-11
Note
Step 4
Power Down Host to Standby Properties Page—Power Down Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Power Down tab, specify the following information:
Field
Description
Host
Inventory path to the ESX host server. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is powered down to standby state.
If the check box is not checked and the ESX host is already
in a standby state, the activity will complete with an error
message stating the operation is not allowed in the current
state or could not connect the host.
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-15
Chapter 7
VMware Host Management Activities
Defining the Power Down Host to Standby Activity
Field
Description
Evacuate guests
Check this check box to migrate all virtual machines
currently associated with the host server to other available
hosts in the computer resource pool before powering down
to a standby state.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the host properties for the activity instance, see Viewing Host Instance Information, page 5-12.
Cisco TEO Adapter Guide for VMware
7-16
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Power Up Host from Standby Activity
Defining the Power Up Host from Standby Activity
Use the Power Up Host from Standby activity to power up an ESX host server from standby state.
To define the Power Up Host from Standby from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Power Up Host from Standby activity, then
drag and drop the activity onto the Workflow pane.
The Power Up Host from Standby property pages display.
Figure 7-12
Step 2
Power Up Host from Standby Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-17
Chapter 7
VMware Host Management Activities
Defining the Power Up Host from Standby Activity
Step 3
Note
Click the Power Up tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-13
Note
Step 4
Power Up Host from Standby Properties Page—Power Up Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Power Up tab, specify the following information:
Field
Description
Host
Inventory path to the ESX host server. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is Powered up.
If the check box is not checked and the ESX host is already
in a powered up state, the activity will complete with an
error message stating the operation is not allowed in the
current state or could not connect the host.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
7-18
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Query Host Network Adapters Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the host properties for the activity instance, see Viewing Host Instance Information, page 5-12.
Defining the Query Host Network Adapters Activity
Use the Query Host Network Adapters activity to enumerate the network adapters configured on a
specified ESX server.
To define the Query Host Network Adapters from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Query Host Network Adapters activity, then
drag and drop the activity onto the Workflow pane.
The Query Host Network Adapters property pages display.
Figure 7-14
Query Host Network Adapters Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-19
Chapter 7
VMware Host Management Activities
Defining the Query Host Network Adapters Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Host tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-15
Note
Step 4
Query Host Network Adapters Properties Page—Host Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Host tab, specify the following information:
Field
Description
Host
Inventory path to the ESX host server. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
7-20
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Query Host Properties Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the activity instance, see Viewing Query Host Network Adapters Results,
page 7-37.
Defining the Query Host Properties Activity
Use the Query Host Properties activity to query the properties of an ESX server.
To define the Query Host Properties from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Query Host Properties activity, then drag and
drop the activity onto the Workflow pane.
The Query Host Properties property pages display.
Figure 7-16
Query Host Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-21
Chapter 7
VMware Host Management Activities
Defining the Query Host Properties Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Query Host Properties tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-17
Note
Step 4
Query Host Properties Page—Query Host Properties Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Query Host Properties tab, specify the following information:
Field
Description
Host
Inventory path to the ESX host server. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
7-22
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Query Host Storage Adapters Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the host properties for the activity instance, see Viewing Host Instance Information, page 5-12.
Defining the Query Host Storage Adapters Activity
Use the Query Host Storage Adapters activity to query information about storage adapters configured
for a specified host.
To define the Query Host Storage Adapters activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Query Host Storage Adapters activity, then
drag and drop the activity onto the Workflow pane.
The Query Host Properties property pages display.
Figure 7-18
Step 2
Query Host Storage Adapters Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-23
Chapter 7
VMware Host Management Activities
Defining the Query Host Storage Adapters Activity
Step 3
Note
Field
Description
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Host tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-19
Note
Step 4
Query Host Storage Adapters Properties Page—Storage Adapters Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Storage Adapters tab, specify the following information:
Field
Description
Host
Inventory path to the host server. The information in this
field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02)
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
7-24
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Query Hosts Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the activity instance, see Viewing Query Host Storage Adapters Activity Results,
page 7-39.
Defining the Query Hosts Activity
Use the Query Hosts activity to query the list of hosts within the virtual infrastructure target.
To define the Query Hosts from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Query Hosts activity, then drag and drop the
activity onto the Workflow pane.
The Query Hosts property pages display.
Figure 7-20
Step 2
Query Hosts Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-25
Chapter 7
VMware Host Management Activities
Defining the Query Hosts Activity
Step 3
Note
Field
Description
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Hosts tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-21
Note
Step 4
Query Hosts Properties Page—Hosts Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Hosts tab, specify the following information:
Field
Description
Host
Name of the ESX host server
Note
Time out if not completed within
Wildcards can be used in this field. See Common
Wildcard Expressions, page 4-3 for additional
information.
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
7-26
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Reboot VM Host Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results of the query, see Viewing Query Hosts Activity Results, page 7-40.
Defining the Reboot VM Host Activity
Use the Reboot VM Host activity to restart an ESX server.
To define the Reboot VM Host from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Reboot VM Host activity, then drag and drop
the activity onto the Workflow pane.
The Reboot VM Host property pages display.
Figure 7-22
Reboot VM Host Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-27
Chapter 7
VMware Host Management Activities
Defining the Reboot VM Host Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Reboot tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-23
Note
Step 4
Reboot VM Host Properties Page—Reboot Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Reboot tab, specify the following information:
Field
Description
Host
Inventory path to the ESX host server to be restarted. The
information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
7-28
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Reboot VM Host Activity
Field
Description
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the activity instance, see Viewing Host Instance Information, page 5-12.
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-29
Chapter 7
VMware Host Management Activities
Defining the Remove ESX Server Activity
Defining the Remove ESX Server Activity
Use the Remove ESX Host activity to remove a host from the virtual environment (Virtual Center).
To define the Remove ESX Host from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Remove ESX Host activity, then drag and drop
the activity onto the Workflow pane.
The Remove ESX Host property pages display.
Figure 7-24
Step 2
Remove ESX Host Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
7-30
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Remove ESX Server Activity
Step 3
Note
Click the Host tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-25
Note
Step 4
Remove ESX Host Properties Page—Host Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Host tab, specify the following information:
Field
Description
Host
Inventory path to the ESX host server to be restarted. The
information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-31
Chapter 7
VMware Host Management Activities
Defining the Shutdown Host Activity
Step 5
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Shutdown Host Activity
Use the Shutdown Host activity to power off an ESX host in a Virtual Center.
To define the Shutdown Host from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Shutdown Host activity, then drag and drop
the activity onto the Workflow pane.
The Shutdown Host property pages display.
Figure 7-26
Step 2
Shutdown Host Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
7-32
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Shutdown Host Activity
Step 3
Note
Click the Host tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-27
Note
Step 4
Shutdown Host Properties Page—Host Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Host tab, specify the following information:
Field
Description
Host
Inventory path to the host server to be shut down. The
information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is shut down.
If the check box is not checked and the host is already shut
down, the activity will complete with an error message
stating the operation is not allowed in the current state or
could not connect the host.
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-33
Chapter 7
VMware Host Management Activities
Defining the Shutdown Host Activity
Field
Description
Force shutdown if not in
maintenance mode
Check this check box to indicate that the host should be
shut down even if it is not in maintenance mode
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results for the activity instance, see Viewing Host Instance Information, page 5-12.
Cisco TEO Adapter Guide for VMware
7-34
OL-24933-02
Chapter 7
VMware Host Management Activities
Defining the Update Host Port Group Activity
Defining the Update Host Port Group Activity
Use the Update Host Port Group activity to modify VLAN ID of the specified port group.
To define the Update Host Port Group from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Update Host Port Group activity, then drag
and drop the activity onto the Workflow pane.
The Update Host Port Group property pages display.
Figure 7-28
Step 2
Update Host Port Group Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-35
Chapter 7
VMware Host Management Activities
Defining the Update Host Port Group Activity
Step 3
Note
Click the Port Group tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 7-29
Note
Step 4
Update Host Port Group Properties Page—Port Group Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Port Group tab, specify the following information:
Field
Description
Host
Inventory path to the host server
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Port group
Enter the name of the port group to update.
VLAN ID
Enter the integer number that corresponds to a VLAN ID.
The valid values are integers between 0 and 4095.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
7-36
OL-24933-02
Chapter 7
VMware Host Management Activities
Viewing VMware Host Activity Results
Step 5
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Viewing VMware Host Activity Results
This section describes what the user should expect to see after a process with a VMware host activity is
launched. Certain activities generate and display additional activity instance information for review by
users.
Viewing Query Host Network Adapters Results
When the Query Host Network Adapters activity is launched, the results of the Query Host Network
Adapters activity are displayed from the Operations Workspace activity instance view.
To view the Query Host Network Adapters results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Query Host Network Adapters activity instance, right-click and choose Properties.
The Query Host Network Adapters dialog box displays.
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-37
Chapter 7
VMware Host Management Activities
Viewing VMware Host Activity Results
Step 3
Click the Network Adapters display-only tab to view the list of network adapters on the host server.
Figure 7-30
Query Host Network Adapters Instance Properties Page—Network Adapters Tab
The following information is displayed:
Column
Description
Name
Display name of the network adapter
Summary
Name or IP address of the virtual network
Adapter Type
Type of adapter configured on the virtual network
•
Flexible—Supported on virtual machines that were
created on ESX Server 3.0 or greater and that run
32-bit guest operating systems.
•
E1000—Emulates the functioning of an E1000
network card. It is the default adapter type for virtual
machines that run 64-bit guest operating systems.
•
Enhanced vmxnet—An upgraded version of the
Vmxnet device with enhanced performance
•
vmxnet 3—Next generation Vmxnet device with
enhanced performance and enhanced networking
features
Connected
Indicates whether the host is connected or disconnected
Connect on Power On
Indicates whether the host is connected when it was
Powered On
MAC Address
MAC Address assigned to the network adapter in the
virtual machine
MAC Address Type
Indicates how the MAC Address was assigned to the
network adapter
•
Manual
•
Automatic
Cisco TEO Adapter Guide for VMware
7-38
OL-24933-02
Chapter 7
VMware Host Management Activities
Viewing VMware Host Activity Results
Column
Description
Network Label
Inventory path for the network assigned to the adapter
Network Port
Port of the virtual network in the VMware environment
Viewing Query Host Storage Adapters Activity Results
When the Query Host Storage Adapters activity is launched, the results of the Query Host Storage
Adapters activity are displayed from the Operations Workspace activity instance view.
To view the Query Host Storage Adapters results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Query Host Storage Adapters activity instance, right-click and choose Properties.
The Query Host Storage Adapters dialog box displays.
Step 3
Click the Storage Adapters display-only tab to view the list of storage adapters and related information
retrieved by the Query Host Storage Adapter activity.
Figure 7-31
Query Host Storage Adapters Instance Properties Page—Storage Adapters Tab
The following information is displayed:
Column
Description
Device
Name of storage device the adapter can access
Model
Name of the adapter
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-39
Chapter 7
VMware Host Management Activities
Viewing VMware Host Activity Results
Column
Description
Type
Type of storage adapter queried
WWN
•
Fibre Channel adapter—Stores virtual machine files
remotely on an FC storage area network (SAN)
•
Internet SCSI adapter—Stores virtual machine files on
remote iSCSI storage devices
World Wide Name formed according to Fibre Channel
standards that uniquely identifies the FC adapter
Viewing Query Hosts Activity Results
When the Query Hosts activity is launched, the results of the Query Hosts activity are displayed from
the Operations Workspace activity instance view.
To view the Query Hosts results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Query Hosts activity instance, right-click and choose Properties.
The Query Hosts dialog box displays.
Cisco TEO Adapter Guide for VMware
7-40
OL-24933-02
Chapter 7
VMware Host Management Activities
Viewing VMware Host Activity Results
Step 3
Click the Hosts display-only tab to view the list of hosts within a virtual infrastructure target.
Figure 7-32
Query Hosts Instance Properties Page—Hosts Tab
The following information is displayed:
Column
Description
Name
Inventory path to the host server responsible for running a
virtual machine
State
The host connection state:
•
connected—Connected to the server. For ESX Server,
this is always the setting.
•
disconnected—The host was taken down by the user.
Virtual Center does not expect to receive heartbeats
from the host. The next time a heartbeat is received, the
host changes to the connected state again and an event
is logged.
•
notResponding—Virtual Center is not receiving
heartbeats from the server. The state automatically
changes to connected once heartbeats are received
again. This state is typically used to trigger an alarm on
the host.
In Maintenance Mode
Indicates whether the host server is in maintenance mode
Up Time
Amount of time the machine has been up without any
downtime
Cisco TEO Adapter Guide for VMware
OL-24933-02
7-41
Chapter 7
VMware Host Management Activities
Viewing VMware Host Activity Results
Cisco TEO Adapter Guide for VMware
7-42
OL-24933-02
CH A P T E R
8
VMware Power Management Activities
Use the following activities to perform the following basic power management to the virtual machines
running on the ESX Server via the VI connection.
This chapter provides instructions for defining VMware power activities, instructions for completing the
property pages for each specific activity, and instructions on viewing the activity results.
•
VMware Power Activities, page 8-2
•
Defining the Execute PowerCLI Script Activity, page 8-3
•
Defining the Power Off VM Activity, page 8-6
•
Defining the Power On VM Activity, page 8-8
•
Defining the Reboot Guest Activity, page 8-11
•
Defining the Reset VM Activity, page 8-13
•
Defining the Shutdown Guest Activity, page 8-15
•
Defining the Standby Guest Activity, page 8-18
•
Defining the Suspend VM Activity, page 8-20
•
Viewing Execute PowerCLI Script Results, page 8-22
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-1
Chapter 8
VMware Power Management Activities
VMware Power Activities
VMware Power Activities
The following table displays the power activities provided by the VMware Adapter:
Activity
Description
Execute PowerCLI Script
Specifies a script command to execute using the VMware
vSphere PowerCLI module.
See Defining the Execute PowerCLI Script Activity.
Power Off VM
Powers off a virtual machine
See Defining the Power Off VM Activity, page 8-6.
Power On VM
Powers on a virtual machine
See Defining the Power On VM Activity, page 8-8.
Reboot Guest
Restarts a guest operating system on a virtual machine
See Defining the Reboot Guest Activity, page 8-11.
Reset VM
Resets the power on a virtual machine
See Defining the Reset VM Activity, page 8-13.
Shutdown Guest
Powers off a guest operating system on a virtual machine and
performs a clean shutdown of all services
See Defining the Shutdown Guest Activity, page 8-15.
Standby Guest
Powers down a guest operating system on a virtual machine
to standby mode
See Defining the Standby Guest Activity, page 8-18.
Suspend VM
Suspends execution in the virtual machine
See Defining the Suspend VM Activity, page 8-20.
Cisco TEO Adapter Guide for VMware
8-2
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Execute PowerCLI Script Activity
Defining the Execute PowerCLI Script Activity
Use the Execute PowerCLI Script activity to specify a script command to execute using the VMware
vSphere PowerCLI module.
This activity will retrieve the collection of objects returned by the last command in the script and
displays the specified properties in the Output tab in the output results.
To define the Execute PowerCLI Script from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Execute PowerCLI Script activity, then drag
and drop the activity onto the Workflow pane.
The Execute PowerCLI Script property pages display.
Figure 8-1
Step 2
Execute PowerCLI Script Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-3
Chapter 8
VMware Power Management Activities
Defining the Execute PowerCLI Script Activity
Step 3
Note
Click the Script tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 8-2
Note
Execute PowerCLI Script Properties Page—Script Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
Cisco TEO Adapter Guide for VMware
8-4
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Execute PowerCLI Script Activity
Step 4
On the Script tab, specify the following information:
Field
Description
Script arguments
Enter the collection of argument values for the script.
•
Add—Click this button and choose one of the
following to launch the Select Argument to Add dialog
box. Enter the appropriate script in the text field or
click the Reference tool to select from the list. See
Adding a Script Argument, page 5-6.
– String—Dialog box can contain standard string
text
– Hidden String—Dialog box can contain hidden
string text or query encrypted value variables in
the Insert Reference Variable dialog box
Script to execute
•
Edit—Select a script argument from the list and click
this button to modify the script argument in the Select
Argument to Add dialog box. See Modifying a Script
Argument, page 5-7.
•
Remove—Select a script argument from the list and
click this button to remove the script argument from
the list.
•
Remove All—Click this button to remove all the script
arguments from the list.
Enter the actual script code to use to execute PowerCLI
scripts.
The code must include valid PowerShell 2.0, 64-bit
compatible script.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the results of the script execution, see Viewing Execute PowerCLI Script Results, page 8-22.
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-5
Chapter 8
VMware Power Management Activities
Defining the Power Off VM Activity
PowerCLI Example
The following is an example of a script containing two arguments. For additional examples and
information, see Script arguments and other special variables.
Script Argument
param([string] $computerName,
[string] $processNameFilter)
Script to Execute
get-process –Name $processNameFilter –ComputerName $computerName
Defining the Power Off VM Activity
Use the Power Off VM activity to power off a specified virtual machine on a given ESX server or Virtual
Center server.
To define the Power Off VM from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Power Off VM activity, then drag and drop the
activity onto the Workflow pane.
The Power Off VM property pages display.
Figure 8-3
Step 2
Power Off VM Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
8-6
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Power Off VM Activity
Step 3
Note
Click the Power Off tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 8-4
Note
Step 4
Power Off VM Properties Page—Power Off Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Power Off tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine to be powered off.
The information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects
dialog box to query the appropriate managed object on a
specified target. See Selecting a Managed Object,
page 5-6.
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is Powered Off.
If the check box is not checked and the ESX host is already
powered off, the activity will complete with an error
message stating the operation is not allowed in the current
state or could not connect the host.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-7
Chapter 8
VMware Power Management Activities
Defining the Power On VM Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Power Off VM activity instance, see Viewing VM Instance
Information, page 5-14.
Defining the Power On VM Activity
Use the Power On VM activity to power on a specified virtual machine on a given ESX server or Virtual
Center server.
To define the Power On VM from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Power On VM activity, then drag and drop the
activity onto the Workflow pane.
The Power On VM property pages display.
Figure 8-5
Power On VM Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
8-8
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Power On VM Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Power On tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 8-6
Note
Step 4
Power On VM Properties Page—Power On Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Power On tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine where the virtual
machine should be powered on. The information in this
field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects
dialog box to query the appropriate managed object on a
specified target. See Selecting a Managed Object,
page 5-6.
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-9
Chapter 8
VMware Power Management Activities
Defining the Power On VM Activity
Field
Description
Host
Inventory path to the ESX host server to be powered on.
The information in this field is case-sensitive.
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is Powered On.
If the check box is not checked and the ESX host is already
powered on, the activity will complete with an error
message stating the operation is not allowed in the current
state or could not connect the host.
Wait for VMware tools
Check this check box to wait for the VM tools service to
start before completing the activity.
Users can configure the VMware Tools service to depend
on other required application services, to ensure that the
required application services are available when the
activity completes.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Power On VM activity instance, see Viewing VM Instance
Information, page 5-14.
Cisco TEO Adapter Guide for VMware
8-10
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Reboot Guest Activity
Defining the Reboot Guest Activity
Use the Reboot Guest activity to restart a guest operating system on a virtual machine on a given ESX
server or Virtual Center server. This activity shuts the machine down gracefully prior to powering the
machine back up.
To define the Reboot Guest from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Reboot Guest activity, then drag and drop the
activity onto the Workflow pane.
The Reboot Guest property pages display.
Figure 8-7
Step 2
Step 3
Note
Reboot Guest Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Reboot Guest tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-11
Chapter 8
VMware Power Management Activities
Defining the Reboot Guest Activity
Figure 8-8
Note
Step 4
Reboot Guest Properties Page—Reboot Guest Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Reboot Guest tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine whose guest
operating system is to be rebooted. The information in this
field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Wait for VMware tools
Check this check box to wait for the VM tools service to
start before completing the activity.
Users can configure the VMware Tools service to depend
on other required application services, to ensure that the
required application services are available when the
activity completes.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
8-12
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Reset VM Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Reboot Guest activity instance, see Viewing VM Instance
Information, page 5-14.
Defining the Reset VM Activity
Use the Reset VM activity to reset the power on a virtual machine on a given ESX server or Virtual
Center server.
To define the Reset VM from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Reset VM activity, then drag and drop the
activity onto the Workflow pane.
The Reset VM property pages display.
Figure 8-9
Reset VM Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-13
Chapter 8
VMware Power Management Activities
Defining the Reset VM Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Reset tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 8-10
Note
Step 4
Reset VM Properties Page—Reset Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Reset tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine to be reset. The
information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
8-14
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Shutdown Guest Activity
Field
Description
Wait for VMware tools
Check this check box to wait for the VM tools service to
start before completing the activity.
Users can configure the VMware Tools service to depend
on other required application services, to ensure that the
required application services are available when the
activity completes.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Reset VM activity instance, see Viewing VM Instance
Information, page 5-14.
Defining the Shutdown Guest Activity
Use the Shutdown Guest activity to power off a guest operating system on a virtual machine gracefully.
To define the Shutdown Guest from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Shutdown Guest activity, then drag and drop
the activity onto the Workflow pane.
The Shutdown Guest property pages display.
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-15
Chapter 8
VMware Power Management Activities
Defining the Shutdown Guest Activity
Figure 8-11
Step 2
Step 3
Note
Shutdown Guest Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Shutdown Guest tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 8-12
Shutdown Guest Properties Page—Shutdown Guest Tab
Cisco TEO Adapter Guide for VMware
8-16
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Shutdown Guest Activity
Note
Step 4
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Shutdown Guest tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine whose guest
operating system is to be shut down. The information in
this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is shut down.
If the check box is not checked and the virtual machine is
already shut down, the activity will complete with an error
message stating the operation is not allowed in the current
state or could not connect the host.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Shutdown Guest activity instance, see Viewing VM Instance
Information, page 5-14.
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-17
Chapter 8
VMware Power Management Activities
Defining the Standby Guest Activity
Defining the Standby Guest Activity
Use the Standby Guest activity to put a guest operating system on a virtual machine in standby mode on
a given ESX server or Virtual Center server.
To define the Standby Guest from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Standby Guest activity, then drag and drop the
activity onto the Workflow pane.
The Standby Guest property pages display.
Figure 8-13
Step 2
Step 3
Note
Standby Guest Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Standby Guest tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Cisco TEO Adapter Guide for VMware
8-18
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Standby Guest Activity
Figure 8-14
Note
Step 4
Standby Guest Properties Page—Standby Guest Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Standby Guest tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine whose guest
operating system should be put in stand by mode. The
information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is in standby.
If the check box is not checked and the virtual machine is
already in standby, the activity will complete with an error
message stating the operation is not allowed in the current
state or could not connect the host.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-19
Chapter 8
VMware Power Management Activities
Defining the Suspend VM Activity
Step 5
Note
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Standby Guest activity instance, see Viewing VM Instance
Information, page 5-14.
Defining the Suspend VM Activity
Use the Suspend VM activity to suspend a virtual machine on a given ESX server or Virtual Center
server.
To define the Suspend VM from activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Suspend VM Host activity, then drag and drop
the activity onto the Workflow pane.
The Suspend VM property pages display.
Figure 8-15
Suspend VM Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
8-20
OL-24933-02
Chapter 8
VMware Power Management Activities
Defining the Suspend VM Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Suspend tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 8-16
Note
Step 4
Suspend VM Properties Page—Suspend Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Suspend tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine to be suspended. The
information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-21
Chapter 8
VMware Power Management Activities
Viewing Execute PowerCLI Script Results
Field
Description
Skip if already in expected power
state
Check this check box to complete the activity normally if
the power state is suspended.
If the check box is not checked and the virtual machine is
already suspended, the activity will complete with an error
message stating the operation is not allowed in the current
state or could not connect the host.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Note
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
To view the following information for the Suspend Guest activity instance, see Viewing VM Instance
Information, page 5-14.
Viewing Execute PowerCLI Script Results
When the Execute PowerCLI Script activity is launched, the results of the activity are displayed from
the Operations Workspace activity instance view.
To view the Execute PowerCLI Script results:
Step 1
On the Operations workspace, click the Activity Views folder.
Step 2
Highlight the Execute PowerCLI Script activity instance, right-click and choose Properties.
The Execute PowerCLI Script Properties dialog box displays.
Step 3
Click the Results tab display-only tab to view the results and properties retrieved from the script
command and output object property specifications.
Field
Description
Execution succeeded
Indicates whether the script execution succeeded
successfully. (True, False)
Result table
Displays the object properties retrieved by the script
command
Cisco TEO Adapter Guide for VMware
8-22
OL-24933-02
Chapter 8
VMware Power Management Activities
Viewing Execute PowerCLI Script Results
Field
Description
Objects discarded
Displays the number of objects discarded from the
collection retrieval
Elapsed Times
Field
Description
Server connection
Displays the time taken to connect to the server.
If the script execution succeeds, but the connection takes
longer than 25 seconds, an Eventlog warning entry will be
created.
Script execution
Displays the time taken for the script execution to
complete.
Result collection
Displays the time taken for the collection of object
properties to be retrieved.
Cisco TEO Adapter Guide for VMware
OL-24933-02
8-23
Chapter 8
VMware Power Management Activities
Viewing Execute PowerCLI Script Results
Cisco TEO Adapter Guide for VMware
8-24
OL-24933-02
CH A P T E R
9
VMware Snapshot Management Activities
Use the following activities to modify the basic snapshot management of the virtual machines running
on the ESX Server or Virtual Center.
This chapter provides instructions for defining VMware snapshot activities, instructions for completing
the property pages for each specific activity, and instructions on viewing the activity results.
•
VMware Snapshot Activities, page 9-2
•
Defining the Query VM Snapshots Activity, page 9-6
•
Defining the Remove All Snapshots Activity, page 9-8
•
Defining the Remove Snapshot Activity, page 9-10
•
Defining the Rename Snapshot Activity, page 9-12
•
Defining the Revert to Current Snapshot Activity, page 9-14
•
Defining the Revert to Snapshot Activity, page 9-17
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-1
Chapter 9
VMware Snapshot Management Activities
VMware Snapshot Activities
VMware Snapshot Activities
The following table displays the string activities provided by the VMware Adapter:
Activity
Description
Create Snapshot
Creates a snapshot of a specified virtual machine
See Defining the Create Snapshot Activity, page 9-3.
Query VM Snapshots
Queries the properties of a snapshot of a selected virtual
machine
See Defining the Query VM Snapshots Activity, page 9-6.
Remove all Snapshot
Removes all snapshots that have been taken of the virtual
machine
See Defining the Remove All Snapshots Activity, page 9-8.
Remove Snapshot
Removes a specific snapshot from the virtual machine and
deletes any associated storage
See Defining the Remove Snapshot Activity, page 9-10.
Rename Snapshot
Changes the name or description of a snapshot of the virtual
machine
See Defining the Rename Snapshot Activity, page 9-12.
Revert to Current Snapshot
Restore the most recent snapshot
See Defining the Revert to Current Snapshot Activity,
page 9-14.
Revert to Snapshot
Restore the specified virtual machine to a specific snapshot
See Defining the Revert to Snapshot Activity, page 9-17.
Cisco TEO Adapter Guide for VMware
9-2
OL-24933-02
Chapter 9
VMware Snapshot Management Activities
Defining the Create Snapshot Activity
Defining the Create Snapshot Activity
Use the Create Snapshot activity to capture a snapshot of a specified virtual machine.
To define the Create Snapshot activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Create Snapshot activity, then drag and drop
the activity onto the Workflow pane.
The Create Snapshot property pages display.
Figure 9-1
Step 2
Create Snapshot Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-3
Chapter 9
VMware Snapshot Management Activities
Defining the Create Snapshot Activity
Step 3
Note
Click the Snapshot tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 9-2
Note
Step 4
Create Snapshot Properties Page—Snapshot Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Snapshot tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine on which the
snapshot will be taken. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Snapshot name
Name for the snapshot that is created
Snapshot the virtual machine
memory
Check this check box to include the memory of the virtual
machine in the snapshot.
A dump of the internal state of the virtual machine is
included in the snap shot.
If the check box is not checked, then the power state of the
snapshot is set to Powered Off.
Cisco TEO Adapter Guide for VMware
9-4
OL-24933-02
Chapter 9
VMware Snapshot Management Activities
Defining the Create Snapshot Activity
Field
Description
Quiesce virtual memory during
snapshot
Check this check box to quiesce file system writes before
the snapshot is taken.
If the virtual machines is Powered On when the snapshot is
taken, this ensures that the disk snapshot represents a
consistent state of the guest file system.
If the virtual machine is Powered Off or VMware Tools are
not available, the quiesce flag is ignored.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Snapshot description
Step 5
Click the time unit link to change the time interval.
Brief description of the snapshot
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-5
Chapter 9
VMware Snapshot Management Activities
Defining the Query VM Snapshots Activity
Defining the Query VM Snapshots Activity
Use the Query VM Snapshots activity to query the properties of a snapshot of a selected virtual machine
on a given ESX server or Virtual Center server. The Query VM Snapshot activity should generate a list
with the name and description of each snapshot of the virtual machine.
To define the Query VM Snapshot activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Query VM Snapshots activity, then drag and
drop the activity onto the Workflow pane.
The Query VM Snapshots property pages display.
Figure 9-3
Step 2
Query VM Snapshots Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
9-6
OL-24933-02
Chapter 9
VMware Snapshot Management Activities
Defining the Query VM Snapshots Activity
Step 3
Note
Click the Virtual Machine tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 9-4
Note
Step 4
Query VM Snapshots Properties Page—Virtual Machine Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Virtual Machine tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine to query for
snapshots. The information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-7
Chapter 9
VMware Snapshot Management Activities
Defining the Remove All Snapshots Activity
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Remove All Snapshots Activity
Use the Remove All Snapshots activity to delete all snapshots that have been taken of a specified virtual
machine.
To define the Remove All Snapshots activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Remove All Snapshots activity, then drag and
drop the activity onto the Workflow pane.
The Remove All Snapshots property pages display.
Figure 9-5
Step 2
Remove All Snapshots Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
9-8
OL-24933-02
Chapter 9
VMware Snapshot Management Activities
Defining the Remove All Snapshots Activity
Step 3
Note
Click the Virtual Machine tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 9-6
Note
Step 4
Remove All Snapshots Properties Page—Virtual Machine Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Virtual Machine tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine on which the
snapshots will be deleted. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-9
Chapter 9
VMware Snapshot Management Activities
Defining the Remove Snapshot Activity
Step 5
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Remove Snapshot Activity
Use the Remove Snapshot activity to delete a specific snapshot that was taken of a specified virtual
machine.
To define the Remove Snapshot activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Remove Snapshot activity, then drag and drop
the activity onto the Workflow pane.
The Remove Snapshot property pages display.
Figure 9-7
Step 2
Remove Snapshot Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
9-10
OL-24933-02
Chapter 9
VMware Snapshot Management Activities
Defining the Remove Snapshot Activity
Step 3
Note
Click the Snapshot tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 9-8
Note
Step 4
Remove Snapshot Properties Page—Snapshot Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Snapshot tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine on which the
snapshot was taken. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Snapshot name
Name of the snapshot to be deleted
Fail on duplicate snapshot name
Check this check box to indicate the activity should fail if
the reverted snapshot is a duplicate.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Click the time unit link to change the time interval.
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-11
Chapter 9
VMware Snapshot Management Activities
Defining the Rename Snapshot Activity
Step 5
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Rename Snapshot Activity
Use the Rename Snapshot activity to update the name or description of an existing snapshot of a
specified virtual machine.
To define the Rename Snapshot activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Rename Snapshot activity, then drag and drop
the activity onto the Workflow pane.
The Rename Snapshot property pages display.
Figure 9-9
Step 2
Rename Snapshot Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
9-12
OL-24933-02
Chapter 9
VMware Snapshot Management Activities
Defining the Rename Snapshot Activity
Step 3
Note
Click the Snapshot tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 9-10
Note
Step 4
Rename Snapshot Properties Page—Snapshot Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Snapshot tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine containing the
snapshot is to be updated. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Snapshot name
Current name of the snapshot whose properties are to be
updated
Fail on duplicate snapshot name
Check this check box to indicate the activity should fail if
the reverted snapshot is a duplicate.
New snapshot name
New name for the snapshot
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-13
Chapter 9
VMware Snapshot Management Activities
Defining the Revert to Current Snapshot Activity
Field
Description
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Snapshot description
Step 5
Click the time unit link to change the time interval.
Brief description of the snapshot
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Defining the Revert to Current Snapshot Activity
Use the Revert to Current Snapshot activity to restore the virtual machine to the most recent snapshot.
To define the Revert to Current Snapshot activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Revert to Current Snapshot activity, then drag
and drop the activity onto the Workflow pane.
The Revert to Current Snapshot property pages display.
Figure 9-11
Revert to Current Snapshot Properties Page—General Tab
Cisco TEO Adapter Guide for VMware
9-14
OL-24933-02
Chapter 9
VMware Snapshot Management Activities
Defining the Revert to Current Snapshot Activity
Step 2
Step 3
Note
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Click the Snapshot tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 9-12
Note
Revert to Current Snapshot Properties Page—Virtual Machine Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-15
Chapter 9
VMware Snapshot Management Activities
Defining the Revert to Current Snapshot Activity
Step 4
On the Snapshot tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine with the current state
that the VM is to be reverted to the most current snapshot.
The information in this field is case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
9-16
OL-24933-02
Chapter 9
VMware Snapshot Management Activities
Defining the Revert to Snapshot Activity
Defining the Revert to Snapshot Activity
Use the Revert to Snapshot activity to restore the specified virtual machine to a specific snapshot.
To define the Revert to Snapshot activity:
Step 1
On the Toolbox pane, under VMware Adapter, select the Revert to Snapshot activity, then drag and drop
the activity onto the Workflow pane.
The Revert to Snapshot property pages display.
Figure 9-13
Step 2
Revert to Snapshot Properties Page—General Tab
On the General tab, enter the following information:
Field
Description
Display name
Name of the activity
Types
Display-only. Type of activity
Description
Brief description of the activity
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-17
Chapter 9
VMware Snapshot Management Activities
Defining the Revert to Snapshot Activity
Step 3
Note
Click the Snapshot tab to continue.
The Required Value
icon displayed on a tab or page indicates that the field is required and is either
missing a value or contains an invalid value.
Figure 9-14
Note
Step 4
Revert to Snapshot Properties Page—Snapshot Tab
Click the Reference
tool to select a defined variable or reference an object within the process from
the Insert Variable Reference dialog box. For additional information, see Inserting Activity Variable
References, page 5-8.
On the Snapshot tab, specify the following information:
Field
Description
Virtual machine
Inventory path to the virtual machine on which the
snapshot was taken. The information in this field is
case-sensitive.
Example:
TEST-ENV/UCS/vm/TESTDEV-W2K8-64-02
Click Browse to launch the Select Managed Objects dialog
box to query the appropriate managed object on a specified
target. See Selecting a Managed Object, page 5-6.
Snapshot name
Name of the snapshot to which the virtual machine should
be restored
Cisco TEO Adapter Guide for VMware
9-18
OL-24933-02
Chapter 9
VMware Snapshot Management Activities
Defining the Revert to Snapshot Activity
Field
Description
Fail on duplicate snapshot name
Check this check box to indicate the activity should fail if
the reverted snapshot is a duplicate.
Time out if not completed within
Check the check box and enter the time period the activity
should wait for completion before failing.
Note
Step 5
Click the time unit link to change the time interval.
Complete the appropriate information in the following tabs, as necessary, and then click the Save
tool to save the activity definition.
•
Target—Specify the target on which the activity should be executed. See Step 4 in Defining a
VMware Activity.
•
Credentials—Specify the runtime user whose credentials should be used to to execute the activity.
See Step 5 in Defining a VMware Activity.
•
Knowledge Base—Choose the appropriate knowledge base article to associate with the activity. See
Step 6 in Defining a VMware Activity.
•
Result Handlers—Click the appropriate buttons to how activity failure is handled. See Step 7 in
Defining a VMware Activity.
Cisco TEO Adapter Guide for VMware
OL-24933-02
9-19
Chapter 9
VMware Snapshot Management Activities
Defining the Revert to Snapshot Activity
Cisco TEO Adapter Guide for VMware
9-20
OL-24933-02
INDEX
Adding Advanced Conditions to an Object
A
Accessing Definitions - Targets
Accessing Triggers
4-17
Adding a VM Hard Disk using an Existing Virtual
Disk 6-7
2-2
Adding a VM Hard Disk using Raw Device Mappings
4-2
Accessing VMware Adapter Properties
Actions menu and toolbar, runtime users
Activity, Clone Virtual Machine
Adding Basic Conditions to an Object
1-3
Add VM Hard Disk Activity
3-3
6-4
Add VM Network Adapter Activity
Activity, Defining the Exit VM Host Maintenance
Mode 7-11
4-16
6-4
Add VM Hard Disk Properties
6-13
6-8
6-10
Activity, Defining the Power Down Host to Standby
7-14
Add VM Network Adapter Properties, Network Adapter
Settings 6-11
Activity, Defining the Power Up Host from Standby
7-17
Advanced Conditions
Activity, Defining the Query Host Properties
7-21, 7-25
Activity, Defining the Query Host Storage Adapters
4-17
Advanced properties
Add Host
7-23
7-5
Activity, Defining the Upgrade Virtual Machine
Hardware 6-70
Activity, Defining the Upgrade Virtual Machine
Tools 6-72
Activity, Defining the VM Network Adapter
Activity, Migrate Virtual Machine
Activity, Query VM Network Adapters
6-52
6-50
6-54
Activity, Reboot Virtual Machine Host
7-27
Activity, Reconfigure Virtual Machine
6-56
Activity, Relocate Virtual Machine
Activity, Shutdown Host
Activity instance, view
6-59
Add Host Port Group
Add Host Properties
Advanced
7-5
7-3
7-7
7-4
Clone Virtual Machine Activity, defining
Clone Virtual Machine Properties
Collection Operators
color indicators
1-2
6-13
6-14
2-14
5-11
4-3
2-14
Computer Name Properties, Customize Linux VM
5-9
adapter, viewing VMware adapter history
Add Host, defining
C
Comparison Operators
5-12
Adapter System Requirements
4-16
Common Wildcard Expressions
7-32
Activity variable references
Basic Conditions
6-67
6-45
Activity, Query Virtual Machine Properties
Activity, Query VMs
B
1-8
6-22
Computer Name Properties, Customize Windows
VM 6-28
Conditions, triggers
4-7
Configuration, VMware
1-1
Configuration Management Activities
Configuring IP Address Settings
6-76
Configuring Network Properties
6-77
6-1
Cisco TEO Adapter Guide for VMware
OL-24933-02
IN-1
Index
Configuring the Keystore Password
Configuring VMware for TEO
Defining a VMware Virtual Machine Performance
Event 4-9
1-5
1-1
Connection properties, ESX Server target
Defining a VMware Virtual Machine Power Event
2-6
Connection properties, Virtual Center target
Defining Target Criteria for Trigger
2-9
Defining the Add Host Activity
Create a VMware Virtual Machine Performance Event
trigger 4-9
Create Folder Properties
Create Runtime user
Create Snapshot
Defining the Create Folder Activity
Create Snapshot Activity, defining
9-3
6-16
Defining the Create New VM Activity
6-19
Defining the Create Snapshot Activity
9-3
6-21
Defining the Customize Windows VM Activity
Defining the Delete VM Activity
Customize Linux VM Activity
6-21
Customize Linux VM Properties, Computer Name
6-22
Customize Linux VM Properties, DNS and Domain
Customize Linux VM Properties, Network
Customize Windows VM Properties, computer name
Customize Windows VM Properties, Domain
6-30
Customize Windows VM Properties, License
6-31
Customize Windows VM Properties, Network
6-28
Datacenter Properties, Enumerate Datastores
Datacenter Properties, Enumerate Networks
6-32
8-3
6-45
6-44
7-14
Defining the Power Off Virtual Machine Activity
8-6
Defining the Power On Virtual Machine Activity
8-8
Defining the Power Up Host from Standby Activity
7-17
Defining the Query Host Network Adapters Activity
7-19
7-21, 7-25
Defining the Query Host Storage Adapters Activity
6-41
7-23
Defining the Query Virtual Machine Properties
Activity 6-52
Defining the Query Virtual Machine Snapshot
Activity 9-6
Defining the Query VM Devices Activity
5-2
Defining a VMware ESX Server Target
6-43
Defining the Exit VM Host Maintenance Mode
Activity 7-11
Defining the Query Host Properties Activity
6-39
Datacenter Properties, Enumerate Resource Pools
3-4
6-40
Defining the Power Down Host to Standby Activity
D
Defining a Runtime User Account
6-38
Defining the Migrate Virtual Machine Activity
6-33
Customize Windows VM Properties, Run Once
2-12
Defining the Enumerate Datastores Activity
Defining the Execute PowerCLI Script Activity
6-27
Defining Activity Target Criteria
Defining the Enter VM Host Maintenance Mode
Activity 7-9
Defining the Enumerate Resource Pools Activity
6-26
6-27
6-35
Defining the Enumerate Networks Activity
6-24
Customize Linux VM Properties, Time Zone
Customize Windows VM Activity
6-25
6-10
6-13
Defining the Customize Linux VM Activity
9-4
5-3
Defining a VMware Activity
6-4
Defining the Clone Virtual Machine Activity
6-19
9-3
Credential properties
7-7
Defining the Add VM Network Adapter Activity
3-4
Create Snapshot Properties
7-3
Defining the Add VM Hard Disk Activity
6-17
Create New VM Properties
4-19
Defining the Add Host Port Group Activity
Create a VMware Virtual Machine Power Event
trigger 4-12
4-12
Defining the Query VM Network Adapters Activity
2-5
Defining a VMware Host Performance Event Trigger
Defining a VMware Virtual Center Server Target
6-48
2-8
4-4
Defining the Query VMs Activity
Defining the Reboot Guest Activity
6-50
6-54
8-11
Defining the Reboot Virtual Machine Host Activity
7-27
Cisco TEO Adapter Guide for VMware
IN-2
OL-24933-02
Index
Defining the Reconfigure Virtual Machine Activity
Defining the Relocate Virtual Machine Activity
Defining the Remove All Snapshots Activity
Defining the Remove ESX Host Activity
Defining the Rename Snapshot Activity
9-14
Extended property values, modify
8-20
6-64
7-11
2-19
H
Hard Disk Settings, Existing Virtual Disk
6-7
Hard Disk Settings, Raw Device Mappings
6-67
Hard Disk Settings Properties
History, Runtime User
Host Instance results
6-8
6-65
3-5
5-12
Host Performance Event properties
6-36
4-5
4-21
Details Pane, Runtime User
disable a target
7-12
7-35
Defining the Upgrade VM Network Adapter Activity
Deleting triggers
8-4
Exit VM Host Maintenance Mode Activity
8-18
Defining the Upgrade Virtual Machine Tools
Activity 6-72
Delete VM Properties
2-6
8-3
Exit Host Maintenance Mode Properties
7-32
6-44
2-5
Execute PowerCLI Script Properties
Defining the Upgrade Virtual Machine Hardware
Activity 6-70
6-35
ESX Target, defining
Execute PowerCLI Script, defining
8-15
Defining the Update VM Hard Disk Activity
Delete VM Activity
6-41
6-43
ESX Server Target connection properties
8-13
9-17
Defining the Update Host Port Group Activity
3-6
6-79
Enumerate Resource Pools Properties, Datacenter
Defining the Suspend Virtual Machine Activity
Delete runtime user
6-40
Enumerate Resource Pools Activity
Defining the Revert to Current Snapshot Activity
Defining the Standby Guest Activity
6-39
Enumerate Networks Properties, Datacenter
9-12
Defining the Revert to Snapshot Activity
6-38
Enumerate Networks Activity Results
6-62
Defining the Reset Virtual Machine Activity
Defining the Shutdown Host Activity
Enumerate Networks Activity
9-8
9-10
Defining the Remove VM Device Activity
Enumerate Datastores Activity
Enumerate Datastores Properties, Datacenter
6-59
7-30
Defining the Remove Snapshot Activity
Defining the Shutdown Guest Activity
6-56
3-3
I
2-11
disable a trigger
Insert Variable Reference
4-15
Disabling a trigger
target
4-15
DNS and Domain Properties, Customize Linux VM
Domain Properties, Customize Windows VM
6-25
5-8
2-15
IP Address Settings, configure
6-76
6-30
K
E
Keystore Password, configuration
enable a target
Keystore Properties, VMware adapter
2-11
enable a trigger
Enabling a trigger
1-5
Knowledge Base article, trigger
4-15
1-5
4-8, 5-4
4-15
Enter Host Maintenance Mode Properties
7-9
Enter VM Host Maintenance Mode, defining
7-9
Cisco TEO Adapter Guide for VMware
OL-24933-02
IN-3
Index
Power Off Virtual Machine, defining
L
8-6
Power Off Virtual Machine Properties
License Properties, Customize Windows VM
6-31
Power On
8-7
8-9
Power On Virtual Machine, defining
M
Managing Runtime User Definitions
Managing Target Definitions
Managing Targets
8-9
Power Up Host from Standby Activity
7-17
7-18
Prerequisites, VMware
2-11
Properties, Add Host
2-1
Managing Trigger Definitions
5-5, 6-76
Migrate Virtual Machine Activity, defining
Migrate Virtual Machine Properties
Modifying a VMware Activity
6-45
7-4
Properties, Add VM Hard Disk
5-5
2-19
4-15
3-6
7-7
6-4
Properties, Clone Virtual Machine
Properties, Create Folder
6-46
Modifying Extended Property Values
Modify runtime user definition
1-6
Properties, Add Host Port Group
4-15
Managing VMware Activity Definitions
Modifying triggers
Power On Virtual Machine Properties
Power Up Properties
3-6
8-8
6-14
6-17
Properties, Create New VM
6-19
Properties, Create Snapshot
9-4
Properties, credentials
5-3
Properties, Delete VM
6-36
Properties, Enter Maintenance Mode
Properties, ESX Target
N
7-9
2-6
Properties, Execute PowerCLI Script
8-4
Properties, Exit Maintenance Mode
7-12
Network Adapter Settings Properties, Add VM Network
Adapter 6-11
Properties, Host Performance Event
4-5
Network properties, configure
Properties, Migrate Virtual Machine
Network Adapter Settings Properties
6-68
6-77
Network Properties, Customize Linux VM
6-24
Network Properties, Customize Windows VM
Normal Operators
2-14
6-33
Properties, Maintenance Mode
Properties, Power Down
7-9, 7-12
6-46
7-15
Properties, Power Off Virtual Machine Host
Properties, Power On Virtual Machine
Properties, Power Up
Properties, Provides
P
8-7
8-9
7-18
1-7
Properties, Query Host Network Adapters Properties
Performance event host properties
Performance event properties
Port Group Properties
PowerCLI Script
4-5
Properties, Query Host Properties
4-10
Properties, Query Hosts
7-7
7-22
7-26
Properties, Query Host Storage Adapters Properties
8-4
Properties, Query Virtual Machine
Power Down Host to Standby Activity
7-14
Properties, Query Virtual Machine Snapshot
7-15
Properties, Query VM Network Adapters
Power Event properties
4-13
Properties, Query VMs
Power Off
8-1
8-7
Properties, Reboot Guest
7-24
6-52
Power Down Properties
Power Management Activities
7-20
9-7
6-51
6-54
8-11
Properties, Reboot Virtual Machine Host
7-28
Cisco TEO Adapter Guide for VMware
IN-4
OL-24933-02
Index
Properties, Reconfigure Virtual Machine
Properties, Relocate Virtual Machine
Properties, Remove All Snapshots
Properties, Remove ESX Host
Properties, Rename Snapshot
Query Host Storage Adapters
Query Virtual Machine
Query Virtual Machines
5-4
Properties, Revert to Snapshots
Properties, Shutdown Host
Properties, Standby Guest
6-82
Query Virtual Machine Snapshot Activity, defining
Query Virtual Machine Snapshot Properties
8-16
Query VM Devices Activity
7-33
Query VM Network Adapters
8-21
9-7
6-51
6-84
Query VM Network Adapters Activity, defining
5-2
Properties, Update Host Port Group
Query VM Network Adapters Activity Results
7-36
Properties, Update VM Hard Disk Settings
Properties, Update VM Network Adapter
Properties, Upgrade Virtual Machine Tools
6-73
Reboot Guest
Properties, Virtual Machine Power Event
Properties, VMware adapter history
4-10
4-13
8-11
Reboot Guest, defining
Reboot Guest Properties
1-8
Reboot Host
Properties, VMware adapter prerequisites
6-54
R
2-9
Properties, Virtual Machine Performance Event
6-84
6-71
4-2
Properties, Virtual Center Target
1-6
8-11
8-11
7-28
Reboot Virtual Machine Host Activity, defining
Reboot Virtual Machine Host Properties
Reconfigure Virtual Machine Properties
Properties
Relocate Virtual Machine Properties
7-21
Storage Adapters Properties
Query Host Network Adapter Activity Results
Query Host Network Adapters
7-19
Query Host Network Adapters Properties
Query Host Properties
7-22
Query Host Properties Activity
Remove All Snapshots Properties
Remove ESX Host Activity
7-37
Query Host Network Adapters Activity
7-37
7-21, 7-25
7-20
Remove ESX Host Properties
6-59
6-59
Remove All Snapshots Activity, defining
7-24
6-56
6-57
Relocate Virtual Machine Activity, defining
7-22
7-27
7-28
Reconfigure Virtual Machine Activity, defining
Q
Query Host
6-50
6-54
Query VMs Activity, defining
6-68
Properties, Upgrade Virtual Machine Hardware
Properties, viewing triggers
Query VMs
6-65
9-6
6-48
Query VM Network Adapter Properties
8-18
6-52
6-82
Query Virtual Machines Activity Results
9-15
9-18
Properties, Suspend Virtual Machine
Properties, Target
6-52
Query Virtual Machine Properties Activity, defining
8-14
Properties, Revert to Current Snapshot
7-23
9-6
Query Virtual Machine Properties
9-13
7-39
7-24, 7-39
Query Host Storage Adapters Activity
6-63
Properties, Reset Virtual Machine
Properties, Shutdown Guest
7-40
Query Host Storage Adapter Activity Results
9-9
9-11
Properties, Remove VM Device
7-26
Query Hosts Results
6-59
7-31
Properties, Remove Snapshot
Properties, result handler
Query Hosts
6-57
9-8
9-9
7-30
7-31
Remove Snapshot Activity, defining
Remove Snapshot Properties
9-11
Remove VM Device Activity
6-62
9-10
Cisco TEO Adapter Guide for VMware
OL-24933-02
IN-5
Index
Remove VM Device Properties
Shutdown Guest Properties
6-63
Rename Snapshot Activity, defining
Rename Snapshot Properties
Reset properties
Shutdown Host
9-12
8-16
7-33
Shutdown Host Activity, defining
9-13
Shutdown Host Properties
8-14
Reset Virtual Machine Activity, defining
Reset Virtual Machine Properties
Resource Pools Results
Snapshot
8-13
Snapshots
6-80
Result handler properties
7-33
9-4, 9-7, 9-9, 9-11, 9-13, 9-15, 9-18
Snapshot Management Activities
8-14
Results
9-1
9-8
Specifying performance counters
5-4
7-32
4-20
Specifying target using algorithm criteria
Host Instance
Standby Guest
5-12
Query Host Network Adapters
Query Hosts
Standby Guest Properties
7-40
Query Host Storage Adapters
Query Virtual Machines
Status indicators
7-39
Revert to Current Snapshot Activity, defining
Revert to Current Snapshot Properties
9-15
Revert to Snapshot Activity, defining
9-17
Revert to Snapshot Properties
9-14
Runtime user
Suspend Virtual Machine Properties
6-32
Target, trigger
3-4
3-5
Delete a Target
3-7
Target properties
runtime user, viewing used by object
3-6
2-17
5-2
Targets
3-3
Runtime User history, viewing
Creating a Copy of a Target Definition
3-5
Disabling a target
3-1
3-2
2-11
Extended Properties
3-4
Member of
Runtime Users, Actions menu and toolbar
3-3
2-12
2-3
Used by, targets
S
2-18
2-18
Modify targets
Properties
2-19
Viewing target history
Selecting Performance Counters
Shutdown Guest
4-20
Shutdown Guest Activity, defining
8-15
2-20
Targets, viewing extended properties
targets, viewing history
8-16
2-17
2-11
Enabling a target
Definitions - Runtime users
Runtime User Properties
2-4
Target Groups
runtime user, viewing history
Runtime Users
8-21
2-4
Target descriptions
3-6
Runtime User Details Pane
8-20
4-6
Target Algorithms
Runtime User, Used by
1-7
T
9-18
Run Once Properties, Customize Windows VM
runtime user, deleting
5-11
Suspend Virtual Machine Activity, defining
5-14
Creating, Defining
8-18
supported adapter objects
6-84
8-18
5-11
status indicators, color
6-82
Query VM Network Adapters
VM Instance
8-18
Standby Guest Activity, defining
7-37
2-12, 4-19
2-18
2-20
Targets, viewing members of
2-18
Cisco TEO Adapter Guide for VMware
IN-6
OL-24933-02
Index
targets, viewing used by objects
Targets Detail Pane
Targets
2-19
Viewing Activity Instance Information
2-3
Target variable references
2-16
Viewing Activity Instance Properties
2-16
Time Zone Properties, Customize Linux VM
6-26
Viewing Activity Status
5-11, 7-37
5-12
5-11
trigger, disable
4-15
Viewing Enumerate Networks Activity Results
trigger, enable
4-15
Viewing Enumerate Resource Pools Activity Results
Trigger Descriptions
Viewing Host Instance Information
4-3
Trigger knowledge base article
Triggers
Viewing runtime user history
4-1
Triggers, conditions
Triggers, delete
Viewing trigger properties
4-21
Triggers, modify
Trigger target
Viewing target properties
4-7
2-3
4-2
Viewing VMware adapter history
4-6
7-40
3-7
Viewing VM Instance Information
4-15
5-14
1-8
Viewing VMware Adapter Prerequisites
1-6
Viewing VMware Adapter-Supported Objects
U
1-7
Viewing VMware Configuration Activity Results
Update Host Port Group
viewing VMware objects, provides
7-36
Update Host Port Group Activity
Update Host Port Group Properties
Update VM Hard Disk Activity
Upgrade Tools
View runtime user history
7-35
views, runtime users
7-36
Upgrade Virtual Machine Hardware Activity
6-70
Upgrade Virtual Machine Hardware Properties
Upgrade Virtual Machine Tools Activity
6-72
Upgrade Virtual Machine Tools Properties
Upgrade VM Network Adapter Activity
Used by runtime user
1-7
3-2
2-8
Virtual Center Target connection properties
6-73
6-73
6-67
Using VMware Configuration Activities
Using VMware Hosts Activities
Virtual Machine Power Event properties
VM Instance results
VMware Activities
5-1
6-2, 7-2, 8-2, 9-2
Using VMware Snapshot Activities
VMware Activity, modify
VMware adapter history
8-1
9-1
5-2
5-5
6-2, 7-2, 8-2, 9-2
1-8
VMware adapter Keystore properties
VMware adapter prerequisites
1-5
1-6
VMware adapter prerequisites, viewing
V
1-6
VMware adapter properties, viewing, accessing
variable reference, insert
Variable references
Activity
5-9
2-15, 5-8
6-48
5-14
VMware Activity Definitions
7-1
Using VMware Power Activities
6-1
4-10
4-13
Virtual Machine Properties, Query VM Devices
VMware Activity, define
5-1
2-9
Virtual Machine Performance Event properties
VMware activities
3-5, 3-6
Using VMware Activities
6-71
6-78
3-5
Virtual Center Target, defining
6-64
6-80
5-12
Viewing Query Hosts Activity Results
4-8, 5-4
6-79
VMware Command Line Options
1-3
6-74
VMware ESX Server Target properties
VMware Host Management Activities
2-6
7-1
VMware Host Performance Event, defining
4-4
Cisco TEO Adapter Guide for VMware
OL-24933-02
IN-7
Index
VMware Performance Event trigger, selecting
performance counters 4-20
VMware Triggers
4-1
VMware Virtual Center Server Target properties
2-9
W
Wildcard expressions
4-3
Windows User properties
3-4
Cisco TEO Adapter Guide for VMware
IN-8
OL-24933-02