Utilitaire de ligne de commande rmtadmin

rmtadmin.cmdResource Monitoring Tool inclut une interface en ligne de commande, située dans le dossier d’installation. Le dossier d’installation par défaut est :

  • Serveur RMT %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\Master
  • Agent : %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\agent

Remarque : vous devez exécuter l’invite de commande en tant qu’administrateur pour que ces commandes s’exécutent avec succès.

rmtadmin est inclus à la fois dans les installations du Serveur RMT et de l’Agent. Certaines commandes peuvent varier selon que vous utilisez l’utilitaire de ligne de commande rmtadmin du Serveur RMT ou de l’Agent. Par exemple, la commande users ne fonctionne que depuis le Serveur RMT. La commande ziplogs est disponible partout mais n’inclut que les fichiers journaux de l’application sur laquelle la commande est exécutée.

Voici les commandes pouvant être utilisées par l’outil de ligne de commande rmtadmin :

Remarque : les commandes rmtadmin utilisent à la fois des paramètres de position et des options.
Les paramètres de position doivent être spécifiés à l’aide de valeurs uniquement. Vous n’avez pas besoin de spécifier le mot-clé réel. Le mot-clé d’option et la valeur doivent être spécifiés à l’aide d’un signe égal.
Exemple :
rmtadmin <command> <positional parameter value> --<option keyword>=<value>

Nous veillons à mettre en œuvre l’une des valeurs fondamentales de notre entreprise, à savoir l’égalité, et à cette fin, nous avons modifié la terminologie afin d’être le plus inclusifs possible. Étant donné que la modification des termes à certains endroits peut entraîner un changement radical, nous conservons la terminologie existante. Il se peut donc que vous continuiez à voir les termes dans les commandes et options de l’interface en ligne de commande, dans les dossiers d’installation, dans les fichiers de configuration et dans d’autres instances. Pour plus d’informations, consultez À propos de l’Aide de Tableau.

rmtadmin agents

Remarque : ajouté dans la version 2021.2

Répertorie tous les Agents enregistrés sur les nœuds Tableau Server pour tous les environnements.

Utile pour savoir où l’Agent Resource Monitoring Tool est installé sur Tableau Server.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin agents [options][global option]

Options

--env

Facultatif : utilisez cette option pour afficher la liste des Agents pour l’environnement spécifique. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

--keys

Facultatif : inclut la clé de l’Agent dans la sortie.

Exemple : rmtadmin agents --env=<myenvironmentidentifier> --keys

rmtadmin bootstrap-file

Remarque : ajouté dans la version 2021.2

Crée et enregistre le fichier d’amorçage utilisé pour enregistrer les Agents sur les nœuds Tableau Server.

Le fichier d’amorçage est créé et enregistré dans le chemin absolu ou le chemin relatif spécifié. Les chemins relatifs sont résolus dans le répertoire de travail actuel.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin bootstrap-file [options][global option]

Options

--env

Obligatoire. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.
L’Agent sur un nœud Tableau Server ne peut être enregistré que dans un environnement à la fois.

--filename

Facultatif. Chemin absolu ou relatif incluant le nom du fichier. Les chemins relatifs sont résolus dans le répertoire de travail courant. En l’absence de spécification, le nom de fichier de sortie par défaut est utilisé.

--force

Facultatif. Remplace le fichier existant qui porte le même nom.

Exemple : rmtadmin bootstrap-file --env=<myenvironmentidentifier>

rmtadmin cleanup

Remarque : ajouté dans la version 2021.2

Supprime les fichiers journaux datant de plus d’un certain nombre de jours. Par défaut, il supprime les fichiers journaux de plus de 31 jours.

Cette commande fonctionne à la fois sur le Serveur RMT et l’Agent.

Remarque : si les processus Resource Monitoring Tool sont en cours d’exécution, les fichiers journaux actifs ne seront pas nettoyés par la commande. Si vous voulez être sûr que tous les fichiers sont supprimés, vous devrez arrêter RMT à l’aide de la commande rmtadmin_stop, exécuter le nettoyage à l’aide de la commande suivante, rmtadmin cleanup --log-files-retention=0, puis redémarrer les processus à l’aide de la commande rmtadmin_start.

Synopsis

rmtadmin cleanup [option][global option]

Option

--log-files-retention

Facultatif. Supprime les fichiers journaux antérieurs au nombre de jours spécifié.

Exemple : rmtadmin cleanup --log-files-retention=<number of days>

rmtadmin create-admin-user

Version : ajouté dans la version 2022.1

Crée un utilisateur administrateur initial s’il n’existe aucun autre utilisateur.

Remarque : depuis la version 2023.1, vous pouvez créer plusieurs utilisateurs administrateurs.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin create-admin-user [options][global option]

Options

--username

Facultatif. Nom d’utilisateur du compte de l’utilisateur administrateur. Valeur par défaut « admin » si aucune valeur n’est spécifiée.

--password

Obligatoire. Mot de passe du compte de l’utilisateur administrateur.

--password-file

Facultatif. Chemin d’accès du fichier contenant le mot de passe du compte utilisateur de l’administrateur. Vous pouvez l’utiliser si vous ne souhaitez pas saisir directement le mot de passe et que le mot de passe soit stocké dans un fichier accessible.

Exemple : rmtadmin create-admin-user --username<admin user name> --password <password for the admin user account>

rmtadmin create-env

Remarque : ajouté dans la version 2021.2

Crée un nouvel environnement.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin create-env [options][global option]

Options

OptionObligatoire ?Par défautDescription
--nameOuiN/ANom de l’environnement.
--gateway-url

Oui

 

N/A

