export-users

export-users 
[-b value | --bootstrap-config=value] 
[-t value | --tool-password=value] 
[-i value | --include-password-hashes=value] 
[-s value | --use-stdf=value] 
[-g value | --include-guids=value] 
[-n value | --include-name-row=value] 
[export file] 
[-f | --force]

Overview

Use this command to export all users from the user directory. The exported users 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.
`-i value --include-password-hashes=value>`	Optional	false	Indicates whether the exported file should include the password hashes. Passwords are relevant only if you use the Spotfire database for authentication.
`-s value --use-stdf=value`	Optional	true	Indicates whether the exported file should be created in Spotfire Text Data Format. If `false`, plain CSV format is used.
`-g value --include-guids=value`	Optional	false	Indicates whether the Globally Unique Identifier (GUID) of each user should be included.
`-n value --include-name-row=value`	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	users.txt	The path to the file to create.
`-f --force`	Optional	none	Indicates that the tool should overwrite an existing destination file.