doc/web/source/howto/manage_domains.rst
branchv0.7.x
changeset 682 697350dd9369
parent 591 2b165e90e225
child 687 5eb033796444
equal deleted inserted replaced
681:4cab983479db 682:697350dd9369
     4 .. _domainadd:
     4 .. _domainadd:
     5 
     5 
     6 domainadd
     6 domainadd
     7 ---------
     7 ---------
     8 Syntax:
     8 Syntax:
     9  | **vmm domainadd** *fqdn* [*transport*]
     9  | **vmm domainadd** *fqdn* [**-t** *transport*]
    10  | **vmm da** *fqdn* [*transport*]
    10  | **vmm da** *fqdn* [**-t** *transport*]
    11  
    11  
    12 Adds the new domain into the database and creates the domain directory.
    12 Adds the new domain into the database and creates the domain directory.
    13 
    13 
    14 If the optional argument transport is given, it will override the default
    14 If the optional argument transport is given, it will override the default
    15 transport (*domain.transport*) from :file:`vmm.cfg`.
    15 transport (*domain.transport*) from :file:`vmm.cfg`.
    30 
    30 
    31 Example:
    31 Example:
    32 
    32 
    33 .. code-block:: console
    33 .. code-block:: console
    34 
    34 
    35  root@host:~# vmm domainadd support.example.com smtp:[mx1.example.com]:2025
    35  root@host:~# vmm domainadd support.example.com -t smtp:[mx1.example.com]:2025
    36  Creating account for postmaster@support.example.com
    36  Creating account for postmaster@support.example.com
    37  Enter new password: 
    37  Enter new password: 
    38  Retype new password: 
    38  Retype new password: 
    39  root@host:~# vmm cs account.random_password true
    39  root@host:~# vmm cs account.random_password true
    40  root@host:~# vmm da sales.example.com
    40  root@host:~# vmm da sales.example.com
    42  Generated password: pLJUQ6Xg_z
    42  Generated password: pLJUQ6Xg_z
    43 
    43 
    44 domaindelete
    44 domaindelete
    45 ------------
    45 ------------
    46 Syntax:
    46 Syntax:
    47  | **vmm domaindelete** *fqdn* [**force**]
    47  | **vmm domaindelete** *fqdn* [**‒‒force**]
    48  | **vmm dd** *fqdn* [**force**]
    48  | **vmm dd** *fqdn* [**‒‒force**]
    49 
    49 
    50 This subcommand deletes the domain specified by *fqdn*.
    50 This subcommand deletes the domain specified by *fqdn*.
    51 
    51 
    52 If there are accounts, aliases and/or relocated users assigned to the given
    52 If there are accounts, aliases and/or relocated users assigned to the given
    53 domain, :command:`vmm` will abort the requested operation and show an error
    53 domain, :command:`vmm` will abort the requested operation and show an error
    54 message.
    54 message.
    55 If you know, what you are doing, you can specify the optional keyword
    55 If you know, what you are doing, you can specify the optional argument
    56 **force**.
    56 **‒‒force**.
    57 
    57 
    58 If you really always know what you are doing, edit your :file:`vmm.cfg` and
    58 If you really always know what you are doing, edit your :file:`vmm.cfg` and
    59 set the option *domain.force_deletion* to **true**.
    59 set the option *domain.force_deletion* to **true**.
    60 
    60 
    61 domaininfo
    61 domaininfo
    62 ----------
    62 ----------
    63 Syntax:
    63 Syntax:
    64  | **vmm domaininfo** *fqdn* [*details*]
    64  | **vmm domaininfo** *fqdn* [**-d** *details*]
    65  | **vmm di** *fqdn* [*details*]
    65  | **vmm di** *fqdn* [**-d** *details*]
    66 
    66 
    67 This subcommand shows some information about the given domain.
    67 This subcommand shows some information about the given domain.
    68 
    68 
    69 For a more detailed information about the domain the optional argument
    69 For a more detailed information about the domain the optional argument
    70 *details* can be specified.
    70 *details* can be specified.
   101          Catch-All Dests..: 0
   101          Catch-All Dests..: 0
   102 
   102 
   103 domainnote
   103 domainnote
   104 ----------
   104 ----------
   105 Syntax:
   105 Syntax:
   106  | **vmm domainnote** *fqdn* [*note*]
   106  | **vmm domainnote** *fqdn* [**-n** *note*]
   107  | **vmm do** *fqdn* [*note*]
   107  | **vmm do** *fqdn* [**-n** *note*]
   108 
   108 
   109 With this subcommand, it is possible to attach a note to the specified
   109 With this subcommand, it is possible to attach a note to the specified
   110 domain.
   110 domain.
   111 Without an argument, an existing note is removed.
   111 Without an argument, an existing note is removed.
   112 
   112 
   113 Example:
   113 Example:
   114 
   114 
   115 .. code-block:: console
   115 .. code-block:: console
   116 
   116 
   117  root@host:~# vmm do example.com Belongs to Robert
   117  root@host:~# vmm do example.com -n 'Belongs to Robert'
   118 
   118 
   119 .. versionadded:: 0.6.0
   119 .. versionadded:: 0.6.0
   120 
   120 
   121 domainquota
   121 domainquota
   122 -----------
   122 -----------
   123 Syntax:
   123 Syntax:
   124  | **vmm domainquota** *fqdn storage* [*messages*] [**force**]
   124  | **vmm domainquota** *fqdn storage* [**-m** *messages*] [**‒‒force**]
   125  | **vmm dq** *fqdn storage* [*messages*] [**force**]
   125  | **vmm dq** *fqdn storage* [**-m** *messages*] [**‒‒force**]
   126 
   126 
   127 This subcommand is used to configure a new quota limit for the accounts
   127 This subcommand is used to configure a new quota limit for the accounts
   128 of the domain - not for the domain itself.
   128 of the domain - not for the domain itself.
   129 
   129 
   130 The default quota limit for accounts is defined in the :file:`vmm.cfg`
   130 The default quota limit for accounts is defined in the :file:`vmm.cfg`
   131 (*domain.quota_bytes* and *domain.quota_messages*).
   131 (*domain.quota_bytes* and *domain.quota_messages*).
   132 
   132 
   133 The new quota limit will affect only those accounts for which the limit has
   133 The new quota limit will affect only those accounts for which the limit has
   134 not been overridden.
   134 not been overridden.
   135 If you want to restore the default to all accounts, you may pass the keyword
   135 If you want to restore the default to all accounts, you may pass the optional
   136 **force**.
   136 argument **‒‒force**.
   137 When the argument *messages* was omitted the default number of messages
   137 When the argument *messages* was omitted the default number of messages
   138 **0** (zero) will be applied.
   138 **0** (zero) will be applied.
   139 
   139 
   140 Example:
   140 Example:
   141 
   141 
   142 .. code-block:: console
   142 .. code-block:: console
   143 
   143 
   144  root@host:~# vmm domainquota example.com 1g force
   144  root@host:~# vmm domainquota example.com 1g ‒‒force
   145 
   145 
   146 .. versionadded:: 0.6.0
   146 .. versionadded:: 0.6.0
   147 
   147 
   148 domainservices
   148 domainservices
   149 --------------
   149 --------------
   150 Syntax:
   150 Syntax:
   151  | **vmm domainservices** *fqdn* [*service ...*] [**force**]
   151  | **vmm domainservices** *fqdn* [**-s** *service ...*] [**‒‒force**]
   152  | **vmm ds** *fqdn* [*service ...*] [**force**]
   152  | **vmm ds** *fqdn* [**-s** *service ...*] [**‒‒force**]
   153 
   153 
   154 To define which services could be used by the users of the domain — with
   154 To define which services could be used by the users of the domain — with
   155 the given *fqdn* — use this subcommand.
   155 the given *fqdn* — use this subcommand.
   156 
   156 
   157 Each specified *service* will be enabled/usable.
   157 Each specified *service* will be enabled/usable.
   158 All other services will be deactivated/unusable.
   158 All other services will be deactivated/unusable.
   159 Possible service names are: **imap**, **pop3**, **sieve** and **smtp**.
   159 Possible service names are: **imap**, **pop3**, **sieve** and **smtp**.
   160 The new service set will affect only those accounts for which the set has
   160 The new service set will affect only those accounts for which the set has
   161 not been overridden.
   161 not been overridden.
   162 If you want to restore the default to all accounts, you may pass the
   162 If you want to restore the default to all accounts, you may pass the
   163 keyword **force**.
   163 option **‒‒force**.
   164 
   164 
   165 .. versionadded:: 0.6.0
   165 .. versionadded:: 0.6.0
   166 
   166 
   167 domaintransport
   167 domaintransport
   168 ---------------
   168 ---------------
   169 Syntax:
   169 Syntax:
   170  | **vmm domaintransport** *fqdn transport* [**force**]
   170  | **vmm domaintransport** *fqdn transport* [**‒‒force**]
   171  | **vmm dt** *fqdn transport* [**force**]
   171  | **vmm dt** *fqdn transport* [**‒‒force**]
   172 
   172 
   173 A new transport for the indicated domain can be set with this subcommand.
   173 A new transport for the indicated domain can be set with this subcommand.
   174 
   174 
   175 The new transport will affect only those accounts for which the transport
   175 The new transport will affect only those accounts for which the transport
   176 has not been overridden.
   176 has not been overridden.
   177 If you want to restore the default to all accounts, you may pass the
   177 If you want to restore the default to all accounts, you may pass the
   178 keyword **force**.
   178 option **‒‒force**.
   179 
   179 
   180 Example:
   180 Example:
   181 
   181 
   182 .. code-block:: console
   182 .. code-block:: console
   183 
   183