tsm maintenance

Use os comandos tsm maintenance para gerenciar tarefas de manutenção do servidor, como criar backups regulares ou restaurar o Tableau Server de um backup criado anteriormente.

tsm maintenance backup

Cria um backup dos dados gerenciados pelo Tableau Server. Entre esses dados está o banco de dados PostgreSQL do Tableau (o repositório) que contém metadados da pasta de trabalho e do usuário de dados, além de dados de extração (.tde ou .hyper). Estes dados não incluem os dados de configuração. Consulte Executar um backup e uma restauração completos do Tableau Server.

Localizar o repositório (pgsql) e o Armazenamento de arquivos no mesmo nó do controlador de administração pode reduzir o tempo necessário para fazer backup do Tableau Server. O controlador de administração geralmente está no nó inicial, a menos que você tenha uma falha inicial do nó e precise mover o controlador para outro nó.

Quando o repositório é colocado no mesmo local do controlador, ele elimina ou reduz significativamente a necessidade de compactar e transferir dados entre nós durante o processo de backup. Isso também ocorre com o Armazenamento de arquivos, especialmente se a sua empresa usa extrações muito.

Sinopse

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

Opções

-d, --append-date

Opcional.

Anexa a data atual ao nome do arquivo de backup.

-f, --file <backup_file>

Obrigatório.

Grava o backup no arquivo indicado. Uma extensão do .tsbak é usada automaticamente. O arquivo está gravado no diretório definido na variável basefilepath.backuprestore do TSM . Como padrão:

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

Para obter mais informações sobre os caminhos do arquivo e como alterá-los, consulte tsm File Paths.

-i, --description <string>

Opcional.

Inclui a descrição detalhada do arquivo de backup.

--skip-compression

Opcional.

Crie um backup sem usar a compactação. Isso resulta em um arquivo de backup maior, mas pode reduzir a quantidade de tempo que leva para concluir o backup. Caso use em uma instalação em vários nós, recomendamos fortemente que tenha uma instância Armazenamento de arquivos configurada no nó inicial.

-k, --skip-verification

Opcional.

Não verifica a integridade do backup de banco de dados.

--override-disk-space-check

Opcional.

Tenta criar um backup mesmo quando há um aviso de pouco espaço no disco.

-po, --pg-only

Opcional.

Gera somente o backup 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).

Exemplos

Este exemplo cria um backup chamado ts_backup-<yyyy-mm-dd>.tsbak na pasta <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\:

tsm maintenance backup -f ts_backup -d

tsm maintenance cleanup

Exclua arquivos de registro e temporários antigos.

Se estiver executando o Tableau Server em uma implantação distribuída, execute esse comando no nó com o processo do Controlador de administração em execução (também chamado Controlador do TSM). Por padrão, o controlador encontra-se no nó inicial do cluster.

O objetivo desse comando é criar espaço livre na implantação do Tableau, excluindo os arquivos antigos. Portanto, a execução desse comando quando o servidor é iniciado removerá a maior parte do conteúdo antigo desse cenário. Para remover os arquivos de registro atuais, você deve interromper o servidor antes de executar esse comando.

Observação: esse comando foi adicionado na versão 10.5.1 do Tableau Server e algumas opções foram adicionadas na versão de 2018.1.

Sinopse

tsm maintenance cleanup [options] [global options]

Opções

-a, --all

Opcional.

Executar todas as operações de limpeza com valores de retenção padrão. Equivalente a executar o comando cleanup com as seguintes opções: -l -t -r -q.

--http-requests-table-retention <nº de dias>

Opcional.

Excluir entradas de tabela de solicitações http mais antigas que este número de dias. (Padrão: 7 dias)

-l, --log-files

Opcional.

Exclua arquivos de log mais antigos que o retention-period. Arquivos nos subdiretórios em data\tabsvc\logs serão excluídos.

--log-files-retention <# of days>

Opcional.

Padrão: 1 (24 horas)

Exclui registros mais antigos do que este número de dias. Este comando não se aplica aos arquivos temporários.

-q, --http-requests-table

Opcional.

Excluir entradas de tabela http_requests antigas.

-r, --redis-cache

