update auto generated docs

[pve-docs.git] / pveum.adoc

diff --git a/pveum.adoc b/pveum.adoc
index cca1ece134424c00f1da067c743acc29f1db8e13..14fff2563f0df0e9dd6b6a71e3b1a8708afec541 100644 (file)
--- a/pveum.adoc
+++ b/pveum.adoc
@@ -1,7 +1,9 @@
+[[chapter_user_management]]

 ifdef::manvolnum[]
 ifdef::manvolnum[]

-PVE({manvolnum})
-================
+pveum(1)
+========

 include::attributes.txt[]
 include::attributes.txt[]

+:pve-toplevel:

 
 NAME
 ----
 
 NAME
 ----


@@ -18,11 +20,11 @@ include::pveum.1-synopsis.adoc[]
 DESCRIPTION
 -----------
 endif::manvolnum[]
 DESCRIPTION
 -----------
 endif::manvolnum[]

-

 ifndef::manvolnum[]
 User Management
 ===============
 include::attributes.txt[]
 ifndef::manvolnum[]
 User Management
 ===============
 include::attributes.txt[]

+:pve-toplevel:

 endif::manvolnum[]
 
 // Copied from pve wiki: Revision as of 16:10, 27 October 2015
 endif::manvolnum[]
 
 // Copied from pve wiki: Revision as of 16:10, 27 October 2015


@@ -35,12 +37,13 @@ By using the role based user- and permission management for all
 objects (VMs, storages, nodes, etc.) granular access can be defined.
 
 
 objects (VMs, storages, nodes, etc.) granular access can be defined.
 
 

+[[pveum_users]]

 Users
 -----
 
 {pve} stores user attributes in `/etc/pve/user.cfg`.
 Passwords are not stored here, users are instead associated with
 Users
 -----
 
 {pve} stores user attributes in `/etc/pve/user.cfg`.
 Passwords are not stored here, users are instead associated with

-<<authentication-realms,authentication realms>> described below.
+<<pveum_authentication_realms,authentication realms>> described below.

 Therefore a user is internally often identified by its name and
 realm in the form `<userid>@<realm>`.
 
 Therefore a user is internally often identified by its name and
 realm in the form `<userid>@<realm>`.
 


@@ -65,6 +68,7 @@ still be changed and system mails will be sent to the email address
 assigned to this user.
 
 
 assigned to this user.
 
 

+[[pveum_groups]]

 Groups
 ~~~~~~
 
 Groups
 ~~~~~~
 


@@ -74,7 +78,7 @@ to groups instead of using individual users. That way you will get a
 much shorter access control list which is easier to handle.
 
 
 much shorter access control list which is easier to handle.
 
 

-[[authentication-realms]]
+[[pveum_authentication_realms]]

 Authentication Realms
 ---------------------
 
 Authentication Realms
 ---------------------
 


@@ -183,6 +187,7 @@ https://developers.yubico.com/Software_Projects/YubiKey_OTP/YubiCloud_Validation
 host your own verification server].
 
 
 host your own verification server].
 
 

+[[pveum_permission_management]]

 Permission Management
 ---------------------
 
 Permission Management
 ---------------------
 


@@ -198,6 +203,7 @@ role)', with the role containing a set of allowed actions, and the path
 representing the target of these actions.
 
 
 representing the target of these actions.
 
 

+[[pveum_roles]]

 Roles
 ~~~~~
 
 Roles
 ~~~~~
 


@@ -289,7 +295,7 @@ We use file system like paths to address these objects. These paths form a
 natural tree, and permissions of higher levels (shorter path) can
 optionally be propagated down within this hierarchy.
 
 natural tree, and permissions of higher levels (shorter path) can
 optionally be propagated down within this hierarchy.
 

-[[templated-paths]]
+[[pveum_templated_paths]]

 Paths can be templated. When an API call requires permissions on a
 templated path, the path may contain references to parameters of the API
 call. These references are specified in curly braces. Some parameters are
 Paths can be templated. When an API call requires permissions on a
 templated path, the path may contain references to parameters of the API
 call. These references are specified in curly braces. Some parameters are


@@ -304,7 +310,7 @@ Some examples are:
 * `/vms`: Covers all VMs
 * `/vms/{vmid}`: Access to specific VMs
 * `/storage/{storeid}`: Access to a storages
 * `/vms`: Covers all VMs
 * `/vms/{vmid}`: Access to specific VMs
 * `/storage/{storeid}`: Access to a storages

-* `/pool/{poolname}`: Access to VMs part of a <<resource-pools,pool>
+* `/pool/{poolname}`: Access to VMs part of a <<pveum_pools,pool>>

 * `/access/groups`: Group administration
 * `/access/realms/{realmid}`: Administrative access to realms
 
 * `/access/groups`: Group administration
 * `/access/realms/{realmid}`: Administrative access to realms
 


@@ -321,6 +327,7 @@ by default). We use the following inheritance rules:
 * Permissions replace the ones inherited from an upper level.
 
 
 * Permissions replace the ones inherited from an upper level.
 
 

+[[pveum_pools]]

 Pools
 ~~~~~
 
 Pools
 ~~~~~
 


@@ -343,8 +350,9 @@ tree of logic and access-check functions:
 Each(`and`) or any(`or`) further element in the current list has to be true.
 
 `["perm", <path>, [ <privileges>... ], <options>...]`::
 Each(`and`) or any(`or`) further element in the current list has to be true.
 
 `["perm", <path>, [ <privileges>... ], <options>...]`::

-The `path` is a templated parameter (see <<templated-paths,Objects and
-Paths>>). All (or , if the `any` option is used, any) of the listed
+The `path` is a templated parameter (see
+<<pveum_templated_paths,Objects and Paths>>). All (or , if the `any`
+option is used, any) of the listed

 privileges must be allowed on the specified path. If a `require-param`
 option is specified, then its specified parameter is required even if the
 API call's schema otherwise lists it as being optional.
 privileges must be allowed on the specified path. If a `require-param`
 option is specified, then its specified parameter is required even if the
 API call's schema otherwise lists it as being optional.


@@ -375,8 +383,9 @@ associated with a realm, since user IDs are passed in the form of
 `<username>@<realm>`.
 
 `["perm-modify", <path>]`::
 `<username>@<realm>`.
 
 `["perm-modify", <path>]`::

-The `path` is a templated parameter (see <<templated-paths,Objects and
-Paths>>). The user needs either the `Permissions.Modify` privilege, or,
+The `path` is a templated parameter (see
+<<pveum_templated_paths,Objects and Paths>>). The user needs either the
+`Permissions.Modify` privilege, or,

 depending on the path, the following privileges as a possible substitute:
 +
 * `/storage/...`: additionally requires 'Datastore.Allocate`
 depending on the path, the following privileges as a possible substitute:
 +
 * `/storage/...`: additionally requires 'Datastore.Allocate`