How it Works
VMware
Loading...
V
W
Loading...
Loading...
vRealize Orchestrator - 6.0
User’s Manual
136 pgs1.84 Mb0
User’s Manual
100 pgs1.35 Mb0
User’s Manual
216 pgs2.87 Mb0
Installation Manual
38 pgs724.97 Kb0
Installation Manual
118 pgs1.63 Mb0
Table of contents
Loading...

VMware vRealize Orchestrator - 6.0 User’s Manual

Using VMware vRealize Orchestrator
Plug-Ins
vRealize Orchestrator 6.0
This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document, see http://www.vmware.com/support/pubs.
EN-001380-00
You can find the most up-to-date technical documentation on the VMware Web site at:
http://www.vmware.com/support/
The VMware Web site also provides the latest product updates.
If you have comments about this documentation, submit your feedback to:
docfeedback@vmware.com
Copyright © 2008–2015 VMware, Inc. All rights reserved. Copyright and trademark information.
VMware, Inc.
3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com
2 VMware, Inc.

Contents

Using VMware vRealize Orchestrator Plug-Ins 9
Introduction to Orchestrator Plug-Ins 11
1
Orchestrator Architecture 11
Plug-Ins Installed with the Orchestrator Server 12
Access the Orchestrator API Explorer 15
Configure the Orchestrator Plug-Ins 17
2
Using the vCenter Server Plug-In 19
3
Configuring the vCenter Server Plug-In 19
Configuration Workflows 19
Configure the Connection to a vCenter Server Instance 20
vCenter Server Plug-In Scripting API 21
Using the vCenter Server Plug-In Inventory 21
Access the vCenter Server Plug-In Workflow Library 21
vCenter Server Plug-In Workflow Library 22
Batch Workflows 24
Cluster and Compute Resource Workflows 25
Configuration Workflows 25
Custom Attributes Workflows 26
Datacenter Workflows 26
Datastore and Files Workflows 27
Datacenter Folder Management Workflows 27
Host Folder Management Workflows 27
Virtual Machine Folder Management Workflows 28
Guest Operation Files Workflows 28
Guest Operation Processes Workflows 29
Power Host Management Workflows 29
Basic Host Management Workflows 29
Host Registration Management Workflows 30
Networking Workflows 30
Distributed Virtual Port Group Workflows 30
Distributed Virtual Switch Workflows 31
Standard Virtual Switch Workflows 31
Networking Virtual SAN Workflows 32
Resource Pool Workflows 32
Storage Workflows 32
Storage DRS Workflows 33
Storage VSAN Workflows 34
Basic Virtual Machine Management Workflows 34
VMware, Inc.
3
Clone Workflows 35
Linked Clone Workflows 36
Linux Customization Clone Workflows 36
Tools Clone Workflows 37
Windows Customization Clone Workflows 37
Device Management Workflows 38
Move and Migrate Workflows 38
Other Workflows 39
Power Management Workflows 40
Snapshot Workflows 41
VMware Tools Workflows 41
Using the Configuration Plug-In 43
4
Access the Configuration Plug-In Workflow Library 43
Configuration Plug-In Workflow Library 43
Using the vCO Library Plug-In 47
5
vCO Library Plug-In Workflows 47
Using the SQL Plug-In 49
6
Configuring the SQL Plug-In 49
SQL Plug-In Configuration Workflows 49
Add a Database 50
Add Tables to a Database 50
Update a Database 51
Running the SQL Sample Workflows 52
Generate a JDBC URL 52
Test a JDBC Connection 52
Create a Table by Using JDBC 53
Insert a Row into a JDBC Table 53
Select Rows from a JDBC Table 54
Delete an Entry from a JDBC Table 54
Delete All Entries from a JDBC Table 55
Drop a JDBC Table 55
Run a Complete JDBC Cycle 56
Using the SQL Plug-In Standard Workflows 56
SQL Plug-In Workflow Library 56
Generate CRUD Workflows for a Table 57
Using the SSH Plug-In 59
7
Configure the SSH Plug-In 59
Running the SSH Plug-In Sample Workflows 59
Generate a Key Pair 60
Change the Key Pair Passphrase 61
Register an Orchestrator Public Key on an SSH Host 61
Run an SSH Command 61
Copy a File from an SSH Host 62
Copy a File to an SSH Host 63
4 VMware, Inc.
Contents
Using the XML Plug-In 65
8
Running the XML Plug-In Sample Workflows 65
Create a Simple XML Document 66
Find an Element in an XML Document 66
Modify an XML Document 67
Create an Example Address Book from XML 67
Using the Mail Plug-In 69
9
Define the Default SMTP Connection 69
Using the Mail Plug-In Sample Workflows 70
Access the Mail Plug-In Sample Workflows 70
Mail Plug-In Sample Workflows 70
Test an Example Interaction with Email 71
Using the Net Plug-In 73
10
Using the Enumeration Plug-In 75
11
Time Zone Codes 75
Using the Workflow Documentation Plug-In 79
12
Workflow Library for the Workflow Documentation Plug-In 79
Generate Workflow Documentation 79
Using the HTTP-REST Plug-In 81
13
Configuring the HTTP-REST Plug-In 81
Configuration Workflows 81
Configure Kerberos Authentication 82
Add a REST Host 82
Add a REST Operation 83
Add a Schema to a REST Host 84
Generate a New Workflow from a REST Operation 84
Invoke a REST Operation 85
Using the SOAP Plug-In 87
14
Configuring the SOAP Plug-In 87
Configuration Workflows 87
Add a SOAP Host 88
Configure Kerberos Authentication 89
Generate a New Workflow from a SOAP Operation 90
Test a Custom-Generated Workflow 90
Invoke a SOAP Operation 91
Using the AMQP Plug-In 93
15
Configuring the AMQP Plug-In 93
Configuration Workflows 93
Add a Broker 93
VMware, Inc. 5
Subscribe to Queues 94
Update a Broker 95
Using the AMQP Plug-In Standard Workflows 95
Declare a Binding 95
Declare a Queue 96
Declare an Exchange 97
Send a Text Message 97
Delete a Binding 98
Using the SNMP Plug-In 99
16
Managing SNMP Devices 99
Device Management Workflows 99
Register an SNMP Device 100
Managing SNMP Queries 100
Query Management Workflows 100
Add a Query to an SNMP Device 101
Managing the SNMP Trap Host 101
Trap Host Management Workflows 102
Set the SNMP Trap Port 102
Receiving SNMP Traps 102
Wait for a Trap on an SNMP Device 102
Set a Trap Policy 103
Edit a Trap Policy 103
Generic SNMP Request Workflows 104
Using the Active Directory Plug-In 105
17
Configuring the Active Directory Plug-In 105
Active Directory Configuration Workflows 105
Using the Active Directory Plug-In Workflow Library 105
Using the Active Directory Plug-In Inventory 106
Access the Active Directory Plug-In Workflow Library 106
Active Directory Plug-In Workflows 106
Using the Dynamic Types Plug-In 109
18
Dynamic Types Configuration Workflows 109
Using the PowerShell Plug-In 111
19
Using the PowerShell Plug-In Inventory 111
Configuring the PowerShell Plug-In 112
Configuration Workflows 112
Configure Kerberos Authentication 112
Add a PowerShell Host 113
Running PowerShell Scripts 114
Invoke a PowerShell Script 114
Invoke an External Script 114
Generating Actions 115
Generate an Action from a PowerShell Script 115
Generate an Action for a PowerShell Cmdlet 116
6 VMware, Inc.
Passing Invocation Results Between Actions 117
PowerCLI Integration with the PowerShell Plug-In 117
Converter Workflows 117
Sample Workflows 117
Access the PowerShell Plug-In API 118
Working with PowerShell Results 118
Examples of Scripts for Common PowerShell Tasks 119
Troubleshooting 121
Servers Not Found in Kerberos Database 121
Unable to Obtain a Kerberos Ticket 121
Kerberos Authentication Fails Due to Time Differences 121
Kerberos Authentication Session Mode Fails 122
Unable to Reach a Key Distribution Center for a Realm 122
Contents
Using the Multi-Node Plug-In 123
20
Introduction to the vRealize Orchestrator Multi-Node Plug-In 123
Configuring the Multi-Node Plug-In 124
Servers Configuration Workflows 124
Add an Orchestrator Server 124
Using Proxy Workflows 125
Synchronous Proxy Workflows 125
Asynchronous Proxy Workflows 126
Remote Execution Workflows 126
Using the Multi-Node Plug-In Inventory 127
Remote Management Workflows 127
Access the Multi-Node Plug-In API 128
Multi-Node Plug-In Use Cases 128
Create a Multi-Proxy Action 128
Maintenance of Remote and Proxy Workflows 130
Deploy a Package from a Local Server 130
Index 133
VMware, Inc. 7
8 VMware, Inc.