URL utilisée pour accéder à la passerelle Tableau Server.

--versionOuiN/AVersion de Tableau Server que cet environnement surveillera.
--non-interactive

Non

Les invites interactives sont activées par défaut.Désactive toutes les invites interactives.
--no-test

Non

Les tests de connexion à l’API et au référentiel sont activés par défaut.Désactive le test des connexions à l’API et au référentiel.
--api-usernameNonNullNom d’utilisateur du compte utilisé pour se connecter aux API de Tableau Server. Le compte utilisateur doit être un administrateur Tableau Server ayant accès à tous les sites Tableau Server.
--api-password

Non

(Si vous spécifiez le nom d’utilisateur de l’API Tableau, vous fournirez soit le mot de passe, soit le chemin du fichier et le fichier contenant le mot de passe)

Null

Mot de passe du compte utilisateur de l’API Tableau Server utilisé pour se connecter aux API Tableau Server.

--api-password-fileNonNullChemin d’accès au fichier et nom du fichier contenant le mot de passe du compte utilisateur de l’API Tableau Server.
--repository-serverOui

Null

Il s’agit du nom du serveur pour la base de données PostgreSQL qui est installée avec Tableau Server.
--repository-databaseOuiNullIl s’agit du nom de la base de données PostgreSQL qui est installée avec Tableau Server.
--repository-portOuiNullNuméro de port de la base de données du référentiel Tableau Server.
--repository-usernameOuiNull

Nom d’utilisateur utilisé pour la connexion à la base de données PostgreSQL installée avec le référentiel Tableau Server.

Resource Monitoring Tool accède directement à la base de données du référentiel Tableau Server pour des raisons de performances. Pour que cela fonctionne, l’accès au référentiel doit être activé, avec un mot de passe défini pour l’utilisateur de la base de données readonly. Pour plus d’informations, consultez Activer l’accès au référentiel Tableau Server.

--repository-passwordOuiNull

Mot de passe pour le compte utilisateur utilisé pour se connecter à la base de données PostgreSQL qui est installée avec Tableau Server.

Resource Monitoring Tool accède directement à la base de données du référentiel Tableau Server pour des raisons de performances. Pour que cela fonctionne, l’accès au référentiel doit être activé, avec un mot de passe défini pour l’utilisateur de la base de données readonly. Pour plus d’informations, consultez Activer l’accès au référentiel Tableau Server.

--repository-password-fileNon, mais obligatoire si vous ne fournissez pas le mot de passe dans l’invite de commande ou directement dans un script.NullChemin d’accès comprenant le nom de fichier où le mot de passe du compte utilisateur utilisé pour se connecter à la base de données PostgreSQL qui est installée avec Tableau Server.
--repository-ssl-mode

Non

Préférence

Mode SSL du référentiel Tableau Server :

Préférez SSL ou Exigez SSL pour configurer les connexions SSL au référentiel Tableau.

Désactivez pour ne jamais utiliser SSL lors des connexions au référentiel Tableau Server.

--repository-ssl-thumbprint

Non

NullLors de la configuration de Tableau Server PostgreSQL pour autoriser les connexions directes, Tableau Server crée un certificat et des clés. Vous pouvez choisir soit de fournir l’empreinte digitale du certificat généré par Tableau Server, soit de copier le fichier server.crt sur l’ordinateur Serveur Resource Monitoring Tool. Si vous choisissez de copier le fichier certificat, vous n’avez pas à fournir l’empreinte digitale. Pour plus d’informations, consultez Configurer Postgres SSL pour autoriser les connexions directes depuis les clients.

Exemple : rmtadmin create-env --name=<myenvironment> --api-username=<TableauServer API user name> --api-password=<password for the Tableau Server API user account> --gateway-url <Tableau Server Gateway URL> --version <Tableau Server version>

rmtadmin data-access

Remarque : ajouté dans la version 2022.3

Active ou désactive l’accès à la base de données PostgreSQL. Remarque : l’accès à la base de données PostgreSQL est requis à partir de la version 2022.3 pour que Resource Monitoring Tool puisse rassembler avec succès toutes les données de surveillance de Tableau Server.

Cette commande ne fonctionne que sur le Serveur RMT

Remarque : la base de données PostgreSQL doit être redémarrée pour que cette configuration prenne effet.

Synopsis

rmtadmin data-access [positional parameter][options] [global option]

Paramètre de position

mode

Obligatoire. Le mode qui doit être utilisé pour l’accès aux données à distance à la base de données PostgreSQL. Les valeurs doivent être l’une des suivantes : Aucun, ReadOnly, Administrateur . Lorsqu’il est défini sur Aucun, l’accès aux données est désactivé. ReadOnly et Administrateur spécifient le compte utilisateur à utiliser pour accéder à la base de données.

Options

--

Exemple :

rmtadmin data-access ReadOnly

rmtadmin restart --db

rmtadmin delete-env

Remarque : ajouté dans la version 2021.2

Supprime un environnement spécifique et toutes les données qui ont été collectées pour cet environnement. Supprime également les informations de connexion et de topologie sur l’instance de Tableau Server que l’environnement surveille et annule l’enregistrement de tous les Agents Resource Monitoring Tool.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin delete-env [positional parameter][options] [global option]

Paramètre de position

env

Obligatoire. Il s’agit de l’identifiant généré par le système. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

Options

--confirm

Facultatif. Confirmez que vous souhaitez supprimer l’environnement. Si vous ne fournissez pas cette option, vous serez invité à confirmer.

--skip-agent-disconnect

