Référence de ligne de commande tsm

Les rubriques de cette section incluent le contenu de référence de l'interface en ligne de commande (CLI) Tableau Services Manager (TSM) pour la prise en charge de Tableau Server.

TSM sert à utiliser l'installation et la configuration de Tableau Server. Pour en savoir plus sur TSM, consultez Présentation de Tableau Services Manager.

Vous pouvez automatiser les tâches d'installation et de configuration prises en charge par l'interface en ligne de commande TSM en utilisant l'API TSM. Pour en savoir plus sur l'API TSM de pré-distribution (Alpha), consultez API Tableau Services Manager.

Utilisation de l'interface en ligne de commande tsm

Vous pouvez exécuter des commandes tsm sur le nœud initial (le nœud où TSM est installé), ou sur tout autre nœud du cluster.

Pour exécuter des commandes tsm, vous devez ouvrir une invite de commandes.

  1. Ouvrez une invite de commande avec un compte membre du groupe tsmadmin sur un nœud du cluster.

  2. Exécutez la commande souhaitée. Si vous exécutez la commande à partir d'un nœud autre que le nœud initial, incluez l'option -s permettant de spécifier l'URL du nœud initial par son nom (pas son adresse IP), et incluez le port TSM, 8850.

    Pour voir la version de TSM et de Tableau Server à partir du nœud initial :

    tsm version

    Pour voir la version de TSM et de Tableau Server à partir d'un nœud supplémentaire :

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

    Par exemple :

    tsm version -s https://myTableauHost:8850

Authentification avec l'interface en ligne de commande tsm

Depuis la version 2019.2 de Tableau Server, l'exécution des commandes tsm n'exige plus la saisie d'un mot de passe si les conditions suivantes sont remplies :

  • Le compte avec lequel vous exécutez des commandes appartient au groupe agréé TSM, par défaut le groupe tsmadmin. L'utilisateur sans privilège Tableau (par défaut, l'utilisateur tableau) et le compte racine peuvent également exécuter des commandes TSM.
  • Vous exécutez des commandes localement sur l'instance de Tableau Server exécutant le service du Contrôleur d'administration Tableau Server. Par défaut, le service Contrôleur d'administration Tableau Server est installé et configuré sur le nœud initial sur un déploiement distribué.

Connexion locale à l'interface en ligne de commande tsm

Si vous exécutez des commandes tsm sur l'ordinateur local doté d'un compte utilisateur appartenant au groupe agréé TSM, vous n'avez pas à spécifier un mot de passe. Dans ce cas, exécutez simplement la commande, par exemple :

tsm version

Connexion distante à l'interface en ligne de commande tsm

Si vous exécutez des commandes TSM depuis un cluster où le service Contrôleur d'administration Tableau Server n'est pas en cours d'exécution, vous devez authentifier une session avec le service Contrôleur d'administration Tableau Server sur l'ordinateur distant avant de pouvoir exécuter des commandes. Par exemple, exécutez la commande suivante :

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

<server_name> est le nom du nœud où le service Contrôleur d'administration Tableau Server est en cours d'exécution et <account_name> est un compte appartenant au groupe agréé TSM.

Après avoir exécuté cette commande, vous serez invité à saisir un mot de passe. Une fois que le compte a été authentifié, vous pouvez exécuter des commandes TSM.

Affichage et ajout de comptes au groupe agréé TSM

Le groupe agréé TSM est créé durant l'installation du serveur. Par défaut, le groupe agréé TSM est nommé tsmadmin. Si vous avez créé un groupe agréé TSM alternatif lors de l'installation, utilisez le nom de votre groupe à la place de tsmadmin dans les exemples de code suivants.

Pour afficher les comptes utilisateur du groupe tsmadmin, exécutez la commande suivante :

grep tsmadmin /etc/group

Pour ajouter un compte utilisateur au groupe tsmadmin :

sudo usermod -G tsmadmin -a <username>

Scripts et automatisation à l'aide de l'interface en ligne de commande tsm

Pour exécuter l'automatisation sur une instance Tableau Server sans mot de passe dans le fichier de script, exécutez le script sur le nœud initial et avec un compte du groupe agréé TSM approprié. Consultez la section « Authentification » ci-dessus pour plus de détails.

Affichage du contenu de l'aide dans l'interpréteur de commandes

Pour afficher un contenu d'aide minimal depuis une ligne de commande, utilisez la catégorie tsm help.

Synopsis

tsm help [category] [command]

Commandes

tsm help

Aide pour toutes les commandes tsm

tsm help <category>

Affichez l'aide pour une catégorie de commande spécifique. Par exemple, tsm help authentication.

tsm help <category> <command>

Affichez l'aide pour une commande spécifique. Par exemple, tsm help authentication open-id.

tsm help command

Liste de toutes les commandes/catégories de niveau supérieur.

Catégories

Autres articles de cette section

Merci de vos commentaires ! Erreur lors de la soumission de votre commentaire. Réessayez ou envoyez-nous un message.