loading table of contents...

3.14.2.10. Restoreusers

The restoreusers tool reads an XML file which has been written using the dumpusers tool. The structure of the XML file is defined by the lib/xml/coremedia-userrepository.xsd schema. It contains a nested structure of group elements which contain rules defined for this group and elements representing the members of this group. To provide for membership in multiple groups a userref or groupref element can be used which refers back to a previously defined user or group.

Members are identified by their capid attribute, if given. If no capid is given, the member is identified by name and domain. If no such member is found, a new member is created. Members can only be created in the built-in user repository!

The identified member is updated to the corresponding values in the XML file, such as name, password, home folder and a group's isAdministrative flag. A new home folder is created if the given path does not exist yet.

[Note]Note

Many attributes cannot be changed once a group or user has been created (the domain of a user or group, the name or password of an external (LDAP) user, the flags isContentGroup and isLiveGroup of a group, the name and the members of an external group). If a mismatch is detected, the restoreusers tool exits with an error message. In addition, the tool can only add or change rules (including rules on external groups) and can only add memberships, but cannot remove them.

When a rights rule refers to a non-existent content path, an empty folder will be created at the indicated location, unless the rule's createFolder attribute is set to false. If createFolder is false and the folder does not exist, the rule is ignored on import.

usage: cm restoreusers -u <user> [other options] 
                       -f <dump-file-url>


available options:


-d,--domain <domain name>   domain for login (default=<builtin>)
-f,--file <file>            url of the user repository dump
-p,--password <password>    password for login
-u,--user <user name>       user for login (required)
-url <ior url>              url to connect to
-v,--verbose                enables verbose output

Example 3.22. Usage of the restoreusers tool


The options have the following meaning:

Parameters Description
-f The file name of the user repository XML file.

Table 3.27. Parameters of restoreusers