tsm maintenance


您可以使用 tsm maintenance 命令來管理伺服器維護工作，例如建立備份或從先前建立的備份還原 Tableau Server。

tsm maintenance backup

建立 Tableau Server 管理的資料的備份。此資料包括 Tableau PostgreSQL 資料庫（存放庫），其中包含工作簿和使用者中繼資料以及擷取檔案（2024.2 及更早版本的 .hyper 檔案和 .tde 檔案）。此資料不包含設定資料。請參閱執行 Tableau Server 的完整備份和還原。

附註：透過外部檔案存放區安裝 Tableau Server 時，請勿使用此命令。請參閱使用外部檔案存放區進行備份與還原。

使用拓撲設定進行最佳化：

  • 將檔案存放區與管理控制器放置於相同的節點，可減少或消除備份過程中在節點之間傳輸資料的需求，從而縮短備份 Tableau Server 的時間。若您的組織使用許多擷取，情況尤其如此。
  • 將存放庫 (pgsql) 與管理控制器節點放置於相同的位置，也有助於縮短備份時間，但節省的時間遠遠少於檔案存放區可節省的時間。

除非發生初始節點故障，且您已將控制器移至另一個節點，否則管理控制器通常位於初始節點上。

備份檔案會在資料目錄中的臨時位置組合，然後寫入 TSM 變數中定義的目錄 basefilepath.backuprestore ：

/var/opt/tableau/tableau_server/data/tabsvc/files/backups/<filename>.tsbak

有關備份檔案寫入位置以及其修改方式的詳情，請參閱 tsm File Paths。附註：即使您變更備份位置，備份程序也會使用資料目錄中的臨時位置來組合備份檔案。

概要

tsm maintenance backup --file <backup_file> [options] [global options]

選項

-f, --file <backup_file>

必要。

有關備份存放庫資料詳情，請參閱備份 Tableau Server 資料。

-d, --append-date

可選。

將目前日期附加到備份檔案名稱的末尾。

附註：使用排程建立的備份會自動在備份檔案名稱的開頭包含日期/時間。若還使用 -d 選項，檔案名稱將包含兩次日期。有關排程備份的更多資訊，請參閱排程和管理備份。

-i, --description <string>

可選。

包括備份檔案的指定說明。

--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 <timeout in seconds>

可選。

等待命令完成的秒數。預設值為 86400（1440 分鐘）。

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

可選。2020.4 版新增功能。

執行排程的日期。每週排程使用 1-7 表示（星期一為 1，星期日為 7），每月排程使用 1-31 表示（如果一個月不包括指定天數，則使用該月的最後一天）。請用逗號分隔多個數值。

-si, --schedule-id <ID>

可選。2020.4 版新增功能。

指定要更新的現有排程 ID。

--跳過-壓縮

可選。

不使用壓縮建立備份。這會產生較大的備份檔案，但是可以縮短備份完成的時間。若在多節點安裝中使用此操作，強烈建議您在初始節點上設定檔案存放區執行個體。

-sn, --schedule-name <name>

可選。2020.4 版新增功能。

為要建立或更新的排程指定名稱。

-sr, --schedule-recurrence <frequency>

可選。2020.4 版新增功能。

排程重複的頻率。可選的選項是「daily」、「weekly」或「monthly」。

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

可選。2020.4 版新增功能。

排程時間格式應為 24 小時制：HH:MM。

範例

此範例會在 /var/opt/tableau/tableau_server/data/tabsvc/files/backups/ 目錄中建立名為 ts_backup-<yyyy-mm-dd>.tsbak 的備份：

tsm maintenance backup -f ts_backup -d

此範例建立名為「weekly-saturday-backup」的重複每週備份排程，該排程每週六中午執行，並建立名為 <yyyy.mm.dd.hh.mm>-ts_saturday_backup.tsbak 的備份：

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

有關管理已排程備份的詳情，請參閱排程和管理備份。

tsm maintenance cleanup

預設情況下，tsm maintenance cleanup 命令會刪除超過一天的暫存檔案和記錄檔。命令選項可以修改保留時長以及刪除哪些檔案。