Using VMware vRealize Orchestrator Plug-Ins

Using VMware vRealize Orchestrator Plug-Ins provides information and instructions about configuring and using the standard set of plug-ins installed with VMware® vRealize Orchestrator.
Intended Audience
This information is intended for advanced vSphere administrators and experienced system administrators who are familiar with virtual machine technology and datacenter operations.
VMware, Inc. 9
10 VMware, Inc.

Introduction to Orchestrator Plug-Ins 1

With the Orchestrator plug-ins, you can access and control external technologies and applications. Exposing an external technology in an Orchestrator plug-in lets you incorporate objects and functions in workflows and run workflows on the objects of that external technology.
The external technologies that you access by using plug-ins include virtualization management tools, email systems, databases, directory services, and remote control interfaces.
Orchestrator provides a standard set of preinstalled plug-ins, which expose the VMware vCenter Server API, email and authentication capabilities, and other technologies. In addition, the Orchestrator open plug­in architecture lets you to develop plug-ins to access other applications. Orchestrator implements open standards to simplify integration with external systems. For information about developing custom content, see Developing with VMware vRealize Orchestrator.
The standard set of plug-ins is automatically installed with the Orchestrator server. You might need to configure some of the plug-ins, for example the vCenter Server plug-in, before start using them.
Plug-ins extend the Orchestrator scripting engine with new object types and methods, and plug-ins publish notification events from the external system that triggers events in Orchestrator and in the plugged-in technology. Plug-ins provide an inventory of JavaScript objects that you can access on the Inventory tab of the Orchestrator client. Each plug-in contains packages of workflows and actions that you can run on the objects in the inventory to automate the typical use cases of the integrated product.
This chapter includes the following topics:
“Orchestrator Architecture,” on page 11
n
“Plug-Ins Installed with the Orchestrator Server,” on page 12
n
“Access the Orchestrator API Explorer,” on page 15
n

Orchestrator Architecture