Opcional.

Limpar o cache Redis.

--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, --temp-files

Opcional.

Exclui todos os arquivos e subdiretórios dentro dos seguintes diretórios:

  • <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\temp: apenas diretórios que armazenam arquivos de sessões expiradas (fora de execução) são excluídos.

  • <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\httpd\temp

  • <install dir>\ProgramData\Tableau\Tableau Server\temp

-v, --verbose

Opcional.

Mostrar detalhes do que foi limpo.

Exemplos

Este exemplo limpa todos os arquivos de registro mais antigos do que 2 dias atrás:

tsm maintenance cleanup -l --log-files-retention 2

tsm maintenance metadata-services enable

Use o comando tsm maintenance metadata-services enable para habilitar a API de metadados do Tableau para o Tableau Server.

Se o Tableau Server estiver licenciado com o Data Management Add-on, a ativação da API de metadados habilitará o Tableau Catalog.

Ao habilitar a API de metadados, as informações sobre o conteúdo no Tableau Server são aceitas e, em seguida, indexadas para o Armazenamento de API de metadados. A API de metadados pode ser usada para consultar esquema, linhagem e metadados gerenciados pelo usuário sobre o conteúdo publicado no Tableau Server. Após habilitar a API de metadados, os metadados são continuamente inseridos e indexados até que a API de metadados seja desabilitada.

Ao executar este comando, lembre-se do seguinte:

  • Este comando interrompe e inicia alguns serviços usados pelo Tableau Server, que faz com que determinadas funcionalidades, como o Recomendações, fiquem temporariamente indisponíveis para os usuários.
  • Um novo índice de metadados é criado e substitui o índice anterior sempre que esse comando é usado.

Para obter mais informações sobre o Catálogo do Tableau, consulte Sobre o Tableau Catalog.

Sinopse

tsm maintenance metadata-services enable

Opção

--ignore-prompt

Opcional.

Ignore o prompt de confirmação ao habilitar a API de metadados.

tsm maintenance metadata-services disable

Use o comando tsm maintenance metadata-services disable para habilitar a API de metadados do Tableau para o seu servidor.

Desabilitar a API de metadados interrompe a inserção e a indexação contínuas de informações sobre o conteúdo no Tableau Server, exclui o índice de informações sobre o conteúdo publicado no Tableau Server e ativos associados a esse conteúdo e desabilita a capacidade de consultar a API de metadados e acessar o Catálogo do Tableau.

A execução desse comando interrompe e inicia alguns serviços usados pelo Tableau Server, que faz com que determinadas funcionalidades, como o Recomendações, fiquem temporariamente indisponíveis para os usuários.

Sinopse

tsm maintenance metadata-services disable

Opção

--ignore-prompt

Opcional.

Ignore o prompt de confirmação ao desabilitar a API de metadados.

tsm maintenance metadata-services get-status

Use o comando tsm maintenance metadata-services get-status para obter informações de status sobre os Serviços de Metadados.

Status nos Serviços de Metadados indica se o Repositório de API de Metadados foi inicializado ou se a API de Metadados do Tableau está em execução ou não.

Sinopse

tsm maintenance metadata-services get-status

tsm maintenance reindex-search

Use o comando tsm maintenance reindex-search para recriar o índice de pesquisa.

Sinopse

tsm maintenance reindex-search [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).

tsm maintenance restore

Restaura o Tableau Server usando o arquivo de backup indicado. A restauração de um arquivo de backup não restaura os dados de configuração. Consulte Executar um backup e uma restauração completos do Tableau Server.

Só é possível restaurar a partir de um backup que tenha o mesmo tipo de armazenamento de identidades que o servidor que está rodando. Por exemplo, um backup de um servidor que usa autenticação local pode ser restaurado para um Tableau Server inicializado por autenticação local, mas um backup de um servidor que usa autenticação por Diretório ativo não pode ser restaurado para um servidor inicializado por autenticação local.

Sinopse

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

Opções

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

Opcional. Especifique esta opção somente se estiver restaurando dos ativos criados pelo tabadmin no Tableau Server (versões 2018.1 e anteriores).

