Packt+ | Advance your knowledge in tech

You're reading from VMware vRealize Orchestrator Cookbook. - Second Edition

Product type Book

Published in Nov 2016

Publisher Packt

ISBN-13 9781786462787

Pages 556 pages

Edition 2nd Edition

Languages

Concepts

Cloud Computing

Author (1):

Daniel Langenhan

Table of Contents (19) Chapters

VMware vRealize Orchestrator Cookbook Second Edition

Credits

About the Author

About the Reviewers

www.PacktPub.com

Preface

1. Installing and Configuring Orchestrator

2. Optimizing Orchestrator Configuration

3. Distributed Design

4. Programming Skills

5. Visual Programming

6. Advanced Programming

7. Interacting with Orchestrator

8. Better Workflows and Optimized Working

9. Essential Plugins

10. Built-in Plugins

11. Additional Plugins

12. Working with vSphere

13. Working with vRealize Automation

Chapter 4. Programming Skills

This chapter deals with the skills that an Orchestrator user needs on a more or less daily basis. We will be looking at the following recipes:

Version control
Changing elements in a workflow
Importing and exporting Orchestrator elements
Working with packages
Workflow auto documentation
Resuming failed workflows
Using the workflow debugging function
Undelete workflows and actions
Scheduling workflows
Sync presentation settings
Locking elements

Introduction

In this chapter, we will focus on using the Orchestrator Client and what one should know about it. The Orchestrator Client is a Java-based client that can be launched via the Orchestrator home page or can be locally installed. The Orchestrator Client is mainly used to create new workflows as well as to configure plugins. However, you also can use it for executing workflows. In this case, it is a good idea to configure non-administrative access to Orchestrator as shown in the User management recipe in Chapter 7, Interacting with Orchestrator.

The Orchestrator icons

The Orchestrator Client has three modes: Run, Design, and Administer. The setting can be changed by selecting the value from the top drop-down menu. You will use the Orchestrator Client mostly in the Design mode when you program. If you are a user, you probably will use the Run mode.

Let's have a quick look at all the icons of Orchestrator Client:

Version control

In this recipe, we will look at how to use the Orchestrator version control and use it to control your software development. Version control is part of almost all elements.

Getting ready

A working Orchestrator is required, and you will need the rights to create new workflows and run them. We will work with the Orchestrator Client.

We need an existing workflow that we can play around with. In this recipe, we will use the 00.00 BasicWorkflow workflow of the example package. The finished example is the 04.02 VersionControl example workflow.

How to do it...

We will use a workflow for this example; however, it works for other elements too:

Make a duplicate of the 00.00 BasicWorkflow workflow.
Click on General and have a look at the current version (see the following screenshot).
Open the workflow for editing by right-clicking on it and selecting Edit.
Drag a system log element from the log section into the schema.
Bind the text in-parameter to an existing string variable.
Click on General...

Changing elements in a workflow

In this recipe, we will have a closer look at the challenges that change the workflow elements in a schema pose. Changing the in- and out-parameters, as well as moving or renaming actions will be discussed. You will learn how to make these changes as well as what to avoid.

Getting ready

We need a workflow that has an additional workflow as well as an action in its schema.

You can use the 04.01.02 MainWorkFlow and 04.01.01 SubWorkflow example workflows as well as the reNameMe action, which is part of the example package.

How to do it...

There are only two major tasks: changing the parameters and renaming/moving the actions.

Changing the parameters of workflows and actions

If you change a subworkflow's in/out-parameters, you will need to synchronize its parameters by following these steps:

Make sure that you have a workflow that has a workflow as an element in its schema. You can use the 04.01.02 MainWorkFlow and 04.01.01 SubWorkflow example workflows.
In the subworkflow...

Importing and exporting Orchestrator elements

In this recipe, we will learn how to import and export elements from one Orchestrator to another using Orchestrator Client.

Getting ready