Orchestrator contains a workflow library and a workflow engine to allow you to create and run workflows that automate orchestration processes. You run workflows on the objects of different technologies that Orchestrator accesses through a series of plug-ins.
Orchestrator provides a standard set of plug-ins, including a plug-in for vCenter Server, to allow you to orchestrate tasks in the different environments that the plug-ins expose.
Orchestrator also presents an open architecture to allow you to plug in external third-party applications to the orchestration platform. You can run workflows on the objects of the plugged-in technologies that you define yourself. Orchestrator connects to an authentication provider to manage user accounts, and to a database to store information from the workflows that it runs. You can access Orchestrator, the Orchestrator workflows, and the objects it exposes through the Orchestrator client interface, or through Web services.
VMware, Inc.
11
XML SSH SQL SMTP
3rd-party
plug-in
workflow engine
Orchestrator
database
vRealize
Orchestrator
Client application
Web services REST/SOAP
browser
access
Directory services
or vCenter
Single Sign On
vCenter
Server
vCenter
Server
workflow library
Figure 1‑1. VMware vRealize Orchestrator Architecture

Plug-Ins Installed with the Orchestrator Server

Orchestrator includes a collection of standard plug-ins. Each plug-in exposes an external product API to the Orchestrator platform. Plug-ins provide inventory classes, extend the scripting engine with new object types, and publish notification events from the external system. Each plug-in also provides a library of workflows for automating the typical use cases of the integrated product.
You can see the list of the installed plug-ins on the Plug-ins tab in the Orchestrator configuration interface. For the plug-ins that require configuration, there are separate tabs in the interface.
Table 1‑1. Plug-Ins Installed with Orchestrator
Plug-In Purpose Configuration
vCenter Server Provides access to the vCenter Server API so that you can
incorporate all of the vCenter Server objects and functions into the management processes that you automate by using Orchestrator.
Configuration Provides workflows for configuring the Orchestrator
authentication, database connection, SSL certificates, and so on.
vCO Library Provides workflows that act as basic building blocks for
customization and automation of client processes. The workflow library includes templates for lifecycle management, provisioning, disaster recovery, hot backup, and other standard processes. You can copy and edit the templates to modify them according to your needs.
SQL Provides the Java Database Connectivity (JDBC) API,
which is the industry standard for database-independent connectivity between the Java programming language and a wide range of databases. The databases include SQL databases and other tabular data sources, such as spreadsheets or flat files. The JDBC API provides a call­level API for SQL-based database access from workflows.
See “Configuring the vCenter Server
Plug-In,” on page 19.
None
None
None
12 VMware, Inc.
Chapter 1 Introduction to Orchestrator Plug-Ins
Table 1‑1. Plug-Ins Installed with Orchestrator (Continued)
Plug-In Purpose Configuration
SSH Provides an implementation of the Secure Shell v2 (SSH-2)
protocol. Allows remote command and file transfer sessions with password and public key-based authentication in workflows. Supports keyboard­interactive authentication. Optionally, the SSH plug-in can provide remote file system browsing directly in the Orchestrator client inventory.
XML A complete Document Object Model (DOM) XML parser
that you can implement in workflows. Alternatively, you can use the ECMAScript for XML (E4X) implementation in the Orchestrator JavaScript API.
Mail Uses Simple Mail Transfer Protocol (SMTP) to send email
from workflows.
Net Wraps the Jakarta Apache Commons Net Library. Provides
implementations of Telnet, FTP, POP3, and IMAP. The POP3 and IMAP part is used for reading email. In combination with the Mail plug-in, the Net plug-in provides complete email sending and receiving capabilities in workflows.
Workflow documentation Provides workflows that let you generate information in
PDF format about a workflow or a workflow category.
Enumeration Provides common enumerated types that can be used in
workflows by other plug-ins.
HTTP-REST Lets you manage REST Web services by providing
interaction between vRealize Orchestrator and REST hosts.
SOAP Lets you manage SOAP Web services by providing
interaction between vRealize Orchestrator and SOAP hosts.
AMQP Lets you interact with Advanced Message Queuing
Protocol (AMQP) servers also known as brokers.
SNMP Enables vRealize Orchestrator to connect and receive
information from SNMP-enabled systems and devices.
Active Directory Provides interaction between vRealize Orchestrator and
Microsoft Active Directory.
Dynamic Types Lets you define dynamic types and create and use objects
of these dynamic types.
Multi-Node Contains workflows for hierarchical orchestration,
management of Orchestrator instances, and scale-out of Orchestrator activities.
PowerShell Lets you manage PowerShell hosts and run custom
PowerShell operations.
See “Configure the SSH Plug-In,” on page 59.
None
Set the default values for the EmailMessage object to use.
See “Define the Default SMTP
Connection,” on page 69.
None
None
None
See “Configuring the HTTP-REST
Plug-In,” on page 81.
See “Configuring the SOAP Plug-
In,” on page 87.
See “Configuring the AMQP Plug-
In,” on page 93.
None
See “Configuring the Active
Directory Plug-In,” on page 105.
See Chapter 18, “Using the Dynamic
Types Plug-In,” on page 109.
See Chapter 20, “Using the Multi-
Node Plug-In,” on page 123.
See Chapter 19, “Using the
PowerShell Plug-In,” on page 111.
Plug-In Components
Each plug-in is a DAR file package. The DAR files are stored in Orchestrator_installation_path\app-
server\plugins on the Orchestrator server system. The components of each plug-in, such as workflow
categories and API modules, use different naming conventions.
VMware, Inc. 13
Table 1‑2. Names of Plug-In Components
Plug-In Name in the Configuration UI DAR File
vCenter Server
vRO Configuration
vCO Library
SQL
SSH
XML
Mail
Net
Workflow documentation
Common enumerated types
Dynamic Types
HTTP-REST Configuration
SOAP
AMQP
SNMP
Active Directory Computer
Orchestrator Servers
PowerShell
o11nplugin-vsphere.dar
o11nplugin-configurator.dar
o11nplugin-library.dar
o11nplugin-database.dar
o11nplugin-ssh.dar
o11nplugin-xml.dar
o11nplugin-mail.dar
o11nplugin-jakartacommonsnet.dar
o11nplugin-wfdocs.dar
o11nplugin-enums.dar
o11n-plugin-dynamictypes.dar
o11n-plugin-soap.dar
o11n-plugin-amqp.dar
o11n-plugin-snmp.dar
o11nplugin-powershell.dar
Workflow Categories API Module
vCenter
Configuration
Locking
VC
Configurator
Not applicable.
Orchestrator
Troubleshooting
JDBC
SQL
SQL
SSH
XML
Mail
None
Workflow
SSH
XML
Mail
Net
Workflow documentation
documentation
None
Configuration
Enums
DynamicTypes
REST
Configuration
Configuration
Device
SOAP
AMQP
SNMP
Management
Query Management
Trap Host Management
AD
Configuration
Organizational Unit
User
User Group
VCO
Configuration
Remote Execution
Remote Management
Tasks
Workflows
Configuration
PowerShell
Generate
Templates
14 VMware, Inc.