Facultatif. Ignore la déconnexion de l’agent et poursuit le désenregistrement de l’agent. Utilisez cette option si vous pensez que l’Agent est inaccessible, par exemple, si le nœud Tableau Server a été supprimé ou que l’Agent a été désinstallé de ce nœud.

Exemple : rmtadmin delete-env <myenvironmentidentifier>

rmtadmin delete-env-data

Supprime définitivement toutes les données relatives à Tableau Server collectées pour un environnement spécifique. Les informations de configuration de l’environnement, de Tableau Server et d’enregistrement d’Agent ne seront pas supprimés.

Cette commande est utile pour effacer toutes les données existantes dans un environnement sans supprimer l’environnement lui-même. Après la suppression des données existantes, les nouvelles données envoyées par les agents continueront à être traitées.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin delete-env-data [positional parameter][option][global option]

Paramètre de position

env

Identificateur de l’environnement pour lequel les données doivent être supprimées. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

Option

--confirm

Facultatif. Confirmez que vous souhaitez supprimer les données d’environnement. Si vous ne fournissez pas cette option, vous serez invité à confirmer.

Exemple : rmtadmin delete-env-data <myenvironmentidentifier>

rmtadmin delete-server

Remarque : ajouté dans la version 2021.2

Supprime les informations de configuration du nœud Tableau Server de l’environnement, annule l’enregistrement de l’Agent sur ce nœud et supprime toutes les données de surveillance collectées spécifiques à ce nœud.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin delete-server [options][global option]

Options

--env

Obligatoire. Identificateur de l’environnement auquel le nœud Tableau Server est connecté. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

--hostname

Obligatoire pour supprimer les informations sur un ou plusieurs nœuds connectés à l’environnement et si --all n’est pas spécifié.

Il s’agit du nom de machine du nœud Tableau Server. Utilisez des virgules pour séparer plusieurs valeurs si vous spécifiez plusieurs noms d’hôte.

--all

Facultatif, mais obligatoire si --hostname n’est pas spécifié.

Supprime les informations de tous les nœuds Tableau Server connectés à l’environnement.

--skip-agent-disconnect

Facultatif. Ignore la déconnexion de l’agent et poursuit le désenregistrement de l’agent. Utilisez cette option si l’Agent est inaccessible, par exemple si le nœud a été supprimé de Tableau Server ou que l’Agent a été désinstallé de ce nœud.

--confirm

Confirmez que vous souhaitez supprimer toutes les informations sur le nœud Tableau Server. Si vous ne fournissez pas cette option, vous serez invité à confirmer.

Exemple : rmtadmin delete-server --hostname=<machine name of the Tableau Server node>

rmtadmin delete-server-data

Remarque : ajouté dans la version 2021.2

Supprime les données collectées à partir d’un ou de plusieurs nœuds Tableau Server. Les données supprimées ne concernent que les nœuds spécifiés. Si vous spécifiez all, toutes les données collectées à partir de tous les nœuds seront supprimées. La configuration de l’environnement, les informations de Tableau Server et les enregistrements d’Agent ne seront pas supprimés.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin delete-server-data [options][global option]

Options

--env

Obligatoire. Identificateur de l’environnement auquel le nœud Tableau Server est connecté. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

--hostname

Obligatoire pour supprimer les informations sur un ou plusieurs nœuds connectés à l’environnement et si --all n’est pas spécifié.

Il s’agit du nom de machine du nœud Tableau Server. Utilisez des virgules pour séparer plusieurs valeurs si vous spécifiez plusieurs noms d’hôte.

--all

Facultatif, mais obligatoire si --hostname n’est pas spécifié.

Supprime les données de surveillance pour tous les nœuds Tableau Server connectés à l’environnement.

--confirm

Confirmez que vous souhaitez supprimer toutes les données de surveillance des nœuds Tableau Server. Si vous ne fournissez pas cette option, vous serez invité à confirmer.

Exemple : rmtadmin delete-server-data --all

rmtadmin deregister

Remarque : ajouté dans la version 2021.2

Annule l’enregistrement de l’Agent de l’environnement. Les données de surveillance de ce nœud ne seront plus collectées. Les données existantes resteront et ne seront pas supprimées.

Cette commande ne fonctionne que sur l’Agent RMT. Exécutez-la sur l’Agent que vous souhaitez désenregistrer.

Synopsis

rmtadmin deregister [options]

Options

--confirm

Facultatif. Confirmez que vous souhaitez désenregistrer l’Agent. Cette opération contourne l’invite de confirmation.

--ignore-master-errors

Facultatif. Ignore toutes les erreurs qui se produisent lors des communications avec le Serveur RMT pendant ce processus.

Exemple : rmtadmin deregister --confirm

rmtadmin deregister-agent

Remarque : ajouté dans la version 2021.2

Annule l’enregistrement de l’Agent spécifié dans l’environnement. Les données de surveillance de ce nœud ne seront plus collectées. Les données existantes resteront et ne seront pas supprimées.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin deregister-agent [options][global option]

Options

--env

Obligatoire si --key n’est pas spécifié.

Identificateur de l’environnement dans lequel l’Agent est actuellement enregistré. Il s’agit de l’identifiant généré par le système. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

--key

Facultatif si --env est spécifié.

Il s’agit de la clé de l’Agent. Utilisez des virgules pour séparer plusieurs valeurs. Vous pouvez obtenir les valeurs des clés en exécutant la commande rmtadmin agents.

--hostname

Facultatif. Nom de la machine du nœud Tableau Server où l’Agent est installé. Utilisez des virgules pour séparer plusieurs valeurs.

--all

Facultatif. Utilisez cette option pour annuler l’enregistrement des Agents sur tous les nœuds.

--ignore-agent-errors

