Команда: state rm

Основная функция состояния OpenTofu — отслеживать связи между адресами экземпляров ресурсов в вашей конфигурации и удалёнными объектами, которые они представляют. Обычно OpenTofu автоматически обновляет состояние в ответ на действия, выполняемые при применении плана, например удаляет связь с удалённым объектом, который был удалён.

Команду tofu state rm можно использовать в менее распространённой ситуации, когда нужно удалить связь с существующим удалённым объектом, не удаляя его предварительно. В результате OpenTofu «забудет» этот объект, хотя он продолжит существовать в удалённой системе.

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

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

OpenTofu выполнит поиск в состоянии всех экземпляров, соответствующих указанному адресу ресурса, и удалит запись для каждого из них, чтобы OpenTofu больше не отслеживал соответствующие удалённые объекты.

Это означает, что, хотя объекты продолжат существовать в удалённой системе, при последующем выполнении tofu plan будет предложено создать новый объект для каждого из «забытых» экземпляров. В зависимости от ограничений удалённой системы создание этих объектов может завершиться ошибкой, если их имена или другие идентификаторы конфликтуют с идентификаторами старых объектов, которые всё ещё существуют.

Эта команда также поддерживает следующие параметры:

• -dry-run — вывести список всех экземпляров ресурсов, соответствующих указанному адресу, не «забывая» при этом ни один из них.

• -lock=false — не блокировать состояние на время выполнения операции. Это опасно, если другие пользователи могут одновременно выполнять команды в той же рабочей области.

• -lock-timeout=DURATION — если блокировка не отключена с помощью -lock=false, указать OpenTofu повторять попытки получения блокировки в течение заданного времени, прежде чем вернуть ошибку. Длительность задаётся числом и буквой единицы времени, например «3s» означает три секунды.

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

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

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

Для конфигураций, использующих только бэкенд cloud или бэкенд remote, команда tofu state rm также поддерживает параметр -ignore-remote-version.

Для конфигураций, использующих только локальный бэкенд local, команда tofu state rm также поддерживает устаревшие параметры -state, -state-out и -backup.

Пример: удаление всех экземпляров ресурса​

В следующем примере OpenTofu «забудет» все экземпляры ресурса packet_device с именем «worker».

$ tofu state rm 'packet_device.worker'

У ресурса, в котором не используется count или for_each, есть только один экземпляр, поэтому этот синтаксис также подходит для выбора этого единственного экземпляра.

Пример: удаление всех экземпляров ресурса в модуле​

Чтобы выбрать ресурс, определённый во вложенном модуле, необходимо указать путь к этому модулю как часть адреса ресурса:

$ tofu state rm 'module.foo.packet_device.worker'

Пример: удаление всех экземпляров всех ресурсов в модуле​

В следующем примере OpenTofu «забудет» все экземпляры, связанные со всеми ресурсами, определёнными во всех экземплярах модуля с именем foo:

$ tofu state rm 'module.foo'

Пример: удаление определённого экземпляра ресурса с помощью count​

У ресурса, определённого с помощью метааргумента count, есть несколько экземпляров, каждый из которых идентифицируется целым числом. Чтобы выбрать определённый экземпляр, укажите в адресе его индекс:

$ tofu state rm 'packet_device.worker[0]'

Квадратные скобки ([, ]) имеют особое значение в некоторых оболочках, поэтому, чтобы передать адрес OpenTofu буквально, может потребоваться заключить его в кавычки или экранировать. Выше приведён типичный синтаксис заключения в кавычки для оболочек в стиле Unix.

Пример: удаление определённого экземпляра ресурса с помощью for_each​

У ресурса, определённого с помощью метааргумента for_each, есть несколько экземпляров, каждый из которых идентифицируется строкой. Чтобы выбрать определённый экземпляр, укажите в адресе его ключ.

Однако синтаксис строк включает кавычки, а символ кавычек часто имеет особое значение в командных оболочках, поэтому необходимо использовать подходящий синтаксис заключения в кавычки и/или экранирования для используемой оболочки. Например:

Оболочки в стиле Unix, например в Linux или macOS:

$ tofu state rm 'packet_device.worker["example"]'

Командная строка Windows (cmd.exe):

$ tofu state rm packet_device.worker[\"example\"]

PowerShell:

$ tofu state rm 'packet_device.worker[\"example\"]'