tabcmd

Remarque : L’utilitaire de ligne de commande tabcmd version 2.0 est disponible sur Tableau tabcmd(Le lien s’ouvre dans une nouvelle fenêtre). Cette nouvelle version vous permet d’exécuter des commandes tabcmd sur MacOS et Linux et de vous authentifier à l’aide de jetons d’accès personnels (PAT). La version 2.0 est basée sur des points de terminaison publics disponibles dans Tableau Server Client (TSC) basé sur Python. Cette dernière version offre une prise en charge limitée pour Tableau Server.

Tableau fournit l’utilitaire de ligne de commande tabcmd que vous pouvez utiliser pour automatiser les tâches d’administration de site sur votre site Tableau Server. Par exemple, créer ou supprimer des utilisateurs, des projets et des groupes.

Remarque : cet utilitaire tabcmd est inclus avec Tableau Server et est installé automatiquement sur les nœuds de serveur. Par contre, son programme d’installation n’est pas inclus. Si vous souhaitez exécuter tabcmd sur des ordinateurs qui ne font pas partie de votre installation Tableau Server, vous devez télécharger le programme d’installation depuis le site Web de Tableau. Pour plus d’informations, consultez Installer tabcmd ci-dessous.

Installer tabcmd

Remarque : ces instructions concernent l’installation de l’utilitaire de ligne de commande tabcmd 1.0. Pour installer l’utilitaire de ligne de commande tabcmd 2.0, accédez à Tableau tabcmd(Le lien s’ouvre dans une nouvelle fenêtre) (nouvelle fenêtre).

Lorsque Tableau Server ou Tableau Cloud est mis à niveau à une nouvelle version, si une version mise à jour de tabcmd est requise, vous pouvez la télécharger depuis la page des versions de Tableau Server sur le site Web de Tableau.

Pour Tableau Server, nous vous recommandons de télécharger la version correspondant à la version de votre serveur. Pour Tableau Cloud, nous vous recommandons de toujours télécharger la dernière version pour éviter les problèmes causés par les incompatibilités de version. Dans les deux cas, l’utilisation d’une version obsolète de tabcmd peut générer des erreurs et des résultats imprévisibles.

  1. Ouvrez un navigateur Web et accédez à la page Versions de Tableau Server(Le lien s’ouvre dans une nouvelle fenêtre). Allez sur cette page même si vous utilisez Tableau Online.

  2. Si vous utilisez :

    Dans les deux cas, si les informations développées affichent les versions de maintenance, sélectionnez la version de maintenance la plus récente ou celle correspondant à votre version de serveur.

    Sélectionnez la version du serveur que vous utilisez (dernière version pour Tableau Cloud)

    Vous accédez alors à la page des notes de version, appelée Problèmes résolus, où vous pouvez prendre connaissance des améliorations de sécurité et des problèmes résolus.

  3. Faites défiler jusqu’à la section Télécharger les fichiers sous les problèmes résolus, et sélectionnez le lien de téléchargement de tabcmd compatible avec l’ordinateur sur lequel vous exécuterez les commandes tabcmd. 

    Sélectionnez le programme d’installation tabcmd pour l’ordinateur sur lequel vous l’utiliserez (32 ou 64 bits)

    Dans le reste des étapes, cet ordinateur est appelé « l’ordinateur tabcmd ».

  4. Enregistrez le programme d’installation sur l’ordinateur tabcmd ou sur un emplacement accessible depuis cet ordinateur .

  5. Terminez les étapes d’installation en fonction du système d’exploitation de l’ordinateur tabcmd :

    • Windows

      Par défaut, tabcmd est défini sur C:\Program Files\Tableau\Tableau Server\<version>\extras\Command Line Utility. Vous pouvez modifier cela pendant l’installation et nous vous recommandons d’installer tabcmd sur un dossier nommé tabcmd à la racine du lecteur C:\ (C:\tabcmd). Il sera ainsi plus facile à localiser et à exécuter, et s’adaptera à certaines limitations avec le système d’exploitation Windows si vous ajoutez le répertoire tabcmd au chemin PATH Windows.

      Remarque Le programme d’installation de tabcmd n’ajoute pas le répertoire tabcmd à la variable PATH de Windows. Vous pouvez l’ajouter manuellement ou indiquer le chemin complet de tabcmd chaque fois que vous l’appelez.

      Vous pouvez installer tabcmd de deux façons sous Windows :

      • Double-cliquez sur le programme d’installation pour suivre les étapes dans l’interface utilisateur :

        1. Acceptez le contrat de licence.

        2. Si vous souhaitez effectuer l’installation à un emplacement autre que par défaut, cliquez sur Personnaliser et saisissez ou naviguez jusqu’à l’emplacement où vous souhaitez installer tabcmd.

        3. Cliquez sur Installer.

          Si vous y êtes invité par le pare-feu Windows Defender ou le contrôle de compte utilisateur, cliquez sur Autoriser l’accès.

      • Exécutez le programme d’installation depuis une invite de commande :

        1. Ouvrez une invite de commande en tant qu’administrateur sur l’ordinateur tabcmd.

        2. Accédez au répertoire où vous avez copié le programme d’installation de tabcmd.

        3. Installez tabcmd :

          tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1

          Installation dans un emplacement autre que par défaut :

          tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="<path\to\install\directory>"

          Par exemple :

          tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="C:\tabcmd"

          Pour une liste complète des options de ligne de commande que vous pouvez utiliser avec le programme d’installation de tabcmd, exécutez l’installateur avec un /?. Pour plus d’informations sur les options de ligne de commande tabcmd installer, consultez Commutateurs d’installation et propriétés pour tabcmd (Windows).

      Le programme d’installation de tabcmd crée des journaux dans C:\Users\<user>\AppData\Local\Temp que vous pouvez utiliser si vous avez des problèmes pour installer tabcmd. Les journaux utilisent la convention de nommage Tableau_Server_Command_Line_Utility_(<version_code>)_##############.log.

    • Linux

      Remarque : pour exécuter tabcmd sur un ordinateur Linux, vous devez avoir installé Java 11. Sur les systèmes de type RHEL, cela sera installé comme une dépendance lors de l’installation de tabcmd. Sur les systèmes Ubuntu, vous devez installer Java 11 séparément s’il n’est pas déjà installé.

      Depuis juillet 2022, les distributions Debian ne sont plus prises en charge. Pour plus d’informations, consultez ce billet de la Communauté Tableau(Le lien s’ouvre dans une nouvelle fenêtre).

      1. Connectez-vous en tant qu’utilisateur avec accès sudo à l’ordinateur tabcmd.

      2. Accédez au répertoire sur lequel vous avez copié le package .rpm ou .deb téléchargé.

        • Sur les distributions de type RHEL, y compris CentOS, exécutez la commande suivante :

          sudo yum install tableau-tabcmd-<version>.noarch.rpm

        • Sur Ubuntu, exécutez la commande suivante :

          sudo apt-get install ./tableau-tabcmd-<version>_all.deb

    Pour désinstaller tabcmd d’un ordinateur Linux, voir la documentation pour la variété Linux que vous exécutez.

  6. (Facultatif) Ajoutez l’emplacement pleinement qualifié où tabcmd est installé sur votre chemin d’accès système pour pouvoir exécuter les commandes tabcmd sans avoir à modifier cet emplacement, ou à spécifier l’emplacement avec chaque commande. Les étapes à suivre dépendent du type et de la version de votre système d’exploitation. Pour plus d’informations, voir PATH_(variable).

