export-groups

Exports groups from the user directory.

export-groups 
[-b value | --bootstrap-config=value] 
[-t value | --tool-password=value] 
[-m <true|false> | --include-member-groups=<true|false>] 
[-u <true|false> | --include-member-users=<true|false>] 
[-g <true|false> | --include-guids=<true|false>] 
[-s <true|false> | --use-stdf=<true|false>] 
[-n <true|false> | --include-name-row=<true|false>] 
[export file] 
[-f | --force]

Overview

Use this command to export all groups from the user directory. The exported groups can be imported on a different server.

Options

Option Optional or Required Default Value Description
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-t value
--tool-password=value
Optional none The configuration tool password used to decrypt the database password in the file bootstrap.xml. If the tool password is omitted, the command prompts the user for it in the console. Refer to Bootstrap.xml file.
-m <true|false>
--include-member-groups=<true|false>
Optional false Indicates whether the group hierarchy information (groups in groups) should be included. Can be used in conjunction with the --include-member-users argument to include all information.
-u <true|false>
--include-member-users=<true|false>
Optional false Indicates whether the group hierarchy information (users in groups) should be included. Can be used in conjunction with the --include-member-groups argument to include all information.
-g <true|false>
--include-guids=<true|false>
Optional false Indicates whether the globally unique identifier (GUID) of each group should be included.
-s <true|false>
--use-stdf=<true|false>
Optional true Indicates whether the exported file should be created in Spotfire Text Data Format. If "false", plain CSV format is used.
-n <true|false>
--include-name-row=<true|false>
Optional false Indicates whether the exported file should include a column name row. Applicable only when --use-stdf is set to "false" because STDF always includes a name row.
[export file]
Optional groups.txt The path to the file to create.
-f
--force
Optional none Indicates that the tool should overwrite an existing destination file.