Referência da linha de comando tsm


Os tópicos desta seção incluem o conteúdo de referência da interface de linha de comandos (CLI) do Tableau Services Manager (TSM) para suportar o Tableau Server .

O TSM é usado para gerenciar a instalação e a configuração do Tableau Server. Para saber mais sobre o TSM, consulte Visão geral do Tableau Services Manager.

É possível automatizar as tarefas de instalação e configuração suportadas pelo TSM CLI usando a API do TSM. Para saber mais sobre a API do TSM de pré-versão (Alpha), consulte API do Tableau Services Manager.

Uso da CLI do tsm

Você pode executar comandos tsm no nó inicial (o nó onde o TSM está instalado) ou em qualquer nó adicional no cluster.

Para executar comandos tsm, é necessário abrir um prompt de comando do Windows. Não use o PowerShell para executar comandos tsm. O uso do PowerShell pode causar um comportamento inesperado.

  1. Abra o prompt de comando do Windows com uma conta que seja membro do grupo de Administradores em um nó no cluster.

  2. Execute o comando desejado. Se você estiver executando o comando de um nó diferente do nó inicial, inclua a opção -s para especificar a URL do nó inicial por nome (não por endereço IP) e inclua a porta do TSM, 8850.

    Para ver a versão do TSM e do Tableau Server no nó inicial:

    tsm version

    Para ver a versão do TSM e do Tableau Server de um nó adicional:

    tsm version -s https://<inital_node_name>:8850

    Por exemplo:

    tsm version -s https://myTableauHost:8850

Autenticação com a CLI tsm

A partir da versão 2019.2 do Tableau Server, a execução de comandos tsm não exigirá que você insira uma senha se a seguinte for verdadeiro:

  • A conta com a qual você está executando comandos é membro do grupo autorizado pelo TSM, que é o grupo de administradores locais no computador Windows.
  • Você está executando comandos localmente no Tableau Server que está executando o serviço do controlador de administração do Tableau Server. Por padrão, o serviço do controlador de administração do Tableau Server é instalado e configurado no nó inicial em uma implantação distribuída.

Fazer logon na CLI tsm localmente

Se estiver executando comandos tsm no computador local com a conta de usuário que é membro de um grupo autorizado pelo TSM, você não precisará especificar uma senha. Neste caso, apenas execute o comando, por exemplo:

tsm version

Fazer logon na CLI tsm remotamente

Se estiver executando comandos do TSM em um nó em um cluster em que o serviço do controlador de administração do Tableau Server não estiver em execução, você deverá autenticar uma sessão com o serviço do controlador de administração do Tableau Server no computador remoto antes de executar comandos. Por exemplo, execute o comando a seguir:

tsm login -s <server_name> -u <account_name>

Em que <server_name> é o nome do nó em que o serviço do controlador de administração do Tableau Server está sendo executado e <account_name> é uma conta membro de um grupo autorizado pelo TSM.

Após executar este comando, você será solicitado a fornecer uma senha. Depois que a conta for autenticada, você poderá executar os comandos do TSM.

Como prática recomendada de segurança, não exponha a porta TSM (por padrão, 8850) para a internet.

Script e automação com a CLI tsm

O TSM é um arquivo de lote. Para executar comandos TSM em outro arquivo de lote, use o comando call. Por exemplo, "call tsm maintenance ziplogs”. Executar essa ação retornará o controle para o arquivo de lote.

Para executar a automação em um Tableau Server sem uma senha no arquivo de script, execute o script no nó inicial e com uma conta no grupo autorizado pelo TSM. Consulte a seção "Autenticação" acima.

Exibição do conteúdo de ajuda no shell

Para visualizar o conteúdo de ajuda mínimo de uma linha de comando, use a categoria tsm help.

Sinopse

tsm help [category] [command]

Comandos

tsm help

Ajuda de todos os comandos tsm

tsm help <category>

Mostra a ajuda de uma categoria de comandos específica. Por exemplo, tsm help authentication.

tsm help <category> <command>

Mostra a ajuda de um comando específico. Por exemplo, tsm help authentication open-id.

tsm help commands

Lista todos os comandos ou as categorias de nível superior.

Categorias

Voltar para o topo
Agradecemos seu feedback!Seu feedback foi enviado. Obrigado!