Comment utiliser tabcmd

Les étapes de base de l’utilisation de tabcmd sont les suivantes :

  1. Ouvrez l’invite de commande en tant qu’administrateur.

    Remarque : N’utilisez pas PowerShell pour exécuter les commandes tabcmd Windows. L’utilisation de PowerShell peut provoquer un comportement inattendu.

  2. Sur un ordinateur Windows, si vous avez installé tabcmd sur un ordinateur autre que le nœud initial, passez au répertoire où vous avez installé tabcmd.

    Sur un ordinateur Linux, vous n’avez pas besoin de passer au répertoire d’installation.

  3. Exécutez la commande tabcmd.

Lorsque vous utilisez tabcmd, vous devez établir une session serveur authentifiée. La session identifie le serveur ou le site Tableau Cloud ainsi que l’utilisateur exécutant la session. Vous pouvez tout d’abord démarrer une session, puis spécifier votre commande, ou vous pouvez démarrer une session et exécuter une commande en même temps.

Important : si vous utilisez tabcmd pour effectuer plus d’une tâche, vous devez exécuter les tâches les unes après les autres (en série) plutôt qu’en même temps (en parallèle).

Les commandes (telles que login) et les options (telles que -s, -u, etc.) ne sont pas sensibles à la casse, mais les valeurs que vous fournissez (par exemple User@Example.com) sont sensibles à la casse.

Exemples

La commande suivante présente le démarrage d’une session avec une instance Tableau Server appelée tabserver.mycompany.com :

tabcmd login -s http://tabserver.mycompany.com -u admin -p mypassword

L’exemple suivant montre une commande pour supprimer un classeur nommé Sales_Workbook :

tabcmd delete "Sales_Workbook" 

Voici comment réussir toute la procédure expliquée ci-dessus en une seule commande-notez que vous n’aurez pas besoin de login :

tabcmd delete "Sales_Workbook" -s http://tabserver.mycompany.com -u admin -p mypassword 

Une instance Tableau Server peut héberger plusieurs sites. Lorsqu’un classeur se trouve sur le site par défaut d’un serveur multisite, vous n’avez pas besoin de préciser qu’il s’agit du site par défaut, la commande ci-dessus est suffisante. Cependant, si la commande s’applique à un élément d’un site autre que celui par défaut, vous devez spécifier l’ID du site concerné (reportez-vous à la rubrique login). Voici la même commande pour un classeur se trouvant sur le site West Coast Sales (ID du site wsales) :

tabcmd delete "Sales_Workbook" -s http://tabserver.mycompany.com -t wsales -u admin -p mypassword 

Les options -s, -t, -u et -p figurent parmi les variables globales de tabcmd, qui peuvent être employées avec n’importe quelle commande.

Pour plus d’informations, consultez Commandes tabcmd.

Messages d’état et journaux

Lorsqu’une commande s’exécute correctement, tabcmd renvoie un code d’état égal à zéro. Un message d’erreur complet pour les codes d’état non égaux à zéro est imprimé sur stderr. De plus, des messages informatifs ou de progression peuvent être imprimés sur stdout.

Un journal complet nommé tabcmd.log (incluant les messages de débogage, de progression et d’erreur) est enregistré dans C:\Users\<username>\AppData\Local\Tableau\.

Merci de vos commentaires !Avis correctement envoyé. Merci