Ayuda de Tableau Server en Windows

• rmtadmin agents
• rmtadmin bootstrap-file
• rmtadmin cleanup
• rmtadmin create-admin-user
• rmtadmin create-env
• rmtadmin delete-env
• rmtadmin data-access
• 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 rotate-mq-certificate
• rmtadmin rotate-mq-certificates
• rmtadmin-servers
• rmtadmin-service-setup
• rmtadmin set
• rmtadmin start
• rmtadmin stop
• rmtadmin status
• rmtadmin test-env
• rmtadmin update-baseline
• rmtadmin update-env
• rmtadmin users
• rmtadmin version
• rmtadmin ziplogs

rmtadmin agents

Nota: Se ha añadido en la versión 2021.2

Enumera todos los agentes registrados en los nodos de Tableau Server para todos los entornos.

Esto es útil para ver dónde está instalado el agente de Resource Monitoring Tool en Tableau Server.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin agents [options][global option]

Opciones

--env

Opcional: use esta opción para ver la lista de agentes para el entorno específico. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.

--keys

Opcional: incluye la clave del agente en la salida.

Ejemplo:rmtadmin agents --env=<myenvironmentidentifier> --keys

rmtadmin bootstrap-file

Nota: Se ha añadido en la versión 2021.2

Crea y guarda el archivo bootstrap utilizado para registrar agentes en los nodos de Tableau Server.

El archivo bootstrap se creará y guardará en la ruta absoluta o relativa especificada. Las rutas relativas se resuelven en el directorio de trabajo actual.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin bootstrap-file [options][global option]

Opciones

--env

Requerido. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.
El agente en un nodo de Tableau Server solo puede registrarse en un entorno a la vez.

--filename

Opcional. La ruta absoluta o relativa, incluido el nombre del archivo. Las rutas relativas se resuelven en el directorio de trabajo actual. Si no se especifica, se utiliza el nombre de archivo de salida predeterminado.

--force

Opcional. Sobrescribe el archivo existente del mismo nombre.

Ejemplo:rmtadmin bootstrap-file --env=<myenvironmentidentifier>

rmtadmin cleanup

Nota: Se ha añadido en la versión 2021.2

Elimina los archivos de registro que tienen más de un cierto número de días. De forma predeterminada, elimina los archivos de registro de más de 31 días.

Este comando funciona tanto en el servidor de RMT como en el agente.

Nota: Si el los procesos de Resource Monitoring Tool se están ejecutando, el comando no limpiará los archivos de registro activos. Si desea asegurarse de que se eliminen todos los archivos, deberá detener RMT con el comando rmtadmin_stop y luego ejecutar la limpieza con el siguiente comando: rmtadmin cleanup --log-files-retention=0 y, por último, reiniciar los procesos con el comando rmtadmin_start.

Sinopsis

rmtadmin cleanup [option][global option]

Opción

--log-files-retention

Opcional. Elimina los archivos de registro anteriores al número de días especificado.

Ejemplo:rmtadmin cleanup --log-files-retention=<number of days>

rmtadmin create-admin-user

Versión: se añadió en la versión 2022.1

Crea un usuario administrador inicial si no existen otros usuarios.

Nota: A partir de la versión 2023.1, puede crear varios usuarios administradores.

Este comando solo funciona en el servidor de RMT.

Sinopsis

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

Opciones

--username

Opcional. El nombre de usuario de la cuenta del usuario administrador. Si no se especifica, el valor predeterminado es "admin"

--password

Requerido. La contraseña de la cuenta del usuario administrador.

--password-file

Opcional. La ruta al archivo que contiene la contraseña de la cuenta de usuario del administrador. Puede usar esto si no desea escribir la contraseña directamente y tener la contraseña almacenada en un archivo al que se puede acceder.

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

rmtadmin create-env

Nota: Se ha añadido en la versión 2021.2

Crea un nuevo entorno.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin create-env [options][global option]

Opciones

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

Nota: Se ha añadido en la versión 2022.3

Habilita o deshabilita el acceso a la base de datos PostgreSQL. Nota: Se requiere acceso a la base de datos PostgreSQL a partir de la versión 2022.3 para Resource Monitoring Tool para recopilar con éxito todos los datos de supervisión de Tableau Server.

Este comando solo funciona en el servidor de RMT

Nota: La base de datos PostgreSQL debe reiniciarse para que esta configuración surta efecto.

Sinopsis

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

Parámetro de posición

mode

Requerido. El modo que debe usarse para el acceso remoto a datos a la base de datos PostgreSQL. Los valores deben ser uno de: None, ReadOnly, Admin. Cuando se establece en None, el acceso a los datos está deshabilitado. ReadOnly y Admin especifican qué cuenta de usuario usar para acceder a la base de datos.

Opciones

--

Ejemplo:

rmtadmin data-access ReadOnly

rmtadmin restart --db

rmtadmin delete-env

Nota: Se ha añadido en la versión 2021.2

Elimina un entorno específico y todos los datos que se han recopilado para ese entorno. También elimina la conexión y la información de topología sobre Tableau Server que el entorno está supervisando y cancela el registro de todos los agentes de Resource Monitoring Tool.

Este comando solo funciona en el servidor de RMT.

Sinopsis

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

Parámetro de posición

env

Requerido. Este es el identificador generado por el sistema. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.

Opciones

--confirm

Opcional. Confirme que desea eliminar el entorno. Si no proporciona esta opción, se le solicitará que confirme la acción.

--skip-agent-disconnect

Opcional. Omite la desconexión del agente y continúa cancelando el registro del agente. Utilice esta opción si cree que el agente es inaccesible; por ejemplo, si se eliminó el nodo de Tableau Server o si se desinstaló el agente en ese nodo.

Ejemplo:rmtadmin delete-env <myenvironmentidentifier>

rmtadmin delete-env-data

Elimina permanentemente todos los datos relacionados con Tableau Server recopilados para un entorno concreto. La configuración del entorno, la información de Tableau Server y los registros de los agentes no se eliminan.

Es útil para borrar todos los datos en un entorno sin eliminar el propio entorno. Una vez eliminados los datos existentes, se seguirán procesando los nuevos datos enviados por los agentes.

Este comando solo funciona en el servidor de RMT.

Sinopsis

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

Parámetro de posición

env

El identificador del entorno para el que se deben eliminar los datos. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.

Opción

--confirm

Opcional. Confirme que desea eliminar los datos del entorno. Si no proporciona esta opción, se le solicitará que confirme la acción.

Ejemplo:rmtadmin delete-env-data <myenvironmentidentifier>

rmtadmin delete-server

Nota: Se ha añadido en la versión 2021.2

Elimina la información de configuración del nodo de Tableau Server del entorno, cancela el registro del agente en ese nodo y elimina todos los datos de supervisión recopilados específicamente para ese nodo.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin delete-server [options][global option]

Opciones

--env

Requerido. El identificador del entorno al que está conectado el nodo de Tableau Server. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.

--hostname

Necesario para eliminar información sobre un host o más conectados al entorno, si no se especifica --all.

Este es el nombre del equipo del nodo de Tableau Server. Utilice comas para separar varios valores si especifica más de un nombre de host.

--all

Opcional, pero obligatorio si no se especifica --hostname.

Elimina la información de todos los nodos de Tableau Server conectados al entorno.

--skip-agent-disconnect

Opcional. Omite la desconexión del agente y continúa cancelando el registro del agente. Utilice esta opción si el agente es inaccesible, por ejemplo, si el nodo se eliminó de Tableau Server o si el agente se desinstaló en ese nodo.

--confirm

Confirme que desea eliminar toda la información sobre el nodo de Tableau Server. Si no proporciona esta opción, se le solicitará que confirme la acción.

Ejemplo:rmtadmin delete-server --hostname=<machine name of the Tableau Server node>

rmtadmin delete-server-data

Nota: Se ha añadido en la versión 2021.2

Elimina los datos recopilados de uno o más nodos de Tableau Server. Los datos eliminados solo pertenecen a los nodos que se especifican. Si especifica all, se eliminarán todos los datos recopilados de todos los nodos. La configuración del entorno, la información de Tableau Server y los registros de agentes no se eliminarán.

Este comando solo funciona en el servidor de RMT.

Sinopsis

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

Opciones

--env

Requerido. El identificador del entorno al que está conectado el nodo de Tableau Server. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.

--hostname

Necesario para eliminar información sobre un host o más conectados al entorno, si no se especifica --all.

Este es el nombre del equipo del nodo de Tableau Server. Utilice comas para separar varios valores si especifica más de un nombre de host.

--all

Opcional, pero obligatorio si no se especifica --hostname.

Elimina los datos de supervisión de todos los nodos de Tableau Server conectados al entorno.

--confirm

Confirme que desea eliminar todos los datos de supervisión de los nodos de Tableau Server. Si no proporciona esta opción, se le solicitará que confirme la acción.

Ejemplo:rmtadmin delete-server-data --all

Anular el registro de rmtadmin

Nota: Se ha añadido en la versión 2021.2

Anula el registro del agente del entorno. Ya no se recopilarán los datos de supervisión de este nodo. Los datos existentes se conservarán y no se eliminarán.

Este comando solo funciona cuando se ejecuta en el agente de RMT. Ejecútelo en el agente cuyo registro desea anular.

Sinopsis

rmtadmin deregister [options]

Opciones

--confirm

Opcional. Confirme que desea anular el registro del agente. Esto omite el mensaje de confirmación.

--ignore-master-errors

Opcional. Ignora cualquier error que ocurra al comunicarse con el servidor RTM durante este proceso.

Ejemplo:rmtadmin deregister --confirm

rmtadmin deregister-agent

Nota: Se ha añadido en la versión 2021.2

Anula el registro del agente especificado en el entorno. Ya no se recopilarán los datos de supervisión de este nodo. Los datos existentes se conservarán y no se eliminarán.

Este comando solo funciona cuando se ejecuta en el servidor RMT.

Sinopsis

rmtadmin deregister-agent [options][global option]

Opciones

--env

Obligatorio si no se especifica --key.

Este es el identificador del entorno donde el agente está registrado actualmente. Este es el identificador generado por el sistema. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.

--key

Opcional si se especifica --env.

Esta es la clave del agente. Use comas para separar varios valores. Puede obtener los valores clave ejecutando el comando rmtadmin agents.

--hostname

Opcional. El nombre del equipo del nodo de Tableau Server en el que está instalado el agente. Use comas para separar varios valores.

--all

Opcional. Utilice esta opción para anular el registro de agentes en todos los nodos.

--ignore-agent-errors

Opcional. Ignora cualquier error que ocurra si no puede conectarse con los agentes durante este proceso.

--skip-agent-disconnect

Opcional. Omite la desconexión del agente y sigue anulando el registro del agente. Utilice esta opción si el agente es inaccesible, por ejemplo, si el nodo se eliminó de Tableau Server o si el agente se desinstaló en ese nodo.

--confirm

Opcional. Confirme que desea anular el registro de los agentes. Si no proporciona esta opción, se le solicitará que confirme la acción.

Ejemplo:rmtadmin deregister-agent --env=<myenvironmentidentifier> --all

rmtadmin environments

Nota: Se ha añadido en la versión 2021.2

Enumera todos los entornos en el servidor Resource Monitoring Tool.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin environments [global option]

rmtadmin get

Obtiene el valor actual de una clave de configuración especificada.

Este comando se puede utilizar tanto en el servidor de RMT como en el agente.

Sinopsis

rmtadmin get <config.key> [global option]

Parámetro de posición

clave

Nombre de la clave de configuración.

Ejemplo: rmtadmin get db:database

Claves de configuración admitidas

Utilice el comando set para cambiar el valor de la configuración actual.

rmtadmin help

Muestra ayuda general sobre la interfaz de línea de comandos y los comandos disponibles.

Este comando se puede utilizar tanto en el servidor de RMT como en el agente.

Sinopsis

rmtadmin help

Mostrar ayuda e información de uso para un comando determinado:

Este comando se puede utilizar tanto en el servidor de RMT como en el agente.

rmtadmin help [command]

rmtadmin master-setup

Configura el servidor de RMT con las opciones especificadas. Se utiliza durante las configuraciones de instalación y después de la instalación.

Sinopsis

rmtadmin master-setup [options][global option]

Las opciones de configuración se enumeran a continuación:

Ejemplos:

Para especificar la contraseña de administrador: rmtadmin master-setup --admin-password=<password> --skip-admin-creation

Para actualizar el puerto después de la instalación: rmtadmin master-setup --http-port=8000 --skip-admin-creation

rmtadmin passwd

Restablece la contraseña para una cuenta de usuario específica de Resource Monitoring Tool.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin passwd [positional parameter][global option]

Parámetro de posición

nombre de usuario

Nombre del usuario para el que desea cambiar la contraseña.

Ejemplo: rmtadmin passwd <username>

rmtadmin query

Ejecuta una consulta SQL sin procesar en la base de datos de Resource Monitoring Tool y guarda los resultados en un archivo de salida.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin query [positional parameter][options] [global option]

Parámetro de posición

sql

Texto del comando SQL que se está ejecutando. Puede proporcionar varios comandos SQL. Para utilizar un archivo con los comandos SQL, utilice @ como prefijo del nombre del archivo.

Opciones

--outfile=VALUE

Nombre del archivo ZIP que desea generar con los resultados de la consulta. El nombre predeterminado es queryresults.zip

--force

Sobrescribe el archivo existente.

--timeout=VALUE

Tiempo de espera para la consulta. Se debe especificar en segundos.

--commit

Confirma los cambios realizados por el comando SQL en la base de datos. De forma predeterminada, el comando SQL se ejecuta como una transacción, pero se revierte al finalizar.

Ejemplo: rmtadmin query <SQLCommand> --outfile=<path and the output file name>

rmtadmin register

Nota: Se ha añadido en la versión 2020.2

Registra el agente mediante un archivo de arranque. El archivo bootstrap se puede descargar mediante el comando rmtadmin bootstrap-file.

Este comando solo se puede utilizar en el agente y debe ejecutarse en el equipo donde desea instalar el agente.

Sinopsis

rmtadmin register [options][positional parameter] [global option]

Opciones

--username

Requerido. Nombre del usuario administrador creado durante la instalación del servidor de RMT.

--password

Requerido. Contraseña de la cuenta de usuario.

--password-file

Ruta que incluye el nombre del archivo que contiene la información de la contraseña. La contraseña se puede proporcionar en la línea de comandos o en un archivo que contenga la contraseña. Si no se proporciona ninguna, se le pedirá que lo haga.

--server-name

Nombre del nodo donde se va a instalar el agente El valor predeterminado es el nombre del equipo si no se especifica ningún otro.

--server-description

Descripción personalizada para el servidor.

Ejemplo: rmtadmin register <bootstrap file name and path> --server-name=<server name>

rmtadmin servers

Nota: Se ha añadido en la versión 2021.2

Enumera todos los nodos de Tableau Server en todos los entornos o en un entorno específico.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin servers [positional parameter][global option]

Parámetro de posición

env

Opcional. Especifique el identificador del entorno para obtener una lista de los nodos de Tableau Server registrados en ese entorno. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.

rmtadmin service-setup

Nota: Se ha añadido en la versión 2021.4 Se usa para instalar o actualizar las credenciales de usuario para los servicios de Resource Monitoring Tool, incluidos el servidor RMT, el agente, Rabbit MQ y la base de datos PostgreSQL. Esto es útil para actualizar la información del servicio después de la instalación.

Este comando funciona tanto en el servidor RMT como en el agente.

Sinopsis

rmtadmin service-setup [positional parameter][options][global option]

Parámetro de posición

Se debe especificar al menos uno de los siguientes valores:

all

Actualiza todos los servicios disponibles. Se puede ejecutar tanto en RMT como en agente. Cuando se ejecuta en un nodo de Tableau Server, actualiza el agente en ese nodo.

master

Actualiza el servidor RMT.

agent

Actualiza el agente. Solo se puede ejecutar en el agente (nodo de Tableau Server).

db

Actualiza el servicio de base de datos. Solo se puede ejecutar en el servidor RMT.

mq

Actualiza el servicio de cola de mensajes. Solo se puede ejecutar en el servidor RMT.

Opciones

--confirm

Opcional. Confirme que desea actualizar. Se puede ejecutar tanto en RMT como en agente. Cuando se ejecuta en un nodo de Tableau Server, actualiza el agente en ese nodo.

--user-type

Requerido para el servidor RMT y agente. El tipo de cuenta que se utiliza para ejecutar el servidor RMT o el agente. Los valores permitidos son:

• Cuenta virtual (solo servidor RMT)
• network-service
• local-system
• local-service
• username (nombre de usuario de la cuenta de usuario local o de dominio)

--username

Especifica el nombre de usuario de la cuenta. Obligatorio si utiliza una cuenta de usuario local o una cuenta de usuario de dominio.

--password

Especifica la contraseña de la cuenta. Obligatorio si utiliza una cuenta de usuario local o una cuenta de usuario de dominio.

--password-file

Opcional. La ruta a la ubicación del archivo, incluido el nombre del archivo donde se almacena la información de la contraseña.

--append-permissions

Opcional. Agrega nuevos permisos. Use esto si no desea sobrescribir los permisos existentes.

rmtadmin test-env

Nota: Se ha añadido en la versión 2021.2

Prueba los distintos puntos de conexión entre Resource Monitoring Tool y Tableau Server. Esto incluye probar la conexión del repositorio de Tableau Server, las conexiones de la API de Tableau Server y capacidades de Advanced Management.

Este comando solo funciona en el servidor de RMT.

Sinopsis

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

Parámetro de posición

--env

Opcional. El identificador del entorno que el Resource Monitoring Tool está supervisando. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.

--force

Opcional. Utilice esta opción para actualizar la línea de base inmediatamente, incluso si no hay suficientes datos disponibles. De manera predeterminada, el comando esperará 50 cargas exitosas para calcular la línea de base

rmtadmin update-baseline

Nota: Se añadió en la versión 2021.4.

Actualiza la línea de base para todas las cargas de vista. La línea de base es el percentil 95 de 50 tiempos de carga iniciales correctos para una vista.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin update-baseline [options][global option]

Opciones

env

Requerido. Este es el identificador generado por el sistema. Puede encontrar esto en Admin >Environments > Edit Environment. En esta página, en la sección Environment Details, verá el identificador del entorno.

rmtadmin update-env

Nota: Se ha añadido en la versión 2021.2

Actualiza la configuración del entorno.

Este comando solo funciona en el servidor de RMT.

Sinopsis

rmtadmin update-env [options][global option]

Opciones

Ejemplo:rmtadmin update-env --name=<new name>