Access the Orchestrator API Explorer

Orchestrator provides an API Explorer that you can use to search the Orchestrator API and see the documentation for JavaScript objects that you can use in scripted elements.
You can consult an online version of the Scripting API for the vCenter Server plug-in on the Orchestrator documentation home page.
Procedure
1 Log in to the Orchestrator client.
2 Select Tools > API Explorer.
The API Explorer appears. You can use it to search all the objects and functions of the Orchestrator API.
What to do next
Use the API Explorer to write scripts for scriptable elements.
Chapter 1 Introduction to Orchestrator Plug-Ins
VMware, Inc. 15
16 VMware, Inc.

Configure the Orchestrator Plug-Ins 2

To deploy the standard set of plug-ins when the Orchestrator server starts, the Orchestrator system must authenticate against an LDAP or vCenter Single Sign-On server. You first specify the administrative credentials that Orchestrator uses with the plug-ins, and enable or disable plug-ins.
If you change the Orchestrator database after configuring and installing the plug-ins, you must click the
Reset current version link on the Troubleshooting tab. This operation deletes the install_directory\app-
server\conf\plugins\_VSOPluginInstallationVersion.xml file, which contains information about the
version of the plug-ins already installed, and forces plug-in reinstallation.
Prerequisites
Set up an LDAP or vCenter Single Sign-On server and configure the Orchestrator authentication settings.
Procedure
1 Log in to the Orchestrator configuration interface as vmware.
2 Click Plug-ins.
3 Type the credentials for a user who is a member of the Orchestrator administrators group that you
specified on the Authentication tab.
When the Orchestrator server starts, the system uses these credentials to set up the plug-ins. The system checks the enabled plug-ins and performs any necessary internal installations such as package import, policy run, script launch, and so on.
VMware, Inc.
4 (Optional) To disable a plug-in, deselect the check box next to it.
This action does not remove the plug-in file.
5 Click Apply changes.
The first time the server starts, it installs the selected plug-ins.
What to do next
You can configure the settings for Mail and SSH plug-ins.
17
18 VMware, Inc.

Using the vCenter Server Plug-In 3

You can use the vCenter Server plug-in to manage multiple vCenter Server instances. You can create workflows that use the vCenter Server plug-in API to automate tasks in your vCenter Server environment.
The vCenter Server plug-in maps the vCenter Server API to the JavaScript that you can use in workflows. The plug-in also provides actions that perform individual vCenter Server tasks that you can include in workflows.
The vCenter Server plug-in provides a library of standard workflows that automate vCenter Server operations. For example, you can run workflows that create, clone, migrate, or delete virtual machines.
This chapter includes the following topics:
“Configuring the vCenter Server Plug-In,” on page 19
n
“vCenter Server Plug-In Scripting API,” on page 21
n
“Using the vCenter Server Plug-In Inventory,” on page 21
n
“Access the vCenter Server Plug-In Workflow Library,” on page 21
n
“vCenter Server Plug-In Workflow Library,” on page 22
n

Configuring the vCenter Server Plug-In

Before managing the objects in your vSphere inventory by using Orchestrator and to run workflows on the objects, you must configure the vCenter Server plug-in and define the connection parameters between Orchestrator and the vCenter Server instances you want to orchestrate.
You can configure the vCenter Server plug-in by running the vCenter Server configuration workflows from the Orchestrator client.
To manage the objects in your vSphere inventory by using the vSphere Web Client, make sure that you configure the Orchestrator server to work with the same vCenter Single Sign-On instance to which both vCenter Server and vSphere Web Client are pointing. You must also ensure that Orchestrator is registered as a vCenter Server extension. You register Orchestrator as a vCenter Server extension when you specify a user (by providing the user name and password), who has the privileges to manage vCenter Server extensions.

Configuration Workflows

