Skip to content

schedule

Schedules are named, reusable cadences (cron expression + timezone) that drive recurring operations — sync applies, run commands, and backup runs. The schedule command surface has two sub-groups: schedule (cadence CRUD) and schedule tasks (management of the recurring operations attached to a schedule).

CommandDescription
schedule createCreate a new schedule
schedule listList all schedules in the organization
schedule describeShow details for a single schedule
schedule enableEnable a schedule
schedule disableDisable a schedule
schedule deleteDelete a schedule
schedule tasks listList all scheduled tasks
schedule tasks describeShow details for a scheduled task
schedule tasks enableEnable a scheduled task
schedule tasks disableDisable a scheduled task
schedule tasks removeRemove a scheduled task

Create a new named schedule.

Terminal window
ndcli schedule create [flags]
FlagTypeRequiredDescription
--namestringYesUnique name within the organization
--cronstringYesStandard 5-field cron expression (e.g., "0 3 * * *")
--timezonestringYesIANA timezone name (e.g., America/New_York, UTC)
Terminal window
ndcli schedule create --name nightly-maintenance --cron "0 3 * * *" --timezone America/New_York
ndcli schedule create --name monday-reboot --cron "0 4 * * 1" --timezone America/Chicago
ndcli schedule create --name monthly-audit --cron "0 0 1 * *" --timezone UTC

List all schedules in the organization.

Terminal window
ndcli schedule list [flags]
FlagTypeDefaultDescription
--pageint1Page number
--per-pageint30Items per page (max 100)
Terminal window
ndcli schedule list
ndcli schedule list -f json

Show details for a single schedule.

Terminal window
ndcli schedule describe <name>
ArgumentRequiredDescription
nameYesSchedule name
Terminal window
ndcli schedule describe nightly-maintenance
ndcli schedule describe nightly-maintenance -f json

Enable a schedule. All scheduled tasks attached to it will resume firing.

Terminal window
ndcli schedule enable <name>
ArgumentRequiredDescription
nameYesSchedule name
Terminal window
ndcli schedule enable nightly-maintenance

Disable a schedule. All scheduled tasks attached to it are paused until re-enabled.

Terminal window
ndcli schedule disable <name>
ArgumentRequiredDescription
nameYesSchedule name
Terminal window
ndcli schedule disable nightly-maintenance

Delete a schedule permanently. The schedule must have no attached scheduled tasks before it can be deleted.

Terminal window
ndcli schedule delete <name>
ArgumentRequiredDescription
nameYesSchedule name
Terminal window
ndcli schedule delete monthly-audit

List all scheduled tasks (recurring operations) in the organization.

Terminal window
ndcli schedule tasks list [flags]
FlagTypeDefaultDescription
--schedulestringFilter by schedule name
--typestringFilter by task type (SYNC, RESTART, BACKUP, etc.)
--pageint1Page number
--per-pageint30Items per page (max 100)
Terminal window
ndcli schedule tasks list
ndcli schedule tasks list --schedule nightly-maintenance
ndcli schedule tasks list --type SYNC
ndcli schedule tasks list -f json

Show details for a single scheduled task.

Terminal window
ndcli schedule tasks describe <code>
ArgumentRequiredDescription
codeYesScheduled task code (shown in schedule tasks list)
Terminal window
ndcli schedule tasks describe a1b2c3d4
ndcli schedule tasks describe a1b2c3d4 -f json

Enable a specific scheduled task. Overrides a task-level disable without affecting the schedule or other tasks.

Terminal window
ndcli schedule tasks enable <code>
ArgumentRequiredDescription
codeYesScheduled task code
Terminal window
ndcli schedule tasks enable a1b2c3d4

Disable a specific scheduled task. The schedule continues to fire; only this task is paused.

Terminal window
ndcli schedule tasks disable <code>
ArgumentRequiredDescription
codeYesScheduled task code
Terminal window
ndcli schedule tasks disable a1b2c3d4

Permanently remove a scheduled task. Future executions are stopped. The schedule itself is unaffected.

Terminal window
ndcli schedule tasks remove <code>
ArgumentRequiredDescription
codeYesScheduled task code
Terminal window
ndcli schedule tasks remove a1b2c3d4