Ajuda do Tableau Server no Windows

Use os comandos de tsm topology para preparar os nós do Repositório de arquivos para a remoção segura ou para colocá-los de volta em modo leitura/gravação. Também é possível iniciar um failover de repositório, obter uma lista de nós ou portas, obter o arquivo de configuração bootstrap exigido para incluir nós adicionais ao seu cluster, remover nós, configurar o repositório externo e o Armazenamento de arquivos externo.

Importante: ao fazer alterações na topologia, você precisa aplicar as alterações pendentes para que as alterações entrem em vigor. Para obter mais informações, consulte tsm pending-changes.

tsm topology cleanup-coordination-service

Observação: começando com a versão 2020.1.0, todos os comandos do ensemble de serviço de coordenação requerem entrada para um prompt "y/n", confirmando que haverá reinicialização do servidor. Para executar esses comandos sem entrada, inclua a opção --ignore-prompt.

Use o comando tsm topology cleanup-coordination-service para remover o ensemble do Serviço de coordenação de não produção doTableau Server depois de implantar um novo ensemble. Esse comando remove as instâncias antigas do Serviço de coordenação em todos os nós no ensemble do Serviço de coordenação de não produção e é necessário após implantar um novo ensemble desse serviço. Para saber mais sobre os ensembles do Serviço de coordenação, consulte Implantar um ensemble do Serviço de coordenação.

Na versão 2020.1.0 e posterior, o comando tsm topology deploy-coordination-service também remove o ensemble antigo. Não há necessidade de executar este comando separadamente, a menos que a implantação falhe.

Sinopse

tsm topology cleanup-coordination-service [option] [global options]

Opção

--request-timeout <tempo limite em segundos>

Opcional.

Aguarde o tempo predefinido para que o comando seja concluído. O valor padrão é 2.700 (45 minutos).

tsm topology deploy-coordination-service

Observação: começando com a versão 2020.1.0, todos os comandos do ensemble de serviço de coordenação requerem entrada para um prompt "y/n", confirmando que haverá reinicialização do servidor. Para executar esses comandos sem entrada, inclua a opção --ignore-prompt.

É possível usar o comando tsm topology deploy-coordination-service para implantar o Serviço de coordenação do Tableau Server. Este comando implanta um ensemble do Serviço de coordenação, que é um conjunto de instâncias do Serviço de coordenação, executadas em nós especificados no cluster do servidor. Para saber mais sobre os ensembles do Serviço de coordenação, inclusive quantos nós no cluster devem ter uma instância do Serviço de coordenação, consulte Implantar um ensemble do Serviço de coordenação.

Na versão 2020.1.0 e posterior, o comando tsm topology deploy-coordination-service também remove o ensemble antigo. Não há necessidade de executar o comando cleanup-coordination-service separadamente.

Sinopse

tsm topology deploy-coordination-service --nodes <nodeID,nodeID,...> [option] [global-options]

Opções

-n, --nodes <nodeID,nodeID,...>

Obrigatório.

As IDs dos nós para a incluir no novo ensemble do Serviço de coordenação, separadas por vírgulas. Especifique 1, 3 ou 5 nós do Serviço de coordenação, dependendo do número total de nós no cluster. Para obter mais informações, consulte O quórum do Serviço de coordenação.

--request-timeout <tempo limite em segundos>

Opcional.

Aguarde o tempo predefinido para que o comando seja concluído. O valor padrão é 2.700 (45 minutos).

tsm topology external-services gateway disable [options] [global options]

tsm topology external-services gateway enable [options] [global options]

tsm topology external-services gateway update [option] [global options]

tsm topology external-services list

Use o comando tsm topology external-service-list para obter um serviço usado para o Repositório externo do Tableau Server. Por exemplo, se você configurou o Tableau Server para usar o Amazon RDS, você verá a seguinte mensagem:

Esses serviços configurados externamente estão sendo usados pelo Tableau Server:

- pgsql

Sinopse

tsm topology external-service list [global options]

Opção

Não há opções para este comando.