The Configuration workflow category of the vCenter Server plug-in contains workflows that let you manage the connections to vCenter Server instances.
You can access these workflows from Library > vCenter > Configuration in the Workflows view of the Orchestrator client.
VMware, Inc.
19
Workflow Name Description
Add a vCenter Server instance Configures Orchestrator to connect to a new vCenter Server instance so that you
can run workflows over the objects in the vSphere infrastructure.
List the vRealize Orchestrator extensions of vCenter Server
Register Orchestrator as a vCenter Server extension
Remove a vCenter Server instance Removes a vCenter Server instance from the Orchestrator inventory. You will no
Update a vCenter Server instance Updates the connection to a vCenter Server instance. For example, if the IP
Unregister a vCenter Server extension
Lists all vRealize Orchestrator extensions of vCenter Server.
Registers the Orchestrator instance as a vCenter Server extension.
longer be able to orchestrate this vCenter Server instance.
address of your vCenter Server system changes, you must update the connection parameters to the vCenter Server instance so that you can manage your vSphere inventory with Orchestrator.
Unregisters a vSphere Web Client extension.

Configure the Connection to a vCenter Server Instance

In addition to configuring the vCenter Server plug-in by using the Orchestrator configuration interface, you can configure the connections to vCenter Server instances by running the vCenter Server configuration workflows in the Orchestrator client.
Procedure
1 Log in to the Orchestrator client as an administrator.
2 Click the Workflows view in the Orchestrator client.
3 In the workflows hierarchical list, select Library > vCenter > Configuration and navigate to the Add a
vCenter Server instance workflow.
4 Right-click the Add a vCenter Server instance workflow and select Start workflow.
5 Type the IP address or the DNS name of the machine on which the vCenter Server instance you want to
add is installed.
6 Retain the default port value, 443.
7 Keep the default location of the SDK to use to connect to your vCenter Server instance.
8 Select whether you want to orchestrate the vCenter Server instance, and click Next.
9 Select whether you want to ignore certificates warnings for the vCenter Server instances you want to
add.
If you select Yes, the vCenter Server instance certificate is accepted silently and the certificate is added to the trusted store.
20 VMware, Inc.
Chapter 3 Using the vCenter Server Plug-In
10 Select the method you want to use to manage user access on the vCenter Server system.
Option Description
Share a unique session
Session per user
Allows Orchestrator to create only one connection to vCenter Server.
In the User name and Password text boxes, type the credentials for Orchestrator to use to establish the connection to the vCenter Server host.
The user that you select must be a valid user with privileges to manage vCenter Server extensions and a set of custom defined privileges. Orchestrator uses these credentials to monitor the vCenter Web service, typically to operate Orchestrator system workflows.
Creates a new session to vCenter Server. This might rapidly use CPU, memory, and bandwidth.
Select this option only if your vCenter Server is in an Active Directory domain or if vCenter Server Single Sign-On is enabled.
The user that you select must be a valid user with privileges to manage vCenter Server extensions.
The user account that you select is also used by the policy engine to collect statistical and other data. If the user that you select does not have enough privileges, the policy engine cannot access the necessary parts of the vCenter Server inventory and thus cannot collect the necessary data.
11 (Optional) Type the user domain.
You must specify the user domain name only when you select to use a shared session.
NOTE Fill this field if you are using LDAP authentication and session per user is selected.
12 Click Submit to run the workflow.
After the workflow runs successfully, the vCenter Server instance and all vSphere objects that belong to it appear in the Inventory view.

vCenter Server Plug-In Scripting API

The vCenter Server scripting API contains classes, with their respective attributes, methods, and constructors that allow interaction between vRealize Orchestrator and vCenter Server. You can use the API to develop custom workflows.
For a list of available API objects, see
http://www.vmware.com/support/orchestrator/doc/vro_vsphere60_api/index.html.

Using the vCenter Server Plug-In Inventory

The vCenter Server plug-in exposes all objects of the connected vCenter Server instances in the Inventory view. You can use the Inventory tab to add authorization elements or to run workflows on vCenter Server objects.
If you enable the Use contextual menu in inventory option from the Inventory tab of the User preferences tool, all of the workflows that you can run on the selected inventory object appear in a pop-up menu.

Access the vCenter Server Plug-In Workflow Library

You must use the Orchestrator client or the vSphere Web Client to access the elements from the vCenter Server plug-in workflow library.
Prerequisites
Configure a connection to a vCenter Server Instance.
n
Log in to the Orchestrator client as a user who can run vCenter Server workflows.
n
VMware, Inc. 21
Procedure
1 Log in to the Orchestrator client and select Design or Run from the drop-down menu in the left upper
corner.
2 Click the Workflows view in the Orchestrator client left pane.
3 Expand the hierarchical list to Library > vCenter.
What to do next
Review the workflow library.

vCenter Server Plug-In Workflow Library

