Команда: state list

Команда tofu state list используется для вывода списка ресурсов в состоянии OpenTofu.

Использование​

Использование: tofu state list [options] [address...]

Команда выведет список всех ресурсов в файле состояния, соответствующих указанным адресам (если они заданы). Если адреса не заданы, выводятся все ресурсы.

Ресурсы в списке сортируются по глубине модулей, а затем по алфавиту. Это означает, что сначала выводятся ресурсы из вашей непосредственной конфигурации, а в конце — ресурсы, глубже вложенные в модули.

В сложной инфраструктуре состояние может содержать тысячи ресурсов. Чтобы отфильтровать их, передайте команде один или несколько шаблонов. Шаблоны должны быть в формате адресации ресурсов.

Все флаги командной строки необязательны. Доступны следующие флаги:

• -state=path — путь к файлу состояния. По умолчанию используется "terraform.tfstate". Игнорируется при использовании удаленного состояния.

• -id=id — идентификатор ресурсов для вывода. Игнорируется, если не задан.

• -var 'NAME=VALUE' — задает значение для одной входной переменной, объявленной в корневом модуле конфигурации. Используйте этот параметр несколько раз, чтобы задать несколько переменных. Дополнительные сведения см. в разделе Входные переменные в командной строке.

• -var-file=FILENAME — задает значения для нескольких входных переменных, объявленных в корневом модуле конфигурации, используя определения из файла "tfvars". Используйте этот параметр несколько раз, чтобы включить значения из нескольких файлов.

• -json — включает вывод машиночитаемого интерфейса JSON.

• -json-into=out.json — формирует тот же вывод, что и -json, но перенаправляет его в файл. Это позволяет одновременно сохранять машиночитаемые и удобочитаемые для человека журналы.

Помимо параметров -var и -var-file есть несколько других способов задать значения входных переменных в корневом модуле. Дополнительные сведения см. в разделе Задание значений переменных корневого модуля.

Пример: все ресурсы​

В этом примере выводится список всех ресурсов, включая модули:

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

Пример: фильтрация по ресурсу​

В этом примере выводятся только ресурсы с указанным именем:

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

Пример: фильтрация по модулю​

В этом примере выводятся ресурсы указанного модуля и всех его подмодулей:

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

Пример: фильтрация по идентификатору​

В этом примере выводится только ресурс с идентификатором, указанным в командной строке. Это полезно, чтобы найти, где в конфигурации находится определенный ресурс.

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