mirror of
https://github.com/opentofu/opentofu.git
synced 2025-01-12 17:12:01 -06:00
4c0bda5386
Co-authored-by: Damian Stasik <920747+damianstasik@users.noreply.github.com> Co-authored-by: Roman Grinovski <roman.grinovski@gmail.com>
72 lines
2.9 KiB
Plaintext
72 lines
2.9 KiB
Plaintext
---
|
|
description: |-
|
|
The `tofu untaint` command tells OpenTofu that an object is functioning
|
|
correctly, even though its creation failed or it was previously manually
|
|
marked as degraded.
|
|
---
|
|
|
|
# Command: untaint
|
|
|
|
OpenTofu has a marker called "tainted" which it uses to track that an object
|
|
might be damaged and so a future OpenTofu plan ought to replace it.
|
|
|
|
OpenTofu automatically marks an object as "tainted" if an error occurs during
|
|
a multi-step "create" action, because OpenTofu can't be sure that the object
|
|
was left in a fully-functional state.
|
|
|
|
You can also manually mark an object as "tainted" using the deprecated command
|
|
[`tofu taint`](/docs/cli/commands/taint), although we no longer recommend that
|
|
workflow.
|
|
|
|
If OpenTofu currently considers a particular object as tainted but you've
|
|
determined that it's actually functioning correctly and need _not_ be replaced,
|
|
you can use `tofu untaint` to remove the taint marker from that object.
|
|
|
|
This command _will not_ modify any real remote objects, but will modify the
|
|
state in order to remove the tainted status.
|
|
|
|
If you remove the taint marker from an object but then later discover that it
|
|
was degraded after all, you can create and apply a plan to replace it without
|
|
first re-tainting the object, by using a command like the following:
|
|
|
|
```
|
|
tofu apply -replace="aws_instance.example[0]"
|
|
```
|
|
|
|
## Usage
|
|
|
|
Usage: `tofu untaint [options] address`
|
|
|
|
The `address` argument is a [resource address](/docs/cli/state/resource-addressing)
|
|
identifying a particular resource instance which is currently tainted.
|
|
|
|
This command also accepts the following options:
|
|
|
|
- `-allow-missing` - If specified, the command will succeed (exit code 0)
|
|
even if the resource is missing. The command might still return an error
|
|
for other situations, such as if there is a problem reading or writing
|
|
the state.
|
|
|
|
- `-lock=false` - Don't hold a state lock during the operation. This is
|
|
dangerous if others might concurrently run commands against the same
|
|
workspace.
|
|
|
|
- `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`,
|
|
instructs OpenTofu to retry acquiring a lock for a period of time before
|
|
returning an error. The duration syntax is a number followed by a time
|
|
unit letter, such as "3s" for three seconds.
|
|
|
|
- `-no-color` - Disables terminal formatting sequences in the output. Use this
|
|
if you are running OpenTofu in a context where its output will be
|
|
rendered by a system that cannot interpret terminal formatting.
|
|
|
|
For configurations using the [`cloud` backend](/docs/cli/cloud) or the [`remote` backend](/docs/language/settings/backends/remote)
|
|
only, `tofu untaint`
|
|
also accepts the option
|
|
[`-ignore-remote-version`](/docs/cli/cloud/command-line-arguments#ignore-remote-version).
|
|
|
|
For configurations using
|
|
[the `local` backend](/docs/language/settings/backends/local) only,
|
|
`tofu untaint` also accepts the legacy options
|
|
[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local#command-line-arguments).
|