doc/web/source/howto/manage_relocated_users.rst
author Pascal Volk <user@localhost.localdomain.org>
Sun, 09 Mar 2014 18:42:58 +0000
changeset 739 b65c3abf9ca8
parent 591 2b165e90e225
permissions -rw-r--r--
doc/web: dovecot_configuration: corrected 'user_query`.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     1
========================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     2
Managing relocated users
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     3
========================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     4
relocatedadd
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     5
------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     6
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     7
 | **vmm relocatedadd** *address newaddress*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     8
 | **vmm ra** *address newaddress*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     9
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    10
A new relocated user can be created with this subcommand.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    11
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    12
*address* is the user's ex-email address, for example b.user\@example.com,
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    13
and *newaddress* points to the new email address where the user can be
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    14
reached.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    15
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    16
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    17
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    18
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    19
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    20
 root@host:~# vmm relocatedadd b.user@example.com b-user@company.tld
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    21
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    22
relocateddelete
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    23
---------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    24
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    25
 | **vmm relocateddelete** *address*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    26
 | **vmm rd** *address*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    27
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    28
Use this subcommand in order to delete the relocated user with the given
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    29
*address*.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    30
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    31
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    32
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    33
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    34
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    35
 root@host:~# vmm relocateddelete b.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    36
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    37
relocatedinfo
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    38
-------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    39
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    40
 | **vmm relocatedinfo** *address*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    41
 | **vmm ri** *address*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    42
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    43
This subcommand shows the new address of the relocated user with the given
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    44
*address*.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    45
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    46
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    47
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    48
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    49
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    50
 root@host:~# vmm relocatedinfo b.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    51
 Relocated information
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    52
 ---------------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    53
         User 'b.user@example.com' has moved to 'b-user@company.tld'