getUpgradePostcheck

nsxt 3.12.2, Nov 13 26

Viewing docs for nsxt 3.12.2
published on Friday, Nov 13, 2026 by vmware

nsxt

Viewing docs for nsxt 3.12.2
published on Friday, Nov 13, 2026 by vmware

The data source polls post-check execution status until all groups have finished running checks (i.e. none remain in IN_PROGRESS state). On success, no output is expected: failed_group will be empty when all post-checks passed. If any group fails or has warnings, it will be listed in failed_group.

Post-checks are triggered by the nsxt.UpgradeRun resource when post_upgrade_check is enabled in edge_upgrade_setting or host_upgrade_setting.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";

const pc = nsxt.getUpgradePostcheck({
    upgradeRunId: test.id,
    type: "EDGE",
});

import pulumi
import pulumi_nsxt as nsxt

pc = nsxt.get_upgrade_postcheck(upgrade_run_id=test["id"],
    type="EDGE")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nsxt.GetUpgradePostcheck(ctx, &nsxt.GetUpgradePostcheckArgs{
			UpgradeRunId: test.Id,
			Type:         "EDGE",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    var pc = Nsxt.GetUpgradePostcheck.Invoke(new()
    {
        UpgradeRunId = test.Id,
        Type = "EDGE",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.NsxtFunctions;
import com.pulumi.nsxt.inputs.GetUpgradePostcheckArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var pc = NsxtFunctions.getUpgradePostcheck(GetUpgradePostcheckArgs.builder()
            .upgradeRunId(test.id())
            .type("EDGE")
            .build());

    }
}

variables:
  pc:
    fn::invoke:
      function: nsxt:getUpgradePostcheck
      arguments:
        upgradeRunId: ${test.id}
        type: EDGE

Example coming soon!

Using getUpgradePostcheck

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUpgradePostcheck(args: GetUpgradePostcheckArgs, opts?: InvokeOptions): Promise<GetUpgradePostcheckResult>
function getUpgradePostcheckOutput(args: GetUpgradePostcheckOutputArgs, opts?: InvokeOutputOptions): Output<GetUpgradePostcheckResult>

def get_upgrade_postcheck(delay: Optional[float] = None,
                          id: Optional[str] = None,
                          interval: Optional[float] = None,
                          timeout: Optional[float] = None,
                          type: Optional[str] = None,
                          upgrade_run_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetUpgradePostcheckResult
def get_upgrade_postcheck_output(delay: pulumi.Input[Optional[float]] = None,
                          id: pulumi.Input[Optional[str]] = None,
                          interval: pulumi.Input[Optional[float]] = None,
                          timeout: pulumi.Input[Optional[float]] = None,
                          type: pulumi.Input[Optional[str]] = None,
                          upgrade_run_id: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetUpgradePostcheckResult]

func GetUpgradePostcheck(ctx *Context, args *GetUpgradePostcheckArgs, opts ...InvokeOption) (*GetUpgradePostcheckResult, error)
func GetUpgradePostcheckOutput(ctx *Context, args *GetUpgradePostcheckOutputArgs, opts ...InvokeOption) GetUpgradePostcheckResultOutput

> Note: This function is named GetUpgradePostcheck in the Go SDK.

public static class GetUpgradePostcheck 
{
    public static Task<GetUpgradePostcheckResult> InvokeAsync(GetUpgradePostcheckArgs args, InvokeOptions? opts = null)
    public static Output<GetUpgradePostcheckResult> Invoke(GetUpgradePostcheckInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetUpgradePostcheckResult> Invoke(GetUpgradePostcheckInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetUpgradePostcheckResult> getUpgradePostcheck(GetUpgradePostcheckArgs args, InvokeOptions options)
public static Output<GetUpgradePostcheckResult> getUpgradePostcheck(GetUpgradePostcheckArgs args, InvokeOptions options)
public static Output<GetUpgradePostcheckResult> getUpgradePostcheck(GetUpgradePostcheckArgs args, InvokeOutputOptions options)

fn::invoke:
  function: nsxt:index/getUpgradePostcheck:getUpgradePostcheck
  arguments:
    # arguments dictionary

data "nsxt_get_upgrade_postcheck" "name" {
    # arguments
}

The following arguments are supported:

Type string: Component type of upgrade post-checks. Supported values: EDGE, HOST.
UpgradeRunId string: The ID of corresponding nsxt.UpgradeRun resource.
Delay double: Initial delay before starting post-check status checks in seconds. Default: 30 seconds.
Id string: ID of upgrade unit group.
Interval double: Interval to check post-check status in seconds. Default: 30 seconds.
Timeout double: Post-check status checks timeout in seconds. Default: 1800 seconds.

Type string: Component type of upgrade post-checks. Supported values: EDGE, HOST.
UpgradeRunId string: The ID of corresponding nsxt.UpgradeRun resource.
Delay float64: Initial delay before starting post-check status checks in seconds. Default: 30 seconds.
Id string: ID of upgrade unit group.
Interval float64: Interval to check post-check status in seconds. Default: 30 seconds.
Timeout float64: Post-check status checks timeout in seconds. Default: 1800 seconds.

type string: Component type of upgrade post-checks. Supported values: EDGE, HOST.
upgrade_run_id string: The ID of corresponding nsxt.UpgradeRun resource.
delay number: Initial delay before starting post-check status checks in seconds. Default: 30 seconds.
id string: ID of upgrade unit group.
interval number: Interval to check post-check status in seconds. Default: 30 seconds.
timeout number: Post-check status checks timeout in seconds. Default: 1800 seconds.

type String: Component type of upgrade post-checks. Supported values: EDGE, HOST.
upgradeRunId String: The ID of corresponding nsxt.UpgradeRun resource.
delay Double: Initial delay before starting post-check status checks in seconds. Default: 30 seconds.
id String: ID of upgrade unit group.
interval Double: Interval to check post-check status in seconds. Default: 30 seconds.
timeout Double: Post-check status checks timeout in seconds. Default: 1800 seconds.

type string: Component type of upgrade post-checks. Supported values: EDGE, HOST.
upgradeRunId string: The ID of corresponding nsxt.UpgradeRun resource.
delay number: Initial delay before starting post-check status checks in seconds. Default: 30 seconds.
id string: ID of upgrade unit group.
interval number: Interval to check post-check status in seconds. Default: 30 seconds.
timeout number: Post-check status checks timeout in seconds. Default: 1800 seconds.

type str: Component type of upgrade post-checks. Supported values: EDGE, HOST.
upgrade_run_id str: The ID of corresponding nsxt.UpgradeRun resource.
delay float: Initial delay before starting post-check status checks in seconds. Default: 30 seconds.
id str: ID of upgrade unit group.
interval float: Interval to check post-check status in seconds. Default: 30 seconds.
timeout float: Post-check status checks timeout in seconds. Default: 1800 seconds.

type String: Component type of upgrade post-checks. Supported values: EDGE, HOST.
upgradeRunId String: The ID of corresponding nsxt.UpgradeRun resource.
delay Number: Initial delay before starting post-check status checks in seconds. Default: 30 seconds.
id String: ID of upgrade unit group.
interval Number: Interval to check post-check status in seconds. Default: 30 seconds.
timeout Number: Post-check status checks timeout in seconds. Default: 1800 seconds.