Skip to main content
pdf?stylesheet=default
Blackboard Help

Command Line Tools

If you are a Managed Hosting customer, this topic doesn't apply to you.
 

Blackboard Learn includes a set of basic system administration tools that must be run from the command line. These tools are located in the blackboard_home/tools/admin directory. Blackboard Learn also includes a set of system administration tools for content management that must be run from the command line. These commands are located in the blackboard/apps/bbcms/bin directory.

On Windows, these tools are .bat files; on UNIX Operating Systems they are .sh files. An error will appear if a command is not successful. If nothing is reported the command processed successfully.

Trying to execute a utility by opening the .bat file in the Windows GUI will return errors and possibly cause the system to stop functioning.


Command line tools

~/blackboard/tools/admin

AuthenticationOneTimeLogin DetectOrphanedHierarchyAssociations PurgeAccumulator
B2Manager DiskCleanup PushConfigUpdates
BatchCourseCopy FullTextTool RegisterPseudoLocales
BatchCreateInstitutionRoles GenerateEmbeddedInfo RotateLogs
BuildCollabLocaleJar LMSImport ServiceController
BundleDiff LMSMoveCourse ServerGroupManager
ChangeDefaultVirtualInstallation LMSMoveUser SystemInfo
ChangeToRemoteVirtualInstallation MergeDocstores ThemeDiff
ConnectInitialSync ProductionInstaller VirtualInstallation

~/blackboard/apps/bbcm

backup_course_files create-resource-links update-course-directory
copy-course-files-to-cs create-user-directory update-course-permission
course-access-control file-import updatecspathtoxythosid
course-role-access-control MoveCourseContent update-locale
create-all-courseorg-directories register-linked-resources user-access-control
create-all-user-directories repair-copied-files  
create-course-directory set-directory-quota  
create-directory update-all-course-hd-permission  

Restricted characters in directory names

When creating directories, do not insert the following characters into the directories for users, folders, or files:

\ / : * ? " < > |

Otherwise, these command lines cannot be executed.


Using spaces in directory names

If a source path or destination path includes spaces when using a command line tool, you must use quotes to enclose the entire path. The following are some examples:

file-import C:\Folder1 /users/Biology/Week1
file-import "C:\Folder 1" /users/Biology/Week1
file-import C:\Folder1 "/users/Biology/Week 1"
file-import "C:\Folder 1" "/users/Biology/Week 1"