tsm topology external-services repository disable -n nodeN

Use o comando tsm topology external-services repository disable para interromper o uso do repositório externo e reconfigurar a instalação para usar um repositório local. Isso migrará os dados para um repositório local e configurará o Tableau Server para usar o repositório local.

Sinopse

tsm topology external-services repository disable -n nodeN

Opção

-n, --node-name <nodeID>

Obrigatório.

Especifica a ID do nó para onde o repositório deve ser movido.

Importante: isso não interrompe ou exclui a instância de RDS. Para obter mais informações sobre como excluir uma instância de RDS, consulte Exclusão de uma instância de DB(O link abre em nova janela) no site do AWS.

tsm topology external-services repository enable

Use o comando tsm topology external-services repository enable para configurar o Tableau Server para usar um repositório externo. Esse comando pode ser usado durante a instalação de um novo Tableau Server para configurar o repositório externo. Se executado em um Tableau Server já existente e em execução, esse comando migrará os dados do nó local para o repositório externo e configurará o Tableau Server para usar o repositório externo após a conclusão da migração.

Sinopse

tsm topology external-services repository enable -f <filename>.json -c <ssl certificate file>.pem

Opções

--f <file name>

Obrigatório.

Caminho e nome de arquivo completos do local onde o arquivo de configuração foi salvo. Para obter mais informações, consulte Reconfigurar o repositório do Tableau Server.

--c <ssl certificate file>

Obrigatório para as versões 2021.2 e 2021.2.1. Opcional para versões 2021.2.2 e posteriores.

Para configurações SSL, baixe o arquivo de certificado e especifique o arquivo para uso com essa opção.

1. Amazon RDS: consulte Uso de SSL para criptografar a conexão a uma instância de banco de dados(O link abre em nova janela).

2. Banco de dados do Azure: consulte Configurar a conectividade TLS no banco de dados do Azure para PostgreSQL(O link abre em nova janela).
3. Instância PostgreSQL autônoma: consulte Configurar o SMTP .

--no-ssl

Opcional. Esta opção está disponível nas versões 2021.2.2 e posteriores.

Isso significa que o SSL não é necessário ao se conectar ao Repositório externo. Se você não precisa usar conexões criptografadas, também deve configurar o Repositório externo para permitir conexões não criptografadas. Ao usar esta opção, as conexões serão criptografadas se o repositório externo estiver configurado para oferecer suporte a conexões TLS/SSL. Caso contrário, o Tableau Server usará conexões não criptografadas.

Ignora a verificação para ver se o repositório externo já está configurado para uso com o Tableau Server. Essa opção normalmente não é recomendada, pois pode fazer com que o mesmo repositório seja usado por várias instalações do Tableau Server, o que pode causar erros. Esta opção pode ser útil para fins de teste ou recuperação de desastres.

--skip-state-check

Opcional. Esta opção está disponível nas versões 2022.3.0 e posteriores.

Ignora a verificação para ver se o repositório externo já está configurado para uso com o Tableau Server. Essa opção pode ser útil para fins de teste ou recuperação de desastres, mas não é recomendada para uso normal, pois pode fazer com que o mesmo repositório seja usado por várias instalações do Tableau Server.

tsm topology external-services repository replace-host

Este comando atualiza as configurações do Tableau Server para usar o repositório externo especificado. Use o comando tsm topology external-services repository replace-host para reconfigurar o Tableau Server para usar o novo repositório externo imediatamente, sem mover dados do repositório externo atual para ele. Pode ser necessário migrar manualmente os dados. Só faça isso depois de ter avaliado completamente e entendido o impacto da potencial perda de dados.

Esse comando pode ser usado nos seguintes cenários:

• Expiração planejada dos certificados SSL usados pelas instâncias RDS: as instâncias RDS precisam ser atualizadas com os novos certificados, e o Tableau Server precisa ser configurado para usar o novo arquivo de certificado para se conectar à instância RDS.