We need at least one workflow, action, or other element that we can export, delete, and import. If you have two Orchestrator servers, you can export the element on one and import into the other.

How to do it...

In this example, we will use a workflow to import and export an object. However, the same methods apply to all Orchestrator elements.

Exporting an object

We will use the 00.00 BasicWorkflow workflow of the example package in this example. Exporting also works for other elements:

To export a workflow, right-click on it and select Export workflow.
A window will pop up that shows you your local drives from the computer you are running Orchestrator Client on.
Select a directory and a name for the workflow (the default name is the name of the workflow). The default file extension is .workflow.
You can define a name...

Working with packages

In this recipe, you will learn how to create, export, and generally work with packages. Packages are great for shipping complete Orchestrator solutions between Orchestrators to customers or for backup.

Getting ready

We need at least one workflow or action to work with in this recipe. Optimally, you have workflows and actions that depend on each other. You can test with the 04.03 Export-Package example workflow; it contains an action and another workflow.

How to do it...

This recipe has several sections. As an overview, the following screenshot shows all the icons and their usages. To get to the correct section, follow these instructions:

Using Orchestrator Client, make sure that you are in Design mode.
Click on packages (the yellow box with a white circle icon):

Create a new package

Either right-click on the white space below the displayed packages and select Add package, or select the icon from the right-hand side (the yellow box with a white circle icon).
Select a new name...

Workflow auto documentation

This recipe will showcase the automatic documentation ability of Orchestrator. We will learn what Orchestrator documents and how it documents workflows.

Getting ready

We need at least one workflow for this recipe that we can document. A good example workflow would be one that contains other workflows, actions, and scriptable tasks.

How to do it...

Right-click on a workflow or a folder and select Generate Documentation.
Select a directory and give the file a name.

A PDF with the documentation is now created.

How it works...

The documentation that is created isn't that flashy, but it is quite useful. The created PDF document contains the following sections:

Icon	Used in recipe/chapter	What is covered?
My Orchestrator...

Resuming failed workflows

This recipe looks at the ability to resume a failed workflow. It allows you to resume a workflow when an error has occurred.

Getting ready

We just need a working Orchestrator, and you will need the rights to create new workflows and run them. We will work with the Orchestrator Client.

To make it easier, we reuse the workflow we will create in the Error handling in workflows recipe in Chapter 5, Visual Programming ( the 05.03.01 Error Handling example workflow). If you don't have it, please create it as described or use the example package that is supplied with this book.

How to do it...

The following steps showcase the functionality:

Create a new workflow.
Drag Workflow element onto the schema and select the workflow we created in the Error handling in workflows recipe in Chapter 5, Visual Programming.
Assign the in-parameter of the Error Handling workflow to the in-parameter of the workflow you added in step 2.
Drop two additional System log instances before and after the...

Using the workflow debugging function

This recipe showcases how to use the debug feature to find and resolve errors in a workflow. The debug function was introduced in version 5.5.

Getting ready

We just need a working Orchestrator, and you will need the rights to create new workflows and run them. We will work with the Orchestrator Client.

We need a new workflow, and to make things easier we reuse some old workflows, such as 00.00 BasicWorkflow and 05.03.01 Error Handling from the example package.

How to do it...

Create a new workflow and add the 00.00 BasicWorkflow and 05.03.01 Error Handling workflows (as shown in the following screenshot).
Bind all variables as required.
Right-click on the first element of your workflow and select Toggle breakpoint. A blue ball appears on the left next to the element.
You can debug a workflow either while still in edit mode or when you exit it. Choose one and click on Debug (the bug icon) to start the debug process.
The debug process starts the workflow and will...

Undelete workflows and actions

This recipe shows how to undelete deleted workflows and actions, as this comes in handy when one deletes something that one shouldn't have.

Getting ready

To undelete a workflow, we need a deleted workflow or action first.

How to do it...

We will use a workflow in this example, as the undelete function for actions works exactly the same:

Right-click on a folder (or the root element ) and select Restore deleted workflows.
A popup will display all the workflows or actions that can be restored. Tick all the workflows you would like to restore and click on Restore:

The workflows or actions will now be restored.

How it works...

All workflows and actions are stored in the Orchestrator database and as such, they can be restored. However, you cannot restore a workflow with the same ID that already exists; names of workflows are of no importance in Orchestrator.

Scheduling workflows

In this recipe, you will learn how to schedule workflows. Scheduled workflows will automatically run at given times and intervals.

Getting ready

We need at least one workflow we can schedule. The workflow should not contain a user interaction.

How to do it...

Right-click on the workflow you would like to schedule and choose Schedule workflow.
Select Task name. By default, the task name is set to be the workflow name. A good naming standard comes in handy here, especially if you schedule recurring tasks.
Set a start date and time.
If this task has been scheduled in the past, you can still run the workflow. This setting is useful if a task had been scheduled but during the planned execution time, Orchestrator server was not available (for example, powered off). The task will then start as soon as Orchestrator server is available again.
You can create a recurring task. You have the base setting for every minute, hour, day, week, and month. Except for the week setting, you can schedule...

Sync presentation settings

In this recipe, we will make it easier for you to reuse presentation settings from embedded workflows.

Getting ready

We need a workflow with a presentation assigned to it; you can use the 05.05 Workflow Presentation example workflow.

How to do it...

Log into the Orchestrator Client and create a new workflow.
Drag the workflow with the presentation onto the schema. You can use the 05.05 Workflow Presentation example workflow.
Right-click the workflow and select Synchronize | Synchronize presentation.
Confirm that you want to sync.
Check the presentation of your new workflow.

How it works...

This is one of the functions that has been around for some time but people don't know about. It not only syncs the presentation but also links up all the workflow elements inputs as INPUTs.

Locking elements

We will have a quick look at the locking mechanism of Orchestrator.

Getting ready

For locking workflows, we need a workflow that we can use to lock, primarily, a workflow that calls other actions or workflows. If you don't have one in hand, use the 06.06.01 Using Asynchronous Workflows example workflow.

How to do it...

There are only two options in the locking system.

Locking workflows

To lock a workflow, action, or package, follow these steps:

Right-click on a workflow, action, or package.
Navigate to Locking | Lock or Locking | Lock with dependencies. The Lock with dependencies option will lock all subworkflows and subactions that are used in this workflow.

Notice that the little lock icon on the item you have locked; you will not be able to edit this workflow anymore. However, you are still able to run it.

Unlocking workflows

Unlocking should be obvious now. However, note that there is no unlock with dependencies option, which means that you have to unlock each element by itself...

The rest of the chapter is locked

You have been reading a chapter from

VMware vRealize Orchestrator Cookbook. - Second Edition

Published in: Nov 2016 Publisher: Packt ISBN-13: 9781786462787

A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.

Unlock this book and the full library FREE for 7 days

Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of

Start free trial

Renews at €14.99/month. Cancel anytime}

Authors (1)

Daniel Langenhan

Daniel Langenhan is a Virtualisation expert with formidable skills in Architecture, Design and Implementation for large multi-tier systems. His experience and knowledge of process management, enterprise-level storage, Linux and Windows operation systems has made him and his business a highly sought after international consultancy in the Asia-Pacific and European regions for multinational clientele in the areas of Finance, Communication, Education and Government. Daniel has been working with VMware products since 2002 and is directly associated with VMWare since 2008. His proven track record of successful integrations of Virtualisation into different business areas while minimizing cost and maximizing reliability and effectiveness of the solution for his clients. Currently, Daniel is operating in the Europe and Asia-Pacific region with his company vLeet GmbH and Melbourne Business Boosters Pty Ltd. Daniel's expertise and practical approach to VMWare has resulted in the publication of the following books: Instant VMware vCloud Starter, Packt Publishing VMware View Security Essentials, Packt Publishing VMware vCloud Director Cookbook, Packt Publishing VMware vRealize Orchestrator Cookbook, Packt Publishing VMware vRealize Orchestrator Essentials, Packt Publishing He has also lent his expertise to many other publishing projects as a Technical Editor.

