tsm maintenance

Vous pouvez utiliser les commandes tsm maintenance pour gérer les tâches de maintenance du serveur, par exemple créer des sauvegardes régulières ou restaurer Tableau Server à partir d'une sauvegarde créée récemment.

tsm maintenance backup

Crée une sauvegarde des données gérées par Tableau Server. Ces données incluent la base de données PostgreSQL (le référentiel) qui contient les métadonnées des classeurs et des utilisateurs, ainsi que les fichiers d'extraits (.tde ou .hyper). Ces données n'incluent pas les données de configuration. Consultez Effectuer une sauvegarde et une restauration complètes de Tableau Server.

Remarque : n'utilisez pas cette commande sur les installations de Tableau Server qui utilisent un répertoire de fichiers externe. Voir Sauvegarde et restauration avec un répertoire de fichiers externe.

La localisation du référentiel (pgsql) et du stockage de fichiers sur le même nœud que le contrôleur d'administration peut réduire le temps nécessaire à la sauvegarde de Tableau Server. Le contrôleur d'administration se trouve généralement sur le nœud initial, à moins que vous n'ayez eu une défaillance initiale du nœud et que vous ayez déplacé le contrôleur vers un autre nœud.

Une co-localisation du référentiel et du contrôleur élimine ou réduit considérablement le besoin de compresser et de transférer les données entre les nœuds pendant le processus de sauvegarde. Ceci est également vrai pour le répertoire de fichiers, surtout si votre entreprise utilise beaucoup d'extraits.

Le fichier de sauvegarde est assemblé dans un emplacement temporaire dans le répertoire de données, puis écrit sur le répertoire défini dans la variable TSM basefilepath.backuprestore. Par défaut :

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\<filename>.tsbak

Pour plus d'informations sur l'emplacement d'écriture des fichiers de sauvegarde et la manière de les modifier, consultez Chemins d'accès des fichiers tsm. Remarque : même lorsque vous modifiez l’emplacement de sauvegarde, le processus de sauvegarde utilise un emplacement temporaire dans le répertoire de données pour assembler le fichier de sauvegarde.

Synopsis

tsm maintenance backup --file <backup_file> [options] [global options]

Options

-d, --append-date

Facultatif.

Ajoutez la date en cours au nom du fichier de sauvegarde.

-f, --file <backup_file>

Obligatoire.

Pour plus d'informations sur la sauvegarde des données de référentiel, consultez Sauvegarder les données Tableau Server pour plus d'informations.

-i, --description <string>

Facultatif.

Incluez la description spécifiée du fichier de sauvegarde.

--skip-compression

Facultatif.

Créez une sauvegarde sans utiliser de compression. Ceci entraîne un fichier de sauvegarde plus volumineux, mais peut réduire la durée nécessaire à la réalisation de la sauvegarde. Si vous utilisez ce paramètre dans une installation multinœud, nous vous recommandons vivement d'avoir une instance du répertoire de fichiers configurée sur votre nœud initial.

-k, --skip-verification

Facultatif.

Ne pas vérifier l'intégrité de la sauvegarde de base de données.

--override-disk-space-check

Facultatif.

Tentez de créer une sauvegarde même si un avertissement d'espace disque faible s'affiche.

-po, --pg-only

Facultatif.

Génère uniquement la sauvegarde du référentiel.

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

Exemples

Cet exemple crée une sauvegarde appelée ts_backup-<yyyy-mm-dd>.tsbak dans le dossier <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\ :

tsm maintenance backup -f ts_backup -d

tsm maintenance snapshot-backup complete

Cette commande doit uniquement être utilisée lorsque Tableau Server est configuré avec le répertoire de fichiers externe.

Effectuez le processus de sauvegarde d’instantané dans Tableau Server. Exécutez cette commande après avoir pris une sauvegarde d’instantané de votre stockage externe.

Les commandes tsm maintenance snapshot-backup prepare et tsm maintenance snapshot-backup complete permettent de créer une sauvegarde des données de Tableau Server pour les installations de Tableau Server qui sont configurées avec un répertoire de fichiers externe. Pour plus d'informations, voir Sauvegarde et restauration avec un répertoire de fichiers externe

Synopsis

tsm maintenance snapshot-backup complete [options] [global options]