• Recuperação de desastres: use isso para se conectar a uma nova instância RDS em cenários de recuperação de desastres. Para obter mais informações, consulte Criar uma instância de banco de dados PostgreSQL no Serviço de banco de dados relacional (RDS) da AWS

Sinopse

tsm topology external-services repository replace-host -f <filename>.json -c <ssl certificate file>.pem

Opções

-f <file name>

Obrigatório.

Caminho e nome de arquivo completos do local onde o arquivo de configuração foi salvo. Para obter mais informações, consulte Reconfigurar o repositório do Tableau Server.

-c <ssl certificate file>

Opcional.

O arquivo de certificado é o certificado a ser importado para permitir conexões com a instância. Para RDS, esse é o certificado CA usado para assinar o certificado da instância. Ele é geralmente o arquivo de certificado raiz rds-ca-XXXX-root.pem mais recente. Use esse parâmetro para atualizar o Tableau Server se o certificado tiver sido alterado na instância RDS.

Para obter mais informações, consulte Uso de SSL/TLS para criptografar a conexão com a uma instância de banco de dados.

Para obter mais informações sobre como obter o arquivo .pem, consulte Uso de SSL para criptografar uma conexão com uma instância de DB(O link abre em nova janela).

--ignore-prompt

Opcional.

Execute esse comando sem instruções.

tsm topology external-services storage disable [options] [global options]

tsm topology external-services storage enable [options] [global options]

tsm topology external-services storage switch-share [option] [global options]

tsm topology failover-repository

É possível usar tsm topology failover-repository para iniciar manualmente um failover do repositório atualmente ativo para o segundo repositório passivo.

O comando tsm topology failover-repository é persistente. O failover de repositório permanece como o repositório ativo até que emita o comando novamente, ou, se o Tableau Server estiver configurado para isso, até que ocorra o failover automático. Se você tiver um repositório ativo de preferência configurado, use a opção --preferred para retornar para esse repositório. Para obter mais informações sobre a configuração de um repositório ativo de preferência, consulte Repositório do Tableau Server.Se o Tableau Server estiver configurado para alta disponibilidade, o failover do repositório é automático, quando necessário. Use o comando do failover de repositório para fazer o failover manual do repositório.

Sinopse

tsm topology failover-repository --preferred | --target <node_id> [global options]

Opções

-r, --preferred

Exigido se -t ou --target não for usado.

Use o nó de preferência como o destino para o failover de repositório.

--request-timeout <tempo limite em segundos>

Opcional.

Aguarde o tempo predefinido para que o comando seja concluído. O valor padrão é 1800 (30 minutos).

-t, --target <node_id>

Exigido se -r ou --preferred não for usado.

A ID do nó de destino na qual ocorrerá o failover. Localize a ID do nó usando o comando tsm topology list-nodes.

tsm topology filestore decommission

Você deve usar o comando tsm topology filestore decommission para preparar um nó ou nós do armazenamento de arquivos para a remoção segura. Este comando coloca os nós especificados em modo somente leitura e garante que não há conteúdo exclusivo nos nós especificados.

Se a desativação resultar em um nó único do armazenamento de arquivos, use a opção --override, ou ocorrerá uma falha na desativação.

Sinopse

tsm topology filestore decommission --nodes <nodeID,nodeID,...> [options] [global options]

Opções

-n, --nodes <nodeID,nodeID,...>

Obrigatório.

Liste um ou mais nós para desativar, especificados pela ID do nó e separados por vírgulas.

--delete-filestore

Opcional.

Força a remoção do armazenamento de arquivos, mesmo se ele não tiver sido desativado. Você só deve usar esta opção se o nó no qual o armazenamento de arquivos se encontra estiver em estado de erro e não seja possível desativá-lo. Qualquer arquivo único no nó será permanentemente excluído.

-o, --override

Opcional.

Substitui avisos ou falhas que normalmente ocorreriam se a remoção do nó de destino do Repositório de arquivos reduzisse o número de nós do repositório de arquivos restantes para um. Essa opção não pode ser usada com a opção --delete-filestore.

--request-timeout <tempo limite em segundos>

Opcional.