Facultatif. Ignore toutes les erreurs qui se produisent s’il est impossible d’établir une connexion avec les Agents pendant ce processus.

--skip-agent-disconnect

Facultatif. Ignore la déconnexion de l’Agent et continue avec le désenregistrement de l’Agent. Utilisez cette option si vous pensez que l’Agent est inaccessible, par exemple si le nœud a été supprimé de Tableau Server ou que l’Agent a été désinstallé de ce nœud.

--confirm

Facultatif. Confirmez que vous souhaitez désenregistrer les Agents. Si vous ne fournissez pas cette option, vous serez invité à confirmer.

Exemple : rmtadmin deregister-agent --env=<myenvironmentidentifier> --all

rmtadmin environments

Remarque : ajouté dans la version 2021.2

Répertorie tous les environnements sur le Serveur Resource Monitoring Tool.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin environments [global option]

rmtadmin get

Obtient la valeur actuelle d’une clé de configuration spécifiée.

Cette commande peut être utilisée à la fois sur le Serveur RMT et l’Agent.

Synopsis

rmtadmin get <config.key> [global option]

Paramètre de position

key

Nom de la clé de configuration.

Exemple : rmtadmin get db:database

Clés de configuration prises en charge

CléType de donnéesS’applique àDEFAULTDescription
db:databaseChaîneServeur RMTtabrmtdbNom de la base de données PostgreSQL utilisée par RMT.
db:readOnlyUsernameChaîneServeur RMTreadonlyNom d’utilisateur d’un compte utilisateur PostgreSQL qui dispose uniquement d’un accès en lecture seule aux données RMT.
db:readOnlyPasswordChaîneServeur RMTGénéré par le programme d’installation.Mot de passe de l’utilisateur en lecture seule PostgreSQL.
mq:tls:certificateHostNameChaîneServeur RMT et AgentN/ANom de l’hôte dans le certificat à utiliser lors de la connexion à RabbitMQ via TLS.
mq:tls:enabledBooléenServeur RMT et AgentFALSEActiver/désactiver la connexion TLS à RabbitMQ.
mq:portEntierServeur RMT et Agent5672Numéro de port hôte RabbitMQ.
mq:virtualHostChaîneServeur RMT et AgenttabrmtConnexion au Serveur RMT ou à l’Agent. Pour l’Agent, vous pouvez modifier ce paramètre en enregistrant l’Agent avec un fichier bootstrap. Pour le Serveur RMT, la valeur est gérée par le programme d’installation.
server.web.runBooléenAgentTRUEActiver/désactiver l’interface Web de l’Agent.

Utilisez la commande set pour afficher la valeur actuelle de la configuration.

rmtadmin help

Affiche l’aide générale concernant l’interface de ligne de commande et les commandes disponibles.

Cette commande peut être utilisée à la fois sur le Serveur RMT et l’Agent.

Synopsis

rmtadmin help

Afficher les informations d’aide et d’utilisation pour une commande spécifique :

Cette commande peut être utilisée à la fois sur le Serveur RMT et l’Agent.

rmtadmin help [command]

rmtadmin master-setup

Configure le Serveur RMT avec des options spécifiées. Utilisé à la fois lors des configurations d’installation et de post-installation.

Synopsis

rmtadmin master-setup [options][global option]

Les options de configuration sont énumérées ci-dessous :

OptionObligatoire ?Par défautDescription
--admin-password

Oui (requis pour l’installation initiale seulement)

Le mot de passe peut être inclus dans la ligne de commande ou fournir un fichier avec le mot de passe à utiliser. Si aucun des deux n’est fourni, vous serez invité à saisir un mot de passe.

N/AMot de passe de l’utilisateur administrateur.
--admin-password-file

Oui (requis pour l’installation initiale seulement)

Le mot de passe peut être inclus dans la ligne de commande ou fournir un fichier avec le mot de passe à utiliser. Si aucun des deux n’est fourni, vous serez invité à saisir un mot de passe.

N/AMot de passe de l’utilisateur administrateur.
--admin-usernameNonadminNom d’utilisateur de l’utilisateur administrateur.
--skip-admin-creation

Ajouté : version 2020.4.0

Supprimé : version 2022.3.0

Non

Cette option doit être utilisée uniquement lorsque vous faites des mises à jour de configuration après l’installation.

Dans les versions où cette option est valide (2020.4.0 - 2022.2.x), si elle n’est pas utilisée lors des mises à jour de configuration post-installation, la commande échouera et aucune mise à jour ne sera effectuée.

Dans les versions 2022.3.0 et ultérieures, la commande créera l’administrateur si nécessaire.

False

Ignorer la création de l’utilisateur administrateur et du mot de passe.

--http-portNon80 
--require-httpsNonFalseRediriger le trafic http vers HTTPS.
--https-certificate-modeNon

'Default'

Options disponibles :

  • Par défaut
  • Magasin (Windows uniquement)
  • Local

Type de recherche de certificat à effectuer pour le certificat HTTPS.

Par défaut : ce mode utilise le certificat auto-signé par défaut fourni par le programme d’installation.

Magasin : ce mode vous permet d’entrer l’empreinte numérique d’un certificat dans le magasin de certificats Windows.

Local : ce mode vous permet de spécifier un certificat basé sur un fichier dans le dossier config.

--https-certificate-store-thumbprintNonNullCertificat HTTPS hash/thumbprint à rechercher en mode certificat ‘store’.
--https-certificate-local-nameNon

Null

Remarque : en l’absence de spécification, Resource Monitoring Tool est installé avec un certificat auto-signé et utilisera ce certificat pour les communications HTTPS.

