opentf/website/source/docs/commands/output.html.markdown

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
docs	Command: output	docs-commands-output	The `terraform output` command is used to extract the value of an output variable from the state file.

Command: output

The terraform output command is used to extract the value of an output variable from the state file.

Usage

Usage: terraform output [options] [NAME]

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.

The command-line flags are all optional. The list of available flags are:

• -json - If specified, the outputs are formatted as a JSON object, with 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.
• -state=path - Path to the state file. Defaults to "terraform.tfstate". Ignored when remote state is used.
• -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.

Examples

These examples assume the following Terraform output snippet.

output "lb_address" {
  value = "${aws_alb.web.public_dns}"
}

output "instance_ips" {
  value = ["${aws_instance.web.*.public_ip}"]
}

To list all outputs:

$ terraform output

To query for the DNS address of the load balancer:

$ terraform output lb_address
my-app-alb-1657023003.us-east-1.elb.amazonaws.com

To query for all instance IP addresses:

$ terraform output instance_ips
test = [
    54.43.114.12,
    52.122.13.4,
    52.4.116.53
]

To query for a particular value in a list, use -json and a JSON command-line parser such as jq. For example, to query for the first instance's IP address:

$ terraform output -json instance_ips | jq '.value[0]'