mirror of
https://github.com/opentofu/opentofu.git
synced 2025-02-25 18:45:20 -06:00
a4fb0f3fa3
Signed-off-by: SaiCharanReddy Adla <saicharanreddy.adla@fmr.com> Signed-off-by: SaiCharanReddyAdla <163337878+SaiCharanReddyAdla@users.noreply.github.com>
65 lines
2.6 KiB
Plaintext
65 lines
2.6 KiB
Plaintext
---
|
|
description: The `tofu state push` command pushes items to the OpenTofu state.
|
|
---
|
|
|
|
# Command: state push
|
|
|
|
The `tofu state push` command is used to manually upload a local
|
|
state file to [remote state](../../../language/state/remote.mdx). This command also
|
|
works with local state.
|
|
|
|
This command should rarely be used. It is meant only as a utility in case
|
|
manual intervention is necessary with the remote state.
|
|
|
|
## Usage
|
|
|
|
Usage: `tofu state push [options] PATH`
|
|
|
|
This command pushes the state specified by PATH to the currently
|
|
configured [backend](../../../language/settings/backends/configuration.mdx).
|
|
|
|
If PATH is "-" then the state data to push is read from stdin. This data
|
|
is loaded completely into memory and verified prior to being written to
|
|
the destination state.
|
|
|
|
:::note
|
|
OpenTofu state files must be in UTF-8 format without a byte order mark (BOM). For PowerShell on Windows, use `Set-Content` to automatically encode files in UTF-8 format. For example, run `tofu state push | sc terraform.tfstate`.
|
|
:::
|
|
|
|
OpenTofu will perform a number of safety checks to prevent you from
|
|
making changes that appear to be unsafe:
|
|
|
|
- **Differing lineage**: If the "lineage" value in the state differs,
|
|
OpenTofu will not allow you to push the state. A differing lineage
|
|
suggests that the states are completely different and you may lose
|
|
data.
|
|
|
|
- **Higher remote serial**: If the "serial" value in the destination state
|
|
is higher than the state being pushed, OpenTofu will prevent the push.
|
|
A higher serial suggests that data is in the destination state that isn't
|
|
accounted for in the local state being pushed.
|
|
|
|
Both of these safety checks can be disabled with the `-force` flag.
|
|
**This is not recommended.** If you disable the safety checks and are
|
|
pushing state, the destination state will be overwritten.
|
|
|
|
For configurations using the [`cloud` backend](../../../cli/cloud/index.mdx) or the [`remote` backend](../../../language/settings/backends/remote.mdx)
|
|
only, `tofu state push`
|
|
also accepts the option
|
|
|
|
[`-ignore-remote-version`](/docs/cli/cloud/command-line-arguments#ignore-remote-version).
|
|
|
|
This command also accepts the following options for tofu state push:
|
|
|
|
- `-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.
|
|
|
|
[`-ignore-remote-version`](../../../cli/cloud/command-line-arguments.mdx#ignore-remote-version).
|
|
|