Nom du fichier de certificat HTTPS.
--https-certificate-local-passwordNonNullMot de passe à utiliser pour le certificat HTTPS.
--https-certificate-local-password-fileNonNullChemin du fichier contenant le mot de passe à utiliser pour le certificat HTTPS.
--confirmNonInvite de confirmation.Confirme le redémarrage du Serveur RMT.
--host

Non

Remarque : nous déconseillons de modifier cette valeur.

Valeur de configuration actuelle ou nom de la machine.URL préférée pour accéder au serveur Resource Monitoring Tool. Le serveur écoutera tous les adresses IP quel que soit le nom d’hôte.
--db-config=externalNonAucun.
Ceci n’est utilisé que lorsque le référentiel est configuré en externe au serveur RMT.
Utilisez ceci pour configurer le Serveur RMT Server de manière à ce qu’il utilise un référentiel externe. Vous n’avez pas besoin de le spécifier si vous souhaitez que la base de données PostgreSQL soit installée localement.
--db-serverNonValeur de configuration actuelle ou par défaut du programme d’installation.

Il s’agit du nom du serveur pour la base de données PostgreSQL qui est installée avec Resource Monitoring Tool.

Si vous utilisez un référentiel externe hébergé sur AWS RDS, il doit s’agir du nom de l’instance RDS.

--db-ssl-mode

Version : ajouté dans la version 2023.1.0

NonPrefer

Détermine le chiffrement SSL/ TLS pour la connexion à la base de données PostgreSQL qui est installée avec Resource Monitoring Tool.

Les options sont Prefer (par défaut), VerifyCA et VerifyFull. Pour plus d’informations, consultez la Documentation Npgsql(Le lien s’ouvre dans une nouvelle fenêtre).

--db-portNonValeur de configuration actuelle ou par défaut du programme d’installation.Numéro de port pour le serveur de données.
--db-usernameNonValeur de configuration actuelle ou par défaut du programme d’installation.

Nom d’utilisateur utilisé pour la connexion à la base de données PostgreSQL installée avec Resource Monitoring Tool.

Si vous utilisez un référentiel externe hébergé sur AWS RDS, il doit s’agir de « postgres ».

--db-passwordNonValeur de configuration actuelle ou par défaut du programme d’installation.

Mot de passe pour le compte utilisateur utilisé pour se connecter à la base de données PostgreSQL qui est installée avec Resource Monitoring Tool.

Si vous utilisez un référentiel externe hébergé sur AWS RDS, il s’agit du mot de passe utilisateur que vous avez créé lors de la création de l’instance RDS.

--mq-config=externalNonAucun
Cette option n’est spécifiée que lorsque le service de messagerie est hébergé à l’extérieur du Serveur RMT.
Cette option configure le Serveur RMT Server de manière à ce qu’il utilise un service de messagerie RabbitMQ externe.
--mq-serverNonValeur de configuration actuelle ou par défaut du programme d’installation.Nom du serveur de file d’attente de message.
--mq-portNonValeur de configuration actuelle ou par défaut du programme d’installation.Port de file d’attente de message.
--mq-vhostNonValeur de configuration actuelle ou par défaut du programme d’installation.Hôte virtuel de file d’attente de message.
--mq-usernameNonValeur de configuration actuelle ou par défaut du programme d’installation.Nom d’utilisateur utilisé pour se connecter à la file d’attente de messages.
--mq-passwordNonValeur de configuration actuelle ou par défaut du programme d’installation.Mot de passe du compte utilisateur utilisé pour se connecter à la file d’attente de messages.
--mq-enable-tlsNonValeur de configuration actuelle ou false.Nécessite une connexion TLS pour se connecter à la file d’attente de messages.
--mq-tls-certificate-hostNonValeur de configuration actuelle ou null.Nom canonique du serveur de file d’attente de message. Doit correspondre au nom sur le certificat.
--password-saltNonAléatoire

Valeur salt globale utilisée pour hacher le mot de passe.

S’applique aux comptes utilisateur locaux créés dans Resource Monitoring Tool.

--password-min-lengthNonValeur de configuration actuelle ou 10.

Longueur minimale pour le mot de passe.

S’applique aux comptes utilisateur locaux créés dans Resource Monitoring Tool.

--password-min-numericNonValeur de configuration actuelle ou 1.

Nombre minimum requis de caractères numériques dans le mot de passe.

S’applique aux comptes utilisateur locaux créés dans Resource Monitoring Tool.

--password-min-specialNonValeur de configuration actuelle ou 1.

Le nombre minimum de caractères spéciaux requis dans le mot de passe.

S’applique aux comptes utilisateur locaux créés dans Resource Monitoring Tool.

--password-min-latinNonValeur de configuration actuelle ou 5.

Nombre minimum requis de caractères latins dans le mot de passe.

S’applique aux comptes utilisateur locaux créés dans Resource Monitoring Tool.

--password-require-mixed-caseNonValeur de configuration actuelle ou true.

Requiert des caractères à casse mixte dans les mots de passe.

S’applique aux comptes utilisateur locaux créés dans Resource Monitoring Tool.

--auth-timeout-minutesNonValeur de configuration actuelle ou 240.Le nombre de minutes avant l’expiration de l’authentification utilisateur pour la session.
--auth-sliding-expirationNonConfiguration actuelle ou true.Indique s’il faut ou non réinitialiser le délai d’expiration d’authentification avec l’activité de l’utilisateur.

Exemples :

Pour spécifier le mot de passe admin : rmtadmin master-setup --admin-password=<password> --skip-admin-creation

Pour mettre à jour le port post-installation : rmtadmin master-setup --http-port=8000 --skip-admin-creation

rmtadmin passwd

