Using VMware vCenter Orchestrator Plug-Ins vCenter Orchestrator 5.5.2 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.
Using VMware vCenter Orchestrator Plug-Ins 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–2014 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 vCenter Orchestrator Plug-Ins 9 1 Introduction to Orchestrator Plug-Ins 11 Orchestrator Architecture 11 Plug-Ins Installed with the Orchestrator Server Access the Orchestrator API Explorer 15 12 2 Configure the Orchestrator Plug-Ins 17 3 Using the vCenter Server Plug-In 19 Configuring the vCenter Server Plug-In 19 Configuration Workflows 19 Configure the Connection to a vCenter Server Instance vCenter Server Plug-In Scripting API 20 Using the vCenter Server Plug-In Inventory 21 A
Using VMware vCenter Orchestrator Plug-Ins Tools Clone Workflows 35 Windows Customization Clone Workflows 35 Device Management Workflows 36 Move and Migrate Workflows 36 Other Workflows 37 Power Management Workflows 37 Snapshot Workflows 38 VMware Tools Workflows 38 4 Using the Configuration Plug-In 41 Access the Configuration Plug-In Workflow Library Configuration Plug-In Workflow Library 41 41 5 Using the vCO Library Plug-In 45 vCO Library Plug-In Workflows 45 6 Using the SQL Plug-In 47 Configurin
Contents 8 Using the XML Plug-In 63 Running the XML Plug-In Sample Workflows 63 Create a Simple XML Document 64 Find an Element in an XML Document 64 Modify an XML Document 65 Create an Example Address Book from XML 65 9 Using the Mail Plug-In 67 Define the Default SMTP Connection 67 Using the Mail Plug-In Sample Workflows 68 Access the Mail Plug-In Sample Workflows 68 Mail Plug-In Sample Workflows 68 Test an Example Interaction with Email 69 10 Using the Net Plug-In 71 11 Using the Enumeration Plug-In
Using VMware vCenter Orchestrator Plug-Ins Using the AMQP Plug-In Standard Workflows 93 Declare a Binding 93 Declare a Queue 94 Declare an Exchange 95 Send a Text Message 95 Delete a Binding 96 16 Using the SNMP Plug-In 97 Managing SNMP Devices 97 Device Management Workflows 97 Register an SNMP Device 98 Managing SNMP Queries 98 Query Management Workflows 98 Add a Query to an SNMP Device 99 Managing the SNMP Trap Host 99 Trap Host Management Workflows 100 Set the SNMP Trap Port 100 Receiving SNMP Traps
Contents Multi-Node Plug-In Use Cases 115 Create a Multi-Proxy Action 115 Maintenance of Remote and Proxy Workflows Deploy a Package from a Local Server 116 115 20 Using the PowerShell Plug-In 117 Using the PowerShell Plug-In Inventory 117 Configuring the PowerShell Plug-In 118 Configuration Workflows 118 Configure Kerberos Authentication 118 Add a PowerShell Host 119 Running PowerShell Scripts 120 Invoke a PowerShell Script 120 Invoke an External Script 120 Generating Actions 121 Generate an Action fro
Using VMware vCenter Orchestrator Plug-Ins 8 VMware, Inc.
Using VMware vCenter Orchestrator Plug-Ins Using VMware vCenter Orchestrator Plug-Ins provides information and instructions about configuring and ® using the standard set of plug-ins installed with VMware vCenter 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.
Using VMware vCenter Orchestrator Plug-Ins 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.
Using VMware vCenter Orchestrator Plug-Ins Figure 1‑1. VMware vCenter Orchestrator Architecture vCenter Orchestrator Client application browser access workflow engine vCenter Server Directory services or vCenter Single Sign On XML vCenter Server SSH Web services REST/SOAP workflow library SQL SMTP 3rd-party plug-in Orchestrator database Plug-Ins Installed with the Orchestrator Server Orchestrator includes a collection of standard plug-ins.
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 keyboardinteractive authentication. Optionally, the SSH plug-in can provide remote file system browsing directly in the Orchestrator client inventory.
Using VMware vCenter Orchestrator Plug-Ins Table 1‑2. Names of Plug-In Components Plug-In Name in the Configuration UI DAR File Workflow Categories API Module vCenter Server o11nplugin-vsphere.dar vCenter VC vCO Configuration o11nplugin-configurator.dar Configuration Configurator vCO Library o11nplugin-library.dar Locking Orchestrator Troubleshooting Not applicable. SQL o11nplugin-database.dar JDBC SQL SQL SSH o11nplugin-ssh.dar SSH SSH XML o11nplugin-xml.
Chapter 1 Introduction to Orchestrator Plug-Ins 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.
Using VMware vCenter Orchestrator Plug-Ins 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.
Using VMware vCenter Orchestrator Plug-Ins 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.
Using VMware vCenter Orchestrator Plug-Ins 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. Remove a vCenter Server instance Removes a vCenter Server instance from the Orchestrator inventory. You will no longer be able to orchestrate this vCenter Server instance. Update a vCenter Server instance Updates the connection to a vCenter Server instance.
Chapter 3 Using the vCenter Server Plug-In Using the vCenter Server Plug-In Inventory The vCenter Server plug-in exposes all objects of the connected vCenter Server hosts 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.
Using VMware vCenter Orchestrator Plug-Ins n Host Folder Management Workflows on page 26 With host folder management workflows, you can create, delete, or rename a host folder. n Virtual Machine Folder Management Workflows on page 26 With virtual machine folder management workflows, you can create, delete, or rename a virtual machine folder. n Guest Operation Files Workflows on page 27 With guest operation files workflows, you can manage files in a guest operating system.
Chapter 3 Using the vCenter Server Plug-In n Clone Workflows on page 33 With clone workflows you can clone virtual machines with or without customizing the virtual machine properties. n Linked Clone Workflows on page 34 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.
Using VMware vCenter Orchestrator Plug-Ins n Run a workflow on a selection of objects Fills the BatchAction configuration element with all of the actions that have no input parameters or one input parameter and that have an array as the returnType. 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.
Chapter 3 Using the vCenter Server Plug-In 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 Adds a custom attribute to a virtual machine.
Using VMware vCenter Orchestrator Plug-Ins Log all datastore files Creates a log for every virtual machine configuration file and every virtual machine file found in all datastores. Log unused datastore files 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. Datacenter Folder Management Workflows With datacenter folder management workflows, you can create, delete, or rename a datacenter folder.
Chapter 3 Using the vCenter Server Plug-In 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 Verifies that a directory exists in a guest virtual machine. Check for file in guest Verifies that a file exists in a guest virtual machine.
Using VMware vCenter Orchestrator Plug-Ins 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 Reboots a host.
Chapter 3 Using the vCenter Server Plug-In 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 Adds a new distributed virtual port group to a specified distributed virtual switch.
Using VMware vCenter Orchestrator Plug-Ins Delete private VLAN Deletes a VLAN from a specified distributed virtual switch. If a secondary VLAN exists, you should first delete the secondary VLAN. Update distributed virtual switch Updates the properties of a distributed virtual switch. Update private VLAN Updates a VLAN on the specified distributed virtual switch.
Chapter 3 Using the vCenter Server Plug-In Reconfigure resource pool Reconfigures CPU and memory allocation configuration for a given resource pool. Rename resource pool Renames a resource pool and waits for the task to complete. Storage Workflows With storage workflows you can perform storage-related operations. You can access the storage workflows from Library > vCenter > Storage in the Workflows view of the Orchestrator client.
Using VMware vCenter Orchestrator Plug-Ins Create Storage DRS scheduled task Creates a scheduled task for reconfiguring a datastore cluster. Only automation and runtime rules can be set. Create virtual machine anti-affinity rule Creates an anti-affinity rule to indicate that all virtual disks of certain virtual machines must be kept on different datastores.
Chapter 3 Using the vCenter Server Plug-In Move virtual machines to resource pool Moves several virtual machines to a resource pool. Register virtual machine Registers a virtual machine. The virtual machine files must be placed in an existing datastore and must not be already registered. Reload virtual machine Forces vCenter Server to reload a virtual machine. Rename virtual machine Renames an existing virtual machine on the vCenter Server system or host and not on the datastore.
Using VMware vCenter Orchestrator Plug-Ins Linked Clone Workflows 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. You can access the linked clone workflows from Library > vCenter > Virtual Machine management > Clone > Linked Clone folder and its subfolders in the Workflows view of the Orchestrator client.
Chapter 3 Using the vCenter Server Plug-In Tools Clone Workflows 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. You can access the tools clone workflows from Library > vCenter > Virtual Machine management > Clone > Tools in the Workflows view of the Orchestrator client. Get a virtual Ethernet card to change the network Returns a new ethernet card to update a virtual device.
Using VMware vCenter Orchestrator Plug-Ins Clone a Windows machine with multiple NICs and credential Clones a Windows virtual machine performing the guest operating system customization. Configures the local administrator user account and up to four virtual network cards. Sysprep tools must be available on the vCenter Server system. Clone a Windows machine with single NIC Clones a Windows virtual machine performing the guest operating system customization and configures one virtual network card.
Chapter 3 Using the vCenter Server Plug-In Move virtual machine to another vCenter Server system Moves a list of virtual machines to another vCenter Server system. Quick migrate multiple virtual machines Suspends the virtual machines if they are powered on and migrates them to another host using the same storage. Quick migrate virtual machine Suspends the virtual machine if it is powered on and migrates it to another host using the same storage.
Using VMware vCenter Orchestrator Plug-Ins Shut down guest OS and wait Shuts down a guest operating system and waits for the process to complete. Start virtual machine and wait Starts a virtual machine and waits for VMware Tools to start. Suspend virtual machine and wait Suspends a virtual machine and waits for the process to complete. Snapshot Workflows With snapshot workflows, you can perform snapshot-related operations.
Chapter 3 Using the vCenter Server Plug-In Upgrade VMware tools Upgrades VMware Tools on a virtual machine. Upgrade VMware tools at next reboot Upgrades VMware Tools on a virtual machine without performing an automatic reboot. VMware, Inc.
Using VMware vCenter Orchestrator Plug-Ins 40 VMware, Inc.
Using the Configuration Plug-In 4 In addition to configuring Orchestrator by using the Orchestrator Web Configuration interface, you can modify the Orchestrator server configuration settings by running workflows from the Configuration plugin. With the Configuration plug-in you can configure the Orchestrator server networking, authentication settings, database, and so on.
Using VMware vCenter Orchestrator Plug-Ins You access the workflows related to LDAP configuration from Library > Configuration > Authentication > LDAP in the Workflows view of the Orchestrator client. Configure Active Directory Changes the server authentication mode to LDAP and configures a connection to an Active Directory LDAP server. If you try to change the authentication settings and the new configuration is not successful, it does not override the existing one.
Chapter 4 Using the Configuration Plug-In You access these workflows from Library > Configuration > Database in the Workflows view of the Orchestrator client. Embedded database Changes the database provider to embedded database and configures the connection to it. If you try to change the database settings and the new configuration is not successful, it does not override the existing one. Microsoft SQL Server Changes the database provider to Microsoft SQL Server and configures the connection to it.
Using VMware vCenter Orchestrator Plug-Ins Network Workflows You access the Network configuration workflows from Library > Configuration > Network in the Workflows view of the Orchestrator client. Configure the network settings Configures the network settings of the Orchestrator server. License Workflows You access the License configuration workflows from Library > Configuration > License in the Workflows view of the Orchestrator client. 44 Enter license key Adds a manually provided license key.
Using the vCO Library Plug-In 5 You can use the vCO Library plug-in workflows as templates for customization and automation of client processes, and to troubleshoot Orchestrator. vCO Library Plug-In Workflows The vCO Library plug-in provides workflows in the Locking, Orchestrator, and Troubleshooting workflow categories. Locking Workflows You access these workflows from Library > Locking in the Workflows view of the Orchestrator client. Display all locks Shows all locks.
Using VMware vCenter Orchestrator Plug-Ins Orchestrator Workflows You access these workflows from Library > Orchestrator > Workflows in the Workflows view of the Orchestrator client. Start workflows in a series Runs a workflow multiple times in a series, one instance after the other. You provide workflow parameters in an array. You also provide a property list, with one property per workflow input, for each instance of the workflow that starts.
Using the SQL Plug-In 6 You can use the API that the SQL plug-in provides to implement connectivity to SQL databases and other tabular data sources, such as spreadsheets or flat files. The SQL plug-in API which is based on JDBC, provides a call-level API for SQL-based database access. The SQL plug-in also provides sample workflows that demonstrate how to use the API in workflows.
Using VMware vCenter Orchestrator Plug-Ins Add a Database You can run a workflow to add a database to the Orchestrator server and configure the host connection parameters. When you add a database that requires a secure connection, you must import the database SSL certificate. You can import the SSL certificate by using the options available in the Network tab in the Orchestrator configuration interface. Procedure 1 Log in to the Orchestrator client as an administrator.
Chapter 6 Using the SQL Plug-In n Verify that you have a connection to a database from the Inventory view. Procedure 1 Click the Workflows view in the Orchestrator client. 2 In the workflows hierarchical list, select Library > SQL > Configuration and navigate to the Add tables to a database workflow. 3 Right-click the Add tables to a database workflow and select Start workflow. 4 Select a database to which to add tables. 5 Select the tables that you want to add.
Using VMware vCenter Orchestrator Plug-Ins Running the SQL Sample Workflows You can run the SQL plug-in workflows to perform JDBC operations such as generating a JDBC URL, testing a JDBC connection, and managing rows in JDBC tables. You can also run the SQL plug-in workflows to manage databases and database tables, as well as to run SQL operations. Generate a JDBC URL You can run a workflow from the Orchestrator client to generate a JDBC connection URL.
Chapter 6 Using the SQL Plug-In 4 5 Provide the required information to test a database connection. a Type a user name to access the database. b Type the URL to test. c Type a password to access the database. Click Submit to run the workflow. Create a Table by Using JDBC You can run a workflow from the Orchestrator client to create a database. Prerequisites Log in to the Orchestrator client as a user who can run JDBC workflows. Procedure 1 Click the Workflows view in the Orchestrator client.
Using VMware vCenter Orchestrator Plug-Ins 4 5 Provide the required information, and click Next. a Type a database connection URL. b Type a user name to access the database. c Type a password to access the database. Type an SQL insert statement, and click Next. An example syntax is: INSERT INTO "table_name" ("column1", "column2") VALUES ("value1", "value2") 6 Type the values to insert into the row. 7 Click Submit to run the workflow.
Chapter 6 Using the SQL Plug-In 4 5 Provide the required information, and click Next. a Type the first name of the user entry to be deleted. b Type a user name to access the database. c Type a JDBC connection URL. d Type the last name of the user entry to be deleted. e Type a password to access the database. Type an SQL delete statement. An example syntax is: DELETE FROM "table_name" where ("column1" = ?, "column2" = ?) 6 Click Submit to run the workflow.
Using VMware vCenter Orchestrator Plug-Ins 4 5 Provide the required information, and click Next. a Type a password to access the database. b Type a database connection URL. c Type a user name to access the database. Type an SQL drop statement. An example syntax is: DROP TABLE "table_name" 6 Click Submit to run the workflow. Run a Complete JDBC Cycle You can run a workflow from the Orchestrator client to test all JDBC example workflows in one full cycle.
Chapter 6 Using the SQL Plug-In Update a database Updates the configuration of a database object in the plug-in's inventory. Validate a database Validates a database in the plug-in's inventory. You can access the SQL operations workflows from Library > SQL in the Workflows view of the Orchestrator client. Execute a custom query on a database Executes a custom query on a specified database and returns the number of affected rows.
Using VMware vCenter Orchestrator Plug-Ins 56 VMware, Inc.
Using the SSH Plug-In 7 You can use the SSH plug-in workflows to run SSH commands on a remote host that supports SSH and transfer files between an Orchestrator server and a remote host through a secure connection. This chapter includes the following topics: n “Configure the SSH Plug-In,” on page 57 n “Running the SSH Plug-In Sample Workflows,” on page 57 Configure the SSH Plug-In You can set up the SSH plug-in to ensure encrypted connections.
Using VMware vCenter Orchestrator Plug-Ins n Change the Key Pair Passphrase on page 59 You can run a workflow from the Orchestrator client to change the passphrase for the key pair that you generated last. n Register an Orchestrator Public Key on an SSH Host on page 59 You can use a public key instead of a password. To register an Orchestrator public key on an SSH host, you can run a workflow from the Orchestrator client.
Chapter 7 Using the SSH Plug-In Change the Key Pair Passphrase You can run a workflow from the Orchestrator client to change the passphrase for the key pair that you generated last. Prerequisites n Configure the SSH plug-in in the Orchestrator configuration interface. n Log in to the Orchestrator client as a user who can run SSH workflows. Procedure 1 Click the Workflows view in the Orchestrator client.
Using VMware vCenter Orchestrator Plug-Ins n Log in to the Orchestrator client as a user who can run SSH workflows. Procedure 1 Click the Workflows view in the Orchestrator client. 2 In the workflows hierarchical list, open Library > SSH to navigate to the Run SSH command workflow. 3 Right-click the Run SSH command workflow and select Start workflow. 4 Type an SSH host name or IP address, and click Next. 5 Type an SSH command to run, and click Next. NOTE The default SSH command is uptime.
Chapter 7 Using the SSH Plug-In Copy a File to an SSH Host You can run a workflow from the Orchestrator client to copy files from the Orchestrator server to an SSH host. The SSH plug-in uses the Java JCraft library, which implements SFTP. The SCP put command workflow transfers files by using SFTP. Prerequisites n Configure the SSH plug-in in the Orchestrator configuration interface. n Log in to the Orchestrator client as a user who can run SSH workflows.
Using VMware vCenter Orchestrator Plug-Ins 62 VMware, Inc.
Using the XML Plug-In 8 You can use the XML plug-in to run workflows that create and modify XML documents. The XML plug-in adds an implementation of a Document Object Model (DOM) XML parser to the Orchestrator JavaScript API. The XML plug-in also provides some sample workflows to demonstrate how you can create and modify XML documents from workflows. Alternatively, you can use the ECMAScript for XML (E4X) implementation in the Orchestrator JavaScript API to process XML documents directly in JavaScript.
Using VMware vCenter Orchestrator Plug-Ins Create a Simple XML Document You can run a workflow from the Orchestrator client to create a simple XML document for testing purposes. Prerequisites n Log in to the Orchestrator client as a user who can run XML workflows. n Verify that you created the c:/orchestrator folder at the root of the Orchestrator server system or set access rights to another folder. Procedure 1 Click the Workflows view in the Orchestrator client.
Chapter 8 Using the XML Plug-In Modify an XML Document You can run a workflow from the Orchestrator client to modify the XML that the Create a simple XML document workflow creates. Prerequisites n Log in to the Orchestrator client as a user who can run XML workflows. n Verify that you created the c:/orchestrator folder at the root of the Orchestrator server system or set access rights to another folder. Procedure 1 Click the Workflows view in the Orchestrator client.
Using VMware vCenter Orchestrator Plug-Ins 5 Click Submit to run the workflow. The workflow creates a DTD, an XML, and a CSS file, appends the stylesheet, and stores the files in the specified folder. 66 VMware, Inc.
Using the Mail Plug-In 9 You can send email messages from workflows by using the Mail plug-in, which uses the Simple Mail Transfer Protocol (SMTP). For example, you can create a workflow to send an email to a given address if the workflow requires user interaction or when it completes its run.
Using VMware vCenter Orchestrator Plug-Ins Using the Mail Plug-In Sample Workflows You can call the sample workflows of the Mail plug-in from custom workflows to implement email functionality. You can run an example workflow to test interaction with email. n Access the Mail Plug-In Sample Workflows on page 68 You must use the Orchestrator client to access the Mail plug-in sample workflows.
Chapter 9 Using the Mail Plug-In Test an Example Interaction with Email You can run a workflow from the Orchestrator client to send an email to respond to a query, known as a user interaction. The workflow uses the default mail server configuration that you set in the Orchestrator configuration interface. See “Define the Default SMTP Connection,” on page 67. Prerequisites n Configure the Mail plug-in in the Orchestrator configuration interface.
Using VMware vCenter Orchestrator Plug-Ins 70 VMware, Inc.
Using the Net Plug-In 10 You can use the Net plug-in to implement the Telnet, FTP, POP3, and IMAP protocols in workflows. The POP3 and IMAP implementations allow downloading and reading email. In combination with the Mail plug-in, the Net plug-in provides full email sending and receiving capabilities in workflows. VMware, Inc.
Using VMware vCenter Orchestrator Plug-Ins 72 VMware, Inc.
11 Using the Enumeration Plug-In You can use the Enumeration plug-in to implement common enumerated types in workflows. Time Zone Codes You can use the time zone codes as possible values for the Enums:MSTimeZone enumeration.
Using VMware vCenter Orchestrator Plug-Ins 74 Time Zone Code Time Zone Name Description 070 S.A.
Chapter 11 Using the Enumeration Plug-In Time Zone Code Time Zone Name Description 203 Myanmar Standard Time (GMT+06:30) Yangon (Rangoon) 205 S.E. Asia Standard Time (GMT+07:00) Bangkok, Hanoi, Jakarta 207 North Asia Standard Time (GMT+07:00) Krasnoyarsk 210 China Standard Time (GMT+08:00) Beijing, Chongqing, Hong Kong SAR, Urumqi 215 Singapore Standard Time (GMT+08:00) Kuala Lumpur, Singapore 220 Taipei Standard Time (GMT+08:00) Taipei 225 W.
Using VMware vCenter Orchestrator Plug-Ins 76 VMware, Inc.
Using the Workflow Documentation Plug-In 12 You can use the Workflow Documentation plug-in to generate PDF documentation about a specific workflow or workflow category.
Using VMware vCenter Orchestrator Plug-Ins The PDF file containing the information about the selected workflow, or the workflows in the folder, is saved on your system. 78 VMware, Inc.
Using the HTTP-REST Plug-In 13 The HTTP-REST plug-in allows you to manage REST Web services by providing interaction between vCenter Orchestrator and REST hosts. You can define REST services and their operations as inventory objects by running configuration workflows, and perform REST operations on the defined objects. The plug-in contains a set of standard workflows related to managing REST hosts and invoking REST operations. You can also generate custom workflows to automate tasks in a REST environment.
Using VMware vCenter Orchestrator Plug-Ins Workflow Name Description Update a REST host Updates a REST host in the plug-in's inventory. Update a REST operation Updates an operation on a REST host. Configure Kerberos Authentication You can use Kerberos authentication when you add a host. The krb5.
Chapter 13 Using the HTTP-REST Plug-In 4 Right-click the Add a REST host workflow and select Start workflow. 5 In the Name text box, type the name of the host. 6 In the URL text box, type the address of the host. NOTE The Kerberos authentication requires a Fully Qualified Domain Name (FQDN) host address. 7 In the Connection timeout text box, type the number of seconds before a connection times out. 8 In the Operation timeout text box, type the number of seconds before an operation times out.
Using VMware vCenter Orchestrator Plug-Ins 3 Right-click the Add a REST operation workflow and select Start workflow. 4 Select the host to which you want to add the operation. 5 In the Name text box, type the name of the operation. 6 In the Template URL text box, type only the operation part of the URL. You can include placeholders for parameters that are provided when you run the operation. The following is an example URL syntax.
Chapter 13 Using the HTTP-REST Plug-In Prerequisites n Verify that you are logged in to the Orchestrator client as an administrator. n Verify that you have a connection to a REST host from the Inventory view. Procedure 1 Click the Workflows view in the Orchestrator client. 2 In the workflows hierarchical list, select Library > HTTP-REST and navigate to the Generate a new workflow from a REST operation workflow.
Using VMware vCenter Orchestrator Plug-Ins 84 VMware, Inc.
Using the SOAP Plug-In 14 The SOAP plug-in allows you to manage SOAP Web services by providing interaction between vCenter Orchestrator and SOAP hosts. You can define SOAP services as inventory objects by running configuration workflows, and perform SOAP operations on the defined objects. The plug-in contains a set of standard workflows related to managing SOAP hosts and invoking SOAP operations. You can also generate custom workflows to automate tasks in a SOAP environment.
Using VMware vCenter Orchestrator Plug-Ins Add a SOAP Host You can run a workflow to add a SOAP host and configure the host connection parameters. Procedure 86 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 > SOAP > Configuration and navigate to the Add a SOAP host workflow. 4 Right-click the Add a SOAP host workflow and select Start workflow.
Chapter 14 Using the SOAP Plug-In 10 Click Submit to run the workflow. After the workflow runs successfully, the SOAP host appears in the Inventory view. What to do next You can explore the SOAP host objects and run workflows on them from the Inventory view. Configure Kerberos Authentication You can use Kerberos authentication when you add a host. The krb5.
Using VMware vCenter Orchestrator Plug-Ins n Verify that you have a connection to a SOAP host from the Inventory view. Procedure 1 Click the Workflows view in the Orchestrator client. 2 In the workflows hierarchical list, select Library > SOAP to navigate to the Generate a new workflow from a SOAP operation workflow. 3 Right-click the Generate a new workflow from a SOAP operation workflow and select Start workflow. 4 Select the SOAP operation from the list of available operations.
Chapter 14 Using the SOAP Plug-In 4 Select the SOAP operation from the list of available operations. 5 Provide the input parameters that the SOAP operation requires. 6 Click Submit to run the workflow. 7 (Optional) In the Logs tab, review the list of available output parameters. VMware, Inc.
Using VMware vCenter Orchestrator Plug-Ins 90 VMware, Inc.
Using the AMQP Plug-In 15 The AMQP plug-in allows you to interact with Advanced Message Queuing Protocol (AMQP) servers also known as brokers. You can define AMQP brokers and queue subscriptions as inventory objects by running configuration workflows, and perform AMQP operations on defined objects. The plug-in contains a set of standard workflows related to managing AMQP brokers and calling AMQP operations.
Using VMware vCenter Orchestrator Plug-Ins 2 Click the Workflows view in the Orchestrator client. 3 In the hierarchical list of workflows, select Library > AMQP > Configuration and navigate to the Add a broker workflow. 4 Right-click the Add a broker workflow and select Start workflow. 5 Provide the information required for the Add a broker workflow. 6 Option Action Name Type the name of the broker. Host Type the address of the host. Port Type the port of the AMQP broker service.
Chapter 15 Using the AMQP Plug-In Update a Broker You can run a workflow to update the broker properties. Prerequisites n Verify that you are logged in to the Orchestrator client as an administrator. n Verify that you have a connection to an AMQP broker from the Inventory view. Procedure 1 Click the Workflows view in the Orchestrator client. 2 In the hierarchical list of workflows, select Library > AMQP and navigate to the Update a broker workflow.
Using VMware vCenter Orchestrator Plug-Ins 4 Select a broker in which you want create a binding. 5 Provide information about the binding. 6 Option Action Queue name Type the name of the queue. Exchange name Type the name of the exchange. Routing key Type the routing key. Click Submit to run the workflow. Declare a Queue You can run a workflow to add a queue to a specified broker. Prerequisites n Verify that you are logged in to the Orchestrator client as an administrator.
Chapter 15 Using the AMQP Plug-In Declare an Exchange You can run a workflow to add an exchange in a specified broker. Prerequisites n Verify that you are logged in to the Orchestrator client as an administrator. n Verify that you have a connection to an AMQP broker from the Inventory view. Procedure 1 Click the Workflows view in the Orchestrator client. 2 In the hierarchical list of workflows, select Library > AMQP and navigate to the Declare an exchange workflow.
Using VMware vCenter Orchestrator Plug-Ins n Verify that you have a connection to an AMQP broker from the Inventory view. Procedure 1 Click the Workflows view in the Orchestrator client. 2 In the hierarchical list of workflows, select Library > AMQP and navigate to the Send a text message workflow. 3 Right-click the Send a text message workflow and select Start workflow. 4 Select a broker from which you want to send a message. 5 In the Exchange name text box, specify the name of the exchange.
Using the SNMP Plug-In 16 The SNMP plug-in allows vCenter Orchestrator to connect and receive information from SNMP-enabled systems and devices. You can define SNMP devices as inventory objects by running workflows, and perform SNMP operations on the defined objects. You can use the plug-in to connect to SNMP devices such as routers, switches, network printers, and UPS devices. The plug-in can also receive events from vCenter Server over the SNMP protocol.
Using VMware vCenter Orchestrator Plug-Ins Workflow Name Description Edit an SNMP device Edits the configuration of a registered SNMP device. Register an SNMP device Registers an SNMP-enabled device to the plug-in's inventory. Unregister an SNMP device Unregisters an SNMP device from the plug-in's inventory. Register an SNMP Device You can run a workflow to register an SNMP device and optionally configure advanced connection parameters.
Chapter 16 Using the SNMP Plug-In Workflow Name Description Add a query to an SNMP device Adds a query to an SNMP device. Copy an SNMP query Copies an SNMP query from one device to another. Edit an SNMP query Edits an existing SNMP query. Remove a query from an SNMP device Removes an SNMP query from a device. Run an SNMP query Runs a query against an SNMP device. Add a Query to an SNMP Device You can run a workflow to add a query to an SNMP device from the plug-in's inventory.
Using VMware vCenter Orchestrator Plug-Ins Trap Host Management Workflows The Trap Host Management workflow category contains workflows that allow you to manage the SNMP trap host. You can access these workflows from Library > SNMP > Trap Host Management on the Workflows view in the Orchestrator client. Workflow Name Description Set the SNMP trap port Sets the port on which Orchestrator listens for SNMP traps. Start the trap host Orchestrator starts listening for SNMP traps.
Chapter 16 Using the SNMP Plug-In Procedure 1 Click the Workflows view in the Orchestrator client. 2 In the workflows hierarchical list, select Library > SNMP and navigate to the Wait for a trap on an SNMP device workflow. 3 Right-click the Wait for a trap on an SNMP device workflow and select Start workflow. 4 Select the device on which you want to wait for an SNMP trap. 5 (Optional) In the OID text box, type the object identifier of a specific trap.
Using VMware vCenter Orchestrator Plug-Ins Procedure 1 Click the Policies view in the Orchestrator client. 2 If the policy that you want to edit is running, right-click the policy and select Stop policy. 3 Right-click the policy and select Edit. 4 From the General tab, edit the startup settings, priority, and description of the policy. 5 (Optional) From the Scripting tab, you can associate a specific workflow or scripting code with the policy, for integration in a more complex scenario.
Using the Active Directory Plug-In 17 The Active Directory plug-in (VMware vCenter Orchestrator plug-in for Microsoft Active Directory) allows interaction between vCenter Orchestrator and Microsoft Active Directory. You can use the plug-in to run Orchestrator workflows that automate Active Directory processes. The plug-in contains a set of standard workflows. You can also create custom workflows that implement the plug-in API to automate tasks in your Active Directory environment.
Using VMware vCenter Orchestrator Plug-Ins Using the Active Directory Plug-In Inventory The Active Directory plug-in exposes all objects in the connected Microsoft Active Directory instance in the Inventory view. You can use the Inventory view to add authorization elements or to run workflows on Microsoft Active Directory objects. You can enable the Use contextual menu in inventory option to display the workflows that are available for an inventory object.
Chapter 17 Using the Active Directory Plug-In Workflow Name Description Create an organizational unit Creates an organizational unit in an existing organizational unit. Destroy an organizational unit Deletes an organizational unit from an Active Directory instance. Destroy an organizational unit and delete its subtree Deletes an organizational unit from an Active Directory instance and all objects within the organizational unit subtree.
Using VMware vCenter Orchestrator Plug-Ins Favorites Management Workflows The Favorites Management workflow category contains workflows related to the management of favorite Active Directory objects. You can access these workflows from Library > Microsoft > Favorites Management. Workflow Name Description Add a favorite computer Adds a computer to the list of favorites. Add a favorite group Adds a group to the list of favorites.
Using the Dynamic Types Plug-In 18 The Orchestrator Dynamic Types plug-in lets you define dynamic types, create objects of these types, and set relations between them. The definition of a dynamic type contains the descriptions of its properties and a set of finder workflows and actions which can be used to find dynamic objects of this type. Runtime instances of dynamic types are called dynamic objects. You can run workflows on the dynamic objects you create and perform different operations on them.
Using VMware vCenter Orchestrator Plug-Ins 108 Workflow Name Description Import Type Definitions From XSD Imports type definitions from an XSD file. Remove Namespace Removes a namespace. Remove Relation Removes a relation. Remove Type Removes a type. Update Namespace Updates a namespace. Update Type Updates a type. VMware, Inc.
Configuring and Using the Multi-Node Plug-In 19 The Multi-Node plug-in workflow library contains workflows for hierarchical orchestration, management of Orchestrator instances, and scale-out of Orchestrator activities.
Using VMware vCenter Orchestrator Plug-Ins Configuring the Multi-Node Plug-In You must use the Orchestrator client to configure the Multi-Node plug-in. Servers Configuration Workflows The Servers Configuration workflow category contains workflows that allow you to configure the connected Orchestrator servers. You can access these workflows from Library > Orchestrator > Servers Configuration on the Workflows view in the Orchestrator client.
Chapter 19 Configuring and Using the Multi-Node Plug-In Cause Orchestrator does not permit the usage of the default SSL certificates. After you install or upgrade Orchestrator, a new self-signed certificate is generated. The newly generated SSL certificate is unique for each Orchestrator instance. To run remote workflows, the primary Orchestrator server must trust the SSL certificate of the remote Orchestrator server.
Using VMware vCenter Orchestrator Plug-Ins The synchronous proxy workflow completes the run after the remote workflow completes and provides output parameters. The local workflow consumes no server resources while waiting for the results of the remote workflow. At the end of a successful run the output parameters of the proxy workflow contain a local representation of the remote workflow token.
Chapter 19 Configuring and Using the Multi-Node Plug-In An asynchronous proxy workflow returns immediately a result that is a local wrapper of the remote workflow token object. The proxy workflow uses this token to check the state of the run and to retrieve the output parameters when the remote workflow completes its run. The output parameters can be used directly by other workflows on the local Orchestrator server when they are of simple type, such as, boolean, number, string, and similar.
Using VMware vCenter Orchestrator Plug-Ins Remote Management Workflows The Remote Management workflow category contains workflows that allow you to manage packages and workflows on remote Orchestrator instances. Packages You can access the workflows for managing remote packages from Library > Orchestrator > Remote Management > Packages on the Workflows view in the Orchestrator client. Workflow Name Description Delete a package Deletes a package and its contents from a remote Orchestrator server.
Chapter 19 Configuring and Using the Multi-Node Plug-In What to do next You can copy code from API elements and paste it into scripting boxes. For more information about API scripting, see Developing with VMware vCenter Orchestrator. Multi-Node Plug-In Use Cases The Multi-Node plug-in use cases include user scenarios such as importing a package from the local Orchestrator server to the remote servers, using multi proxy actions, as well as information about maintenance of remote and proxy workflows.
Using VMware vCenter Orchestrator Plug-Ins Workflow Name Description Delete all finished workflow runs Deletes all finished workflow runs from a remote workflow. Delete a remote workflow Deletes a workflow from a remote Orchestrator server. Deploy a workflow from a local server Deploys a workflow from a local Orchestrator server to a list of remote Orchestrator servers.
Using the PowerShell Plug-In 20 The PowerShell plug-in workflow library contains workflows that allow you to manage PowerShell hosts and run custom PowerShell operations. You can use the Inventory view in the Orchestrator client to manage the available PowerShell resources. You can use the scripting API of the plug-in to develop custom workflows.
Using VMware vCenter Orchestrator Plug-Ins Configuring the PowerShell Plug-In You must use the Orchestrator client to configure the PowerShell plug-in. Configuration Workflows The Configuration workflow category contains workflows that allow you to manage PowerShell hosts. You can access these workflows from Library > PowerShell > Configuration on the Workflows view in the Orchestrator client. Workflow Name Description Add a PowerShell host Adds a PowerShell host to the plug-in's inventory.
Chapter 20 Using the PowerShell Plug-In } [domain_realms] .yourdomain.com=YOURDOMAIN.COM yourdomain.com=YOURDOMAIN.COM NOTE The Kerberos authentication requires a Fully Qualified Domain Name (FQDN) host address. IMPORTANT When you add or modify the krb5.conf file, you must restart the Orchestrator server service. Add a PowerShell Host You can run a workflow to add a PowerShell host and configure the host connection parameters. You can set up a connection to a remote or a local PowerShell host.
Using VMware vCenter Orchestrator Plug-Ins Running PowerShell Scripts You can run workflows to invoke an external or custom script on a PowerShell host. Invoke a PowerShell Script You can run an existing or custom PowerShell script on a host in the plug-in's inventory. Prerequisites n Verify that you are logged in to the Orchestrator client as an administrator. n Verify that you have a connection to a PowerShell host from the Inventory view.
Chapter 20 Using the PowerShell Plug-In Generating Actions You can run workflows to generate actions based on a PowerShell script or a PowerShell cmdlet. You can use the generated actions as building blocks for custom workflows. Generate an Action from a PowerShell Script You can run a workflow to generate an action from a PowerShell script that you provide. You can optionally generate a sample workflow that can run the generated action.
Using VMware vCenter Orchestrator Plug-Ins Generate an Action for a PowerShell Cmdlet You can run a workflow to generate an action for a PowerShell cmdlet and parameter set that you provide. With this action, you can use PowerShell functionality in Orchestrator. You can optionally generate a sample workflow that can run the generated action. You can use a large set of data types with the PowerShell script engine.
Chapter 20 Using the PowerShell Plug-In Passing Invocation Results Between Actions The PowerShell plug-in supports passing of results as parameters from one PowerShell script invocation to another. To pass results correctly, both invocations must happen in the same session. PowerCLI Integration with the PowerShell Plug-In You can use functionality that is available in a third-party snap-in, such as VMware vSphere PowerCLI, with the PowerShell plug-in.
Using VMware vCenter Orchestrator Plug-Ins Workflow Name Description Toggle virtual machine state Toggles the power state of a virtual machine. Access the PowerShell Plug-In API Orchestrator provides an API Explorer to allow you to search the PowerShell plug-in API and see the documentation for JavaScript objects that you can use in scripted elements. Procedure 1 Log in to the Orchestrator client as an administrator.
Chapter 20 Using the PowerShell Plug-In n If the returned object is of type complex, the object is represented as PSObject. Examples of Scripts for Common PowerShell Tasks You can cut, paste, and edit the JavaScript examples to write scripts for common PowerShell tasks. For more information about scripting, see the vCenter Orchestrator Developer's Guide. Example: Run a PowerShell Script Through the API You can use JavaScript to run a PowerShell script through the API of the plug-in.
Using VMware vCenter Orchestrator Plug-Ins //Check for errors if (invResult.invocationState == 'Failed'){ System.error(invResult.getErrors()); } else { //Get PowerShellRemotePSObject var psObject = invResult.getResults(); var directories = psObject.getRootObject(); var isList = directories instanceof Array if ( isList ){ for (idx in directories){ var item = directories[idx]; if ( item.instanceOf('System.IO.FileInfo') ){//Check type of object System.log( item.
Chapter 20 Using the PowerShell Plug-In Troubleshooting If you encounter problems when running or using PowerShell plug-in, you can use a troubleshooting topic to understand and solve the problem, if there is a workaround. Servers Not Found in Kerberos Database After you add servers with Kerberos authentication, the servers might not be found because they are not added correctly. Problem When you try to connect to a server, the server is not found in Kerberos database.
Using VMware vCenter Orchestrator Plug-Ins Solution Synchronize the system times in the environment. Kerberos Authentication Session Mode Fails When you use Kerberos authentication with Shared Session or Session per User, adding the PowerShell host might fail. Problem When you attempt to add a PowerShell host to the plug-in's inventory using Shared Session or Session per User, the workflow fails, and the following error appears.
Index A action generation 121 Active Directory plug-in 103 Active Directory plug-in configuration 103 add a database 54 add a vCenter Server instance 20 add a vCO server 110 add tables to a database 54 adding a database 48 adding a PowerShell host 119 adding a REST host 80 adding a REST operation 81 adding a SOAP host 86 adding an AMQP broker 91 adding an SNMP query 99 adding an XSD schema to a REST host 82 adding tables to a database 48 AMQP broker 91 AMQP plug-in 91 API, working with results 124 API Expl
Using VMware vCenter Orchestrator Plug-Ins H SQL plug-in 12 SSH plug-in 12 vCenter Server plug-in 12 vCO Library plug-in 12 vCO Weboperator plug-in 12 XML plug-in 12 host configure 118 manage 118 host folder management workflows 26 host management registration workflows 28 HTTP-REST plug-in 79 I JDBC connection, testing 50 JDBC dropping, testing 53 JDBC entry deletion, testing 52, 53 JDBC full cycle, testing 54 JDBC plug-in, usage 47 JDBC row insertion, testing 51 JDBC row selection, testing 52 JDBC sa
Index SNMP traps, receive 100 SOAP plug-in 85 SQL operations 54 SQL plug-in, usage 47 SQL plug-in configuration 47 SSH commands, running 59 SSH file copy SCP get command 60 SCP put command 61 SSH plug-in, usage 57 SSH plug-in sample workflows 57 SSH workflows changing a key pair passphrase 59 generating a key pair 58 registering a public key 59 standard virtual switch workflows 30 storage DRS workflows 31 storage workflows 31 synchronous 111 T tools clone workflows 35 trap host management 99 troubleshooti
Using VMware vCenter Orchestrator Plug-Ins organizational unit 104 other 37 power host management 28 power management 37 query management 98 remote execution 113 remote management 114 resource pool 30 sample 123 servers configuration 110 snapshot 38 standard workflows 54 standard virtual switch 30 storage 31 Storage DRS 31 testing a custom generated workflow 88 tools clone 35 trap host management 100 user 105 user group 105 vCenter Server configuration 19 virtual machine folder management 26 VMware Tools 3