O nome do arquivo da chave de recurso a ser restaurado. O arquivo da chave de recurso é criado pelo comando tabadmin assetkeys. O arquivo deve estar no local predefinido de backup/restauração do servidor.

-f, --file <file_name>

Obrigatório.

Especifica o arquivo de backup do qual deve ser restaurado.

O comando restore exige um arquivo de backup no diretório definido na variável basefilepath.backuprestore do TSM. Como padrão:

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

Para obter mais informações sobre os caminhos do arquivo e como alterá-los, consulte tsm File Paths.

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

Opcional. Especifique esta opção somente se estiver restaurando de um arquivo de backup criado pelo tabadmin no Tableau Server (versões 2018.1 e anteriores).

Ignore a verificação do armazenamento de identidades. Especifique esta opção se estiver restaurando um arquivo de backup criado com o comando tabadmin backup --no-config.

-po, --pg-only

Opcional.

Restaure somente o repositório.

-r, --restart-server

Opcional.

Reinicia o servidor após a restauraçã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).

tsm maintenance send-logs

Faz o upload do arquivo especificado no Tableau e o associa a um caso de suporte.

Sinopse

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

Opções

-c,--case <case_number>

Obrigatório.

Número do caso de suporte.

-e,--email <contact_email>

Obrigatório.

E-mail de contato.

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

Obrigatório.

Especifica a localização e o nome do arquivo de registro arquivado para envio.

--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 maintenance validate-resources

Valida as pastas de trabalho e fontes de dados para um site.

Sinopse

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

Opções

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

Obrigatório.

ID do site cujos recursos você está validando.

-r,--repair

Opcional.

Repare os recursos inválidos.

--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 maintenance ziplogs

Usa o comando ziplogs para criar um armazenamento dos arquivos de log do Tableau Server.

Sinopse

tsm maintenance ziplogs [options] [global options]

Opções

-a, --all

Opcional.

Inclui todos os arquivos, exceto os dados de PostgreSQL.

-d, --with-postgresql-data

Opcional.

Inclui a pasta de dados do PostgreSQL se o Tableau Server for interrompido, ou os arquivos de despejo do PostgreSQL, se o Tableau Server estiver sendo executado.

--description <string>

Opcional.

Inclui a descrição detalhada do arquivo de armazenamento.

-f, --file <name>

Opcional.

Define um nome para o arquivo de armazenamento zipado. Se nenhum nome for fornecido, o armazenamento é criado como logs.zip. O arquivo está gravado no diretório definido na variável basefilepath.log_archive do TSM . Como padrão:

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

Para obter mais informações sobre os caminhos do arquivo e como alterá-los, consulte tsm File Paths.

-i, --description <string>

Opcional.

Inclui a descrição detalhada do arquivo de armazenamento.

-mi, --with-msinfo

Opcional.

Inclua o relatório msinfo32, com informações do sistema sobre o sistema operacional, o hardware e o software em execução.

-l, --with-latest-dump

Opcional.

Quando qualquer serviço falhar, o Tableau Server gerará um arquivo de despejo. Defina essa opção para incluir o arquivo de dump de falha de serviço mais recente. Se você não definir essa opção, então, nenhum arquivo de despejo será incluído no ziplog resultante.

-m, --minimumdate <date>

Opcional.

A data mais recente dos arquivos de log a serem incluídos. Se não for especificado, no máximo dois dias de arquivo de log são incluídos. O formato da data deve ser "mm/dd/yyyy".

-o, --overwrite

Opcional.

Para a substituição de um arquivo ziplog existente. Se já existir um arquivo com o mesmo nome e essa opção não for usada, ocorrera uma falha no comando ziplogs.

Por padrão, o arquivo é gravado em:

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

Para obter mais informações sobre os caminhos do arquivo e como alterá-los, consulte tsm File Paths.

--request-timeout <tempo limite em segundos>

Opcional.

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

-t, --with-netstat-info

Opcional.

Incluir as informações de netstat.

 

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 <url_to_tsm>

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, e não o endereço IP, por exemplo https://mytableauhost: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.

 

Agradecemos seu feedback! Ocorreu um erro ao enviar seu feedback. Tente novamente ou envie-nos uma mensagem.