Réinitialise le mot de passe d’un compte utilisateur Resource Monitoring Tool spécifique.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin passwd [positional parameter][global option]

Paramètre de position

username

Nom de l’utilisateur pour lequel vous souhaitez modifier le mot de passe.

Exemple : rmtadmin passwd <username>

rmtadmin query

Exécute une requête SQL brute sur la base de données Resource Monitoring Tool et enregistre les résultats dans un fichier de sortie.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin query [positional parameter][options] [global option]

Paramètre de position

sql

Texte de commande SQL à exécuter. Vous pouvez fournir plusieurs commandes SQL. Pour utiliser un fichier avec les commandes SQL, utilisez @ comme préfixe au nom du fichier.

Options

--outfile=VALUE

Nom du fichier zip dont vous souhaitez produire les résultats de la requête. Le paramètre par défaut est queryresults.zip

--force

Remplace le fichier existant.

--timeout=VALUE

délai d’attente pour la requête. Spécifiez-le en quelques secondes

--commit

Valide les modifications apportées par la commande SQL à la base de données. Par défaut, la commande SQL est exécutée en tant que transaction, mais est restaurée à la fin.

Exemple : rmtadmin query <SQLCommand> --outfile=<path and the output file name>

rmtadmin register

Remarque : ajouté dans la version 2020.2

Enregistre l’Agent à l’aide d’un fichier bootstrap. Le fichier d’amorçage peut être téléchargé à l’aide de la commande rmtadmin bootstrap-file.

Cette commande ne peut être utilisée que sur l’Agent et doit être exécutée sur la machine où vous souhaitez installer l’Agent.

Synopsis

rmtadmin register [options][positional parameter] [global option]

Paramètre de position

bootstrap

Chemin d’accès du fichier, y compris le nom du fichier bootstrap.

Options

--username

Obligatoire. Nom de l’utilisateur admin créé lors de l’installation du Serveur RMT.

--password

Obligatoire. Mot de passe du compte utilisateur.

--password-file

Chemin comprenant le nom de fichier qui contient les informations de mot de passe. Le mot de passe peut être inclus dans la ligne de commande ou dans un fichier contenant le mot de passe. Si aucun des deux n’est fourni, vous serez invité à saisir un mot de passe.

--server-name

Nom du nœud où l’Agent est en cours d’installation. Par défaut, il s’agit du nom de l’ordinateur si aucun nom n’est spécifié.

--server-description

Description personnalisée du serveur.

Exemple : rmtadmin register <bootstrap file name and path> --server-name=<server name>

rmtadmin restart

Redémarre les applications Resource Monitoring Tool. Si la commande est exécutée à partir de la machine sur laquelle le Serveur RMT est installé, elle redémarre l’application Serveur RMT. Lorsqu’elle est exécutée sur un nœud sur lequel l’agent est installé, elle redémarre uniquement l’application de l’Agent sur ce nœud particulier.

Cette commande peut être exécutée à la fois depuis le Serveur RMT et l’Agent.

Synopsis

rmtadmin restart [options] [global option]

Options

Au moins une option doit être spécifiée :

Serveur RMT :

--all

Redémarre tous les services.

--master

Redémarre le Serveur RMT.

--mq

Redémarre le service de file d’attente de messages.

--db

Redémarre le service de base de données.

Agent :

--agent

Redémarre le service Agent en cours d’exécution sur la machine.

Exemple : rmtadmin restart --db

 

rmtadmin rotate-mq-certificate

Rotation du certificat client dans la file d’attente de messages de l’Agent.

Cette commande doit être exécutée depuis l’Agent RMT.

Synopsis

rmtadmin rotate-mq-certificate [options] [positional parameter]

Paramètre de position

bootstrap

Chemin d’accès du fichier, y compris le nom du fichier bootstrap.

Options

--username

Obligatoire. Nom d’utilisateur du Serveur principal.

--password

Obligatoire. Mot de passe du compte utilisateur du Serveur principal.

--password-file

Chemin d’accès comprenant le nom de fichier avec les informations de mot de passe du Serveur principal. Le mot de passe peut être inclus dans la ligne de commande ou dans un fichier contenant le mot de passe. Si aucun des deux n’est fourni, vous serez invité à saisir un mot de passe.

--confirm-restart

Confirme le redémarrage du service et contourne l’invite de confirmation.

rmtadmin rotate-mq-certificates

Rotation des certificats serveur et client dans la file d’attente de messages.

Cette commande doit être exécutée depuis le Serveur RMT.

Synopsis

rmtadmin rotate-mq-certificates [options]

Options

--confirm-restart

Confirme le redémarrage du service et contourne l’invite de confirmation.

rmtadmin servers

Remarque : ajouté dans la version 2021.2

Répertorie tous les nœuds Tableau Server dans tous les environnements ou dans un environnement spécifique.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin servers [positional parameter][global option]

Paramètre de position

env

Facultatif. Spécifiez l’identificateur de l’environnement pour obtenir une liste des nœuds Tableau Server enregistrés dans cet environnement. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

rmtadmin service-setup

Remarque : ajouté dans la version 2021.4 Utilisé pour installer ou mettre à jour les informations d’identification de l’utilisateur pour les services Resource Monitoring Tool, notamment le Serveur RMT, l’Agent, RabbitMQ et la base de données PostgreSQL. Ceci est utile pour mettre à jour les informations de service après l’installation.

Cette commande fonctionne à la fois sur le Serveur RMT et l’Agent.

Synopsis

rmtadmin service-setup [positional parameter][options][global option]

Paramètre de position

Au moins une des valeurs suivantes doit être spécifiée :

all

