=============
sampo_ps list
=============

.. contents:: Contents
    :local:

Overview
========

.. warning::

   sampo_ps list command is deprecated.

**sampo_ps list** is used to view a list of processes stored in a ProcessStore.
The result is output to stdout.

|

Synopsis
========
See sampo_ps command help::

    $ sampo_ps list --help

|

Examples
========
You can choose the display format, whose details are displayed either per process or per component.

* Listing of details per process.

 * Command::

   $ sampo_ps list -s file:///var/process_store_storage -a -m process

 * Output::

     +--------------+--------------------------------------+---------------------+--------------+-------------+
     | process name | version                              | started at          | running time | status      |
     +--------------+--------------------------------------+---------------------+--------------+-------------+
     | learn1       | c8206325-a02b-4ed7-a565-88aeaf173b0c | 2013-09-30 18:47:59 | 0:00:00.066  | Succeeded   |
     | learn1       | 2d418854-1178-4c73-83c4-1b2568a7ce90 | 2013-09-30 18:47:59 | 0:00:00.067  | Succeeded   |
     | learn1       | a165df99-ce9c-43f6-81a0-d612d4ce36a0 | 2013-09-30 18:47:58 | 0:00:00.166  | Succeeded   |
     | learn1       | 5c2dde2f-cc82-4533-a80a-63fb84391cbf | 2013-09-30 18:47:58 | 0:00:00.167  | Succeeded   |
     | learn1       | f1b8c415-8db5-419e-9abe-eadb15e73e2c | 2013-09-30 18:47:57 | 0:00:00.180  | Succeeded   |
     | learn1       | eea83494-b880-4979-b7f0-eec4ffa5a1e7 | 2013-09-30 18:47:57 | 0:00:00.196  | Succeeded   |
     | learn1       | c0af7df7-a7ce-46ca-b481-974d8eb2d2fe | 2013-09-30 18:47:57 | 0:00:00.180  | Succeeded   |
     | learn1       | 89e9c30a-9c7f-4271-aef2-e4ffbaf33f5d | 2013-09-30 18:47:57 | 0:00:00.158  | Succeeded   |
     | learn2       | b387981a-36a8-4ad3-9e07-c39200416f65 | 2013-09-30 18:47:56 |              | In progress |
     +--------------+--------------------------------------+---------------------+--------------+-------------+

 * Columns:

  +---------------+-------------------------------------------------------------+
  |Column         | Description                                                 |
  +===============+=============================================================+
  |process name   | Name of the process.                                        |
  +---------------+-------------------------------------------------------------+
  |version        | Version of the process.                                     |
  +---------------+-------------------------------------------------------------+
  |started at     | Data and time that the process started.                     |
  +---------------+-------------------------------------------------------------+
  |running time   | | Time that the process has taken to run.                   |
  |               | | If the status is **In progress**, this column is blank.   |
  +---------------+-------------------------------------------------------------+
  |status         | | There are three statuses:                                 |
  |               | |   **Succeeded**   : Process has finished successfully.    |
  |               | |   **Failed**      : Process has failed and finished.      |
  |               | |   **In progress** : Process is in execution.              |
  +---------------+-------------------------------------------------------------+

|

* Listing of details per component.

 * Command::

   $ sampo_ps list -s file:///var/process_store_storage -m component

 * Output::

     +--------------+--------------------------------------+--------------+---------------------+--------------+
     | process name | version                              | component id | started_at          | running time |
     +--------------+--------------------------------------+--------------+---------------------+--------------+
     | learn1       | c8206325-a02b-4ed7-a565-88aeaf173b0c | dl           | 2013-09-30 18:47:59 | 0:00:00.066  |
     | learn1       | 2d418854-1178-4c73-83c4-1b2568a7ce90 | fabreg       | 2013-09-30 18:47:59 | 0:00:00.067  |
     +--------------+--------------------------------------+--------------+---------------------+--------------+

 * Columns:

  +---------------+-----------------------------------------------------------+
  |Column         | Description                                               |
  +===============+===========================================================+
  |process name   | Name of the process that the component belongs to.        |
  +---------------+-----------------------------------------------------------+
  |version        | Version of the process that the component belongs to.     |
  +---------------+-----------------------------------------------------------+
  |component id   | Component ID of the component.                            |
  +---------------+-----------------------------------------------------------+
  |started at     | Data and time that the component started.                 |
  +---------------+-----------------------------------------------------------+
  |running time   | | Time that the component has taken to run.               |
  |               | | If the status is **In progress**, this column is blank. |
  +---------------+-----------------------------------------------------------+
