Unable to extract the install preview output

[liftconfig]

Is there a way to extract the install preview using the provider? I've tried using the security console resources below - although the install preview task is successful in FortiManager, I can't see a way to get the results as an output.

resource "fortimanager_securityconsole_install_package" "install" {
  fmgadom = "testadom"
  pkg     = "aws"
  flags   = ["preview"]
  force_recreate = uuid()

  scope {
    name = "testfg1"
    vdom = "root"
  }
}

resource "fortimanager_securityconsole_install_preview" "preview" {
  fmgadom        = "testadom"
  flags          = ["none"]
  force_recreate = uuid()

  scope {
    name = "testfg1"
    vdom = "root"
  }
}

Reviewing https://community.fortinet.com/t5/FortiManager/Technical-Tip-How-to-install-preview-and-review-the-output-of/ta-p/301325 it seems there isn't a securityconsole resource for the final step calling /securityconsole/preview/result

I've tried using a generic api resource to for this API call but it's failing:

resource "time_sleep" "wait_30s" {
  create_duration = "30s"
  triggers = {
    preview_id = fortimanager_securityconsole_install_preview.preview.id
  }
}

resource "fortimanager_json_generic_api" "result" {
  json_content = <<JSON
{
    "id": 1,
    "method": "exec",
    "params": [
        {
            "data": {
               "adom": "testadom",
               "device": "testfg1"
            },
            "url": "/securityconsole/preview/result"
        }
    ],
    "verbose": 1
}
JSON
  depends_on   = [fortimanager_securityconsole_install_preview.preview, time_sleep.wait_30s]
}

Apply result:

fortimanager_json_generic_api.result: Creating...
╷
│ Error: Error createGeneric:
│ err -1: runtime error 0: invalid value
│
│   with fortimanager_json_generic_api.result,
│   on main.tf line 106, in resource "fortimanager_json_generic_api" "result":
│  106: resource "fortimanager_json_generic_api" "result" {
│
╵

Is there a different way I should be doing this? The provider documentation is unclear.

[MaxxLiu22]

Hi @liftconfig ,

Thank you for raising this question, and apologies for the late reply.

This error occurs because fortimanager_securityconsole_install_preview is executed before fortimanager_securityconsole_install_package has completed. To avoid this, it would be better to add a waiting period and use depends_on to explicitly define the execution order.

In addition, install_preview and preview/result should use the same session; otherwise, the result will always be empty. To resolve this, please disable the clean_session flag in the provider or use the token authentication method instead.

provider "fortimanager" {
  hostname = "10.160.xx"
  clean_session  = "false"   # <------------------  disable it
}


resource "fortimanager_securityconsole_install_package" "install" {
  fmgadom        = "root"
  pkg            = "FGT-VM-103_root"
  flags          = ["preview"]
  force_recreate = uuid()
  scope {
    name = "FGT-VM-103"
    vdom = "root"
  }
}

resource "time_sleep" "wait_10s" {
  create_duration = "10s"
  depends_on      = [fortimanager_securityconsole_install_package.install]
}

resource "fortimanager_securityconsole_install_preview" "preview" {
  fmgadom        = "root"
  force_recreate = uuid()

  scope {
    name = "FGT-VM-103"
    vdom = "root"
  }
  depends_on = [time_sleep.wait_10s]
}

resource "time_sleep" "wait_40s" {
  create_duration = "40s"
  triggers = {
    preview_id = fortimanager_securityconsole_install_preview.preview.id
  }
}

resource "fortimanager_json_generic_api" "result" {
  force_recreate = uuid()
  json_content   = <<JSON
{
    "method": "exec",
    "params": [
        {
            "data": {
               "adom": "root",
               "scope": [
                {
                  "name": "FGT-VM-103",
                  "vdom": "root"
                }
               ]
            },
            "url": "/securityconsole/preview/result"
        }
    ]
}
JSON
  depends_on     = [fortimanager_securityconsole_install_preview.preview, time_sleep.wait_40s]
}

output "result" {
  value = fortimanager_json_generic_api.result.response
}

Apply complete! Resources: 4 added, 0 changed, 4 destroyed.

Outputs:

result = "map[result:[map[data:map[message:[{ \"name\": \"FGT-VM-103\", \"oid\": 186, \"result\": \"=== Preview result ===\\nconfig global\\n    config system password-policy\\n        unset status\\n    end\\nend\\n\"}]] status:map[code:0 message:OK] url:/securityconsole/preview/result]]]"

Adding a waiting clock is not ideal in this case. I will consult with the development team to see whether the execute resource can return a task ID, so that we can use the task monitor resource to track and obtain the task status instead of setting a fixed timer.

Thanks,
Maxx