Met à jour tous les services disponibles. Peut être exécuté à la fois sur le Serveur RMT et l’Agent. Lorsqu’il est exécuté sur un nœud Tableau Server, met à jour l’Agent sur ce nœud.

master

Met à jour le Serveur RMT.

agent

Met à jour l’Agent. Ne peut être exécuté que sur l’Agent (nœud Tableau Server).

db

Met à jour le service de base de données. Ne peut être exécuté que sur le Serveur RMT.

mq

Met à jour le service de file d’attente de messages. Ne peut être exécuté que sur le Serveur RMT.

Options

--confirm

Facultatif. Confirmez que vous souhaitez effectuer des mises à jour. Peut être exécuté à la fois sur le Serveur RMT et l’Agent. Lorsqu’il est exécuté sur un nœud Tableau Server, met à jour l’Agent sur ce nœud.

--user-type

Requis pour le Serveur RMT et l’Agent. Le type de compte utilisé pour exécuter le Serveur RMT ou l’Agent. Les valeurs autorisées sont :

  • Compte virtuel (Serveur RMT uniquement)
  • network-service
  • local-system
  • local-service
  • username (nom d’utilisateur du compte d’utilisateur local ou de domaine)

--username

Spécifie le nom d’utilisateur du compte. Requis si vous utilisez un compte d’utilisateur local ou de domaine.

--password

Spécifie le mot de passe du compte. Requis si vous utilisez un compte d’utilisateur local ou de domaine.

--password-file

Facultatif. Le chemin d’accès à l’emplacement du fichier, y compris le nom du fichier où les informations de mot de passe sont stockées.

--append-permissions

Facultatif. Ajoute de nouvelles autorisations. Utilisez ce paramètre si vous ne souhaitez pas écraser les autorisations existantes.

rmtadmin set

Définit la valeur actuelle d’une clé de configuration spécifiée.

Cette commande fonctionne à la fois sur le Serveur RMT et l’Agent.

Synopsis

rmtadmin set [positional parameter] [global option]

Paramètres de position

key

Clé de configuration dont vous souhaitez modifier la valeur.

value

Nouvelle valeur que vous souhaitez utiliser.

Exemple : rmtadmin set mq:port <port number> où mq:port est la clé et <port number> est la valeur.

Clés de configuration prises en charge

CléType de donnéesS’applique àDEFAULTDescription
mq:tls:certificateHostNameChaîneServeur RMT et AgentN/ANom de l’hôte dans le certificat à utiliser lors de la connexion à RabbitMQ via TLS
mq:tls:enabledBooléenServeur RMT et AgentFALSEActiver/désactiver la connexion TLS à RabbitMQ
mq:portEntierServeur RMT et Agent5672Numéro de port hôte RabbitMQ.
server.web.runBooléenAgentTRUEActiver/désactiver l’interface Web de l’Agent.

Options

--backup

Crée une sauvegarde du fichier de configuration avant d’apporter des modifications.

Utilisez la commande get pour afficher la valeur actuelle de la configuration.

rmtadmin start

Démarre les services Resource Monitoring Tool. En cas d’exécution sur le Serveur RMT, la commande démarre le Serveur RMT uniquement. Lorsque vous l’exécutez sur un Agent, elle démarre l’Agent sur l’ordinateur d’où vous exécutez la commande.

Cette commande fonctionne à la fois sur le Serveur RMT et l’Agent

Synopsis

rmtadmin start [options] [global option]

Options

Au moins une option doit être spécifiée :

Serveur RMT :

--all

Démarre les services.

--master

Démarre le Serveur RMT.

--mq

Démarre le service de file d’attente de messages.

--db

Démarre le service de base de données.

Agent :

--agent

Démarre le service Agent en cours d’exécution sur la machine.

Exemple : rmtadmin start --all

rmtadmin status

Vérifie l’état de l’application et les services en cours d’utilisation sur l’ordinateur où vous exécutez cette commande. Pour le Serveur RMT, le rapport d’état confirme que le Serveur RMT est connecté à la base de données et à la file d’attente de messages. Pour les Agents, le rapport d’état confirme que l’Agent est connecté au Serveur RMT.

Cette commande peut être exécutée à la fois sur le Serveur RMT et l’Agent.

Cette commande renvoie ce qui suit :

  • État de l’application (en cours d’exécution ou non)
  • État de la licence
  • Connexion MQ
  • Détails de file d’attente
  • Mémoire utilisée
  • Espace disque utilisé
  • Version de Tableau Server sur l’ordinateur
  • Topologie de processus de Tableau Server qui est stockée dans le fichier de configuration de l’Agent.

Synopsis

rmtadmin status [global option]

rmtadmin stop

Arrête les services Resource Monitoring Tool. En cas d’exécution sur le Serveur RMT, la commande arrête uniquement le Serveur RMT. En cas d’exécution sur un ordinateur où l’Agent est installé, la commande arrête uniquement l’Agent sur cet ordinateur.

Cette commande peut être exécutée à la fois sur le Serveur RMT et l’Agent.

Synopsis

rmtadmin stop [options] [global option]

Options

Au moins une option doit être spécifiée :

Serveur RMT :

--all

Arrête tous les services.

--master

Arrête le Serveur RMT.

--mq

Arrête le service de file d’attente de messages.

--db

Arrête le service de base de données.

Agent :

--agent

Arrête le service d’Agent en cours d’exécution sur la machine.

Exemple : rmtadmin stop --db

rmtadmin test-env

Remarque : ajouté dans la version 2021.2

