From 5bbcddba87c06dabb1ee6ece9bddd1c488349f83 Mon Sep 17 00:00:00 2001 From: liyi Date: Fri, 7 Jul 2017 16:21:18 +0800 Subject: [PATCH] Add profile list filter description in doc The command 'openstack cluster profile list' support '--filter' option, but not descibed in documentation. Change-Id: Id7996ae00ede01458c4a5e5d46f12b3d3cfacf09 --- doc/source/user/profiles.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/source/user/profiles.rst b/doc/source/user/profiles.rst index ba616961b..616008733 100644 --- a/doc/source/user/profiles.rst +++ b/doc/source/user/profiles.rst @@ -81,6 +81,28 @@ When sorting the list of profiles, you can use one of ``type``, ``name``, ``created_at`` and ``updated_at``. +Filtering the List +------------------ + +The :program:`openstack cluster profile list` command also provides options +for filtering the profile list at the server side. The option +:option:`--filters` can be used for this purpose. For example, the following +command filters the profile by the ``type`` field:: + + $ openstack cluster profile list --filter "type=os.heat.stack-1.0" + +----------+----------+--------------------+---------------------+ + | id | name | type | created_at | + +----------+----------+--------------------+---------------------+ + | ceda64bd | mystack | os.heat.stack-1.0 | 2015-05-05T13:26:25 | + | 9b127538 | pstack | os.heat.stack-1.0 | 2015-06-25T12:59:01 | + +----------+----------+--------------------+---------------------+ + +The option :option:`--filters` accepts a list of key-value pairs separated +by semicolon (``;``), where each key-value pair is expected to be of format +``=``. The valid keys for filtering include: ``name`` and +``type``. + + Paginating the List -------------------