---
schema_version: "1"
id: a446c6b8c9ae7751c9dc4a7e680ba5dad8b88222578b79028ea52b368a2df4eb
title: tabcmd 命令
collection: tableau
version: next
locale: zh-tw
portal_url: https://docs.salesforce.com/tableau/next/zh-tw/server/tabcmd_cmd.md
canonical_url: https://help.tableau.com/v0.0/server/zh-tw/tabcmd_cmd.htm
source_site: help.tableau.com
content_type: documentation
content_hash: d64ed9413ad3fd208327f018b790133c5aac9566a4106653d708d7e02dbd582a
description: Reference for tabcmd commands and their options.
---
[跳至主要內容](#main-content)

# tabcmd 命令

**附註：**tabcmd 命令列公用程式版本 2.0 可從 [Tableau tabcmd](https://tableau.github.io/tabcmd) 取得。此新版本可讓您在 MacOS 和 Linux 上執行 tabcmd 命令，並使用個人存取權杖 (PAT) 進行驗證。版本 2.0 依據基於 Python 的 Tableau Server 用戶端 (TSC) 中可用的公用端點建置。此最新版本對 Tableau Server 的支援有限。

要在 Linux 上尋找 Tableau Server？請參閱 [tabcmd 命令](https://help.tableau.com/current/server-linux/zh-tw/tabcmd_cmd.htm "在新瀏覽器索引標籤中開啟主題").

您可以透過 tabcmd 命令列工具使用以下命令：

[addusers](#id1999d76f-638e-47d4-86ac-fe8e206ed364)（至群組）  
[createextracts](#id5a3316ed-45bb-4da4-b557-1111112d4ac8)  
[creategroup](#idbfa546df-2be7-444f-8bb8-07978b127783)  
[createproject](#id5a3316ed-45bb-4da4-b557-58492b2d4ac8)  
[createsite](#id6f434e96-89d1-4aa2-a935-4c22fa1e2506)  
[createsiteusers](#idd1b7729f-dd20-475a-96f6-17fcd2577894)  
[createusers](#ide42a948a-cd9c-4b73-9ef2-3a58eda2d095)  
[decryptextracts](#decryptextracts_tabcmd)  
[delete _workbook-name_ 或 _datasource-name_](#idfdf59712-84ed-4590-9471-541d316917a6)  
[deleteextracts](#id5a3316ed-45bb-4da4-b557-2222222d4ac8)  
[deletegroup](#id0d009916-bee3-4ef0-a6ac-22188c0e7f30)  
[deleteproject](#idfdf59712-84ed-4590-9471-541d316917a6)  
[deletesite](#id54a7f404-5d1b-452e-8273-0ab8396da641)  
[deletesiteusers](#deletesiteusers)  
[deleteusers](#id6a8ef3d6-d17b-4c31-be47-7b09437eeec0)  
[editdomain](#editdomain)  
[editsite](#id06d8e2e0-d7a1-4733-b0df-d1e02f66919b)  
[encryptextracts](#encryptextracts_tabcmd)  
[export](#id7cb8d032-a4ff-43da-9990-15bdfe64bcd0)  
[get _url_](#id7e0a0627-ad89-4135-a1c2-85b1d8472568)  
[initialuser](#initialuser)  
[listdomains](#listdomains)  
[listsites](#idc7467cb6-6cef-49bf-9358-a3e4addd5fa0)  
[login](#id5fba51c9-5608-4520-8ceb-2caf4846a2be)  
[logout](#id8f512aec-57a4-4ed4-94c4-86e91ea9cc9c)  
[publish](#iddf805b62-18ff-4497-9245-adc6905b2084)  
[publishsamples](#publishsamples)  
[reencryptextracts](#reencryptextracts_tabcmd)  
[refreshextracts](#id4cdb3410-1c41-4dad-b1d2-306542ac9b32)  
[removeusers](#id5cc30cba-44b8-48b0-93d6-5707938d157a)  
[reset\_openid\_sub](#reset_sub)  
[runschedule](#idd9d99c44-c9be-4191-9191-402341775a3d)  
[set](#idfe12acaf-ed64-4f0c-8eb8-b83c9de12382)  
[syncgroup](#ide6a39f29-77ff-44f6-b946-c2b56b31a2f9)  
[upgradethumbnails](#upgradethumbnails)  
[validateidpmetadata](#validateidp)  
[version](#id825f5d18-529c-408a-b876-57693195bbdd)

## addusers _group-name_

將使用者新增到指定的群組。

**範例**

`tabcmd addusers "Development" --users "users.csv"`

### 選項

`--users`

將給定 `.csv` 檔中的使用者新增到指定組中。該檔案應是每行一個使用者名的簡單清單。使用者名稱不區分大小寫。使用者應已在 Tableau Server 上建立。

如果在 Tableau Server 上將此命令用於大型 `.csv` 檔案，則伺服器管理員可啟用說明改善性能的設定。

有關詳情，請參閱 [CSV 匯入檔案指導方針](https://help.tableau.com/v0.0/server/zh-tw/csvguidelines.htm)。

`--[no-]complete`

當設定為 `complete` 時，此選項要求所有列都必須有效，變更才能成功。如果未指定，則使用 `--complete`。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## createextracts

為已發佈的工作簿或資料來源建立擷取。

### 選項

`-d`, `--datasource`

用於擷取建立的目標資料來源名稱。

`--embedded-datasources`

目標工作簿中的嵌入資料來源清單（以空格分隔）。若資料來源名稱包含空格，則以雙引號括起來。只有在針對工作簿建立擷取時可用。

`--encrypt`

建立加密的擷取。

`--include-all`

在目標工作簿中包括所有嵌入資料來源。只有在針對工作簿建立擷取時可用。

`--parent-project-path`

包含目標資源之專案的父專案路徑。必須使用 --project 指定專案名稱。

`--project`

包含目標資源的專案的名稱。唯有在指定 --workbook 或 --datasource 時才有需要。如果未指定，則使用預設專案 'Default'。

`-u`, `-url`

顯示在 URL 中的資源的正式名稱。

`-w`, `-workbook`

用於擷取建立的目標工作簿名稱。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## creategroup _group-name_

建立一個群組。使用 `addusers`（用於本機群組）在建立群組後新增使用者。 使用 `syncgroup`（用於 Active Directory 群組）建立 Tableau Server 群組，並與 Active Directory 群組同步。

**範例**

`tabcmd creategroup "Development"`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## createproject _project-name_

建立一個專案。

**範例**

`tabcmd createproject -n "Quarterly_Reports" -d "Workbooks showing quarterly sales reports."`

### 選項

`-n`, `--name`

指定要建立的專案的名稱。

`--parent-project-path`

使用 `-n` 選項指定時，指定巢狀專案的父專案名稱。例如，若要指定存在於「Main」專案中名稱為「Nested」的專案，請使用以下語法：`--parent-project-path "Main" -n "Nested"`。

`-d`, `--description`

為專案指定說明。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## createsite _site-name_

建立一個網站。

**範例**

建立名為 West Coast Sales 的網站。系統會自動建立網站 ID `WestCoastSales`，該網站沒有存儲配額限制，且網站管理員可以新增和移除使用者：

`tabcmd createsite "West Coast Sales"`

使用 `wsales` 的網站 ID 建立名為 `West Coast Sales` 的網站：

`tabcmd createsite "West Coast Sales" -r "wsales"`

阻止網站管理員向網站新增使用者：

`tabcmd createsite "West Coast Sales" --no-site-mode`

設定存儲配額（以 MB 為單位）：

`tabcmd createsite "West Coast Sales" --storage-quota 100`

### 選項

`-r`, `--url`

在網址中使用以指定網站。不同於網站名稱。

`--user-quota`

新增到該網站的使用者的最大數量。

`--[no-]site-mode`

允許或拒絕網站管理員向網站新增使用者或從中移除使用者。

`--storage-quota`

網站上可儲存的工作簿、擷取和資料來源的數量，以 MB 為單位。

`--extract-encryption-mode`

可以**強制執行**、**啟用**或**停用**網站的擷取加密模式。有關詳情，請參閱[靜態擷取加密](https://help.tableau.com/v0.0/server/zh-tw/security_ear.htm)。

`--run-now-enabled`

允許或拒絕使用者手動執行擷取重新整理、流程或排程。**true** 允許使用者手動執行工作或 **false** 阻止使用者手動執行工作。有關詳情，請參閱[伺服器設定（常規與自訂）](https://help.tableau.com/v0.0/server/zh-tw/maintenance_set.htm)。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## createsiteusers _filename.csv_

根據逗號分隔值 (CSV) 檔中提供的資訊將使用者新增到網站。如果尚未在伺服器中建立該使用者，則該命令會在將使用者新增至該站台前建立該使用者。

CSV 檔案必須包含一個或多個使用者名，還可（為每個使用者）包括一個密碼、全名、授權類型、管理員層級、發佈者（是/否），以及電子郵件地址。有關 CSV 檔案的格式的資訊，請參閱 [CSV 匯入檔案指導方針](https://help.tableau.com/v0.0/server/zh-tw/csvguidelines.htm)。

作為在 CSV 檔案中包括管理員層級和發佈者權限的替代方法，您可以透過包括 `--role` 選項並指定要為 CSV 檔案中列出的使用者分配的網站角色來傳遞存取層級資訊。

預設情況下，使用者將新增到您登入的站台。若要將使用者新增到其他網站，請包括全域 `--site` 選項並指定該網站。（您必須具有在指定的網站上建立使用者的使用權限。）

如果伺服器包含多個站台，則無法使用 `createsiteusers` 命令新增伺服器（系統）管理員。請改用 `createusers`。如果為 `--role` 選項指定 `ServerAdministrator` 站台角色，則命令將返回錯誤。如果 CSV 檔案包括 `System` 作為 administrator 的值，則該值將被忽略，並且會為使用者指派 `Unlicensed` 授權類型。

如果伺服器只包含一個網站（預設網站），您可以為使用者的 administrator 值指定 `system`，或者，如果希望 CSV 檔案中的所有使用者都成為伺服器管理員，您甚至可以使用 `--role` 選項指派 `ServerAdministrator` 站台角色。

預設情況下，此命令使用同步操作建立使用者（它將等待所有操作完成才會繼續）。您可以使用 `--no-wait` 選項指定非同步作業。

### 改善大型 CSV 檔案的效能

伺服器管理員可以使用 `tabadmin set` 命令啟用設定，幫助改善大型 CSV 檔案的效能。有關詳情，請參閱「CSV 匯入檔案準則」主題中的[提高透過 tabcmd 傳遞的大型 CSV 檔案的效能](https://help.tableau.com/v0.0/server/zh-tw/csvguidelines.htm#improve-performance-large-csv)。

### 本機驗證

如果伺服器設定為使用本機驗證，則使用 CSV 檔案中的資訊建立使用者。

### Active Directory 驗證

如果伺服器設定為使用 Active Directory 驗證，則會從 Active Directory 匯入使用者資訊，並忽略 CSV 檔案中的密碼和友好名稱資訊。此外，如果 CSV 檔案中指定了使用者，但 Active Directory 中沒有相應的使用者，則不會將該使用者新增到 Tableau Server。對於 Active Directory 使用者，由於不能保證使用者名在網域之間的唯一性，因此必須包括網域作為使用者名的一部分。您可以將此項指定為 `domain\username` 或 `username@domain.com`；但是，我們建議使用 `domain\username` 格式。有關詳情，請參閱[使用外部識別身分存放區進行部署中的使用者管理](https://help.tableau.com/v0.0/server/zh-tw/users_manage_ad.htm)。

**範例**

`tabcmd createsiteusers "users.csv" --role "Explorer"`

### 選項

`--admin-type`

已棄用。請改用 `--role` 選項。

`--auth-type`

為 `.csv` 檔中的所有使用者設定驗證類型（`Local` 或 `SAML`）。如果未指定，則預設值為 `Local`。

**附註：**要使用 SAML 驗證，必須在 Tableau Server 設定中將站台設定為使用站台特定的 SAML。有關資訊，請參閱[設定特定於網站的 SAML](https://help.tableau.com/v0.0/server/zh-tw/saml_site_specific.htm)。

`--[no-]complete`

已棄用。預設錯誤行為：如果在十行範圍內有 3 個或更多錯誤，則命令將失敗。

`--no-publisher`

已棄用。請改用 `--role` 選項。

`--nowait`

不等待非同步作業完成。

`--publisher`

已棄用。請改用 `--role` 選項。

`--role`

為 `.csv` 中的所有使用者指定站台角色。如果要使用 --role 選項指派站台角色，請為每個站台角色建立單獨的 CSV 檔案。

有效的值為：`ServerAdministrator`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `SiteAdministrator`, `Creator`, `ExplorerCanPublish`, `Publisher`, `Explorer`, `Interactor`, `Viewer`, and `Unlicensed`.

對於新使用者，預設值為 `Unlicensed`，對於現有使用者，預設值不變。如果有基於使用者的伺服器安裝，並且在 `createsiteusers` 命令建立新使用者的情況下您已達到使用授權數的限制，則會以未授權使用者的形式新增該使用者。

**附註：**在多網站 Tableau Server 上，如果要使用 `--role` 選項指派 `ServerAdministrator` 站台角色，請使用 [`createusers`](#createusers) 命令，而不是 `createsiteusers`。

`--silent-progress`

不顯示命令的進度訊息。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## createusers _filename.csv_

基於逗號分隔值 CSV 檔案中提供的資訊在 Tableau Server 中建立使用者。

CSV 檔案必須包含一個或多個使用者名，還可（為每個使用者）包括一個密碼、全名、授權類型、管理員層級、發佈者（是/否），以及電子郵件地址。有關 CSV 檔案的格式的資訊，請參閱 [CSV 匯入檔案指導方針](https://help.tableau.com/v0.0/server/zh-tw/csvguidelines.htm)。

作為在 CSV 檔案中包括管理員層級和發佈者權限的替代方法，您可以透過包括 `--role` 選項並指定要為 CSV 檔案中列出的使用者分配的網站角色來傳遞存取層級資訊。

如果伺服器只有一個網站（預設網站），則會建立使用者並將其新增到網站。如果伺服器有多個站台，則會建立該使用者，但不會將其新增到任何站台。若要將使用者新增到網站，請使用 [`createsiteusers`](#createsiteusers)。

如果有以使用者為基礎的的伺服器安裝，並且在命令建立新使用者的情況下您已達到使用授權數的限制，則會在未授權使用者的形式新增該使用者。

### 本機驗證

如果伺服器設定為使用本機驗證，則使用 CSV 檔案中的資訊建立使用者。

### Active Directory 驗證

如果伺服器設定為使用 Active Directory 驗證，則會從 Active Directory 匯入使用者資訊，並忽略 CSV 檔案中的密碼和友好名稱資訊。此外，如果 CSV 檔案中指定了使用者，但 Active Directory 中沒有相應的使用者，則不會將該使用者新增到 Tableau Server。對於 Active Directory 使用者，由於不能保證使用者名在網域之間的唯一性，因此必須包括網域作為使用者名的一部分。您可以將此項指定為 `domain\username` 或 `username@domain.com`；但是，我們建議使用 `domain\username` 格式。有關詳情，請參閱[使用外部識別身分存放區進行部署中的使用者管理](https://help.tableau.com/v0.0/server/zh-tw/users_manage_ad.htm)。

**範例**

`tabcmd createusers "users.csv" --role "ServerAdministrator"`

`tabcmd createusers "users.csv"`

### 選項

`--admin-type`

已棄用。請改用 `--role` 選項。

`--[no-]complete`

已棄用。預設錯誤行為：如果在十行範圍內有 3 個或更多錯誤，則命令將失敗。

`--no-publisher`

已棄用。請改用 `--role` 選項。

`--nowait`

不等待非同步作業完成。

`--publisher`

已棄用。請改用 `--role` 選項。

`-r`, `--role`

為 `.csv` 中的所有使用者指定站台角色。如果要使用 --role 選項指派站台角色，請為每個站台角色建立單獨的 CSV 檔案。

有效的值為：`ServerAdministrator`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `SiteAdministrator`, `Creator`, `ExplorerCanPublish`, `Publisher`, `Explorer`, `Interactor`, `Viewer`, and `Unlicensed`.

在多站台伺服器上，該命令不會將使用者指派到某個站台。因此，該命令可成功指派的唯一站台角色是 `ServerAdministrator` 和 `Unlicensed`。如果指定任何其他站台角色，則該命令會指派 `Unlicensed` 角色。

在單網站伺服器上，將使用您指定的角色建立使用者並將其新增到預設網站。

如果有以使用者為基礎的的伺服器安裝，並且在命令建立新使用者的情況下您已達到使用授權數的限制，則會在未授權使用者的形式新增該使用者。

`--silent-progress`

不顯示命令的進度訊息。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## decryptextracts

解密網站上的所有擷取。如未指定網站，則會解密預設網站上的擷取。有關詳情，請參閱[靜態擷取加密](https://help.tableau.com/v0.0/server/zh-tw/security_ear.htm)。

根據擷取的數目和大小，此作業可能會耗用大量的伺服器資源。請考慮在正常工作時間之外執行此命令。

**範例**

`tabcmd decryptextracts "West Coast Sales"`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## delete _workbook-name_ 或 _datasource-name_

從伺服器中刪除指定工作簿或資料來源。

此命令按原樣使用伺服器上的工作簿或資料來源的名稱，而不是發佈時的檔案名。

**範例**

`tabcmd delete "Sales_Analysis"`

### 選項

`-r`, `--project`

包含您要刪除的工作簿或資料來源的專案的名稱。如果未指定，則使用「Default」專案。

`--parent-project-path`

使用 `-r` 選項指定時，指定巢狀專案的父專案名稱。例如，若要指定存在於「Main」專案中名稱為「Nested」的專案，請使用以下語法：`--parent-project-path "Main" -r "Nested"`。 對於多層級巢狀專案： `--parent-project-path "Main\Nested\Nested2 -r "Nested3`。

`--workbook`

要刪除的工作簿的名稱。

`--datasource`

要刪除的資料來源的名稱。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## deleteextracts

刪除已發佈的工作簿或資料來源的擷取。

### 選項

`-d`, `--datasource`

用於擷取刪除的目標資料來源名稱。

`--embedded-datasources`

目標工作簿中的嵌入資料來源清單（以空格分隔）。若資料來源名稱包含空格，則以雙引號括起來。只有在針對工作簿刪除擷取時可用。

`--encrypt`

建立加密的擷取。

`--include-all`

在目標工作簿中包括所有嵌入資料來源。

`--parent-project-path`

包含目標資源之專案的父專案路徑。必須使用 --project 指定專案名稱。

`--project`

包含目標資源的專案的名稱。唯有在指定 --workbook 或 --datasource 時才有需要。如果未指定，則使用預設專案 'Default'。

`-u`, `-url`

顯示在 URL 中的資源的正式名稱。

`-w`, `-workbook`

用於擷取刪除的目標工作簿名稱。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## deletegroup _group-name_

從伺服器中刪除指定的組。

**範例**

`tabcmd deletegroup "Development"`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## deleteproject _project-name_

從伺服器中刪除指定的專案。

使用 `tabcmd`，您可以僅指定專案階層中的頂層專案。若要自動執行想要對父專案內的專案執行的工作，請使用等效的 Tableau [REST API](https://help.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm%23API_Reference "在新流覽器索引標籤中開啟 REST API 參照") 調用。

**範例**

`tabcmd deleteproject "Designs"`

### 選項

`--parent-project-path`

使用命令指定時，指定巢狀專案的父專案名稱。例如，若要指定存在於「Main」專案中名稱為「Designs」的專案，請使用以下語法：`--parent-project-path "Main" "Designs"`。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## deletesite _site-name_

從伺服器中刪除指定的網站。

**範例**

`tabcmd deletesite "Development"`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## deletesiteusers _filename.csv_

從您登入的站台中移除該使用者。要移除的使用者在一個檔中指定，該檔包含每行一個使用者名的簡單清單。（除使用者名之外不需要其他資訊。）

預設情況下，如果伺服器只有一個網站，或者使用者只屬於一個網站，則還會從伺服器中移除使用者。在 Tableau Server Enterprise 安裝中，如果伺服器包含多個站台，則會從站台中移除指派了**「伺服器管理員」**站台角色的使用者，但不會將其從伺服器中移除。

如果使用者擁有內容，則使用者的角色將變為**「未授權」**，但不會從伺服器或站台中將其移除。內容仍然由該使用者擁有。若要完全移除使用者，您必須變更內容的所有者，然後再次嘗試移除使用者。

如果使用者是從 Active Directory 匯入的，則會從網站中移除使用者，並可能會從伺服器中將其移除。但是，不會從 Active Directory 中將其刪除。

**範例**

`tabcmd deletesiteusers "users.csv"`

### 改善大型 CSV 檔案的效能

伺服器管理員可以使用 `tabadmin set` 命令啟用設定，幫助改善大型 CSV 檔案的效能。有關詳情，請參閱「CSV 匯入檔案準則」主題中的[提高透過 tabcmd 傳遞的大型 CSV 檔案的效能](https://help.tableau.com/v0.0/server/zh-tw/csvguidelines.htm#improve-performance-large-csv)。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## deleteusers _filename.csv_

刪除指定逗號分隔值 (`.csv`) 檔案中列出的使用者。

`.csv` 檔案應包含每行一個使用者名的簡單清單。

**範例**

`tabcmd deleteusers "users.csv"`

### 選項

`--[no-]complete`

當設定為 `--complete` 時，此選項要求所有列都必須有效，變更才能成功。如果未指定，則使用 `--complete`。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## editdomain

**附註：**最佳做法是，應在編輯網域之前備份 Tableau Server。該網域已儲存在 Tableau 存放庫中，若未正確變更，則管理員可能無法登入。

變更伺服器上 Active Directory 網域的昵稱或完整網域名稱。網域「暱稱」是 Windows NetBIOS 網域名稱。

您可以修改伺服器正在使用的任何網域的昵稱。通常，除了您用來登入的域外，您可以修改任何網域的完整網域名稱。但是，如果您當前用來登入的使用者名同時存在於當前網域以及新網域中，則可以修改當前網域的完整網域名稱。

為了確保 Tableau Server 可連線至其他 Active Directory 網域，您必須藉由透過 TSM 設定 `wgserver.domain.whitelist` 選項，指定 Tableau Server 連線到的從屬網域。有關從屬網域和設定連線的詳情，請參閱 [wgserver.domain.whitelist](https://help.tableau.com/v0.0/server/zh-tw/cli_configuration-set_tsm.htm#wgserver-domain)。

查看[使用外部識別身分存放區進行部署中的使用者管理](https://help.tableau.com/v0.0/server/zh-tw/users_manage_ad.htm)，以瞭解多個域、網域名稱對應和使用者名與 Tableau Server 的對話模式。

若要查看網域的清單，請使用 [listdomains](#listdomains)。

**範例**

`tabcmd editdomain --id 2 --nickname "new-nickname"`

`tabcmd editdomain --id 3 --name "new-name"`

### 選項

`--id`

要變更的網域的 ID。若要獲取網域 ID 的清單，請使用 [listdomains](#listdomains)。

`--name`

網域的新名稱。

`--nickname`

網域的新昵稱。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## editsite _site-name_

變更網站名稱或其 Web 資料夾名稱。您也可以使用此命令來允許或拒絕站點管理員新增和移除使用者的功能，或是避免使用者手動執行某些工作。如果網站管理員擁有使用者管理使用權限，則您可指定他們可向一個網站新增的使用者數量。

**範例**

`tabcmd editsite wc_sales --site-name "West Coast Sales"`

`tabcmd editsite wc_sales --site-id "wsales"`

`tabcmd editsite wsales --status ACTIVE`

`tabcmd editsite wsales --user-quota 50`

### 選項

`--site-name`

顯示的網站名稱。

`--site-id`

在網址中使用以特別標識網站。

`--user-quota`

可成為該網站成員的使用者的最大數量。

`--[no-]site-mode`

允許或阻止網站管理員向網站新增使用者。

`--status`

設定為 `ACTIVE` 以啟用網站，或設定為 `SUSPENDED` 以掛起網站。

`--storage-quota`

網站上可儲存的工作簿、擷取和資料來源的數量，以 MB 為單位。

`--extract-encryption-mode`

可以**強制執行**、**啟用**或**停用**網站的擷取加密模式。有關詳情，請參閱[靜態擷取加密](https://help.tableau.com/v0.0/server/zh-tw/security_ear.htm)。根據擷取的數目和大小，此作業可能會耗用大量的伺服器資源。

`--run-now-enabled`

允許或拒絕使用者手動執行擷取重新整理、流程或排程。**true** 允許使用者手動執行工作或 **false** 阻止使用者手動執行工作。有關詳情，請參閱[伺服器設定（常規與自訂）](https://help.tableau.com/v0.0/server/zh-tw/maintenance_set.htm)。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## encryptextracts

加密網站上的所有擷取。如未指定網站，則會加密預設網站上的擷取。有關詳情，請參閱[靜態擷取加密](https://help.tableau.com/v0.0/server/zh-tw/security_ear.htm)。

根據擷取的數目和大小，此作業可能會耗用大量的伺服器資源。請考慮在正常工作時間之外執行此命令。

**範例**

`tabcmd encryptextracts "West Coast Sales"`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## export

從 Tableau Server 匯出檢視或工作簿，並將其儲存到文件。此命令還可匯出恰好適用於檢視的資料。檢視資料會在摘要層級匯出。要匯出詳細資訊層級的資料，必須使用 Tableau Server UI。有關詳細資訊，請參閱[下載檢視和工作簿](https://help.tableau.com/current/pro/desktop/zh-tw/export.htm)。

使用此命令時，請注意以下問題：

- **使用權限**：若要匯出，您必須擁有匯出影像使用權限。雖然可針對每個工作簿或檢視設定使用權限，但預設情況下，所有角色均會獲得或繼承此使用權限。
- **匯出資料**：若要匯出恰好適用於檢視的資料，請使用 `--csv` 選項。這會將檢視中使用的摘要資料匯出為 .csv 文件。
- **指定要匯出的檢視、工作簿或資料：**
    
    - 使用 URL 的一部分標識要匯出的內容，特別是工作簿或檢視的 URL 中顯示的 `"workbook/view"` 字串。不要使用「友好名稱」，並且不要包括 URL 末尾的 `:iid=_<n>_` 工作階段 ID。
        
        例如，「_Superstore_」工作簿中的 Tableau 範例檢視「_訂單明細_」具有類似於如下的 URL： `<server_name>/#/views/Superstore/OrderDetails?:iid=2`
        
        若要匯出「_訂單明細_」檢視，請使用字串 `Superstore/OrderDetails`。
        
        _不要_使用 `Superstore/Order Details` 或 `Superstore/OrderDetails?:iid=2`。
    - 如果伺服器執行多個網站，並且檢視或工作簿不在「預設」網站上，請使用 `-t <site_id>`。
    - 若要匯出工作簿，請透過在工作簿中開啟檢視來獲取 URL 字串，並在使用的字串中包括檢視。
        
        在上面的範例中，若要匯出「_Regional_」（區域）工作簿，請使用字串 `Superstore/OrderDetails`。
    - 若要匯出工作簿，必須已在「Tableau Desktop 發佈」對話方塊中選中「將試算表顯示為標籤」的情況下發佈該工作簿。
        
        **附註：**包含[管理檢視](https://help.tableau.com/current/server/zh-tw/adminview.htm)的 Tableau 工作簿無法予以匯出。
    - 若要篩選下載的資料，請使用以下格式新增參數篩選器：
        
        ?<filter\_name>=value
        
        或者，若對參數進行篩選，並且該參數的顯示名稱與度量或維度的名稱相符：
        
        `?Parameters.<filter_name>=value`
- 已儲存的格式：格式選項取決於所匯出的內容。只能使用 `--fullpdf` 參數將工作簿匯出為 PDF。可將檢視匯出為 PDF (`--pdf`) 或 PNG (`--png`)。
- **已儲存的名稱和位置**（可選）：如果您不提供名稱，則將從檢視或工作簿名稱得到名稱。如果您不提供位置，則會將該檔案儲存到當前工作目錄。否則，您可以指定完整路徑或目前工作目錄的相對路徑。
    
    **附註：**您必須包括檔案副檔名，例如 `.csv` 或 `.pdf`。該命令不會自動為您提供的檔案名新增副檔名。
- **PDF 匯出中不包含儀表板窗格網頁物件**：儀表板窗格可以包含網頁物件。如果要將包含網頁物件的儀表板窗格匯出到 PDF，則 PDF 中將不包括該網頁物件。
- **非 ASCII 字元、非標準 ASCII 字元與 PDF 匯出**：如果您匯出的檢視或工作簿名稱所包含的字元不在 ASCII 字元集或非標準 ASCII 字元集內，則需要對字元進行 URL 編碼（或百分號編碼）。
    
    舉例來說，如果您的命令包括城市 `Zürich`，則需要將其 URL 編碼為 `Z%C3%BCrich`：
    
    `tabcmd export "/Cities/Sheet1?locationCity=Z%C3%BCrich" -fullpdf`

**清除快取以使用即時資料**

您可以選取新增 URL 參數 `?:refresh=yes` 強制重新整理資料查詢而不是從快取中獲取結果。如果要將 tabcmd 與您自己的指令碼結合使用，並且大量使用 `refresh` URL 參數，則可能會對效能造成負面影響。建議您僅當需要即時資料時才使用 `refresh`，例如，在單個儀表板窗格上而不是整個工作簿上。

**範例**

_檢視_

`tabcmd export "Q1Sales/Sales_Report" --csv -f "Weekly-Report.csv"`

`tabcmd export -t Sales "Sales/Sales_Analysis" --pdf -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"`

`tabcmd export "Finance/InvestmentGrowth" --png`

`tabcmd export "Finance/InvestmentGrowth?:refresh=yes" --png`

_工作簿_

`tabcmd export "Q1Sales/Sales_Report" --fullpdf`

`tabcmd export "Sales/Sales_Analysis" --fullpdf --pagesize tabloid -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"`

### 選項

`-f`, `--filename`

使用給定檔案名和副檔名儲存。

`--csv`

僅檢視。以 `.csv` 格式匯出檢視的資料（摘要資料）。

`--pdf`

僅檢視。匯出為 PDF。

`--png`

僅檢視。匯出為 `.png` 格式的影像。

`--fullpdf`

僅工作簿。匯出為 PDF。必須已在「將試算表顯示為索引標籤」已啟用的情況下發佈該工作簿。

`--pagelayout`

設定所匯出的 PDF 的頁面方向（`landscape` 或 `portrait`）。如果不指定，則將使用其 Tableau Desktop 設定。

`--pagesize`

將匯出的 PDF 的頁面大小設定為以下各項之一：`unspecified`、`letter`、`legal`、`note folio`、`tabloid`、`ledger`、`statement`、`executive`、 `a3`、`a4`、`a5`、`b4`、`b5` 或 `quarto`。預設值為 `letter`。

`--width`

以圖元為單位設定寬度。預設值為 800 圖元。

`--height`

以圖元為單位設定高度。預設值為 600 圖元。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## get _url_

從指定（部分）URL 表示的 Tableau Server 中獲取資源。結果以檔案形式返回。

使用此命令時，請注意以下問題：

- **使用權限**：若要獲取檔案，您必須擁有「下載/另存到 Web」使用權限。雖然可針對每個工作簿或檢視設定使用權限，但預設情況下，所有角色均會獲得或繼承此使用權限。
- **指定要獲取的檢視或工作簿**：使用 `"/views/<workbookname>/<viewname>.<extension>"` 字串指定要獲取的檢視，並使用 `"/workbooks/<workbookname>.<extension>"` 字串指定要獲取的工作簿。將 `<workbookname>`  和 `<viewname>` 替換為當您在瀏覽器開啟檢視時工作簿和檢視在 URL 中的顯示名稱，並將 <extension> 替換為想要儲存的檔案類型。不要在 URL 的末尾使用工作階段 ID (`?:iid=<n>`)，也不要使用工作簿或檢視的「友好」名稱。
    
    例如，當您在名為 _Metrics Summary_ 的工作簿中開啟檢視 _Regional Totals_ 時，URL 將類似於如下：
    
    `/views/MetricsSummary_1/RegionalTotals?:iid=1`
    
    使用字串 `/views/MetricsSummary_1/RegionalTotals.<extension>` 來獲取檢視。
    
    使用字串 `/workbooks/MetricsSummary_1.<extension>` 來獲取工作簿。
    
    從 Tableau Server 下載工作簿和檢視時，.twb 或 .twbx 檔案的內容以純文字形式儲存。所有資料，包括可能為資料提供語義線索的篩選器值，都可以被開啟檔案的任何人讀取。
- 檔案**副檔名**：URL 必須包括檔案副檔名。副檔名確定返回的內容。可採用 PDF、PNG 或 CSV（僅限匯總資料）格式返回檢視。Tableau 工作簿作為 TWB 返回（如果它連線到發行資料來源或使用即時連線）或者作為 TWBX 返回（如果它連線到擷取）。
    
    **附註：**如果要將檢視下載為 PDF 或 PNG 檔，並且包含包括 .pdf 或 .png 副檔名的 `--filename` 參數，則不必在 URL 中包含 .pdf 或 .png 副檔名。
- **已儲存的名稱和位置**（可選）：用於 `--filename` 的名稱應包含該檔副檔名。如果您不提供名稱和檔副檔名，則這兩個名稱都將從 URL 字串得到。如果您不提供位置，則會將該檔案儲存到當前工作目錄。否則，您可以指定完整路徑或目前工作目錄的相對路徑。
- **PNG 大小**（可選）：如果儲存的檔案是 PNG，您可以在 URL 中指定該大小（以圖元為單位）。

**清除快取以使用即時資料**

您可以選取新增 URL 參數 `?:refresh=yes` 強制重新整理資料查詢而不是從快取中獲取結果。如果將 tabcmd 與您自己的指令碼結合使用，則大量使用 `refresh` 參數可能會對效能造成負面影響。建議您僅當需要即時資料時才使用 `refresh`，例如，在單個儀表板窗格上而不是整個工作簿上。

**範例**

_檢視_

`tabcmd get "/views/Sales_Analysis/Sales_Report.png" --filename "Weekly-Report.png"`

`tabcmd get "/views/Finance/InvestmentGrowth.pdf" -f "Q1Growth.pdf"`

`tabcmd get "/views/Finance/InvestmentGrowth" -f "Q1Growth.pdf"`

`tabcmd get "/views/Finance/InvestmentGrowth.csv"`

`tabcmd get "/views/Finance/InvestmentGrowth.png?:size=640,480" -f growth.png`

`tabcmd get "/views/Finance/InvestmentGrowth.png?:refresh=yes" -f growth.png`

_工作簿_

`tabcmd get "/workbooks/Sales_Analysis.twb" -f "C:\Tableau_Workbooks\Weekly-Reports.twb"`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## initialuser

在未定義初始管理使用者的伺服器上建立初始伺服器管理使用者。這將建立一個伺服器管理員。這樣不會建立 TSM 管理員。

**附註：****tabcmd initialuser** 命令不要求向 Tableau Server 進行驗證，但必須在初始伺服器節點中執行該命令。

**附註**：

- **tabcmd initialuser** 命令不需要對 Tableau Server 進行驗證，但必須在初始伺服器節點中執行該命令。
- `username` 值不能包含 at 符號 (@)，除非使用者名稱尾碼與 Tableau Server 的主要網域相符。例如，若 Tableau Server 連線到網域「myco.com」，則不能使用使用者名稱「user@example.com@myco.com」。

**範例**

`tabcmd initialuser --username "admin" --password "password" --server http://localhost`

`tabcmd initialuser --username "admin" --password "password" --friendly "Tableau Admin" --server http://localhost`

要在 shell 中提示輸入密碼，請不要在命令中包含 `--password` 參數。例如：

`tabcmd initialuser --username "admin" --server http://localhost`

### 選項

`-f`, `--friendly`

使用顯示名稱建立初始伺服器管理使用者。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## listdomains

顯示伺服器正在使用的 Active Directory 網域的清單，以及其昵稱和 ID。如果伺服器設定為使用本機驗證，則該命令僅返回網域名稱 `local`。

**範例**

`tabcmd listdomains`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## listsites

返回已登入使用者所屬網站的清單。

**範例**

`tabcmd listsites --username adam --password mypassword`

### 選項

`--get-extract-encryption-mode`

可以**強制執行**、**啟用**或**停用**網站的擷取加密模式。有關詳情，請參閱[靜態擷取加密](https://help.tableau.com/v0.0/server/zh-tw/security_ear.htm)。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## login

使 Tableau Server 使用者登入。

可使用 `--server`、`--site`、`--username`、`--password` 全域選項來建立會話。

**附註：**使用 **tabcmd login** 命令時，即使伺服器設為使用 SAML，也無法使用 SAML 單一登入 (SSO)。若要登入，您必須傳遞在伺服器上建立的使用者的使用者名和密碼。您將具有您在登入時使用的 Tableau Server 使用者的使用權限。有關詳情，請參閱[設定使用者的網站角色](https://help.tableau.com/v0.0/server/zh-tw/users_site_roles.htm)和[權限](https://help.tableau.com/v0.0/server/zh-tw/permissions.htm)。

如果要使用建立會話時使用的相同資訊進行登入，只需指定 `--password` 選項。將使用存儲在 Cookie 中的伺服器和使用者名。

如果伺服器使用 80（預設值）之外的埠，您需要指定該埠。

僅當該伺服器執行多個站台，並且您登入的站台不是預設站台時，才需要使用 `--site` (`-t`) 選項。如果未提供密碼，則會提示您輸入密碼。如果指定 `--no-prompt` 選項但未提供密碼，則該命令將失敗。

登入後，該會話將繼續進行，直到其在伺服器上過期或 `logout` 命令執行。

**範例**

使使用者 jsmith 登入到本機電腦上執行的 Tableau Server：

`tabcmd login -s http://localhost -u jsmith -p password`

使管理員登入到 sales-server 上的「Sales」（銷售額）網站：

`tabcmd login -s http://sales-server -t Sales -u administrator -p password`

`tabcmd login -s http://sales-server:8000 -t Sales -u administrator -p password`

使用 SSL 讓管理員登入 sales-server 的「Sales」（銷售額）站台，但不驗證伺服器的 SSL 憑證：

`tabcmd login --no-certcheck -s https://sales-server -t Sales -u administrator -p password`

為 localhost 建立正向 Proxy 和埠：

`tabcmd login --proxy myfwdproxyserver:8888 -s http://localhost -u jsmith -p password`

使使用者 jsmith 使用 SSL 登入到反向 Proxy ：

`tabcmd login -s https://myreverseproxy -u jsmith -p password`

### 選項

`-s`, `--server`

如果在網路上的 Tableau Server 電腦中執行該命令，可以使用 `http://localhost`。否則，指定電腦的 URL，例如 `http://bigbox.myco.com` 或 `http://bigbox`。

如果伺服0器使用 SSL，則需要在電腦的URL中指定`https://`。

對於 Tableau Cloud，請指定完整的 URL，包括部署站台的 Pod。例如：`https://prod-useast-b.online.tableau.com`。

`-t`, `--site`

如果伺服器具有多個站台，且您登入的站台不是預設站台時，請使用此選項。

在 URL 中使用站台 ID 以唯一地標識站台。例如，名為 West Coast Sales 的站台的 ID 可能為 west-coast-sales。

`-u`, `--username`

登入使用者的使用者名。對於 Tableau Cloud，使用者名是使用者的電子郵件地址。

`-p`, `--password`

`--username` 所指定的使用者的密碼。如果未提供密碼，則會提示您輸入密碼。

`--password-file`

允許將密碼存儲在給定 `filename.txt` 檔中而不是命令列中以增加安全性。

`-x`, `--proxy`

用於指定 tabcmd 請求的 HTTP Proxy 伺服器與連接埠（主機:連接埠）。

`--no-prompt`

不提示輸入密碼。如果未指定密碼，則 `login` 命令將失敗。

`--no-proxy`

請勿使用 HTTP Proxy 伺服器。

`--cookie`

登入時儲存會話 ID。後續命令將不需要登入。此值是命令的預設值。

`--no-cookie`

成功登入後不儲存工作階段 ID 資訊。後續命令將需要登入名。

`--timeout SECONDS`

處理 `login` 命令前伺服器應等待的秒數。預設值：30 秒。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## logout

登出伺服器。

**範例**

`tabcmd logout`

## publish _filename.twb(x)_、_filename.tds(x)_ 或 _filename.hyper_

將指定的工作簿 (.twb(x))、資料來源 (.tds(x)) 或擷取 (.hyper) 發佈到 Tableau Server。

如果要發佈工作簿，則預設情況下無需資料庫使用者名或密碼即可發佈工作簿中的所有工作表。

將從在其中發佈檔案的專案中複製最初指派給工作簿或資料來源的使用權限。可在發佈了檔後變更已發佈資源的使用權限。 

如果工作簿中包含使用者篩選條件，則必須指定一個縮圖選項。

**附註：**目前不支援使用 tabcmd 發佈擴展資料來源或組合資料來源。如果使用 tabcmd 發布組合工作簿或資料來源檔案，它將無法正確連結到伺服器上的其父項。

**範例**

`tabcmd publish "analysis.twbx" -n "Sales_Analysis" --db-username "jsmith" --db-password "secret-password"`

`tabcmd publish "analysis_sfdc.hyper" -n "Sales Analysis"   --oauth-username "user-name" --save-oauth`

如果該檔案與 tabcmd 並不位於同一目錄，請包含檔案的完整路徑。

**範例**

`tabcmd publish "\\computer\volume\Tableau Workbooks\analysis.twbx" -n "Sales_Analysis" --db-username "jsmith" --db-password "secret-password"`

`tabcmd publish "\\computer\volume\Tableau Workbooks\analysis_sfdc.hyper" -n "Sales Analysis" --oauth-username "username" --save-oauth`

### 選項

`-n`, `--name`

伺服器上工作簿或資料來源的名稱如果省略，則工作簿、資料來源或擷取將以檔案名來命名。

`-o`, `--overwrite`

如果伺服器上已存在該工作簿、資料來源或擷取，則將其覆蓋。

`-r`, `--project`

將工作簿、資料來源或擷取發佈到指定專案。如果未指定，則發佈到「Default」專案。

`--parent-project-path`

使用 `-r` 選項指定時，指定巢狀專案的父專案名稱。例如，若要指定存在於「Main」專案中名稱為「Nested」的專案，請使用以下語法：`--parent-project-path "Main" -r "Nested"`。

`--db-username`

使用此選項可將資料庫使用者名與工作簿、資料來源或擷取一起發佈。

`--db-password`

使用此選項可將資料庫密碼與工作簿、資料來源或擷取一起發佈。

`--save-db-password`

將提供的資料庫密碼存儲在伺服器上。

`--oauth-username`

使用者帳戶的電子郵件地址。如果使用者對 `--name` 中指定的雲端資料來源已經有儲存的存取權杖，則透過預先設定的 OAuth 連線來連線該使用者。存取權杖在使用者首選項中管理。

對於資料來源的現有 OAuth 連線，應使用該選項而不是 `--db-username` 和 `--db-password`。

`--save-oauth`

將 `--oauth-username` 指定的認證儲存為已發佈工作簿或資料來源的嵌入式認證。

隨後，當發行者或伺服器管理員登入伺服器並編輯該工作簿或資料來源的連線時，連線設定將顯示此 OAuth 認證已嵌入到內容中。

如果要安排在發佈後重新整理擷取，則必須對 `--oauth-username` 使用該選項。這與對傳統的資料庫連線使用 `--save-db-password` 類似。

`--thumbnail-username`

如果工作簿中包含使用者篩選條件，則將基於指定使用者可看到的內容產生縮圖。設定 `--thumbnail-group` 選項後，無法指定此選項。

`--thumbnail-group`

如果工作簿中包含使用者篩選條件，則將基於指定群組可看到的內容產生縮圖。設定 `--thumbnail-username` 選項後，無法指定此選項。

`--tabbed`

發佈帶有索引標籤式檢視的工作簿時，每個工作表都成為一個索引標籤，Viewer（檢視器）可以使用這些索引標籤在工作簿中巡覽。請注意，此設定將替代任何工作表級安全設定。

`--append`

將擷取檔案附加到現有的資料來源中。

`--replace`

使用擷取檔案替換現有的資料來源。

`--disable-uploader`

停用增量檔案上傳器。

`--restart`

重新啟動檔上傳過程。

`--encrypt-extracts`

發佈工作簿、資料來源或擷取至伺服器時加密擷取。有關詳情，請參閱[靜態擷取加密](https://help.tableau.com/v0.0/server/zh-tw/security_ear.htm)。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## publishsamples

### 描述

將 Tableau 範例工作簿發佈到指定專案。任何現有範例將被覆蓋。

### 語法

`tabcmd publishsamples -n [project name] [Global options]`

**範例**

以使用者 jsmith 身分將範例發佈到「Default」網站上的「Inside Sales」專案。

`tabcmd publishsamples -n "Inside Sales" -t "" -s localhost --username "jsmith" --password "secret-password"`

### 選項

`-n`, `--name`

必要。將 Tableau 範例發佈到指定專案中。如果項目名稱包括空格，請用引號將整個名稱括起來。

`--parent-project-path`

使用 `-n` 選項指定時，指定巢狀專案的父專案名稱。例如，若要指定存在於「Main」專案中名稱為「Nested」的專案，請使用以下語法：`--parent-project-path "Main" -n "Nested"`。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## reencryptextracts

以新的加密金鑰重新加密網站上的所有擷取。此命令會重新產生金鑰加密金鑰和資料加密金鑰。您必須指定一個網站。有關詳情，請參閱[靜態擷取加密](https://help.tableau.com/v0.0/server/zh-tw/security_ear.htm)。

根據擷取的數目和大小，此作業可能會耗用大量的伺服器資源。請考慮在正常工作時間之外執行此命令。

**範例**

`tabcmd reencryptextracts "Default"`

`tabcmd reencryptextracts "West Coast Sales"`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## refreshextracts _workbook-name_ 或 _datasource-name_

對屬於指定工作簿或資料來源的擷取執行完全或累加式重新整理。

此命令使用伺服器上顯示的工作簿或資料來源的名稱，而不使用發佈時的檔案名。僅允許管理員或者工作簿或資料來源的所有者執行此操作。

**附註：**如果伺服器管理員已停用網站的 **RunNow** 設定，此方法將會失敗且出現錯誤。有關詳情，請參閱 [Tableau Server 設定](Https://help.tableau.com/current/server/zh-tw/maintenance_set.htm)。

**範例**

tabcmd refreshextracts --datasource sales\_ds

tabcmd refreshextracts --project "Sales External" --datasource sales\_ds

tabcmd refreshextracts --project "Sales External" --parent-project-path "Main" --project "Sales External" --datasource sales\_ds

tabcmd refreshextracts --workbook "My Workbook"

tabcmd refreshextracts --url SalesAnalysis

tabcmd refreshextracts --workbook "My Workbook" --addcalculations

tabcmd refreshextracts --datasource sales\_ds --removecalculations

### 選項

`--incremental`

執行累加式重新整理操作。

`--synchronous`

將完全重新整理操作新增至背景程式處理序所使用的佇列，以在背景程式處理序可用時立即執行。如果背景程式處理序可用，則立即執行此操作。重新整理操作會出現在「背景工作」報告中。

在同步重新整理期間，`tabcmd` 在重新整理操作進行時保持即時連線到伺服器，並且每秒鐘進行一次輪詢，直到背景作業完成為止。

**附註：**`--synchronous` 選項對使用 Tableau Bridge 進行重新整理的資料來源不可用。

`--workbook`

包含要重新整理的擷取的工作簿的名稱。如果工作簿名稱中含有空格，請將名稱放入引號內。

`--datasource`

包含要重新整理的擷取的資料來源的名稱。

`--project`

與 `--workbook` 或 `--datasource` 結合使用可確定 _Default_ 以外的專案中的工作簿或資料來源。如果未指定，則使用「Default」專案。

`--parent-project-path`

使用 `--project` 選項指定時，指定巢狀專案的父專案名稱。

例如：

- 若要指定存在於「Main」專案中名稱為「Nested」的專案，請使用以下語法：
- \--parent-project-path "Main" --project "Nested"
- 若要指定巢嵌在「Nested」專案中的名稱為「Nested2」的專案：
- \--parent-project-path "Main/Nested" --project "Nested2"

`--url`

顯示在 URL 中的工作簿的名稱。發佈為「Sales Analysis」工作簿的 URL 名稱為「SalesAnalysis」。

`--addcalculations`

與 `--workbook` 結合使用以在工作簿的嵌入式擷取中實現計算，或與 `--datasource` 結合使用以在擷取資料來源中實現計算。將操作新增到背景程式處理序使用的查詢中。如果背景程式處理序可用，操作將立即執行。此操作出現在[擷取背景工作](https://help.tableau.com/current/online/zh-tw/adminview_backgrnd.htm) 管理檢視中。

`--removecalculations`

與 `--workbook` 或 `--datasource` 結合使用可移除以前實現的計算。將操作新增到背景程式處理序使用的查詢中。如果背景程式處理序可用，操作將立即執行。此操作出現在[擷取背景工作](https://help.tableau.com/current/online/zh-tw/adminview_backgrnd.htm) 管理檢視中。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## reset\_openid\_sub

清除與 Tableau Server 識別相關聯的 OpenID Connect 識別碼（sub 值）。請參閱[在採用 OpenID Connect 的 Tableau Server 中變更 IdP](https://help.tableau.com/v0.0/server/zh-tw/openid_auth_changing_idp.htm)。

**範例**

`tabcmd reset_openid_sub --target-username jsmith`

### 選項

`--target-username`

為指定的個人使用者清除 sub 值。

`--all`

為所有使用者清除 sub 值。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## removeusers _group-name_

從指定的組中移除使用者。

**範例**

`tabcmd removeusers "Development" --users "users.csv"`

### 選項

`--users`

從指定的組刪除給定 `.csv` 檔案中的使用者。該檔案應是每行一個使用者名的簡單清單。

如果在 Tableau Server 上將此命令用於大型 `.csv` 檔案，則伺服器管理員可啟用說明改善性能的設定。有關資訊，請參閱[提高透過 tabcmd 傳遞的大型 CSV 檔案的效能](https://help.tableau.com/v0.0/server/zh-tw/csvguidelines.htm#improve-performance-large-csv)

`--[no-]complete`

要求所有列都必須有效，變更才能成功。如果未指定，則使用 `--complete`。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## runschedule _schedule-name_

為您當前登入的站台執行指定排程中的工作。無法使用 tabcmd 為所有站台執行此命令。要為所有站點執行排程中的工作，請登入 Web 介面，從**排程**頁面，選取**所有站點**，然後在排程中**立即執行**。

此命令採用伺服器上指定的排程名稱。

本命令在 Tableau Cloud 上不可用。

**附註：**如果伺服器管理員已停用網站的 **RunNow** 設定，此方法將會失敗且出現錯誤。有關詳情，請參閱 [Tableau Server 設定](https://help.tableau.com/current/server/zh-tw/maintenance_set.htm)。

**範例**

`tabcmd runschedule "5AM Sales Refresh"`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## set _setting_

在伺服器上啟用指定設定。伺服器的「維護」頁面上提供了有關各項設定詳情。

在設定名稱前使用感嘆號可停用該設定。可啟用或停用以下設定：

- `allow_scheduling`
- `embedded_credentials`
- `remember_passwords_forever`

**範例**

`tabcmd set embedded_credentials`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## syncgroup _group-name_

將 Tableau Server 群組與 Active Directory 群組同步。如果還沒有該 Tableau Server 群組，則會建立該群組並將其與指定的 Active Directory 群組同步。

如果群組名稱本身包括「@」（而不是作為網域分隔符號），則您需要使用十六進位格式引用該符號「\\0x40」

**範例**

`tabcmd syncgroup "Development"`

`tabcmd syncgroup "Dev\0x40West"`

**附註：** 如果同步您是其成員的群組，則使用此命令所做的變更不會應用於您的使用者。例如，如果您使用此命令移除您是其成員的群組中使用者的管理員權限，則在命令完成後您仍然是管理員。

### 選項

`--grant-license-mode <grant-license-mode>`

指定是否應在登入時授予角色。預設值為 `on-sync`。有效值為 `on-login`, `on-sync`。若未指定任何值，則假定為 `on-sync`，並且在同步群組時將授予預設角色。有關詳情，請參閱[修改因為登入授與角色而受影響的使用者](https://help.tableau.com/v0.0/server/zh-tw/grant_role.htm#GrantRoleOnSignin)。

`--no-publisher`

已棄用。請改用 `--role` 選項。

`--overwritesiterole`

使用 `--role` 時，允許用使用權限較低的角色覆蓋使用者的站台角色。預設情況下，在使用 `--role` 時，使用者站台角色可能會收到提示，但無法降階。由於 `--overwritesiterole` 選項會使使用者站台角色降級，因此請小心使用。

`--publisher`

已棄用。請改用 `--role` 選項。

`-r`, `--role`

為群組中的使用者指定站台角色。預設值為 `Unlicensed`。

有效的值為`SiteAdministratorCreator`, `SiteAdministratorExplorer`, `SiteAdministrator`, `Creator`, `ExplorerCanPublish`, `Publisher`, `Explorer`, `Interactor`, `Viewer`, `Unlicensed`.

`--silent-progress`

不顯示命令的進度訊息。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## upgradethumbnails

啟動和停止升級縮圖工作。若要瞭解詳細資訊，請參閱[升級縮圖工作](https://help.tableau.com/v0.0/server/zh-tw/adminview_backgrounder_upgrade_thumbnails.htm)。

**範例**

要啟動升級縮圖工作：

`tabcmd upgradethumbnails --server <serverURL>`

要停止執行升級縮圖工作：

`tabcmd upgradethumbnails --server <serverURL> --stop`

### 選項

`--stop`

在指定時，停止執行升級縮圖工作。如果未指定此選項，則將啟動升級縮圖工作。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## validateidpmetadata

識別使用不安全的摘要演算法 SHA-1 設定 IdP 的 Tableau Server 站台。此命令也識別使用憑證的 RSA 金鑰大小或橢圓曲線大小不足的 IdP。

**附註：**此命令僅適用於站台特定的 SAML。有關詳情，請參閱[設定特定於網站的 SAML](https://help.tableau.com/v0.0/server/zh-tw/saml_site_specific.htm)。

### 選項

`--digest-algorithms <ALGORITHMS>`

用空格分隔的摘要演算法清單。正確的值為`sha1`和`sha256`。如果未指定，則伺服器使用伺服器設定的值[wgserver.saml.blocklisted\_digest\_algorithms](https://help.tableau.com/v0.0/server/zh-tw/cli_configuration-set_tsm.htm#wgserver5)。

`--min-allowed-elliptic-curve-size <SIZE>`

如果未指定，則伺服器使用伺服器設定的值[wgserver.saml.min\_allowed.elliptic\_curve\_size](https://help.tableau.com/v0.0/server/zh-tw/cli_configuration-set_tsm.htm#wgserver2)。

`--min-allowed-rsa-key-size <SIZE>`

如果未指定，則伺服器使用伺服器設定的值[wgserver.saml.min\_allowed.rsa\_key\_size](https://help.tableau.com/v0.0/server/zh-tw/cli_configuration-set_tsm.htm#wgserver4)。

`--site-names <SITENAMES>`

用空格分隔、執行證書驗證的站台名稱清單。如果未指定，則將檢查所有站台。

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

## version

顯示 tabcmd 公用程式的當前安裝的版本資訊。

**範例**

`tabcmd version`

全域選項

所有 `tabcmd` 命令都使用以下選項。若要開始一個會話，至少需要使用一次 `--server`、`--user` 和 `--password` 選項。將存儲一個驗證權杖，以便可以不用包括這些選項就能執行後續命令。此權杖在使用它的最後一個命令之後五分鐘內保持有效。

`-h`, `--help`

顯示命令說明。

`-c`, `--use-certificate`

使用用戶端憑證登入。啟用相互 SSL 時需要。

有關設定憑證的資訊，請從適用於您的 Tableau Server OS 的以下主題開始：

- **Windows**：[設定相互 SSL](https://help.tableau.com/current/server/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")
- **Linux**：[設定相互 SSL](https://help.tableau.com/current/server-linux/zh-tw/ssl_config_mutual.htm "在新瀏覽器索引標籤中開啟主題")

`-s`, `--server`

Tableau Server URL，至少需要使用一次才能開始會話。

`-u`, `--user`

Tableau Server 使用者名，至少需要使用一次才能開始會話。

`-p`, `--password`

Tableau Server 密碼，至少需要使用一次才能開始會話。

`--password-file`

允許將密碼存儲在給定 `.txt` 檔案中而不是命令列中以增加安全性。

`-t`, `--site`

指示命令將套用於由 Tableau Server 站點 ID 指定的站點（以單引號或雙引號括住）。若要指定預設站點，請使用以單引號或雙引號括住的空字串（" 或 ""），或是使用以雙引號括住的 Default（"Default"）。網站 ID 使用擷取驗證權杖時會區分大小寫。如果您的權杖大小寫不符合，即使其仍有效，系統可能會提示您輸入密碼。

`-x`, `--proxy`

Host:Port

使用指定的 HTTP 代理。

`--no-prompt`

指定後，該命令將不提示輸入密碼。如果未提供有效密碼，則該命令將失敗。

`--no-proxy`

指定後，將不使用 HTTP 代理。

`--no-certcheck`

在指定時，tabcmd（用戶端）不會驗證伺服器的 SSL 憑證。

`--[no-]cookie`

指定後，登入時將儲存會話 ID，這樣後續命令就無需登入。若要不儲存會話 ID，請使用 `no-` 首碼。預設情況下，將儲存會話。

`--timeout`

等待指定秒數以使伺服器完成命令處理。預設情況下，處理程序將等待伺服器回應。

`--`

指定命令列上的選項結尾。您可以使用 `--` 向 `tabcmd` 指明不應將 `--` 後面的內容解釋為選項設定，而是解釋為命令的值。如果需要在包括連字號的命令中指定值，這將非常有用。下面的範例顯示如何能在 `tabcmd` 命令中使用 `--`，在該命令中，`-430105/Sheet1` 是 `export` 命令的必需值。

`tabcmd export --csv -f "D:\export10.csv" -- -430105/Sheet1`

**提示**：有關可用於 Tableau Cloud 的 Tabcmd 1.0 命令，請參閱 [tabcmd 命令](https://help.tableau.com/current/online/zh-tw/tabcmd_cmd.htm)。