Aguarde o tempo predefinido para que o comando seja concluído. O valor padrão é 1800 (30 minutos).

tsm topology filestore recommission

Use o comando tsm topology filestore recommission para reverter todos os nós desativados de volta para o modo de leitura/gravação.

Sinopse

tsm topology filestore recommission --nodes <nodeID,nodeID,...> [global options]

Opções

-n, --nodes <nodeID,nodeID,...>

Obrigatório.

Liste um ou mais nós para reativar, especificados pela ID do nó e separados por vírgulas.

tsm topology list-nodes

Exibe os nós no cluster e (opcionalmente) nos serviços em cada nó.

Sinopse

tsm topology list-nodes [options] [global options]

Opções

tsm topology list-ports

Exibe as portas no cluster.

Sinopse

tsm topology list-ports [options] [global options]

Opções

--node-name <nodeID>

Opcional.

Determina o nó para o qual as portas serão listadas.

--service-name

Opcional.

Especifica o serviço para o qual as portas serão listadas.

tsm topology node-nickname list

Obtenha os pseudônimos dos nós no cluster.

Sinopse

tsm topology node-nickname list [options] [global options]

Opções

--nodes <nodeID,nodeID,...>

Opcional.

Especifique as IDs dos nós a serem listadas com pseudônimos.

tsm topology node-nickname remove

Remova o pseudônimo do nó ou nós especificados.

Sinopse

tsm topology node-nickname remove [options] [global options]

Opções

--all

Obrigatório se --nodes não está especificado.

Obtenha os pseudônimos de todos os nós no cluster.

--nodes <nodeID,nodeID,...>

Obrigatório se --all não for especificado.

Especifique a ID do nó ou nós cujos pseudônimos devem ser removidos.

tsm topology node-nickname set

Configure o pseudômino para o nó especificado.

Sinopse

tsm topology node-nickname set [options] [global options]

Opções

-id, --node <nodeID>

Obrigatório.

Especifique o nó para o qual configurar o apelido.

-nn, --nickname <name>

Obrigatório.

O pseudônimo do nó especificado.

tsm topology nodes get-bootstrap-file

É possível usar o comando tsm topology nodes get-bootstrap-file para obter o arquivo bootstrap necessário para adicionar um novo nó ao cluster.

Sinopse

tsm topology nodes get-bootstrap-file --file <path\file>.json [global options]

Opções

-f,--file <file>

Obrigatório.

Caminho e nome de arquivo completos do local onde o arquivo de configuração será salvo. Se existir um arquivo duplicado, ele será substituído.

-nec,--no-embedded-credential

Opcional.

Adicionado na versão 2019.3.

Por padrão, as credenciais inseridas são incluídas no arquivo bootstrap. Use essa opção caso as credenciais não devam ser incluídas no arquivo bootstrap. As credenciais inseridas são temporárias e expiram de acordo com o valor da chave de configuração tabadmincontroller.auth.expiration.minutes, por padrão, 120 minutos.

Observação: é possível desabilitar a capacidade de incluir credenciais inseridas no nível do servidor, usando uma opção de configuração. Para obter mais informações, consulte features.PasswordlessBootstrapInit.

tsm topology remove-nodes

Remove os nós do cluster.

Para concluir a remoção de um nó, você também deve executar o comando tsm pending-changes apply. Alguns cenários exigem que os processos sejam movidos ou reimplantados antes da remoção dos nós. Consulte Remover um nó.

Se você remover um nó e quiser adicioná-lo novamente ao cluster, primeiro será necessário executar o script obliterate para limpar o Tableau e depois reinstalar o nó usando o processo normal de adição de um novo nó. Para obter mais informações, consulte Remover o Tableau Server do computador e Instalar e configurar nós adicionais.

Observação: para remover um nó de um cluster, é possível que tenha sido configurado com um processo em algum ponto. Se estiver removendo um nó no qual nunca configurou processos, é necessário adicionar um processo a ele, executar tsm pending-changes apply e remover o nó.

Sinopse

tsm topology remove-nodes --nodes <nodeID,nodeID,...> [global options]

