tsm maintenance

您可以使用 tsm maintenance 命令来管理服务器维护任务，例如创建定期备份或从先前创建的备份还原 Tableau Server。

• tsm maintenance backup

• tsm maintenance cleanup

• tsm maintenance jmx

• tsm maintenance jmx disable

• tsm maintenance jmx enable

• tsm maintenance metadata-services

• tsm maintenance metadata-services disable

• tsm maintenance metadata-services enable

• tsm maintenance metadata-services get-status

• tsm maintenance reindex-search

• tsm maintenance reset-searchserver

• tsm maintenance restore

• tsm maintenance send-logs

• tsm maintenance snapshot-backup

• tsm maintenance snapshot-backup complete

• tsm maintenance snapshot-backup prepare

• tsm maintenance snapshot-backup restore

• tsm maintenance validate-resources

• tsm maintenance ziplogs

tsm maintenance backup

创建 Tableau Server 管理的数据的备份。此数据包括 Tableau PostgreSQL 数据库（存储库），其中包含工作簿和用户元数据，以及数据提取（.tde 或 .hyper）文件。此数据不包括配置数据。请参见执行 Tableau Server 的完整备份和还原。

注意：不要在包含外部文件存储的 Tableau Server 安装上使用此命令。请参见使用外部文件存储进行备份和还原。

使用拓扑配置进行优化：

• 将文件存储与管理控制器放在同一节点上可以减少或消除备份过程中在节点之间传输数据的需要，从而缩短备份 Tableau Server 所需的时间。如果您的组织使用许多数据提取，则情况尤其如此。

• 将存储库 (Pgsql) 与管理控制器节点放在同一位置也有助于缩短备份时间，但节省的时间不如文件存储显著。

管理控制器通常位于初始节点上，除非您遇到初始节点故障并且将控制器转移到另一节点。

系统将在数据目录的临时位置中汇编备份文件，并将该文件写入 TSM basefilepath.backuprestore ：

/var/opt/tableau/tableau_server/data/tabsvc/files/backups/

有关备份文件的写入位置以及如何更改该位置的详细信息，请参见tsm File Paths。注意：即使您更改备份位置，备份过程也会使用数据目录中的临时位置来汇编备份文件。

概要

tsm maintenance backup --file

选项

• -f, --file

• 必需。

  有关备份存储库数据的详细信息，请参见备份 Tableau Server 数据。

• -d, --append-date

• 可选。

  将当前日期附加到备份文件名末尾。

  注意：使用计划创建的备份会自动在备份文件名的开头包含日期/时间。如果您还使用 -d 选项，您的文件名将包含日期两次。有关计划备份的详细信息，请参见计划和管理备份。

• -i, --description

• 可选。

  包括备份文件的指定说明。

• --ignore-prompt

• 可选。版本 2020.2 中新增。

  备份而不提示，即使文件存储不在管理控制器所在的同一节点上（通常是初始节点）。如果自动执行备份（例如，使用脚本），请使用此提示。

• -k, --skip-verification

• 可选。

  不验证数据库备份的完整性。

• --multithreaded

• 可选。版本 2021.1 中新增

  默认情况下，创建 Tableau Server 备份时使用单个线程。指定此选项后，将使用多个线程创建备份。默认情况下，如果指定此选项，将使用两个线程。您可以通过设置 backup.zstd.thread_count 配置键来更改使用的线程数。

• --override-disk-space-check

• 可选。

  即使在出现磁盘空间不足警告时也尝试创建备份。

• -po，--pg-only

• 可选。

  只生成存储库备份。

• --request-timeout

• 可选。

  等待命令完成的秒数。默认值为 86400（1440 分钟）。

• -sd, --schedule-days

• 可选。版本 2020.4 中新增。

  运行计划的天数。为每周计划使用 1-7（星期一为 1，星期日为 7），为每月计划使用 1-31（如果一个月不包括指定日期，则使用该月的最后一天）。用逗号分隔多个值。

• -si, --schedule-id

• 可选。版本 2020.4 中新增。

  指定要更新的现有计划的 ID。

• --skip-compression

• 可选。

  在不使用压缩的情况下创建备份。这会生成较大的备份文件，但可以缩短完成备份所花费的时间。如果在多节点安装中使用此选项，我们强烈建议您在初始节点上配置文件存储实例。