The vCenter Server plug-in workflow library contains workflows that you can use to run automated processes related to the management of vCenter Server.
Batch Workflows on page 24
n
Batch workflows populate configuration elements or run workflows on a selected vCenter Server object.
Cluster and Compute Resource Workflows on page 25
n
With cluster and compute resource workflows, you can create, rename or delete a cluster, and enable or disable high availability, Distributed Resource Scheduler, and vCloud Distributed Storage on a cluster.
Configuration Workflows on page 25
n
The Configuration workflow category of the vCenter Server plug-in contains workflows that let you manage the connections to vCenter Server instances.
Custom Attributes Workflows on page 26
n
With custom attributes workflows, you can add custom attributes to virtual machines or get a custom attribute for a virtual machine.
Datacenter Workflows on page 26
n
With datacenter workflows, you can create, delete, reload, rename, or rescan a datacenter.
Datastore and Files Workflows on page 27
n
With datastore and files workflows, you can delete a list of files, find unused files in a datastore, and so on.
Datacenter Folder Management Workflows on page 27
n
With datacenter folder management workflows, you can create, delete, or rename a datacenter folder.
Host Folder Management Workflows on page 27
n
With host folder management workflows, you can create, delete, or rename a host folder.
Virtual Machine Folder Management Workflows on page 28
n
With virtual machine folder management workflows, you can create, delete, or rename a virtual machine folder.
Guest Operation Files Workflows on page 28
n
With guest operation files workflows, you can manage files in a guest operating system.
Guest Operation Processes Workflows on page 29
n
With guest operation processes workflows, you can get information and control the running processes in a guest operating system.
22 VMware, Inc.
Chapter 3 Using the vCenter Server Plug-In
Power Host Management Workflows on page 29
n
With power host management workflows you can reboot or shut down a host.
Basic Host Management Workflows on page 29
n
With basic host management workflows, you can put a host into maintenance mode, make a host exit maintenance mode, move a host to a folder or a cluster, and reload data from a host.
Host Registration Management Workflows on page 30
n
With host registration management workflows, you can add a host to a cluster, disconnect or reconnect a host from a cluster, and so on.
Networking Workflows on page 30
n
With networking workflows you can add a port group to distributed virtual switch, create a distributed virtual switch with a port group, and so on.
Distributed Virtual Port Group Workflows on page 30
n
With distributed virtual port group workflows you can update or delete a port group, and reconfigure the port group.
Distributed Virtual Switch Workflows on page 31
n
With distributed virtual switch workflows, you can create, update or delete a distributed virtual switch, and create, delete, or update a private VLAN.
Standard Virtual Switch Workflows on page 31
n
With standard virtual switch workflows you can create, update, or delete a standard virtual switch, and create, delete, or update port groups in standard virtual switches.
Networking Virtual SAN Workflows on page 32
n
With Virtual SAN workflows you can configure Virtual SAN network traffic.
Resource Pool Workflows on page 32
n
With resource pool workflows you can create, rename, reconfigure or delete a resource pool, and get resource pool information.
Storage Workflows on page 32
n
With storage workflows you can perform storage-related operations.
Storage DRS Workflows on page 33
n
With storage DRS workflows you perform storage-related operations, such as creating and configuring a datastore cluster, removing a datastore from cluster, adding storage to a cluster, and so on.
Storage VSAN Workflows on page 34
n
With Virtual SAN workflows you can manage non-SSD disks and disk groups in Virtual SAN cluster
Basic Virtual Machine Management Workflows on page 34
n
With basic virtual machine management workflows you can perform basic operations on virtual machines, for example, create, rename or delete a virtual machine, upgrade virtual hardware, and so on.
Clone Workflows on page 35
n
With clone workflows you can clone virtual machines with or without customizing the virtual machine properties.
Linked Clone Workflows on page 36
n
With linked clone workflows, you can perform linked clone operations such as restoring a virtual machine from a linked clone, creating a linked clone, and so on.
VMware, Inc. 23
Linux Customization Clone Workflows on page 36
n
With Linux customization workflows you can clone a Linux virtual machine and customize the guest operating system.
Tools Clone Workflows on page 37
n
With tools clone workflows you can obtain customization information about the operating system of the virtual machine, information needed to update a virtual device, and so on.
Windows Customization Clone Workflows on page 37
n
With Windows customization clone workflows you can clone Windows virtual machines and customize the guest operating system.
Device Management Workflows on page 38
n
With device management workflows you can manage the devices that are connected to a virtual machine or to a host datastore.
Move and Migrate Workflows on page 38
n
With move and migrate workflows, you can migrate virtual machines.
Other Workflows on page 39
n
With other workflows, you can enable and disable Fault Tolerance (FT), extract virtual machine information, and find orphaned virtual machines.
Power Management Workflows on page 40
n
With power management workflows, you can power on and off virtual machines, reboot the guest operating system of a virtual machine, suspend a virtual machine, and so on.
Snapshot Workflows on page 41
n
With snapshot workflows, you can perform snapshot-related operations.
VMware Tools Workflows on page 41
n
With VMware Tools workflows, you can perform VMware Tools-related tasks on virtual machines.

Batch Workflows

Batch workflows populate configuration elements or run workflows on a selected vCenter Server object.
You can access the batch workflows from Library > vCenter > Batch in the Workflows view of the Orchestrator client.
Fill batch configuration elements
Populates the configuration elements that the Run a workflow on a selection of objects workflow uses. Performs the following tasks:
Resets the BatchObject and BatchAction configuration elements.
n
Fills the BatchObject configuration element with all of the workflows
n
that have only one input parameter.
Fills the BatchAction configuration element with all of the actions that
n
have no input parameters or one input parameter and that have an array as the returnType.
Run a workflow on a selection of objects
Runs a workflow on a selection of vCenter Server objects, taking one action as input. This is the action that retrieves the list of objects on which to run the workflow. To return the objects without running the selected workflow, run the workflow in simulation mode.
24 VMware, Inc.
Chapter 3 Using the vCenter Server Plug-In

Cluster and Compute Resource Workflows