這項命令的影響需視 Tableau Server 是否正在執行而定。

  • 如果伺服器正在執行多數的舊檔案，則 http_requests 表項目可以刪除，但正在使用中的檔案無法刪除（由作業系統鎖定），因此您無法移除暫存檔案和有效記錄檔。若要刪除暫存檔和目前的記錄檔，您必須先停止伺服器，再執行此命令。要刪除 http_requests 表項目，請使用 -q 選項。
  • 如果伺服器停止，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 選項一起使用以指定表項目要保留的天數，覆寫預設的 7 天。此選項可指定表項目保留天數，但無法觸發表項目的刪除動作。將此與 -q 選項一起使用，會觸發項目的刪除。

-ic, --sheet-image-cache

可選。2019.4 版新增功能。

清除影像快取。此快取可包含離線預覽的影像、訂閱電子郵件訊息的快照、訂閱 PDF，以及任何從發佈 REST API 端點要求的影像（有關詳情請參閱 rest_api_ref.htm(連結在新視窗開啟)）。

-l, --log-files

可選。

刪除超過一天的記錄檔。將刪除 data/tabsvc/logs 下的子目錄中的檔案。

--log-files-retention <天數>

可選。

預設值：1（24 小時）

刪除此天數之前的記錄。使用此選項可以覆寫 1 天的預設保留期。此命令不適用於暫封存。

-q, --http-requests-table

可選。

刪除舊的 http_requests 表項目。必須行 Tableau Server 才能刪除表項目。如果停止 Tableau Server，則忽略此選項。這個選項可單獨用於指定刪除早於預設保留期（7 天）的項目，或搭配 --http-requests-table-retention 來指定非預設保留期。

附註： 刪除 http_requests 表項目會永久移除自訂管理檢視中的可用資料。請務必確認移除此資料不會影響所需的任何自訂檢視。

-r, --redis-cache

可選。

清除 Redis 快取。

--request-timeout <timeout in seconds>

可選。

預設值：3600

等待指定的時間以完成命令。

-t, --temp-files

可選。

刪除以下目錄中的所有檔案和子目錄：

  • /var/opt/tableau/tableau_server/data/tabsvc/temp：若要刪除每個 Tableau Server 流程目錄下的檔案，必須在執行命令之前停止 Tableau Server。若在 Tableau Server 執行時執行命令，則只會刪除儲存過期（未執行）工作階段之檔案的目錄。

  • /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 <timeout in seconds>

可選。

等待指定的時間以完成命令。

tsm maintenance jmx enable

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

使用 tsm maintenance jmx enable 命令於 Tableau Server 啟用 JMX。

此命令是互動式的，如果不將它們作為命令列參數提供，則會提示輸入適用的選項。

此命令需要重新啟動 Tableau Server，包括 TSM 服務。

概要

tsm maintenance jmx enable

選項

- 存取 <readonly | readwrite>

可選。

啟用具有唯讀或讀寫存取權限的 JMX。預設值為 readonly。

--ignore-prompt

可選。

在不提示其他安全選項的情況下啟用 JMX。如果不包含任何其他命令選項，這將啟用帶有 SSL 的 JMX 並重新啟動 Tableau Server。例如：

tsm maintenance jmx enable --ignore-prompt

--no-ssl

可選。

啟用不帶 SSL 的 JMX。

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。

--ssl-client-auth

可選。

啟用需要 SSL 用戶端身份驗證的 JMX。

--不安全

可選。

在未啟用安全功能的情況下啟用 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 <timeout in seconds>

可選。

等待指定的時間以完成命令。

tsm maintenance reset-searchserver

版本：「搜尋」與「瀏覽」（也稱「搜尋伺服器」）停用時，此命令已於 2023.3.0 停用（移除）。已使用「索引和搜尋伺服器」取代「搜尋」與「瀏覽」。

附註：在 2023.3.0 或更高版本中執行此命令不會有任何動作。

將搜尋伺服器重置為清除狀態，刪除搜尋資訊並重新搜尋索引。

概要

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

選項

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。

tsm maintenance restore

使用指定的備份檔案還原 Tableau Server。還原備份檔案並不會還原任何設定資料。請參閱執行 Tableau Server 的完整備份和還原。