See other products by Daniel Langenhan

Personalised recommendations for you

Based on your interests and search pattern

Designing and Implementing Microsoft Azure Networking Solutions

Designing and Implementing Microsoft Azure Networking Solutions Exam Ref AZ-700 is an all-encompassing guide to the AZ-700 exam and contains all the information you need to succeed in the world of virtual networking with Azure. With this book, you will be fully prepared for the exam and the world of cloud networking.

Aug 2023 17 hours 28 minutes

Microsoft 365 Security, Compliance, and Identity Administration

The Microsoft 365 Security, Compliance, and Identity Administration is a comprehensive guide that helps you employ Microsoft 365's robust suite of features and empowers you to optimize your administrative tasks.

Aug 2023 21 hours 0 minutes

Zero Trust Overview and Playbook Introduction

Get started on Zero Trust with this step-by-step playbook and learn everything you need to know for a successful Zero Trust journey with tailored guidance for every role, covering strategy, operations, architecture, implementation, and measuring success. This book will become an indispensable reference for everyone in your organization.

Oct 2023 8 hours 0 minutes

The Self-Taught Cloud Computing Engineer

This self-study book helps you master multiple clouds, including AWS, Azure, and GCP, and serves as a roadmap to becoming a certified cloud computing expert. The book will guide you to develop a professional cloud career by helping you build a broad cloud knowledge base, developing hands-on cloud computing skills, and getting cloud certified.

Sep 2023 15 hours 44 minutes

Technology Operating Models for Cloud and Edge

This book will help you build and create ownership of a technology operating model, as well as connect your leadership with engineering and operations, keeping your internal and external customers in mind. It provides practical tips on why, where, and how to make the cloud and edge platform paradigm sing for you, your team, and your organization.

Aug 2023 7 hours 36 minutes

Azure Architecture Explained

Azure is the preferred platform to build mission-critical and secure apps. This book provides comprehensive coverage of essential Azure products, services, and solutions vital for every solution architect's success. Elevate your knowledge and master the critical components of Azure to excel in your role with Azure Architecture Explained.

Sep 2023 14 hours 52 minutes

Pentesting Active Directory and Windows-based Infrastructure

This practical guide helps you explore the pentesting of Microsoft infrastructure in detail, and enhances your offensive skillset by showing you the different ways to perform security assessment. This book will help blue teamers and IT engineers get up to speed with possible security issues they may encounter in their Windows environments.

Nov 2023 12 hours 0 minutes

Practical Ansible

In Practical Ansible, you'll work with the latest release of Ansible and learn to solve complex issues quickly with the help of task-oriented scenarios. You'll start by installing and configuring Ansible to automate monotonous and repetitive IT tasks and get to grips with concepts such as playbooks, inventories, plugins, collections, and network modules.

Sep 2023 14 hours 0 minutes

Windows 11 for Enterprise Administrators

Microsoft’s launch of Windows 11 is a step toward satisfying the enterprise administrator’s needs for better management and enhanced user experience customization. This book provides the enterprise administrator with the knowledge needed to fully utilize the advanced feature set of Windows 11 Enterprise.

Oct 2023 9 hours 32 minutes

The Linux DevOps Handbook

This book is for software and IT professionals seeking knowledge on Linux systems and DevOps practices. This book will provide you with guidance and tools to learn and gain proficiency in managing Linux-based infrastructures and knowledge of DevOps.

Nov 2023 14 hours 16 minutes

Section	Description
Versions	This is a summary of all existing versions this workflow has, including the create date, create user, and any comments you have made regarding this version.
Inputs	This contains a list of all the in-parameters of the workflow as well as their type and description.
Outputs	This...