Difference between revisions of "AppSuite:Data management"

(Created page with "<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">deleteinvisible</h2></div></div></div><p>The <strong class="userinput"><...")
 
(html to wiki)
Line 1: Line 1:
−
<div class="sect1" lang="en-EN"><div class="titlepage"><div><div><h2 class="title" style="clear: both">deleteinvisible</h2></div></div></div><p>The <strong class="userinput"><code>deleteinvisible</code></strong> command line tool can be used to remove not visible data inside a context. Before calling this CLT the module access for all users in the context should be changed to the according permissions. This CLT uses the changed permissions to determine what data is not visible for the context users anymore. Changing permissions can be done by either changing the module access for every single user in the context through the CLT changeuser or by the CLT for changing the module access for an entire context.
 
−
Be careful because the deleted data is lost completely and can not be restored anymore.</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 for this CLT</td></tr><tr><td align="left">    --environment</td><td align="left">Shows information about environment variables</td></tr><tr><td align="left">    --nonl</td><td align="left">Removes all newlines (\n) from output</td></tr><tr><td align="left"> -c,--contextid &lt;contextid&gt;</td><td align="left">The unique identifier of the context that invisible data should be deleted.</td></tr><tr><td align="left">-N,--contextname &lt;contextname&gt;</td><td align="left">A name that is assigned to the context.</td></tr></table></div><p>Either the unique context identifier must be given or a name that is assigned to it.</p></div><div class="sect2" lang="en-EN"><div class="titlepage"><div><div><h3 class="title">Extra parameters</h3></div></div></div><div class="informaltable"><table border="0"><tr><td align="left">-A,--adminuser &lt;adminuser&gt;</td><td align="left">Master adminstrator user name that is defined for managing contexts.</td></tr><tr><td align="left">-P,--adminpass &lt;adminpass&gt;</td><td align="left">Master adminstrator user 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 or contextname&gt; invisible data deleted</code></p><p>On failure:</p><p><code class="computeroutput">context &lt;contextid or contextname&gt; invisible data 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/deleteinvisible -N default</code></strong></p><p><code class="computeroutput">context default invisible data deleted</code></p></div></div>
 
  
 +
== deleteinvisible ==
 +
 +
The '''<code>deleteinvisible</code>''' command line tool can be used to remove not visible data inside a context. Before calling this CLT the module access for all users in the context should be changed to the according permissions. This CLT uses the changed permissions to determine what data is not visible for the context users anymore. Changing permissions can be done by either changing the module access for every single user in the context through the CLT changeuser or by the CLT for changing the module access for an entire context.
 +
 +
''Be careful because the deleted data is lost completely and can not be restored anymore.''
 +
 +
 +
=== Parameters ===
 +
 +
{| border="1"
 +
|-
 +
| -h,--help
 +
|Prints a help text for this CLT
 +
|-
 +
| --environment
 +
|Shows information about environment variables
 +
|-
 +
| --nonl
 +
|Removes all newlines (\n) from output
 +
|-
 +
| -c,--contextid &lt;contextid&gt;
 +
|The unique identifier of the context that invisible data should be deleted.
 +
|-
 +
| -N,--contextname &lt;contextname&gt;
 +
|A name that is assigned to the context.
 +
|}
 +
 +
Either the unique context identifier must be given or a name that is assigned to it.
 +
 +
 +
=== Extra parameters ===
 +
 +
{| border="1"
 +
|-
 +
|-A,--adminuser &lt;adminuser&gt;
 +
|Master adminstrator user name that is defined for managing contexts.
 +
|-
 +
|-P,--adminpass &lt;adminpass&gt;
 +
|Master adminstrator user password.
 +
|}
 +
 +
=== Return value ===
 +
 +
<code>0</code> on success
 +
 +
<code>&gt;0</code> on failure
 +
 +
=== Mandatory parameters ===
 +
 +
'''<code>(contextid or contextname) {adminuser adminpass}</code>'''
 +
 +
=== Command output ===
 +
 +
On success:
 +
 +
<code>context &lt;contextid or contextname&gt; invisible data deleted</code>
 +
 +
On failure:
 +
 +
<code>context &lt;contextid or contextname&gt; invisible data could not be deleted: &lt;reason from server&gt;</code>
 +
 +
 +
=== Example ===
 +
 +
<code>root@oxhe~# </code>'''<code>/opt/open-xchange/sbin/deleteinvisible -N default</code>'''
 +
 +
<code>context default invisible data deleted</code>
  
 
[[Category:AppSuite]]
 
[[Category:AppSuite]]
 
[[Category:AdminGuide]]
 
[[Category:AdminGuide]]

Revision as of 14:28, 30 August 2013

deleteinvisible

The deleteinvisible command line tool can be used to remove not visible data inside a context. Before calling this CLT the module access for all users in the context should be changed to the according permissions. This CLT uses the changed permissions to determine what data is not visible for the context users anymore. Changing permissions can be done by either changing the module access for every single user in the context through the CLT changeuser or by the CLT for changing the module access for an entire context.

Be careful because the deleted data is lost completely and can not be restored anymore.


Parameters

-h,--help Prints a help text for this CLT
--environment Shows information about environment variables
--nonl Removes all newlines (\n) from output
-c,--contextid <contextid> The unique identifier of the context that invisible data should be deleted.
-N,--contextname <contextname> A name that is assigned to the context.

Either the unique context identifier must be given or a name that is assigned to it.


Extra parameters

Master adminstrator user name that is defined for managing contexts.
Master adminstrator user password.

Return value

0 on success

>0 on failure

Mandatory parameters

(contextid or contextname) {adminuser adminpass}

Command output

On success:

context <contextid or contextname> invisible data deleted

On failure:

context <contextid or contextname> invisible data could not be deleted: <reason from server>


Example

root@oxhe~# /opt/open-xchange/sbin/deleteinvisible -N default

context default invisible data deleted

Retrieved from "https://oxpedia.org/wiki/index.php?title=AppSuite:Data_management&oldid=15585"