Options

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

tsm maintenance cleanup

Par défaut, supprime les fichiers journaux remontant à plus de sept jours, ainsi que les fichiers temporaires. Les options de commande peuvent modifier les fichiers supprimés.

L'impact de la commande cleanup diffère selon que le serveur est en cours d'exécution ou non. Si le serveur exécute la plupart des fichiers anciens et que les entrées de table http_requests peuvent être supprimées, mais que tous les fichiers en cours d’utilisation (verrouillés par le système d’exploitation) ne peuvent pas être supprimés, les fichiers temporaires et les fichiers journaux actifs ne sont pas supprimés. Pour supprimer les fichiers temporaires et les fichiers journaux actuels, vous devez arrêter le serveur avant d'exécuter cette commande.

Si vous exécutez Tableau Server sur un déploiement distribué, exécutez cette commande sur le nœud exécutant le processus du contrôleur d'administration (également appelé Contrôleur TSM). Par défaut, le contrôleur se trouve sur le nœud initial du cluster.

Synopsis

tsm maintenance cleanup [options] [global options]

Options

-a, --all

Facultatif.

Effectuez toutes les opérations de nettoyage avec les valeurs de rétention par défaut. Équivaut à l'exécution de la commande cleanup avec les options suivantes : -l -t -r -q -ic.

--http-requests-table-retention <# of days>

Facultatif.

Par défaut : 7 jours

Spécifiez le nombre de jours d'entrées de table http_requests à conserver. Les entrées antérieures au nombre de jours spécifié sont supprimées. Doit être utilisé avec -q. Cette option indique depuis combien de temps les entrées sont conservées, mais ne contrôle pas la suppression des entrées de table. Pour supprimer les entrées, utilisez cette option en combinaison avec l'option -q.

-ic, --sheet-image-cache-image

Facultatif.

