The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter contains the following sections:
You can edit many features of an existing workflow. You can:
Rename a workflow
Reorder inputs
Delete inputs
Rename inputs
Change an input from optional to mandatory (but not the reverse)
Edit tasks in the workflow
You can also:
Delete any or all versions of a single workflow
Delete the default version or all versions of multiple workflows at one time
The following sections describe these procedures.
Note | To modify a predefined workflow, we recommend that you create a new version of that workflow before making the changes. If you modify a default predefined workflow, you can affect what happens in Cisco UCS Director when you click an action button. Actions that you take in Cisco UCS Director, such as creating or modifying a VM, use the default predefined workflows. For example, when you click the Create button on the page, Cisco UCS Director runs the default Create HyperFlex Datastore workflow and creates a service request for the action. |
To rename a workflow, change its name field.
Note | All versions of the workflow are renamed. |
You cannot rename a compound task.
You have selected the workflow you want to rename and chosen the Edit action.
You have selected the workflow in which you want to reorder the inputs and have chosen the Edit action.
You can delete one or more inputs while editing an existing workflow.
Note | You can also delete inputs in a cloned workflow. |
To delete inputs from an opened workflow, do the following:
Select the workflow from which you want to delete inputs.
Click Edit to open the Edit Workflow window.
Click Next to move to the Edit User Inputs page.
Click Next to move to the Edit User Outputs page, then click Submit.
You can rename inputs while editing an existing workflow.
To rename inputs from an opened workflow, do the following:
Select the workflow in which you want to rename inputs.
Click Edit to open the Edit Workflow window.
Click Next to move to the Edit User Inputs page.
Click Next to move to the Edit User Outputs page, then click Submit.
You can change the optionality (optional or required status) of workflow inputs.
Note | You cannot map an optional workflow input to a mandatory task input. Similarly, you cannot change an input from mandatory to optional if it is mapped to a mandatory task input. |
Select the workflow you want to edit and choose the Edit action.
You can edit a task in an existing workflow. The change is local to the workflow and version containing the edited task. For example, if you edit task A in version 0 of workflow X, the task remains unchanged in workflow Y and in version 1 of workflow X.
Step 1 | Open a workflow in the Workflow Designer. | ||||||||||||||||||
Step 2 | In the workflow display, double-click the task that you want to edit. The Edit Task window appears. | ||||||||||||||||||
Step 3 | In the
Task
Information screen, you can edit the following fields:
| ||||||||||||||||||
Step 4 | Click Next. | ||||||||||||||||||
Step 5 | On the User
Input Mappings page, you can edit the following fields:
| ||||||||||||||||||
Step 6 | Click Next. | ||||||||||||||||||
Step 7 | On the
Task
Input page, you can edit the following fields:
| ||||||||||||||||||
Step 8 | In the
User
Output Mapping screen, you can edit the following fields:
| ||||||||||||||||||
Step 9 | Click Submit. |
You can delete any or all versions of a workflow.
Step 1 | On the menu bar, choose . |
Step 2 | Choose the Workflows tab. |
Step 3 | Choose Delete from the task bar or from the actions drop-down list. |
Step 4 | In the Delete Workflow(s) dialog, choose the versions that you want to delete. To choose all versions for deletion, check the check box at the top of the list. |
Step 5 | Click the Delete button. |
You can delete more than one workflow at a time.
Step 1 | On the menu bar, choose . | ||
Step 2 | Choose the Workflows tab. | ||
Step 3 | Choose all the
workflow you want to delete.
| ||
Step 4 | Choose Delete All from the task bar or from the actions drop-down list. | ||
Step 5 | In the Delete Workflow dialog, check the Delete All Versions check box if you want to delete all versions of the selected workflows. Otherwise only the default version is deleted. | ||
Step 6 | Click the Delete button. |
You can export and import workflows, custom tasks, script modules, and activities in Cisco UCS Director. This is useful if, for example, you want to:
Move or copy workflows or other entities to different Cisco UCS Director instances.
Back up or store entities.
Use templates to standardize workflows.
Cisco UCS Director artifacts are exported from and imported to Cisco UCS Director in a single package. The you exported or imported file has a.wfdx extension and is an XML file containing a serialized representation of the objects. The file contains at least one of the following:
For example, you might import a file that contains only a single custom task; or a file that contains several workflows, a script module, and a few activities; and so on.
You can export and import workflows as templates.
When you export a template, all of the tasks within the workflow are retained. When you create a new workflow using a template, task inputs that have been mapped to workflow inputs cannot be modified. However, you can modify inputs which have not been mapped.
Step 1 | On the menu bar, choose . | ||||||||
Step 2 | In the Orchestration pane, click the Workflows tab. | ||||||||
Step 3 | On the Workflows tab, click Export. | ||||||||
Step 4 | In the Select Workflows screen, select the workflows that you want to export. | ||||||||
Step 5 | Click Next. | ||||||||
Step 6 | In the Select Custom Tasks screen, select the custom tasks that you want to export. | ||||||||
Step 7 | Click Next. | ||||||||
Step 8 | In the Export: Select Script Modules screen, select the script modules that you want to export. | ||||||||
Step 9 | Click Next. | ||||||||
Step 10 | In the Export: Select Activities screen, select the activities that you want to export. | ||||||||
Step 11 | In the
Export:
Confirmation screen, complete the following fields:
| ||||||||
Step 12 | Click Export. |
You are prompted to save the file.
To import artifacts into Cisco UCS Director, do the following:
Step 1 | On the menu bar, choose . | ||||||||||||||||
Step 2 | In the Orchestration pane, click the Workflows tab. | ||||||||||||||||
Step 3 | Click the Import action. | ||||||||||||||||
Step 4 | In the Import dialog box, click Upload. | ||||||||||||||||
Step 5 | In the File Upload dialog, click Click and select a file from your computer. | ||||||||||||||||
Step 6 | Select the import file. Cisco UCS Director import and export files have a .wfdx file extension. When the file is uploaded, the File Upload dialog displays File ready for use. | ||||||||||||||||
Step 7 | Dismiss the File Upload dialog. | ||||||||||||||||
Step 8 | Click Next. The Import dialog displays a list of Cisco UCS Director objects contained in the uploaded file. | ||||||||||||||||
Step 9 | (Optional)
Specify how objects are handled if they duplicate names already in the workflow
folder. In the
Import dialog box, complete the following fields:
| ||||||||||||||||
Step 10 | Click Import. |
A workflow template is like an outline of a workflow. It contains placeholders for all the tasks in the workflow, but is not executable.
A workflow template is useful when you want to import a workflow to a different Cisco UCS Director instance, especially if the workflow is large or contains custom tasks.
A workflow template contains the following elements:
Task names. Only the names are exported; the tasks themselves must exist in the Cisco UCS Director environment in order to execute.
Workflow structure (connections between tasks).
Input names.
A workflow template does not contain these elements:
Custom tasks. Since only task names are exported in a template, you must import custom tasks in the new Cisco UCS Director environment in order for them to execute.
Admin input values. Since the elements referred to by input values are unlikely to exist in the new Cisco UCS Director environment, input values must be redefined.
You can export a workflow as a template. To export a workflow as a template:
Step 1 | On the menu bar, choose . | ||||||
Step 2 | Choose the Workflows tab. | ||||||
Step 3 | Choose a workflow. | ||||||
Step 4 | Click Export As Template. | ||||||
Step 5 | In the
Export as
Template dialog, complete the following fields:
| ||||||
Step 6 | Click
Submit.
You are
prompted to save the template to your system.
|
To import a workflow template:
Step 1 | On the menu bar, choose . |
Step 2 | Choose the Workflow Templates tab. |
Step 3 | Click the Import action. |
Step 4 | In the Import dialog box, click Upload. |
Step 5 | In the File Upload dialog, click Click and select a file from your computer. |
Step 6 | Select the template file. Cisco UCS Director template files have a .wft file extension. When the file is uploaded, the File Upload dialog displays File ready for use. |
Step 7 | Dismiss the File Upload dialog. |
Step 8 | In the Import Template dialog, click Submit. |
The template appears on the Workflow Templates page.
Step 1 | On the menu bar, choose . | ||||||
Step 2 | Choose the Workflow Templates tab. | ||||||
Step 3 | Choose a template. | ||||||
Step 4 | Click Create Workflow. | ||||||
Step 5 | In the Overview
screen, complete the following fields:
| ||||||
Step 6 | Click Next. | ||||||
Step 7 | Click through the remaining pages of the Create Workflow from Template wizard. You can change any editable task-specific inputs that appear. | ||||||
Step 8 | Click Submit. |
The workflow is created in the Template Workflows folder on the Workflows page.
What to Do Next
Open the workflow in the Workflow Designer and configure it to work in its new environment.
Name | Purpose | Description |
---|---|---|
Customer Onboarding template |
Customer onboarding in a secure multitenancy setting |
The workflow does the following:
|
Deploy ESXi Host template |
Deployment of a new blade as an ESXi Host on a VMware (vCenter) account |
The workflow does the following: |
Deploy ESXi Host with ONTAP template |
Deployment of a new blade as an ESXi Host on a VMware (vCenter) account. | Workflow does the following: |
Deploy ESXi Host of Local Storage (without a Cisco Nexus 1000v Series switch) template |
Deployment of a new blade as an ESXi local storage host (without using a Cisco Nexus 1000v Series switch) on a VMware (vCenter) account |
The workflow does the following: |
Attach VLAN to Storage Controller template |
Attaching a NetApp storage controller's Ethernet ports to a new VLAN |
The workflow does the following: |
Cisco UCS Director provides a set of features for managing versions of a workflow. For an introduction to workflow versioning, see Workflow Versioning.
The following sections discuss how to manage workflow versions.
You can create a new version of a workflow. You can then modify the new version without changing the old version.
You have an existing workflow that you want to modify.
Step 1 | On the menu bar, choose . | ||||||
Step 2 | Choose the Workflows tab. | ||||||
Step 3 | Choose the workflow to duplicate. | ||||||
Step 4 | Click the Create New Version action. | ||||||
Step 5 | In the
Create
New Version screen, complete the following fields:
| ||||||
Step 6 | Click Submit. The new version opens in the Workflow Designer. | ||||||
Step 7 | In Workflow Designer, complete your changes for the workflow. | ||||||
Step 8 | Click Close. |
If the Manage Versions settings specify Set latest version as default, the new version becomes the default version. The Workflows page displays the new version of the workflow under the Version column.
If the Manage Version settings specify Set selected version as default, the new version is created but the default version does not change. See Choosing the Default Version of a Workflow.
Step 1 | On the menu bar, choose . | ||||||||
Step 2 | Choose the Workflows tab. | ||||||||
Step 3 | Right click the workflow and choose Manage Versions. | ||||||||
Step 4 | In the
Manage
Versions screen, complete the following fields:
| ||||||||
Step 5 | Click Submit. |
When you update a compound task, the new version of the compound task replaces the old one in all workflows that use the compound task.
However, it is possible for some versions of a workflow to be compound tasks while other versions of the same workflow are not. Normally, the behavior of a workflow is defined by the workflow's default version, but this is sometimes not the case with compound tasks.
If the default version of a workflow is not a compound task, then when the workflow is called as a compound task the system uses the most recent version of the workflow that is defined as a compound task. This can be confusing. The following example illustrates this behavior.
Step 1 | Save CTv0 as a normal (non-compound-task) workflow: |
Step 2 | In the Workflow Designer, validate WF. Validation fails with the message The task "Compound add user" does not exist anymore. |
Step 3 | Create a new
version of
CT (CTv1).
|
Step 4 | Validate WF again, as in Step 2. Validation fails with the message The task "Compound add user" does not exist anymore. |
Step 5 | Make CTv1 a compound task. |
Step 6 | Validate WF again. Validation is successful. |
Step 7 | Change the
default version of
CT back to
CTv0.
|
Step 8 | Validate WF again. Validation is successful. Note that WF is using CTv1 as the compound task, even though CTv0 is the default. Be aware that this can cause confusion if you have more than one version of a workflow that is used as a compound task. |
You can clone a workflow. The cloned workflow is identical to the original workflow. You can edit the new workflow immediately. You might do this, for example, to create a workflow that is similar to the original workflow but which has different inputs. The new workflow has a new, separate version history.
Navigate to Workflows tab.
and select theStep 1 | Select the workflow you want to clone. |
Step 2 | Click Clone. The Clone Workflow window comes up. |
Step 3 | Edit the workflow details, inputs, and outputs. See Creating a Workflow. You must enter a new name for the workflow. |
Step 4 | Click Next to proceed to the Workflow User Inputs screen. |
Step 5 | Edit the workflow user inputs. |
You can create a graphics image of a workflow. To capture an image, do the following:
Step 1 | On the menu bar, choose . |
Step 2 | Choose the Workflows tab. |
Step 3 | Choose a workflow. |
Step 4 | Click on Workflow Designer. |
Step 5 | From within the Workflow Designer window click the Full View icon. |
Step 6 | Click Export as Image. You are prompted to save the image file. |
Step 7 | Choose a directory (if applicable) and click Save. |
The saved file is named workflow_nnn.png, where nnn is the workflow ID number in Cisco UCS Director. The workflow ID number is visible in the upper left corner of the Workflow Designer next to the workflow name.