terraform state list — lister les ressources

terraform state list affiche la liste de toutes les ressources que Terraform gère dans le state. C’est la commande de départ pour savoir ce qui existe avant de modifier, déplacer ou supprimer une ressource. Ce guide montre comment l’utiliser, filtrer les résultats et comprendre les adresses affichées.

Analogie

terraform state list est l’équivalent de la commande ls pour votre infrastructure : elle affiche le contenu du state comme ls affiche le contenu d’un répertoire. Sans elle, vous travaillez à l’aveugle.

Prérequis : avoir compris le rôle du state Terraform et disposer d’un projet avec des ressources déployées.

Ce que vous allez apprendre

• Lire la sortie de terraform state list (format des adresses)
• Filtrer les ressources par adresse exacte
• Rechercher par type avec grep
• Trouver une ressource par son identifiant avec -id
• Compter les ressources gérées

Syntaxe de base

terraform state list [options] [adresse...]

Sans argument, la commande affiche toutes les ressources du state. Avec une adresse, elle affiche uniquement cette ressource (ou une erreur si elle n’existe pas).

Lister toutes les ressources

Pour ce guide, le projet contient un réseau, deux volumes et une data source :

resource "libvirt_network" "net" {
  name = "state-list-net"
  # ...
}

resource "libvirt_volume" "web" {
  name = "web-server.qcow2"
  # ...
}

resource "libvirt_volume" "db" {
  name = "db-server.qcow2"
  # ...
}

data "libvirt_node_info" "host" {}

Après terraform apply, la commande state list affiche :

terraform state list

data.libvirt_node_info.host
libvirt_network.net
libvirt_volume.db
libvirt_volume.web

Quatre entrées : la data source et les trois ressources managées. La liste est triée alphabétiquement par type, puis par nom.

Comprendre les adresses

Chaque ligne suit le format type.nom pour les ressources managées et data.type.nom pour les data sources :

Adresse	Type	Nom logique	Signification
libvirt_network.net	libvirt_network	net	Réseau géré par Terraform
libvirt_volume.web	libvirt_volume	web	Volume disque « web »
libvirt_volume.db	libvirt_volume	db	Volume disque « db »
data.libvirt_node_info.host	libvirt_node_info	host	Data source (lecture seule)

Glissez pour voir

Ces adresses sont celles que vous utilisez dans toutes les commandes terraform state : show, mv, rm.

Adresses avec count ou for_each

Si une ressource utilise count, son adresse contient un index : libvirt_volume.disk[0], libvirt_volume.disk[1]. Avec for_each, c’est une clé : libvirt_volume.disk["web"], libvirt_volume.disk["db"].

Filtrer par adresse exacte

Passez une adresse complète pour vérifier qu’une ressource existe dans le state :

terraform state list libvirt_volume.web

libvirt_volume.web

Si la ressource n’existe pas, Terraform renvoie une erreur explicite :

terraform state list libvirt_volume.inexistant

╷
│ Error: Unknown resource
│
│ The current state contains no resource libvirt_volume.inexistant. If you've
│ just added this resource to the configuration, you must run "terraform apply"
│ first to create the resource's entry in the state.
╵

Utile avant state rm ou state mv

Vérifiez toujours l’existence d’une ressource avec state list avant de la déplacer (state mv) ou de la retirer (state rm). Un mauvais nom est la cause d’erreur la plus fréquente.

Rechercher par type avec grep

Pour trouver toutes les ressources d’un type donné, combinez state list avec grep :

terraform state list | grep volume

libvirt_volume.db
libvirt_volume.web

terraform state list | grep data

data.libvirt_node_info.host

C’est la méthode recommandée pour filtrer par type — l’argument d’adresse attend un nom complet type.nom, pas un pattern partiel.

Trouver une ressource par identifiant

L’option -id filtre les ressources par leur identifiant dans le state (la valeur du champ id de chaque ressource) :

terraform state list -id=/var/lib/libvirt/images/web-server.qcow2

libvirt_volume.web

Cette option est utile quand vous connaissez l’identifiant réel d’une ressource (un chemin, un UUID, un ARN) mais pas son adresse Terraform.

Compter les ressources

Pour savoir combien de ressources Terraform gère :

terraform state list | wc -l

4

Ce comptage inclut les data sources. Pour ne compter que les ressources managées :

terraform state list | grep -v ^data | wc -l

3

Cas d’usage courants

Besoin	Commande
Tout lister	terraform state list
Vérifier qu’une ressource existe	terraform state list type.nom
Lister les volumes	terraform state list | grep volume
Lister les data sources	terraform state list | grep ^data
Trouver par ID	terraform state list -id=identifiant
Compter les ressources	terraform state list | wc -l

Glissez pour voir

Dépannage

Symptôme	Cause probable	Solution
No state file was found!	Aucun apply effectué ou state supprimé	Vérifier le dossier, lancer terraform apply
Unknown resource	Faute de frappe dans l’adresse	Vérifier avec terraform state list sans filtre
Invalid address	Adresse partielle (ex : libvirt_volume sans .nom)	Utiliser grep pour filtrer par type
Liste vide après destroy	Toutes les ressources ont été supprimées	Comportement normal

Glissez pour voir

À retenir

• terraform state list affiche toutes les ressources du state — c’est votre inventaire d’infrastructure
• Chaque ressource a une adresse au format type.nom (ou data.type.nom pour les data sources)
• Utilisez grep pour filtrer par type et -id pour trouver une ressource par son identifiant réel
• Vérifiez toujours l’adresse avec state list avant d’utiliser state show, state mv ou state rm
• Avec count, les adresses ont un index ([0], [1]). Avec for_each, une clé (["web"])

Prochaines étapes

terraform state show Afficher tous les attributs d'une ressource du state.

terraform state mv Déplacer ou renommer une ressource dans le state sans la recréer.

terraform state rm Retirer une ressource du state sans la détruire.

×

📖 Voir la documentation →