AppSuite:Context management: Difference between revisions

From Open-Xchange
(Admin handbook, sadly html-formatted.)
 
(removed some html elements, cleaned up.)
Line 1: Line 1:
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">createcontext</h2></div></div></div><a class="indexterm" name="id2590615"></a><p><strong class="userinput"><code>createcontext</code></strong> is the tool to create new contexts. A context is an independent instance within the createcontext Open-Xchange system and holds users, groups and resources and all their objects. Data from one context is not visible to other contexts. Module access (calendar, tasks, email) can be set via predefined "access combination names". These names can be configured on the server side. All users which are created during later use of the "createuser" tool will inherit the module access rights from the context. If you do not specify any access rights on createcontext minimal access rights will be granted. Currently, these are Webmail and Contacts access rights.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left">   --environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">   --nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,--contextid &lt;integer&gt;</td><td align="left">The id of the context, when starting with 0, 0 is deleted</td></tr><tr><td align="left">-q,--quota &lt;integer&gt;</td><td align="left">Context wide filestore quota in MB</td></tr><tr><td align="left">-u,--username &lt;string&gt;</td><td align="left">Username for the new context admin user</td></tr><tr><td align="left">-d,--displayname &lt;string&gt;</td><td align="left">Displayname for the new context admin user</td></tr><tr><td align="left">-g,--givenname &lt;string&gt;</td><td align="left">Given name for the new context admin user</td></tr><tr><td align="left">-s,--surname &lt;string&gt;</td><td align="left">Surname/last name for the new context Admin user</td></tr><tr><td align="left">-p,--password &lt;string&gt;</td><td align="left">Password for the new context Admin user</td></tr><tr><td align="left">-e,--email &lt;string&gt;</td><td align="left">Primary E-Mail address for the new context Admin user</td></tr><tr><td align="left">-l,--lang &lt;lang&gt;</td><td align="left">Language for the new context Admin user</td></tr><tr><td align="left">-t,--timezone &lt;timezone&gt;</td><td align="left">Timezone for the new context Amin user</td></tr><tr><td align="left">-N,--contextname &lt;string&gt;</td><td align="left">Context name</td></tr><tr><td align="left">-L,--addmapping &lt;string&gt;</td><td align="left">Add login mappings separated by ","</td></tr><tr><td align="left">--access-combination-name &lt;access-combination-name&gt;</td><td align="left">Access combination name</td></tr><tr><td align="left">--access-denied-portal &lt;on/off&gt;</td><td align="left">Denies portal access (Default is off)</td></tr><tr><td align="left"> --csv-import &lt;CSV file&gt; </td><td align="left"> Full path to CSV file with user data to import. This option makes mandatory options obsolete, except credential options (if needed). </td></tr></tbody></table></div><div class="sect3" lang="en-EN"><div class="titlepage"><div><div><h4 class="title">--csv-import &lt;CSV file&gt;</h4></div></div></div><p>Full path to CSV file with user data to import. This option makes mandatory command line options obsolete, except credential options (if needed). But they have to be set in the CSV file.</p><p>With this option you can specify a csv file (a full pathname must be given) with the data which should be imported. The columnnames in the CSV file must be the same as the long-options of the command line tools, without the prefix "--".</p><p>This option will normally be used to fill new large installations with the new data. So instead of calling the command line tools in a shell script every time, just a csv file needs to be created, containing the whole data.</p><p>Note that the credentials of the masteradmin in the createcontext call must be given on the command line with the -A and -P options nevertheless - if authentication is enabled. If the createuser command line tool is used, the credentials are part of the csv file, and cannot be set as options on the command line itself. The reason for this different behavior is that different contexts have different credentials for the admin user, so they must be set in every line of the csv file. Opposed to this the credentials of the masteradmin are always the same.</p></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>contextid {adminuser adminpass} quota username displayname givenname surname password email</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">context &lt;contextid&gt; created</code></p><p>On failure:</p><p><code class="computeroutput">context &lt;contextid&gt; could not be created: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/createcontext -c 123 -q 1000 -N CompanyA -u "admin" -d "Admin of CompanyA" -g John -s Example -p newpw -e john@example.com</code></strong></p><p><code class="computeroutput">context 123 created</code></p></div></div>
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">createcontext</h2></div></div></div><p><strong
class="userinput"><code>createcontext</code></strong> is the tool to create new contexts. A context is an independent instance within the createcontext Open-Xchange system and holds users, groups
and resources and all their objects. Data from one context is not visible to other contexts. Module access (calendar, tasks, email) can be set via predefined "access combination names". These
names can be configured on the server side. All users which are created during later use of the "createuser" tool will inherit the module access rights from the context. If you do not specify any
access rights on createcontext minimal access rights will be granted. Currently, these are Webmail and Contacts access rights.</p><div class="sect2" lang="en-EN"><div
class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-h,--help</td><td align="left">Prints a help
text</td></tr><tr><td align="left"> --environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left"> --nonl</td><td align="left">Remove all newlines (\n)
from output</td></tr><tr><td align="left">-c,--contextid &lt;integer&gt;</td><td align="left">The id of the context, when starting with 0, 0 is deleted</td></tr><tr><td align="left">-q,--quota
&lt;integer&gt;</td><td align="left">Context wide filestore quota in MB</td></tr><tr><td align="left">-u,--username &lt;string&gt;</td><td align="left">Username for the new context admin
user</td></tr><tr><td align="left">-d,--displayname &lt;string&gt;</td><td align="left">Displayname for the new context admin user</td></tr><tr><td align="left">-g,--givenname
&lt;string&gt;</td><td align="left">Given name for the new context admin user</td></tr><tr><td align="left">-s,--surname &lt;string&gt;</td><td align="left">Surname/last name for the new context
Admin user</td></tr><tr><td align="left">-p,--password &lt;string&gt;</td><td align="left">Password for the new context Admin user</td></tr><tr><td align="left">-e,--email &lt;string&gt;</td><td
align="left">Primary E-Mail address for the new context Admin user</td></tr><tr><td align="left">-l,--lang &lt;lang&gt;</td><td align="left">Language for the new context Admin
user</td></tr><tr><td align="left">-t,--timezone &lt;timezone&gt;</td><td align="left">Timezone for the new context Amin user</td></tr><tr><td align="left">-N,--contextname &lt;string&gt;</td><td
align="left">Context name</td></tr><tr><td align="left">-L,--addmapping &lt;string&gt;</td><td align="left">Add login mappings separated by ","</td></tr><tr><td
align="left">--access-combination-name &lt;access-combination-name&gt;</td><td align="left">Access combination name</td></tr><tr><td align="left">--access-denied-portal &lt;on/off&gt;</td><td
align="left">Denies portal access (Default is off)</td></tr><tr><td align="left"> --csv-import &lt;CSV file&gt; </td><td align="left"> Full path to CSV file with user data to import. This option
makes mandatory options obsolete, except credential options (if needed). </td></tr></table></div><div class="sect3" lang="en-EN"><div class="titlepage"><div><div><h4 class="title">--csv-import
&lt;CSV file&gt;</h4></div></div></div><p>Full path to CSV file with user data to import. This option makes mandatory command line options obsolete, except credential options (if needed). But they
have to be set in the CSV file.</p><p>With this option you can specify a csv file (a full pathname must be given) with the data which should be imported. The columnnames in the CSV file must be
the same as the long-options of the command line tools, without the prefix "--".</p><p>This option will normally be used to fill new large installations with the new data. So instead of calling
the command line tools in a shell script every time, just a csv file needs to be created, containing the whole data.</p><p>Note that the credentials of the masteradmin in the createcontext call
must be given on the command line with the -A and -P options nevertheless - if authentication is enabled. If the createuser command line tool is used, the credentials are part of the csv file, and
cannot be set as options on the command line itself. The reason for this different behavior is that different contexts have different credentials for the admin user, so they must be set in every
line of the csv file. Opposed to this the credentials of the masteradmin are always the same.</p></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td
align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></table></div></div><div class="sect2"
lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code
class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong
class="userinput"><code>contextid {adminuser adminpass} quota username displayname givenname surname password email</code></strong></p></div><div class="sect2" lang="en-EN"><div
class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">context &lt;contextid&gt; created</code></p><p>On
failure:</p><p><code class="computeroutput">context &lt;contextid&gt; could not be created: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div
class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/createcontext
-c 123 -q 1000 -N CompanyA -u "admin" -d "Admin of CompanyA" -g John -s Example -p newpw -e john@example.com</code></strong></p><p><code class="computeroutput">context 123
created</code></p></div></div>


