INTERFACE EN LIGNE DE COMMANDE GLPI

GLPI inclut un outil CLI pour vous aider à gérer votre instance GLPI. Cette interface est fournie par le script bin/console qui peut être exécuté depuis la racine de votre répertoire GLPI.

Chaque commande peut avoir zéro ou plusieurs arguments ou options. Les arguments sont des éléments d'information positionnels tandis que les options ne le sont pas et sont préfixées par un ou deux tirets

glpi:assets:cleansoftware

Alias : assets:cleansoftware

Description

Supprimer les versions de logiciels sans installation et les logiciels sans version

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
--max	-m	Maximum d'éléments à traiter en une exécution	Oui	500	Non	Non

glpi:assets:purgesoftware

Alias : assets:purgesoftware

Description

Purger les logiciels sans version qui sont supprimés.

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
-max	-m	Maximum d'éléments à traiter en une exécution	Oui	500	Non	Non

Dans l'interface Web GLPI

Action de purge des logiciels

glpi:build:compile_scss

Alias : build:compile_scss

Description

Compiler un fichier SCSS.

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
--file	-f	Fichier à compiler (compile tous les fichiers SCSS par défaut)	Non	[]	Oui	Oui
--dry-run		Simuler la compilation sans réellement enregistrer les fichiers CSS compilés	Non		Non	Non

glpi:cache:clear

Alias : cache:clear, glpi:system:clear_cache, system:clear_cache

Description

Vider le cache GLPI.

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
--context	-c	Contexte de cache à vider (par ex. 'core' ou 'plugin:nom_plugin'). Tous les contextes sont vidés par défaut.	Oui	[]	Oui	Non

glpi:cache:configure

Alias : cache:configure

Description

Définir la configuration du cache

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
--context		Contexte de cache (par ex. 'core' ou 'plugin:nom_plugin')	Oui	core	Non	Non
--dsn		DSN du système de cache	Oui	[]	Oui	Non
--use-default		Désactiver la configuration du cache pour utiliser le cache filesystem par défaut pour le contexte donné	Non		Non	Non
--skip-connection-checks		Ignorer les vérifications de connexion	Non		Non	Non

Aide

Systèmes de cache valides : <comment>Memcached</comment>, <comment>Redis (TCP)</comment>, <comment>Redis (TLS)</comment>.

Format DSN Memcached : memcached://[user:pass@][ipsocket[:port]][?weight=int] Format DSN Redis (TCP) : redis://%5Bpass@%5D%5Bip%7Chost%7Csocket[:port]][/db-index] Format DSN Redis (TLS) : rediss://%5Bpass@%5D%5Bip%7Chost%7Csocket[:port]][/db-index]

L'espace de noms du cache peut être utilisé pour assurer soit la séparation, soit le partage des données de plusieurs instances GLPI sur le même système de cache.

Utilisation

• glpi:cache:configure --use-default

• glpi:cache:configure --dsn=memcached://cache1.glpi-project.org --dsn=memcached://cache2.glpi-project.org

• glpi:cache:configure --dsn=redis://redis.glpi-project.org:6379/glpi

glpi:cache:debug

Alias : cache:debug

Description

Déboguer le cache GLPI.

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
--key	-k	Clé de cache à déboguer.	Oui	[]	Oui	Non
--context	-c	Contexte de cache à vider (par ex. 'core' ou 'plugin:nom_plugin').	Oui	core	Non	Non

glpi:cache:set_namespace_prefix

Alias : cache:set_namespace_prefix

Description

Définir le préfixe d'espace de noms du cache

Arguments/Options

