Skip to main content

Command: state list

The tofu state list command is used to list resources within a OpenTofu state.

Usage​

Usage: tofu state list [options] [address...]

The command will list all resources in the state file matching the given addresses (if any). If no addresses are given, all resources are listed.

The resources listed are sorted according to module depth order followed by alphabetical. This means that resources that are in your immediate configuration are listed first, and resources that are more deeply nested within modules are listed last.

For complex infrastructures, the state can contain thousands of resources. To filter these, provide one or more patterns to the command. Patterns are in resource addressing format.

The command-line flags are all optional. The following flags are available:

  • -state=path - Path to the state file. Defaults to "terraform.tfstate". Ignored when remote state is used.

  • -id=id - ID of resources to show. Ignored when unset.

  • -var 'NAME=VALUE' - Sets a value for a single input variable declared in the root module of the configuration. Use this option multiple times to set more than one variable. Refer to Input Variables on the Command Line for more information.

  • -var-file=FILENAME - Sets values for potentially many input variables declared in the root module of the configuration, using definitions from a "tfvars" file. Use this option multiple times to include values from more than one file.

There are several other ways to set values for input variables in the root module, aside from the -var and -var-file options. Refer to Assigning Values to Root Module Variables for more information.

Example: All Resources​

This example will list all resources, including modules:

Code Block
$ tofu state list
aws_instance.foo
aws_instance.bar[0]
aws_instance.bar[1]
module.elb.aws_elb.main

Example: Filtering by Resource​

This example will only list resources for the given name:

Code Block
$ tofu state list aws_instance.bar
aws_instance.bar[0]
aws_instance.bar[1]

Example: Filtering by Module​

This example will list resources in the given module and any submodules:

Code Block
$ tofu state list module.elb
module.elb.aws_elb.main
module.elb.module.secgroups.aws_security_group.sg

Example: Filtering by ID​

This example will only list the resource whose ID is specified on the command line. This is useful to find where in your configuration a specific resource is located.

Code Block
$ tofu state list -id=sg-1234abcd
module.elb.aws_security_group.sg