With cluster and compute resource workflows, you can create, rename or delete a cluster, and enable or disable high availability, Distributed Resource Scheduler, and vCloud Distributed Storage on a cluster.
You can access the cluster and compute resource workflows from Library > vCenter > Cluster and Compute Resource in the Workflows view of the Orchestrator client.
Add DRS virtual machine group to cluster
Add virtual machines to DRS group
Create cluster
Delete cluster
Disable DRS on cluster
Disable HA on cluster
Disable vCloud Distributed Storage on cluster
Enable DRS on cluster
Enable HA on cluster
Enable vCloud Distributed Storage on cluster
Remove virtual machine DRS group from cluster
Adds a DRS virtual machine group to a cluster.
Adds a virtual machine list to an existing DRS virtual machine group.
Creates a new cluster in a host folder.
Deletes a cluster.
Disables DRS on a cluster.
Disables high availability on a cluster.
Disables vCloud Distributed Storage on a cluster.
Enables DRS on a cluster.
Enables high availability on a cluster.
Enables vCloud Distributed Storage on a cluster.
Removes a DRS virtual machine group from a cluster.
Remove virtual machines from DRS group
Rename cluster
Removes virtual machines from a cluster DRS group.
Renames a cluster.

Configuration Workflows

The Configuration workflow category of the vCenter Server plug-in contains workflows that let you manage the connections to vCenter Server instances.
You can access these workflows from Library > vCenter > Configuration in the Workflows view of the Orchestrator client.
Add a vCenter Server instance
List the Orchestrator extensions of vCenter Server
VMware, Inc. 25
Configures Orchestrator to connect to a new vCenter Server instance so that you can run workflows over the objects in the vSphere infrastructure.
Lists all Orchestrator extensions of vCenter Server.
Register Orchestrator as a vCenter Server extension
Remove a vCenter Server instance
Update a vCenter Server instance
Unregister a vCenter Server extension
Registers the Orchestrator instance as a vCenter Server extension.
Removes a vCenter Server instance from the Orchestrator inventory. You will no longer be able to orchestrate this vCenter Server instance.
Updates the connection to a vCenter Server instance. For example, if the IP address of your vCenter Server system changes, you must update the connection parameters to the vCenter Server instance so that you can manage your vSphere inventory with Orchestrator.
Unregisters a vCenter Server extension.

Custom Attributes Workflows

With custom attributes workflows, you can add custom attributes to virtual machines or get a custom attribute for a virtual machine.
You can access the custom attributes workflows from Library > vCenter > Custom Attributes in the Workflows view of the Orchestrator client.
Add custom attribute to a virtual machine
Add custom attribute to multiple virtual machines
Adds a custom attribute to a virtual machine.
Adds a custom attribute to a selection of virtual machines.
Get custom attribute
Gets a custom attribute for a virtual machine in vCenter Server.

Datacenter Workflows

With datacenter workflows, you can create, delete, reload, rename, or rescan a datacenter.
You can access the datacenter workflows from Library > vCenter > Datacenter in the Workflows view of the Orchestrator client.
Create datacenter
Delete datacenter
Reload datacenter
Rename datacenter
Rescan datacenter HBAs
Creates a new data center in a data center folder.
Deletes a data center.
Forces vCenter Server to reload data from a data center.
Renames a data center and waits for the task to complete.
Scans the hosts in a data center and initiates a rescan on the host bus adapters to discover new storage.
26 VMware, Inc.
Chapter 3 Using the vCenter Server Plug-In

Datastore and Files Workflows

With datastore and files workflows, you can delete a list of files, find unused files in a datastore, and so on.
You can access the datastore and files workflows from Library > vCenter > Datastore and Files in the Workflows view of the Orchestrator client.
Delete all files
Delete all unused datastore files
Export unused datastore files
Find unused files in datastores
Get all configuration, template, and disk files from virtual machines
Log all datastore files
Log unused datastore files
Upload file to datastore
Deletes a list of files.
Searches all datastores in the vCenter Server environment and deletes all unused files.
Searches all datastores and creates an XML descriptor file that lists all unused files.
Searches the vCenter Server environment for all unused disks (*.vmdk), virtual machines (*.vmx), and template (*.vmtx) files that are not associated with any vCenter Server instances registered with Orchestrator.
Creates a list of all virtual machine descriptor files and a list of all virtual machine disk files, for all datastores.
Creates a log for every virtual machine configuration file and every virtual machine file found in all datastores.
Searches the vCenter Server environment for unused files that are registered on virtual machines and exports a log of the files in a text file.
Uploads a file to an existing folder on a specific datastore. The uploaded file will overwrite any existing file with the same name in the same destination folder.

Datacenter Folder Management Workflows

With datacenter folder management workflows, you can create, delete, or rename a datacenter folder.
You can access the datacenter folder management workflows from Library > vCenter > Folder management > Datacenter folder in the Workflows view of the Orchestrator client.
Create datacenter folder
Delete datacenter folder
Rename datacenter folder
Creates a data center folder.
Deletes a data center folder and waits for the task to complete.
Renames a data center folder and waits for the task to complete.

Host Folder Management Workflows

With host folder management workflows, you can create, delete, or rename a host folder.
You can access the host folder management workflows from Library > vCenter > Folder management > Host folder in the Workflows view of the Orchestrator client.
Create host folder
Delete host folder
Rename host folder
Creates a host folder.
Deletes a host folder and waits for the task to complete.
Renames a host folder and waits for the task to complete.
VMware, Inc. 27

