Skip to content

Pre-Migration Setup

Purpose

Pre-Migration Setup is a Clarity Transform menu group under Execute with three screens: Script Repository, Task Groups and Task Library. Together they hold the scripts, task groups and tasks that cut-over runbooks are created from on Execute → Migration Operations → Runbooks.

The screens are linked by these fields:

  • A task's Task Library Group Name names a group from Task Groups.
  • A task's Script refers to a script in Script Repository.
  • On Execute → Migration Operations → Runbooks, a primary and a linked rollback runbook are created for each move group from a primary and a rollback task library group. See Runbooks.

Script Repository

Purpose

The screen header is Automation Script Repository. The on-screen subtitle reads: "The Automation Script Repository stores reusable scripts that can be executed as part of runbook tasks. Scripts in this repository can automate a wide range of actions, such as system configuration, data migration, or validation steps, and can be referenced by tasks in your runbooks."

Where to find it

Execute → Pre-Migration Setup → Script Repository

Columns

  • Name
  • Script Type: the only value is Powershell
  • Credential: names a credential from Settings → Identity & Access Management → Credentials
  • Description

The grid also has the hidden columns Id, Technology and the audit fields. The rows have no row actions.

Fields

The create form (Create new entry) has these fields. The edit form (Edit entry) has the same fields, filled in.

  • Name
  • Script Type: a list with one option, Powershell.
  • Credential: a list of the stored credentials. Help text: "Only required if your script needs to interact with the guest operating system. Credentials required for interacting with Hypervisor platforms are handled internally by Clarity.Web."
  • Description
  • Script File: a file upload, with the button Choose file....

The form footer has Cancel and Save.

Actions

The grid has the standard Clarity toolbar: the add icon (Create New), Edit, Remove selected, Clear selection, Reload table data, Enable spreadsheet editing, Export CSV and Import CSV.

Task Groups

Purpose

The screen header is Task Library Groups. The on-screen subtitle reads: "Task Library Groups allow you to organize your runbook tasks into logical categories or workflow stages. Create groups like "Pre-Migration", "VM Migration", or "Post-Migration" to better organize and manage your automation tasks. Each runbook can then select from a specific group's tasks."

Where to find it

Execute → Pre-Migration Setup → Task Groups

Columns

  • Name
  • Description

The grid also has the hidden columns Id, Is Active, Sort Order and the audit fields. Each row has a View Details row action (the eye icon).

Fields

The create and edit forms have two fields:

  • Name
  • Description

Is Active and Sort Order are not shown in the form.

Actions

The grid has the standard Clarity toolbar: the add icon (Create New), Edit, Remove selected, Clear selection, Reload table data, Enable spreadsheet editing, Export CSV and Import CSV.

Task Library

Purpose

The screen header is Runbook Task Library. The on-screen subtitle reads: "The Runbook Task Library contains a catalog of predefined tasks that can be added to runbooks. Tasks may include running scripts, sending emails, or performing other automated actions. Built-in tasks shipped with Clarity appear here as system tasks and can be enabled when you want them included in new runbooks."

Where to find it

Execute → Pre-Migration Setup → Task Library

Columns

  • Name
  • Task Library Group Name: names a group from Task Groups
  • Order
  • Description
  • Action
  • Script: refers to a script in Script Repository
  • Send Email On Complete
  • Operating System
  • Send Email On Failed
  • Stage
  • Clarity Tags: matched against the Clarity Tags on devices, to select which devices a task is created for
  • Tag Match Mode
  • Is Enabled
  • Is System Task: marks the built-in tasks shipped with Clarity

The grid also has the hidden columns Id, Send Email On Complete, Send Email On Failed, Email Template Name, Execution Endpoint and the audit fields. Each row has a View Details row action (the eye icon).

Fields

The create form (Create new entry) has these fields. No field is marked as required.

  • Name
  • Task Library Group Name: a list of the task groups.
  • Order
  • Description
  • Action: Manual, Send Email, Run Script or Cutover.
  • Send Email On Complete: a checkbox. Help text: "Send an email notification when this task completes successfully".
  • Operating System: Windows or Linux.
  • Send Email On Failed: a checkbox. Help text: "Send an email notification when this task fails".
  • Clarity Tags: a list of the Clarity Tags; you can choose more than one. Help text: "Optional device tag filter for runbook creation. Leave blank to include all devices, or enter tags so the task is only created for devices whose clarity_tags match them using Tag Match Mode."
  • Tag Match Mode: All or Any.
  • Is Enabled: a checkbox, ticked by default on a new task. Help text: "Enable or disable this library task for runbook creation." Untick it to keep the task out of new runbooks.
  • Is System Task: a checkbox that you cannot change. Help text: "Mark this task as always available regardless of the selected task library group." Only the built-in tasks shipped with Clarity are system tasks; a task you create is never one.
  • Execution Endpoint: help text: "Optional automation endpoint (e.g. a Nutanix SSP integration endpoint) for automation actions such as 'Run SSP Operation'. Leave blank to auto-resolve the single matching endpoint, or set a name to target a specific one."

