tsm-Befehlszeilenreferenz
Die Themen in diesem Abschnitt enthalten Referenzinhalte für die Tableau Services Manager-Befehlszeilenschnittstelle (TSM) zum Unterstützen von Tableau Server.
TSM wird zum Verwalten der Installation und Konfiguration von Tableau Server verwendet. Weitere Informationen über TSM finden Sie unter Übersicht zu Tableau Services Manager.
Sie können die von der TSM-Befehlszeilenschnittstelle unterstützten Installations- und Konfigurationsaufgaben mit der TSM-API automatisieren. Weitere Informationen über die Vorabversion (Alpha) der TSM-API finden Sie unter Tableau Services Manager-API.
Verwenden der tsm CLI
Sie können tsm-Befehle auf dem Einstiegsknoten (dem Knoten, auf dem TSM installiert ist) oder auf jedem weiteren Knoten im Cluster ausführen.
Zum Ausführen von tsm-Befehlen müssen Sie eine Windows-Eingabeaufforderung öffnen. Verwenden Sie nicht PowerShell, um tsm-Befehle auszuführen. Die Verwendung von PowerShell kann zu unerwartetem Verhalten führen.
Öffnen Sie eine Windows-Eingabeaufforderung mit einem Konto, das Mitglied der Administratorgruppe auf einem Knoten im Cluster ist.
Führen Sie den gewünschten Befehl aus. Wenn Sie den Befehl von einem anderen Knoten als dem anfänglichen Knoten aus ausführen, schließen Sie die Option
-s
ein, um die URL des anfänglichen Knotens namentlich (nicht die IP-Adresse) anzugeben, und schließen Sie den TSM-Port 8850 ein.Um die Version von TSM und Tableau Server vom Einstiegsknoten aus anzuzeigen:
tsm version
Um die Version von TSM und Tableau Server von einem zusätzlichen Knoten aus anzuzeigen:
tsm version -s https://<inital_node_name>:8850
Beispiel:
tsm version -s https://myTableauHost:8850
Authentifizierung mit tsm CLI
Ab der Version 2019.2 von Tableau Server brauchen Sie mit tsm-Befehlen kein Kennwort einzugeben, wenn Folgendes zutrifft:
- Das Konto, mit dem Sie Befehle ausführen, ist Mitglied der von TSM autorisierten Gruppe, der lokalen Administratorengruppe auf dem Windows-Computer.
- Sie führen Befehle lokal auf dem Tableau Server aus, auf dem der "Tableau Server Administration Controller"-Dienst ausgeführt wird. Standardmäßig wird der "Tableau Server Administration Controller"-Dienst in einer verteilten Bereitstellung auf dem Primärknoten installiert und konfiguriert.
Lokales Anmelden bei tsm CLI
Wenn Sie auf dem lokalen Computer tsm-Befehle mit einem Benutzerkonto ausführen, das Mitglied einer von TSM autorisierten Gruppe ist, brauchen Sie kein Kennwort anzugeben. Führen Sie in diesem Fall einfach den Befehl aus, z. B.:
tsm version
Remote-Anmelde bei tsm CLI
Wenn Sie TSM-Befehle auf einem Knoten in einem Cluster ausführen, auf dem der "Tableau Server Administration Controller"-Dienst nicht ausgeführt wird, müssen Sie auf dem Remotecomputer eine Sitzung mit dem Tableau Server Administration Controller authentifizieren, bevor Sie Befehle ausführen können. Führen Sie beispielsweise den folgenden Befehl aus:
tsm login -s <server_name> -u <account_name>
Dabei ist <server_name>
der Name des Knotens, in dem der Tableau Server Administration Controller ausgeführt wird, und <account_name>
ist ein Konto, das Mitglied einer von TSM autorisierten Gruppe ist.
Nach dem Ausführen dieses Befehls werden Sie aufgefordert, ein Kennwort einzugeben. Nachdem das Konto authentifiziert wurde, können Sie TSM-Befehle ausführen.
Aus Sicherheitsgründen sollten Sie darauf achten, dass nicht über das Internet auf den TSM-Port zugegriffen werden kann (standardmäßig 8850
).
Skripterstellung und Automatisierung mit tsm CLI
TSM ist eine Stapelverarbeitungsdatei Verwenden Sie den Befehl call
, um TSM-Befehle in einer anderen Stapelverarbeitungsdatei auszuführen.. Beispiel: "call tsm maintenance ziplogs
". Dadurch hat die Stapelverarbeitungsdatei wieder die Kontrolle.
Führen Sie das Skript auf dem Anfangsknoten und mit einem Konto in der richtigen von TSM autorisierten Gruppe aus, um die Automatisierung auf einem Tableau Server ohne Kennwort in der Skriptdatei auszuführen. Siehe Abschnitt "Authentifizieren" weiter oben.
Anzeigen von Hilfeinhalt in der Shell
Verwenden Sie die Kategorie tsm help
, um minimale Hilfeinhalte aus einer Befehlszeile anzuzeigen.
Synopse
tsm help [category] [command]
Befehle
tsm help
Hilfe für alle TSM-Befehle
tsm help <category>
Zeigen Sie die Hilfe für eine bestimmte Befehlskategorie an. Beispiel:
tsm help authentication
.tsm help <category> <command>
Zeigen Sie die Hilfe für einen bestimmten Befehl an. Beispiel:
tsm help authentication open-id
.tsm help commands
Führen Sie alle Befehle oder Kategorien auf oberster Ebene auf.