From 0931fcf0a5b745583a73341fb76bb4c28f68836a Mon Sep 17 00:00:00 2001
From: OlgaGusarenko <ogusarenko@mirantis.com>
Date: Tue, 15 Nov 2016 12:59:37 +0200
Subject: [PATCH] [UG] Add filters to the 'fuel2 task list' command

Change-Id: Idab2a7912af7d28f5b79a1aaab4d60f658511fe0
Closes-Bug: #1640224
---
 .../download-deployment-info.rst              |  2 ++
 .../workflows-manage/view-history.rst         |  2 ++
 .../notes/fuel2-task-list-filters.rst         | 25 +++++++++++++++++++
 3 files changed, 29 insertions(+)
 create mode 100644 userdocs/snippets/notes/fuel2-task-list-filters.rst

diff --git a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-deployment-info.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-deployment-info.rst
index 724a41fb3..83b1b62e9 100644
--- a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-deployment-info.rst
+++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-deployment-info.rst
@@ -19,6 +19,8 @@ deployment.
      fuel task
      fuel2 task list
 
+   .. include:: /userdocs/snippets/notes/fuel2-task-list-filters.rst
+
 #. Download the deployment information:
 
    .. code-block:: console
diff --git a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst
index 5bd3cd1bb..85dde8f2e 100644
--- a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst
+++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst
@@ -35,6 +35,8 @@ the Fuel web UI (timeline or table view mode) as well as the Fuel CLI.
       fuel task
       fuel2 task list
 
+   .. include:: /userdocs/snippets/notes/fuel2-task-list-filters.rst
+
 #. Get the information on deployment tasks running on nodes:
 
    .. code-block:: console
diff --git a/userdocs/snippets/notes/fuel2-task-list-filters.rst b/userdocs/snippets/notes/fuel2-task-list-filters.rst
new file mode 100644
index 000000000..e3f2ae796
--- /dev/null
+++ b/userdocs/snippets/notes/fuel2-task-list-filters.rst
@@ -0,0 +1,25 @@
+.. note::
+
+   By default, the :command:`fuel2 task list` shows all deployment tasks.
+   Although, you can filter the tasks in the command output by:
+
+   * Environment ID:
+
+     .. code-block:: console
+
+        fuel2 task list --env <ENV_ID>
+
+   * Tasks statuses:
+
+     .. code-block:: console
+
+        fuel2 task list --statuses ready
+
+     The available tasks statuses are ``pending``, ``error``,
+     ``ready``, and ``running``.
+
+   * Tasks names:
+
+     .. code-block:: console
+
+        fuel2 task list --names <TASK_NAME>
\ No newline at end of file