Arguments (dans l'ordre) :

Nom	Description	Requis	Défaut
prefix	Préfixe d'espace de noms	Oui

Il n'y a pas d'options pour cette commande

glpi:config:set

Alias : config:set

Description

Définir la valeur de configuration

Arguments/Options

Arguments (dans l'ordre) :

Nom	Description	Requis	Défaut
key	Clé de configuration	Oui
value	Valeur de configuration (omettre l'argument pour saisir la valeur en mode interactif)	Oui

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
--context	-c	Contexte de configuration	Oui	core	Non	Non

glpi:database:check_schema_integrity

Alias : db:check_schema_integrity, glpi:database:check, db:check

Description

Vérifier les différences de schéma entre la base de données actuelle et le fichier d'installation.

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
--strict		Comparaison stricte des définitions	Non		Non	Non
--check-all-migrations		Vérifier les jetons relatifs à toutes les migrations de bases de données.	Non		Non	Non

| --check-innodb-migration | | Vérifier les jetons liés à la migration de "MyISAM" vers "InnoDB". | No | | No | No | | --check-timestamps-migration | | Vérifier les jetons liés à la migration de "datetime" vers "timestamp". | No | | No | No | | --check-utf8mb4-migration | | Vérifier les jetons liés à la migration de "utf8" vers "utf8mb4". | No | | No | No | | --check-dynamic-row-format-migration | | Vérifier les jetons liés à la migration du format de ligne "DYNAMIC". | No | | No | No | | --check-unsigned-keys-migration | | Vérifier les jetons liés à la migration d'entiers signés vers non signés dans les clés primaires/étrangères. | No | | No | No |

glpi:database:configure

Alias : db:configure

Description

Définir la configuration de la base de données

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Niable
--db-host	-H	Hôte de la base de données	No	localhost	No	Yes
--db-name	-d	Nom de la base de données	Yes		No	No
--db-password	-p	Mot de passe de la base de données (la valeur sera demandée si l'option est passée sans valeur)	No		No	Yes
--db-port	-P	Port de la base de données	No		No	Yes
--db-user	-u	Utilisateur de la base de données	Yes		No	No
--reconfigure	-r	Reconfigurer la base de données, écraser le fichier de configuration s'il existe déjà	No		No	No
--strict-configuration		Utiliser une configuration stricte pour appliquer les avertissements sur les usages obsolètes ou déconseillés	No		No	No

glpi:database:enable_timezones

Alias : db:enable_timezones

Description

Activer l'utilisation des fuseaux horaires.

glpi:database:install

Alias : db:install

Description

Installer le schéma de base de données

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Niable
--db-host	-H	Hôte de la base de données	No	localhost	No	Yes
--db-name	-d	Nom de la base de données	Yes		No	No
--db-password	-p	Mot de passe de la base de données (la valeur sera demandée si l'option est passée sans valeur)	No		No	Yes
--db-port	-P	Port de la base de données	No		No	Yes
--db-user	-u	Utilisateur de la base de données	Yes		No	No
--reconfigure	-r	Reconfigurer la base de données, écraser le fichier de configuration s'il existe déjà	No		No	No
--strict-configuration		Utiliser une configuration stricte pour appliquer les avertissements sur les usages obsolètes ou déconseillés	No		No	No
--default-language	-L	Langue par défaut de GLPI	No	en_GB	No	Yes
--force	-f	Forcer l'exécution de l'installation, en écrasant la base de données existante	No		No	No
--enable-telemetry		Autoriser l'envoi de statistiques d'utilisation au service de télémétrie (https://telemetry.glpi-project.org)	No		No	No
--no-telemetry		Interdire l'envoi de statistiques d'utilisation au service de télémétrie (https://telemetry.glpi-project.org)	No		No	No

glpi:database:update

Alias : db:update

Description

Mettre à jour le schéma de base de données vers une nouvelle version

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Niable
--allow-unstable	-u	Autoriser la mise à jour vers une version instable	No		No	No
--force	-f	Forcer l'exécution de la mise à jour depuis la version v-1 de GLPI même si le schéma n'a pas changé	No		No	No
--enable-telemetry		Autoriser l'envoi de statistiques d'utilisation au service de télémétrie (https://telemetry.glpi-project.org)	No		No	No
--no-telemetry		Interdire l'envoi de statistiques d'utilisation au service de télémétrie (https://telemetry.glpi-project.org)	No		No	No

glpi:ldap:synchronize_users

Alias : ldap:sync

Description

Synchroniser les utilisateurs avec les informations du serveur LDAP

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Niable
--only-create-new	-c	Créer uniquement les nouveaux utilisateurs	No		No	No
--only-update-existing	-u	Mettre à jour uniquement les utilisateurs existants	No		No	No
--ldap-server-id	-s	Synchroniser uniquement les utilisateurs rattachés à ce serveur LDAP	No	[]	Yes	Yes
--ldap-filter	-f	Filtre à appliquer sur la recherche LDAP	No		No	Yes
--begin-date		Date de début à appliquer dans le filtre "modifyTimestamp" (voir http://php.net/manual/en/datetime.formats.php pour les formats supportés)	No		No	Yes
--end-date		Date de fin à appliquer dans le filtre "modifyTimestamp" (voir http://php.net/manual/en/datetime.formats.php pour les formats supportés)	Non		Non	Oui
--deleted-user-strategy	-d	Forcer la stratégie utilisée pour les utilisateurs supprimés (action actuellement configurée : "1") Les valeurs possibles sont : 0: Préserver 1: Mettre dans la corbeille 2: Retirer les autorisations dynamiques et les groupes 3: Désactiver 4: Désactiver + Retirer les autorisations dynamiques et les groupes	Non		Non	Oui
--restored-user-strategy	-r	Forcer la stratégie utilisée pour les utilisateurs restaurés (action actuellement configurée : "0") Les valeurs possibles sont : 0: Ne rien faire 1: Restaurer (sortir de la corbeille) 3: Activer	Non		Non	Oui

glpi:maintenance:disable

Alias : maintenance:disable

Description

Désactiver le mode maintenance

glpi:maintenance:enable

Alias : maintenance:enable

Description

Activer le mode maintenance

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négation
--text	-t	Texte à afficher pendant la maintenance	Non		Non	Oui

glpi:marketplace:download

Alias : marketplace:download

Description

Télécharger un plugin depuis le marketplace GLPI

Arguments/Options

Arguments (dans l'ordre) :

Nom	Description	Requis	Défaut
plugins	La clé du plugin	Oui	[]

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négation
--force	-f	Forcer le téléchargement même si le plugin est déjà téléchargé	Non		Non	Non

glpi:marketplace:info

Alias : marketplace:info

Description

Obtenir des informations sur un plugin

Arguments/Options

Arguments (dans l'ordre) :

Nom	Description	Requis	Défaut
plugin	La clé du plugin	Oui

Il n'y a pas d'options pour cette commande

glpi:marketplace:search

Alias : marketplace:search

Description

Rechercher dans le marketplace GLPI

Arguments/Options

Arguments (dans l'ordre) :

Nom	Description	Requis	Défaut
term	Le terme de recherche	Non

Il n'y a pas d'options pour cette commande

glpi:migration:appliances_plugin_to_core

Alias : None

Description

Migrer les données du plugin Appliances vers les tables du cœur de GLPI

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négation
--skip-errors	-s	Ne pas quitter en cas d'erreurs d'import	Non		Non	Non

glpi:migration:build_missing_timestamps

Alias : None

Description

Définir les valeurs manquantes de date_creation et date_mod en utilisant les entrées de journal.

glpi:migration:databases_plugin_to_core

Alias : None

Description

Migrer les données du plugin Databases vers les tables du cœur de GLPI

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négation
--skip-errors	-s	Ne pas quitter en cas d'erreurs d'import	Non		Non	Non

glpi:migration:domains_plugin_to_core

Alias : None

Description

Migrer les données du plugin Domains vers les tables du cœur de GLPI

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négation
--skip-errors	-s	Ne pas quitter en cas d'erreurs d'import	Non		Non	Non

glpi:migration:dynamic_row_format

Alias : None

Description

Convertir les tables de base de données au format de ligne "Dynamic" (requis pour le support du jeu de caractères "utf8mb4").

glpi:migration:myisam_to_innodb

Alias : None

Description

Migrer les tables MyISAM vers InnoDB

glpi:migration:racks_plugin_to_core

Alias : None

Description

Migrer les données du plugin Racks vers les tables du cœur de GLPI

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négation
--ignore-other-elements	-i	Ignorer les modèles et éléments "PluginRacksOther"	Non		Non	Non
--skip-errors	-s	Ne pas quitter en cas d'erreurs d'import	Non		Non	Non
--truncate	-t	Supprimer les données existantes du cœur	Non		Non	Non
--update-plugin	-u	Exécuter la mise à jour du plugin Racks (vous devez disposer des fichiers de la version 1.8.0 pour effectuer cette opération)	Non		Non	Non
--without-plugin	-w	Activer la migration sans les fichiers du plugin (nous ne pouvons pas valider que les données du plugin sont compatibles avec la version 1.8.0 supportée)	Non		Non	Non

glpi:migration:timestamps

Alias : None

Description

Convertir les champs "datetime" en "timestamp" pour utiliser les fuseaux horaires.

glpi:migration:unsigned_keys

Alias : None

Description

Migrer les clés primaires/étrangères vers des entiers non signés

glpi:migration:utf8mb4

Alias : None

Description

Convertir le jeu de caractères de la base de données de "utf8" vers "utf8mb4".

glpi:plugin:activate

Alias : plugin:activate

Description

Activer un ou plusieurs plugin(s)

Arguments/Options

Arguments (dans l'ordre) :

Nom	Description	Requis	Défaut
directory	Répertoire du plugin	Non	[]

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négation
--all	-a	Exécuter la commande sur tous les plugins	Non		Non	Non

glpi:plugin:deactivate

Alias : plugin:deactivate

Description

Désactiver un ou plusieurs plugin(s)

Arguments/Options

Arguments (dans l'ordre) :

Nom	Description	Requis	Défaut
directory	Répertoire du plugin	Non	[]

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négable
--all	-a	Exécuter la commande sur tous les plugins	Non		Non	Non

glpi:plugin:install

Alias : plugin:install

Description

Exécuter le(s) script(s) d'installation de plugin

Arguments/Options

Arguments (dans l'ordre) :

Nom	Description	Requis	Défaut
directory	Répertoire du plugin	Non	[]

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négable
--all	-a	Exécuter la commande sur tous les plugins	Non		Non	Non
--param	-p	Paramètres additionnels à transmettre à la fonction hook d'installation du plugin "-p foo" définira la valeur du paramètre "foo" à true "-p foo=bar" définira la valeur du paramètre "foo" à "bar"	Non	[]	Oui	Oui
--username	-u	Nom de l'utilisateur employé durant le script d'installation (entre autres pour définir les droits administrateur du plugin)	Oui		Non	Non
--force	-f	Forcer l'exécution de l'installation, même si le plugin est déjà installé	Non		Non	Non

Utilisation

• glpi:plugin:install -p foo=bar -p force myplugin

glpi:rules:process_software_category_rules

Alias : rules:process_software_category_rules

Description

Traiter les règles de catégorie de logiciel

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négable
--all	-a	Traiter la règle pour tous les logiciels, même ceux ayant déjà une catégorie définie	Non		Non	Non

glpi:rules:replay_dictionnary_rules

Alias : rules:replay_dictionnary_rules

Description

Rejouer les règles de dictionnaire sur les éléments existants

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négable
--dictionnary	-d	Dictionnaire à utiliser. Les valeurs possibles sont : CableType, ComputerModel, ComputerType, DatabaseInstanceType, GlpiSocketModel, ImageFormat, ImageResolution, Manufacturer, MonitorModel, MonitorType, NetworkEquipmentModel, NetworkEquipmentType, OperatingSystem, OperatingSystemArchitecture, OperatingSystemEdition, OperatingSystemKernel, OperatingSystemKernelVersion, OperatingSystemServicePack, OperatingSystemVersion, PeripheralModel, PeripheralType, PhoneModel, PhoneType, Printer, PrinterModel, PrinterType, Software	Oui		Non	Non
--manufacturer-id	-m	Si l'option est définie, seuls les éléments ayant l'ID de fabricant donné seront traités. Actuellement disponible uniquement pour le dictionnaire Software.	Oui		Non	Non

glpi:security:change_key

Alias : None

Description

Modifier la clé de stockage des mots de passe et mettre à jour les valeurs dans la base de données.

glpi:system:check_requirements

Alias : system:check_requirements

Description

Vérifier les prérequis système

glpi:system:list_services

Alias : system:list_services

Description

Lister les services système

glpi:system:status

Alias : system:status

Description

Vérifier l'état du système

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négable
--format	-f	Format de sortie [plain ou json]	Non	plain	Non	Oui
--private	-p	Publicité des informations d'état. Les informations d'état privées peuvent contenir des informations potentiellement sensibles telles que les informations de version.	Non		Non	Non
--service	-s	Le service à vérifier ou all	Non	all	Non	Oui

glpi:task:unlock

Alias : task:unlock

Description

Déverrouiller les tâches automatiques

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négable
--all	-a	Déverrouiller toutes les tâches	Non		Non	Non
--cycle	-c	Temps d'exécution (en cycles) à partir duquel la tâche est considérée comme bloquée (délai = fréquence tâche * cycle)	Non		Non	Oui
--delay	-d	Temps d'exécution (en secondes) à partir duquel la tâche est considérée comme bloquée (par défaut : 1800)	Non		Non	Oui
--task	-t	Itemtype::nom de la tâche à déverrouiller (ex : "MailCollector::mailgate")	Non	[]	Oui	Oui

glpi🛠️check_database_keys

Alias : tools:check_database_keys

Description

Vérifier la base de données pour les clés manquantes et erronées.

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
--detect-misnamed-keys		Détecter les clés mal nommées	Non		Non	Non
--detect-useless-keys		Détecter les clés mal nommées	Non		Non	Non

glpi🛠️check_database_schema_consistency

Alias : tools:check_database_schema_consistency

Description

Vérifier la cohérence du schéma de la base de données.

glpi🛠️delete_orphan_logs

Alias : tools:delete_orphan_logs

Description

Supprimer les journaux orphelins

Arguments/Options

Il n'y a pas d'arguments pour cette commande

Options :

Nom	Raccourci	Description	Requis	Défaut	Tableau	Négatable
--dry-run		Simuler la commande sans réellement supprimer quoi que ce soit	Non		Non	Non