github.com/atsaki/terraform@v0.4.3-0.20150919165407-25bba5967654/website/source/docs/commands/plan.html.markdown (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Command: plan"
     4  sidebar_current: "docs-commands-plan"
     5  description: |-
     6    The `terraform plan` command is used to create an execution plan. Terraform performs a refresh, unless explicitly disabled, and then determines what actions are necessary to achieve the desired state specified in the configuration files. The plan can be saved using `-out`, and then provided to `terraform apply` to ensure only the pre-planned actions are executed.
     7  ---
     8  
     9  # Command: plan
    10  
    11  The `terraform plan` command is used to create an execution plan. Terraform
    12  performs a refresh, unless explicitly disabled, and then determines what
    13  actions are necessary to achieve the desired state specified in the
    14  configuration files. The plan can be saved using `-out`, and then provided
    15  to `terraform apply` to ensure only the pre-planned actions are executed.
    16  
    17  ## Usage
    18  
    19  Usage: `terraform plan [options] [dir]`
    20  
    21  By default, `plan` requires no flags and looks in the current directory
    22  for the configuration and state file to refresh.
    23  
    24  The command-line flags are all optional. The list of available flags are:
    25  
    26  * `-backup=path` - Path to the backup file. Defaults to `-state-out` with
    27    the ".backup" extension. Disabled by setting to "-".
    28  
    29  * `-destroy` - If set, generates a plan to destroy all the known resources.
    30  
    31  * `-detailed-exitcode` - Return a detailed exit code when the command exits.
    32    When provided, this argument changes the exit codes and their meanings to
    33    provide more granular information about what the resulting plan contains:
    34    * 0 = Succeeded with empty diff (no changes)
    35    * 1 = Error
    36    * 2 = Succeeded with non-empty diff (changes present)
    37  
    38  * `-input=true` - Ask for input for variables if not directly set.
    39  
    40  * `-module-depth=n` - Specifies the depth of modules to show in the output.
    41    This does not affect the plan itself, only the output shown. By default,
    42    this is zero. -1 will expand all.
    43  
    44  * `-no-color` - Disables output with coloring.
    45  
    46  * `-out=path` - The path to save the generated execution plan. This plan
    47    can then be used with `terraform apply` to be certain that only the
    48    changes shown in this plan are applied. Read the warning on saved
    49    plans below.
    50  
    51  * `-refresh=true` - Update the state prior to checking for differences.
    52  
    53  * `-state=path` - Path to the state file. Defaults to "terraform.tfstate".
    54  
    55  * `-target=resource` - A [Resource
    56    Address](/docs/internals/resource-addressing.html) to target. Operation will
    57    be limited to this resource and its dependencies. This flag can be used
    58    multiple times.
    59  
    60  * `-var 'foo=bar'` - Set a variable in the Terraform configuration. This
    61    flag can be set multiple times.
    62  
    63  * `-var-file=foo` - Set variables in the Terraform configuration from
    64     a file. If "terraform.tfvars" is present, it will be automatically
    65     loaded if this flag is not specified.
    66  
    67  ## Security Warning
    68  
    69  Saved plan files (with the `-out` flag) encode the configuration,
    70  state, diff, and _variables_. Variables are often used to store secrets.
    71  Therefore, the plan file can potentially store secrets.
    72  
    73  Terraform itself does not encrypt the plan file. It is highly
    74  recommended to encrypt the plan file if you intend to transfer it
    75  or keep it at rest for an extended period of time.
    76  
    77  Future versions of Terraform will make plan files more
    78  secure.