您只能從識別身分存放區與執行伺服器類型相同的備份中進行還原。例如，使用本機驗證的伺服器中的備份只能還原到使用本機驗證初始化的 Tableau Server，但使用 Active Directory 驗證的伺服器中的備份無法還原到使用本機驗證初始化的伺服器。

從版本 2022.3 開始，不支援使用 tabadmin 建立的備份（「TSM 之前的備份」）。無法將 TSM 之前的備份還原到 Tableau Server 版本 2022.3 或更高版本。

概要

tsm maintenance restore --file <file_name> [--restart-server] [global options]

選項

-f, --file <file_name>

必要。

指定要還原的備份檔案。

restore 命令需要 TSM basefilepath.backuprestore 變數定義的目錄中有備份檔案。預設情況下：

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

有關檔案路徑及其修改方式的詳情，請參閱tsm File Paths。

-ak, --asset-key-file <file_name>

可選。在版本 2021.4.0 中已棄用。

唯有在您要從 Tableau Server (2018.1 及更早版本) 所建立的資產進行還原時，才指定這個選項。

要還原之資產金鑰檔案的名稱。資產金鑰檔案是由 tabadmin assetkeys 命令所建立。檔案必須位於伺服器中預先定義的備份/還原位置。

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

可選。唯有在您要從 Tableau Server (2018.1 及更早版本) 所建立的備份檔案還原時，才指定這個選項。

請不要使用此金鑰嘗試在建立原始備份檔案的 Tableau Server 中變更識別身份存放類型。若要變更識別身份存放區，請參閱變更識別身分存放區。

-po, --pg-only

可選。

僅還原存放庫。

-r, --restart-server

可選。

還原後重新啟動伺服器。

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。

tsm maintenance send-logs

將指定的檔案上傳到 Tableau 並將其與支援案例相關聯。若要順利將檔上傳至 Tableau，Tableau Server 必須能夠與傳送記錄伺服器進行通訊：https://report-issue.tableau.com。

概要

tsm maintenance send-logs --case <case_number> --email <contact_email> --file <path/to/file> [global options]

選項

-c,--case <case_number>

必要。

支援案例編號。

-e,--email <contact_email>

必要。

連絡人電子郵件。

-f, --file <path/to/file>

必要。

指定要傳送的記錄檔案封存的位置和名稱。

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。

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 <timeout in seconds>

可選。

等待指定的時間以完成命令。

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

可選。在版本 2021.1 中新增。先前的版本總是包含外部存放庫的備份。

可選。

對存放庫進行備份，並複製到網路共用。這僅適用於已同時設定外部存放庫和外部檔案存放區的部署。有關詳情，請參閱使用外部檔案存放區進行備份與還原。

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。

tsm maintenance snapshot-backup restore

版本：在 2020.1 版中新增的命令，只有為外部檔案儲存體設定 Tableau Server 時才可用。

會將存放庫備份從儲存體快照還原到 Tableau Server。

有關詳情，請參閱使用外部檔案存放區進行備份與還原。

概要

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

選項

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。

tsm maintenance validate-backup-basefilepath

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

驗證備份/還原基本檔案路徑位置是否具有正確的權限，以允許備份和還原功能正常工作。在設定備份和還原的基本檔案路徑後執行它。有關詳情，請參閱變更當前檔案位置。

概要

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

選項

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。

tsm maintenance validate-resources

驗證網站的工作簿和資料來源。在遷移網站之前使用此命令，檢測導致網站匯入失敗的網站資源（如工作簿和資料來源）問題。某些資源問題可以透過本機來源重新發佈加以更正。其他問題可能需要 Tableau 支援部門的協助。

概要

tsm maintenance validate-resources --site-id <site ID> [global options]

選項

-id,--site-id <site ID>

必要。

要驗證其資源的網站的 ID。

-r,--repair

可選。

嘗試修復無效資源。無法修復的，會在輸出中予以註明。

--request-timeout <timeout in seconds>

可選。

等待指定的時間以完成命令。

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 轉儲檔案。對於使用 Tableau Server 外部存放庫執行的部署，將忽略此標幟。

--enddate "<mm/dd/yyyy H:mm>"