• -sn, --schedule-name

• 可选。版本 2020.4 中新增。

  为要创建或更新的计划指定名称。

• -sr, --schedule-recurrence

• 可选。版本 2020.4 中新增。

  计划重复的频率。有效的选项为“daily”、“weekly”或“monthly”。

• -st, --schedule-time

• 可选。版本 2020.4 中新增。

  计划应运行的时间，采用 24 小时格式：HH:MM。

示例

此示例会在 /var/opt/tableau/tableau_server/data/tabsvc/files/backups/ 目录中创建名为 ts_backup- 的备份：

tsm maintenance backup -f ts_backup -d

此示例创建每周六中午运行的名为“weekly-saturday-backup”的定期每周备份计划，并创建名为 的备份：

tsm maintenance backup -f ts_saturday_backup -sr weekly -st 12:00 -sd 6 -sn weekly-saturday-backup

有关管理计划备份的更多详细信息，请参见计划和管理备份。

tsm maintenance cleanup

默认情况下，会删除早于一天的日志文件和临时文件。命令选项可以修改删除哪些文件和保留时间。

此命令的效果取决于 Tableau Server 是否正在运行。如果服务器正在运行，则可以删除大多数旧文件和 http_requests 表条目，但无法删除正在使用的任何文件（由操作系统锁定），因此不会移除临时文件和活动日志文件。若要删除临时文件和当前日志文件，您必须在运行此命令之前停止服务器。

如果在分布式部署中运行 Tableau Server，请在运行管理控制器（也称为 TSM 控制器）进程的节点上运行此命令。默认情况下，控制器位于群集中的初始节点上。

注意：此命令是 Tableau Server 版本 10.5.1 中的新增命令，部分选项是版本 2018.1 中的新增选项。

概要

tsm maintenance cleanup [options] [global options]

选项

• -a, --all

• 可选。

  使用默认保留值执行所有清理操作。相当于使用以下选项运行 cleanup 命令： -l -t -r -q -ic。

• --http-requests-table-retention <天数>

• 可选。

  默认值：7 天

  指定应保留 http_requests 表条目的天数。将此选项与 -q 选项结合敷衍以删除超过指定天数的条目。此选项指定表条目保留期限，但不会触发表条目的实际删除。-q 选项触发条目的删除。

• -ic, --sheet-image-cache

• 可选。版本 2019.4 中新增。

  清除图像缓存。此缓存可以包含脱机预览的图像、订阅电子邮件的快照、订阅 PDF 以及从发布 rest API 端点请求的任何图像（有关详细信息，请参见 rest_api_ref.htm(链接在新窗口中打开)）。

• -l, --log-files

• 可选。

  删除 retention-period 之前的日志文件。将删除 data/tabsvc/logs 下的子目录中的文件。

• --log-files-retention <天数>

• 可选。

  默认值：1（24 小时）

  删除此天数之前的日志。此命令不适用于临时文件。

• -q, --http-requests-table

• 可选。

  删除旧的 http_requests 表条目。Tableau Server 必须正在运行才能删除表条目。如果 Tableau Server 已停止，则会忽略此选项。此选项可单独用于指定删除早于默认保留期（7 天）的条目，或与 --http-requests-table-retention 一起使用来指定非默认保留期。

  注意：删除 http_requests 表条目会永久删除可用于自定义管理视图的数据。确保移除此数据不会影响所需的任何自定义视图。

• -r, --redis-cache

• 可选。

  清除 Redis 缓存。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

• -t, --temp-files

• 可选。

  删除以下目录中的所有文件和子目录：

• /var/opt/tableau/tableau_server/data/tabsvc/temp：只会删除存储已过期（未在运行）会话文件的目录。

• /var/opt/tableau/tableau_server/data/tabsvc/httpd/temp

• /var/opt/tableau/tableau_server/temp

示例

此示例将清理 2 天之前的所有日志文件：

tsm maintenance cleanup -l --log-files-retention 2

tsm maintenance jmx disable

版本：版本 2022.1 中新增的命令。

使用 tsm maintenance jmx disable 命令在 Tableau Server 上禁用 JMX。

运行此命令需要重新启动 Tableau Server，包括 TSM 服务。

概要

