---
schema_version: "1"
id: de36fab052ee3ba5d3905c05151306dc6021398a3fc3fb509d219b4409a753bf
title: tabcmd
collection: tableau
version: current
locale: zh-cn
portal_url: https://docs.salesforce.com/tableau/current/zh-cn/server/tabcmd.md
canonical_url: https://help.tableau.com/current/server/zh-cn/tabcmd.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 83165fd8152a7157ec14c662f61b50eb3e34b65d79a7b825e6065180ea1ee606
description: Install and use the tabcmd command-line utility for Tableau.
---
[跳转到主要内容](#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 的支持有限。

Tableau 提供了 tabcmd 命令行实用工具，您可以使用它在 Tableau Server 站点上自动完成站点管理任务。例如，创建或删除用户、项目和组。

**注意：**在 2024.1 之前的 Tableau 版本中，tabcmd 版本 1 不适用于导出可视化项。

**注意：**tabcmd 实用工具随 Tableau Server 一起提供，并将自动安装在服务器节点上。但未包括其安装程序，因此，如果要在不是 Tableau Server 安装一部分的计算机上运行 tabcmd，您需要从 Tableau 网站下载安装程序。有关详细信息，请参见下面的[安装 tabcmd](#tabcmd-install)。

## 安装 tabcmd

**注意：**这些说明用于安装 tabcmd 1.0 命令行实用程序。若要安装 tabcmd 2.0 命令行实用程序，请转到 [Tableau tabcmd](https://tableau.github.io/tabcmd)（新窗口）。

将 Tableau Server 或 Tableau Cloud 升级到新版本时，如果需要 tabcmd 的更新版本，您可以从 Tableau 网站上“Tableau _Server_ 版本”页面下载该版本。

对于 Tableau Server：我们建议下载择与您的服务器版本匹配的版本。对于 Tableau Cloud，我们建议您始终下载最新版本，以避免版本不兼容导致的问题。在任一情况下，使用 tabcmd 的过时版本可能会导致错误和不可预知的结果。

1. 打开 Web 浏览器并转到 [Tableau Server 版本](https://www.tableau.com/zh-cn/support/releases/server)页面。即使您使用 Tableau Online，也转到此页面。
2. 如果您使用的是：
    
    - **Tableau Cloud**，请使用 [Tableau tabcmd 2.0](https://tableau.github.io/tabcmd)（新窗口）。
    - **Tableau Server（Windows 或 Linux）：**请选择与您的服务器版本匹配的版本。
    
    在任一情况下，如果展开的信息显示维护版本，请选择最新维护版本，或选择与您的服务器版本匹配的维护版本。
    
    ![选择您使用的服务器版本（Tableau Cloud 的最新版本）](/tableau/current/zh-cn/server/zh-cn/Img/tabcmd_download1.png)
    
    这将带您进入发行说明页面（名为“已解决问题”），您可以在其中阅读有关安全改进和已解决问题的信息。
3. 滚动到已解决问题下的“**下载文件**”部分，选择与您将从中运行 tabcmd 命令的计算机兼容的 tabcmd 下载链接。 
    
    ![选择适用于要在其上使用 tabcmd 安装程序的计算机的 tabcmd 安装程序（32 位或 64 位）](/tableau/current/zh-cn/server/zh-cn/Img/tabcmd_download.png)
    
    其余步骤将此计算机称为“tabcmd 计算机”。
4. 将安装程序保存到 tabcmd 计算机，或保存到可从该计算机访问的位置。
5. 完成适合于 tabcmd 计算机操作系统的安装步骤：
    
    - Windows
        
        默认情况下，tabcmd 安装到 `C:\Program Files\Tableau\Tableau Server\<version>\extras\Command Line Utility`。您可以在安装过程中更改此项，并建议将 tabcmd 安装到 C:\\ 驱动器 (`C:\tabcmd`) 根目录处名为 `tabcmd` 的文件夹中。这可以使查找和运行更加容易，并且如果将 tabcmd 目录添加到 Windows PATH，则它适应 Windows 操作系统的一些限制。
        
        **注意** tabcmd 安装程序不会向 Windows PATH 变量添加 tabcmd 目录。您可以手动添加它，也可以在每次调用 tabcmd 时包含其完整路径。
        
        您可以通过两种方式在 Windows 上安装 tabcmd：
        
        - 双击安装程序，按照 UI 中的步骤进行操作：
            
            1. 接受许可协议。
            2. 如果要安装到非默认位置，请单击“自定义”，并键入或浏览到要将 tabcmd 安装到的位置。
            3. 单击“安装”。
                
                如果 Windows Defender 防火墙或用户帐户控制提示，请单击**“允许访问”**。
        - 从命令提示符中运行安装程序：
            
            1. 在 tabcmd 计算机上以管理员身份打开命令提示符。
            2. 导航到在其中复制了 tabcmd 安装程序的目录。
            3. 安装 tabcmd：
                
                tableau-setup-tabcmd-tableau-<version\_code>-x64.exe /quiet ACCEPTEULA=1
                
                安装到非默认位置：
                
                tableau-setup-tabcmd-tableau-<version\_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="<path\\to\\install\\directory>"
                
                例如：
                
                tableau-setup-tabcmd-tableau-<version\_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="C:\\tabcmd"
                
                有关可用于 tabcmd 安装程序的命令行选项的完整列表，请使用 a /? 运行安装程序。有关 tabcmd 安装程序命令行选项的详细信息，请参见[tabcmd 的安装开关和属性 (Windows)](https://help.tableau.com/current/server/zh-cn/tabcmd_install_flags.htm)。
        
        Tabcmd 安装程序会在 `C:\Users\<user>\AppData\Local\Temp` 中创建日志，如果安装 tabcmd 时出现问题，您可以使用这些日志。日志使用命名约定 `Tableau_Server_Command_Line_Utility_(<version_code>)_##############.log`。
    - Linux
        
        **注意：**若要在 Linux 计算机上运行 tabcmd，您必须安装 Java 11。在类似 RHEL 的系统上，Java 11 将在您安装 tabcmd 时作为依赖项安装。在 Ubuntu 系统上，如果 Java 11 尚未安装，则需要单独安装。  
          
        自 2022 年 7 月起，不再支持 Debian 发行版。有关详细信息，请参见[此 Tableau 社区](https://community.tableau.com/s/news/a0A4T0000011xDOUAY/debian-end-of-life)。
        
        1. 以具有 sudo 访问权限的用户身份登录到 tabcmd 计算机。
        2. 导航到您将所下载的 `.rpm` 或 `.deb` 软件包复制到的目录。
            
            - 在类似于 RHEL 的分发（包括 CentOS）上，运行以下命令：
                
                `sudo yum install tableau-tabcmd-<version>.noarch.rpm`
            - 在 Ubuntu 上，运行以下命令：
                
                `sudo apt-get install ./tableau-tabcmd-<version>_all.deb`
    
    若要从 Linux 计算机中卸载 tabcmd，请参见适用于正在运行的 Linux 版本的文档。
6. （可选）将安装 tabcmd 的完全限定位置添加到系统路径中，以允许您运行 tabcmd 命令，而无需更改到该位置，或为每个命令指定位置。执行此操作的步骤取决于操作系统的类型和版本。有关详细信息，请参见 [PATH（变量）](https://en.wikipedia.org/wiki/PATH_\(变量\))。

## 如何使用 tabcmd

使用 tabcmd 的基本步骤如下：

1. 以管理员身份打开命令提示符。
    
    **注意：**在 Windows 上，请勿使用 PowerShell 运行 tabcmd 命令。使用 PowerShell 可能会导致意外行为。
2. 在 Windows 计算机上，如果在不是初始节点的计算机上安装了 tabcmd，请切换到安装了 tabcmd 的目录。
    
    在 Linux 计算机上，您无需切换到安装目录。
3. 运行 tabcmd 命令。

在使用 tabcmd 时，您必须建立经过身份验证的服务器会话。会话会识别服务器或 Tableau Cloud 站点以及运行该会话的用户。您可以先启动会话，然后指定命令，或者在启动会话的同时执行命令。

**重要信息：**如果您要使用 tabcmd 执行多项任务，则必须依次（连续）运行任务，而非同时（并行）运行。

命令（例如 `login`）和选项（例如 `-s`、`-u` 等）不区分大小写，但您提供的值（例如 `User@Example.com`）区分大小写。

## 示例

下面的命令演示了如何对名为 _tabserver.mycompany.com_ 的 Tableau Server 启动会话：

tabcmd login -s http://tabserver.mycompany.com -u admin -p mypassword

下一个示例演示用于删除名为 _Sales\_Workbook_ 的工作簿的命令：

tabcmd delete "Sales\_Workbook" 

下面介绍了如何用一条命令完成上述所有操作，请注意此处不需要 `login`：

tabcmd delete "Sales\_Workbook" -s http://tabserver.mycompany.com -u admin -p mypassword 

一个 Tableau Server 可以运行多个站点。当工作簿运行在多站点服务器的 Default 站点上时，不需要指定 Default，上述命令已足够。但是，如果命令应用于 Default 之外的站点，则需要指定该站点的站点 ID（请参见[login](https://help.tableau.com/current/server/zh-cn/tabcmd_cmd.htm#login)）。下面是用于 West Coast Sales 站点上的一个工作簿的命令（站点 ID `wsales`）：

tabcmd delete "Sales\_Workbook" -s http://tabserver.mycompany.com -t wsales -u admin -p mypassword 

选项 `-s`、`-t`、`-u` 和 `-p` 是 tabcmd 的全局变量，可与任何命令一起使用。

有关详细信息，请参见 [tabcmd 命令](https://help.tableau.com/current/server/zh-cn/tabcmd_cmd.htm)。

## 状态消息和日志

当命令成功执行时，tabcmd 将返回零状态代码。对于非零状态代码，将向 **stderr** 打印完整错误消息。此外，还可向 **stdout** 打印信息性消息或进度消息。

会将一个名为 **tabcmd.log** 并包括调试、进度和错误消息的完整日志写入 `C:\Users\<username>\AppData\Local\Tableau\`。

**重要信息：**Tableau 支持无法解决只能在自定义脚本中重现的问题。若要获取有关自定义脚本的帮助，请访问 Tableau 社区论坛。

## 此部分中的其他文章