2014-07-25 00:44:10 +02:00
|
|
|
---
|
|
|
|
layout: "docs"
|
|
|
|
page_title: "Command: output"
|
|
|
|
sidebar_current: "docs-commands-output"
|
2014-10-22 05:21:56 +02:00
|
|
|
description: |-
|
|
|
|
The `terraform output` command is used to extract the value of an output variable from the state file.
|
2014-07-25 00:44:10 +02:00
|
|
|
---
|
|
|
|
|
|
|
|
# Command: output
|
|
|
|
|
|
|
|
The `terraform output` command is used to extract the value of
|
|
|
|
an output variable from the state file.
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
2016-07-12 00:37:51 +02:00
|
|
|
Usage: `terraform output [options] [NAME]`
|
2014-07-25 00:44:10 +02:00
|
|
|
|
2016-07-12 00:37:51 +02:00
|
|
|
With no additional arguments, `output` will display all the outputs for the root module.
|
|
|
|
If an output `NAME` is specified, only the value of that output is printed.
|
2014-07-25 00:44:10 +02:00
|
|
|
|
|
|
|
The command-line flags are all optional. The list of available flags are:
|
|
|
|
|
2016-07-13 18:38:19 +02:00
|
|
|
* `-json` - If specified, the outputs are formatted as a JSON object, with
|
2016-07-12 00:37:51 +02:00
|
|
|
a key per output. If `NAME` is specified, only the output specified will be
|
|
|
|
returned. This can be piped into tools such as `jq` for further processing.
|
2014-07-25 00:44:10 +02:00
|
|
|
* `-state=path` - Path to the state file. Defaults to "terraform.tfstate".
|
2015-05-27 17:11:31 +02:00
|
|
|
* `-module=module_name` - The module path which has needed output.
|
|
|
|
By default this is the root path. Other modules can be specified by
|
|
|
|
a period-separated list. Example: "foo" would reference the module
|
|
|
|
"foo" but "foo.bar" would reference the "bar" module in the "foo"
|
|
|
|
module.
|