## Actions

updated: 2020-10-17 18:54

# Actions

## Concept

An Action is an operation that can be performed on a Cluster or a Node. Each action is executed asynchronously by a worker thread after being created. Most Senlin APIs are executed asynchronously inside the Senlin engine except for some object retrieval or object listing APIs.

Different types of objects support different sets of actions. For example, a cluster object supports the following actions:

- `CREATE`: creates a cluster;

- `DELETE`: deletes a cluster;

- `UPDATE`: update the properties and/or the profile used by a cluster;

- `ADD_NODES`: add existing nodes to a cluster;

- `DEL_NODES`: remove nodes from a cluster;

- `ATTACH_POLICY`: attach the specified policy to a cluster;

- `DETACH_POLICY`: detach the specified policy from a cluster;

- `UPDATE_POLICY`: update the specified policy on a cluster;

- `SCALE_IN`: shrink the size of a cluster;

- `SCALE_OUT`: inflate the size of a cluster;

- `RESIZE`: resize a cluster;

- `CHECK`: check a cluster;

- `RECOVER`: recover a cluster;

- `REPLACE_NODES`: replace the nodes in cluster with specified nodes;

- `OPERATION`: perform an operation on the specified cluster;

A node object supports the following actions:

- `CREATE`: creates a node;

- `DELETE`: deletes a node;

- `UPDATE`: updates the properties and/or the profile used by a node;

- `CHECK`: check a node;

- `RECOVER`: recover a node;

- `OPERATION`: perform an operation on the specified node;

In future, Senlin may support user defined actions (UDAs).

## Listing Actions

The following command shows the actions known by the Senlin engine:

    $ openstack cluster action list
    +----------+-------------------------+----------------+-----------+----------+------------+-------------+----------------------+
    | id       | name                    | action         | status    | target_id| depends_on | depended_by | created_at           |
    +----------+-------------------------+----------------+-----------+----------+------------+-------------+----------------------+
    | 1189f5e8 | node_create_b825fb74    | NODE_CREATE    | SUCCEEDED | b825fb74 |            |             | 2016-09-22T10:13:24Z |
    | 2454c28a | node_delete_c035c519    | NODE_DELETE    | SUCCEEDED | c035c519 |            |             | 2016-09-22T10:53:09Z |
    | 252b9491 | node_create_c035c519    | NODE_CREATE    | SUCCEEDED | c035c519 |            |             | 2016-09-22T10:54:09Z |
    | 34802f3b | cluster_create_7f37e191 | CLUSTER_CREATE | SUCCEEDED | 7f37e191 |            |             | 2016-09-22T11:04:00Z |
    | 4250bf29 | cluster_delete_7f37e191 | CLUSTER_DELETE | SUCCEEDED | 7f37e191 |            |             | 2016-09-22T11:06:32Z |
    | 67cbcfb5 | node_delete_b825fb74    | NODE_DELETE    | SUCCEEDED | b825fb74 |            |             | 2016-09-22T11:14:04Z |
    | 6e661db8 | cluster_create_44762dab | CLUSTER_CREATE | SUCCEEDED | 44762dab |            |             | 2016-09-22T11:14:44Z |
    | 7bfad7ed | node_delete_b716052d    | NODE_DELETE    | SUCCEEDED | b716052d |            |             | 2016-09-22T11:15:22Z |
    | b299cf44 | cluster_delete_44762dab | CLUSTER_DELETE | SUCCEEDED | 44762dab |            |             | 2016-09-22T11:18:18Z |
    | e973552e | node_create_b716052d    | NODE_CREATE    | SUCCEEDED | b716052d |            |             | 2016-09-22T11:25:58Z |
    +----------+-------------------------+----------------+-----------+----------+------------+-------------+----------------------+

The openstack cluster command line supports various options when listing the actions.

### Sorting the List

You can specify the sorting keys and sorting direction when list actions, using the option `--sort`. The `--sort` option accepts a string of format `key1[:dir1],key2[:dir2],key3[:dir3]`, where the keys used are action properties and the dirs can be one of `asc` and `desc`. When omitted, Senlin sorts a given key using `asc` as the default direction.

For example, the following command instructs the openstack cluster command to sort actions using the `name` property in descending order:

    $ openstack cluster action list --sort name:desc

When sorting the list of actions, you can use one of `name`, `target`, `action`, `created_at` and `status`.

### Filtering the List

You can filter the list of actions using the `--filters``. For example, the following command filters the action list by the `action` property:

    $ openstack cluster action list --filters action=CLUSTER_SCALE_OUT

The option `--filters` accepts a list of key-value pairs separated by semicolon (`;`), where each pair is expected to be of format `key=val`. The valid keys for filtering include `name`, `target`, `action` and `status` or any combination of them.

### Paginating the Query results

In case you have a huge collection of actions (which is highly likely the case), you can limit the number of actions returned using the option `--limit`. For example:

    $ openstack cluster action list --limit 1

Another option you can specify is the ID of an action after which you want to see the returned list starts. In other words, you don’t want to see those actions with IDs that is or come before the one you specify. You can use the option `--marker` for this purpose. For example:

    $ openstack cluster action list --limit 1 \
        --marker 2959122e-11c7-4e82-b12f-f49dc5dac270

Only 1 action record is returned in this example and its UUID comes after the one specified from the command line.

## Showing Details of an Action

You can use the openstack cluster command to show the details about an action you are interested in. When specifying the identity of the action, you can use its name, its ID or its “short ID” . Senlin API and engine will verify if the identifier you specified can uniquely identify an action. An error message will be returned if there is no action matching the identifier or if more than one action matching it.

An example is shown below:

    $ openstack cluster action show 8fac487f
    +---------------+--------------------------------------+
    | Field         | Value                                |
    +---------------+--------------------------------------+
    | action        | CLUSTER_DELETE                       |
    | cause         | RPC Request                          |
    | created_at    | 2016-09-23T09:00:25Z                 |
    | depended_by   |                                      |
    | depends_on    |                                      |
    | domain_id     | None                                 |
    | end_at        | 1450683904.0                         |
    | id            | 8fac487f-861a-449e-9678-478133bea8de |
    | inputs        | {}                                   |
    | interval      | -1                                   |
    | location      | None                                 |
    | name          | cluster_delete_7deb546f              |
    | outputs       | {}                                   |
    | owner_id      | None                                 |
    | project_id    | bdeecc1b58004bb19302da77ac056b44     |
    | start_at      | 1450683904.0                         |
    | status        | SUCCEEDED                            |
    | status_reason | Action completed successfully.       |
    | target_id     | 7deb546f-fd1f-499a-b120-94f8f07fadfb |
    | timeout       | 3600                                 |
    | updated_at    | None                                 |
    | user_id       | f3cdb8010bb349d5bdff2815d8f007a1     |
    +---------------+--------------------------------------+

## See Also

- Creating Receivers

- Browsing Events

updated: 2020-10-17 18:54

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

questions?