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).
Commands
Section titled “Commands”| Command | Description |
|---|---|
schedule create | Create a new schedule |
schedule list | List all schedules in the organization |
schedule describe | Show details for a single schedule |
schedule enable | Enable a schedule |
schedule disable | Disable a schedule |
schedule delete | Delete a schedule |
schedule tasks list | List all scheduled tasks |
schedule tasks describe | Show details for a scheduled task |
schedule tasks enable | Enable a scheduled task |
schedule tasks disable | Disable a scheduled task |
schedule tasks remove | Remove a scheduled task |
schedule create
Section titled “schedule create”Create a new named schedule.
ndcli schedule create [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--name | string | Yes | Unique name within the organization |
--cron | string | Yes | Standard 5-field cron expression (e.g., "0 3 * * *") |
--timezone | string | Yes | IANA timezone name (e.g., America/New_York, UTC) |
Examples
Section titled “Examples”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 UTCschedule list
Section titled “schedule list”List all schedules in the organization.
ndcli schedule list [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--page | int | 1 | Page number |
--per-page | int | 30 | Items per page (max 100) |
Examples
Section titled “Examples”ndcli schedule list
ndcli schedule list -f jsonschedule describe
Section titled “schedule describe”Show details for a single schedule.
ndcli schedule describe <name>Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
name | Yes | Schedule name |
Examples
Section titled “Examples”ndcli schedule describe nightly-maintenance
ndcli schedule describe nightly-maintenance -f jsonschedule enable
Section titled “schedule enable”Enable a schedule. All scheduled tasks attached to it will resume firing.
ndcli schedule enable <name>Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
name | Yes | Schedule name |
Examples
Section titled “Examples”ndcli schedule enable nightly-maintenanceschedule disable
Section titled “schedule disable”Disable a schedule. All scheduled tasks attached to it are paused until re-enabled.
ndcli schedule disable <name>Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
name | Yes | Schedule name |
Examples
Section titled “Examples”ndcli schedule disable nightly-maintenanceschedule delete
Section titled “schedule delete”Delete a schedule permanently. The schedule must have no attached scheduled tasks before it can be deleted.
ndcli schedule delete <name>Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
name | Yes | Schedule name |
Examples
Section titled “Examples”ndcli schedule delete monthly-auditschedule tasks list
Section titled “schedule tasks list”List all scheduled tasks (recurring operations) in the organization.
ndcli schedule tasks list [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--schedule | string | Filter by schedule name | |
--type | string | Filter by task type (SYNC, RESTART, BACKUP, etc.) | |
--page | int | 1 | Page number |
--per-page | int | 30 | Items per page (max 100) |
Examples
Section titled “Examples”ndcli schedule tasks list
ndcli schedule tasks list --schedule nightly-maintenance
ndcli schedule tasks list --type SYNC
ndcli schedule tasks list -f jsonschedule tasks describe
Section titled “schedule tasks describe”Show details for a single scheduled task.
ndcli schedule tasks describe <code>Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
code | Yes | Scheduled task code (shown in schedule tasks list) |
Examples
Section titled “Examples”ndcli schedule tasks describe a1b2c3d4
ndcli schedule tasks describe a1b2c3d4 -f jsonschedule tasks enable
Section titled “schedule tasks enable”Enable a specific scheduled task. Overrides a task-level disable without affecting the schedule or other tasks.
ndcli schedule tasks enable <code>Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
code | Yes | Scheduled task code |
Examples
Section titled “Examples”ndcli schedule tasks enable a1b2c3d4schedule tasks disable
Section titled “schedule tasks disable”Disable a specific scheduled task. The schedule continues to fire; only this task is paused.
ndcli schedule tasks disable <code>Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
code | Yes | Scheduled task code |
Examples
Section titled “Examples”ndcli schedule tasks disable a1b2c3d4schedule tasks remove
Section titled “schedule tasks remove”Permanently remove a scheduled task. Future executions are stopped. The schedule itself is unaffected.
ndcli schedule tasks remove <code>Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
code | Yes | Scheduled task code |
Examples
Section titled “Examples”ndcli schedule tasks remove a1b2c3d4