copyxnat.api.run_command module

API for running the specified command on XNAT servers

copyxnat.api.run_command.resolve_projects(single_project_filter)

Return source and destination project names from a src:dst string

copyxnat.api.run_command.run_command(command, src_params, dst_params=None, project_filter=None, app_settings=None, reporter=None)

Runs the command on the specified XNAT servers

@param command: the command class to run @param src_params: XnatServerParams for source server @param dst_params: XnatServerParams for destination server @param project_filter: array of project names to process or None to process all projects visible on the server. If a project name needs to be different on the source and destination servers, the string should be of the form src_project_name:dst_project_name @param app_settings: Global settings; if None then defaults will be used @param reporter: PyReporter object for user input/output and logging

copyxnat.api.run_command.run_command_on_servers(command, src_xnat_server, dst_xnat_server, reporter, app_settings, project_filter=None)

Runs the specified command on the specified XnatServer objects

@param command: command class @param src_xnat_server: Source XnatServer @param dst_xnat_server: Destination XnatServer, if required for this command @param reporter: PyReporter object for user input/output and logging @param app_settings: holds global parameters @param project_filter: array of project names to process or None to process all projects visible on the server. If a project name needs to be different on the source and destination servers, the string should be of the form src_project_name:dst_project_name