tsm maintenance jmx disable [options] [global options]

选项

• --ignore-prompt

• 可选。

  在没有提示的情况下禁用 JMX。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance jmx enable

版本：版本 2022.1 中新增的命令。

使用 tsm maintenance jmx enable 命令在 Tableau Server 上启用 JMX。

此命令是交互式的，如果您不提供它们作为命令行参数，则会提示您输入适用的选项。

此命令需要重新启动 Tableau Server，包括 TSM 服务。

概要

tsm maintenance jmx enable

选项

• --access

• 可选。

  启用具有只读或读写访问权限的 JMX。默认值为 readonly。

• --ignore-prompt

• 可选。

  在不提示其他安全选项的情况下启用 JMX。这将启用带有 SSL 的 JMX 并重新启动 Tableau Server（如果您不包含任何其他命令选项）。例如：

  tsm maintenance jmx enable --ignore-prompt

• --no-ssl

• 可选。

  启用不带 SSL 的 JMX。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

• --ssl-client-auth

• 可选。

  启用需要 SSL 客户端身份验证的 JMX。

• --unsecured

• 可选。

  在未启用安全功能的情况下启用 JMX（不推荐这样做）。在 2022.1 之前的版本中，这相当于将 service.jmx_enabled 配置键设置为 true。

tsm maintenance metadata-services disable

版本：版本 2019.3 中新增的命令。

使用 tsm maintenance metadata-services disable 命令来禁用 Tableau 元数据 API。

禁用元数据 API 会停止持续摄取有关 Tableau Server 上的内容的信息并将其编入索引，删除有关发布到 Tableau Server 的内容及该内容的关联资产的信息，并禁用查询元数据 API 和访问 Tableau Catalog 的功能。

运行此命令并会停止和启动 Tableau Server 使用的某些服务，从而导致某些功能（例如“建议”）对于用户暂时不可用。

概要

tsm maintenance metadata-services disable

选项

• --ignore-prompt

• 可选。

  禁用元数据 API 时关闭确认提示。

tsm maintenance metadata-services enable

版本：版本 2019.3 中新增的命令。

使用 tsm maintenance metadata-services enable 命令为 Tableau Server 启用 Tableau 元数据 API。

如果 Tableau Server 使用 数据管理加载项 获得许可，则启用元数据 API 将会启用 Tableau Catalog。

启用元数据 API 时，有关 Tableau Server 上的内容的信息将被摄取并随后编入元数据 API 存储索引。可以使用元数据 API 来查询有关发布到 Tableau Server 的内容的架构、世系及用户管理的元数据。启用元数据 API 后，系统将会持续地摄取元数据并将其编入索引，直至禁用元数据 API 为止。

运行此命令时，请谨记以下内容：

• 此命令并会停止和启动 Tableau Server 使用的某些服务，从而导致某些功能（例如“建议”）对于用户暂时不可用。

• 每次使用此命令时，系统都会创建新的元数据索引，并替换以前的索引。

有关 Tableau Catalog 的详细信息，请参见关于 Tableau Catalog。

概要

tsm maintenance metadata-services enable

选项

--ignore-prompt

可选。

启用元数据 API 时关闭确认提示。

tsm maintenance metadata-services get-status

版本：版本 2019.3 中新增的命令。

使用 tsm maintenance metadata-services get-status 命令获取有关元数据服务的状态信息。

元数据服务的状态指明元数据 API 存储是否已初始化，或者 Tableau 元数据 API 是否正在运行。

概要

tsm maintenance metadata-services get-status

tsm maintenance reindex-search

使用 tsm maintenance reindex-search 命令建立搜索索引。

概要

tsm maintenance reindex-search [options] [global options]

选项

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance reset-searchserver

将搜索服务器重置为干净状态，同时删除搜索信息并重建搜索索引。

概要

tsm maintenance reset-searchserver [options] [global options]

选项

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance restore

使用指定的备份文件还原 Tableau Server。还原备份文件不会还原任何配置数据。请参见执行 Tableau Server 的完整备份和还原。

您只能从身份存储与运行服务器类型相同的备份中进行还原。例如，使用本地身份验证的服务器中的备份只能还原到使用本地身份验证初始化的 Tableau Server，但使用 Active Directory 身份验证的服务器中的备份无法还原到使用本地身份验证初始化的服务器。