Opções

-n, --nodes <nodeID,nodeID,...>

Obrigatório.

Especifica o nó ou nós a serem removidos. Se estiver especificando vários nós, separe as IDs do nó por vírgula.

tsm topology set-node-role

Defina as funções do nó do Processador em segundo plano e Extrair consultas. Isso determina o tipo de tarefas que será executado nos nós. As seguintes funções de nó podem ser úteis se você tiver um cluster de vários nós. Diferentes funções de nó podem exigir licenças para Advanced Management ou Data Management, ou para ambos. Para obter mais informações sobre os requisitos da licença, consulte Gerenciamento de carga de trabalho por meio das funções de nó.

Observação: fazer configurações para funções de nó requer uma reinicialização do servidor e exigirá algum tempo de inatividade. Para obter mais informações, consulte tsm pending-changes.

Sinopse

tsm topology set-node-role [options] [global options]

Opções

-n, --nodes <nodeID,nodeID,...>

Obrigatório.

Liste um ou mais nós para definir funções de nó, especificados pela ID do nó e separados por vírgulas e sem espaços entre os nós.

-r --role <all-jobs,flows,no-flows,extract-refreshes,subscriptions,extract-refreshes-and-subscriptions,no-extract-refreshes,no-subscriptions,no-extract-refreshes-and-subscriptions,extract-queries,extract-queries-interactive>

Obrigatório

Define a função para os nós especificados. Os valores válidos para esta opção são:

• todos os trabalhos: o processador em segundo plano executará todos os tipos de trabalho.

• fluxos: o processador em segundo plano executará somente os trabalhos de execução de fluxo.

• nenhum fluxo: o processador em segundo plano não executará os trabalhos de execução de fluxo.

• atualizações de extração: o processador em segundo plano executará somente os trabalhos de atualização de extração. Isso inclui atualizações incrementais, atualizações completas, criptografia e descriptografia de todas as extrações, incluindo as extrações geradas pelas saídas de fluxo.

• assinaturas: o processador em segundo plano executará somente os trabalhos de assinatura.

• atualizações de extração e assinaturas: o processador em segundo plano executará os trabalhos de atualizações de extração, criptografia e descriptografia de todas as extrações, incluindo as extrações criadas pelas saídas de fluxo e assinatura.

• nenhuma atualização de extração: o processador em segundo plano executará todos os trabalhos, exceto as atualizações de extração, criptografia e descriptografia de extração, incluindo as extrações criadas pelas saídas de fluxo.

• nenhuma assinatura: o processador em segundo plano executará todos os trabalhos, exceto as assinaturas.

• nenhuma atualização de extração e assinatura: o processador em segundo plano executará todos os trabalhos, exceto as atualizações de extração, criptografia e descriptografia de todas as extrações, incluindo as extrações criadas pelas saídas de fluxo e assinaturas.

• extract-queries: os nós selecionados serão executados como all-jobs e priorizarão o processamento das consultas de extração.

• extract-queries-interactive: os nós selecionados serão executados como todos os trabalhos e priorizarão o processamento de consultas de extração interativas, como aquelas que são executadas quando um usuário está olhando para sua tela e aguardando o carregamento de um painel baseado em extração. Esta é uma configuração avançada e só deve ser usada se o cluster tiver uma carga de trabalho pesada de assinatura e alertas, que faz com que os usuários tenham um desempenho diminuído em tempos de carregamentos de visualização que são executados na mesma hora que carregamentos agendados.

• system: o processador em segundo plano executará apenas trabalhos de manutenção do sistema que interagem com outros processos do Tableau Server, como limpeza de trabalhos travados, coleta de eventos de banco de dados e sincronização do Active Directory.

• no-system: o processador em segundo plano executará todos os trabalhos, exceto as assinaturas.

tsm topology set-ports

Define as portas para uma instância de serviço.

Sinopse

tsm topology set-ports --node-name <nodeID> --port-name <port_name> --port-value <port_value> [options] [global options]

Opções

