La commande manualvacuum sous nz

La commande nz manualvacuum effectue une opération complète de nettoyage et de réindexation sur toutes les bases de données de votre instance NPSaaS. Cette opération de maintenance permet de libérer de l'espace disque et d'optimiser les performances de la base de données en supprimant les données obsolètes et en reconstruisant les index. Cette commande a été introduite dans la version 11.3.1.3 de nzcli.

Présentation

La purge manuelle est une opération de maintenance essentielle qui :

  • Arrête le système NPS (nzstop)
  • Crée une sauvegarde des données du catalogue
  • Effectue des opérations de nettoyage et de réindexation sur toutes les bases de données
  • Redémarre le système NPS (nzstart)

Le système est indisponible pendant cette opération, qui peut prendre un certain temps en fonction de la taille de vos bases de données.

Prérequis

Avant de lancer l'opération de vidange manuelle, assurez-vous que :

  • Vous disposez d'un accès administrateur à l'instance d' NPSaaS
  • Vous avez téléchargé et configuré l'outil en ligne nz de commande version 11.3.1.3 ou ultérieure
  • Vous avez défini les variables d'environnement requises (APISERVER_URL, NZ_USER, NZ_PASSWORD) ou êtes prêt à les fournir en tant qu'options de commande
  • Vous avez programmé une fenêtre de maintenance, car le système sera indisponible pendant l'opération
  • Vous disposez d'un espace disque suffisant pour la sauvegarde du catalogue

Syntaxe

nz manualvacuum [options]

Options

Option Description
-apiserver <APISERVER> URL s du serveur API. Peut être défini à l'aide de la variable d'environnement APISERVER_URL. (obligatoire)
-u <USER> Nom d'utilisateur NPS. Peut être défini à l'aide de la variable d'environnement NZ_USER. (obligatoire)
-pw <PASSWORD> Mot de passe NPS. Peut être défini à l'aide de la variable d'environnement NZ_PASSWORD. (obligatoire)
-force Ignorer l'invite de confirmation et poursuivre immédiatement l'opération
-format <FORMAT> Format d'affichage des résultats de la commande
-host <HOST> URL s du serveur API. Peut être défini à l'aide de la variable d'environnement NZ_HOST

Exemples

Exécution d'un nettoyage manuel avec invite de confirmation

./nz manualvacuum -apiserver <apiserver-url> -u <nps-admin-user> -pw <nps-admin-user-password>

La commande affiche un avertissement et demande une confirmation :

  WARNING: Manual Vacuum Operation
=====================================
This operation will:
  1. Stop NPS (nzstop)
  2. Run nz_manual_vacuum
  3. Start NPS (nzstart)
This process may take significant time and will restart the system.
The system will be unavailable during this operation.
Do you want to continue? (yes/no):

Exécution d'un vidage manuel sans confirmation

Utilisez l'option -force pour ignorer l'invite de confirmation :

./nz manualvacuum -force -apiserver <apiserver-url> -u <nps-admin-user> -pw <nps-admin-user-password>

Utilisation des variables d'environnement

Définissez des variables d'environnement pour éviter d'indiquer des identifiants dans la commande :

export APISERVER_URL=<apiserver-url>
export NZ_USER=<nps-admin-user>
export NZ_PASSWORD=<nps-admin-user-password>
./nz manualvacuum -force

Processus opérationnel

Lorsque vous exécutez la commande nz manualvacuum, le workflow suivant est exécuté. En interne, la commande appelle le binaire système nz_manual_vacuum sur l'hôte NPS.

  1. Arrêt du système: le système NPS est arrêté à l'aide de la commande nzstop
  2. Sauvegarde du catalogue: une sauvegarde des données du catalogue est créée à /nz/manual_vacuum/nz_manual_vacuum.<timestamp>.tar.gz
  3. Nettoyage et réindexation: cette opération effectue un nettoyage et une réindexation sur :
    • La table système _T_OBJECT
    • Toutes les bases de données utilisateur et système, par ordre chronologique
  4. Démarrage du système: le système NPS est redémarré à l'aide de la commande nzstart
  5. Fin: l'opération s'achève et affiche un résumé des résultats

Sorties et journaux

Le fonctionnement manuel de l'aspirateur génère :

  • Fichier journal: /nz/manual_vacuum/nz_manual_vacuum.<timestamp>.log
  • Fichier de sauvegarde: /nz/manual_vacuum/nz_manual_vacuum.<timestamp>.tar.gz
  • Sortie de la console: informations détaillées sur l'avancement, notamment :
    • Identifiant de l'opération et horodatage
    • État d'exécution de la commande
    • Informations sur la synchronisation pour chaque base de données
    • Comparaison de taille (avant et après)
    • Etat d'achèvement

Exemple de sortie

Manual vacuum completed successfully
Output:
================================================================================
Manual Vacuum Workflow Started
Handle: nzrest.68n6kkr8.manual_vacuum
User: admin
Timestamp: 2026-06-09 14:08:12,790
================================================================================
# Database 1 of 19          SYSTEM
     TIMINGS (vacuum    ):  Elapsed Time:     0.21
     TIMINGS (reindex   ):  Elapsed Time:     0.39
...
###############################################################################
    Size Before      Size After  Pathname
=============== ===============  =========================================================
     3924887043      3915646467  /data/catalog/data.1.0
###############################################################################
   log file: /nz/manual_vacuum/nz_manual_vacuum.20260609_140932.log
backup file: /nz/manual_vacuum/nz_manual_vacuum.20260609_140932.tar.gz
================================================================================
Manual Vacuum Workflow Completed Successfully
All commands executed without errors
================================================================================

Meilleures pratiques

  • Planifiez les opérations de nettoyage manuel pendant les fenêtres de maintenance, lorsque le système peut être mis hors ligne
  • Vérifiez l'espace disque avant d'exécuter l'opération afin de vous assurer qu'il y a suffisamment d'espace pour la sauvegarde du catalogue
  • Vérifiez les fichiers journaux une fois l'opération terminée afin de vous assurer qu'elle s'est déroulée correctement
  • Tenez compte de la taille de vos bases de données lorsque vous planifiez la fenêtre de maintenance, car les bases de données plus volumineuses nécessitent davantage de temps
  • Conservez les fichiers de sauvegarde à des fins de restauration jusqu'à ce que vous ayez vérifié que l'opération s'est déroulée avec succès