Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Short parameter nameLong parameter nameRequired?Takes argument?Description
-u--useryesyesSpecifies the XNAT user to upload data. For full functionality, the user should be an admin, but this is not strictly required to use only parts of the features.
-p--passyesyes

The password for the user specified above.

-s--urlyesyes

The site URL for your XNAT instance to populate.

-d--datayesyesThis specifies a text file which defines the data to upload (separated by newlines). See Populate Data for more information about available data. Alternatively, instead of specifying a file, you can enter a comma-separated list of projects here.
-g--confignoyesSpecifies a YAML file as defined in Site Configuration to set site level properties.
-c--cleannonoDANGEROUS. Add this flag to delete preexisting XNAT projects matching the data list. Don't use in production. Also, always back up your data just in case something goes wrong.
-r--refresh-datanono

Semi-dangerous. Add this flag to clear out the data folder on startup. Useful to grab updated copies of data.

-y--refresh-yaml

no

noAdd this flag to delete all YAML files in data folder on startup. Useful to grab updated configuration YAML.
-k--insecurenonoAdd this flag to ignore SSL errors on https sites. Useful for dev/test environments.
-su--secure-usersnonoAdd this flag to only add existing XNAT users to created projects. Users that are specified in project configurations will not be created (to prevent insecure user accounts).
-e--export-modenonoAdd this flag to use XNAT Populate to export data *from* your XNAT to the local file system in a format that it can understand (can then be used to send to a different XNAT).
-w--delaynoyesOptional delay (in milliseconds) after each session import. Useful if rapid session imports is degrading performance on the server in constrained memory situations.
-m--promptnonoAdd this flag to allow XNAT Populate to prompt you for your password instead of including it in the arguments.