<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">deletecontext</h2></div></div></div><a class="indexterm" name="id2577690"></a><p><strong class="userinput"><code>deletecontext</code></strong> is the tool to delete contexts and all data stored that belong to it. This includes
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">deletecontext</h2></div></div></div><p><strong
all database entries and files in the infostore but no E-Mail components.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,--contextid &lt;contextid&gt;</td><td align="left">The id of the context</td></tr><tr><td align="left">-N,--contextname &lt;contextname&gt;</td><td align="left">Context name</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>(contextid or contexname) {adminuser adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">context &lt;contextid&gt; deleted</code></p><p>On failure:</p><p><code class="computeroutput">context &lt;contextid&gt; could not be deleted: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/deletecontext -c 123</code></strong></p><p><code class="computeroutput">context 123 deleted</code></p></div></div>
class="userinput"><code>deletecontext</code></strong> is the tool to delete contexts and all data stored that belong to it. This includes all database entries and files in the infostore but no
E-Mail components.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td
align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td
align="left">--nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,--contextid &lt;contextid&gt;</td><td align="left">The id of the
context</td></tr><tr><td align="left">-N,--contextname &lt;contextname&gt;</td><td align="left">Context name</td></tr></table></div></div><div class="sect2" lang="en-EN"><div
class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser
&lt;string&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></table></div></div><div
class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code
class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong
class="userinput"><code>(contextid or contexname) {adminuser adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command
output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">context &lt;contextid&gt; deleted</code></p><p>On failure:</p><p><code class="computeroutput">context
&lt;contextid&gt; could not be deleted: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/deletecontext -c
123</code></strong></p><p><code class="computeroutput">context 123 deleted</code></p></div></div>


<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">listcontext</h2></div></div></div><a class="indexterm" name="id2523861"></a><p><strong class="userinput"><code>listcontext</code></strong> is the tool to list and search for contexts.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-s,--searchpattern &lt;string&gt;</td><td align="left">Search/List pattern, default “<span class="quote">*</span>”</td></tr><tr><td align="left">   --csv</td><td align="left">Command output as csv</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-A,--adminuser &lt;adminuser&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>{adminuser adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>Standard output:</p><pre class="screen">cid fid fname       enabled qmax qused name       lmappings
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">listcontext</h2></div></div></div><p><strong
  .   . ...         ...     ...   ... ...         ...</pre><p>csv output:</p><p><code class="computeroutput">id,filestore_id,filestore_name,enabled,max_quota,used_quota,name,lmappings</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><pre class="screen">root@oxhe:/opt/open-xchange/sbin# ./listcontexts
class="userinput"><code>listcontext</code></strong> is the tool to list and search for contexts.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
cid fid fname       enabled qmax qused name       lmappings
class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td
  6   3 6_ctx_store true   1000     0 customerA   6,customerA,secondlogin</pre></div></div>
align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from
output</td></tr><tr><td align="left">-s,--searchpattern &lt;string&gt;</td><td align="left">Search/List pattern, default “<span class="quote">*</span>”</td></tr><tr><td align="left"> --csv</td><td
align="left">Command output as csv</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is
enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser &lt;adminuser&gt;</td><td align="left">Master Admin user name</td></tr><tr><td
align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2"
lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>{adminuser adminpass}</code></strong></p></div><div
class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>Standard output:</p><pre class="screen">cid fid fname enabled qmax qused name
lmappings . . ... ... ... ... ... ...</pre><p>csv output:</p><p><code class="computeroutput">id,filestore_id,filestore_name,enabled,max_quota,used_quota,name,lmappings</code></p></div><div
class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><pre class="screen">root@oxhe:/opt/open-xchange/sbin# ./listcontexts cid fid fname
enabled qmax qused name lmappings 6 3 6_ctx_store true 1000 0 customerA 6,customerA,secondlogin</pre></div></div>


<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">disablecontext</h2></div></div></div><p><strong
class="userinput"><code>disablecontext</code></strong> is the tool to disable contexts. Whenever a customer tries to log in to a disabled context, the login is denied.</p><div class="sect2"
lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-h,--help</td><td
align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td
align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,--contextid &lt;integer&gt;</td><td align="left">The id of the context</td></tr><tr><td
align="left">-N,--contextname &lt;string&gt;</td><td align="left">Context name</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra
parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Master Admin
user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div
class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on
failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>(contextid or
contextname) {adminuser adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On
success:</p><p><code class="computeroutput">context &lt;contextid&gt; disabled</code></p><p>On failure:</p><p><code class="computeroutput">context &lt;contextid&gt; could not be disabled:
&lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code
class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/disablecontext -c 123</code></strong></p><p><code class="computeroutput">context 123
disabled</code></p></div></div>


<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">disablecontext</h2></div></div></div><a class="indexterm" name="id2591992"></a><p><strong class="userinput"><code>disablecontext</code></strong> is the tool to disable contexts.
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">disableallcontexts</h2></div></div></div><p><strong
Whenever a customer tries to log in to a disabled context, the login is denied.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,--contextid &lt;integer&gt;</td><td align="left">The id of the context</td></tr><tr><td align="left">-N,--contextname &lt;string&gt;</td><td align="left">Context name</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>(contextid or contextname) {adminuser adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">context &lt;contextid&gt; disabled</code></p><p>On failure:</p><p><code class="computeroutput">context &lt;contextid&gt; could not be disabled: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/disablecontext -c 123</code></strong></p><p><code class="computeroutput">context 123 disabled</code></p></div></div>
class="userinput"><code>disableallcontexts</code></strong> is the tool to disable all contexts. Whenever a customer tries to log in to a disabled context, the login is denied.</p><div
class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-h,--help</td><td
align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td
align="left">Remove all newlines (\n) from output</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when
authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Master Admin user
name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div
class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on
failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>{adminuser
adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code
class="computeroutput">all contexts disabled</code></p><p>On failure:</p><p><code class="computeroutput">all contexts could not be disabled: &lt;reason from server&gt;</code></p></div><div
class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong
class="userinput"><code>/opt/open-xchange/sbin/disableallcontexts</code></strong></p><p><code class="computeroutput">all contexts disabled</code></p></div></div>


<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">enablecontext</h2></div></div></div><p><strong
class="userinput"><code>enablecontext</code></strong> is the tool to enable a disabled context.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td
align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from
output</td></tr><tr><td align="left">-c,--contextid &lt;integer&gt;</td><td align="left">The id of the context</td></tr><tr><td align="left">-N,--contextname &lt;string&gt;</td><td
align="left">Context name</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is
enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser &lt;adminuser&gt;</td><td align="left">Master Admin user name</td></tr><tr><td
align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2"
lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>(contextid or contextname) {adminuser
adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code
class="computeroutput">context &lt;contextid&gt; enabled</code></p><p>On failure:</p><p><code class="computeroutput">context &lt;contextid&gt; could not be enabled: &lt;reason from
server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~#
</code><strong class="userinput"><code>/opt/open-xchange/sbin/enablecontext -c 123</code></strong></p><p><code class="computeroutput">context &lt;contextid&gt; enabled</code></p></div></div>


<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">disableallcontexts</h2></div></div></div><a class="indexterm" name="id2592248"></a><p><strong class="userinput"><code>disableallcontexts</code></strong> is the tool to disable all contexts. Whenever a customer tries
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">enableallcontexts</h2></div></div></div><p><strong
to log in to a disabled context, the login is denied.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from output</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>{adminuser adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">all contexts disabled</code></p><p>On failure:</p><p><code class="computeroutput">all contexts could not be disabled: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/disableallcontexts</code></strong></p><p><code class="computeroutput">all contexts disabled</code></p></div></div>
class="userinput"><code>enableallcontexts</code></strong> is the tool to enable all disabled contexts.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td
align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from
output</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div
class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass
&lt;string&gt;</td><td align="left">Master Admin password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return
value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div
class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>{adminuser adminpass}</code></strong></p></div><div class="sect2"
lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">all contexts enabled</code></p><p>On
failure:</p><p><code class="computeroutput">all contexts could not be enabled: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/enableallcontexts</code></strong></p><p><code
class="computeroutput">all contexts enabled</code></p></div></div>


<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">changecontext</h2></div></div></div><p><strong
class="userinput"><code>changecontext</code></strong> is the tool to change the current quota for a given context. When the context has more changecontext space in use than the new quota allows,
the customer is only able to delete files until the usage is below quota. Module access (calendar,tasks,email)can be set via predefined "access combination names". These names can be configured on
the server side. All users which are created during later use of the "createuser" tool will inherit the module access rights from the context. If you do not specify any access rights on
createcontext minimal access rights will be granted. Currently, these are Webmail and Contacts access rights.</p><p>There are some default combinations in the ModuleAccessDefinitions.properties
file on the admin server, like:


<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">enablecontext</h2></div></div></div><a class="indexterm" name="id2592489"></a><p><strong class="userinput"><code>enablecontext</code></strong> is the tool to enable a disabled context.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,--contextid &lt;integer&gt;</td><td align="left">The id of the context</td></tr><tr><td align="left">-N,--contextname &lt;string&gt;</td><td align="left">Context name</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-A,--adminuser &lt;adminuser&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>(contextid or contextname) {adminuser adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">context &lt;contextid&gt; enabled</code></p><p>On failure:</p><p><code class="computeroutput">context &lt;contextid&gt; could not be enabled: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/enablecontext -c 123</code></strong></p><p><code class="computeroutput">context &lt;contextid&gt; enabled</code></p></div></div>
</p><table class="simplelist" border="0" summary="Simple list"><tr><td><span class="phrase.bold">webmail</span>=webmail, contacts, globaladdressbookdisabled,
collectemailaddresses,editpassword</td></tr><tr><td><span class="phrase.bold">pim</span>=webmail, calendar, contacts, tasks, globaladdressbookdisabled, collectemailaddresses, multiplemailaccounts,
subscription, publication,editpassword</td></tr><tr><td><span class="phrase.bold">pim_infostore</span>=webmail, calendar, contacts, tasks, infostore, webdav, globaladdressbookdisabled,
collectemailaddresses, multiplemailaccounts, subscription, publication</td></tr><tr><td><span class="phrase.bold">pim_mobility</span>=webmail,calendar,contacts,tasks,syncml,usm,
activesync,globaladdressbookdisabled,collectemailaddresses,multiplemailaccounts,subscription,publication, editpassword</td></tr><tr><td><span
class="phrase.bold">groupware_standard</span>=webmail,calendar,contacts,infostore,tasks,webdav,ical,vcard,readcreatesharedfolders,delegatetask,editpublicfolders,editgroup,editresource,editpassword,collectemailaddresses,multiplemailaccounts,subscription,publication
(Groupware Standard always gets new features except mobility and OXtender. ) </td></tr><tr><td><span
class="phrase.bold">groupware_premium</span>=webmail,calendar,contacts,infostore,tasks,webdav,webdavxml,ical,vcard,syncml,usm,olox20,activesync,readcreatesharedfolders,delegatetask,editpublicfolders,editgroup,editresource,editpassword,collectemailaddresses,multiplemailaccounts,subscription,publication</td></tr><tr><td><span
class="phrase.bold">all</span>=webmail,calendar,contacts,infostore,tasks,webdav,webdavxml,ical,vcard,syncml,usm,olox20,activesync,readcreatesharedfolders,delegatetask,editpublicfolders,editgroup,editresource,editpassword,publicfoldereditable,collectemailaddresses,multiplemailaccounts,subscription,publication</td></tr></table><p>
</p><p>When having changed the access rights of the context and its users with "changecontext" the "downgrade" command should be called on the admin server. All unnecessary data are removed from
the data base via "groupware api". If e. g. the context 1 is changed from "pim_infostore" to "webmail", the "downgrade" command has to be called for this context then. Then, all unnecessary
folders for this context are removed from the data base.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div
class="informaltable"><table border="0"><tr><td align="left">-h,- -help</td><td align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about
commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,- -contextid &lt;integer&gt;</td><td
align="left">The id of the context</td></tr><tr><td align="left">-N,- -contextname &lt;string&gt;</td><td align="left">The name of the context</td></tr><tr><td align="left">-L,- -addmapping
&lt;string(s)&gt;</td><td align="left">Add login mappings. Separated by ","</td></tr><tr><td align="left">-R,- -removemapping &lt;stirng(s)&gt;</td><td align="left">Remove login mappings.
Separated by ","</td></tr><tr><td align="left">-q,- -quota &lt;integer&gt;</td><td align="left">Quota for the context filestore in MB</td></tr><tr><td align="left">--access-combination-name
&lt;access-combination-name&gt;</td><td align="left">Access combination name</td></tr></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra
parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,- -adminuser &lt;string&gt;</td><td align="left">Master Admin
user name</td></tr><tr><td align="left">-P,- -adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></table></div></div><div class="sect2" lang="en-EN"><div
class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on
failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>(contextid or
contextname) {adminuser adminpass} and at minimum one attribute to change</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command
output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">context &lt;contextid&gt; changed</code></p><p>On failure:</p><p><code class="computeroutput">context
&lt;contextid&gt; could not be changed: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3
class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/changecontext -c 123 -q
500</code></strong></p><p><code class="computeroutput">context 123 changed</code></p></div></div>


 
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">getAdminId</h2></div></div></div><p>Returns the ID of the context administrator.</p></div>
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">enableallcontexts</h2></div></div></div><a class="indexterm" name="id2592740"></a><p><strong class="userinput"><code>enableallcontexts</code></strong> is the tool to enable all disabled contexts.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-h,--help</td><td align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from output</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-A,--adminuser &lt;string&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,--adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>{adminuser adminpass}</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">all contexts enabled</code></p><p>On failure:</p><p><code class="computeroutput">all contexts could not be enabled: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/enableallcontexts</code></strong></p><p><code class="computeroutput">all contexts enabled</code></p></div></div>
 
 
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">changecontext</h2></div></div></div><a class="indexterm" name="id2592976"></a><p><strong class="userinput"><code>changecontext</code></strong> is the tool to change the current quota for a given context. When the context has more changecontext space in use than the new quota allows, the customer is only able to delete files until the usage is below quota. Module access (calendar,tasks,email)can be set via predefined "access combination names". These names can be configured on the server side. All users which are created during later use of the "createuser" tool will inherit the module access rights from the context. If you do not specify any access rights on createcontext minimal access rights will be granted. Currently, these are Webmail and Contacts access rights.</p><p>There are some default combinations in the  ModuleAccessDefinitions.properties file on the admin server, like:
</p><table class="simplelist" border="0" summary="Simple list"><tbody><tr><td><span class="phrase.bold">webmail</span>=webmail, contacts, globaladdressbookdisabled, collectemailaddresses,editpassword</td></tr><tr><td><span class="phrase.bold">pim</span>=webmail, calendar, contacts, tasks, globaladdressbookdisabled, collectemailaddresses, multiplemailaccounts, subscription, publication,editpassword</td></tr><tr><td><span class="phrase.bold">pim_infostore</span>=webmail, calendar, contacts, tasks, infostore, webdav, globaladdressbookdisabled, collectemailaddresses, multiplemailaccounts, subscription, publication</td></tr><tr><td><span class="phrase.bold">pim_mobility</span>=webmail,calendar,contacts,tasks,syncml,usm, activesync,globaladdressbookdisabled,collectemailaddresses,multiplemailaccounts,subscription,publication, editpassword</td></tr><tr><td><span class="phrase.bold">groupware_standard</span>=webmail,calendar,contacts,infostore,tasks,webdav,ical,vcard,readcreatesharedfolders,delegatetask,editpublicfolders,editgroup,editresource,editpassword,collectemailaddresses,multiplemailaccounts,subscription,publication (Groupware Standard always gets new features except mobility and OXtender. ) </td></tr><tr><td><span class="phrase.bold">groupware_premium</span>=webmail,calendar,contacts,infostore,tasks,webdav,webdavxml,ical,vcard,syncml,usm,olox20,activesync,readcreatesharedfolders,delegatetask,editpublicfolders,editgroup,editresource,editpassword,collectemailaddresses,multiplemailaccounts,subscription,publication</td></tr><tr><td><span class="phrase.bold">all</span>=webmail,calendar,contacts,infostore,tasks,webdav,webdavxml,ical,vcard,syncml,usm,olox20,activesync,readcreatesharedfolders,delegatetask,editpublicfolders,editgroup,editresource,editpassword,publicfoldereditable,collectemailaddresses,multiplemailaccounts,subscription,publication</td></tr></tbody></table><p>
</p><p>When having changed the access rights of the context and its users with "changecontext" the "downgrade" command should be called on the admin server. All unnecessary data are removed from the data base via "groupware api". If e. g. the context 1 is changed from "pim_infostore" to "webmail", the  "downgrade" command has to be called for this context then. Then, all unnecessary folders for this context are removed from the data base.</p><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Parameters</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-h,- -help</td><td align="left">Prints a help text</td></tr><tr><td align="left">--environment</td><td align="left">Show info about commandline environment</td></tr><tr><td align="left">--nonl</td><td align="left">Remove all newlines (\n) from output</td></tr><tr><td align="left">-c,- -contextid &lt;integer&gt;</td><td align="left">The id of the context</td></tr><tr><td align="left">-N,- -contextname &lt;string&gt;</td><td align="left">The name of the context</td></tr><tr><td align="left">-L,- -addmapping &lt;string(s)&gt;</td><td align="left">Add login mappings. Separated by ","</td></tr><tr><td align="left">-R,- -removemapping &lt;stirng(s)&gt;</td><td align="left">Remove login mappings. Separated by ","</td></tr><tr><td align="left">-q,- -quota &lt;integer&gt;</td><td align="left">Quota for the context filestore in MB</td></tr><tr><td align="left">--access-combination-name &lt;access-combination-name&gt;</td><td align="left">Access combination name</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters when authentication is enabled</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="left"><col align="left"></colgroup><tbody><tr><td align="left">-A,- -adminuser &lt;string&gt;</td><td align="left">Master Admin user name</td></tr><tr><td align="left">-P,- -adminpass &lt;string&gt;</td><td align="left">Master Admin password</td></tr></tbody></table></div></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Return value</h3></div></div></div><p><code class="computeroutput">0</code> on success</p><p><code class="computeroutput">&gt;0</code> on failure</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Mandatory parameters</h3></div></div></div><p><strong class="userinput"><code>(contextid or contextname) {adminuser adminpass} and at minimum one attribute to change</code></strong></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Command output</h3></div></div></div><p>On success:</p><p><code class="computeroutput">context &lt;contextid&gt; changed</code></p><p>On failure:</p><p><code class="computeroutput">context &lt;contextid&gt; could not be changed: &lt;reason from server&gt;</code></p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Example</h3></div></div></div><p><code class="computeroutput">root@oxhe~# </code><strong class="userinput"><code>/opt/open-xchange/sbin/changecontext -c 123 -q 500</code></strong></p><p><code class="computeroutput">context 123 changed</code></p></div></div>
 
 
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">getAdminId</h2></div></div></div><a class="indexterm" name="id2593384"></a><p>Returns the ID of the context administrator.</p></div>

Revision as of 17:24, 16 December 2012

createcontext is the tool to create new contexts. A context is an independent instance within the createcontext Open-Xchange system and holds users, groups

and resources and all their objects. Data from one context is not visible to other contexts. Module access (calendar, tasks, email) can be set via predefined "access combination names". These names can be configured on the server side. All users which are created during later use of the "createuser" tool will inherit the module access rights from the context. If you do not specify any

access rights on createcontext minimal access rights will be granted. Currently, these are Webmail and Contacts access rights.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <integer>The id of the context, when starting with 0, 0 is deleted
-q,--quota <integer>Context wide filestore quota in MB
-u,--username <string>Username for the new context admin user
-d,--displayname <string>Displayname for the new context admin user
-g,--givenname <string>Given name for the new context admin user
-s,--surname <string>Surname/last name for the new context Admin user
-p,--password <string>Password for the new context Admin user
-e,--email <string>Primary E-Mail address for the new context Admin user
-l,--lang <lang>Language for the new context Admin user
-t,--timezone <timezone>Timezone for the new context Amin user
-N,--contextname <string>Context name
-L,--addmapping <string>Add login mappings separated by ","
--access-combination-name <access-combination-name>Access combination name
--access-denied-portal <on/off>Denies portal access (Default is off)
--csv-import <CSV file> Full path to CSV file with user data to import. This option makes mandatory options obsolete, except credential options (if needed).

--csv-import <CSV file>

Full path to CSV file with user data to import. This option makes mandatory command line options obsolete, except credential options (if needed). But they have to be set in the CSV file.

With this option you can specify a csv file (a full pathname must be given) with the data which should be imported. The columnnames in the CSV file must be the same as the long-options of the command line tools, without the prefix "--".

This option will normally be used to fill new large installations with the new data. So instead of calling the command line tools in a shell script every time, just a csv file needs to be created, containing the whole data.

Note that the credentials of the masteradmin in the createcontext call

must be given on the command line with the -A and -P options nevertheless - if authentication is enabled. If the createuser command line tool is used, the credentials are part of the csv file, and cannot be set as options on the command line itself. The reason for this different behavior is that different contexts have different credentials for the admin user, so they must be set in every

line of the csv file. Opposed to this the credentials of the masteradmin are always the same.

Extra parameters when authentication is enabled

-A,--adminuser <string>Master Admin user name
-P,--adminpass <string>Master Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

contextid {adminuser adminpass} quota username displayname givenname surname password email

Command output

On success:

context <contextid> created

On failure:

context <contextid> could not be created: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/createcontext -c 123 -q 1000 -N CompanyA -u "admin" -d "Admin of CompanyA" -g John -s Example -p newpw -e john@example.com

context 123 created

deletecontext

deletecontext is the tool to delete contexts and all data stored that belong to it. This includes all database entries and files in the infostore but no E-Mail components.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <contextid>The id of the context
-N,--contextname <contextname>Context name

Extra parameters when authentication is enabled

-A,--adminuser <string>Master Admin user name
-P,--adminpass <string>Master Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

(contextid or contexname) {adminuser adminpass}

Command output

On success:

context <contextid> deleted

On failure:

context <contextid> could not be deleted: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/deletecontext -c 123

context 123 deleted

listcontext

listcontext is the tool to list and search for contexts.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-s,--searchpattern <string>Search/List pattern, default “*
--csvCommand output as csv

Extra parameters when authentication is enabled

-A,--adminuser <adminuser>Master Admin user name
-P,--adminpass <string>Master Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

{adminuser adminpass}

Command output

Standard output:

cid fid fname enabled qmax qused name
lmappings . . ... ... ... ... ... ...

csv output:

id,filestore_id,filestore_name,enabled,max_quota,used_quota,name,lmappings

Example

root@oxhe:/opt/open-xchange/sbin# ./listcontexts cid fid fname
enabled qmax qused name lmappings 6 3 6_ctx_store true 1000 0 customerA 6,customerA,secondlogin

disablecontext

disablecontext is the tool to disable contexts. Whenever a customer tries to log in to a disabled context, the login is denied.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <integer>The id of the context
-N,--contextname <string>Context name

Extra parameters when authentication is enabled

-A,--adminuser <string>Master Admin user name
-P,--adminpass <string>Master Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

(contextid or contextname) {adminuser adminpass}

Command output

On success:

context <contextid> disabled

On failure:

context <contextid> could not be disabled: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/disablecontext -c 123

context 123 disabled

disableallcontexts

disableallcontexts is the tool to disable all contexts. Whenever a customer tries to log in to a disabled context, the login is denied.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output

Extra parameters when authentication is enabled

-A,--adminuser <string>Master Admin user name
-P,--adminpass <string>Master Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

{adminuser adminpass}

Command output

On success:

all contexts disabled

On failure:

all contexts could not be disabled: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/disableallcontexts

all contexts disabled

enablecontext

enablecontext is the tool to enable a disabled context.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <integer>The id of the context
-N,--contextname <string>Context name

Extra parameters when authentication is enabled

-A,--adminuser <adminuser>Master Admin user name
-P,--adminpass <string>Master Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

(contextid or contextname) {adminuser adminpass}

Command output

On success:

context <contextid> enabled

On failure:

context <contextid> could not be enabled: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/enablecontext -c 123

context <contextid> enabled

enableallcontexts

enableallcontexts is the tool to enable all disabled contexts.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output

Extra parameters when authentication is enabled

-A,--adminuser <string>Master Admin user name
-P,--adminpass <string>Master Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

{adminuser adminpass}

Command output

On success:

all contexts enabled

On failure:

all contexts could not be enabled: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/enableallcontexts

all contexts enabled

changecontext

changecontext is the tool to change the current quota for a given context. When the context has more changecontext space in use than the new quota allows,

the customer is only able to delete files until the usage is below quota. Module access (calendar,tasks,email)can be set via predefined "access combination names". These names can be configured on the server side. All users which are created during later use of the "createuser" tool will inherit the module access rights from the context. If you do not specify any access rights on

createcontext minimal access rights will be granted. Currently, these are Webmail and Contacts access rights.

There are some default combinations in the ModuleAccessDefinitions.properties

file on the admin server, like:

webmail=webmail, contacts, globaladdressbookdisabled, collectemailaddresses,editpassword
pim=webmail, calendar, contacts, tasks, globaladdressbookdisabled, collectemailaddresses, multiplemailaccounts, subscription, publication,editpassword
pim_infostore=webmail, calendar, contacts, tasks, infostore, webdav, globaladdressbookdisabled, collectemailaddresses, multiplemailaccounts, subscription, publication
pim_mobility=webmail,calendar,contacts,tasks,syncml,usm, activesync,globaladdressbookdisabled,collectemailaddresses,multiplemailaccounts,subscription,publication, editpassword
groupware_standard=webmail,calendar,contacts,infostore,tasks,webdav,ical,vcard,readcreatesharedfolders,delegatetask,editpublicfolders,editgroup,editresource,editpassword,collectemailaddresses,multiplemailaccounts,subscription,publication (Groupware Standard always gets new features except mobility and OXtender. )
groupware_premium=webmail,calendar,contacts,infostore,tasks,webdav,webdavxml,ical,vcard,syncml,usm,olox20,activesync,readcreatesharedfolders,delegatetask,editpublicfolders,editgroup,editresource,editpassword,collectemailaddresses,multiplemailaccounts,subscription,publication
all=webmail,calendar,contacts,infostore,tasks,webdav,webdavxml,ical,vcard,syncml,usm,olox20,activesync,readcreatesharedfolders,delegatetask,editpublicfolders,editgroup,editresource,editpassword,publicfoldereditable,collectemailaddresses,multiplemailaccounts,subscription,publication

When having changed the access rights of the context and its users with "changecontext" the "downgrade" command should be called on the admin server. All unnecessary data are removed from

the data base via "groupware api". If e. g. the context 1 is changed from "pim_infostore" to "webmail", the "downgrade" command has to be called for this context then. Then, all unnecessary

folders for this context are removed from the data base.

Parameters

-h,- -helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,- -contextid <integer>The id of the context
-N,- -contextname <string>The name of the context
-L,- -addmapping <string(s)>Add login mappings. Separated by ","
-R,- -removemapping <stirng(s)>Remove login mappings. Separated by ","
-q,- -quota <integer>Quota for the context filestore in MB
--access-combination-name <access-combination-name>Access combination name

Extra parameters when authentication is enabled

-A,- -adminuser <string>Master Admin user name
-P,- -adminpass <string>Master Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

(contextid or contextname) {adminuser adminpass} and at minimum one attribute to change

Command output

On success:

context <contextid> changed

On failure:

context <contextid> could not be changed: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/changecontext -c 123 -q 500

context 123 changed

getAdminId

Returns the ID of the context administrator.