btmcli exportSchedules

Use the exportSchedules command to export schedules from the target sphere. You can output the schedules to a file or to stdout.

You can specify all schedules, a specific schedule, or schedules of a certain type.

After export, you can use the importSchedules command to import the schedules to a different sphere.

Command Syntax

btmcli exportSchedules -n Name | -query filterQuery | -exportAll
                       [-o fileName]
                       -s sphereUrl sphereUrl -l username:password
Name Long Name Description
-n -name The name of the schedule to export.
-query -filterQuery An AQL query specifying the set of schedules to export.

Use the Filter tool to construct the query, and then copy and paste the query into the command line.

-exportAll -- Specifies that all schedules should be exported.
-o -outputFile Specifies a file into which the results of the export will be placed. If this flag is not used, output goes to stdout.
-s -sphereUrl The URL of the sphere.


This flag is not required if you have set the AP_SPHERE_URL environment variable for your sphere.

-l -userLogin The username and password associated with the sphere, in the format: username:password. This set of credentials must belong to a user in the btmadmin role.

See Security Options in Accessing CLI Commands for information on furnishing login credentials.

You can encrypt passwords using the encryptPassword command.


The following command exports all schedules known to the specified sphere to the file MySchedules.

btmcli exportSchedules -exportAll -o C:\Home\MySchedules 
                       -s http://localhost/btmcentral/sphere/ -l admin:pass