How to read tfstate from TFE

[Ramnikov]

After the Infrastructure is created in TFE I need to read the VM IP address saved in tfstate file.
I can see on TFE GUI in the TAB States all the data but how can I get it using tf-helper or curl?

Thanks in advance
Andrew

[fprimex]

Hi. Currently tfh does not have a state / state-version command, however I am working on a complete overhaul that will include nearly everything (everything I can manage, anyway). I wouldn't wait around for that, though.

If you only need an output from the state you could use the state-version-output API. This allows you to retrieve exactly one output from a state. The whole state does not have to be read. To do this, though, you need to know the ID of the output. First do a "show" on the workspace, which includes the output IDs:

https://www.terraform.io/docs/cloud/api/workspaces.html#show-workspace

In the example from that page:

    "included": [{
      "id": "wsout-tZ2bJSSeECSBkCiS",
      "type": "workspace-outputs",
      "attributes": {
        "name": "random",
        "sensitive": false,
        "output-type": "string",
        "workspace-attributes": {
          "id": "ws-sKRZA6LNRdViecHa",
          "name": "terraform-testing"
        },

This is under included because outputs are one of the options for the request to include in the response. You'll want to include outputs with ?include=outputs.

https://www.terraform.io/docs/cloud/api/workspaces.html#outputs

https://www.terraform.io/docs/cloud/api/index.html#inclusion-of-related-resources

Use something like the following to extract the workspace output of interest, replacing random with your output name and ws_show_example.json with your output from the workspace show:

jq -r --arg out_name "random" '
  .data.included[]
  | select(.type == "workspace-outputs" and .attributes.name == $out_name)
  | .id
' ws_show_example.json 

Note that the example on the documentation page is actually invalid JSON. The comma at the end of this bit should be removed:

      "outputs": {
        "data": [{
          "id": "wsout-tZ2bJSSeECSBkCiS",
          "type": "workspace-outputs"
        }]
      },

Use that ID with the show-state-version-output endpoint as described here:

https://www.terraform.io/docs/cloud/api/state-version-outputs.html#show-a-state-version-output

Alternatively, if you want to fetch the whole state, then first show the latest state for the workspace:

https://www.terraform.io/docs/cloud/api/state-versions.html#fetch-the-current-state-version-for-a-workspace

Then download the state file using hosted-state-download-url as noted in the documentation.

Let me know if you have any questions about the above.

[Ramnikov]

Many thanks for your reply...

I solved the issue in the following way... not the best, but it is working

  echo "*****************************"
  echo "Get TFE State Information"
  echo "*****************************"
  export WS_ID=$(tfh workspace get | awk 'FNR==2{print $3}')
  echo ${WS_ID}
  export TFE_URL=$(curl -H "Authorization":"Bearer ${TERRAFORM_TOKEN}" -H "Content-Type":"application/vnd.api+json" https://xxxxx/api/v2/workspaces/"${WS_ID}"/current-state-version | jq '.data.attributes["hosted-state-download-url"]' | tr -d '"')
  echo ${TFE_URL}
  export VM_IP=$(curl ${TFE_URL} | jq '.outputs.private_ip_address.value' | awk ' {print $3}' | tr -d '"')
  echo ${VM_IP}