O Ferramenta de monitoramento de recursos inclui uma interface de linha de comando, rmtadmin.cmd
, localizada na pasta de instalação. O diretório de instalação padrão é:
- Servidor RMT
/var/opt/tableau/tabrmt/master/
- Agente:
/var/opt/tableau/tabrmt/agent/
.
O
rmtadmin
está incluído nas instalações de Servidor RMT e Agente. Alguns comandos podem variar se você estiver usando o utilitário de linha de comando Servidor RMT ou Agentermtadmin
. Por exemplo, o comandousers
só funciona no Servidor RMT. O comandoziplogs
está disponível em todos os lugares, mas inclui apenas os arquivos de registro do aplicativo em que o comando é executado.
Observação: você deve executar esses comandos como usuário tabrmt-master
:sudo su --login tabrmt-master
Aqui estão os comandos que podem ser usados com a linha de comando rmtadmin
:
Observação: os comandos rmtadmin
usam parâmetros posicionais e opções.
Os parâmetros posicionais devem ser especificados usando apenas os valores. Você não precisa especificar a palavra-chave real. A palavra-chave da opção e o valor devem ser especificados usando um sinal de igual.
Exemplo: rmtadmin <command> <positional parameter value> --<option keyword>=<value>
- rmtadmin agents
- rmtadmin bootstrap-file
- rmtadmin cleanup
- rmtadmin create-env
- rmtadmin delete-env
- rmtadmin delete-env-data
- rmtadmin delete-server
- rmtadmin delete-server-data
- rmtadmin deregister-agent
- rmtadmin environments
- rmtadmin get
- rmtadmin help
- rmtadmin master-setup
- rmtadmin passwd
- rmtadmin query
- rmtadmin register
- rmtadmin restart
- rmtadmin-servers
- rmtadmin-service-setup
- rmtadmin set
- rmtadmin start
- rmtadmin stop
- rmtadmin status
- rmtadmin test-env
- rmtadmin update-env
- rmtadmin users
- rmtadmin version
- rmtadmin ziplogs
Em um esforço para nos alinhar com os valores de Igualdade de nossa empresa, mudamos a terminologia não inclusiva sempre que possível. Como a alteração dos termos em determinados locais pode causar uma alteração significativa, mantemos a terminologia existente, Portanto, você pode continuar a ver os termos em comandos e opções da CLI, pastas de instalação e arquivos de configuração e outras instâncias. Para obter mais informações, consulte Sobre a Ajuda do Tableau.
rmtadmin agents
Observação: adicionado na versão 2021.2
Lista todos os Agentes registrados nos nós do Tableau Server para todos os ambientes.
Isso é útil para ver onde o Agente do Ferramenta de monitoramento de recursos está instalado no Tableau Server.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin agents [options][global option]
Opções
-
--env
-
Opcional: use esta opção para ver a lista de Agentes para o ambiente específico.
-
--keys
-
Opcional: inclui a chave do agente na saída.
Exemplo:
rmtadmin agents --env=<myenvironment> --keys
rmtadmin bootstrap-file
Observação: adicionado na versão 2021.2
Cria e salva o arquivo de bootstrap usado para registrar agentes nos nós do Tableau Server.
O arquivo de bootstrap será criado e salvo no caminho absoluto ou relativo especificado. Os caminhos relativos são resolvidos para o diretório de trabalho atual.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin bootstrap-file [options][global option]
Opções
-
--env
-
Obrigatório. Nome do ambiente que monitorará este Tableau Server. O agente em um nó do Tableau Server só pode ser registrado em um ambiente por vez.
-
--filename
-
Opcional. O caminho absoluto ou relativo, incluindo o nome do arquivo. Os caminhos relativos são resolvidos para o diretório de trabalho atual. Se não for especificado, o nome do arquivo de saída padrão será usado.
-
--force
-
Opcional. Substitui o arquivo existente com o mesmo nome.
Exemplo:
rmtadmin bootstrap-file --env=<myenvironment>
rmtadmin cleanup
Observação: adicionado na versão 2021.2
Exclui os arquivos de registro mais antigos do que um determinado número de dias. Por padrão, ele exclui arquivos de registro com mais de 31 dias.
Esse comando funciona no Servidor RMT e no Agente.
Observação: se os processos do Ferramenta de monitoramento de recursos estiverem em execução, os arquivos de registro ativos não serão limpos pelo comando. Se você quiser ter certeza de que todos os arquivos foram excluídos, você precisará interromper o RMT usando o comando rmtadmin_stop e, em seguida, executar a limpeza usando o seguinte comando ,rmtadmin cleanup --log-files-retention=0
e, em seguida, reiniciar os processos usando o comando rmtadmin_start.
Sinopse
rmtadmin cleanup [option][global option]
Opção
-
--log-fles-retention
-
Opcional. Exclui os arquivos de registro mais antigos que o número de dias especificado.
Exemplo:
rmtadmin cleanup --log-files-retention=<number of days>
rmtadmin create-env
Observação: adicionado na versão 2021.2
Criar um novo ambiente.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin create-env [options][global option]
Opções
Opção | Obrigatório? | Padrão | Descrição |
---|---|---|---|
--name | Sim | n/a | O nome do ambiente. |
--gateway-url |
Sim
|
n/a |
URL usado para acessar o gateway do Tableau Server. |
--version | Sim | n/a | Versão do Tableau Server que este ambiente monitorará. |
--non-interactive |
Não
|
Os prompts interativos são ativados por padrão. | Desativa todos os prompts interativos. |
--no-test |
Não
|
O teste de conexão da API e do repositório é ativado por padrão. | Desativa o teste de conexões de API e repositório. |
--id | Não | Sistema gerado com base no nome do ambiente. | Identificador do ambiente usado em URLs de interface da Web. |
--api-username | Não | Nulo | Nome de usuário da conta usada para se conectar às APIs do Tableau Server. A conta de usuário deve ser um administrador do Tableau Server com acesso a todos os sites do Tableau Server. |
--api-password |
Não (Se você especificar o nome de usuário da API do Tableau, fornecerá a senha ou especificará o caminho do arquivo e o arquivo que contém a senha) |
Nulo |
Senha da conta de usuário da API do Tableau Server usada para se conectar às APIs do Tableau Server. |
--api-password-file | Não | Nulo | O caminho para o arquivo e o nome do arquivo que contém a senha da conta de usuário da API do Tableau Server. |
--repository-server | Não |
Nulo |
É o nome do servidor para o banco de dados PostgreSQL que está instalado com Tableau Server |
--repository-port | Não | Nulo | O número da porta do aplicativo do banco de dados do Repositório do Tableau Server. |
--repository-username | Não | Nulo |
Nome de usuário usado para se conectar ao banco de dados PostgreSQL instalado com o Repositório do Tableau Server. O Ferramenta de monitoramento de recursos acessa o banco de dados do Repositório do Tableau Server diretamente, por motivos de desempenho. Para que isso funcione, o acesso ao repositório deve ser habilitado, com uma senha definida para o usuário do banco de dados readonly (somente leitura). Para obter detalhes, consulte Habilitar o acesso ao repositório do Tableau Server. |
--repository-password | Não | Nulo |
Senha para a conta de usuário usada para se conectar ao banco de dados PostgreSQL instalado com o Tableau Server. O Ferramenta de monitoramento de recursos acessa o banco de dados do Repositório do Tableau Server diretamente, por motivos de desempenho. Para que isso funcione, o acesso ao repositório deve ser habilitado, com uma senha definida para o usuário do banco de dados readonly (somente leitura). Para obter detalhes, consulte Habilitar o acesso ao repositório do Tableau Server. |
--repository-password-file | Não | Nulo | O caminho incluindo o nome do arquivo onde a senha da conta do usuário é usada para se conectar ao banco de dados PosgreSQL instalado com o Tableau Server. |
--repository-ssl-mode |
Não |
Prefira |
Modo SSL do repositório do Tableau Server: Prefira SSL ou Exija SSL para configurar conexões SSL para o repositório do Tableau. Desative para nunca usar SSL para fazer conexões de Repositório do Tableau Server. |
--repository-ssl-thumbprint |
Não |
Nulo | Você pode optar por fornecer a impressão digital gerada pelo Tableau Server ou copiar o arquivo server.crt para a máquina do Servidor RMT da Ferramenta de monitoramento de recursos. Se você optar por copiar o arquivo de certificado, não precisará fornecer a impressão digital. Para obter mais informações, consulte Configurar Postgres SSL para permitir conexões diretas de clientes. |
Exemplo:
rmtadmin create-env --name=<myenvironment> --api-username=<TableauServer API user name> --api-password=<password for the Tableau Server API user account> --gateway-url <Tableau Server Gateway URL> --version <Tableau Server version>
rmtadmin delete-env
Observação: adicionado na versão 2021.2
Exclui um ambiente específico e todos os dados coletados para esse ambiente. Ele também remove as informações de conexão e topologia sobre o Tableau Server que o ambiente está monitorando e cancela o registro de todos os Agentes do Ferramenta de monitoramento de recursos.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin delete-env [positional parameter][options] [global option]
Parâmetro de posição
-
env
-
Obrigatório. O nome do ambiente de trabalho que você deseja excluir.
Opções
-
--confirm
-
Opcional. Confirme se deseja excluir o ambiente. Se você não fornecer esta opção, será solicitado a confirmar.
-
--skip-agent-disconnect
-
Opcional. Pula a desconexão do agente e continua com o cancelamento do registro do agente. Use esta opção se achar que o agente está inacessível - Por exemplo, se o nó do Tableau Server foi removido ou se o agente foi desinstalado nesse nó.
Exemplo:
rmtadmin delete-env <myenvironment>
rmtadmin delete-env-data
Exclui permanentemente todos os dados relacionados do Tableau Server coletados para um ambiente específico. A configuração do ambiente, as informações do Tableau Server e o registro do agente não serão removidos.
Isso é útil para limpar todos os dados existentes em um ambiente sem remover o próprio ambiente. Depois de excluir os dados existentes, novos dados enviados pelos agentes continuarão a ser processados.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin delete-env-data [positional parameter][option][global option]
Parâmetro de posição
-
env
-
O nome do ambiente para o qual os dados devem ser excluídos.
Opção
-
--confirm
-
Opcional. Confirme se deseja excluir os dados do ambiente. Se você não fornecer esta opção, será solicitado a confirmar.
Exemplo:
rmtadmin delete-env-data <myenvironment>
rmtadmin delete-server
Observação: adicionado na versão 2021.2
Exclui as informações de configuração do nó do Tableau Server do ambiente, cancela o registro do Agente nesse nó e exclui todos os dados de monitoramento coletados específicos para esse nó.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin delete-server [options][global option]
Opções
-
--env
-
Obrigatório. O nome do ambiente ao qual o nó do Tableau Server está conectado.
-
--hostname
-
Necessário para excluir informações sobre um ou mais conectados ao ambiente e se --all não for especificado.
É o nome da máquina do nó do Tableau Server. Use vírgulas para separar vários valores se especificar mais de um nome de host.
-
--all
-
Opcional, mas obrigatório se --hostname não for especificado.
Exclui as informações de todos os nós do Tableau Server conectados ao ambiente.
-
--skip-agent-disconnect
-
Opcional. Pula a desconexão do agente e continua com o cancelamento do registro do agente. Use esta opção se o agente estiver inacessível - por exemplo, se o nó foi removido do Tableau Server ou se o Agente foi desinstalado naquele nó.
-
--confirm
-
Confirme se deseja excluir todas as informações sobre o nó do Tableau Server. Se você não fornecer esta opção, será solicitado a confirmar.
Exemplo:
rmtadmin delete-server --hostname=<machine name of the Tableau Server node>
rmtadmin delete-server-data
Observação: adicionado na versão 2021.2
Exclui os dados coletados de um ou mais nós do Tableau Server. Os dados removidos pertencem apenas aos nós especificados. Se você especificar all, todos os dados coletados de todos os nós serão excluídos. A configuração do ambiente, as informações do Tableau Server e os registros do agente não serão excluídos.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin delete-server-data [options][global option]
Opções
-
--env
-
Obrigatório. O nome do ambiente ao qual o nó do Tableau Server está conectado.
-
--hostname
-
Necessário para excluir informações sobre um ou mais conectados ao ambiente e se --all não for especificado.
É o nome da máquina do nó do Tableau Server. Use vírgulas para separar vários valores se especificar mais de um nome de host.
-
--all
-
Opcional, mas obrigatório se --hostname não for especificado.
Exclui os dados de monitoramento de todos os nós do Tableau Server conectados ao ambiente.
-
--confirm
-
Confirme se deseja excluir todos os dados de monitoramento dos nós do Tableau Server. Se você não fornecer esta opção, será solicitado a confirmar.
Exemplo:
rmtadmin delete-server-data --all
rmtadmin deregister-agent
Observação: adicionado na versão 2021.2
Cancele o registro do Agente do ambiente. Os dados de monitoramento deste nó não serão mais coletados. Os dados existentes permanecerão e não serão excluídos.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin deregister-agent [options][global option]
Opções
-
--env
-
Obrigatório se --key não for especificado.
Este é o nome do ambiente onde o Agente está registrado atualmente.
-
--key
-
Opcional se --env for especificado.
Esta é a chave do Agente. Use vírgulas para separar vários valores. Você pode obter os valores-chave executando o comando rmtadmin agents.
-
--hostname
-
Opcional. Nome da máquina do nó do Tableau Server em que o Agente está instalado. Use vírgulas para separar vários valores.
-
--all
-
Opcional. Use esta opção para cancelar o registro de Agentes em todos os nós.
-
--ignore-agent-errors
-
Opcional. Ignora todos os erros que ocorrem se não for possível conectar-se com os Agentes durante este processo.
-
--skip-agent-disconnect
-
Opcional. Pula a desconexão do agente e continua com o cancelamento do registro do agente. Use esta opção se você achar que o Agente está inacessível - por exemplo, se o nó foi removido do Tableau Server ou se o Agente foi desinstalado naquele nó.
-
--confirm
-
Opcional. Confirme se deseja cancelar o registro o Agente. Se você não fornecer esta opção, será solicitado a confirmar.
Exemplo:
rmtadmin deregister-agent --env=<myenvironment> --all
rmtadmin environments
Observação: adicionado na versão 2021.2
Lista todos os ambientes no Servidor do Ferramenta de monitoramento de recursos.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin environments [global option]
rmtadmin get
Obtém o valor da chave de configuração especificada.
Esse comando pode ser usado no Servidor RMT e no Agente.
Sinopse
rmtadmin get <config.key> [global option]
Parâmetro de posição
-
key
-
Nome da chave de configuração.
Exemplo:
rmtadmin get db:database
Chaves de configuração suportadas
Chave | Tipo de dados | Aplica-se a | PADRÃO | Descrição |
---|---|---|---|---|
db:database
|
Cadeia de caracteres | Servidor RMT | tabrmtdb | Nome do banco de dados PostgreSQL usado pela RMT. |
db:readOnlyUsername
|
Cadeia de caracteres | Servidor RMT | readonly | Nome de usuário de uma conta de usuário PostgreSQL que só tem acesso somente leitura para os dados da RMT. |
db:readOnlyPassword
|
Cadeia de caracteres | Servidor RMT | Gerado pelo programa instalador. | Senha do usuário somente leitura do PostgreSQL. |
mq:tls:certificateHostName
|
Cadeia de caracteres | Servidor RMT e Agente | n/a | Nome do host no certificado que deve ser usado ao se conectar ao RabbitMQ via TLS. |
mq:tls:enabled
|
Booliano | Servidor RMT e Agente | FALSE | Ativar/desativar conexão TLS ao RabbitMQ. |
mq:port
|
Inteiro | Servidor RMT e Agente | 5672 | Número da porta de host RabbitMQ. |
mq:virtualHost
|
Cadeia de caracteres | Servidor RMT e Agente | tabrmt | Conexão com o Servidor RMT ou Agente. Para Agente, você pode modificar esta configuração registrando o Agente com um arquivo bootstrap. Para o Servidor RMT, o valor é gerenciado pelo instalador. |
server.web.run
|
Booliano | Agente | TRUE | Ativar ou desativar a interface na Web do Agente. |
Use o comando set para alterar o valor da configuração atual.
rmtadmin help
Mostra a ajuda geral sobre a interface da linha de comando e os comandos disponíveis.
Esse comando pode ser usado no Servidor RMT e no Agente.
Sinopse
rmtadmin help
Mostra a ajuda e a utlização de um comando específico:
Esse comando pode ser usado no Servidor RMT e no Agente.
rmtadmin help [command]
rmtadmin master-setup
Configura o Servidor RMT com opções especificadas. Usado durante as configurações de instalação e pós-instalação.
Sinopse
rmtadmin master-setup [options][global option]
As opções de configuração estão listadas abaixo:
Opção | Obrigatório? | Padrão | Descrição |
---|---|---|---|
--admin-password |
Sim (Necessário apenas para instalação inicial) A senha pode ser fornecida na linha de comando ou fornecer um arquivo com a senha a ser usada. Se nenhuma for fornecida, você será solicitado a fornecer uma senha. |
n/a | A senha do usuário administrador. |
--admin-password-file |
Sim (Necessário apenas para instalação inicial) A senha pode ser fornecida na linha de comando ou fornecer um arquivo com a senha a ser usada. Se nenhuma for fornecida, você será solicitado a fornecer uma senha. |
n/a | A senha do usuário administrador. |
--admin-username | Não | admin | O nome de usuário administrador. |
--skip-admin-creation |
Não Essa opção só deve ser usada quando você fizer atualizações de configuração pós-instalação. |
False |
Pule a criação do usuário e senha do administrador. Se essa opção não for usada durante as atualizações de configuração de pós-instalação, o comando falhará e nenhuma atualização será feita. |
--http-port | Não | 80 | |
--require-https | Não | False | Redirecione o tráfego http para HTTPS. |
--https-certificate-mode | Não |
'Padrão' Opções disponíveis:
|
O tipo de pesquisa de certificado para realizar o certificado HTTPS. Padrão: este modo usa o certificado de autoassinatura padrão fornecido pelo instalador. Armazenamento: permite que você digite a impressão digital de um certificado na loja de certificados do Windows. Local: permite especificar um certificado baseado em arquivo na pasta /config. |
--https-certificate-store-thumbprint | Não | Nulo | O certificado HTTPS hash/impressão digital para procurar no modo de certificado 'store'. |
--https-certificate-local-name | Não |
Nulo Nota: se não especificado, o Ferramenta de monitoramento de recursos é instalado com um certificado autoassinado e usará esse certificado para comunicações HTTPS. |
O nome do arquivo de certificado HTTPS. |
--https-certificate-local-password | Não | Nulo | A senha a ser usada para o certificado HTTPS. |
--https-certificate-local-password-file | Não | Nulo | O caminho para o arquivo contendo a senha a ser usada para o certificado HTTPS. |
--confirm | Não | Solicitação de confirmação. | Confirma a reinicialização do Serviço RMT. |
--host |
Não Observação: não recomendamos alterar este valor. |
Valor de configuração atual ou nome da máquina. | A URL preferida para acessar o servidor da Ferramenta de monitoramento de recursos. O servidor ouvirá todos os IPs independentemente do nome do host. |
--db-server | Não | Valor de configuração atual ou padrão do instalador. | É o nome do servidor para o banco de dados PostgreSQL que está instalado com o Ferramenta de monitoramento de recursos. |
--db-port | Não | Valor de configuração atual ou padrão do instalador. | Número da porta para o servidor de banco de dados. |
--db-username | Não | Valor de configuração atual ou padrão do instalador. |
Nome de usuário usado para se conectar ao banco de dados PostgreSQL instalado com o Ferramenta de monitoramento de recursos. O Ferramenta de monitoramento de recursos acessa o banco de dados de repositório diretamente, por motivos de desempenho. Para que isso funcione, o acesso ao repositório deve ser habilitado, com uma senha definida para o usuário do banco de dados readonly (somente leitura). Para obter detalhes, consulte Habilitar o acesso ao repositório do Tableau Server. |
--db-password | Não | Valor de configuração atual ou padrão do instalador. |
Senha para a conta de usuário usada para se conectar ao banco de dados PostgreSQL instalado com o Ferramenta de monitoramento de recursos. O Ferramenta de monitoramento de recursos acessa o banco de dados de repositório diretamente, por motivos de desempenho. Para que isso funcione, o acesso ao repositório deve ser habilitado, com uma senha definida para o usuário do banco de dados readonly (somente leitura). Para obter detalhes, consulte Habilitar o acesso ao repositório do Tableau Server. |
--mq-server | Não | Valor de configuração atual ou padrão do instalador. | O nome do servidor da fila de mensagens. |
--mq-port | Não | Valor de configuração atual ou padrão do instalador. | A porta da fila de mensagens. |
--mq-vhost | Não | Valor de configuração atual ou padrão do instalador. | O host virtual da fila de mensagens. |
--mq-username | Não | Valor de configuração atual ou padrão do instalador. | O nome de usuário usado para se conectar à fila de mensagens. |
--mq-password | Não | Valor de configuração atual ou padrão do instalador. | A senha da conta de usuário usada se conecta à fila de mensagens. |
--mq-enable-tls | Não | Valor de configuração atual ou false. | Requer conexão TLS para se conectar à fila de mensagens. |
--mq-tls-certificate-host | Não | Valor de configuração atual ou null. | O nome canônico do servidor da fila de mensagens. Isso deve coincidir com o nome no certificado. |
--password-salt | Não | Aleatório |
O salt global usado para gerar o hash da senha. Isso se aplica às contas de usuário locais criadas no Ferramenta de monitoramento de recursos. |
--password-min-length | Não | Valor de configuração atual ou 10. |
O comprimento mínimo para a senha. Isso se aplica às contas de usuário locais criadas no Ferramenta de monitoramento de recursos. |
--password-min-numeric | Não | Valor de configuração atual ou 1. |
O mínimo necessário de caracteres numéricos na senha. Isso se aplica às contas de usuário locais criadas no Ferramenta de monitoramento de recursos. |
--password-min-special | Não | Valor de configuração atual ou 1. |
O mínimo necessário de caracteres especiais na senha. Isso se aplica às contas de usuário locais criadas no Ferramenta de monitoramento de recursos. |
--password-min-latin | Não | Valor de configuração atual ou 5. |
O mínimo necessário de caracteres latinos na senha. Isso se aplica às contas de usuário locais criadas no Ferramenta de monitoramento de recursos. |
--password-require-mixed-case | Não | Valor de configuração atual ou true. |
Requer caracteres de letras minúsculas e maiúsculas em senhas. Isso se aplica às contas de usuário locais criadas no Ferramenta de monitoramento de recursos. |
--auth-timeout-minutes | Não | Valor de configuração atual ou 240. | O número de minutos antes que a autenticação do usuário expire para a sessão. |
--auth-slip-expiration | Não | Configuração atual ou true. | Se deve ou não redefinir o período limite de autenticação com a atividade do usuário. |
Exemplos:
Para especificar a senha do administrador:
rmtadmin master-setup --admin-password=<password>
Para atualizar a porta após a instalação:
rmtadmin master-setup --http-port=8000 --skip-admin-creation
rmtadmin passwd
Redefine a senha para uma conta de usuário específica do Ferramenta de monitoramento de recursos.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin passwd [positional parameter][global option]
Parâmetro de posição
-
username
-
Nome do usuário para o qual você deseja alterar a senha.
Exemplo:
rmtadmin passwd <username>
rmtadmin query
Executa uma consulta SQL bruta no banco de dados do Ferramenta de monitoramento de recursos e salva os resultados em um arquivo de saída.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin query [positional parameter][options] [global option]
Parâmetro de posição
-
sql
-
Texto de comando SQL a ser executado. Você pode fornecer vários comandos SQL. Para usar um arquivo com os comandos SQL, use @ como prefixo para o nome do arquivo.
Opções
-
--outfile=VALUE
-
--force
-
Substitui o arquivo existente.
-
--timeout=VALUE
-
tempo limite da consulta. Especifique isso em segundos
-
--commit
-
Confirma as alterações feitas pelo comando SQL no banco de dados. Por padrão, o comando SQL é executado como transação, mas é revertido na conclusão.
Nome do arquivo zip para o qual deseja gerar os resultados de consulta. O padrão é queryresults.zip
Exemplo:
rmtadmin query <SQLCommand> --outfile=<path and the output file name>
rmtadmin register
Observação: adicionado na versão 2020.2
Registra o Agente que usa um arquivo bootstrap. O arquivo de bootstrap pode ser baixado usando o comando rmtadmin bootstrap-file.
Esse comando só pode ser usado no Agente e deve ser executado na máquina em que deseja instalar o Agente.
Sinopse
rmtadmin register [options][positional parameter] [global option]
Parâmetro de posição
-
bootstrap
-
O caminho do arquivo, incluindo o nome do arquivo bootstrap.
Opções
-
--username
-
Obrigatório. Nome do usuário admin criado durante a instalação do Servidor RMT.
-
--password
-
Obrigatório. Senha para a conta do usuário.
-
--password-file
-
Caminho incluindo o nome do arquivo que contém as informações da senha. A senha pode ser fornecida na linha de comando ou em um arquivo que contenha a senha. Se nenhuma for fornecida, você será solicitado a fornecer uma senha.
-
--server-name
-
Nome do nó em que o Agente está sendo instalado. É padrão para o nome da máquina, se nenhum nome for especificado.
-
--server-description
-
Descrição personalizada para o Servidor.
Exemplo:
rmtadmin register <bootstrap file name and path> --server-name=<server name>
rmtadmin restart
Reinicia os aplicativos do Ferramenta de monitoramento de recursos. Quando executado na máquina em que o RMT Server está instalado, ele reinicia o aplicativo RMT Server. Quando executado em um nó em que o Agente está instalado, ele reinicia apenas o aplicativo do Agente naquele nó específico.
Esse comando pode ser executado no Servidor RMT e no Agente.
Sinopse
rmtadmin restart [options] [global option]
Opções
Pelo menos uma opção deve ser especificada:
Servidor RMT:
-
--all
-
Reinicia todos os serviços.
-
--master
-
Reinicia o Servidor RMT.
-
--mq
-
Reinicia o serviço de fila de mensagens.
-
--db
-
Reinicia o serviço de banco de dados.
Agente:
-
--agent
-
Reinicia o serviço do Agente em execução na máquina.
Exemplo:
rmtadmin restart --db
rmtadmin servers
Observação: adicionado na versão 2021.2
Lista todos os nós do Tableau Server em todos os ambientes ou em um ambiente específico.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin servers [positional parameter][global option]
Parâmetro de posição
-
env
-
Opcional. Especifique o nome do ambiente para obter uma lista de nós do Tableau Server registrados nesse ambiente.
rmtadmin service-setup
Observação: adicionado na versão 2021.4 e usado para instalar ou atualizar a credencial do usuário para serviços da Ferramenta de Monitoramento de Recursos, incluindo Servidor RMT, Agente, Rabbit MQ e banco de dados PostgreSQL. Isso é útil para atualizar as informações de serviço pós-instalação.
Esse comando funciona no Servidor RMT e no Agente.
Sinopse
rmtadmin service-setup [positional parameter][options][global option]
Parâmetro de posição
Pelo menos um dos valores a seguir deve ser especificado:
-
Todos
-
Atualiza todos os serviços disponíveis. Pode ser executado no RMT e no Agente. Quando executado em um nó do Tableau Server, atualiza o Agente nesse nó.
-
master
-
Atualiza o Servidor RMT.
-
agent
-
Atualiza o agente. Só pode ser executado no Agente (nó do Tableau Server).
-
db
-
Atualiza o serviço de banco de dados. Só pode ser executado no servidor RMT.
-
mq
-
Atualiza o serviço de fila de mensagens. Só pode ser executado no servidor RMT.
Opções
-
--confirm
-
Opcional. Confirme se deseja fazer atualizações. Pode ser executado no RMT e no Agente. Quando executado em um nó do Tableau Server, atualiza o Agente nesse nó.
-
--user-type
-
Necessário para Servidor e Agente RMT. O tipo de conta usada para executar o Servidor ou Agente RMT. Os valores permitidos são:
- Conta virtual (apenas servidor RMT)
- network-service
- local-system
- local-service
- nome de usuário (nome de usuário da conta de usuário local ou de domínio)
-
--username
-
Especifica o nome de usuário da conta. Obrigatório se estiver usando uma conta de usuário local ou de domínio.
-
--password
-
Especifica a senha da conta. Obrigatório se estiver usando uma conta de usuário local ou de domínio.
-
--password-file
-
Opcional. O caminho para a localização do arquivo, incluindo o nome do arquivo em que as informações de senha estão armazenadas.
-
--append-permissions
-
Opcional. Acrescenta novas permissões. Use se não quiser sobrescrever as permissões existentes.
rmtadmin set
Define o valor da chave de configuração especificada.
Esse comando funciona no Servidor RMT e no Agente.
Sinopse
rmtadmin set [positional parameter] [global option]
Parâmetro de posição
-
key
-
A chave de configuração para a que você deseja alterar o valor.
-
value
-
O novo valor que você deseja usar.
Exemplo:
rmtadmin set mq:port <port number>
em que mq:port é a chave, e o <port number> é o valor.
Chaves de configuração suportadas
Chave | Tipo de dados | Aplica-se a | PADRÃO | Descrição |
---|---|---|---|---|
mq:tls:certificateHostName
|
Cadeia de caracteres | Servidor RMT e Agente | n/a | Nome do host no certificado que deve ser usado ao se conectar ao RabbitMQ via TLS |
mq:tls:enabled
|
Booliano | Servidor RMT e Agente | FALSE | Ativar/desativar conexão TLS ao RabbitMQ |
mq:port
|
Inteiro | Servidor RMT e Agente | 5672 | Número da porta de host RabbitMQ. |
server.web.run
|
Booliano | Agente | TRUE | Ativar ou desativar a interface na Web do Agente. |
Opções
-
--backup
-
Cria um backup do arquivo de configuração, antes de fazer alterações.
Use o comando get para exibir o valor da configuração atual.
rmtadmin start
Inicia os serviços do Ferramenta de monitoramento de recursos. Quando é executado no Servidor RMT, inicia o Servidor RMT somente. Quando executado em um Agente, inicia o Agente na máquina em que você está executando o comando.
Esse comando funciona no Servidor RMT e no Agente
Sinopse
rmtadmin start [options] [global option]
Opções
Pelo menos uma opção deve ser especificada:
Servidor RMT:
-
--all
-
Inicia todos os serviços.
-
--master
-
Inicia o Servidor RMT.
-
--mq
-
Inicia o serviço de fila de mensagens.
-
--db
-
Inicia o serviço de banco de dados.
Agente:
-
--agent
-
Inicia o serviço do Agente em execução na máquina.
Exemplo:
rmtadmin start --all
rmtadmin status
Verifica o status do aplicativo e dos serviços em execução na máquina em que você está executando esse comando. Para o Servidor RMT, o relatório de status confirma que o Servidor RMT está conectado ao banco de dados e à fila de mensagens. Para Agentes, o relatório de status confirma que o agente está conectado ao Servidor RMT.
Esse comando pode ser executado no Servidor RMT e no Agente.
Esse comando retorna o seguinte:
- Status do aplicativo (em execução ou não)
- Status da licença
- Conexão MQ
- Detalhes da fila
- Memória utilizada
- Espaço em disco utilizado
- Versão do Tableau Server na máquina
- Topologia de processo do Tableau Server armazenado no arquivo de configuração do Agente.
Sinopse
rmtadmin status [global option]
rmtadmin stop
Interrompe os serviços do Ferramenta de monitoramento de recursos. Quando esse comando é executado no Servidor RMT, ele para somente o Servidor RMT. Quando executado em uma máquina onde o Agente foi instalado, ele para somente A agente dessa máquina.
Esse comando pode ser executado no Servidor RMT e no Agente.
Sinopse
rmtadmin stop [options] [global option]
Opções
Pelo menos uma opção deve ser especificada:
Servidor RMT:
-
--all
-
Interrompe todos os serviços.
-
--master
-
Para o Servidor RMT.
-
--mq
-
Interrompe o serviço de fila de mensagens.
-
--db
-
Interrompe o serviço de banco de dados.
Agente:
-
--agent
-
Impede que o serviço do Agente seja executado na máquina.
Exemplo:
rmtadmin stop --db
rmtadmin test-env
Observação: adicionado na versão 2021.2
Testa os vários pontos de conexão entre o Ferramenta de monitoramento de recursos e o Tableau Server. Isso inclui testar a conexão do Repositório do Tableau Server, as conexões da API do Tableau Server e o licenciamento do Server Management Add-on.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin test-env [positional parameter][global option]
Parâmetro de posição
-
env
-
Obrigatório. O nome do ambiente no qual você deseja executar o teste.
rmtadmin update-env
Observação: adicionado na versão 2021.2
Atualiza as configurações do ambiente.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin update-env [options][global option]
Opções
Opção | Obrigatório? | Descrição |
---|---|---|
--non-interactive |
Não
|
Desativa todos os prompts interativos. |
--no-test |
Não
|
Desativa o teste de conexões de API e repositório. |
--name | Sim | O nome do ambiente. |
--id | Não | Identificador do ambiente usado em URLs de interface da Web. |
--gateway-url |
Não
|
URL usado para acessar o gateway do Tableau Server. |
--version | Não | Versão do Tableau Server que este ambiente monitorará. |
--api-username | Não | Nome de usuário da conta usada para se conectar às APIs do Tableau Server. A conta de usuário deve ser um administrador do Tableau Server com acesso a todos os sites do Tableau Server. |
--api-password | Não |
Senha da conta de usuário da API do Tableau Server usada para se conectar às APIs do Tableau Server. |
--api-password-file | Não | O caminho para o arquivo que contém a senha da conta de usuário da API do Tableau Server. |
--repository-server | Não | É o nome do servidor para o banco de dados PostgreSQL que está instalado com o Ferramenta de monitoramento de recursos. |
--repository-port | Não | O número da porta do aplicativo do banco de dados do Repositório do Tableau Server. |
--repository-username | Não |
Nome de usuário usado para se conectar ao banco de dados PostgreSQL instalado com o Repositório do Tableau Server. O Ferramenta de monitoramento de recursos acessa o banco de dados do Repositório do Tableau Server diretamente, por motivos de desempenho. Para que isso funcione, o acesso ao repositório deve ser habilitado, com uma senha definida para o usuário do banco de dados readonly (somente leitura). Para obter detalhes, consulte Habilitar o acesso ao repositório do Tableau Server. |
--repository-password | Não |
Senha para a conta de usuário usada para se conectar ao banco de dados PostgreSQL instalado com o Tableau Server. O Ferramenta de monitoramento de recursos acessa o banco de dados do Repositório do Tableau Server diretamente, por motivos de desempenho. Para que isso funcione, o acesso ao repositório deve ser habilitado, com uma senha definida para o usuário do banco de dados readonly (somente leitura). Para obter detalhes, consulte Habilitar o acesso ao repositório do Tableau Server. |
--repository-password | Não | O caminho incluindo o nome do arquivo onde a senha da conta do usuário é usada para se conectar ao banco de dados PosgreSQL instalado com o Tableau Server. |
--repository-ssl-mode |
Não |
Modo SSL do repositório do Tableau Server: Prefira SSL ou Exija SSL para configurar conexões SSL para o repositório do Tableau. Desative para nunca usar SSL para fazer conexões de Repositório do Tableau Server. |
--repository-ssl-thumbprint |
Não |
Você pode optar por fornecer a impressão digital gerada pelo Tableau Server ou copiar o arquivo server.crt para a máquina do Servidor RMT da Ferramenta de monitoramento de recursos. Se você optar por copiar o arquivo de certificado, não precisará fornecer a impressão digital. Para obter mais informações, consulte Configurar Postgres SSL para permitir conexões diretas de clientes. |
Exemplo:
rmtadmin update-env --name=<new name>
rmtadmin users
Mostra uma lista das contas de usuário do Ferramenta de monitoramento de recursos.
Esse comando só funciona no Servidor RMT.
Sinopse
rmtadmin users
rmtadmin version
Mostra as informações atuais da versão do Servidor RMT quando executado na máquina do Servidor RMT. Mostra as informações atuais da versão do Agente instalado na máquina em que você está executando o comando.
Esse comando pode ser executado no Servidor RMT e no Agente.
Sinopse
rmtadmin version
rmtadmin ziplogs
Cria um arquivo de ZIP contendo os arquivo de registro do Ferramenta de monitoramento de recursos.
Esse comando funciona no Servidor RMT e no Agente, mas inclui apenas os arquivos de registro do aplicativo em que o comando é executado.
Sinopse
rmtadmin ziplogs [positional parameter] [option] [global option]
Parâmetro de posição
-
filename
-
Nome do arquivo zip de saída. Padrão para log.zip, se nenhum nome for fornecido.
Opção
-
--force
-
Substitui o arquivo existente.
Exemplo:
rmtadmin ziplogs <zip file name> --force
Opção global
-
Mostra a ajuda do comando.
--help