Virtual Machine Folder Management Workflows

With virtual machine folder management workflows, you can create, delete, or rename a virtual machine folder.
You can access the virtual machine folder management workflows from Library > vCenter > Folder management > VM folder in the Workflow view of the Orchestrator client.
Create virtual machine folder
Delete virtual machine folder
Rename virtual machine folder
Creates a virtual machine folder.
Deletes a virtual machine folder and waits for the task to complete.
Renames a virtual machine folder and waits for the task to complete.

Guest Operation Files Workflows

With guest operation files workflows, you can manage files in a guest operating system.
You can access the guest operation files workflows from Library > vCenter > Guest operations > Files in the Workflows view of the Orchestrator client.
Check for directory in guest
Check for file in guest
Copy file from guest to Orchestrator
Copy file from Orchestrator to guest
Create directory in guest
Verifies that a directory exists in a guest virtual machine.
Verifies that a file exists in a guest virtual machine.
Copies a specified file from a guest file system to an Orchestrator server.
Copies a specified file from an Orchestrator server to a guest file system.
Creates a directory in a guest virtual machine.
Create temporary directory in guest
Create temporary file in guest
Delete directory in guest
Delete file in guest
List path in guest
Move directory in guest
Move file in guest
28 VMware, Inc.
Creates a temporary directory in a guest virtual machine.
Creates a temporary file in a guest virtual machine.
Deletes a directory from a guest virtual machine.
Deletes a file from a guest virtual machine.
Shows a path in a guest virtual machine.
Moves a directory in a guest virtual machine.
Moves a file in a guest virtual machine.
Chapter 3 Using the vCenter Server Plug-In

Guest Operation Processes Workflows

With guest operation processes workflows, you can get information and control the running processes in a guest operating system.
You can access the guest operation files workflows from Library > vCenter > Guest operations > Processes in the Workflows view of the Orchestrator client.
Get environment variables from guest
Get processes from guest
Run program in guest
Kill process in guest
Returns a list with environmental variables from a guest. An interactive session returns the variables of the user who is currently logged in.
Returns a list with the processes running in the guest operating system and the recently completed processes started by the API.
Starts a program in a guest operating system.
Treminates a process in a guest operating system.

Power Host Management Workflows

With power host management workflows you can reboot or shut down a host.
You can access the power host management workflows from Library > vCenter > Host management > Power in the Workflows view of the Orchestrator client.
Reboot host
Shut down host
Reboots a host. If the Orchestrator client is connected directly to the host, it does not receive an indication of success in the returned task, but rather loses the connection to the host if the operation succeeds.
Shuts down a host. If the Orchestrator client is connected directly to the host, it does not receive an indication of success in the returned task, but rather loses the connection to the host if the operation succeeds.

Basic Host Management Workflows

With basic host management workflows, you can put a host into maintenance mode, make a host exit maintenance mode, move a host to a folder or a cluster, and reload data from a host.
You can access the basic host management workflows from Library > vCenter > Host management > Basic in the Workflows view of the Orchestrator client.
Enter maintenance mode
Exit maintenance mode
Move host to cluster
Move host to folder
Reload host
Puts the host into maintenance mode. You can cancel the task.
Exits maintenance mode. You can cancel the task.
Moves an existing host into a cluster. The host must be part of the same data center, and if the host is part of a cluster, the host must be in maintenance mode.
Moves a host into a folder as a standalone host. The host must be part of a ClusterComputeResource in the same data center and the host must be in maintenance mode.
Forces vCenter Server to reload data from a host.
VMware, Inc. 29

Host Registration Management Workflows

With host registration management workflows, you can add a host to a cluster, disconnect or reconnect a host from a cluster, and so on.
You can access the host management registration workflows from Library > vCenter > Host management > Registration in the Workflows view of the Orchestrator client.
Add host to cluster
Add standalone host
Disconnect host
Reconnect host
Reconnect host with all information
Remove host
Adds a host to the cluster. This workflow fails if it cannot authenticate the SSL certificate of the host.
Registers a host as a standalone host.
Disconnects a host from vCenter Server.
Reconnects a disconnected host by providing only the host information.
Reconnects a disconnected host by providing all information about the host.
Removes a host and unregisters it from vCenter Server. If the host is part of a cluster, you must put it in maintenance mode before attempting to remove it.

Networking Workflows

With networking workflows you can add a port group to distributed virtual switch, create a distributed virtual switch with a port group, and so on.
You can access the networking workflows from Library > vCenter > Networking in the Workflows view of the Orchestrator client.
Add port group to distributed virtual switch
Attach host system to distributed virtual switch
Adds a new distributed virtual port group to a specified distributed virtual switch.
Adds a host to a distributed virtual switch.
Create distributed virtual switch with port group
Creates a new distributed virtual switch with a distributed virtual port group.

Distributed Virtual Port Group Workflows

With distributed virtual port group workflows you can update or delete a port group, and reconfigure the port group.
You can access the distributed virtual port group workflows from Library > vCenter > Networking > Distributed virtual port group in the Workflows view of the Orchestrator client.
Connect virtual machine NIC number to distributed virtual port group
Delete distributed virtual port group
30 VMware, Inc.
Reconfigures the network connection of the specified virtual machine NIC number to connect to the specified distributed virtual port group. If no NIC number is specified, the number zero is used.
Deletes a specified distributed virtual port group.
Loading...
+ 106 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use