Informatie over de tsm-opdrachtregel

De onderwerpen in dit gedeelte bevatten referentiemateriaal voor de CLI (opdrachtregelinterface) van TSM (Tableau Services Manager) ter ondersteuning van Tableau Server.

TSM wordt gebruikt om de installatie en configuratie van Tableau Server te beheren. Zie Overzicht Tableau Services Manager voor meer informatie over TSM.

U kunt de installatie- en configuratietaken die door de TSM-CLI worden ondersteund, automatiseren met behulp van de TSM-API. Zie Tableau Services Manager-API (in het Engels) voor meer informatie over de alfaversie van de TSM-API.

Met de tsm-CLI

U kunt tsm-opdrachten uitvoeren op het eerste knooppunt (het knooppunt waarop TSM is geïnstalleerd) of op een willekeurig ander knooppunt in het cluster.

Om tsm-opdrachten uit te voeren, moet u de Windows-opdrachtprompt openen. Gebruik geen PowerShell om tsm-opdrachten uit te voeren. Het gebruiken van PowerShell kan onverwacht gedrag veroorzaken.

  1. Open de Windows-opdrachtprompt met een account dat lid is van de Beheerdersgroep op een knooppunt in het cluster.

  2. Voer de gewenste opdracht uit. Als u de opdracht uitvoert vanaf een ander knooppunt dan het eerste knooppunt, moet u de optie -s opnemen om de naam van de URL van het eerste knooppunt op te geven (niet het IP-adres). U moet ook de TSM-poort 8850 opgeven.

    Om de versie van TSM en Tableau Server van het eerste knooppunt te zien, typt u:

    tsm version

    Om de versie van TSM en Tableau Server van een extra knooppunt te zien, typt u:

    tsm version -s https://<inital_node_name>:8850

    Bijvoorbeeld:

    tsm version -s https://myTableauHost:8850

Verifiëren met de tsm-CLI

Vanaf de release 2019.2 van Tableau Server hoeft u geen wachtwoord meer op te geven bij het uitvoeren van tsm-opdrachten als aan de volgende voorwaarden is voldaan:

  • Het account waarmee u opdrachten uitvoert, is lid van de door TSM geautoriseerde groep. Dit is de lokale Administrators-groep op de Windows-computer.
  • U voert opdrachten lokaal uit op de Tableau Server waarop de service Tableau Server - Beheercontroller wordt uitgevoerd. Standaard wordt de service Tableau Server - Beheercontroller geïnstalleerd en geconfigureerd op het eerste knooppunt in een gedistribueerde implementatie.

Lokaal inloggen bij de tsm-CLI

Als u tsm-opdrachten uitvoert op de lokale computer met een gebruikersaccount dat lid is van een door TSM geautoriseerde groep, hoeft u geen wachtwoord op te geven. In dat geval voert u de opdracht gewoon uit, bijvoorbeeld:

tsm version

Op afstand inloggen bij de tsm CLI

Als u TSM-opdrachten uitvoert vanaf een knooppunt in een cluster waar de service Tableau Server - Beheercontroller niet wordt uitgevoerd, moet u een sessie met de service Tableau Server - Beheercontroller op de externe computer verifiëren voordat u opdrachten kunt uitvoeren. Voer bijvoorbeeld de volgende opdracht uit:

tsm login -s <server_name> -u <account_name>

Hierbij staat <server_name> voor de naam van het knooppunt waar de service Tableau Server - Beheercontroller wordt uitgevoerd, en <account_name> voor een account dat lid is van een door TSM geautoriseerde groep.

Na het uitvoeren van deze opdracht wordt u om het wachtwoord gevraagd. Nadat het account is geverifieerd, kunt u TSM-opdrachten uitvoeren.

Als best practice voor de beveiliging is het raadzaam om de TSM-poort niet bloot te stellen (standaard is dit de TSM-poort, 8850) aan internet.

Scripts uitvoeren en automatiseren met de tsm-CLI

TSM is een batchbestand. Om TSM-opdrachten in een ander batchbestand uit te voeren, gebruikt u de opdracht call. Bijvoorbeeld call tsm maintenance ziplogs. Als u dit doet, krijgt het batchbestand weer de controle.

Als u automatisering op een Tableau Server wilt uitvoeren zonder een wachtwoord in het scriptbestand, voert u het script uit op het eerste knooppunt en met een account in de juiste door TSM geautoriseerde groep. Zie het gedeelte 'Verifiëren' hierboven.

Help-inhoud weergeven in de shell

Om minimale Help-inhoud vanaf een opdrachtregel te bekijken, gebruikt u de categorie tsm help.

Overzicht

tsm help [category] [command]

Opdrachten

tsm help

Help voor alle tsm-opdrachten

tsm help <category>

Help voor een specifieke opdrachtcategorie weergeven. Bijvoorbeeld: tsm help authentication.

tsm help <category> <command>

Help voor een specifieke opdracht weergeven. Bijvoorbeeld: tsm help authentication open-id.

tsm help commands

Alle opdrachten of categorieën op het hoogste niveau weergeven.

Categorieën

Bedankt voor uw feedback.De feedback is verzonden. Dank u wel.