可選。時間選項（H:mm) 已在版本 2021.4.0 中新增。

要包含的記錄檔的最晚日期。此選項必須與 --startdate 搭配使用，且無法與 --minimumdate 一起使用。若未指定此選項，則最多包含兩天的記錄檔，從 00:00 GMT 開始。

若包含時間選項，則必須在日期和時間周圍使用引號。時間選項使用 GMT，但是，產生的記錄檔將使用 Tableau Server 電腦的本機時區寫入。

範例：如果 Tableau Server 電腦的本機時區是 PDT，您希望記錄檔在 2022 年 7 月 28 日太平洋夏令時間上午 7 點開始並在太平洋夏令時間晚上 7 點結束，請使用以下命令：

tsm maintenance ziplogs -f logs.zip --startdate "07/28/2022 14:00" --enddate "07/29/2022 02:00"

-f, --file <name>

可選。

指定壓縮封封存的名稱。如果沒有提供名稱，則將封存建立為 logs.zip。檔案將寫入 TSM basefilepath.log_archive 變數中定義的目錄。預設情況下：

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

有關檔案路徑及其修改方式的詳情，請參閱tsm File Paths。

-i, --description <string>

可選。

包括封存檔案的指定說明。

-l, --with-latest-dump

可選。

有任何服務當機時，Tableau Server 就會產生傾印檔案。設定此選項可包括最新的服務當機傾印檔案。如未設定此選項，所產生的 ziplog 就不會包括任何傾印檔案。

-m, --minimumdate <mm/dd/yyyy>

可選。

要包括的記錄檔案的最早日期。如果未指定，則最多包含兩天的記錄檔案。日期格式應為「mm/dd/yyyy」。此選項無法與 --startdate 和 --enddate 或 --all 一起使用。

--nodes

可選。2020.3 版新增功能。

請指定要為其建立 ziplog 檔案的節點。若未指定，則為所有節點建立 ziplog 檔案，並儲存到初始節點。用逗號分隔節點。例如，要收集節點 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 <seconds>

可選。

等待命令完成的秒數。預設值為 7200（120 分鐘）。

--startdate "<mm/dd/yyyy H:mm>"

可選。時間選項（H:mm) 已在版本 2021.4.0 中新增。

要包含的記錄檔的最晚日期。此選項必須與 --enddate 搭配使用，且無法與 --minimumdate 一起使用。若未指定此選項，則最多包含兩天的記錄檔，從 00:00 GMT 開始。

若包含時間選項，則必須在日期和時間周圍使用引號。時間選項使用 GMT，但是，產生的記錄檔將使用 Tableau Server 電腦的本機時區寫入。

範例：如果 Tableau Server 電腦的本機時區是 PDT，您希望記錄檔在 2022 年 7 月 28 日太平洋夏令時間上午 7 點開始並在太平洋夏令時間晚上 7 點結束，請使用以下命令：

tsm maintenance ziplogs -f logs.zip --startdate "07/28/2022 14:00" --enddate "07/29/2022 02:00"

 

全域選項

-h, --help

可選。

顯示命令說明。

-p, --password <password>

在會話不是活動狀態的情況下為必需，-u 或 --username 也為必需。

為在 -u 或 --username 中指定的使用者指定密碼。

如果密碼包括窗格或特殊字元，請將其括在引號中：

--password 'my password'

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

可選。

對 Tableau 服務管理器使用指定的位址。URL 必須以 https 開頭（包括連接埠 8850），並使用伺服器名稱而不是 IP 位址。例如 https://<tsm_hostname>:8850。如果沒有指定伺服器，則假定為 https://<localhost | dnsname>:8850。

--trust-admin-controller-cert

可選。

使用此旗標來信任 TSM 控制器上的自我簽署憑證。如需有關憑證信任和 CLI 連線的詳細資訊，請參閱連接 TSM 用戶端。

-u, --username <user>

在會話不是活動狀態的情況下為必需，-p 或 --password 也為必需。

請指定使用者名稱。如果未包括此選項，則使用您登入所使用的認證執行該命令。

 

返回頂端
感謝您的意見反應！已成功提交您的意見回饋。謝謝！