Life Cycle Extensibility vRealize Automation 7.3 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.
Life Cycle 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–2016 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 1 Life Cycle Extensibility 5 Machine Extensibility Overview 5 Machine Life Cycle Extensibility 5 Choosing a Life Cycle Extensibility Scenario 7 Extending Machine Lifecycles By Using vRealize Orchestrator 7 Extending Machine Lifecycles by Using vRealize Orchestrator Checklist 7 Configuring the vRealize Automation Plug-in for Machine Extensibility 8 Customizing IaaS Workflows By Using vRealize Orchestrator 11 Configuring Workflow Subscriptions to Extend vRealize Automation 12 Event Topics Provided
Life Cycle Extensibility 4 VMware, Inc.
Life Cycle Extensibility 1 Using vRealize Orchestrator with vRealize Automation, you can extend how you the manage the life cycle of IaaS machines. Extending vRealize Automation requires you to use provided vRealize Orchestrator workflows and to create custom workflows.
Life Cycle Extensibility 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 master workflow illustrations show the main states of the master workflow, highlighting in yellow the states you can customize by using IaaS workflow stubs.
Chapter 1 Life Cycle Extensibility Choosing a Life Cycle Extensibility Scenario You can use vRealize Orchestrator or vRealize Automation Designer to extend machine lifecycles. You can extend machine lifecycles by using vRealize Automation Designer to call out to vRealize Orchestrator, or by using vRealize Orchestrator directly.
Life Cycle Extensibility Table 1‑3. Extending Machine Lifecycles by Using vRealize Orchestrator Checklist (Continued) Task Details Create a vRealize Automation endpoint for your vRealize Orchestrator instance. “Create a vRealize Orchestrator Endpoint,” on page 47 Use the workflow template provided in the Extensibility subdirectory of the vRealize Automation plug-in library to create a custom vRealize Orchestrator workflow to run during the machine lifecycle.
Chapter 1 Life Cycle Extensibility 10 11 Select the type of connection to the host from the Session mode drop-down menu. Option Actions Shared Session Enter the credentials for a vRealize Automation user in the Authentication username and Authentication password text boxes. Per User Session Connect using the credentials of the user that is currently logged in. You must be logged in to the Orchestrator client with the credentials of the vRealize Automation system administrator.
Life Cycle Extensibility 16 Select the host's authentication type. Option Description SSO Select this to use vCenter Single Sign-On. NTLM Select this to enable NT LAN Manager (NTLM) protocol-based authentication only if your Active Directory infrastructure relies on NTLM authentication. If you select this option, you must the additional NTLM credentials and authentication options. 17 If you selected NTLM, click Next and enter the name of the Workstation machine and the NetBIOS domain name.
Chapter 1 Life Cycle Extensibility Procedure 1 Select Infrastructure > Endpoints > Endpoints. 2 Select New > Orchestration > vRealize Orchestrator. 3 Enter a name and, optionally, a description. 4 Enter a URL with the fully qualified name or IP address of the vRealize Orchestrator server and the vRealize Orchestrator port number. The transport protocol must be HTTPS. If no port is specified, the default port 443 is used.
Life Cycle Extensibility Prerequisites Use the workflow template provided in the Extensibility subdirectory of the vRealize Automation plugin library to create a custom workflow to run during the machine lifecycle. Procedure 1 From the drop-down menu in the Orchestrator client, select Run or Design. 2 Click the Workflows view. 3 Select Library > vRealize Automation > Infrastructure > Extensibility.
Chapter 1 Life Cycle Extensibility Event Topics Provided With vRealize Automation Event topics describe the type of event message that is sent to the event broker service by the other services. You select an event topic and configure the workflow subscription based on the topic. Table 1‑4. Event Topics Event Topic Name Description Service Blueprint component completed A blueprint component that is part of a composite blueprint finishes provisioning.
Life Cycle Extensibility Table 1‑4. Event Topics (Continued) Event Topic Name Description Service Orchestration server configuration (XaaS) - Obsolete A vRealize Orchestrator server configuration is created, updated, deleted, or modified to use a different default instance. advanced-designer-service Post Approval A post-approval policy level is configured to use the event subscription option.
Chapter 1 Life Cycle Extensibility Table 1‑5. Workflow Subscription and Event Broker Terminology (Continued) Term Description System Workflow Subscription A specialized workflow subscription that reacts to system events and to events in all the tenants. Tenant Workflow Subscription A specialized workflow subscription that specifies which conditions trigger a vRealize Orchestrator workflow for events in the same tenant.
Life Cycle Extensibility Replyable Event Topics Some event topics support replies from the subscribed service. The service that registered the replyable event topic can accept a reply event that provides the workflow output, usually as a result of an interaction with a system or user. The reply output parameters must meet the criteria defined in the reply schema so that the vRealize Automation service that published the original replyable event can process it.
Chapter 1 Life Cycle Extensibility Table 1‑6. Workflow Subscription options Option Description New Create a new subscription. Edit Modify the selected subscription. If the subscription is published, the saved changes are immediately active. You cannot edit the event topic or modify the blocking option for a published or unpublished subscription. Publish Make the subscription active. The events from the event broker service are processed and the subscription conditions are evaluated.
Life Cycle Extensibility Table 1‑7. Event Topic Options (Continued) Option Description Blockable Indicates whether you can create a blocking subscription for this event topic. Blocking subscriptions are used to change the event's payload or to synchonously run your custom logic when the results of a second workflow for the same event depend on the results of the first workflow.
Chapter 1 Life Cycle Extensibility Table 1‑8. Conditions Tab Options Option Description Run for all events The selected workflow runs when the message for this event topic is received. Run based on conditions The selected workflow runs when the event message is detected and the event meets the configured conditions. If you select this option, you must specify conditions based on the event data to trigger the selected workflow for this subscription. n Single condition.
Life Cycle Extensibility Table 1‑10. Details Tab Options Options Descriptions Name By default, the displayed name is the name of the selected workflow. This name is displayed in the subscription list. The name must be unique in the tenant. Priority The order in which the blocking subscriptions run. Zero is the highest priority.
Chapter 1 Life Cycle Extensibility Working with Provisioning and Life Cycle Workflow Subscriptions You create provisioning and life cycle workflow subscriptions so that you can use vRealize Orchestrator to extend your management of IaaS machines. The provisioning subscriptions extend what you can do during the provisioning process. The life cycle subscriptions extend what you can do when the user is managing the provisioned items.
Life Cycle Extensibility only processed by Manager Service as consumer */ virtualMachineAddOrUpdateProperties : Properties, /* properties on the machine to add/update only processed by Manager Service as consumer */ virtualMachineDeleteProperties : Properties /* properties to remove from the machine only processed by Manager Service as consumer */ } The vRealize Orchestrator parameters are mapped to the event's payload by name and type.
Chapter 1 Life Cycle Extensibility The element has the following structure in the message. lifecycleState : { state : STRING, phase : STRING, event : STRING } Table 1‑12. LifecycleState Elements Property Description Format and Values Examples state Contains workflow name and state name. {workflowName}.{stateName} n n n phase Contains the phase that triggered a message. PRE, POST, EVENT n n n event Contains the event. This property is optional and exists only when the phase is EVENT.
Life Cycle Extensibility Table 1‑13. Global Events State(Topic) Events [Triggering String] (Topic) Global n n n n n n n n n n n onBuildFailure [BuildFailure] (Provision) OnBuildSuccess [BuildSuccess] (Provision) OnFinalizeMachine [Destroy] (Provision) OnForceUnregisterEvent [ForceUnregister] (Provision) ReconfigureVM.Pending [ReconfigureVM.Pending] (Active) ReconfigureVM.ExecutionUpdated [ReconfigureVM.ExecutionUpdated] (Active) ReconfigureVM.RetryRequestMade [ReconfigureVM.
Chapter 1 Life Cycle Extensibility Table 1‑15.
Life Cycle Extensibility Table 1‑15. VMPSMasterWorkflow32 States and Events (Continued) State(Topic) Events [Triggering String] (Topic) UnprovisionMachine Pre(Provision) n Post(Provision) n WaitingToBuild Pre(Provision) n Post(Provision) n Example of VMPS Master Workflow The VMPS workflow is the master in which the other provisioning workflows are embedded. This example includes the Basic VM Workflow to illustrate the life cycle of a virtual machine.
Chapter 1 Life Cycle Extensibility Provisioning Life Cycle States by Machine Type The life cycle states by machine type are specific to certain virtual machine types. In addition to the master workflow, you can use the provisioning workflow states and events when you create triggering conditions for workflow subscriptions.
Life Cycle Extensibility State (Topic) Events (Topic) CreatingMachine Pre(Provision) n n n OnCreatingMachineComplete(Provision) OnCreatingMachineTimeout(Provision) FailedProvisioning n Pre(Provision) Opsware Virtual State (Topic) Events (Topic) AddingDisks Pre(Provision) n n n OnAddingDisksComplete(Provision) OnAddingDisksTimeout(Provision) BuildFinished n Pre(Provision) CreatingVM n Pre(Provision) n InitialPowerOn n Pre(Provision) n OnInitialPowerOnComplete(Provision) OnInitialPowerOnTi
Chapter 1 Life Cycle Extensibility State (Topic) Events (Topic) EjectCD n Pre(Provision) n n OnEjectCDComplete(Provision) OnEjectCDTimeout(Provision) FailedProvisioning n Pre(Provision) FinalizeProvisioning n Pre(Provision) n n InitialPowerOn Pre(Provision) n n InstallSoftware Pre(Provision) n MountCD Pre(Provision) n n n n n n OnFinalizeComplete(Provision) OnFinalizeTimeout(Provision) OnInitialPowerOnComplete(Provision) OnInitialPowerOnTimeout(Provision) OnInstallSoftwareComplete(Prov
Life Cycle Extensibility State (Topic) Events (Topic) FailedProvisioning n Pre(Provision) InitialPowerOn n Pre(Provision) n n OnInitialPowerOnComplete(Provision) OnInitialPowerOnTimeout(Provision) Linux Kickstart Workflow State (Topic) Events (Topic) AddingDisks Pre(Provision) n n n OnAddingDisksComplete(Provision) OnAddingDisksTimeout(Provision) BuildComplete n Pre(Provision) CreatingMachine n Pre(Provision) CustomizeOS Pre(Provision) n n n n n EjectingCD n Pre(Provision) n n OnCreating
Chapter 1 Life Cycle Extensibility Physical PXE Provisioning Workflow State (Topic) Events (Topic) CheckHardwareType n Pre(Provision) CleanPxe n Pre(Provision) n OnCleanPxeTimeout(Provision) FinalizeProvisioning n Pre(Provision) n OnFinalizeProvisioningTimeout(Provision) InitializeProvisioning Pre(Provision) n OnInitializeProvisioningTimeout(Provision) InitialPowerOn Pre(Provision) n OnInitialPowerOnTimeout(Provision) OnInstallOSComplete(Provision) OnInstallOSTimeout(Provision) FailedProvisio
Life Cycle Extensibility Physical SCCM PXE Provisioning Workflow State (Topic) Events (Topic) CheckHardwareType n Pre(Provision) CleanPxe n Pre(Provision) n OnCleanPxeTimeout(Provision) n n OnCompleteProvisioningComplete(Provision) OnCompleteProvisioningTimeout(Provision) FailedProvisioning n Pre(Provision) n OnFailedProvisioningTimeout(Provision) FinalizeProvisioning n Pre(Provision) n OnFinalizeProvisioningTimeout(Provision) InitializeProvisioning n Pre(Provision) n OnInitializeProvisionin
Chapter 1 Life Cycle Extensibility Virtual SCCM Provisioning Workflow State (Topic) Events (Topic) AddingDisks Pre(Provision) n n n OnAddingDisksComplete(Provision) OnAddingDisksTimeout(Provision) BuildComplete n Pre(Provision) CreatingMachine n Pre(Provision) n n CreatingMachineComplete(Provision) OnCreatingMachineTimeout(Provision) Disposing n Pre(Provision) EjectingCD n Pre(Provision) n n OnEjectingCDComplete(Provision) OnEjectingCDTimeout(Provision) FailedProvisioning n Pre(Provision) Init
Life Cycle Extensibility Configuring the Timeout Values for States and Events The default timeout value for all states and events is 30 minutes and is configured in the vRealize Automation global settings. Some workflows might take more time to run successfully. To accommodate different workflows in your environment, you can add timeout override values for individual workflows or states.
Chapter 1 Life Cycle Extensibility To customize the timeout or error behavior, you can add custom properties to the machine for any events or states where you want to trigger an event or force a state change. Use the following examples to configure the custom properties. n Extensibility.Lifecycle.Error.Event.{Workflow}.{State}. The value of the property is the name of the event to be triggered on in the workflow in case of timeout or error. n Extensibility.Lifecycle.Error.State.{Workflow}.{State}.
Life Cycle Extensibility Scenario: Create a Post-Provisioning Snapshot Workflow Subscription As a tenant administrator, you want to create a snapshot of each virtual machine after it is created. You configure a workflow subscription based on the machine provisioning event topic, and publish it to make it active. You configure the workflow subscription to run a create snapshot workflow when a virtual machine is provisioned and the detected event message is in the activated state.
Chapter 1 Life Cycle Extensibility What to do next To test the workflow subscription, request a virtual machine in the service catalog. After the request indicates successful provisioning, verify that the snapshot was created. Working with Approval Workflow Subscriptions You create pre-approval and post-approval workflow subscriptions so that you can send an approval request to an external system for processing. The response, approved or rejected, is then processed by vRealize Automation.
Life Cycle Extensibility description : STRING, // purpose of the request approvalLevel:ExternalReference,// approvalLevelName : STRING, // createDate : DATE_TIME, // requestedFor : STRING, // is initiated subtenantId : STRING, // requestedBy : STRING // request }, Description entered by the user specifying the Approval level ID.
Chapter 1 Life Cycle Extensibility Scenario: Send Software Requests to an External System for Approval As a tenant administrator, you want users outside vRealize Automation to approve a software component when a service catalog user requests a machine that includes software. You configure an approval policy that requires approval for all software provisioning and a workflow subscription that is configured to run when it receives pre-approval messages that match your defined conditions.
Life Cycle Extensibility What to do next You create an approval policy that uses the workflow subscription as an approver. “Scenario: Create an Approval Policy for External Approval,” on page 40 Scenario: Create an Approval Policy for External Approval As a tenant administrator, you create an approval policy that generates an event message that is published by the approval service.
Chapter 1 Life Cycle Extensibility Prerequisites n Log in to the vRealize Automation console as a tenant administrator. n Configure an approval policy level named External level for software. See “Scenario: Create an Approval Policy for External Approval,” on page 40. n Create a custom vRealize Orchestrator workflow that sends the request to your external system. In this scenario, use the Automation Approval Request workflow.
Life Cycle Extensibility n Troubleshooting vRealize Orchestrator Workflows That Do Not Start on page 42 You configure a workflow subscription to run a custom workflow when the event message is received, but the workflow does not run. n Troubleshooting Provisioning Requests That Take Too Much Time on page 42 An IaaS machine take ten or more hours to provision.
Chapter 1 Life Cycle Extensibility at DynamicOps.VMPS.Service.Workflow.Services.EventBrokerService.OnMessage(EventObject obj) [UTC:2015-11-14 07:14:25 Local:2015-11-13 23:14:25] [Error]: Thread-Id="15" context="HKBsp6Tt" token="JeuTG7ru" [EventBrokerClient] Invoking subscription callback failed: Event Queue operation failed with MessageQueueErrorCode QueueNotFound for queue '3679fa71-ac2a-42d5-8626-f98ea096f0d3'.
Life Cycle Extensibility Cause One possible cause is an internal error when vRealize Orchestrator tried to run the workflow. For example, the workflow is missing or the vRealize Orchestrator server is not running. Solution 1 Select Administration > Events > Event Logs. 2 Review the logs for messages related to approvals.
Chapter 1 Life Cycle Extensibility Table 1‑17. Extending Machine Lifecycles By Using vRealize Automation Designer Checklist (Continued) Task Details Using vRealize Automation Designer activities, customize an IaaS Workflow stub. Note The workflow stubs are replaced by the event broker workflow subscriptions. They are still available, supported, and they can be used, but expect them to be removed in a future version of vRealize Automation.
Life Cycle Extensibility Download the vRealize Automation Designer Installer You can download the vRealize Automation Designer installer from the vRealize Automation appliance. Prerequisites n Log in to the Windows machine as a local administrator. n If you are using Internet Explorer, verify that Enhanced Security Configuration is not enabled. See res://iesetup.dll/SoftAdmin.htm. Procedure 1 Open a browser.
Chapter 1 Life Cycle Extensibility Configuring vRealize Orchestrator Endpoints If you are using vRealize Automation workflows to call vRealize Orchestrator workflows, you must configure the vRealize Orchestrator instance or server as an endpoint. You can associate a vRealize Orchestrator endpoint with a machine blueprint to make sure that all of the vRealize Orchestrator workflows for machines provisioned from that blueprint are run using that endpoint.
Life Cycle Extensibility 5 Provide your vRealize Orchestrator credentials in the User name and Password text boxes to connect to the vRealize Orchestrator endpoint. The credentials you use should have Execute permissions for any vRealize Orchestrator workflows to call from IaaS. To use the default vRealize Orchestrator instance embedded in the vRealize Automation appliance, the user name is administrator@vsphere.local and the password is the administrator password that was specified when configuring SSO.
Chapter 1 Life Cycle Extensibility 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.
Life Cycle Extensibility 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 vRealize Automation Designer: state change workflows and menu operation workflows.
Chapter 1 Life Cycle Extensibility vRealize Automation Designer provides a customizable workflow for each of these states. Table 1‑18.
Life Cycle Extensibility Configuring a Menu Operation Workflow Overview You can customize a menu operation workflow by using vRealize Automation 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 vRealize Automation Designer.
Chapter 1 Life Cycle Extensibility 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 61.
Life Cycle Extensibility Call a vRealize Orchestrator Workflow You can use either the InvokeVcoWorkflow or the InvokeVcoWorkflowAsync activity to call a vRealize Orchestrator workflow from an IaaS workflow. Some vRealize Orchestrator workflows require user interaction during execution.
Chapter 1 Life Cycle Extensibility Get the Status of a vRealize Orchestrator Workflow You can check the status of a vRealize Orchestrator workflow that was called with the InvokeVcoWorkflowAsync activity using the GetVcoWorkflowExecutionStatus activity. Prerequisites “Call a vRealize Orchestrator Workflow,” on page 54 using the InvokeVcoWorkflowAsync activity. Procedure 1 In vRealize Automation Designer, open a workflow where you have used the InvokeVcoWorkflowAsync activity.
Life Cycle Extensibility 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.
Chapter 1 Life Cycle Extensibility 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.
Life Cycle Extensibility 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 58 The operation configuration file is required for menu operation workflows. It specifies the aspects of the custom menu option in the vRealize Automation console such as the display text, which roles have access to the option, and the machine states for which the option is available.
Chapter 1 Life Cycle Extensibility 4 Specify the roles to grant access to the menu operation. a Add the authorizedTasks element.
Life Cycle Extensibility Enterprise Administrator Custom Event VRM Administrator Custom Event On Off 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 58. Procedure 1 Open an elevated command prompt.
Chapter 1 Life Cycle Extensibility 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 vRealize Automation console as a tenant administrator or business group manager. Procedure 1 Select Design > Blueprints. 2 Point to the name of a blueprint and click Edit. 3 Click the Actions tab.
Life Cycle Extensibility 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.
Chapter 1 Life Cycle Extensibility 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.
Life Cycle Extensibility DEM-Add-Skills Associates skills with a registered Distributed Execution Manager. Synopsis CloudUtil.exe DEM-Add-Skills -n|--name -s|--skills [--repository ] [-v|--verbose] DEM-Add-Skills Arguments Argument Description -n | - -name Name of a registered Distributed Execution Manager. - -repository (Optional) The root URI of the Model Manager, for example, http://hostname/repository.
Chapter 1 Life Cycle Extensibility Argument Description -s | - -skills Comma-delimited list of skills to remove from this Distributed Execution Manager. -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 Exports a file from the Model Manager. Synopsis CloudUtil.
Life Cycle Extensibility File-List Lists all files imported into the Model Manager. Synopsis CloudUtil.exe File-List [--repository ] [-v|--verbose] File-List Arguments Argument Description - -repository (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 section.
Chapter 1 Life Cycle Extensibility Argument Description - -repository (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 section. -v | - -verbose (Optional) If an error occurs, outputs a stack trace instead of just the exception message. File-Rollback Reverts a file in the Model Manager to a specified revision. Synopsis CloudUtil.
Life Cycle Extensibility Operation-Create Creates a custom operation or set of operations that can be performed on a machine based on an operation definition file. Synopsis CloudUtil.exe Operation-Create -c|--operationConfig [--repository ] [-v|--verbose] Operation-Create Arguments Argument Description -c | - -operationConfig Path to an operation definition file (XML).
Chapter 1 Life Cycle Extensibility Skill Commands The Skill commands enable you to manage the skills associated with Distributed Execution Managers and workflows. Skill-Install Installs a skill in the Model Manager. Synopsis CloudUtil.exe Skill-Install -n|--name [--repository ] [-v|-verbose] Skill-Install Arguments Argument Description -n | - -name Name for the skill in the Model Manager.
Life Cycle Extensibility Skill-Uninstall Arguments Argument Description -n | - -name Name of the skill to uninstall from the Model Manager. - -repository (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 section. -v | - -verbose (Optional) If an error occurs, outputs a stack trace instead of just the exception message.
Chapter 1 Life Cycle Extensibility Workflow-Remove-Skills Removes association between skills and a workflow in the Model Manager. Synopsis CloudUtil.exe Workflow-Remove-Skills -n|--name -s|--skills [--repository ] [-v|--verbose] Workflow-Remove-Skills Arguments Argument Description -n | - -name Name of a workflow in the Model Manager. - -repository (Optional) The root URI of the Model Manager, for example, http://hostname/repository.
Life Cycle Extensibility Table 1‑24. Workflow-Update Arguments (Continued) Argument Description - -repository (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 section. -v | - -verbose (Optional) If an error occurs, outputs a stack trace instead of just the exception message.
Chapter 1 Life Cycle Extensibility Table 1‑25. (Continued) Argument Description -t | - -machinetype (Optional) Specify machine type to be exported, for example, Virtual, Physical, Cloud, AppService, vApp. -u | - -user Specify the Fabric Administrator who performs the bulk registration. -v | - -verbose (Optional) If an error occurs, outputs a stack trace instead of just the exception message. Machine-BulkRegisterImport Imports one or more virtual machines to a target vRealize Automation deployment.
Life Cycle Extensibility vRealize Automation Workflow Activity Reference VMware provides a library of workflow activities with vRealize Automation Designer for use in customizing workflows. Note The CDK is deprecated beginning with vRealize Automation 7.0. You can use the vRealize Orchestrator workflows to address use cases that you previously addressed with CDK.
Chapter 1 Life Cycle Extensibility AttachTo Notifies the DataServiceContext to start tracking the specified resource. Table 1‑29. 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.
Life Cycle Extensibility InvokeRepositoryWorkflow Executes a workflow installed in the Model Manager. Table 1‑34. InvokeRepositoryWorkflow Activity Input Parameters Argument Type Description WorkflowType WorkflowDefinition entity The workflow to execute. WorkflowInputs Dictionary (Optional) Inputs to the workflow. CallingInstance WorkflowInstance entity (Optional) The workflow that calls the executed workflow and to which it will return.
Chapter 1 Life Cycle Extensibility UpdateObject Changes the state of the specified object in the DataServiceContext to Modified. Table 1‑38. 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.
Life Cycle Extensibility 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 1‑41. 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.
Chapter 1 Life Cycle Extensibility GetMachineProperties Gets the list of custom properties associated with a machine. Table 1‑47. GetMachineProperties Activity Input Parameters Argument Type Description MachineId Guid The machine whose properties to retrieve. Table 1‑48. GetMachineProperties Activity Output Parameters Argument Type Description Properties Dictionary List of the machine’s properties. Values are returned decrypted if they were stored encrypted.
Life Cycle Extensibility InvokePowerShell Executes a PowerShell command. Table 1‑53. InvokePowerShell Activity Input Parameters Argument Type Description CommandText String Command to execute. Arguments IEnumerable (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.
Chapter 1 Life Cycle Extensibility Table 1‑55. InvokeSshCommand Activity Input Parameters (Continued) Argument Type Description 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 1‑56. InvokeSshCommand Activity Output Parameters Argument Type Description EnvironmentVariables Dictionary Output of command if any. Throws exception on error.
Life Cycle Extensibility Table 1‑59. RunProcess Activity Input Parameters (Continued) Argument Type Description 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 1‑60.
Chapter 1 Life Cycle Extensibility SetMachineProperty Creates or updates a custom property on a machine. Table 1‑61. 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.
Life Cycle Extensibility 84 VMware, Inc.
Index A activities AddLink 74 AddObject 74 AttachTo 75 CreateRepositoryServiceContext<T> 75 DeleteLink 75 DeleteObject 75 ExecutePowerShellScript 77 ExecuteSshScript 78 GetMachineName 78 GetMachineOwner 78 GetMachineProperties 79 GetMachineProperty 79 GetScriptFromName 79 GetVcoWorkflowExecutionStatus 55 InvokePowerShell 80 InvokeRepositoryWorkflow 76 InvokeSshCommand 80 InvokeVcoWorkflow 54 InvokeVcoWorkflowAsync 54 LoadProperty 76 LogMachineEvent 81 LogMessage 81 RunProcess 81 SaveChanges 76 SendEm
Life Cycle Extensibility customizing checklist for vRealize Orchestrator 7 enabling 57, 61 menu operation workflows 51, 52, 61 overview 11, 48 restricting execution to DEMs 61 reverting to previous revision 61 state change workflows 50, 51, 57 types of workflows 50 installation downloading the vRealize Automation Designer installer 46 prerequisites 45 vRealize Automation Designer 45 L life cycle, workflow subscriptions 21 lifecycles extending checklist for vRealize Automation Designer 44 extending with vR
Index tenant administrator 12 workflow tab 19 workflows activity reference 74 See also IaaS workflows VMware, Inc.
Life Cycle Extensibility 88 VMware, Inc.
