changecontext deprecated

PACKAGE: open-xchange-admin

NAME

changecontext - creates a context.

SYNOPSIS

changecontext [OPTION]...

DESCRIPTION

This command line tool makes context-wide changes.

If you specify module access options; e.g. "--access-edit-password on"; then please be aware that basic module access set is the one from context's administrator. Meaning any option not explicitly specified as CLI argument will fall-back to context administrator setting for every user in associated context.

You can use changecontext to change the current quota for a given context. When the context has more filestore space in use than the new quota allows, the users are only able to delete files until the usage is below quota.

Module access can be set right by right with the --access-* options described in createuser(1), or as a whole with --access-combination-name. A combination name refers to a named set of rights defined through com.openexchange.moduleaccessdefinitions.<name> properties (traditionally in ModuleAccessDefinitions.properties), for example webmail, pim, pim_infostore, pim_mobility, groupware_standard, groupware_premium, drive or all. A name always replaces the complete set of rights. All rights, their status, the shipped combinations and the validation rules are documented in Module Access.

changecontext applies the new module access to the context administrator and to every user of the context. Reducing the module access does not delete data; run deleteinvisible(1) afterwards to remove data that is no longer reachable, for example the calendar data of a context that was changed from pim_infostore to webmail.

OPTIONS

-c, --contextid contextId : The id of the context, when starting with 0, 0 is deleted.

-N, --contextname contextName : Context name.

-L, --addmapping mapping : Add login mappings separated by ",".

-R, --removemapping mapping : Remove login mappings. Separated by ",".

-q, --quota quota : Quota for the context filestore in MB .

-N, --contextname contextName : The context name. Mandatory and mutually exclusive with -c.

--access-combination-name access-combination-name : Access combination name, see Module Access.

--capabilities-to-add capabilities-to-add : The capabilities to add as a comma-separated string (from 7.2.0 on). Capabilities that correspond to module access rights (webmail, infostore, read_create_shared_folders, ...) are rejected here; use the --access-* options instead, see Module Access.

--capabilities-to-remove capabilities-to-remove : The capabilities to remove as a comma-separated string (from 7.2.0 on). Capabilities that correspond to module access rights (webmail, infostore, read_create_shared_folders, ...) are rejected here; use the --access-* options instead, see Module Access.

--capabilities-to-drop capabilities-to-drop : The capabilities to drop; e.g. cleanse from storage; as a comma-separated string (from 7.6.0 on)

--quota-module quota-module : The identifier of the module to which to apply the quota value (from 7.2.0 on)

--quota-value quota-value : From v7.2.0 on: The quota value; zero is unlimited. From v7.6.0 on: The numeric quota value specifying the max. number of items allowed for context. Zero is unlimited. A value less than zero deletes the quota entry (and falls back to configured behavior)

-A, --adminuser masterAdmin : Master admin user name for authentication. Optional, depending on your configuration.

-P, --adminpass masterAdminPassword : Master admin password for authentication. Optional, depending on your configuration.

-h, --help : Prints a help text.

--environment : Show info about commandline environment.

--nonl : Remove all newlines (\n) from output.

--responsetimeout : The optional response timeout in seconds when reading data from server (default: 0s; infinite).

EXAMPLES

changecontext -A masterAdmin -P masterPassword -c 123 -q 5000