Extensibility vCloud Automation Center 6.0

Extensibility vCloud Automation Center 6.0
Extensibility
vCloud Automation Center 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-001328-00
Extensibility
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
Extensibility
5
1 Introduction 7
vCloud Automation Center Extensibility Options 7
Leveraging Existing and Future Infrastructure 8
Configuring Business-Relevant Services 8
Integrating with Third-Party Management Systems 9
Adding New IT Services and Creating New Actions 9
Calling vCloud Automation Center Services from External Applications
Distributed Execution 9
9
2 Installing and Configuring vCloud Automation Center Designer 11
Installing vCloud Automation Center Designer 11
Configuring vCenter Orchestrator Endpoints 13
3 Customizing IaaS Workflows 17
The vCloud Automation Center Designer Console 17
IaaS Workflow Types 19
Customize an IaaS Workflow 21
Using vCenter Orchestrator Workflow Activities 22
Configure a Blueprint to Call a State Change Workflow
Configuring a Menu Operation Workflow 26
Revert to a Previous Revision of a Workflow 30
25
4 Workflows and Distributed Execution Management 31
Associate Workflows and DEM Workers by Using Skills 31
Remove Associations between Skills and DEM Workers 32
Remove Associations between Skills and Workflows 32
Remove a Skill 33
5 CloudUtil Command Reference 35
DEM Commands 35
File Commands 36
Operation Commands 39
Skill Commands 40
Workflow Commands 41
6 vCloud Automation Center Workflow Activity Reference 43
DynamicOps.Repository.Activities
DynamicOps.Cdk.Activities 46
VMware, Inc.
43
3
Extensibility
Index
4
53
VMware, Inc.
Extensibility
Extensibility provides information about customizing IaaS workflows by using
vCloud Automation Center Designer and its associated command-line tools.
It covers the following subjects:
Overview of extensibility options with vCloud Automation Center
n
n
vCloud Automation Center Designer installation
n
Customizing workflows, including calling vCenter Orchestrator workflows from IaaS
n
Associating workflows and Distributed Execution Managers by using skills
n
Reference information for the CloudUtil command-line tool
Intended Audience
This information is intended for workflow developers who want to use
vCloud Automation Center Designer to customize IaaS workflows.
For information about using the Advanced Service Designer to call vCenter Orchestrator workflows, see
Advanced Service Design. For information about configuring vCenter Orchestrator for use with the Advanced
Service Designer, see Advanced Service Designer Configuration.
VMware Technical Publications Glossary
VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions
of terms as they are used in VMware technical documentation, go to
http://www.vmware.com/support/pubs.
VMware, Inc.
5
Extensibility
6
VMware, Inc.
Introduction
1
The architecture of vCloud Automation Center is designed with extensibility in mind. To satisfy different
extensibility use cases, vCloud Automation Center offers a variety of configuration options and tools.
This chapter includes the following topics:
n
“vCloud Automation Center Extensibility Options,” on page 7
n
“Leveraging Existing and Future Infrastructure,” on page 8
n
“Configuring Business-Relevant Services,” on page 8
n
“Integrating with Third-Party Management Systems,” on page 9
n
“Adding New IT Services and Creating New Actions,” on page 9
n
“Calling vCloud Automation Center Services from External Applications,” on page 9
n
“Distributed Execution,” on page 9
vCloud Automation Center Extensibility Options
vCloud Automation Center is a flexible cloud management platform that enables customization and
extensibility at multiple levels.
VMware, Inc.
7
Extensibility
Leveraging Existing and Future Infrastructure
vCloud Automation Center provides out-of-the box support for many types of infrastructure and
provisioning methods.
Infrastructure administrators can integrate with several infrastructure sources including virtual hypervisors
(vSphere, Hyper-V, KVM (RHEV), and so on), public clouds (including vCloud Hybrid Service and
Amazon AWS), and physical infrastructure.
Blueprint authors can control many machine options, including provisioning methods, by configuring
blueprints for various types of infrastructure.
For a full list of supported infrastructure types and provisioning methods, see the vCloud Automation Center
Support Matrix. For information about configuring infrastructure blueprints, see the IaaS Configuration
documentation for the relevant machine type.
Configuring Business-Relevant Services
The vCloud Automation Center console enables administrators to configure business- and user-specific
policies through a web-based user interface without writing any code.
These business policies include entitlements and approvals for the service catalog, resource reservation
policies for infrastructure, and many others. For information about customization tasks that you can
perform through the vCloud Automation Center console, see Tenant Administration or the IaaS Configuration
documentation for the relevant machine type.
Using custom properties, machine blueprint authors can define additional machine properties or override
their standard attributes for a variety of purposes. For details about the use and configuration of custom
properties, see the IaaS Configuration documentation for the relevant machine type or the Custom Properties
Reference.
8
VMware, Inc.
Chapter 1 Introduction
Integrating with Third-Party Management Systems
Provisioning or decommissioning a new machine, especially for mission-critical systems, typically requires
interacting with a number of different management systems, including DNS servers, load balancers,
CMDBs, IP Address Management and other systems.
Using vCloud Automation Center Designer, administrators can inject custom logic (known as workflows) at
various predetermined IaaS life cycle stages. These IaaS workflows can call out to vCenter Orchestrator for
bi-directional integration with external management systems.
For details about working with IaaS workflows, see Chapter 3, “Customizing IaaS Workflows,” on
page 17.
Adding New IT Services and Creating New Actions
The Advanced Services Designer enables service architects to define new services and new management
operations on provisioned services.
vCloud Automation Center provides a range of management operations that you can perform on machines
out of the box. Your organization may find it valuable to extend the default IaaS machine menus with new
options, such as creating a machine backup or running a security check.
It can also be beneficial to expose entirely new services in the service catalog, so that users can automate
other initiatives directly via the portal. Service architects can create service blueprints for storage-as-aservice, networking services or virtually any kind of IT service by using the Advanced Services Designer.
For details about how to create new catalog items or menu options, see Advanced Service Design.
Calling vCloud Automation Center Services from External
Applications
In some cases, organizations may want to interact with vCloud Automation Center programmatically rather
than via the vCloud Automation Center console.
For such scenarios, the vCloud Automation Center API provides a standardized, secured RESTful interface
for cloud access and interaction, controlled through business-aware policy for consumers such as users,
infrastructure, devices, and applications.
All blueprints, including the ones created via the Advanced Services Designer, are automatically exposed
through the vCloud Automation Center API. For more details, see the vCloud Automation Center API
Reference.
NOTE The vCloud Automation Center API is currently available as a beta feature in
vCloud Automation Center 6.0.
Distributed Execution
All core vCloud Automation Center workflows are executed in a distributed execution environment.
The vCloud Automation Center runtime environment consists of one or more DEM Worker instances that
can execute any workflow installed in the core engine. Additional Worker instances can be added as needed
for scalability, availability and distribution.
VMware, Inc.
9
Extensibility
Skills can be used to associate DEMs and workflows, restricting execution of a given workflow to a
particular DEM or set of DEMs with matching skills. Any number and combination of skills can be
associated with a given workflow or DEM. For example, workflow execution can be restricted to a specific
datacenter, or to environments that support a specific API the workflow requires. The
vCloud Automation Center Designer and the CloudUtil command-line tool provide facilities for mapping
skills to DEMs and workflows.
For more information about distributed execution and working with skills, see Chapter 4, “Workflows and
Distributed Execution Management,” on page 31.
10
VMware, Inc.
Installing and Configuring
vCloud Automation Center Designer
2
You can install vCloud Automation Center Designer on a Windows machine and configure it to
communicate with a remote Model Manager instance. If you are using IaaS workflows to call
vCenter Orchestrator workflows, you must also configure the vCenter Orchestrator instance in IaaS.
This chapter includes the following topics:
n
“Installing vCloud Automation Center Designer,” on page 11
n
“Configuring vCenter Orchestrator Endpoints,” on page 13
Installing vCloud Automation Center Designer
You can install vCloud Automation Center Designer on a Windows machine and configure it to
communicate with a remote Model Manager instance.
vCloud Automation Center Designer Prerequisites
vCloud Automation Center Designer is typically installed on a development machine rather than a server.
Supported Operating Systems
n
Windows Server 2008 R2 SP1 (64-bit)
n
Windows 7 SP1 (32- or 64-bit)
n
Windows Vista Business (32- or 64-bit)
n
Windows XP SP3 (32- or 64-bit)
System Configuration Requirements
n
.NET Framework 4.5 must be installed.
n
The vCloud Automation Center Designer host must have network access to the IaaS Website
components (specifically, the Model Manager Web component).
n
If the Model Manager is installed remotely, the certificate used for the Model Manager Web component
must be trusted on the vCloud Automation Center Designer host.
VMware, Inc.
11
Extensibility
Download the vCloud Automation Center Designer Installer
The vCloud Automation Center Designer installer can be downloaded from the
vCloud Automation Center Appliance.
Prerequisites
Log in to the Windows machine as a local administrator.
Procedure
1
Open a browser.
If you are using Internet Explorer, verify that Enhanced Security Configuration is not enabled. See
res://iesetup.dll/SoftAdmin.htm.
2
Navigate to the Windows installer download page by using the host name of the (https://vcac-vahostname.domain.name:5480/installer/).
3
Click vCloud Automation Center Designer.
4
When prompted, save the installer.
What to do next
“Install vCloud Automation Center Designer,” on page 12.
Install vCloud Automation Center Designer
The vCloud Automation Center Designer installer is packaged as Windows installation wizard.
Prerequisites
“Download the vCloud Automation Center Designer Installer,” on page 12.
Procedure
1
Navigate to the directory where you downloaded the installer.
2
Right-click DesignCenter-Setup.exe and select Run as administrator.
3
On the Welcome page, click Next.
4
On the End-User License Agreement page, read the License Agreement, select I accept the terms in the
License Agreement, then click Next.
5
On the Custom Setup page, click Next.
6
On the Model Manager Web Service Host Name page, specify the fully qualified domain name and port
of the Model Manager Web instance in hostname:port format.
The default port is 443.
7
Specify the Model Manager service user credentials.
8
Click Next.
The installer validates the combination of Model Manager host and credentials by attempting to access
to the Model Manager; if it succeeds, you can continue with installation. If an error is returned, you
must provide the correct combination of Model Manager host and credentials before proceeding.
12
9
On the Ready to Install page, click Install.
10
On the Completed the VMware vCloud Automation Center Designer Setup Wizard page, click Finish.
VMware, Inc.
Chapter 2 Installing and Configuring vCloud Automation Center Designer
What to do next
Launch the vCloud Automation Center Designer by clicking Start > VMware > vCAC > vCAC Designer.
Configuring vCenter Orchestrator Endpoints
If you are using IaaS workflows to call vCenter Orchestrator workflows, you must configure the
vCenter Orchestrator instance as an endpoint in IaaS.
You can configure multiple endpoints to connect to different vCenter Orchestrator servers. Each endpoint
must have a priority. When executing vCenter Orchestrator workflows, IaaS tries the highest priority
endpoint first. If that endpoint is not reachable, then it proceeds to try the next highest priority endpoint
until a vCenter Orchestrator server is available to run the workflow.
You can associate a specific vCenter Orchestrator endpoint with a blueprint to ensure that all
vCenter Orchestrator workflows for machines provisioned from that blueprint are run using that endpoint.
vCloud Automation Center Designer always uses the vCenter Orchestrator endpoint with the highest
priority that is available.
NOTE vCloud Automation Center includes an embedded vCenter Orchestrator instance. You can use this as
your vCenter Orchestrator endpoint for running IaaS workflows instead of or in addition to external
vCenter Orchestrator servers. For more information about managing the embedded vCenter Orchestrator
instance, see Advanced Service Designer Configuration.
vCenter Orchestrator Integration Prerequisites
If you are using IaaS workflows to execute vCenter Orchestrator workflows that have input or output
parameters of type VC:VirtualMachine, ensure that you have the vCenter Orchestrator workflows for
converting virtual machine types between vCenter Orchestrator and IaaS.
The required workflows are included by default in vCenter Orchestrator 5.5 as part of the vCenter plugin.
If you are using vCenter Orchestrator 5.1, install the vCloud Automation Center integration package for
vCenter Orchestrator. Download the package com.vmware.library.vcenter.vcac-integration.package from
the vCenter Orchestrator community site at
http://communities.vmware.com/community/vmtn/server/vcenter/orchestrator and import it on each
vCenter Orchestrator server that you set up as an endpoint in IaaS.
For information about importing packages to vCenter Orchestrator, refer to the vCenter Orchestrator
documentation.
Create a vCenter Orchestrator Endpoint
IaaS uses vCenter Orchestrator endpoints to run workflows. vCloud Automation Center Designer also uses
the vCloud Automation Center Designer endpoints to browse the inventory of available workflows.
Prerequisites
Log in to the vCloud Automation Center console as an IaaS administrator.
Procedure
1
Select Infrastructure > Endpoints > Endpoints.
2
Select New Endpoint > Orchestration > vCenter Orchestrator.
3
Type a Name and, optionally, a Description.
VMware, Inc.
13
Extensibility
4
Type a URL with the fully qualified name or IP address of the vCenter Orchestrator server and the
vCenter Orchestrator port number.
The format depends on the version of the vCenter Orchestrator server.
vCenter Orchestrator version
URL format
5.1
https://hostname:port
5.5
https://hostname:port/vco
The transport protocol must be HTTPS. If no port is specified, the default port of 8281 is used.
To use the default vCenter Orchestrator instance embedded in the
vCloud Automation Center Appliance, type
https://vcloud-automation-center-appliance-hostname:8281/vco.
5
Specify the credentials to use to connect to this endpoint.
a
Click the ellipsis next to the Credentials field.
b
Select an existing credential from the list or click New Credentials to provide your
vCenter Orchestrator credentials.
The credentials you use should have Execute permissions for any vCenter Orchestrator workflows
that you want to call from IaaS.
To use the default vCenter Orchestrator instance embedded in the
vCloud Automation Center Appliance, the user name is administrator@vsphere.local and the
password is the administrator password that was specified when configuring SSO.
6
Specify the endpoint priority.
a
Click New Property.
b
Type VMware.VCenterOrchestrator.Priority in the Name text box.
The property name is case sensitive.
c
Type an integer greater than or equal to 1 in the Value text box.
Lower value means higher priority.
d
7
Click the Save icon (
).
Click OK.
Associate a vCenter Orchestrator Endpoint with a Blueprint
You can specify a particular vCenter Orchestrator endpoint to use with a blueprint.
When IaaS runs a vCenter Orchestrator workflow for any machine provisioned from this blueprint, it
always uses the associated endpoint. If the endpoint is not reachable, the workflow fails.
Prerequisites
Log in to the vCloud Automation Center console as a tenant administrator or business group manager.
Procedure
1
14
Select Infrastructure > Blueprints > Blueprints.
VMware, Inc.
Chapter 2 Installing and Configuring vCloud Automation Center Designer
2
Create a new blueprint or edit an existing blueprint.
If you are editing an existing blueprint, the vCenter Orchestrator endpoint you specify only applies to
new machines provisioned from the updated blueprint. Existing machines provisioned from the
blueprint continue to use the highest priority endpoint unless you manually add this property to the
machine.
3
Click the Properties tab.
a
Click New Property.
b
Type VMware.VCenterOrchestrator.EndpointName in the Name text box.
The property name is case sensitive.
c
d
4
VMware, Inc.
Type the name of a vCenter Orchestrator endpoint in the Value text box.
Click the Save icon (
).
Click OK.
15
Extensibility
16
VMware, Inc.
Customizing IaaS Workflows
3
VMware provides a number of workflows that you can customize using the
vCloud Automation Center Designer. These include state change workflows and menu operation
workflows.
IaaS workflows are created using Microsoft Windows Workflow Foundation 4, part of .NET Framework 4.
For information on Windows Workflow Foundation and workflow creation, refer to the Microsoft
documentation. vCloud Automation Center also provides several vCloud Automation Center Designer
activities for running and monitoring vCenter Orchestrator workflows.
The customizable workflow templates provided by VMware demonstrate best practices for structuring
workflows with separate sequences for initialization, custom logic, and finalization. The entire workflow is
wrapped in a TryCatch block for error handling. Any uncaught or rethrown exceptions are logged by the
Distributed Execution Manager that executes the workflow.
After you create a custom IaaS workflow, a blueprint author must enable the workflow on specific
blueprints.
This chapter includes the following topics:
n
“The vCloud Automation Center Designer Console,” on page 17
n
“IaaS Workflow Types,” on page 19
n
“Customize an IaaS Workflow,” on page 21
n
“Using vCenter Orchestrator Workflow Activities,” on page 22
n
“Configure a Blueprint to Call a State Change Workflow,” on page 25
n
“Configuring a Menu Operation Workflow,” on page 26
n
“Revert to a Previous Revision of a Workflow,” on page 30
The vCloud Automation Center Designer Console
The vCloud Automation Center Designer console provides a visual workflow editor for customizing IaaS
workflows.
You must have local administrator rights on the vCloud Automation Center Designer host (typically a
development machine) in order to launch the vCloud Automation Center Designer console.
VMware, Inc.
17
Extensibility
The Toolbox pane on the left provides access to the vCloud Automation Center workflow activity library.
You can drag activities from the toolbox onto the Designer pane to add them to a workflow. The Properties
pane displays the configurable properties of the currently selected activity on the Designer pane. This
interface is very similar to the workflow designer in Visual Studio.
The detail tabs at the bottom of the Designer pane enable you to display and edit variables within the scope
of the selected activity or arguments to the selected activity.
NOTE Variables and arguments are both specified as Visual Basic expressions. However, variable names are
not case sensitive while argument names are case sensitive. For information about valid arguments for the
IaaS workflow activities, see Chapter 6, “vCloud Automation Center Workflow Activity Reference,” on
page 43.
18
VMware, Inc.
Chapter 3 Customizing IaaS Workflows
The Imports tab displays imported namespaces from which you can select entity types to add to the
workflow.
The collapsible Information pane at the bottom of the console displays any errors in configuring activities
and provides access to the XAML representation of the workflow.
IaaS Workflow Types
You can customize two types of workflows by using vCloud Automation Center Designer: state change
workflows and menu operation workflows.
n
A state change workflow is executed when the master workflow transitions between states, for example
at a particular stage during the process of provisioning a new machine.
n
A menu operation workflow is executed when a user selects an option from the Action menu in the
service catalog or from the machine menu in the Infrastructure tab.
State Change Workflows
Creating a state change workflow enables you to trigger the execution of a workflow before the IaaS master
workflow enters a specific state.
For example, you can create custom workflows to integrate with an external database and record
information at different stages of the machine life cycle:
n
Create a custom workflow that runs before the master workflow enters the MachineProvisioned state to
record such information as machine owner, approvers and so on.
n
Create a custom workflow that runs before a machine enters the MachineDisposing state to record the
time at which the machine was destroyed and data such as its resource utilization at last data collection,
last logon, and so on.
The following illustrations show the main states of the master workflow.
vCloud Automation Center Designer provides a customizable workflow for each of these states.
Table 3‑1. Customizable State Change Workflows
Master Workflow State
Customizable Workflow Name
BuildingMachine
WFStubBuildingMachine
Disposing
WFStubMachineDisposing
Expired
WFStubMachineExpired
MachineProvisioned
WFStubMachineProvisioned
VMware, Inc.
19
Extensibility
Table 3‑1. Customizable State Change Workflows (Continued)
Master Workflow State
Customizable Workflow Name
RegisterMachine
WFStubMachineRegistered
UnprovisionMachine
WFStubUnprovisionMachine
Configuring a State Change Workflow Overview
You can customize a state change workflow by using vCloud Automation Center Designer. A blueprint
author can then enable it for specific blueprints.
The following is a high-level overview of the steps required to enable state change workflows:
1
A workflow developer customizes one of the state change workflow templates by using
vCloud Automation Center Designer. See “Customize an IaaS Workflow,” on page 21.
Any IaaS workflow can call a vCenter Orchestrator workflow. For more information, see “Using
vCenter Orchestrator Workflow Activities,” on page 22.
2
A tenant administrator or business group manager configures a blueprint to call the customized
workflow for machines provisioned from that blueprint. See “Configure a Blueprint to Call a State
Change Workflow,” on page 25.
Menu Operation Workflows
A menu operation workflow is executed when a user selects an option from the Actions menu in the service
catalog or the machine menu in the Infrastructure tab.
For example, you can create a custom workflow that enables a user to create a support ticket related to a
machine by selecting Raise Support Issue from the machine menu.
vCloud Automation Center Designer provides templates for customizing menu operation workflows.
In addition to the workflow definition, a menu operation workflow depends on an operation configuration
file, which defines the aspects of the custom menu option such as the display text, which roles have access to
it, and the machine states for which the operation is available.
NOTE A service architect can define custom actions for machines provisioned in vSphere or
vCloud Director by using the Advanced Services Designer. For more information, see Advanced Service
Design. Creating custom actions in the Advanced Services Designer for vCloud Director requires
vCloud Automation Center 6.0 SP1.
Configuring a Menu Operation Workflow Overview
You can customize a menu operation workflow by using vCloud Automation Center Designer and the
CloudUtil command-line utility. A blueprint author can then enable it for specific blueprints.
The following is a high-level overview of the steps required to enable menu operation workflows:
1
A workflow developer customizes one of the menu operation workflow templates by using
vCloud Automation Center Designer. See “Customize an IaaS Workflow,” on page 21.
Any IaaS workflow can call a vCenter Orchestrator workflow. For more information, see “Using
vCenter Orchestrator Workflow Activities,” on page 22.
20
2
A workflow developer configures the menu operation in the Model Manager. See “Configure a Menu
Operation,” on page 26.
3
A workflow developer registers the new menu operation with the service catalog. See “Register New
Menu Operations with the Service Catalog,” on page 29.
VMware, Inc.
Chapter 3 Customizing IaaS Workflows
4
A tenant administrator or business group manager configures a blueprint to enable the menu operation
for machines provisioned from that blueprint. See “Configure a Blueprint to Enable a Menu Operation
Workflow,” on page 29.
If the menu operation is intended to be used in the service catalog, it must also be entitled to users. For more
information, see Tenant Administration.
Customize an IaaS Workflow
vCloud Automation Center Designer enables you to edit the customizable workflows and update
workflows in the Model Manager.
Prerequisites
Launch the vCloud Automation Center Designer.
Procedure
1
Click Load.
2
Select the workflow that you want to customize.
3
Option
Description
WFMachineMenuN
Customizable menu operation workflow
WFStubBuildingMachine
Customizable state change workflow that executes before a machine enters
the BuildingMachine state
WFStubMachineDisposing
Customizable state change workflow that executes before a machine enters
the Disposing state
WFStubMachineExpired
Customizable state change workflow that executes before a machine enters
the Expired state
WFStubMachineProvisioned
Customizable state change workflow that executes before a machine enters
the MachineProvisioned state
WFStubMachineRegistered
Customizable state change workflow that executes before a machine enters
the RegisterMachine state
WFStubUnprovisionMachine
Customizable state change workflow that executes before a machine enters
the UnprovisionMachine state
Click OK.
The workflow displays in the Designer pane.
4
Customize the workflow by dragging activities from the Toolbox to the Designer pane and configuring
their arguments.
5
When you are finished editing the workflow, update the workflow in the Model Manager by clicking
Send.
The workflow is saved and appears as a new revision in the list the next time you load a workflow. You
can access an earlier version of a workflow at any time. See “Revert to a Previous Revision of a
Workflow,” on page 30.
VMware, Inc.
21
Extensibility
Using vCenter Orchestrator Workflow Activities
You can use vCloud Automation Center Designer activities to call vCenter Orchestrator workflows either
synchronously or asynchronously.
Synchronous Execution
The InvokeVcoWorkflow activity calls a vCenter Orchestrator workflow and blocks further execution of its
parent IaaS workflow until the vCenter Orchestrator workflow completes. The activity returns the output
parameters for the vCenter Orchestrator workflow.
Asynchronous Execution
The InvokeVcoWorkflowAsync activity is a “fire and forget” activity that calls a vCenter Orchestrator
workflow and continues to execute activities in the IaaS workflow without waiting for the
vCenter Orchestrator workflow to complete.
The activity returns either a unique workflow execution token that can be used to monitor the workflow or
an error if the REST API call to the vCenter Orchestrator server failed (for example, if the server could not be
reached).
Two additional activities are available for use with this activity:
n
GetVcoWorkflowExecutionStatus enables you to poll the vCenter Orchestrator workflow for its status.
n
WaitForVcoWorkflowCompletion enables you to block further execution of the IaaS workflow until the
vCenter Orchestrator workflow has completed or timed out. You can use this activity to retrieve the
results of a vCenter Orchestrator workflow that you execute asynchronously.
Call a vCenter Orchestrator Workflow
You can use either the InvokeVcoWorkflow or the InvokeVcoWorkflowAsync activity to call a
vCenter Orchestrator workflow from an IaaS workflow.
Some vCenter Orchestrator workflows require user interaction during execution. For these workflows, the
user prompt appears in the vCenter Orchestrator client rather than in the vCloud Automation Center
console, so it is not apparent to the end user in vCloud Automation Center that a workflow is waiting for
input.
To avoid workflows that block on user input, do not call vCenter Orchestrator workflows that require user
interaction from IaaS workflows.
Procedure
1
In vCloud Automation Center Designer, open a workflow and navigate to the context where you want
to call a vCenter Orchestrator workflow.
2
Drag the InvokeVcoWorkflow or the InvokeVcoWorkflowAsync activity into the Designer pane.
3
Select the vCenter Orchestrator workflow to execute.
a
Under General, click the ellipsis next to Workflow.
b
In the Browse for vCO workflow dialog box, select a workflow.
c
Click OK.
The Inputs and Outputs sections display the input and output parameters of the selected workflow.
22
VMware, Inc.
Chapter 3 Customizing IaaS Workflows
4
In the Properties pane, specify the name of the variable representing the virtual machine ID in
VirtualMachineId.
The customizable workflows contain a variable by default named virtualMachineId that is set during
initialization.
5
Specify the parameters for the vCenter Orchestrator workflow.
n
Enter the values in the activity in the Designer pane.
n
In the Properties pane, click the ellipsis next to InputParameters or OutputParameters to open the
Parameters dialog box. This dialog box displays the IaaS type of each parameter. If the parameter
type appears in bold, the parameter is required.
Point to the text box for any parameter to view a tooltip indicating the vCenter Orchestrator type.
If you are using the InvokeVcoWorkflowAsync activity, the output parameters of the
vCenter Orchestrator workflow are displayed with their corresponding types for informational
purposes, but you cannot specify an expression for the parameter in this activity.
What to do next
To retrieve the results of a workflow that you execute asynchronously, use the
WaitForVcoWorkflowCompletion activity.
Get the Status of a vCenter Orchestrator Workflow
You can check the status of a vCenter Orchestrator workflow that was called with the
InvokeVcoWorkflowAsync activity using the GetVcoWorkflowExecutionStatus activity.
Prerequisites
“Call a vCenter Orchestrator Workflow,” on page 22 using the InvokeVcoWorkflowAsync activity.
Procedure
1
In vCloud Automation Center Designer, open a workflow where you have used the
InvokeVcoWorkflowAsync activity.
2
Navigate to the context where you want to check the status of the vCenter Orchestrator workflow.
3
Drag the GetVcoWorkflowExecutionStatus activity into the Designer pane.
4
In the Properties pane, specify the name of the variable representing the virtual machine ID in
VirtualMachineId.
The customizable workflows contain a variable by default named virtualMachineId that is set during
initialization.
5
6
Create a variable of type DynamicOps.VcoModel.Common.VcoWorkflowExecutionToken.
Specify the name of the token variable as the executionToken output parameter on the
InvokeVcoWorkflowAsync activity.
7
Specify the same variable name as the WorkflowExecutionToken property of the
GetVcoWorkflowExecutionStatus activity.
8
Create a variable of type string.
9
Specify the name of the string variable as the VcoWorkflowExecutionStatus property of the
GetVcoWorkflowExecutionStatus activity.
When the workflow runs, the value of the VcoWorkflowExecutionStatus variable is set to the status of the
vCenter Orchestrator workflow.
VMware, Inc.
23
Extensibility
Get the Results of a vCenter Orchestrator Workflow
If you want to call a vCenter Orchestrator workflow asynchronously and then retrieve the results of the
completed workflow at a later point, you can use the WaitForVcoWorkflowCompletion activity.
The WaitForVcoWorkflowCompletion activity blocks execution of the IaaS workflow until the
vCenter Orchestrator workflow has completed or a timeout is reached. The activity returns the results of the
vCenter Orchestrator workflow if it completes successfully, an error if the workflow fails, or null if the
workflow times out.
Prerequisites
“Call a vCenter Orchestrator Workflow,” on page 22 using the InvokeVcoWorkflowAsync activity.
Procedure
1
In vCloud Automation Center Designer, open a workflow where you have used the
InvokeVcoWorkflowAsync activity.
2
Navigate to the context where you want to retrieve the results of the vCenter Orchestrator workflow.
3
Drag the WaitForVcoWorkflowCompletion activity into the Designer pane.
4
In the Properties pane, specify the name of the variable representing the virtual machine ID in
VirtualMachineId.
The customizable workflows contain a variable by default named virtualMachineId that is set during
initialization.
5
Create a variable of type DynamicOps.VcoModel.Common.VcoWorkflowExecutionToken.
6
Create a variable of type DynamicOps.VcoModel.Common.VcoWorkflowExecutionToken.
7
Specify the name of the token variable as the executionToken output parameter on the
InvokeVcoWorkflowAsync activity.
8
Specify the same variable name as the WorkflowExecutionToken property of the
WaitForVcoWorkflowCompletion activity.
9
Retrieve the output of the vCenter Orchestrator workflow.
a
b
Create a variable of type DynamicOps.VcoModel.Common.VcoWorkflowExecutionResult.
Specify the name of the results variable as the WorkflowOutput property of the
WaitForVcoWorkflowCompletion activity.
When the workflow runs, the value of the variable is set to the results of the vCenter Orchestrator
workflow, if any.
vCenter Orchestrator and IaaS Object Types
When you use either the InvokeVcoWorkflow or the InvokeVcoWorkflowAsync activity in
vCloud Automation Center Designer, input and output properties for the activity are automatically
populated based on the parameters of the vCenter Orchestrator workflow that you select.
vCenter Orchestrator primitive types are converted into the following IaaS types:
Table 3‑2. vCenter Orchestrator and IaaS Object Types
24
vCenter Orchestrator Type
IaaS Type
string
string
boolean
bool
number
decimal
VMware, Inc.
Chapter 3 Customizing IaaS Workflows
Table 3‑2. vCenter Orchestrator and IaaS Object Types (Continued)
vCenter Orchestrator Type
IaaS Type
SecureString
string
Text
string
Array/T
Array<T>
Properties
Dictionary<string,object>
Date
DateTime
VC:VirtualMachine
VirtualMachine
NOTE If you are using vCenter Orchestrator 5.1, you must have installed the vCloud Automation Center
integration package to enable the conversion of VC:VirtualMachine object types to VirtualMachine.
All other vCenter Orchestrator types are converted to the IaaS type VcoSdkObject.
Configure a Blueprint to Call a State Change Workflow
After you create a custom state change workflow, a tenant administrator or business group manager must
enable it for specific blueprints by adding a custom property.
Each state change workflow is associated with a specific custom property. When a machine is entering a
state with a corresponding state change workflow, IaaS checks to see if the machine has the corresponding
custom property; if so, the associated workflow is executed. For example, if a machine has the custom
property ExternalWFStubs.MachineProvisioned, the WFStubMachineProvisioned workflow is executed before
the master workflow enters the MachineProvisioned state.
While custom properties can be applied to a machine from a number of sources, typically the property for a
state change workflow is specified in a blueprint, enabling the workflow for all machines provisioned from
that blueprint.
Prerequisites
Log in to the vCloud Automation Center console as a tenant administrator or business group manager.
Procedure
1
Select Infrastructure > Blueprints > Blueprints.
2
Point to the name of a blueprint and click Edit.
3
Click the Properties tab.
4
Click New Property.
5
Type the name of the custom property associated with the workflow you want to enable in the Name
text box.
VMware, Inc.
Customizable Workflow Name
Associated Property Name
WFStubMachineProvisioned
ExternalWFStubs.MachineProvisioned
WFStubBuildingMachine
ExternalWFStubs.BuildingMachine
WFStubMachineDisposing
ExternalWFStubs.MachineDisposing
WFStubUnprovisionMachine
ExternalWFStubs.UnprovisionMachine
WFStubMachineRegistered
ExternalWFStubs.MachineRegistered
WFStubMachineExpired
ExternalWFStubs.MachineExpired
25
Extensibility
6
Leave the Value text box blank.
The workflow depends on the presence of the property, not on any particular value.
7
8
Click the Save icon (
).
Click OK.
The workflow is now enabled for new machines that are provisioned from this blueprint.
Configuring a Menu Operation Workflow
After you customize a menu operation workflow, additional configuration is required before it is available
to users in the vCloud Automation Center console.
Configure a Menu Operation
To configure a menu operation, you create an operation configuration file and install it in the Model
Manager.
Procedure
1
Create an Operation Configuration File on page 26
The operation configuration file is required for menu operation workflows. It specifies the aspects of
the custom menu option in the vCloud Automation Center console such as the display text, which
roles have access to the option, and the machine states for which the option is available.
2
Install an Operation in the Model Manager on page 28
You install an operation in the Model Manager by using the CloudUtil command-line utility.
What to do next
If the menu operation is intended to be used in the service catalog, it must be registered with the service
catalog so that it can be entitled to users. “Register New Menu Operations with the Service Catalog,” on
page 29.
Create an Operation Configuration File
The operation configuration file is required for menu operation workflows. It specifies the aspects of the
custom menu option in the vCloud Automation Center console such as the display text, which roles have
access to the option, and the machine states for which the option is available.
Procedure
1
Create a new XML file.
<?xml version="1.0" encoding="utf-8"?>
2
Create the root element customOperations.
<customOperations xmlns="http://www.dynamicops.com/schemas/2009/OperationConfig/">
</customOperations>
The element must specify the XML namespace
http://www.dynamicops.com/schemas/2009/OperationConfig/.
26
VMware, Inc.
Chapter 3 Customizing IaaS Workflows
3
For each operation you want to define, add an operation element within customOperations.
<operation name="WFMachineMenu1" displayName="Execute Machine Menu task">
</operation>
The operation element takes the following attributes:
Attribute
4
Description
name
The name of the workflow that this operation executes.
displayName
A descriptive label for the option in the machine menu.
Specify the roles to grant access to the menu operation.
a
Add the authorizedTasks element.
<operation name="WFMachineMenu1" displayName="Execute Machine Menu task">
<authorizedTasks>
</authorizedTasks>
</operation>
b
For each role that you want to grant access to the operation, add a task element, for example:
<authorizedTasks>
<task>VRM User Custom Event</task>
<task>VRM Support Custom Event</task>
<task>Group Administrator Custom Event</task>
<task>Enterprise Administrator Custom Event</task>
<task>VRM Administrator Custom Event</task>
</authorizedTasks>
The valid contents of the task element are as follows:
VMware, Inc.
Element content
Description
VRM User Custom Event
Grants access to the operation for all users.
VRM Support Custom Event
Grants access to the operation for support users.
Group Administrator Custom
Event
Grants access to the operation for business group managers.
Enterprise Administrator Custom
Event
Grants access to the operation for fabric administrators.
VRM Administrator Custom Event
Grants access to the operation for IaaS administrators only.
27
Extensibility
5
(Optional) Specify the machine states for which the operation is available.
a
Add the machineStates element.
<operation name="WFMachineMenu1" displayName="Execute Machine Menu task">
<machineStates>
</machineStates>
</operation>
b
For each state in which the operation should be available, add a state element.
<machineStates>
<state>On</state>
<state>Off</state>
</machineStates>
The value may be any of the possible machine states. For a full list of machine states, see IaaS
Configuration for Virtual Platforms, IaaS Configuration for Physical Machines, or IaaS Configuration for
Cloud Platforms.
If the element is omitted, the operation is available for all machine states.
The following is an example of a complete operation configuration file:
<?xml version="1.0" encoding="utf-8" ?>
<customOperations xmlns="http://www.dynamicops.com/schemas/2009/OperationConfig/">
<operation name="WFMachineMenu1" displayName="Execute Machine Menu task">
<authorizedTasks>
<task>VRM User Custom Event</task>
<task>VRM Support Custom Event</task>
<task>Group Administrator Custom Event</task>
<task>Enterprise Administrator Custom Event</task>
<task>VRM Administrator Custom Event</task>
</authorizedTasks>
<machineStates>
<state>On</state>
<state>Off</state>
</machineStates>
</operation>
</customOperations>
Install an Operation in the Model Manager
You install an operation in the Model Manager by using the CloudUtil command-line utility.
Prerequisites
“Create an Operation Configuration File,” on page 26.
Procedure
1
Open an elevated command prompt.
2
Run the CloudUtil.exe command with the following arguments.
n
CloudUtil.exe Operation-Create -c <path to operation definition file>
n
Optionally, you can specify a Model Manager host and request a stack trace in case of error.
CloudUtil.exe Operation-Create -c <path to operation definition file>
--repository <Model Manager Root URI> -v
28
VMware, Inc.
Chapter 3 Customizing IaaS Workflows
What to do next
If the menu operation is intended to be used in the service catalog, it must be registered with the service
catalog so that it can be entitled to users. “Register New Menu Operations with the Service Catalog,” on
page 29.
Register New Menu Operations with the Service Catalog
After installing new menu operations, the workflow developer must register them with the service catalog
so they can be entitled to users.
Prerequisites
n
“Configure a Menu Operation,” on page 26.
n
Log in to the IaaS Model Manager host as a local user with administrator privileges.
Procedure
1
Open an elevated command prompt.
2
Navigate to the IaaS root installation directory.
In a typical installation, this is C:\Program Files (x86)\VMware\vCAC.
3
Navigate to Server\Model Manager Data\Cafe.
4
Execute the following command:
Vcac-Config.exe RegisterCatalogTypes -v
What to do next
A tenant administrator or business group manager must entitle the new action before it is available to users
in the service catalog. For more information, see Tenant Administration.
Configure a Blueprint to Enable a Menu Operation Workflow
You enable a menu operation workflow for machines provisioned from a specific blueprint by updating the
security configuration for the blueprint.
Prerequisites
Log in to the vCloud Automation Center console as a tenant administrator or business group manager.
Procedure
1
Select Infrastructure > Blueprints > Blueprints.
2
Point to the name of a blueprint and click Edit.
3
Click the Actions tab.
4
Select the checkbox that corresponds to the operation that you want to enable.
5
Click OK.
The menu operation is now enabled for machines provisioned from this blueprint and available to all user
roles specified in the operation configuration file.
What to do next
If the menu operation is intended to be used in the service catalog, it must also be entitled to users. For more
information, see Tenant Administration.
VMware, Inc.
29
Extensibility
Revert to a Previous Revision of a Workflow
The Load Workflow dialog displays all revisions of a workflow in the Model Manager so that you have
access to the full version history of the workflows.
Each time you send a workflow to the Model Manager, the Revision and Time Stamp are updated.
Prerequisites
Launch the vCloud Automation Center Designer console.
Procedure
1
Click Load.
2
Select the revision of the workflow that you want to revert to.
The original workflows provided by VMware are revision 0 (zero).
3
Click OK.
4
Update the workflow in the Model Manager by clicking Send.
The earlier revision becomes the latest revision in the Model Manager. For example, if you have created
revisions 1 and 2 of a workflow, then load and save revision 0, revisions 0 and 3 are now identical and you
have returned the workflow to the version provided by VMware.
30
VMware, Inc.
Workflows and Distributed Execution
Management
4
You can use skills to restrict execution of workflows to specific Distributed Execution Managers.
A skill is similar to a tag that you can apply to both workflows and DEM Worker instances. If a workflow is
not associated with any skills, any DEM Worker can execute it. If a workflow is associated with one or more
skills, then only DEM Workers that are associated with all of the same skills can execute it.
Skills are useful when a particular workflow requires a DEM installed on a host with specific prerequisites.
For example, you may want to restrict cloud provisioning workflows to a specific DEM running on a host
with the required network access to Amazon URLs.
Skills can also be used to associate workflows with a particular data center location. For example, you might
install one DEM in your Boston data center and another in your London data center, and use skills to direct
certain operations to one data center or the other.
This chapter includes the following topics:
n
“Associate Workflows and DEM Workers by Using Skills,” on page 31
n
“Remove Associations between Skills and DEM Workers,” on page 32
n
“Remove Associations between Skills and Workflows,” on page 32
n
“Remove a Skill,” on page 33
Associate Workflows and DEM Workers by Using Skills
You associate workflows with a specific DEM Worker or set of Worker instances by adding a skill to the
Model Manager and then associating the skill with one or more workflows and DEM Workers.
Prerequisites
Launch the vCloud Automation Center Designer console.
Procedure
1
On the ribbon, click Manage Skills.
2
In the text field at the upper left of the Manage Skills dialog, type the name of a new skill and click the
Add button.
The skill name must be unique. If the name of the new skill matches the name of an existing skill, the
Add button is unavailable.
3
VMware, Inc.
Select the name of the skill in the list on the left.
31
Extensibility
4
5
Associate the skill with one or more DEM Workers.
a
Click the Add icon (
b
In the Select DEMs dialog, select one or more DEM Worker instances.
c
Click OK.
) next to Distributed Execution Managers.
Associate the skill with one or more Workflows.
a
Click the Add icon (
b
In the Select Workflows dialog, select one or more workflows.
c
Click OK.
) next to Workflows.
The workflows associated with this skill can only be executed by the DEM Workers that are associated
with this skill.
6
When you are done adding skills and associating them with DEM workers and workflows, click OK to
close the Manage Skills dialog and save your changes to the Model Manager.
Remove Associations between Skills and DEM Workers
When you remove the association between a skill and a DEM Worker, that Worker instance can no longer
execute the workflows associated with the skill.
Prerequisites
Launch the vCloud Automation Center Designer console.
Procedure
1
On the ribbon, click Manage Skills.
2
In the Manage Skills dialog, select the name of the skill in the list on the left.
3
Select the name of one or more DEM Worker instances from the Distributed Execution Managers list
and click the Remove icon (
4
).
Click OK to close the Manage Skills dialog and save your changes to the Model Manager.
Remove Associations between Skills and Workflows
When you remove the association between a skill and a workflow, that workflow is no longer restricted to
the DEM Workers that are associated with the same skill.
Prerequisites
Launch the vCloud Automation Center Designer console.
Procedure
32
1
On the ribbon, click Manage Skills.
2
In the Manage Skills dialog, select the name of the skill in the list on the left.
3
Select the name of one or more workflows from the Workflows list and click the Remove icon (
4
Click OK to close the Manage Skills dialog and save your changes to the Model Manager.
).
VMware, Inc.
Chapter 4 Workflows and Distributed Execution Management
Remove a Skill
Removing a skill also removes its associations to any DEM Workers and workflows.
Prerequisites
Launch the vCloud Automation Center Designer console.
Procedure
1
On the ribbon, click Manage Skills.
2
In the Manage Skills dialog, select the name of the skill in the list on the left.
3
Click the Remove icon (
) at the top of the list of skills.
After you confirm that you want to delete the skill, its name appears dimmed to indicate that it is
marked for deletion.
4
VMware, Inc.
Click OK to close the Manage Skills dialog and save your changes to the Model Manager or Cancel if
you do not want to delete the skill and its associations with DEMs and workflows.
33
Extensibility
34
VMware, Inc.
CloudUtil Command Reference
5
This section provides a reference to the commands in the CloudUtil command line interface.
NOTE In the CloudUtil commands, the Model Manager is referred to as the repository and a Distributed
Execution Manager (DEM) is referred to as an agent.
This chapter includes the following topics:
n
“DEM Commands,” on page 35
n
“File Commands,” on page 36
n
“Operation Commands,” on page 39
n
“Skill Commands,” on page 40
n
“Workflow Commands,” on page 41
DEM Commands
The DEM commands enable you to view a list of Distributed Execution Managers registered with the Model
Manager and add or remove associations between skills and DEMs.
DEM-Add-Skills
Associate skills with a registered Distributed Execution Manager.
CloudUtil.exe DEM-Add-Skills -n|--name <Name> -s|--skills <Skills> [--repository <Model Manager
Root URI>] [-v|--verbose]
Table 5‑1. DEM-Add-Skills Arguments
Argument
Description
Name
Name of a registered Distributed Execution Manager.
Skills
Comma-delimited list of skills to associate with this Distributed Execution Manager.
Model Manager Root URI
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
NOTE The skills must already exist in the Model Manager. See “Skill-Install,” on page 40.
VMware, Inc.
35
Extensibility
DEM-List
List all Distributed Execution Managers registered with the Model Manager and their associated skills.
CloudUtil.exe DEM-List [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑2. DEM-List Arguments
Argument
Description
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
DEM-Remove-Skills
Remove association between skills and a Distributed Execution Manager.
CloudUtil.exe DEM-Remove-Skills -n|--name <Name> -s|--skills <Skills> [--repository <Model
Manager Root URI>] [-v|--verbose]
Table 5‑3. DEM-Remove-Skills Arguments
Argument
Description
Name
Name of a registered Distributed Execution Manager.
Skills
Comma-delimited list of skills to remove from this Distributed Execution Manager.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
File Commands
The File commands enable you to store and manage files (typically scripts) in the Model Manager.
File-Export
Export a file from the Model Manager.
CloudUtil.exe File-Export -n|--name <Name> -o|--output <Output File> [-i|--iteration
<Iteration>] [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑4. File-Export Arguments
36
Argument
Description
Name
Friendly name of the file in the Model Manager.
Output file
Path for file output.
Iteration
(Optional) Version string of the file in the Model Manager. Default is 0.0.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
VMware, Inc.
Chapter 5 CloudUtil Command Reference
File-Import
Import a file into the Model Manager.
CloudUtil.exe File-Import -n|--name <Name> -f|--filename <File Name> [-d|--description
<Description>] [-i|--iteration <Iteration>] [--repository <Model Manager Root URI>] [-v|-verbose]
Table 5‑5. File-Import Arguments
Argument
Description
Name
Friendly name to assign to the file in the Model Manager.
File Name
Path to a file to import into the Model Manager.
Description
(Optional) Description of the file.
Iteration
(Optional) Version string of the file in the Model Manager. Default is 0.0.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
File-List
List all files imported into the Model Manager.
CloudUtil.exe File-List [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑6. File-List Arguments
Argument
Description
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
File-Remove-All
Remove all revisions for a given version of a file from the Model Manager.
CloudUtil.exe File-Remove-All -n|--name <Name> [-i|--iteration <Iteration>]
[--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑7. File-Remove-All Arguments
Argument
Description
Name
Friendly name of the file in the Model Manager.
Iteration
(Optional) Version string of the file in the Model Manager. Default is 0.0.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
VMware, Inc.
37
Extensibility
File-Remove-Rev
Remove a specific revision of a file from the Model Manager.
CloudUtil.exe File-Remove-Rev -n|--name <Name> -r|--revision <Revision> [-i|--iteration
<Iteration>] [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑8. File-Export Arguments
Argument
Description
Name
Friendly name of the file in the Model Manager.
Revision
Revision of the file to remove.
Iteration
(Optional) Version string of the file in the Model Manager. Default is 0.0.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
File-Rollback
Revert a file in the Model Manager to a given revision.
CloudUtil.exe File-Rollback -n|--name <Name> -r|--revision <Revision> [-i|--iteration
<Iteration>] [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑9. File-Rollback Arguments
Argument
Description
Name
Friendly name of the file in the Model Manager.
Revision
Revision of the file to revert to.
Iteration
(Optional) Version string of the file in the Model Manager. Default is 0.0.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
File-Update
Update a previously imported file in the Model Manager with a new revision.
CloudUtil.exe File-Update -n|--name <Name> -f|--filename <File Name> [-i|--iteration
<Iteration>] [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑10. File-Update Arguments
38
Argument
Description
Name
Friendly name of the file in the Model Manager.
File Name
Path to the updated file.
Iteration
(Optional) Version string of the file in the Model Manager. Default is 0.0.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
VMware, Inc.
Chapter 5 CloudUtil Command Reference
Operation Commands
The Operation commands enable you to manage custom operations in the Model Manager.
Operation-Create
Create a custom operation or set of operations that can be performed on a machine based on an operation
definition file.
CloudUtil.exe Operation-Create -c|--operationConfig <Operation Definition File> [--repository
<Model Manager Root URI>] [-v|--verbose]
Table 5‑11. Operation-Create Arguments
Argument
Description
Operation Definition File
Path to an operation definition file (XML).
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
Operation-Delete
Delete a custom operation from the Model Manager.
CloudUtil.exe Operation-Delete -n|--name <Name> [--force] [--repository <Model Manager
Root URI>] [-v|--verbose]
Table 5‑12. Operation-Delete Arguments
Argument
Description
Name
Name of the custom operation in the Model Manager.
[--force]
(Optional) Force deletion of the operation.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
Operation-List
List all custom operations in the Model Manager.
CloudUtil.exe Operation-List [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑13. Operation-List Arguments
Argument
Description
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
VMware, Inc.
39
Extensibility
Skill Commands
The Skill commands enable you to manage the skills associated with Distributed Execution Managers and
workflows.
Skill-Install
Install a skill in the Model Manager.
CloudUtil.exe Skill-Install -n|--name <Name> [--repository <Model Manager Root URI>] [-v|-verbose]
Table 5‑14. Skill-Install Arguments
Argument
Description
Name
Name for the skill in the Model Manager.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
Skill-List
List all skills installed in the Model Manager.
CloudUtil.exe Skill-List [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑15. Skill-List Arguments
Argument
Description
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
Skill-Uninstall
Uninstall a skill from the Model Manager.
CloudUtil.exe Skill-Uninstall -n|--name <Name> [--repository <Model Manager Root URI>]
[-v|--verbose]
Table 5‑16. Skill-Uninstall Arguments
Argument
Description
Name
Name of the skill to uninstall from the Model Manager.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
NOTE A skill cannot be uninstalled if it is associated with either a Distributed Execution Manager or a
workflow. See “DEM-Remove-Skills,” on page 36 or “Workflow-Remove-Skills,” on page 41.
40
VMware, Inc.
Chapter 5 CloudUtil Command Reference
Workflow Commands
The Workflow commands enable you to manage customizable IaaS workflows in the Model Manager, as
well as the skills associated with any workflows.
Workflow-Add-Skills
Associate skills with a workflow in the Model Manager.
CloudUtil.exe Workflow-Add-Skills -n|--name <Name> -s|--skills <Skills> [--repository <Model
Manager Root URI>] [-v|--verbose]
Table 5‑17. Workflow-Add-Skills Arguments
Argument
Description
Name
Name of a workflow in the Model Manager.
Skills
Comma-delimited list of skills to associate with this workflow.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
NOTE The skills must already exist in the Model Manager. See “Skill-Install,” on page 40.
Workflow-List
List all workflows installed in the Model Manager and their associated skills.
CloudUtil.exe Workflow-List [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑18. Workflow-List Arguments
Argument
Description
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
Workflow-Remove-Skills
Remove association between skills and a workflow in the Model Manager.
CloudUtil.exe Workflow-Remove-Skills -n|--name <Name> -s|--skills <Skills> [--repository
<Model Manager Root URI>] [-v|--verbose]
Table 5‑19. Workflow-Remove-Skills Arguments
Argument
Description
Name
Name of a workflow in the Model Manager.
Skills
Comma-delimited list of skills to remove from this workflow.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
VMware, Inc.
41
Extensibility
Workflow-Rollback
Revert a workflow to a given revision.
CloudUtil.exe Workflow-Rollback -n|--name <Name> -r|--revision <Revision> [--repository <Model
Manager Root URI>] [-v|--verbose]
Table 5‑20. Workflow-Rollback Arguments
Argument
Description
Name
Name of the workflow in the Model Manager.
Revision
Revision of the workflow to revert to.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
Workflow-Update
Update a customizable workflow with a new revision.
CloudUtil.exe Workflow-Update -f|--filename <File Name> -n|--name <Name> [-d|--description
<Description>] [--repository <Model Manager Root URI>] [-v|--verbose]
Table 5‑21. Workflow-Update Arguments
42
Argument
Description
File Name
Path to a file (XAML) containing the updated workflow.
Name
Name of the workflow to update.
Description
(Optional) Description of workflow.
Model Manager Root URI
(Optional) The root URI of the Model Manager, for example, http://hostname/repository).
Default is specified in the CloudUtil config file in the repositoryAddress key under the
<appSettings> section.
[-v|verbose]
(Optional) If an error occurs, outputs a stack trace instead of just the exception message.
VMware, Inc.
vCloud Automation Center Workflow
Activity Reference
6
VMware provides a library of workflow activities with vCloud Automation Center Designer for use in
customizing workflows.
Five categories of Windows Workflow Foundation activities are also included in
vCloud Automation Center Designer, including Control Flow, Flowchart, Primitives, Collection and Error
Handling.
This section provides a reference to the IaaS workflow activities included with
vCloud Automation Center Designer in the DynamicOps.Repository.Activities and
DynamicOps.Cdk.Activities namespaces. Activities related to calling vCenter Orchestrator workflows are
described in “Using vCenter Orchestrator Workflow Activities,” on page 22.
NOTE In the IaaS activity library, the Model Manager is referred to as the repository.
This chapter includes the following topics:
n
“DynamicOps.Repository.Activities,” on page 43
n
“DynamicOps.Cdk.Activities,” on page 46
DynamicOps.Repository.Activities
The DynamicOps.Repository.Activities namespace contains basic workflow activities for IaaS workflows.
AddLink
Adds the specified link to the set of objects the DataServiceContext is tracking.
Table 6‑1. AddLink Activity Input Parameters
Argument
Type
Description
DataServiceContext
RepositoryServiceContext
The DataServiceContext to which to add the link.
Source
Object
The source object for the new link.
SourceProperty
String
The name of the navigation property on the source object
that returns the related object.
Target
Object
The object related to the source object by the new link.
VMware, Inc.
43
Extensibility
AddObject
Adds the specified object to the set of objects the DataServiceContext is tracking.
Table 6‑2. AddObject Activity Input Parameters
Argument
Type
Description
DataServiceContext
RepositoryServiceContext
The DataServiceContext to which to add the object.
Instance
Object
The object to be tracked by the DataServiceContext.
AttachTo
Notifies the DataServiceContext to start tracking the specified resource.
Table 6‑3. AttachTo Activity Input Parameters
Argument
Type
Description
DataServiceContext
RepositoryServiceContext
The DataServiceContext that should track the resource.
Instance
Object
The resource to be tracked by the DataServiceContext.
The resource is attached in the Unchanged state.
CreateRepositoryServiceContext<T>
Creates a context for a model loaded into the Model Manager.
When you add this activity to a workflow in vCloud Automation Center Designer, you must select a class
that inherits from the RepositoryServiceContext class.
Table 6‑4. CreateRepositoryServiceContext<T> Activity Input Parameters
Argument
Type
Description
Uri
URI
(Optional) Root URI to use in connecting to the model.
Username
String
(Optional) Username to use in connecting to the context.
Table 6‑5. CreateRepositoryServiceContext<T> Activity Output Parameters
Argument
Type
Description
Result
RepositoryServiceContext
The specific type returned is an instance of the class
selected when the activity was added to the workflow.
DeleteLink
Changes the state of the link to deleted in the list of links being tracked by the DataServiceContext.
Table 6‑6. DeleteLink Activity Input Parameters
44
Argument
Type
Description
DataServiceContext
RepositoryServiceContext
The DataServiceContext from which to delete the link.
Source
Object
The source object in the link to be marked for deletion.
SourceProperty
String
The name of the navigation property on the source object
that is used to access the target object.
Target
Object
The target object involved in the link that is bound to the
source object. The target object must be of the type
identified by the source property or a subtype.
VMware, Inc.
Chapter 6 vCloud Automation Center Workflow Activity Reference
DeleteObject
Changes the state of the specified object to be deleted in the DataServiceContext.
Table 6‑7. DeleteObject Activity Input Parameters
Argument
Type
Description
DataServiceContext
RepositoryServiceContext
The DataServiceContext from which to delete the
resource.
Instance
Object
The tracked entity to be changed to the deleted state.
InvokeRepositoryWorkflow
Executes a workflow installed in the Model Manager.
Table 6‑8. InvokeRepositoryWorkflow Activity Input Parameters
Argument
Type
Description
WorkflowType
WorkflowDefinition entity
The workflow to execute.
WorkflowInputs
Dictionary<string, object>
(Optional) Inputs to the workflow.
CallingInstance
WorkflowInstance entity
(Optional) The workflow that calls the executed workflow
and to which it will return.
LoadProperty
Loads deferred content for a specified property from the data service.
Table 6‑9. LoadProperty Activity Input Parameters
Argument
Type
Description
DataServiceContext
RepositoryServiceContext
The DataServiceContext from which to load the
property.
Instance
Object
The entity that contains the property to load.
InstanceProperty
String
The name of the property of the specified entity to load.
SaveChanges
Saves the changes that the DataServiceContext is tracking to storage.
Table 6‑10. SaveChanges Activity Input Parameters
Argument
Type
Description
DataServiceContext
RepositoryServiceContext
The DataServiceContext that is tracking the changes to
save.
VMware, Inc.
45
Extensibility
SetLink
Notifies the DataServiceContext that a new link exists between the objects specified and that the link is
represented by the property specified in the SourceProperty argument.
Table 6‑11. SetLink Activity Input Parameters
Argument
Type
Description
DataServiceContext
RepositoryServiceContext
The DataServiceContext to notify of the link.
Source
Object
The source object for the new link.
SourceProperty
String
The property on the source object that identifies the target
object of the new link.
Target
Object
The child object involved in the new link to initialize by
calling this method. The target object must be a subtype of
the type identified by SourceProperty. If Target is set to
null, the call represents a delete link operation.
UpdateObject
Changes the state of the specified object in the DataServiceContext to Modified.
Table 6‑12. UpdateObject Activity Input Parameters
Argument
Type
Description
DataServiceContext
RepositoryServiceContext
The DataServiceContext tracking the entity to update.
Instance
Object
The tracked entity to be assigned to the Modified state.
DynamicOps.Cdk.Activities
The DynamicOps.Cdk.Activities namespace contains advanced activities for IaaS workflows.
ExecutePowerShellScript
Executes a PowerShell script stored in the Model Manager under the specified name.
Before you use the ExecutePowerShellScript activity, you must first load the script that you want to execute
into the Model Manager using the CloudUtil File-Import command.
Table 6‑13. ExecutePowerShellScript Activity Input Parameters
46
Argument
Type
Description
ScriptName
String
Name in the Model Manager of the script to execute.
ScriptVersion
Object
(Optional) Version in the Model Manager of the script to
execute. Default is 0.0.
MachineId
Guid
(Optional) If specified, the machine is loaded and all its
properties are passed to the script.
VMware, Inc.
Chapter 6 vCloud Automation Center Workflow Activity Reference
Table 6‑13. ExecutePowerShellScript Activity Input Parameters (Continued)
Argument
Type
Description
Arguments
Dictionary<string,string>
Additional arguments to pass to the script. If MachineId is
specified and there is a machine property with the same
name as an argument (case-insensitive), the value of the
machine property overrides the value of the argument.
PSModules
IEnumerable<string>
(Optional) Modules loaded into the PowerShell runtime
during command execution.
This option is only available in the Properties pane and not
in the Designer pane.
Table 6‑14. ExecutePowerShellScript Activity Output Parameters
Argument
Type
Description
Output
Collection<PSObject>
Output of script if any. Throws exception on error.
If you receive the error message Type PSObject is not defined in the vCloud Automation Center Designer
console when you are dealing with the output of ExecutePowerShellScript, perform the following steps:
ExecuteSshScript
Executes an SSH script stored in the model manager under the specified name.
Before you use the ExecuteSshScript activity, you must first load the script that you want to execute into the
Model Manager using the CloudUtil File-Import command.
Table 6‑15. ExecuteSshScript Activity Input Parameters
Argument
Type
Description
ScriptName
String
Name in the Model Manager of the script to execute.
Host
String
Server name against which to execute the script.
Username
String
Username to use in connecting to the host.
Password
String
Password to use in connecting to the host.
ScriptVersion
Object
(Optional) Version in the Model Manager of the script to
execute. Default is 0.0.
Timeout
TimeSpan
(Optional) Period of time after which execution of the
script times out. Default is 30 minutes.
Table 6‑16. ExecuteSshScript Activity Output Parameters
Argument
Type
Description
EnvironmentVariables
Dictionary<string, string>
Script execution result if any.
GetMachineName
Gets a machine’s name.
Table 6‑17. GetMachineName Activity Input Parameters
Argument
Type
Description
MachineId
Guid
The machine whose name to retrieve.
VMware, Inc.
47
Extensibility
Table 6‑18. GetMachineName Activity Output Parameters
Argument
Type
Description
MachineName
String
Name of the machine identifed by MachineId.
GetMachineOwner
Gets the username of a machine’s owner.
Table 6‑19. GetMachineOwner Activity Input Parameters
Argument
Type
Description
MachineId
Guid
The machine whose owner to retrieve.
Table 6‑20. GetMachineOwner Activity Output Parameters
Argument
Type
Description
Owner
String
Owner of the machine identified by MachineId, or null if
there is no owner.
GetMachineProperties
Gets the list of custom properties associated with a machine.
Table 6‑21. GetMachineProperties Activity Input Parameters
Argument
Type
Description
MachineId
Guid
The machine whose properties to retrieve.
Table 6‑22. GetMachineProperties Activity Output Parameters
Argument
Type
Description
Properties
Dictionary<string, string>
List of the machine’s properties. Values are returned
decrypted if they were stored encrypted.
GetMachineProperty
Gets the value of the specified property for a machine.
Table 6‑23. GetMachineProperty Activity Input Parameters
Argument
Type
Description
MachineId
Guid
The machine from which to retrieve a property.
PropertyName
String
Name of the property whose value to return.
IsRequired
bool
If the property is required and is not found the activity
throws an exception, otherwise returns null.
Table 6‑24. GetMachineProperty Activity Output Parameters
48
Argument
Type
Description
PropertyValue
String
Value of the property specified by PropertyName. The
value is returned decrypted if it was stored encrypted.
VMware, Inc.
Chapter 6 vCloud Automation Center Workflow Activity Reference
GetScriptFromName
Gets the contents of the script stored in the Model Manager under the specified name.
Table 6‑25. GetScriptFromName Activity Input Parameters
Argument
Type
Description
ScriptName
String
Name in the Model Manager of the script to retrieve.
ScriptVersion
Object
(Optional) Version in the Model Manager of the script to
retrieve. Default is 0.0.
Table 6‑26. GetScriptFromName Activity Output Parameters
Argument
Type
Description
ScriptContent
String
Contents of the script identified by ScriptName.
InvokePowerShell
Executes a PowerShell command.
Table 6‑27. InvokePowerShell Activity Input Parameters
Argument
Type
Description
CommandText
String
Command to execute.
Arguments
IEnumerable<string>
(Optional) Arguments to the command.
Input
IEnumerable
(Optional) The input pipeline.
IsScript
bool
(Optional) Indicates whether CommandText is a script.
Default is False.
This option is only available in the Properties pane and not
in the Designer pane.
Parameters
Collection
(Optional) Collection of name-value pairs passed as
parameters to the PowerShell script.
This option is only available in the Properties pane and not
in the Designer pane.
PowerShellVariables
Collection
(Optional) Variables copied into the PowerShell runtime.
This option is only available in the Properties pane and not
in the Designer pane.
PSModules
IEnumerable<string>
(Optional) Modules loaded into the PowerShell runtime
during command execution.
This option is only available in the Properties pane and not
in the Designer pane.
Runspace
Runspace
(Optional) Creating a PowerShell runspace and supplying
it to this argument enables you to reuse the same runspace
in multiple PowerShell invocations, which may result in
performance improvements.
This option is only available in the Properties pane and not
in the Designer pane.
Table 6‑28. InvokePowerShell Activity Output Parameters
Argument
Type
Description
Output
Collection<PSObject>
Output of command if any. Throws exception on error.
Errors
Collection<ErrorRecord>
Errors resulting from execution if any.
VMware, Inc.
49
Extensibility
If you receive the error message Type PSObject is not defined in the vCloud Automation Center Designer
console when you are dealing with the output of ExecutePowerShellScript, perform the following steps:
InvokeSshCommand
Executes an SSH command.
Table 6‑29. InvokeSshCommand Activity Input Parameters
Argument
Type
Description
CommandText
String
Command to execute.
Host
String
Server name against which to execute the command.
Username
String
Username to use in connecting to the host.
Password
String
Password to use in connecting to the host.
Timeout
TimeSpan
(Optional) Period of time after which execution of the
command times out. Default is 30 minutes.
Table 6‑30. InvokeSshCommand Activity Output Parameters
Argument
Type
Description
EnvironmentVariables
Dictionary<string, string>
Output of command if any. Throws exception on error.
LogMachineEvent
Logs a machine event to the user log that is visible to the machine owner.
Table 6‑31. LogMachineEvent Activity Input Parameters
Argument
Type
Description
MachineId
Guid
Machine generating the event to log.
Message
String
Message to write to the user log.
Type
String
Select a message type from the drop-down list (Info, Warn,
Error)
LogMessage
Logs to the Distributed Execution Manager log.
Table 6‑32. LogMessage Activity Input Parameters
50
Argument
Type
Description
Message
String
Message to write to the DEM log.
MessageCategory
String
Select a category from the drop-down menu (Debug, Error,
Info, Trace) or enter a custom category.
MessageSeverity
String
Select a severity from the drop-down menu; bound to the
list of Severities supplied in
System.Diagnostics.TraceEventType.
VMware, Inc.
Chapter 6 vCloud Automation Center Workflow Activity Reference
RunProcess
Executes a process on the same machine as the DEM that executes this activity.
NOTE vCloud Automation Center cannot present the UI from processes launched by the RunProcess activity
to the user, therefore these process must be non-interactive. In order to avoid leaving orphaned processes on
the DEM machine, the processes must also be self-terminating.
Table 6‑33. RunProcess Activity Input Parameters
Argument
Type
Description
Command
String
Path to the executable to run on the DEM machine.
WorkingDirectory
String
(Optional) The working directory under which the process
should run.
Arguments
String
(Optional) The list of command-line arguments to pass to
the command.
WaitForExit
bool
(Optional) If true, the workflow waits for the process to
complete before continuing with the workflow. Default is
false.
This option is only available in the Properties pane and not
in the Designer pane.
SendEmail
Sends an email to the given set of addresses.
Table 6‑34. SendEmail Activity Input Parameters
Argument
Type
Description
To
IEnumerable<string>
The list of addresses to which to send the email.
From
String
The address with which to populate the “From” field of the
email.
Subject
String
The subject line for the email.
Body
String
The body text of the email.
Host
String
The host name or IP address of the outgoing SMTP server.
Port
Integer
The SMTP port on the server specified in Host.
This option is only available in the Properties pane and not
in the Designer pane.
CC
IEnumerable<string>
(Optional) The address or list of addresses to copy on the
email.
This option is only available in the Properties pane and not
in the Designer pane.
Bcc
IEnumerable<string>
(Optional) The address or list of addresses to blind copy on
the email.
This option is only available in the Properties pane and not
in the Designer pane.
EnableSsl
bool
(Optional) Indicates whether to use SSL.
This option is only available in the Properties pane and not
in the Designer pane.
VMware, Inc.
51
Extensibility
Table 6‑34. SendEmail Activity Input Parameters (Continued)
Argument
Type
Description
UserName
String
The user name with which to authenticate with the SMTP
server specified in Host .
This option is only available in the Properties pane and not
in the Designer pane.
Password
String
The password of the user specified in UserName.
This option is only available in the Properties pane and not
in the Designer pane.
SetMachineProperty
Creates or updates a custom property on a machine.
Table 6‑35. SetMachineProperty Activity Input Parameters
Argument
Type
Description
MachineId
Guid
Machine on which to create or update the custom property.
PropertyName
String
Name of property to create or update.
PropertyValue
String
Value with which to create or update the property.
IsEncrypted
bool
(Optional) Indicates whether the value of the property is
encrypted.
IsHidden
bool
(Optional) Indicates whether the property is a hidden
property.
IsRuntime
bool
(Optional) Indicates whether the requesting user provides
the property value at request time (equivalent to being
marked Prompt User in the vCloud Automation Center
console)
SetWorkflowResult
Sets an external workflow’s state to either Complete or Failed to be honored by ExternalWF.xml settings.
Table 6‑36. SetWorkflowResult Activity Input Parameters
52
Argument
Type
Description
WorkflowId
Guid
The workflow for which to set the state.
Next State
WorkflowState
Select Complete or Failed from the drop-down menu.
VMware, Inc.
Index
A
activities
AddLink 43
AddObject 44
AttachTo 44
CreateRepositoryServiceContext&lt;T&gt; 44
DeleteLink 44
DeleteObject 45
ExecutePowerShellScript 46
ExecuteSshScript 47
GetMachineName 47
GetMachineOwner 48
GetMachineProperties 48
GetMachineProperty 48
GetScriptFromName 49
GetVcoWorkflowExecutionStatus 23
InvokePowerShell 49
InvokeRepositoryWorkflow 45
InvokeSshCommand 50
InvokeVcoWorkflow 22
InvokeVcoWorkflowAsync 22
LoadProperty 45
LogMachineEvent 50
LogMessage 50
RunProcess 51
SaveChanges 45
SendEmail 51
SetLink 46
SetMachineProperty 52
SetWorkflowResult 52
UpdateObject 46
WaitForVcoWorkflowCompletion 24
C
CloudUtil
DEM Commands 35
DEM-Add-Skills 35
DEM-List 36
DEM-Remove-Skills 36
File Commands 36
File-Export 36
File-Import 37
File-List 37
File-Remove-All 37
VMware, Inc.
File-Remove-Rev 38
File-Rollback 38
File-Update 38
Operation Commands 39
Operation-Create 39
Operation-Delete 39
Operation-List 39
Skill Commands 40
Skill-Install 40
Skill-List 40
Skill-Uninstall 40
Workflow Commands 41
Workflow-Add-Skills 41
Workflow-List 41
Workflow-Remove-Skills 41
Workflow-Rollback 42
Workflow-Update 42
E
extensibility
API 9
business-relevant services 8
creating new machine actions 9
creating new services 9
distributed execution 9
infrastructure types 8
overview of options 7
third-party systems 9
G
glossary 5
I
IaaS workflows
calling vCenter Orchestrator workflows 22
customizing 21
enabling 25, 29
menu operation workflows 20, 29
overview 17
restricting execution to DEMs 31
reverting to previous revision 30
state change workflows 19, 20, 25
types of workflows 19
installation
downloading the installer 12
53
Extensibility
prerequisites 11
vCloud Automation Center Designer 11
intended audience 5
M
menu operations
configuring 26
installing 28
registering 29
menu operation configuration file, creating 26
S
skills
associating with workflows and DEMs 31
overview 31
removing 33
removing association with DEMs 32
removing association with workflows 32
V
vCenter Orchestrator
configuring endpoints 13
integrating 13
object types 24
prerequisites 13
specifying an endpoint on a blueprint 14
vCenter Orchestrator workflows, calling from
IaaS workflows 22
vCloud Automation Center Designer
installing 12
vCloud Automation Center Designer
console 17
W
workflows, See IaaS workflows
54
VMware, Inc.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising