Referencia de la línea de comandos de tsm
Los temas de esta sección incluyen contenidos de referencia correspondientes a la interfaz de línea de comandos (CLI) de Tableau Services Manager (TSM), que resultan útiles si emplea Tableau Server.
TSM se usa para administrar la instalación y la configuración de Tableau Server. Para obtener más información sobre TSM, consulte Introducción a Tableau Services Manager.
Puede automatizar las tareas de instalación y configuración admitidas en la CLI de TSM usando la API de TSM. Para obtener más información sobre la API preliminar (alfa) de TSM, consulte API de Tableau Services Manager.
Usar la interfaz de línea de comandos de TSM
Puede ejecutar comandos tsm en el nodo inicial (el nodo donde está instalado TSM), o en cualquier nodo adicional del clúster.
Para ejecutar comandos tsm, debe abrir una línea de comandos de Windows. No utilice PowerShell para ejecutar comandos tsm. El uso de PowerShell puede causar un comportamiento inesperado.
Abra el Símbolo del sistema operativo de Windows con una cuenta que sea miembro del grupo Administradores en un nodo del clúster.
Ejecute el comando que desee. Si está ejecutando el comando desde un nodo que no sea el nodo inicial, incluya la opción
-s
para especificar la URL del nodo inicial por nombre (no por dirección IP), e incluya el puerto TSM 8850.Para ver la versión de TSM y Tableau Server desde el nodo inicial:
tsm version
Para ver la versión de TSM y Tableau Server desde un nodo adicional:
tsm version -s https://<inital_node_name>:8850
Por ejemplo:
tsm version -s https://myTableauHost:8850
Autenticación con la interfaz de línea de comandos de tsm
A partir de la versión 2019.2 de Tableau Server, los comandos tsm no requieren que escriba una contraseña si se cumplen las siguientes condiciones:
- La cuenta con la que ejecuta comandos es miembro del grupo TSM-authorized, que es el grupo de administradores locales del equipo Windows.
- Se ejecutan comandos localmente en Tableau Server que ejecuta el servicio del controlador de administración de Tableau Server. De forma predeterminada, el servicio del controlador de administración de Tableau Server se instala y configura en el nodo inicial de una implementación distribuida.
Inicio de sesión en la interfaz de línea de comandos de tsm localmente
Si ejecuta comandos tsm en el equipo local con una cuenta de usuario que sea miembro de un grupo TSM-authorized, no necesitará especificar una contraseña. En este caso, simplemente ejecute el comando, por ejemplo:
tsm version
Inicio de sesión en la interfaz de línea de comandos de tsm de forma remota
Si ejecuta comandos TSM desde un nodo en un clúster donde no se está ejecutando el servicio del controlador de administración de Tableau Server, debe autenticar una sesión con el servicio de administración de Tableau Server en el equipo remoto antes de poder ejecutar comandos. Por ejemplo, ejecute el siguiente comando:
tsm login -s <server_name> -u <account_name>
Donde <server_name>
es el nombre del nodo donde se ejecuta el servicio del controlador de administración de Tableau Server y <account_name>
es una cuenta que es miembro de un grupo TSM-authorized.
Después de ejecutar este comando, se le solicitará una contraseña. Una vez autenticada la cuenta, puede ejecutar comandos TSM.
Como práctica recomendada de seguridad, no exponga el puerto TSM (de manera predeterminada, 8850
) a Internet.
Scripting y automatización con la interfaz de línea de comandos de tsm
TSM es un archivo por lotes. Use el comando call
para ejecutar comandos de TSM en otro archivo por lotes. Por ejemplo, “call tsm maintenance ziplogs
”. Esto indica el control del archivo por lotes.
Para ejecutar la automatización en un servidor Tableau sin contraseña en el archivo de script, ejecute el script en el nodo inicial y con una cuenta en el grupo TSM-authorized correcto. Consulte la sección "Autenticación" anterior.
Ver contenido de ayuda en el shell
Para ver un contenido de ayuda mínimo en una línea de comandos, utilice la categoría tsm help
.
Sinopsis
tsm help [category] [command]
.
Comandos
tsm help
.Ayuda de todos los comandos de tsm.
tsm help <category>
.Ver la ayuda de una categoría de comandos determinada. Por ejemplo,
tsm help authentication
.tsm help <category> <command>
.Ver la ayuda de un comando determinado. Por ejemplo,
tsm help authentication open-id
.tsm help commands
Ver una lista de todas las categorías o comandos del nivel superior.