---
schema_version: "1"
id: e3d34bd0804825813db9b0b3ab2a7e3fe00ff8ab20e9eeb77484c089de11b23f
title: tsm schedules
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/server/cli_schedules_tsm.md
canonical_url: https://help.tableau.com/current/server/en-us/cli_schedules_tsm.htm
source_site: help.tableau.com
content_type: documentation
content_hash: ddd50fbac2e252fd25af78a90ce03bb97a699a92b6063c117a189e7d6140ac49
description: Reference for tsm schedules commands to manage scheduled tsm maintenance backup jobs.
---
[Skip to main content](#main-content)

# tsm schedules

**Note:** These commands only apply to backup jobs scheduled using the tsm maintenance backup command. They do not apply to jobs run by the backgrounder (ex: extract refreshes, flows, subscriptions).

You can use the `tsm schedules` commands to manage scheduled backup jobs. To create a scheduled backup job, use the `tsm maintenance backup` command. For details, see [tsm maintenance backup](https://help.tableau.com/current/server/en-us/cli_maintenance_tsm.htm#tsm). For more details on managing scheduled backups, see [Scheduling and Managing Backups](https://help.tableau.com/current/server/en-us/db_backup.htm#ScheduleBackups).

- [tsm schedules delete](#sched_delete)
- [tsm schedules list](#sched_list)
- [tsm schedules resume](#sched_resume)
- [tsm schedules suspend](#sched_suspend)
- [tsm schedules update](#sched_update)

## tsm schedules delete

Delete the specified schedule.

### Synopsis

`tsm schedules delete [-si <scheduleID> | -sn <scheduleName>] [global options]`

### Options

\-si,--schedule-id <scheduleID>

Required if --schedule-name is not used.

Id of the schedule to delete.

\-sn,--schedule-name <scheduleName>

Required if --schedule-id is not used.

Name of the schedule to delete.

## tsm schedules list

List schedules on the server.

### Synopsis

`tsm schedules list [--next-run | --schedule-id <scheduleID> | --schedule-name <scheduleName>] [global options]`

### Options

\-nr,--next-run

Optional.

Sort the schedules by their "next run" time, earliest to latest.

\-si,--schedule-id <scheduleID>

Optional.

Id of the schedule to list the details of.

\-sn,--schedule-name <scheduleName>

Optional.

Sort the schedules by their names, in alphabetical order.

## tsm schedules resume

Resume the specified suspended schedule.

### Synopsis

`tsm schedules resume [-si <scheduleID> | -sn <scheduleName>] [global options]`

### Options

\-si,--schedule-id <scheduleID>

Required if --schedule-name is not used.

Id of the schedule to resume.

\-sn,--schedule-name <scheduleName>

Required if --schedule-id is not used.

Name of the schedule to resume.

## tsm schedules suspend

Suspend the specified schedule.

### Synopsis

`tsm schedules suspend [-si <scheduleID> | -sn <scheduleName>] [global options]`

### Options

\-si,--schedule-id <scheduleID>

Required if --schedule-name is not used.

Id of the schedule to suspend.

\-sn,--schedule-name <scheduleName>

Required if --schedule-id is not used.

Name of the schedule to suspend.

## tsm schedules update

Update the specified schedule.

### Synopsis

`tsm schedules update[-si <scheduleID> -st <time_to_run> -sr <recurrence_frequency> -sd <day-or-days>] [global options]`

### Options

\-si,--schedule-id <scheduleID>

Required.

Id of the schedule to update.

\-sr,--schedule-recurrence <frequency>

Required.

Recurrence frequency of the schedule. Valid options are "daily", "weekly", or "monthly".

\-st,--schedule-time <HH:MM>

Required.

The time a schedule should be run, in 24-hour format: HH:MM.

\-sd,--schedule-days <day\[,day\]>

Optional.

Days on which to run the schedule. For weekly schedules, use 1-7 where 1 is Monday, and 7 is Sunday. For monthly schedules, use 1-31. If a day doesn't exist for a specific month (30 for February, for example) the last valid day of the month is used. Separate multiple values with commas.

## Global options

\-h, --help

Optional.

Show the command help.

\-p, --password <password>

Required, along with `-u` or `--username` if no session is active.

Specify the password for the user specified in `-u` or `--username`.

If the password includes spaces or special characters, enclose it in quotes:

`--password "my password"`

\-s, --server https://<hostname>:8850

Optional.

Use the specified address for Tableau Services Manager. The URL must start with `https`, include port 8850, and use the server name not the IP address. For example `https://<tsm_hostname>:8850`. If no server is specified, `https://<localhost | dnsname>:8850` is assumed.

\--trust-admin-controller-cert

Optional.

Use this flag to trust the self-signed certificate on the TSM controller. For more information about certificate trust and CLI connections, see [Connecting TSM clients](https://help.tableau.com/current/server/en-us/tsm_overview.htm#Connecti).

\-u, --username <user>

Required if no session is active, along with `-p` or `--password`.

Specify a user account. If you do not include this option, the command is run using credentials you signed in with.