Utilitário de linha de comando rmtadmin

O Resource Monitoring Tool inclui uma interface de linha de comando, rmtadmin.cmd, localizada na pasta de instalação. O diretório de instalação padrão é:

  • RMT Server %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\Master
  • Agente: %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\agent

Observação: você deve executar o prompt de comando como Administrador para que esses comandos sejam executados com sucesso.

O rmtadmin está incluído nas instalações de RMT Server e Agente. Alguns comandos podem variar se você estiver usando o utilitário de linha de comando RMT Server ou Agente rmtadmin. Por exemplo, o comando users só funciona no RMT Server. O comando ziplogs está disponível em todos os lugares, mas inclui apenas os arquivos de registro do aplicativo em que o comando é executado.

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>

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 Resource Monitoring Tool está instalado no Tableau Server.

Esse comando só funciona no RMT Server.

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. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

--keys

Opcional: inclui a chave do agente na saída.

Exemplo:rmtadmin agents --env=<myenvironmentidentifier> --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 RMT Server.

Sinopse

rmtadmin bootstrap-file [options][global option]

Opções

--env

Obrigatório. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.
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=<myenvironmentidentifier>

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 RMT Server e no Agente.

Observação: se os processos do Resource Monitoring Tool 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-files-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-admin-user

Versão: adicionado na versão 2022.1.

Cria um usuário administrador inicial se não houver outros usuários.

Observação: a partir da versão 2023.1, você pode criar vários usuários administradores.

Esse comando só funciona no RMT Server.

Sinopse

rmtadmin create-admin-user [options][global option]

Opções

--username

Opcional. O nome de usuário para a conta de usuário administrador. Coloca “admin” como padrão, se não especificado.

--password

Obrigatório. A senha para a conta de usuário administrador.

--password-file

Opcional. O caminho para o arquivo que contém a senha da conta de usuário administrador. Você pode usar isso se não quiser digitar a senha diretamente e ter a senha armazenada em um arquivo que pode ser acessado.

Exemplo:rmtadmin create-admin-user --username<admin user name> --password <password for the admin user account>

rmtadmin create-env

Observação: adicionado na versão 2021.2

Criar um novo ambiente.

Esse comando só funciona no RMT Server.

Sinopse

rmtadmin create-env [options][global option]

Opções

OpçãoObrigatório?PadrãoDescrição
--nameSimn/aO nome do ambiente.
--gateway-url

Sim

 

n/a

URL usado para acessar o gateway do Tableau Server.

--versionSimn/aVersã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.
--api-usernameNãoNuloNome 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-fileNãoNuloO 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-serverSim

Nulo

É o nome do servidor para o banco de dados PostgreSQL que está instalado com Tableau Server.
--repository-databaseSimNuloÉ o nome do banco de dados PostgreSQL que está instalado com Tableau Server.
--repository-portSimNuloO número da porta do aplicativo do banco de dados do Repositório do Tableau Server.
--repository-usernameSimNulo

Nome de usuário usado para se conectar ao banco de dados PostgreSQL instalado com o Repositório do Tableau Server.

O Resource Monitoring Tool 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-passwordSimNulo

Senha para a conta de usuário usada para se conectar ao banco de dados PostgreSQL instalado com o Tableau Server.

O Resource Monitoring Tool 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-fileNão, mas obrigatório se você não fornecer a senha no prompt de comando ou diretamente em um script.NuloO caminho incluindo o nome do arquivo onde a senha da conta do usuário é usada para se conectar ao banco de dados PostgreSQL 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

NuloAo configurar o Tableau Server PostgreSQL para permitir conexões diretas, o Tableau Server cria um certificado e chaves. Você pode optar por fornecer a impressão digital para o certificado gerada pelo Tableau Server ou copiar o arquivo server.crt para a máquina do RMT Server da Resource Monitoring Tool. 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 data-access

Observação: adicionado na versão 2022.3

Habilita ou desabilita o acesso ao banco de dados PostgreSQL. Observação: o acesso ao banco de dados PostgreSQL é necessário a partir da versão 2022.3 para que o Resource Monitoring Tool colete com êxito todos os dados de monitoramento do Tableau Server.

Esse comando só funciona no RMT Server

Observação: o banco de dados PostgreSQL deve ser reiniciado para que esta configuração tenha efeito.

Sinopse

rmtadmin data-access [positional parameter][options] [global option]

Parâmetro de posição

modo

Obrigatório. O modo que deve ser usado para acesso remoto de dados ao banco de dados PostgreSQL. Os valores devem ser: None, ReadOnly, Admin. Quando definido como None, o acesso aos dados é desabilitado. ReadOnly e Admin especificam qual conta de usuário usar para acessar o banco de dados.

Opções

--

Exemplo:

rmtadmin data-access ReadOnly

rmtadmin restart --db

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 Resource Monitoring Tool.

Esse comando só funciona no RMT Server.

Sinopse

rmtadmin delete-env [positional parameter][options] [global option]

Parâmetro de posição

env

Obrigatório. Este é o identificador gerado pelo sistema. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

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

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 RMT Server.

Sinopse

rmtadmin delete-env-data [positional parameter][option][global option]

Parâmetro de posição

env

O identificador do ambiente para o qual os dados devem ser excluídos. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

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

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 RMT Server.

Sinopse

rmtadmin delete-server [options][global option]

Opções

--env

Obrigatório. O identificador do ambiente ao qual o nó do Tableau Server está conectado. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

--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 RMT Server.

Sinopse

rmtadmin delete-server-data [options][global option]

Opções

--env

Obrigatório. O identificador do ambiente ao qual o nó do Tableau Server está conectado. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

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

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.

Este comando só funciona quando executado no Agente RMT. Execute isso no agente cujo registro você deseja cancelar.

Sinopse

rmtadmin deregister [options]

Opções

--confirm

Opcional. Confirme se deseja cancelar o registro do Agente. Isso ignora o prompt de confirmação.

--ignore-master-errors

Opcional. Ignora quaisquer erros que ocorram durante a comunicação com o RMT Server durante este processo.

Exemplo:rmtadmin deregister --confirm

rmtadmin deregister-agent

Observação: adicionado na versão 2021.2

Cancele o registro do Agente especificado 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.

Este comando só funciona quando executado no RMT Server.

Sinopse

rmtadmin deregister-agent [options][global option]

Opções

--env

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

Este é o identificador do ambiente onde o Agente está registrado atualmente. Este é o identificador gerado pelo sistema. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

--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=<myenvironmentidentifier> --all

rmtadmin environments

Observação: adicionado na versão 2021.2

Lista todos os ambientes no Server do Resource Monitoring Tool.

Esse comando só funciona no RMT Server.

Sinopse

rmtadmin environments [global option]

rmtadmin get

Obtém o valor da chave de configuração especificada.

Esse comando pode ser usado no RMT Server 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

ChaveTipo de dadosAplica-se aPADRÃODescrição
db:databaseCadeia de caracteresRMT ServertabrmtdbNome do banco de dados PostgreSQL usado pela RMT.
db:readOnlyUsernameCadeia de caracteresRMT ServerreadonlyNome de usuário de uma conta de usuário PostgreSQL que só tem acesso somente leitura para os dados da RMT.
db:readOnlyPasswordCadeia de caracteresRMT ServerGerado pelo programa instalador.Senha do usuário somente leitura do PostgreSQL.
mq:tls:certificateHostNameCadeia de caracteresRMT Server e Agenten/aNome do host no certificado que deve ser usado ao se conectar ao RabbitMQ via TLS.
mq:tls:enabledBooleanoRMT Server e AgenteFALSEAtivar/desativar conexão TLS ao RabbitMQ.
mq:portInteiroRMT Server e Agente5672Número da porta de host RabbitMQ.
mq:virtualHostCadeia de caracteresRMT Server e AgentetabrmtConexão com o RMT Server ou Agente. Para Agente, você pode modificar esta configuração registrando o Agente com um arquivo bootstrap. Para o RMT Server, o valor é gerenciado pelo instalador.
server.web.runBooleanoAgenteTRUEAtivar 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 RMT Server e no Agente.

Sinopse

rmtadmin help

Mostra a ajuda e a utlização de um comando específico:

Esse comando pode ser usado no RMT Server e no Agente.

rmtadmin help [command]

rmtadmin master-setup

Configura o RMT Server 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çãoObrigatório?PadrãoDescriçã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/aA 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/aA senha do usuário administrador.
--admin-usernameNãoadminO nome de usuário administrador.
--skip-admin-creation

Adicionado: versão 2020.4.0

Descontinuado: versão 2022.3.0

Não

Essa opção só deve ser usada quando você fizer atualizações de configuração pós-instalação.

Nas versões onde esta opção é válida (2020.4.0 - 2022.2.x), se não for usada durante as atualizações de configuração pós-instalação, o comando falhará e nenhuma atualização será feita.

Nas versões 2022.3.0 e posteriores, o comando criará o administrador quando necessário.

False

Pule a criação do usuário e senha do administrador.

--http-portNão80 
--require-httpsNãoFalseRedirecione o tráfego http para HTTPS.
--https-certificate-modeNão

'Padrão'

Opções disponíveis:

  • Padrão
  • Armazenamento (somente windows)
  • Local

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-thumbprintNãoNuloO certificado HTTPS hash/impressão digital para procurar no modo de certificado 'store'.
--https-certificate-local-nameNão

Nulo

Nota: se não especificado, o Resource Monitoring Tool é instalado com um certificado autoassinado e usará esse certificado para comunicações HTTPS.

O nome do arquivo de certificado HTTPS.
--https-certificate-local-passwordNãoNuloA senha a ser usada para o certificado HTTPS.
--https-certificate-local-password-fileNãoNuloO caminho para o arquivo contendo a senha a ser usada para o certificado HTTPS.
--confirmNãoSolicitaçã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 Resource Monitoring Tool. O servidor ouvirá todos os IPs independentemente do nome do host.
--db-config=externalNãoNenhuma.
Isso só é usado quando o repositório é configurado externamente ao RMT Server.
Use isso para configurar o RMT Server para usar um repositório externo. Você não precisa especificar isso se quiser que o banco de dados PostgreSQL seja instalado localmente.
--db-serverNãoValor de configuração atual ou padrão do instalador.

É o nome do servidor para o banco de dados PostgreSQL que está instalado com o Resource Monitoring Tool.

Se você estiver usando um repositório externo hospedado no AWS RDS, esse deve ser o nome da instância do RDS.

--db-ssl-mode

Versão: adicionado na versão 2023.1.0.

NãoPrefer

Isso determina a criptografia SSL/TLS para a conexão com o banco de dados PostgreSQL instalado com o Resource Monitoring Tool.

As opções são Prefer (o padrão), VerifyCA e VerifyFull. Para obter detalhes, consulte a documentação Npgsql(O link abre em nova janela).

--db-portNãoValor de configuração atual ou padrão do instalador.Número da porta para o servidor de banco de dados.
--db-usernameNãoValor 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 Resource Monitoring Tool.

Se você estiver usando um repositório externo hospedado no AWS RDS, deve ser "postgres".

--db-passwordNãoValor 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 Resource Monitoring Tool.

Se você estiver usando um repositório externo hospedado no AWS RDS, esta é a senha do usuário que você criou ao criar a instância do RDS.

--mq-config=externalNãoNenhum
Esta opção é especificada apenas quando o serviço de mensagens é hospedado externamente ao RMT Server.
Esta opção configura o RMT Server para usar um serviço de mensagens Rabbit MQ externo.
--mq-serverNãoValor de configuração atual ou padrão do instalador.O nome do servidor da fila de mensagens.
--mq-portNãoValor de configuração atual ou padrão do instalador.A porta da fila de mensagens.
--mq-vhostNãoValor de configuração atual ou padrão do instalador.O host virtual da fila de mensagens.
--mq-usernameNãoValor de configuração atual ou padrão do instalador.O nome de usuário usado para se conectar à fila de mensagens.
--mq-passwordNãoValor de configuração atual ou padrão do instalador.A senha da conta de usuário usada se conecta à fila de mensagens.
--mq-enable-tlsNãoValor de configuração atual ou false. Requer conexão TLS para se conectar à fila de mensagens.
--mq-tls-certificate-hostNãoValor 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-saltNãoAleatório

O salt global usado para gerar o hash da senha.

Isso se aplica às contas de usuário locais criadas no Resource Monitoring Tool.

--password-min-lengthNãoValor de configuração atual ou 10.

O comprimento mínimo para a senha.

Isso se aplica às contas de usuário locais criadas no Resource Monitoring Tool.

--password-min-numericNãoValor 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 Resource Monitoring Tool.

--password-min-specialNãoValor 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 Resource Monitoring Tool.

--password-min-latinNãoValor 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 Resource Monitoring Tool.

--password-require-mixed-caseNãoValor 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 Resource Monitoring Tool.

--auth-timeout-minutesNãoValor 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-expirationNãoConfiguraçã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> --skip-admin-creation

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 Resource Monitoring Tool.

Esse comando só funciona no RMT Server.

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 Resource Monitoring Tool e salva os resultados em um arquivo de saída.

Esse comando só funciona no RMT Server.

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

Nome do arquivo zip para o qual deseja gerar os resultados de consulta. O padrão é queryresults.zip

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

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 RMT Server.

--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 Resource Monitoring Tool. 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 RMT Server e no Agente.

Sinopse

rmtadmin restart [options] [global option]

Opções

Pelo menos uma opção deve ser especificada:

RMT Server:

--all

Reinicia todos os serviços.

--master

Reinicia o RMT Server.

--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 rotate-mq-certificate

Rotaciona o certificado do cliente da fila de mensagens do Agente.

Esse comando precisa ser executado no Agente do RMT.

Sinopse

rmtadmin rotate-mq-certificate [options] [positional parameter]

Parâmetro de posição

bootstrap

O caminho do arquivo, incluindo o nome do arquivo bootstrap.

Opções

--username

Obrigatório. O nome de usuário do servidor primário.

--password

Obrigatório. Senha da conta de usuário do servidor primário.

--password-file

Caminho incluindo o nome do arquivo que contém as informações da senha do servidor primário. 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.

--confirm-restart

Confirma a reinicialização do serviço e ignora o prompt de confirmação.

rmtadmin rotate-mq-certificates

Alterna o servidor da fila de mensagens e os certificados do cliente.

Esse comando precisa ser executado no RMT Server.

Sinopse

rmtadmin rotate-mq-certificates [options]

Opções

--confirm-restart

Confirma a reinicialização do serviço e ignora o prompt de confirmação.

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 RMT Server.

Sinopse

rmtadmin servers [positional parameter][global option]

Parâmetro de posição

env

Opcional. Especifique o identificador do ambiente para obter uma lista de nós do Tableau Server registrados nesse ambiente. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

rmtadmin service-setup

Observação: adicionado na versão 2021.4. Usado para instalar ou atualizar a credencial do usuário para serviços da Resource Monitoring Tool, incluindo RMT Server, 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 RMT Server 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 RMT Server.

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 RMT Server.

mq

Atualiza o serviço de fila de mensagens. Só pode ser executado no RMT Server.

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 RMT Server)
  • 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 RMT Server 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

ChaveTipo de dadosAplica-se aPADRÃODescrição
mq:tls:certificateHostNameCadeia de caracteresRMT Server e Agenten/aNome do host no certificado que deve ser usado ao se conectar ao RabbitMQ via TLS
mq:tls:enabledBooleanoRMT Server e AgenteFALSEAtivar/desativar conexão TLS ao RabbitMQ
mq:portInteiroRMT Server e Agente5672Número da porta de host RabbitMQ.
server.web.runBooleanoAgenteTRUEAtivar 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 Resource Monitoring Tool. Quando é executado no RMT Server, inicia o RMT Server somente. Quando executado em um Agente, inicia o Agente na máquina em que você está executando o comando.

Esse comando funciona no RMT Server e no Agente

Sinopse

rmtadmin start [options] [global option]

Opções

Pelo menos uma opção deve ser especificada:

RMT Server:

--all

Inicia todos os serviços.

--master

Inicia o RMT Server.