Teste les différents points de connexion entre Resource Monitoring Tool et Tableau Server. Cela inclut le test de la connexion au référentiel Tableau Server, des connexions API Tableau Server et des licences Advanced Management (anciennement module Server Management Add-on).

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin test-env [positional parameter][global option]

Paramètre de position

--env

Facultatif. Identifiant de l’environnement que l’outil Resource Monitoring Tool surveille. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

--force

Facultatif. Utilisez cette option pour mettre à jour la ligne de base immédiatement même s’il n’y a pas suffisamment de données disponibles. Par défaut, la commande attendra 50 chargements réussis pour calculer la ligne de base

rmtadmin update-baseline

Remarque : Ajouté dans la version 2021.4

Met à jour la ligne de base pour tous les chargements de vue. La ligne de base est le 95e centile de 50 temps de chargement initiaux réussis pour une vue.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin update-baseline [options][global option]

Options

env

Obligatoire. Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

rmtadmin update-env

Remarque : ajouté dans la version 2021.2

Met à jour les paramètres de l’environnement.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin update-env [options][global option]

Options

OptionObligatoire ?Description
--non-interactive

Non

Désactive toutes les invites interactives.
--no-test

Non

Désactive le test des connexions à l’API et au référentiel.
--nameOuiNom de l’environnement.
--idNonIdentifiant de l’environnement utilisé dans les URL de l’interface Web.

Il s’agit de l’identifiant généré par le système. Vous le trouverez en allant sur Admin >Environments >Edit Environment. Sur cette page, dans la section Environment Details, vous verrez l’identifiant de l’environnement.

--gateway-url

Non

 

URL utilisée pour accéder à la passerelle Tableau Server.

--versionNonVersion de Tableau Server que cet environnement surveillera.
--api-usernameNonNom d’utilisateur du compte utilisé pour se connecter aux API de Tableau Server. Le compte utilisateur doit être un administrateur Tableau Server ayant accès à tous les sites Tableau Server.
--api-passwordNon

Mot de passe du compte utilisateur de l’API Tableau Server utilisé pour se connecter aux API Tableau Server.

--api-password-fileNonChemin d’accès au fichier contenant le mot de passe du compte utilisateur de l’API Tableau Server.
--repository-serverNonIl s’agit du nom du serveur pour la base de données PostgreSQL qui est installée avec Resource Monitoring Tool.
--repository-portNonNuméro de port de la base de données du référentiel Tableau Server.
--repository-usernameNon

Nom d’utilisateur utilisé pour la connexion à la base de données PostgreSQL installée avec le référentiel Tableau Server.

Resource Monitoring Tool accède directement à la base de données du référentiel Tableau Server pour des raisons de performances. Pour que cela fonctionne, l’accès au référentiel doit être activé, avec un mot de passe défini pour l’utilisateur de la base de données readonly. Pour plus d’informations, consultez Activer l’accès au référentiel Tableau Server.

--repository-passwordNon

Mot de passe pour le compte utilisateur utilisé pour se connecter à la base de données PostgreSQL qui est installée avec Tableau Server.

Resource Monitoring Tool accède directement à la base de données du référentiel Tableau Server pour des raisons de performances. Pour que cela fonctionne, l’accès au référentiel doit être activé, avec un mot de passe défini pour l’utilisateur de la base de données readonly. Pour plus d’informations, consultez Activer l’accès au référentiel Tableau Server.

--repository-passwordNonChemin d’accès comprenant le nom de fichier où le mot de passe du compte utilisateur utilisé pour se connecter à la base de données PostgreSQL qui est installée avec Tableau Server.
--repository-ssl-mode

Non

Mode SSL du référentiel Tableau Server :

Préférez SSL ou Exigez SSL pour configurer les connexions SSL au référentiel Tableau.

Désactivez pour ne jamais utiliser SSL lors des connexions au référentiel Tableau Server.

--repository-ssl-thumbprint

Non

Lors de la configuration de Tableau Server PostgreSQL pour autoriser les connexions directes, Tableau Server crée un certificat et des clés. Vous pouvez choisir soit de fournir l’empreinte digitale du certificat généré par Tableau Server, soit de copier le fichier server.crt sur l’ordinateur Serveur Resource Monitoring Tool. Si vous choisissez de copier le fichier certificat, vous n’avez pas à fournir l’empreinte digitale. Pour plus d’informations, consultez Configurer Postgres SSL pour autoriser les connexions directes depuis les clients.

Exemple : rmtadmin update-env --name=<new name>

rmtadmin users

Affiche la liste des comptes utilisateur Resource Monitoring Tool.

Cette commande ne fonctionne que sur le Serveur RMT.

Synopsis

rmtadmin users

rmtadmin version

Affiche les informations de version actuelle du Serveur RMT en cas d’exécution sur le Serveur RMT. Affiche les informations de version actuelle de l’Agent installé sur l’ordinateur depuis lequel vous exécutez la commande.

Cette commande peut être exécutée à la fois sur le Serveur RMT et l’Agent.

Synopsis

rmtadmin version

rmtadmin ziplogs

Crée un fichier archive ZIP contenant les fichiers journaux Resource Monitoring Tool.

Cette commande fonctionne à la fois sur le Serveur RMT et l’Agent, mais inclut uniquement les fichiers journaux de l’application sur laquelle la commande est exécutée.

Synopsis

rmtadmin ziplogs [positional parameter] [option] [global option]

Paramètre de position

filename

Nom du fichier zip de sortie. Le nom par défaut est log.zip si aucun nom n’est fourni.

Option

--force

Remplace le fichier existant.

Exemple : rmtadmin ziplogs <zip file name> --force

Option globale

--help

Affiche l’aide de la commande.

Merci de vos commentaires !Avis correctement envoyé. Merci