The Action you choose adds fields to the form:

  • Run Script adds Script, a list of the scripts in Script Repository, and Stage, with the options Pre cutover and Post cutover. The Stage help text reads: "This setting determines wether the action (if running a script) is passed the source or target platform to run against."
  • Send Email adds Email Template Name, a list of the email templates. Help text: "Select the email template to use for notifications".
  • Manual and Cutover add no fields.

Email Template Name also shows, for any Action, when Send Email On Complete or Send Email On Failed is ticked. It sets the template used for those notifications. See Attach a template to a task.

The edit form (Edit entry) has the same fields, filled in, plus the fields for the row's Action. The form footer has Cancel and Save.

The form's Action list does not offer Run SSP Operation, although the Execution Endpoint help text names it and tasks in the library use it.

Values

The values below are those seen in the lab data. Some are not offered in the form.

  • Action: the values seen are Send Email, Manual, Run Script, Run SSP Operation and Cutover.
  • Stage: the values seen are Pre cutover, Post cutover and Cutover. The form offers Pre cutover and Post cutover only.
  • Operating System: the value seen is All. The form offers Windows and Linux.
  • Tag Match Mode: the value seen is All.

Actions

The grid has the standard Clarity toolbar: the add icon (Create New), Edit, Remove selected, Clear selection, Reload table data, Enable spreadsheet editing, Export CSV and Import CSV.

System tasks

The system task names seen are:

  • App Services Shutdown Comms Sent
  • App Services Shutdown Confirmed
  • Application Smoke Test Comms Sent
  • Application Signed Off
  • Device Smoke Test Comms Sent
  • Device Signed Off
  • Sequence Smoke Test Comms Sent
  • Sequence Signed Off

There are four smoke-test comms system tasks: the three above and a duplicate in lower case, Application smoke test comms sent.

System tasks are locked. In the edit form, every field except Is Enabled is disabled, so you can only enable or disable a system task. This includes Send Email On Complete, Send Email On Failed and Email Template Name, which cannot be changed on system tasks. System tasks cannot be deleted: Remove selected is disabled while a system task is selected, and Clarity shows "Built-in runbook tasks are seeded by the product and cannot be deleted. Toggle Enabled instead."

Filters

Each of the three grids has a filter row under its column headings, a Search: box and an entries per page selector (10, 25, 50 or All).

The grid remembers its Search: text, column filters, sort order and page size between visits. If the grid shows fewer rows than you expect, clear the Search: box and the filter row.

How to

Add a script

  1. Go to Execute → Pre-Migration Setup → Script Repository.
  2. Select the add icon (Create New). The Create new entry form opens.
  3. Enter a Name and a Description, and choose the Script Type.
  4. Choose a Credential only if the script needs to sign in to the guest operating system.
  5. Under Script File, select Choose file... and choose the script.
  6. Select Save.

Add a task group

  1. Go to Execute → Pre-Migration Setup → Task Groups.
  2. Select the add icon (Create New). The form opens.
  3. Enter a Name and a Description.
  4. Select Save.

Add a task to the library

  1. Go to Execute → Pre-Migration Setup → Task Library.
  2. Select the add icon (Create New). The Create new entry form opens.
  3. Enter a Name, choose the Task Library Group Name, and fill in Order and Description.
  4. Choose the Action. For Run Script, also choose the Script and the Stage. For Send Email, also choose the Email Template Name.
  5. To create the task only for some devices, choose Clarity Tags and a Tag Match Mode. Leave Clarity Tags blank to include all devices.
  6. Is Enabled is ticked by default; untick it to keep the task out of new runbooks. Tick Send Email On Complete or Send Email On Failed if you want notifications, then choose the Email Template Name to use for them.
  7. Select Save.

Enable a system task

  1. Go to Execute → Pre-Migration Setup → Task Library.
  2. Select the system task's row, then select Edit. The Edit entry form opens with every field except Is Enabled disabled.
  3. Tick Is Enabled (or untick it to stop the task being added to new runbooks).
  4. Select Save.
  • Runbooks: create a primary and a linked rollback runbook for each move group from a primary and a rollback task library group.
  • Credentials: the credentials named in a script's Credential.
  • Clarity Tags: the tags used in a task's Clarity Tags.
  • Email Templates: the templates offered in a task's Email Template Name.