AppSuite:Data management

From Open-Xchange
Revision as of 18:01, 16 December 2012 by Tierlieb (talk | contribs) (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"><...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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,--helpPrints a help text for this CLT
--environmentShows information about environment variables
--nonlRemoves 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

-A,--adminuser <adminuser>Master adminstrator user name that is defined for managing contexts.
-P,--adminpass <adminpass>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