概要

tsm maintenance restore --file

选项

• -f, --file

• 必需。

  指定要还原的备份文件。

  restore 命令需要 TSM basefilepath.backuprestore 变量定义的目录中有备份文件。默认情况下：

  /var/opt/tableau/tableau_server/data/tabsvc/files/backups/

  有关文件路径及其修改方式的详细信息，请参见tsm File Paths。

• -ak, --asset-key-file

• 可选。

  仅当从通过 Tableau Server（版本 2018.1 及更低版本）上的 tabadmin 创建的资产还原时，才指定此选项。

  要从中还原的资产密钥文件的名称。资产密钥文件通过 tabadmin assetkeys 命令创建。该文件必须位于服务器上的预定义备份/还原位置。

• -k, --skip-identity-store-verification

• 可选。仅当从通过 Tableau Server（版本 2018.1 及更低版本）上的 tabadmin 创建的备份文件进行还原时，才指定此选项。

  不要使用此密钥尝试从创建原始备份文件的 Tableau Server 更改身份存储类型。若要更改身份存储，请参见更改身份存储。

• -po，--pg-only

• 可选。

  仅还原存储库。

• -r, --restart-server

• 可选。

  还原后重新启动服务器。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance send-logs

将指定的文件上载到 Tableau 并将其与支持案例相关联。若要成功将文件上载到 Tableau，Tableau Server 必须能够与 https://report-issue.tableau.com 上的 send-logs 服务器进行通信。

概要

tsm maintenance send-logs --case

选项

• -c,--case

• 必需。

  支持案例编号。

• -e,--email

• 必需。

  联系人电子邮件。

• -f, --file

• 必需。

  指定要发送的日志文件存档的位置和名称。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance snapshot-backup complete

版本：版本 2020.1 中新增的命令，仅在针对外部文件存储配置了 Tableau Server 时可用。

在 Tableau Server 上完成快照备份过程。在获取了外部存储的快照备份后运行此项。

tsm maintenance snapshot-backup prepare 和 tsm maintenace snapshot-backup complete 命令用于为配置为包含外部文件存储的 Tableau Server 安装创建 Tableau Server 数据备份。有关详细信息，请参见使用外部文件存储进行备份和还原

概要

tsm maintenance snapshot-backup complete [options] [global options]

选项

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance snapshot-backup prepare

版本：版本 2020.1 中新增的命令，仅在针对外部文件存储配置了 Tableau Server 时可用。

准备快照备份。准备步骤完成后，您可以对网络存储进行快照备份。

tsm maintenance snapshot-backup prepare 和 tsm maintenace snapshot-backup complete 命令用于为配置为包含外部文件存储的 Tableau Server 安装创建 Tableau Server 数据备份。有关详细信息，请参见使用外部文件存储进行备份和还原

概要

tsm maintenance snapshot-backup prepare [options] [global options]

选项

• --include-pg-backup

• 可选。

  系统会创建存储库的备份，并将其复制到网络共享。这仅适用于配置了外部存储库和外部文件存储的部署。有关详细信息，请参见使用外部文件存储进行备份和还原。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance snapshot-backup restore

版本：版本 2020.1 中新增的命令，仅在针对外部文件存储配置了 Tableau Server 时可用。

将存储库备份从存储快照还原到 Tableau Server。

有关详细信息，请参见使用外部文件存储进行备份和还原。

概要

tsm maintenance snapshot-backup restore [options] [global options]

选项

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance validate-backup-basefilepath

版本：版本 2022.1 中新增的命令。

验证备份/还原基本文件路径位置是否具有正确的权限，以允许备份和还原功能正常工作。在设置备份和还原的基本文件路径后运行此命令。有关详细信息，请参见tsm maintenance validate-backup-basefilepath。

概要

tsm maintenance validate-backup-basefilepath [options][global options]

选项

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance validate-resources

验证站点的工作簿和数据源。在迁移站点之前使用此命令，以检测站点资源（例如工作簿和数据源）将导致站点导入失败的问题。某些资源问题可以通过从本地源重新发布来纠正。其他问题可能需要 Tableau 支持的协助。

概要

tsm maintenance validate-resources --site-id

选项

• -id,--site-id

