Using the vCenter Orchestrator Plug-In
for vSphere Auto Deploy 1.0
vCenter Orchestrator 4.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.
EN-000756-01
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:
Copyright © 2011 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws. VMware products are covered by one or more patents listed at http://www.vmware.com/go/patents.
VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.
VMware, Inc.
3401 Hillview Ave.
Palo Alto, CA 94304 www.vmware.com
Contents
Using the vCenter Orchestrator Plug-In for vSphere Auto Deploy 1.0 5
Updated Information 7
1 Introduction to the Auto Deploy Plug-In 9
Role of vCenter Orchestrator with the Auto Deploy Plug-In 10 Installing the Auto Deploy Plug-In 10
Auto Deploy Plug-In Functional Prerequisites 10 Install the Auto Deploy Plug-In 10
2 Using the Auto Deploy Plug-In 13
Configuring the Auto Deploy Plug-In 13 Configuration Workflows 13 Auto Deploy Hosts Workflows 13 Depots Workflows 14
Using the Auto Deploy Plug-In Standard Workflows 15 Answer Files Workflows 15
Reprovision Host Workflows 16 Rule Set Compliance Workflows 16 Rules Workflows 17
Using the Auto Deploy Plug-In Inventory 19
Exporting and Importing Auto Deploy Configuration 19 Export Auto Deploy Configuration as a Package 20 Import Auto Deploy Configuration from a Package 20 Access the Auto Deploy Plug-In API 21
Index 23
Using the vCenter Orchestrator Plug-In for
vSphere Auto Deploy 1.0
Using the vCenter Orchestrator Plug-In for vSphere Auto Deploy 1.0 provides information and instructions about configuring and using the VMware® vCenter Orchestrator Plug-In for vSphere Auto Deploy 1.0.
Intended Audience
This information is intended for anyone who is installing and configuring the plug-in, using the API of the plug-in, and using the workflow and actions library. Using the vCenter Orchestrator Plug-In for vSphere Auto Deploy 1.0 is written for experienced users who are familiar with virtual machine technology, with Orchestrator workflow development, and with vSphere Auto Deploy.
For more information about Orchestrator, see
http://www.vmware.com/support/pubs/orchestrator_pubs.html.
For more information about vSphere 5.0, see https://www.vmware.com/support/pubs/vsphere-esxi-vcenter- server-pubs.html.
Updated Information
Using the vCenter Orchestrator Plug-In for vSphere Auto Deploy 1.0 is updated with each release of the product or when necessary.
This table provides the update history of Using the vCenter Orchestrator Plug-In for vSphere Auto Deploy 1.0.
Revision Description
EN-000756-01 n Added more detailed information about the Add a depot workflow in “Depots Workflows,” on page 14.
n Added information about the usage of image profiles in “Reprovision Host Workflows,” on page 16 and “Rules Workflows,” on page 17.
EN-000756-00 Initial release.
Introduction to the Auto Deploy Plug-
In 1
The Auto Deploy plug-in allows simplified and automated provisioning of physical hosts with ESXi software by interacting with Auto Deploy server using a VMODL interface.
Image profiles Host Profiles
and answer files
vCenter Orchestrator
Host profile engine
Plug-in
ESXi host
HTTP fetch of images/VIBS and host profiles (gPXE boot
and update)
Public depot VIBs and image profiles Auto Deploy
server (web server) Rules Engine SOAP over HTTPS
HTTP/HTTPS
Auto Deploy plug-in
The plug-in contains a set of standard workflows allowing you to configure access to public depots and Auto Deploy servers. You can provision and reprovision hosts by manipulating the rules and rule sets within the rule engine of the Auto Deploy server. You can associate hosts with image profiles, host profiles, and location of the vCenter Server instances. You can also determine rules which match a host, and hosts impacted by a rule and rule set.
This chapter includes the following topics:
n “Role of vCenter Orchestrator with the Auto Deploy Plug-In,” on page 10 n “Installing the Auto Deploy Plug-In,” on page 10
Role of vCenter Orchestrator with the Auto Deploy Plug-In
You must use the Orchestrator configuration interface to install the Auto Deploy plug-in. You use the Orchestrator client to run and create workflows and access the plug-in API.
The Auto Deploy plug-in is powered by vCenter Orchestrator. Orchestrator is a development and process- automation platform that provides a library of extensible workflows to manage the VMware vCenter infrastructure and other technologies.
Orchestrator allows integration with management and administration solutions through its open plug-in architecture.
Installing the Auto Deploy Plug-In
You must use the Orchestrator configuration interface to install the Auto Deploy plug-in.
Auto Deploy Plug-In Functional Prerequisites
To be able to install and use the Auto Deploy plug-in, your system must meet certain functional prerequisites.
vCenter Orchestrator
Verify that you have a running instance of Orchestrator. You can log in to the Orchestrator configuration interface at http://orchestrator_server:8282. Version 1.0 of the plug-in works with vCenter Orchestrator 4.2.
For information about setting up Orchestrator, see Installing and Configuring VMware vCenter Orchestrator.
vCenter Server Plug-In
Verify that you have vCenter Server plug-in 5.0 installed. See Using the vCenter Orchestrator Plug-In for vCenter Server 5.0.
vSphere Auto Deploy
Verify that you have access to a configured Auto Deploy server. See vSphere Installation and Setup.
On the Linux version you should edit the /etc/vmware-rbd/httpd/conf/httpd.conf file.
You should edit the following properties on your Auto Deploy server to optimize the performance.
Property Description Recommended Value
KeepAlive Allows persistent connections with more than one request per
connection. On
MaxKeepAliveRequest Sets the maximum number of allowed requests during a persistent connection. When set to 0 the number of requests is unlimited. 0 KeepAliveTimeout Sets the number of seconds to wait for the next request from the same
client on the same connection. At least 300.
Install the Auto Deploy Plug-In
To be able to use the Auto Deploy plug-in, you must download the .vmoapp file containing the plug-in and install it by using the Orchestrator configuration interface.
Prerequisites
n Verify that you are logged in to the Orchestrator configuration interface at http://orchestrator_server:8282.
n Verify that you have downloaded the .vmoapp file from
http://www.vmware.com/products/datacenter-virtualization/vcenter-orchestrator/plugins.html.
Procedure
1 On the General tab, click Install Application.
2 Upload the Auto Deploy plug-in.
a Click the magnifying glass icon.
b Select the .vmoapp file to install.
c Click Open.
d Click Install.
The Auto Deploy plug-in tab appears in the Orchestrator configuration interface.
3 On the Startup Options tab, click Restart service to complete the plug-in installation.
Chapter 1 Introduction to the Auto Deploy Plug-In
Using the Auto Deploy Plug-In 2
The Auto Deploy plug-in workflow library contains workflows that allow you to configure access to public depots and provision ESXi hosts.
You can use the Inventory view in the Orchestrator client to manage the available Auto Deploy resources. You can use the scripting API of the plug-in to develop custom workflows.
This chapter includes the following topics:
n “Configuring the Auto Deploy Plug-In,” on page 13 n “Using the Auto Deploy Plug-In Inventory,” on page 19
n “Exporting and Importing Auto Deploy Configuration,” on page 19 n “Access the Auto Deploy Plug-In API,” on page 21
Configuring the Auto Deploy Plug-In
You must use the Orchestrator client to configure the Auto Deploy plug-in.
Configuration Workflows
The Configuration workflow category contains workflows that allow you to manage depots and Auto Deploy hosts.
You can access these workflows from Library > Auto Deploy > Configuration on the Workflows view in the Orchestrator client.
You can run the Reload plug-in configuration workflow to reload the list of public depots and configured Auto Deploy hosts with an already configured access to vCenter Server instances.
Auto Deploy Hosts Workflows
The Auto Deploy hosts workflow category contains workflows that allow you to manage Auto Deploy hosts.
The workflows allow you to configure the Auto Deploy host properties that are used during the plug-in run.
You can access these workflows from Library > Auto Deploy > Configuration > Auto Deploy hosts on the Workflows view in the Orchestrator client.
Workflow Name Description
Add an Auto Deploy host Adds a new Auto Deploy host for the already configured vCenter Server instance. The connections between the plug-in and the host are made using HTTPS protocol. In case the
Depots Workflows
The Depots workflow category contains workflows that allow you to manage Auto Deploy depots and use image profiles along with the provided software packages.
You can access Depots workflows from Library > Auto Deploy > Configuration > Depots on the Workflows view in the Orchestrator client.
Workflow Name Description
Add a depot Adds a public depot. The connections between the plug-in and the depot are made using the HTTP or HTTPS protocol. In case the certificate is not trusted, you must accept it to be installed.
IMPORTANT You must specify the index.xml in the URL.
Remove a depot Removes a public depot.
Update a depot Updates a public depot.
Add a Depot
You can run a workflow to add a new depot. The added depot allows you to use image profiles along with the provided software packages during the use of the plug-in.
Procedure
1 Log in to the Orchestrator client as an administrator.
2 Click the Workflows view in the Orchestrator client.
3 In the hierarchical list of workflows, select Library > Auto Deploy > Depots and navigate to the Add a depot workflow.
4 Right-click the Add a depot workflow and select Start workflow.
5 In the Depot Name text box, type a name for the new depot.
6 In the Depot URL text box, type the location of the depot.
7 Click Submit to run the workflow.
Update a Depot
You can run a workflow to update a depot.
Procedure
1 Log in to the Orchestrator client as an administrator.
2 Click the Workflows view in the Orchestrator client.
3 In the hierarchical list of workflows, select Library > Auto Deploy > Depots and navigate to the Update a depot workflow.
4 Right-click the Update a depot workflow and select Start workflow.
5 Select the depot that you want to update.
6 Provide the information for the depot update.
Option Action
Depot name Type the new name for the depot.
Depot URL Type the new URL for the depot.
7 Click Submit to run the workflow.
Using the Auto Deploy Plug-In Standard Workflows
The Auto Deploy workflow category contains workflows that allow you to get host attributes and manage SSL certificates.
You can access these workflows from Library > Auto Deploy on the Workflows view in the Orchestrator client.
Workflow Name Description
Get host attributes Gets the ESXi attributes that are used when the Auto Deploy server evaluates the rules.
Manage SSL certificates Verifies a host URL, and if required, shows a user interaction message for the approval of SSL certificates.
Answer Files Workflows
The Answer Files workflow category contains workflows that allow you to manage answer files in an XML format. The answer files are used when a user input is needed during applying of host configuration . You can access these workflows from Library > Auto Deploy > Answer Files on the Workflows view in the Orchestrator client.
Workflow Name Description
Clear an answer file Clears the contents of an answer file associated with a specified ESXi host.
Get an answer file Retrieves an answer file associated with a specific ESXi host.
Get answer file status Retrieves the status of an answer file associated with a specific ESXi host. An answer file can be valid, invalid, or unknown.
Valid Indicates that the answer file for the host and the associated profile contains all the required inputs.
Invalid Indicates that the answer file for the host and the associated profile exists, but some of the required inputs are missing.
Unknown Indicates that the answer file is associated with a host, but the associated profile is missing.
Update an answer file Updates an answer file from editable XML content. Creates an answer file when it is missing. The created answer file has simple XML content with empty tags that you can fill.
Editing the XML Content of an Answer File
You can edit the default XML content when running the Update an answer file workflow.
When you run the Update an answer file workflow, and the answer file is missing, the following XML content appears in the Answer file content text box.
<answerFile>
<userInputParameter>
<profilePath>{}</profilePath>
<policyId>{}</policyId>
<parameterId>{}</parameterId>
<keyValuePair>
<key>{}</key>
<value>{}</value>
</keyValuePair>
</userInputParameter>
Chapter 2 Using the Auto Deploy Plug-In
The following code contains custom values for setting a name of an ESXi host.
<?xml version="1.0" encoding="UTF-8"?>
<answerFile>
<userInputParameter>
<profilePath>network.dnsConfig</profilePath>
<policyId>HostNamePolicy</policyId>
<keyValuePair>
<key>hostName</key>
<value>TestHostName</value>
</keyValuePair>
</userInputParameter>
</answerFile>
Reprovision Host Workflows
The Reprovision host workflows are simple cases and building blocks that allow you to reprovision hosts. You can use the workflows to create more complex scenarios.
You can access these workflows from Library > Auto Deploy > Reprovision host on the Workflows view in the Orchestrator client.
When the plug-in uses an image profile for the first time, the workflow takes more time to complete than a standard workflow run. If the plug-in has previously used the image profile, a workflow run takes less time to complete.
NOTE The Reprovision host workflows cannot manage running virtual machines. You can use workflows from the vCenter Server plug-in to manage the running virtual machines.
Workflow Name Description
Reprovision a host by simple reboot Reprovisions the host by repairing the rule set compliance and rebooting the host.
Reprovision a host with an answer file Reprovisions the host by updating or creating an answer file. Validates the answer file before remediating the rule set compliance, and rebooting the host.
Reprovision a host with a host profile
and an answer file Reprovisions the host with a new host profile and an answer file. Validates the answer file. Reboots the host when the answer file is valid.
Reprovision a host with a new image Reprovisions the host by changing a specific deploy rule with a new image profile, repairing rule set compliance, and rebooting the host.
Reprovision a host with a new location Reprovisions the host by changing a specific deploy rule with a new vCenter Server location, repairing the rule set compliance, and rebooting the host.
Rule Set Compliance Workflows
The Rule Set Compliance workflow category contains workflows that allow you to check and remediate a rule set compliance for a specific ESXi host.
You can access these workflows from Library > Auto Deploy > Rule Set Compliance on the Workflows view in the Orchestrator client.
Workflow Name Description
Repair an active rule set
compliance Remediates the host to use the revised rule set the next time you boot the host. Updates the image profile, host profile, and location for the specified host in the vCenter Server inventory.
Test a rule set compliance Checks whether the objects associated with a specified ESXi host are in compliance with a rule set.
Rules Workflows
The Rules workflow category contains workflows that allow you to manage Auto Deploy rules and rule sets.
You can access the Rules workflows from Library > Auto Deploy > Rules on the Workflows view in the Orchestrator client.
When the plug-in uses an image profile for the first time, a workflow takes more time to complete than a standard workflow run. If the plug-in has previously used the image profile, a workflow run takes less time to complete.
Workflow Name Description
Activate a deploy rule and a working
set Activates a deploy rule by adding it to both working and active rule sets. All rules that are already in the working rule set are activated too.
Activate a working set Activates all rules from a working rule set by moving them to an active set.
Add to a working set Adds a rule to a working rule set.
Copy a deploy rule Replaces the original rule by creating a new copy and applying all modifications.
As a result, the old rule is hidden and the new rule takes the place of the original one.
Create a deploy rule Creates a new deploy rule.
Delete a deploy rule Deletes a deploy rule from an Auto Deploy host.
Delete all hidden rules Deletes all hidden rules from the rule engine.
Edit a deploy rule Modifies a deploy rule on a specific Auto Deploy host.
Get deploy rules Retrieves all deploy rules from the rule engine of the Auto Deploy server.
Get hidden rules Retrieves all hidden rules from the rule engine of the Auto Deploy server.
Get host matching rules Retrieves all rules which are applicable to a host.
Get rules from active set Retrieves all rules from an active rule set.
Get rules from working set Retrieves all rules from a working rule set.
Remove a deploy rule from a rule set Removes a rule from a rule set without deleting the rule.
Create a Deploy Rule
You can run a workflow to create a deploy rule. The deploy rule allows you to configure the rule engine of a specific Auto Deploy host.
Procedure
1 Log in to the Orchestrator client as an administrator.
2 Click the Workflows view in the Orchestrator client.
3 In the hierarchical list of workflows, select Library > Auto Deploy > Rules and navigate to the Create a deploy rule workflow.
4 Right-click the Create a Deploy Rule workflow and select Start workflow.
5 Provide the information for the Create a Deploy Rule workflow.
Option Action
Auto Deploy host Select the Auto Deploy host.
Type the name for the rule.
Chapter 2 Using the Auto Deploy Plug-In
Pattern Type the values for the host attributes.
Type Specify the rule type.
n Datacenter n Host folder n Cluster
6 Browse to select the vSphere inventory object.
7 Click Submit to run the workflow.
The new rule is editable and it is not added to any rule set.
Copy a Deploy Rule
You can run a workflow to copy a deploy rule and modify a noneditable rule that is added to the active rule set.
Procedure
1 Log in to the Orchestrator client as an administrator.
2 Click the Workflows view in the Orchestrator client.
3 In the hierarchical list of workflows, select Library > Auto Deploy > Rules and navigate to the Copy a deploy rule workflow.
4 Right-click the Copy a deploy rule workflow and select Start workflow.
5 Select a deploy rule to copy.
6 (Optional) In the New rule name text box, type the new name for the rule.
7 Select whether to change PXE profile, Host profile, and Inventory location, and specify the new details.
8 In the Pattern text box, type the new rule pattern.
9 Select whether to update the rule sets.
10 Select whether to activate the rule.
11 Click Submit to run the workflow.
The old rule is hidden. The new modified rule takes the place of the original rule.
Edit a Deploy Rule
You can run a workflow to edit an editable deploy rule that is not activated.
Procedure
1 Log in to the Orchestrator client as an administrator.
2 Click the Workflows view in the Orchestrator client.
3 In the hierarchical list of workflows, select Library > Auto Deploy > Rules and navigate to the Edit a deploy rule workflow.
4 Right-click the Edit a deploy rule workflow and select Start workflow.
5 Select a deploy rule to edit.
6 In the New rule name text box, type the new name for the rule.
7 Select whether to change PXE profile, Host profile, and Inventory location, and specify the new details.
8 In the Pattern text box, type the new rule pattern.
9 Click Submit to run the workflow.
Using the Auto Deploy Plug-In Inventory
The Auto Deploy plug-in exposes rules and public depots from Auto Deploy host in the Inventory view. You can use the Inventory view to add authorization elements or to run workflows on configured public depots and objects related with Auto Deploy host.
You can enable the Use contextual menu in inventory option to display the workflows that are available for an inventory object. After the option is enabled, when you right-click an object in the Orchestrator inventory, all available workflows for the object are displayed.
You can refresh the list of inventory objects by pressing F5.
The rules that are higher in the inventory list are with higher priority.
The rules above the active and working rule sets do not belong to any rule set.
Exporting and Importing Auto Deploy Configuration
You can transfer the configuration of the Auto Deploy plug-in from one Orchestrator instance to another by creating a configuration package. You can export all plug-in elements, such as Auto Deploy hosts, public
Chapter 2 Using the Auto Deploy Plug-In
Export Auto Deploy Configuration as a Package
You can export elements of the Auto Deploy plug-in configuration as an Orchestrator package.
Prerequisites
Verify that you are logged in to the Orchestrator client as an administrator.
Procedure
1 Click the Packages view in the Orchestrator client.
2 From the Packages drop-down menu, select Add package.
3 Type the name of the package and click Ok.
4 Right-click the package that you added and select Edit.
5 From the Resources tab, select Insert Resource Element (tree browsing).
Option Action
Add all available Auto Deploy depots In the hierarchical list, select Library > Auto Deploy and click Select.
Add a specific Auto Deploy depot Expand the hierarchical list to Library > Auto Deploy, select an Auto Deploy depot, and click Select.
6 (Optional) From the Workflows tab, add custom Auto Deploy plug-in workflows.
7 (Optional) From the General tab, provide a description of the package.
8 Click Save and close.
9 Right-click the edited package and select Export package.
10 Type the file name, select a location, and click Save.
Import Auto Deploy Configuration from a Package
You can import elements of the Auto Deploy plug-in configuration from an Orchestrator package.
Prerequisites
n Verify that you are logged in to the Orchestrator client as an administrator.
n Verify that the Auto Deploy plug-in is installed on the Orchestrator instance.
Procedure
1 Click the Packages view in the Orchestrator client.
2 From the Packages drop-down menu, select Import package.
3 Browse to select the package to import and click Open.
Certificate information about the exporter appears.
4 Review the package import details and select Import or Import and trust provider.
The Import package view appears. If the version of the imported package element is later than the server version, the system selects the element for import.
5 Click Import checked elements.
The imported package appears in the list of packages.
6 Click the Workflows view in the Orchestrator client.
7 In the hierarchical list of workflows, select Library > Auto Deploy > Configuration and navigate to the Reload plug-in configuration workflow.
8 Right-click the Reload plug-in configuration workflow and select Start workflow to refresh the list of Auto Deploy depots.
The imported Auto Deploy depot appear in the Inventory view.
Access the Auto Deploy Plug-In API
Orchestrator provides an API Explorer to allow you to search the Auto Deploy 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.
2 Access the API Explorer from either the Orchestrator client or from the Scripting tabs of the workflow, policy, and action editors.
n To access the API Explorer from the Orchestrator client, click Tools > API Explorer in the Orchestrator client toolbar.
n To access the API Explorer from the Scripting tabs of the workflow, policy, and action editors, click Search API on the left.
3 To expand the hierarchical list of Auto Deploy plug-in API objects, double-click the Auto Deploy module in the left pane.
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.
Chapter 2 Using the Auto Deploy Plug-In
Index
A
adding a new depot 14 API access 21 Auto Deploy host 13 Auto-Deploy plug-in 9
C
configuration exporting 20 importing 20
configuration transfer 19 configuration workflows 13 copy a deploy rule 18 creating a deploy rule 17
E
edit a deploy rule 18 edit XML content 15
F
functional prerequisites 10
I
installation 10
installation process 10 introduction 9
Inventory 19
O
Orchestrator 10
R
reprovision host workflows 16 rule set compliance 16
U
updated information 7 updating a depot 14
W
workflow 16 workflow library 13
depots 14 rules 17
