summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2015-08-06 22:15:42 -0700
committerSteve Martinelli <stevemar@ca.ibm.com>2015-08-07 10:03:00 -0700
commit51ae8c78b913a72826f8409e84155148986b7b09 (patch)
treec0c438bc465cdd621e41610500252775b2917504 /doc/source/command-objects
parent366d72d87e9ea849e33628ec7b7187520630338f (diff)
downloadpython-openstackclient-51ae8c78b913a72826f8409e84155148986b7b09.tar.gz
Add --inherited to the role docs
commit Id72670be8640e5c6e2490a6ef849e9ec3493b1a9 forgot to update the docs for role.rst. Change-Id: I97c426ea9b290fc266b34cb0bf97de56cfd098de
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/role.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst
index d26932b1..9ba149ec 100644
--- a/doc/source/command-objects/role.rst
+++ b/doc/source/command-objects/role.rst
@@ -15,6 +15,7 @@ Add role to a user or group in a project or domain
os role add
--domain <domain> | --project <project> [--project-domain <project-domain>]
--user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
+ --inherited
<role>
.. option:: --domain <domain>
@@ -58,6 +59,12 @@ Add role to a user or group in a project or domain
.. versionadded:: 3
+.. option:: --inherited
+
+ Specifies if the role grant is inheritable to the sub projects.
+
+ .. versionadded:: 3
+
.. describe:: <role>
Role to add to `<project>`:`<user>` (name or ID)
@@ -110,6 +117,7 @@ List roles
os role list
--domain <domain> | --project <project> [--project-domain <project-domain>]
--user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
+ --inherited
.. option:: --domain <domain>
@@ -156,6 +164,12 @@ List roles
.. versionadded:: 3
+.. option:: --inherited
+
+ Specifies if the role grant is inheritable to the sub projects.
+
+ .. versionadded:: 3
+
role remove
-----------
@@ -167,6 +181,7 @@ Remove role from domain/project : user/group
os role remove
--domain <domain> | --project <project> [--project-domain <project-domain>]
--user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
+ --inherited
<role>
.. option:: --domain <domain>
@@ -210,6 +225,12 @@ Remove role from domain/project : user/group
.. versionadded:: 3
+.. option:: --inherited
+
+ Specifies if the role grant is inheritable to the sub projects.
+
+ .. versionadded:: 3
+
.. describe:: <role>
Role to remove (name or ID)