--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 RMT Server, o relatório de status confirma que o RMT Server está conectado ao banco de dados e à fila de mensagens. Para Agentes, o relatório de status confirma que o agente está conectado ao RMT Server.

Esse comando pode ser executado no RMT Server 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 Resource Monitoring Tool. Quando esse comando é executado no RMT Server, ele para somente o RMT Server. 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 RMT Server e no Agente.

Sinopse

rmtadmin stop [options] [global option]

Opções

Pelo menos uma opção deve ser especificada:

RMT Server:

--all

Interrompe todos os serviços.

--master

Para o RMT Server.

--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 Resource Monitoring Tool 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 Advanced Management (anteriormente Server Management Add-on).

Esse comando só funciona no RMT Server.

Sinopse

rmtadmin test-env [positional parameter][global option]

Parâmetro de posição

--env

Opcional. O identificador do ambiente que oResource Monitoring Tool está monitorando. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

--force

Opcional. Use esta opção para atualizar a linha de base imediatamente, mesmo que não haja dados suficientes disponíveis. Por padrão, o comando aguardará 50 carregamentos bem-sucedidos para calcular a linha de base

rmtadmin update-baseline

Observação: adicionado na versão 2021.4.

Atualiza a linha de base para todas as cargas de vista. A linha de base é o 95º percentil de 50 tempos de carregamento inicial bem-sucedidos para uma visualização.

Esse comando só funciona no RMT Server.

Sinopse

rmtadmin update-baseline [options][global option]

Opções

env

Obrigatório. Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

rmtadmin update-env

Observação: adicionado na versão 2021.2

Atualiza as configurações do ambiente.

Esse comando só funciona no RMT Server.

Sinopse

rmtadmin update-env [options][global option]

Opções

OpçãoObrigató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.
--nameSimO nome do ambiente.
--idNãoIdentificador do ambiente usado em URLs de interface da Web.

Este é o identificador gerado pelo sistema. Você pode encontrar isso acessandoAdmin >Environments >Edit Environment . Nesta página, na seçãoEnvironment Details, você verá o identificador para o ambiente.

--gateway-url

Não

 

URL usado para acessar o gateway do Tableau Server.

--versionNãoVersão do Tableau Server que este ambiente monitorará.
--api-usernameNãoNome 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-passwordNão

Senha da conta de usuário da API do Tableau Server usada para se conectar às APIs do Tableau Server.

--api-password-fileNãoO caminho para o arquivo que contém a senha da conta de usuário da API do Tableau Server.
--repository-serverNãoÉ o nome do servidor para o banco de dados PostgreSQL que está instalado com o Resource Monitoring Tool.
--repository-portNãoO número da porta do aplicativo do banco de dados do Repositório do Tableau Server.
--repository-usernameNão

Nome de usuário usado para se conectar ao banco de dados PostgreSQL instalado com o Repositório do Tableau Server.

O Resource Monitoring Tool 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-passwordNão

Senha para a conta de usuário usada para se conectar ao banco de dados PostgreSQL instalado com o Tableau Server.

O Resource Monitoring Tool 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-passwordNãoO caminho incluindo o nome do arquivo onde a senha da conta do usuário é usada para se conectar ao banco de dados PostgreSQL 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

Ao configurar o Tableau Server PostgreSQL para permitir conexões diretas, o Tableau Server cria um certificado e chaves. Você pode optar por fornecer a impressão digital para o certificado gerada pelo Tableau Server ou copiar o arquivo server.crt para a máquina do RMT Server da Resource Monitoring Tool. 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 Resource Monitoring Tool.

Esse comando só funciona no RMT Server.

Sinopse

rmtadmin users

rmtadmin version

Mostra as informações atuais da versão do RMT Server quando executado na máquina do RMT Server. 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 RMT Server e no Agente.

Sinopse

rmtadmin version

rmtadmin ziplogs

Cria um arquivo de ZIP contendo os arquivo de registro do Resource Monitoring Tool.

Esse comando funciona no RMT Server 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

--help

Mostra a ajuda do comando.

Agradecemos seu feedback!Seu feedback foi enviado. Obrigado!