close

Filter

loading table of contents...

Content Server Manual / Version 2110

Table Of Contents

3.13.2.6 Dumpusers

The dumpusers tool writes all groups, users and rules currently managed in a Content Server into an XML file. You can use this file later on with the restoreusers tool to restore the user settings (see Section 3.13.2.14, “Restoreusers). 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.

<group id="g13" name="global-manager" contentgroup="true" livegroup="false"
       administrative="false">
  <rule content="/Settings/Meta/Mail" type="CMMail" rights="RMDAP"/>
  <rule content="/Settings/Options/Bundles" type="CMSettings" rights="RMDAP"/>
  <rule content="/Settings/Options/Settings" type="CMSettings" rights="RMAP"/>
  <rule content="/Settings/Taxonomies" type="CMTaxonomy" rights="RMDAP"/>
  <rule content="/Themes" type="CMObject" rights="RMDAP"/>
  <rule content="/Themes" type="CMTemplateSet" rights="RMDAP"/>
  <rule content="/Themes" type="Folder_" rights="RMDAP"/>
  <members>
    <group name="global-site-manager-c" contentgroup="true" livegroup="false"
           administrative="false">
      <rule content="/Sites/Chef Corp." type="CMObject" rights="RMDAPS"/>
      <rule content="/Sites/Chef Corp." type="Folder_" rights="RMDAPS"/>
      <rule content="/Settings/Taxonomies" type="CMTaxonomy" rights="RMDAP"/>
      <members>
        <user id="u10" name="Colin" home="/Home/Colin"/>
        <user id="u9" name="Rick C" home="/Home/Rick C"/>
      </members>
    </group>
  </members>
</group>

Example 3.23. Snippet of dumpusers output


For a description of the flags shown at the rights attribute, see Section 3.15.2, “User Rights Management”.

Groups managed in an external user repository only appear in the output file if there are rights rules defined for those groups.

cm dumpusers [(1) connection options]
[ { -f | --file } file | [ { -e | --encoding } encoding ]]
[ -ie | --include-uuids ]
[ -P | --pretty ]
[ -v | --verbose ](1) { -u | --user } user [ { -d | --domain } domain ] [ { -p | --password } password ] [-url IOR URL]

Example 3.24. Usage of dumpusers


The options have the following meaning:

ParameterDescription

{ -e | --encoding } encoding

Defines the encoding for the output. Default is UTF-8. An encoding can only be used when the tool dumps in a file.

{ -f | --file } file

File where to write dump users to. May be provided as URL. If unset, the XML will be printed to standard output.

-ie | --include-uuids

Toggles export of UUIDs of users and groups. If contained, UUIDs will be automatically taken into account when restoring users, unless skipped explicitly.

Note

For Built-In Members Only

While UUIDs will be written for built-in members as well as external members (for example provided by LDAP), the UUIDs for external members will be ignored when restoring users.

It is expected, that your external user provider generates a stable unique ID. If for any reason the UUIDs for external members do not match, you will get an information about this issue.

-P | --pretty

Pretty print file.

-v | --verbose

Toggle verbose output.

Table 3.30. Parameters of dumpusers


Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.