ViPR 2.2 - Track Workflow and Asynchronous Operations in the ViPR UI with Tasks

Table of Contents

Overview

A number of ViPR operations and services are processed asynchronously. Asynchronous operations return a task (or list of tasks).

Each task represents a block of work performed by the controller engine. These tasks can be followed to check if the operation has succeeded, failed or is in progress, and can be followed using both the UI and the REST API (see Track Status of Asynchronous Operations with Tasks Using the REST API).

There are two types of tasks:
  • Tenant tasks, such as adding a host.
    • Any user that is a member of the tenant can view the tasks that are related to that tenant.
    • Any user that is a member of the tenant can view the details of the tasks related to that tenant.
  • System tasks that are not associated with any tenant, such as adding a storage array.
    • Only a system administrator can view system tasks.
    • Only system administrators and security administrators can view the details of a system task.

By default, tasks last for seven days from the date of completion. But this value can be changed in task configuration options. In addition, when you delete a resource the tasks that are associated with the resource are still available for viewing.

Back to Top

View tasks and workflow in the UI

The UI allows you to view tenant and system tasks. However, only system administrators and security administrators can view the details of the task.

There are two different means to view the tasks:
  • Task popup
  • Tasks screen displayed using Resources > Tasks
Back to Top

Task popup

The Task popup is available on all ViPR UI screens and displays the last five tasks for your tenant or system (if you are a system administrator) that have run during the last twelve hours.

You display the Task popup by clicking the icon that shows the count of running tasks in the top bar of the UI. In the figure below, the icon shows 0 running tasks, as all tasks have completed.
Note Image
If you see a double dash (--) as the number of tasks, when doing a screen refresh or navigating to another screen, it indicates that ViPR is recalculating the number of running tasks.

Task popup example

The Task popup has two tabs that can be displayed; one for tenant-level tasks and one for system tasks. The Tenant Tasks tab is displayed for all users. However, the System Tasks tab is only displayed for system administrators and security administrators.

The elasped time to complete the task is shown for each task. A status bar is also displayed for each task that shows the percentage complete for the task:
  • Blue = task completed successfully
  • Red = task completed with errors

Selecting View All Tasks displays the Tasks screen that provides access to the last 1000 tasks.

If you are a system administrator or security administrator, you can view the details of the task by selecting the task in the list.

Back to Top

Tasks screen

Resources > Tasks opens the Tasks screen. The last 1000 tenant and system tasks are displayed.

The Tasks screen has two tabs, Tenant and System, which display the corresponding types of tasks. Each tab includes the total number of tasks in ViPR for that task type, as well as a count of the number of tasks that are pending, that completed but with an error, and that successfully completed.

There may be more than 1000 tenant or system tasks in ViPR, but the UI shows only the last 1000 tasks for each type which means you may not see all of the tasks you are searching for. For example, you search for tenant tasks in the pending state and while the count of pending tasks shows 14, you only see 6 because the other 8 tasks are older than the 1000 tenant tasks shown in the Tasks screen. However, the ViPR REST API can be used to retrieve all of the tasks. See Track Status of Asynchronous Operations with Tasks Using the REST API.

Resources > Tasks Screen

For each task, the following information is displayed:
  • The name of the operation which created the task.
  • The name of the resource for which the task was created. Clicking the resource name displays the screen to edit the resource.
  • A progress bar that shows the percentage complete, and is color coded:
    • Green = task completed successfully
    • Red = task encountered an error
  • The state of the task
  • How long ago the tasks was started
  • The elapsed time to complete the task.

If you are a system administrator or security administrator, you can view the details of the task by selecting the task in the list.

Back to Top

Task details

Selecting one of the tasks in the Tasks screen or the Task popup displays a screen showing the details of the selected task. Only system administrators and security administrators can view the details of a system task. But any user that is a member of a tenant can view the details of tasks associated with that tenant.

The task details include the following task properties:
  • ID: ID of the task.
  • Operation ID: ID of the operation that created the task.
  • Name: The name of the operation that created the task
  • Resource: The resource for which the task was created.
  • State: The state of the task: Completed if the task completed successfully or Error if the task completed but with an error.
  • Description: The description of the operation that created the task.
  • Start, End, and Elapsed: The start and end times of the tasks, as well as the elapsed time for the task.
In addition, if the task completed with an error, the error number and message are included.

For tasks that are created by ordering a service from the service catalog, there is also a link to the order.

Details of a task that completed with an error

The task details also display the workflow steps (if applicable, such as when ordering a service from the service catalog) and the logs associated with each step of the task.

Back to Top

Change task-related configuration settings

Selecting the Other tab from Settings > Configuration allows you to change the task-related configuration settings.

There are two settings that you can change.

Back to Top