• 必需。

  要验证其资源的站点的 ID。

• -r,--repair

• 可选。

  尝试修复无效资源。输出中会注明无法修复的资源。

• --request-timeout

• 可选。

  等待指定的时间以完成命令。

tsm maintenance ziplogs

使用 ziplogs 命令创建 Tableau Server 日志文件的存档。

注意：如果无法成功运行 ziplogs 命令，则可以手动压缩 Tableau Server 日志。有关详细信息，请参见Linux 上的 Tableau Server 疑难解答。

概要

tsm maintenance ziplogs [options] [global options]

选项

• -a, --all

• 可选。

  包括除 PostgreSQL 数据以外的所有文件。

• -d, --with-postgresql-data

• 可选。

  如果 Tableau Server 已停止，则包括 PostgreSQL 数据文件夹，如果 Tableau Server 正在运行，则包括 PostgreSQL 转储文件。

• --enddate

• 可选。版本 2019.3 中新增。时间选项 (H:mm) 在版本 2021.4.0 中添加。

  要包括的日志文件的最后日期。此选项必须与 --startdate 结合使用，不能与 --minimumdate 一起使用。如果未指定此选项，则最多包含两天的日志（从 00:00 GMT 开始）。

• -f, --file

• 可选。

  指定压缩存档文件的名称。如果没有提供名称，则将存档创建为 logs.zip。文件将写入 TSM basefilepath.log_archive 变量中定义的目录。默认情况下：

  /var/opt/tableau/tableau_server/data/tabsvc/files/log-archives/

  有关文件路径及其修改方式的详细信息，请参见tsm File Paths。

• -i, --description

• 可选。

  包括存档文件的指定说明。

• -l, --with-latest-dump

• 可选。

  当任何服务崩溃时，Tableau Server 会生成一个转储文件。设置此选项以包括最近服务崩溃转储文件。如果未设置此选项，则生成的 ziplog 中将不包括任何转储文件。

• -m, --minimumdate

• 可选。

  要包括的日志文件的最早日期。如果未指定，则最多包含两天的日志文件。日期格式应为“mm/dd/yyyy”。此选项不能与 --startdate 和 --enddate 或 --all 一起使用。

• --nodes

• 可选。版本 2020.3 中新增。

  指定要为其创建备份的节点。如果未指定，则为所有节点创建备份并保存到初始节点。用逗号分隔多个节点。例如，若要收集节点 2 和 4 的日志：

  tsm maintenance ziplogs --nodes node2,node4

• -o, --overwrite

• 可选。

  用于覆盖现有的 ziplog 文件。如果已经存在同名的文件，并且未使用此选项，则 ziplogs 命令将失败。

  默认情况下会将文件写入到：

  /var/opt/tableau/tableau_server/data/tabsvc/files/log-archives/

  有关文件路径及其修改方式的详细信息，请参见tsm File Paths。

• --request-timeout <秒数>

• 可选。

  等待命令完成的秒数。默认值为 7200（120 分钟）。

• --startdate

• 可选。版本 2019.3 中新增。时间选项（H:mm) 在版本 2021.4.0 中添加。

  要包括的日志文件的最早日期。此选项必须与 --enddate 结合使用，不能与 --minimumdate 一起使用。如果未指定此选项，则最多包含两天的日志（从 00:00 GMT 开始）。

全局选项

• -h, --help

• 可选。

  显示命令帮助。

• -p, --password

• 在会话不是活动状态的情况下为必需，-u 或 --username 也为必需。

  为在 -u 或 --username 中指定的用户指定密码。

  如果密码包括空格或特殊字符，请将其括在引号中：

  --password 'my password'

• -s, --server https://

• 可选。

  对 Tableau 服务管理器使用指定的地址。URL 必须以 https 开头，包括端口 8850，并使用服务器名称（而不是 IP 地址）。例如，https://。如果没有指定服务器，则假定为 https://。

• --trust-admin-controller-cert

• 可选。

  使用此标志来信任 TSM 控制器上的自签名证书。有关证书信任和 CLI 连接的详细信息，请参见 连接 TSM 客户端。

• -u, --username

• 在会话不是活动状态的情况下为必需，-p 或 --password 也为必需。

  指定用户帐户。如果未包括此选项，则使用您登录所使用的凭据运行该命令。