From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: reorganize existing documentation according to the new standard layout Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann --- doc/source/cli/command-objects/role.rst | 326 ++++++++++++++++++++++++++++++++ 1 file changed, 326 insertions(+) create mode 100644 doc/source/cli/command-objects/role.rst (limited to 'doc/source/cli/command-objects/role.rst') diff --git a/doc/source/cli/command-objects/role.rst b/doc/source/cli/command-objects/role.rst new file mode 100644 index 00000000..fe3126c0 --- /dev/null +++ b/doc/source/cli/command-objects/role.rst @@ -0,0 +1,326 @@ +==== +role +==== + +Identity v2, v3 + +role add +-------- + +Add role assignment to a user or group in a project or domain + +.. program:: role add +.. code:: bash + + openstack role add + --domain | --project [--project-domain ] + --user [--user-domain ] | --group [--group-domain ] + --role-domain + --inherited + + +.. option:: --domain + + Include (name or ID) + + .. versionadded:: 3 + +.. option:: --project + + Include (name or ID) + +.. option:: --user + + Include (name or ID) + +.. option:: --group + + Include (name or ID) + + .. versionadded:: 3 + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + + .. versionadded:: 3 + +.. option:: --group-domain + + Domain the group belongs to (name or ID). + This can be used in case collisions between group names exist. + + .. versionadded:: 3 + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + .. versionadded:: 3 + +.. option:: --inherited + + Specifies if the role grant is inheritable to the sub projects. + + .. versionadded:: 3 + +.. option:: --role-domain + + Domain the role belongs to (name or ID). + This must be specified when the name of a domain specific role is used. + + .. versionadded:: 3 + +.. describe:: + + Role to add to : (name or ID) + +role create +----------- + +Create new role + +.. program:: role create +.. code:: bash + + openstack role create + [--or-show] + [--domain ] + + +.. option:: --domain + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + +.. option:: --or-show + + Return existing role + + If the role already exists return the existing role data and do not fail. + +.. describe:: + + New role name + +role delete +----------- + +Delete role(s) + +.. program:: role delete +.. code:: bash + + openstack role delete + [ ...] + [--domain ] + +.. describe:: + + Role to delete (name or ID) + +.. option:: --domain + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + +role list +--------- + +List roles + +.. program:: role list +.. code:: bash + + openstack role list + --domain | --project [--project-domain ] + --user [--user-domain ] | --group [--group-domain ] + --inherited + +.. option:: --domain + + Filter roles by (name or ID) + + (Deprecated if being used to list assignments in conjunction with the + ``--user ``, option, please use ``role assignment list`` instead) + +.. option:: --project + + Filter roles by (name or ID) + + (Deprecated, please use ``role assignment list`` instead) + +.. option:: --user + + Filter roles by (name or ID) + + (Deprecated, please use ``role assignment list`` instead) + +.. option:: --group + + Filter roles by (name or ID) + + (Deprecated, please use ``role assignment list`` instead) + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + + (Deprecated, please use ``role assignment list`` instead) + + .. versionadded:: 3 + +.. option:: --group-domain + + Domain the group belongs to (name or ID). + This can be used in case collisions between group names exist. + + (Deprecated, please use ``role assignment list`` instead) + + .. versionadded:: 3 + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + (Deprecated, please use ``role assignment list`` instead) + + .. versionadded:: 3 + +.. option:: --inherited + + Specifies if the role grant is inheritable to the sub projects. + + (Deprecated, please use ``role assignment list`` instead) + + .. versionadded:: 3 + +role remove +----------- + +Remove role assignment from domain/project : user/group + +.. program:: role remove +.. code:: bash + + openstack role remove + --domain | --project [--project-domain ] + --user [--user-domain ] | --group [--group-domain ] + --role-domain + --inherited + + +.. option:: --domain + + Include (name or ID) + + .. versionadded:: 3 + +.. option:: --project + + Include (name or ID) + +.. option:: --user + + Include (name or ID) + +.. option:: --group + + Include (name or ID) + + .. versionadded:: 3 + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + + .. versionadded:: 3 + +.. option:: --group-domain + + Domain the group belongs to (name or ID). + This can be used in case collisions between group names exist. + + .. versionadded:: 3 + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + .. versionadded:: 3 + +.. option:: --inherited + + Specifies if the role grant is inheritable to the sub projects. + + .. versionadded:: 3 + +.. option:: --role-domain + + Domain the role belongs to (name or ID). + This must be specified when the name of a domain specific role is used. + + .. versionadded:: 3 + +.. describe:: + + Role to remove (name or ID) + +role set +-------- + +Set role properties + +.. versionadded:: 3 + +.. program:: role set +.. code:: bash + + openstack role set + [--name ] + [--domain ] + + +.. option:: --name + + Set role name + +.. option:: --domain + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + +.. describe:: + + Role to modify (name or ID) + +role show +--------- + +Display role details + +.. program:: role show +.. code:: bash + + openstack role show + [--domain ] + + +.. option:: --domain + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + +.. describe:: + + Role to display (name or ID) -- cgit v1.2.1