-i, --instance <instance_id>

Opcional.

Especifica a id de instância do serviço. Coloca 0 (zero) como padrão, se não especificado.

-n, --node-name <nodeID>

Obrigatório.

Especifica a ID do nó.

-pn, --port-name <port_name>

Obrigatório.

O nome da porta a ser definida, neste formato: service_name:port_type. Se nenhum tipo de porta for especificado, a porta primária é considerada. Para obter sintaxe de nome de porta, consulte Portas mapeadas dinamicamente.

-pv, --port-value <port_value>

Obrigatório.

A porta a ser definida.

-r, --restart

Opcional.

Suprime o prompt de reinicialização e reinicializa o Tableau Server quando necessário.

tsm topology set-process

Definir o número de instâncias de processo em um nó. Se o nó já tiver o processo especificado, o número é atualizado para corresponder à contagem especificada.

• É possível definir apenas um processo por vez. Se você especificar mais que um processo, qualquer processo depois dele será ignorado silenciosamente.
• Você deve definir um nó de processo de cada vez. Se você especificar mais de um nó, o comando exibirá um erro de "nome de nó inválido".

Ao atualizar o número de processos nos números, também é preciso aplicar as alterações pendentes. Na maioria dos casos, isso também requer uma reinicialização do servidor (você será solicitado), mas há casos especiais em que você pode fazer alterações dinâmicas de topologia sem precisar reiniciar o servidor. Para obter mais informações, consulte Alterações de topologia dinâmica do Tableau Server.

Observação: para obter uma lista completa dos nomes de processo, consulte Processos do Tableau Server.

Sinopse

tsm topology set-process --count <process_count> --node <nodeID> --process <process_name> [global options]

Opções

-c, --count <process_count>

Obrigatório.

A contagem de processo (número de instâncias) a ser definida.

-n, --node <nodeID>

Obrigatório.

Especifica a ID do nó no qual será definido o processo.

-pr, --process <process_name>

Obrigatório.

O nome do processo a ser definido.

tsm topology toggle-coordination-service

Observação: começando com a versão 2020.1.0, todos os comandos do ensemble de serviço de coordenação requerem entrada para um prompt "y/n", confirmando que haverá reinicialização do servidor. Para executar esses comandos sem entrada, inclua a opção --ignore-prompt.

É possível usar o comando tsm topology toggle-coordination-service para alternar entre ensembles do Serviço de coordenação. Para saber mais sobre os ensembles do Serviço de coordenação, consulte Implantar um ensemble do Serviço de coordenação.

Na versão 2020.1.0 e posterior, o comando tsm topology deploy-coordination-service também muda para o novo ensemble. Não há necessidade de executar este comando separadamente.

Sinopse

tsm topology toggle-coordination-service [option] [global options]

Opção

--request-timeout <tempo limite em segundos>

Opcional.

Aguarde o tempo predefinido para que o comando seja concluído. O valor padrão é 1800 (30 minutos).

Opções globais

-h, --help

Opcional.

Exibir a ajuda do comando.

-p, --password <senha>

Obrigatório, com -u ou --username se não tiver sessões ativas.

Especificar a senha do usuário especificado no -u ou --username.

Se a senha tiver espaços ou caracteres especiais, coloque-a entre aspas:

--password "my password"

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

Opcional.

Usar o endereço definido para o Gerenciador de serviços do Tableau. A URL deve começar com https, incluir a porta 8850 e usar o nome do servidor, não o endereço IP. Por exemplo, https://<tsm_hostname>:8850. Se nenhum servidor for especificado, o https://<localhost | dnsname>:8850 é considerado.

--trust-admin-controller-cert

Opcional.

Use este sinalizador para confiar no certificado autoassinado do controlador TSM. Para obter mais informações sobre confiança de certificado e conexões CLI, consulte Conexão de clientes do TSM.

-u, --username <usuário>

Obrigatório se nenhuma sessão estiver ativa, com -p ou --password.

Especificar uma conta de usuário. Se não incluir essa opção, o comando é executado usando as credenciais de logon.