terraform/website/docs/commands/state/show.html.md

92 lines
2.6 KiB
Markdown
Raw Normal View History

2016-03-25 18:26:30 +01:00
---
layout: "docs"
2016-03-25 18:26:30 +01:00
page_title: "Command: state show"
sidebar_current: "docs-commands-state-sub-show"
2016-03-25 18:26:30 +01:00
description: |-
The `terraform state show` command is used to show the attributes of a single resource in the Terraform state.
---
# Command: state show
The `terraform state show` command is used to show the attributes of a
single resource in the
[Terraform state](/docs/state/index.html).
## Usage
2016-03-25 22:33:31 +01:00
Usage: `terraform state show [options] ADDRESS`
2016-03-25 18:26:30 +01:00
The command will show the attributes of a single resource in the
2016-03-25 22:33:31 +01:00
state file that matches the given address.
2016-03-25 18:26:30 +01:00
This command requires an address that points to a single resource in the
2016-03-25 22:33:31 +01:00
state. Addresses are
2016-03-25 18:26:30 +01:00
in [resource addressing format](/docs/commands/state/addressing.html).
The command-line flags are all optional. The list of available flags are:
* `-state=path` - Path to the state file. Defaults to "terraform.tfstate".
Ignored when [remote state](/docs/state/remote.html) is used.
2016-03-25 18:26:30 +01:00
The output of `terraform state show` is intended for human consumption, not
programmatic consumption. To extract state data for use in other software, use
[`terraform show -json`](../show.html#json-output) and decode the result
using the documented structure.
2016-03-25 18:26:30 +01:00
## Example: Show a Resource
The example below shows a `packet_device` resource named `worker`:
2016-03-25 18:26:30 +01:00
```
$ terraform state show 'packet_device.worker'
# packet_device.worker:
resource "packet_device" "worker" {
billing_cycle = "hourly"
created = "2015-12-17T00:06:56Z"
facility = "ewr1"
hostname = "prod-xyz01"
id = "6015bg2b-b8c4-4925-aad2-f0671d5d3b13"
locked = false
}
2016-03-25 18:26:30 +01:00
```
## Example: Show a Module Resource
The example below shows a `packet_device` resource named `worker` inside a module named `foo`:
```shell
$ terraform state show 'module.foo.packet_device.worker'
```
## Example: Show a Resource configured with count
The example below shows the first instance of a `packet_device` resource named `worker` configured with
[`count`](/docs/configuration/meta-arguments/count.html):
```shell
$ terraform state show 'packet_device.worker[0]'
```
## Example: Show a Resource configured with for_each
The example below shows the `"example"` instance of a `packet_device` resource named `worker` configured with
[`for_each`](/docs/configuration/meta-arguments/for_each.html):
Linux, Mac OS, and UNIX:
```shell
$ terraform state show 'packet_device.worker["example"]'
```
PowerShell:
```shell
$ terraform state show 'packet_device.worker[\"example\"]'
```
Windows `cmd.exe`:
```shell
$ terraform state show packet_device.worker[\"example\"]
```