Effacez le cache d'images. Ce cache peut contenir des images pour les aperçus hors ligne, les instantanés pour les messages d'abonnements par e-mail et les PDF d'abonnement, ainsi que toutes les images demandées au point de terminaison de l'API REST de publication (voir rest_api_ref.htm pour plus d'informations).

Remarque : option ajoutée dans la version 2019.4

-l, --log-files

Facultatif.

Supprimez les fichiers journaux remontant à plus de retention-period. Les fichiers qui se trouvent dans les sous-répertoires sous data\tabsvc\logs seront supprimés.

--log-files-retention <# of days>

Facultatif.

Par défaut : 1 (24 heures)

Supprimez les journaux plus anciens que ce nombre de jours. Cette commande ne s'affiche pas aux fichiers temporaires.

-q, --http-requests-table

Facultatif.

Supprimez les anciennes entrées de la table http_requests. Tableau Server doit être en cours d'exécution pour que les entrées de table puissent être supprimées. Cette option est ignorée si Tableau Server est arrêté. Cette option peut être utilisée seule pour spécifier la suppression des entrées plus anciennes que la période de rétention par défaut (7 jours) ou avec l’option --http-requests-table-retention pour spécifier une période de rétention autre que celle par défaut.

Remarque : la suppression des entrées de table http_requests supprime définitivement les données disponibles pour les vues administratives personnalisées. Assurez-vous que la suppression de ces données n’aura pas d’incidence sur les vues personnalisées dont vous avez besoin.

-r, --redis-cache

Facultatif.

Effacez le cache Redis.

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

-t, --temp-files

Facultatif.

Supprimez tous les fichiers et sous-répertoires dans les répertoires suivants :

  • <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\temp : Seuls les répertoires qui stockent des fichiers correspondant à des sessions expirées (qui ne sont pas en cours d'exécution) sont supprimés.

  • <install dir>\ProgramData\Tableau\Tableau Server\data\tabsvc\httpd\temp

  • <install dir>\ProgramData\Tableau\Tableau Server\temp

Exemples

Cet exemple montre comment nettoyer tous les fichiers journaux remontant à plus de 2 jours :

tsm maintenance cleanup -l --log-files-retention 2

tsm maintenance metadata-services enable

Utilisez la commande tsm maintenance metadata-services enable pour activer l'API Tableau Metadata pour Tableau Server.

Si Tableau Server est sous licence avec l'option Module Data Management Add-on, activer l'API Metadata active également Tableau Catalog.

Lors de l'activation de l'API Metadata, les informations sur le contenu Tableau Server sont ingérées et ensuite indexées dans le magasin de l'API Metadata. L'API Metadata peut être utilisée pour interroger le schéma, la lignage et les métadonnées gérées par l'utilisateur pour le contenu publié dans Tableau Server . Une fois l'API Metadata activée, les métadonnées sont ingérées et indexées en continu jusqu'à ce que l'API Metadata soit désactivée.

Lors de l'exécution de cette commande, gardez à l'esprit ce qui suit :

  • L'exécution de cette commande arrête et démarre certains services utilisés par Tableau Server, ce qui rend certaines fonctionnalités, telles que les Recommandations, temporairement indisponibles pour vos utilisateurs.
  • Un nouvel index de métadonnées est créé et remplace l'index précédent chaque fois que cette commande est utilisée.

Pour plus d'informations sur Tableau Catalog, consultez À propos de Tableau Catalog.

Synopsis

                    tsm maintenance metadata-services enable
                

Option

--ignore-prompt

Facultatif.

Désactivez l'invite de confirmation lorsque vous activez l'API Metadata.

tsm maintenance metadata-services disable

Utilisez la commande tsm maintenance metadata-services disable pour activer l'API Metadata de Tableau.

Désactiver l'API Metadata arrête l'ingestion et l'indexage en continu des informations relatives au contenu Tableau Server, supprime l'index des informations relatives au contenu publié sur Tableau Server ainsi que les ressources associées à ce contenu, et désactive la possibilité d'interroger l'API Metadata et d'accéder à Tableau Catalog.

L'exécution de cette commande arrête et démarre certains services utilisés par Tableau Server, ce qui rend certaines fonctionnalités, telles que les Recommandations, temporairement indisponibles pour vos utilisateurs.

Synopsis

                    tsm maintenance metadata-services disable
                

Option

--ignore-prompt

Facultatif.

Désactivez l'invite de confirmation lorsque vous désactivez l'API Metadata.

tsm maintenance metadata-services get-status

Utilisez la commande tsm maintenance metadata-services get-status pour obtenir des informations sur l'état des services de métadonnées.

L'état des services de métadonnées indique si le magasin de l'API Metadata a été initialisé ou si l'API Tableau Metadata est en cours d'exécution ou non.

Synopsis

                    tsm maintenance metadata-services get-status
                

tsm maintenance reindex-search

Utilisez la commande tsm maintenance reindex-search pour reconstituer l'index de recherche.

Synopsis

tsm maintenance reindex-search [options] [global options]

Option

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

tsm maintenance reset-searchserver

Réinitialise le serveur de recherche à un état propre, en supprimant les informations de recherche et reconstituant l'index de recherche.

Synopsis

tsm maintenance reset-searchserver [options] [global options]

Option

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

tsm maintenance restore

Restaurez Tableau Server à l'aide du fichier de sauvegarde spécifié. La restauration d'un fichier de sauvegarde ne restaure aucune donnée de configuration. Consultez Effectuer une sauvegarde et une restauration complètes de Tableau Server.

Vous pouvez uniquement restaurer à partir d'une sauvegarde présentant le même type de banque d'identités que le serveur en cours d'exécution. Par exemple, une sauvegarde à partir d'un serveur utilisant l'authentification locale peut être restaurée sur une instance Tableau Server initialisée avec l'authentification locale, mais une sauvegarde depuis un serveur utilisant l'authentification Active Directory ne peut pas être restaurée sur un serveur initialisé avec l'authentification locale.

Synopsis

tsm maintenance restore --file <file_name> [--restart-server] [global options]

Options

-ak, --asset-key-file <file_name>

Facultatif. Spécifiez cette option uniquement si vous effectuez une restauration depuis des ressources créées par tabadmin sur Tableau Server (versions 2018.1 et antérieures).

Nom du fichier de clé de ressource depuis lequel effectuer la restauration. Le fichier de clé de ressource est créé par la commande tabadmin assetkeys. Le fichier doit se trouver dans l'emplacement de sauvegarde/restauration prédéfini sur le serveur.

-f, --file <file_name>

Obligatoire.

Spécifie le fichier de sauvegarde depuis lequel effectuer la restauration.

La commande restore attend un fichier de sauvegarde dans le répertoire défini dans la variable TSM basefilepath.backuprestore. Par défaut :

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\

Pour plus d'informations sur les chemins d'accès des fichiers et la manière de les modifier, consultez Chemins d'accès des fichiers tsm.

-k, --skip-identity-store-verification

Facultatif. Spécifiez cette option uniquement si vous effectuez une restauration depuis un fichier de sauvegarde créée par tabadmin sur Tableau Server (versions 2018.1 et antérieures).

N'utilisez pas cette clé pour tenter de modifier le type de magasin d'identités de Tableau Server qui a créé le fichier de sauvegarde original. Pour modifier le magasin d'identités, voir Changement de magasin d'identités.

-po, --pg-only

Facultatif.

Restaure uniquement le référentiel.

-r, --restart-server

Facultatif.

Redémarrez le serveur après la restauration.

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

tsm maintenance send-logs

Chargez le fichier spécifié sur Tableau et associez-le à un cas de support. Pour télécharger des fichiers correctement vers Tableau, votre serveur Tableau doit être capable de communiquer avec le serveur d'envoi des journaux à l'adresse https://report-issue.tableau.com.

Synopsis

tsm maintenance send-logs --case <case_number> --email <contact_email> --file <path/to/file> [global options]

Options

-c,--case <case_number>

Obligatoire.

Numéro du cas de support.

-e,--email <contact_email>

Obligatoire.

Email de contact.

-f, --file <path/to/Fichier>

Obligatoire.

Spécifie l'emplacement et le nom du fichier créé par l'archive de fichier journal à envoyer.

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

tsm maintenance snapshot-backup prepare

Cette commande doit uniquement être utilisée lorsque Tableau Server est configuré avec le répertoire de fichiers externe.

Prépare la sauvegarde de l'instantané. Une fois l'étape de préparation terminée, vous pouvez effectuer une sauvegarde d'instantané de votre stockage réseau.

Les commandes tsm maintenance snapshot-backup prepare et tsm maintenance snapshot-backup complete permettent de créer une sauvegarde des données de Tableau Server pour les installations de Tableau Server qui sont configurées avec un répertoire de fichiers externe. Pour plus d'informations, voir Sauvegarde et restauration avec un répertoire de fichiers externe

Synopsis

tsm maintenance snapshot-backup prepare [options] [global options]

Options

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

tsm maintenance snapshot-backup restore

Cette commande doit uniquement être utilisée lorsque Tableau Server est configuré avec le répertoire de fichiers externe.

Restaure la sauvegarde du référentiel à partir de l'instantané de stockage sur Tableau Server.

Pour plus d'informations, voir Sauvegarde et restauration avec un répertoire de fichiers externe.

Synopsis

tsm maintenance snapshot-backup restore [options] [global options]

Options

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

tsm maintenance validate-resources

Valide les classeurs et les sources de données pour un site. Utilisez cette commande avant de migrer un site, pour détecter les problèmes avec les ressources du site telles que les classeurs et les sources de données qui entraîneront l'échec de l'importation d'un site. Certains problèmes de ressources peuvent être corrigés en republiant à partir de sources locales. D'autres problèmes pourraient nécessiter l'aide de l'assistance Tableau.

Synopsis

tsm maintenance validate-resources --site-id <site ID> [global options]

Options

-id,--site-id <site ID>

Obligatoire.

ID du site dont vous validez les ressources.

-r,--repair

Facultatif.

Tentez de réparer les ressources non valides. Celles qui ne peuvent pas être réparées sont indiquées dans la sortie.

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 1800 (30 minutes).

 

tsm maintenance ziplogs

Utilisez la commande ziplogs pour créer une archive des fichiers journaux de Tableau Server.

Synopsis

tsm maintenance ziplogs [options] [global options]

Options

-a, --all

Facultatif.

Inclut msinfo, netstat, et le vidage le plus récent. Équivaut à l'exécution de la commande avec les options suivantes :-mi -t -l. N'inclut pas les données PostgreSQL.

-d, --with-postgresql-data

Facultatif.

Incluez le dossier de données PostgreSQL si Tableau Server est arrêté ou les fichiers d'image mémoire PostgreSQL si Tableau Server est en cours d'exécution.

--description <string>

Facultatif.

Incluez la description spécifiée du fichier archive.

--enddate <mm/dd/yyyy>

Facultatif.

La date la plus proche des fichiers journaux à inclure. Cette option doit être utilisée avec --startdate et ne peut pas être utilisée avec l'option --minimumdate. Si cette option n'est pas spécifiée, jusqu'à deux jours de journaux seront inclus.

Ajouté dans la version 2019.3

-f, --file <name>

Facultatif.

Spécifiez le nom du fichier archive compressé. Si aucun nom n'est fourni, l'archive est créée en tant que logs.zip. Le fichier est écrit sur le répertoire défini dans la variable TSM basefilepath.log_archive. Par défaut :

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

Pour plus d'informations sur les chemins d'accès des fichiers et la manière de les modifier, consultez Chemins d'accès des fichiers tsm.

-i, --description <string>

Facultatif.

Incluez la description spécifiée du fichier archive.

-mi, --with-msinfo

Facultatif.

Incluez le rapport msinfo32, avec les informations système relatives au système d'exploitation, au matériel et aux logiciels en cours d'exécution.

-l, --with-latest-dump

Facultatif.

En cas de panne d'un service, Tableau Server génère un fichier de vidage. Définissez cette option de manière à inclure le fichier de vidage le plus récent d'une panne de service. Si vous ne configurez pas cette option, aucun fichier de vidage ne sera inclus dans le fichier ziplog résultant.

-m, --minimumdate <mm/dd/yyyy>

Facultatif.

La date la plus proche des fichiers journaux à inclure. Si elle n'est pas spécifiée, un maximum de deux jours de fichiers journaux est inclus. Le format de date doit être « mm/dd/yyyy ». Cette option ne peut pas être utilisée avec --startdate et --enddate.

-o, --overwrite

Facultatif.

Permet de remplacer un fichier ziplog existant. S'il existe déjà un fichier du même nom et que cette option n'est pas utilisée, la commande ziplogs échouera.

Par défaut, le fichier est écrit sur :

C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\log-archives\

Pour plus d'informations sur les chemins d'accès des fichiers et la manière de les modifier, consultez Chemins d'accès des fichiers tsm.

--startdate <mm/dd/yyyy>

Facultatif.

La date la plus proche des fichiers journaux à inclure. Cette option doit être utilisée avec --enddate et ne peut pas être utilisée avec l'option --minimumdate. Si cette option n'est pas spécifiée, jusqu'à deux jours de journaux seront inclus.

Ajouté dans la version 2019.3

--request-timeout <timeout in seconds>

Facultatif.

Attendez la durée spécifiée pour que la commande se termine. La valeur par défaut est 7200 (120 minutes).

-t, --with-netstat-info

Facultatif.

Incluez les informations netstat.

 

Options globales

-h, --help

Facultatif.

Affichez l'aide de la commande.

-p, --password <password>

Requis, en même temps que -u ou --username si aucune session n'est active.

Spécifiez le mot de passe de l'utilisateur spécifié dans -u ou --username.

Si le mot de passe inclut des espaces ou des caractères spéciaux, mettez-le entre guillemets :

--password "my password"

-s, --serveur https://<hostname>:8850</hostname>

Facultatif.

Utilisez l'adresse spécifiée pour Tableau Services Manager. L’URL doit commencer par https, inclure le port 8850 et utiliser le nom de serveur, et non l’adresse IP. Par exemple, https://<tsm_hostname>:8850. Si aucun serveur n'est spécifié, https://<localhost | dnsname>:8850 est présupposé.

--trust-admin-controller-cert

Facultatif.

Utilisez cet indicateur pour approuver le certificat auto-signé sur le contrôleur TSM. Pour plus d’informations sur les connexions d’approbation de certificat et d'interface en ligne de commande, reportez-vous à la rubrique Connexion des clients TSM.

-u, --username <user>

Requis si aucune session n'est active, en même temps que -p ou --password.

Spécifiez un compte utilisateur. Si vous n'incluez pas cette option, la commande s'exécute à l'aide des informations d'identification avec lesquelles vous vous êtes connecté.

 

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