Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. UpgradeRun
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.UpgradeRun

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    This resource provides a method to configure and execute upgrade of NSXT edges, hosts, and managers.

    It will first configure upgrade unit groups and upgrade plan settings for EDGE and HOST components. Then it will execute the upgrade for each component. If there are either EDGE or HOST groups disabled from the upgrade, the corresponding component will be paused after enabled groups get upgraded. At the same time, MP upgrade won’t be processed, because that requires EDGE and HOST to be fully upgraded. Refer to the exposed attribute for current upgrade state details. For example, check upgrade_plan for current upgrade plan, which also includes the plan not specified in this resource and state for upgrade status of each component and UpgradeUnitGroups in the component. For more details, please check NSX admin guide.

    If upgrade post-checks are configured to be run, it will trigger the upgrade post-check. Please use data source nsxt.getUpgradePostcheck to retrieve results of upgrade post-checks.

    Example Usage

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

const run1 = new nsxt.UpgradeRun("run1", {
    upgradePrepareReadyId: nsxt_upgrade_prepare_ready.test.id,
    edgeGroups: [
        {
            id: data.nsxt_edge_upgrade_group.eg1.id,
            enabled: false,
        },
        {
            id: data.nsxt_edge_upgrade_group.eg2.id,
            enabled: true,
        },
    ],
    hostGroups: [
        {
            id: data.nsxt_host_upgrade_group.hg1.id,
            parallel: true,
        },
        {
            displayName: "TEST123",
            parallel: false,
            hosts: ["2fa96cdc-6b82-4284-a69a-18a21a6b6d0c"],
        },
    ],
    edgeUpgradeSetting: {
        parallel: true,
        postUpgradeCheck: true,
    },
    hostUpgradeSetting: {
        parallel: true,
        postUpgradeCheck: true,
    },
});

    import pulumi
import pulumi_nsxt as nsxt

run1 = nsxt.UpgradeRun("run1",
    upgrade_prepare_ready_id=nsxt_upgrade_prepare_ready["test"]["id"],
    edge_groups=[
        {
            "id": data["nsxt_edge_upgrade_group"]["eg1"]["id"],
            "enabled": False,
        },
        {
            "id": data["nsxt_edge_upgrade_group"]["eg2"]["id"],
            "enabled": True,
        },
    ],
    host_groups=[
        {
            "id": data["nsxt_host_upgrade_group"]["hg1"]["id"],
            "parallel": True,
        },
        {
            "display_name": "TEST123",
            "parallel": False,
            "hosts": ["2fa96cdc-6b82-4284-a69a-18a21a6b6d0c"],
        },
    ],
    edge_upgrade_setting={
        "parallel": True,
        "post_upgrade_check": True,
    },
    host_upgrade_setting={
        "parallel": True,
        "post_upgrade_check": True,
    })

    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.NewUpgradeRun(ctx, "run1", &nsxt.UpgradeRunArgs{
			UpgradePrepareReadyId: pulumi.Any(nsxt_upgrade_prepare_ready.Test.Id),
			EdgeGroups: nsxt.UpgradeRunEdgeGroupArray{
				&nsxt.UpgradeRunEdgeGroupArgs{
					Id:      pulumi.Any(data.Nsxt_edge_upgrade_group.Eg1.Id),
					Enabled: pulumi.Bool(false),
				},
				&nsxt.UpgradeRunEdgeGroupArgs{
					Id:      pulumi.Any(data.Nsxt_edge_upgrade_group.Eg2.Id),
					Enabled: pulumi.Bool(true),
				},
			},
			HostGroups: nsxt.UpgradeRunHostGroupArray{
				&nsxt.UpgradeRunHostGroupArgs{
					Id:       pulumi.Any(data.Nsxt_host_upgrade_group.Hg1.Id),
					Parallel: pulumi.Bool(true),
				},
				&nsxt.UpgradeRunHostGroupArgs{
					DisplayName: pulumi.String("TEST123"),
					Parallel:    pulumi.Bool(false),
					Hosts: pulumi.StringArray{
						pulumi.String("2fa96cdc-6b82-4284-a69a-18a21a6b6d0c"),
					},
				},
			},
			EdgeUpgradeSetting: &nsxt.UpgradeRunEdgeUpgradeSettingArgs{
				Parallel:         pulumi.Bool(true),
				PostUpgradeCheck: pulumi.Bool(true),
			},
			HostUpgradeSetting: &nsxt.UpgradeRunHostUpgradeSettingArgs{
				Parallel:         pulumi.Bool(true),
				PostUpgradeCheck: pulumi.Bool(true),
			},
		})
		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 run1 = new Nsxt.UpgradeRun("run1", new()
    {
        UpgradePrepareReadyId = nsxt_upgrade_prepare_ready.Test.Id,
        EdgeGroups = new[]
        {
            new Nsxt.Inputs.UpgradeRunEdgeGroupArgs
            {
                Id = data.Nsxt_edge_upgrade_group.Eg1.Id,
                Enabled = false,
            },
            new Nsxt.Inputs.UpgradeRunEdgeGroupArgs
            {
                Id = data.Nsxt_edge_upgrade_group.Eg2.Id,
                Enabled = true,
            },
        },
        HostGroups = new[]
        {
            new Nsxt.Inputs.UpgradeRunHostGroupArgs
            {
                Id = data.Nsxt_host_upgrade_group.Hg1.Id,
                Parallel = true,
            },
            new Nsxt.Inputs.UpgradeRunHostGroupArgs
            {
                DisplayName = "TEST123",
                Parallel = false,
                Hosts = new[]
                {
                    "2fa96cdc-6b82-4284-a69a-18a21a6b6d0c",
                },
            },
        },
        EdgeUpgradeSetting = new Nsxt.Inputs.UpgradeRunEdgeUpgradeSettingArgs
        {
            Parallel = true,
            PostUpgradeCheck = true,
        },
        HostUpgradeSetting = new Nsxt.Inputs.UpgradeRunHostUpgradeSettingArgs
        {
            Parallel = true,
            PostUpgradeCheck = true,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.UpgradeRun;
import com.pulumi.nsxt.UpgradeRunArgs;
import com.pulumi.nsxt.inputs.UpgradeRunEdgeGroupArgs;
import com.pulumi.nsxt.inputs.UpgradeRunHostGroupArgs;
import com.pulumi.nsxt.inputs.UpgradeRunEdgeUpgradeSettingArgs;
import com.pulumi.nsxt.inputs.UpgradeRunHostUpgradeSettingArgs;
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) {
        var run1 = new UpgradeRun("run1", UpgradeRunArgs.builder()
            .upgradePrepareReadyId(nsxt_upgrade_prepare_ready.test().id())
            .edgeGroups(            
                UpgradeRunEdgeGroupArgs.builder()
                    .id(data.nsxt_edge_upgrade_group().eg1().id())
                    .enabled(false)
                    .build(),
                UpgradeRunEdgeGroupArgs.builder()
                    .id(data.nsxt_edge_upgrade_group().eg2().id())
                    .enabled(true)
                    .build())
            .hostGroups(            
                UpgradeRunHostGroupArgs.builder()
                    .id(data.nsxt_host_upgrade_group().hg1().id())
                    .parallel(true)
                    .build(),
                UpgradeRunHostGroupArgs.builder()
                    .displayName("TEST123")
                    .parallel(false)
                    .hosts("2fa96cdc-6b82-4284-a69a-18a21a6b6d0c")
                    .build())
            .edgeUpgradeSetting(UpgradeRunEdgeUpgradeSettingArgs.builder()
                .parallel(true)
                .postUpgradeCheck(true)
                .build())
            .hostUpgradeSetting(UpgradeRunHostUpgradeSettingArgs.builder()
                .parallel(true)
                .postUpgradeCheck(true)
                .build())
            .build());

    }
}

    resources:
  run1:
    type: nsxt:UpgradeRun
    properties:
      upgradePrepareReadyId: ${nsxt_upgrade_prepare_ready.test.id}
      edgeGroups:
        - id: ${data.nsxt_edge_upgrade_group.eg1.id}
          enabled: false
        - id: ${data.nsxt_edge_upgrade_group.eg2.id}
          enabled: true
      hostGroups:
        - id: ${data.nsxt_host_upgrade_group.hg1.id}
          parallel: true
        - displayName: TEST123
          parallel: false
          hosts:
            - 2fa96cdc-6b82-4284-a69a-18a21a6b6d0c
      edgeUpgradeSetting:
        parallel: true
        postUpgradeCheck: true
      hostUpgradeSetting:
        parallel: true
        postUpgradeCheck: true

    Create UpgradeRun Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UpgradeRun(name: string, args: UpgradeRunArgs, opts?: CustomResourceOptions);
    @overload
def UpgradeRun(resource_name: str,
               args: UpgradeRunArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def UpgradeRun(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               upgrade_prepare_ready_id: Optional[str] = None,
               delay: Optional[float] = None,
               edge_groups: Optional[Sequence[UpgradeRunEdgeGroupArgs]] = None,
               edge_upgrade_setting: Optional[UpgradeRunEdgeUpgradeSettingArgs] = None,
               finalize_upgrade_setting: Optional[UpgradeRunFinalizeUpgradeSettingArgs] = None,
               host_groups: Optional[Sequence[UpgradeRunHostGroupArgs]] = None,
               host_upgrade_setting: Optional[UpgradeRunHostUpgradeSettingArgs] = None,
               interval: Optional[float] = None,
               max_retries: Optional[float] = None,
               timeout: Optional[float] = None,
               upgrade_group_plans: Optional[Sequence[UpgradeRunUpgradeGroupPlanArgs]] = None,
               upgrade_run_id: Optional[str] = None)
    func NewUpgradeRun(ctx *Context, name string, args UpgradeRunArgs, opts ...ResourceOption) (*UpgradeRun, error)
    public UpgradeRun(string name, UpgradeRunArgs args, CustomResourceOptions? opts = null)
    public UpgradeRun(String name, UpgradeRunArgs args)
public UpgradeRun(String name, UpgradeRunArgs args, CustomResourceOptions options)

    type: nsxt:UpgradeRun
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UpgradeRunArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UpgradeRunArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UpgradeRunArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UpgradeRunArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UpgradeRunArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var upgradeRunResource = new Nsxt.UpgradeRun("upgradeRunResource", new()
{
    UpgradePrepareReadyId = "string",
    Delay = 0,
    EdgeGroups = new[]
    {
        new Nsxt.Inputs.UpgradeRunEdgeGroupArgs
        {
            Id = "string",
            Enabled = false,
            Parallel = false,
            PauseAfterEachUpgradeUnit = false,
        },
    },
    EdgeUpgradeSetting = new Nsxt.Inputs.UpgradeRunEdgeUpgradeSettingArgs
    {
        Parallel = false,
        PostUpgradeCheck = false,
    },
    FinalizeUpgradeSetting = new Nsxt.Inputs.UpgradeRunFinalizeUpgradeSettingArgs
    {
        Enabled = false,
    },
    HostGroups = new[]
    {
        new Nsxt.Inputs.UpgradeRunHostGroupArgs
        {
            DisplayName = "string",
            Enabled = false,
            Hosts = new[]
            {
                "string",
            },
            Id = "string",
            MaintenanceModeConfigEvacuatePoweredOffVms = false,
            MaintenanceModeConfigVsanMode = "string",
            Parallel = false,
            PauseAfterEachUpgradeUnit = false,
            RebootlessUpgrade = false,
            UpgradeMode = "string",
        },
    },
    HostUpgradeSetting = new Nsxt.Inputs.UpgradeRunHostUpgradeSettingArgs
    {
        Parallel = false,
        PostUpgradeCheck = false,
        StopOnError = false,
    },
    Interval = 0,
    MaxRetries = 0,
    Timeout = 0,
    UpgradeGroupPlans = new[]
    {
        new Nsxt.Inputs.UpgradeRunUpgradeGroupPlanArgs
        {
            Enabled = false,
            ExtendedConfig = 
            {
                { "string", "string" },
            },
            Id = "string",
            Parallel = false,
            PauseAfterEachUpgradeUnit = false,
            Type = "string",
        },
    },
    UpgradeRunId = "string",
});

    example, err := nsxt.NewUpgradeRun(ctx, "upgradeRunResource", &nsxt.UpgradeRunArgs{
	UpgradePrepareReadyId: pulumi.String("string"),
	Delay:                 pulumi.Float64(0),
	EdgeGroups: nsxt.UpgradeRunEdgeGroupArray{
		&nsxt.UpgradeRunEdgeGroupArgs{
			Id:                        pulumi.String("string"),
			Enabled:                   pulumi.Bool(false),
			Parallel:                  pulumi.Bool(false),
			PauseAfterEachUpgradeUnit: pulumi.Bool(false),
		},
	},
	EdgeUpgradeSetting: &nsxt.UpgradeRunEdgeUpgradeSettingArgs{
		Parallel:         pulumi.Bool(false),
		PostUpgradeCheck: pulumi.Bool(false),
	},
	FinalizeUpgradeSetting: &nsxt.UpgradeRunFinalizeUpgradeSettingArgs{
		Enabled: pulumi.Bool(false),
	},
	HostGroups: nsxt.UpgradeRunHostGroupArray{
		&nsxt.UpgradeRunHostGroupArgs{
			DisplayName: pulumi.String("string"),
			Enabled:     pulumi.Bool(false),
			Hosts: pulumi.StringArray{
				pulumi.String("string"),
			},
			Id: pulumi.String("string"),
			MaintenanceModeConfigEvacuatePoweredOffVms: pulumi.Bool(false),
			MaintenanceModeConfigVsanMode:              pulumi.String("string"),
			Parallel:                                   pulumi.Bool(false),
			PauseAfterEachUpgradeUnit:                  pulumi.Bool(false),
			RebootlessUpgrade:                          pulumi.Bool(false),
			UpgradeMode:                                pulumi.String("string"),
		},
	},
	HostUpgradeSetting: &nsxt.UpgradeRunHostUpgradeSettingArgs{
		Parallel:         pulumi.Bool(false),
		PostUpgradeCheck: pulumi.Bool(false),
		StopOnError:      pulumi.Bool(false),
	},
	Interval:   pulumi.Float64(0),
	MaxRetries: pulumi.Float64(0),
	Timeout:    pulumi.Float64(0),
	UpgradeGroupPlans: nsxt.UpgradeRunUpgradeGroupPlanArray{
		&nsxt.UpgradeRunUpgradeGroupPlanArgs{
			Enabled: pulumi.Bool(false),
			ExtendedConfig: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Id:                        pulumi.String("string"),
			Parallel:                  pulumi.Bool(false),
			PauseAfterEachUpgradeUnit: pulumi.Bool(false),
			Type:                      pulumi.String("string"),
		},
	},
	UpgradeRunId: pulumi.String("string"),
})

    var upgradeRunResource = new UpgradeRun("upgradeRunResource", UpgradeRunArgs.builder()
    .upgradePrepareReadyId("string")
    .delay(0)
    .edgeGroups(UpgradeRunEdgeGroupArgs.builder()
        .id("string")
        .enabled(false)
        .parallel(false)
        .pauseAfterEachUpgradeUnit(false)
        .build())
    .edgeUpgradeSetting(UpgradeRunEdgeUpgradeSettingArgs.builder()
        .parallel(false)
        .postUpgradeCheck(false)
        .build())
    .finalizeUpgradeSetting(UpgradeRunFinalizeUpgradeSettingArgs.builder()
        .enabled(false)
        .build())
    .hostGroups(UpgradeRunHostGroupArgs.builder()
        .displayName("string")
        .enabled(false)
        .hosts("string")
        .id("string")
        .maintenanceModeConfigEvacuatePoweredOffVms(false)
        .maintenanceModeConfigVsanMode("string")
        .parallel(false)
        .pauseAfterEachUpgradeUnit(false)
        .rebootlessUpgrade(false)
        .upgradeMode("string")
        .build())
    .hostUpgradeSetting(UpgradeRunHostUpgradeSettingArgs.builder()
        .parallel(false)
        .postUpgradeCheck(false)
        .stopOnError(false)
        .build())
    .interval(0)
    .maxRetries(0)
    .timeout(0)
    .upgradeGroupPlans(UpgradeRunUpgradeGroupPlanArgs.builder()
        .enabled(false)
        .extendedConfig(Map.of("string", "string"))
        .id("string")
        .parallel(false)
        .pauseAfterEachUpgradeUnit(false)
        .type("string")
        .build())
    .upgradeRunId("string")
    .build());

    upgrade_run_resource = nsxt.UpgradeRun("upgradeRunResource",
    upgrade_prepare_ready_id="string",
    delay=0,
    edge_groups=[{
        "id": "string",
        "enabled": False,
        "parallel": False,
        "pause_after_each_upgrade_unit": False,
    }],
    edge_upgrade_setting={
        "parallel": False,
        "post_upgrade_check": False,
    },
    finalize_upgrade_setting={
        "enabled": False,
    },
    host_groups=[{
        "display_name": "string",
        "enabled": False,
        "hosts": ["string"],
        "id": "string",
        "maintenance_mode_config_evacuate_powered_off_vms": False,
        "maintenance_mode_config_vsan_mode": "string",
        "parallel": False,
        "pause_after_each_upgrade_unit": False,
        "rebootless_upgrade": False,
        "upgrade_mode": "string",
    }],
    host_upgrade_setting={
        "parallel": False,
        "post_upgrade_check": False,
        "stop_on_error": False,
    },
    interval=0,
    max_retries=0,
    timeout=0,
    upgrade_group_plans=[{
        "enabled": False,
        "extended_config": {
            "string": "string",
        },
        "id": "string",
        "parallel": False,
        "pause_after_each_upgrade_unit": False,
        "type": "string",
    }],
    upgrade_run_id="string")

    const upgradeRunResource = new nsxt.UpgradeRun("upgradeRunResource", {
    upgradePrepareReadyId: "string",
    delay: 0,
    edgeGroups: [{
        id: "string",
        enabled: false,
        parallel: false,
        pauseAfterEachUpgradeUnit: false,
    }],
    edgeUpgradeSetting: {
        parallel: false,
        postUpgradeCheck: false,
    },
    finalizeUpgradeSetting: {
        enabled: false,
    },
    hostGroups: [{
        displayName: "string",
        enabled: false,
        hosts: ["string"],
        id: "string",
        maintenanceModeConfigEvacuatePoweredOffVms: false,
        maintenanceModeConfigVsanMode: "string",
        parallel: false,
        pauseAfterEachUpgradeUnit: false,
        rebootlessUpgrade: false,
        upgradeMode: "string",
    }],
    hostUpgradeSetting: {
        parallel: false,
        postUpgradeCheck: false,
        stopOnError: false,
    },
    interval: 0,
    maxRetries: 0,
    timeout: 0,
    upgradeGroupPlans: [{
        enabled: false,
        extendedConfig: {
            string: "string",
        },
        id: "string",
        parallel: false,
        pauseAfterEachUpgradeUnit: false,
        type: "string",
    }],
    upgradeRunId: "string",
});

    type: nsxt:UpgradeRun
properties:
    delay: 0
    edgeGroups:
        - enabled: false
          id: string
          parallel: false
          pauseAfterEachUpgradeUnit: false
    edgeUpgradeSetting:
        parallel: false
        postUpgradeCheck: false
    finalizeUpgradeSetting:
        enabled: false
    hostGroups:
        - displayName: string
          enabled: false
          hosts:
            - string
          id: string
          maintenanceModeConfigEvacuatePoweredOffVms: false
          maintenanceModeConfigVsanMode: string
          parallel: false
          pauseAfterEachUpgradeUnit: false
          rebootlessUpgrade: false
          upgradeMode: string
    hostUpgradeSetting:
        parallel: false
        postUpgradeCheck: false
        stopOnError: false
    interval: 0
    maxRetries: 0
    timeout: 0
    upgradeGroupPlans:
        - enabled: false
          extendedConfig:
            string: string
          id: string
          parallel: false
          pauseAfterEachUpgradeUnit: false
          type: string
    upgradePrepareReadyId: string
    upgradeRunId: string

    UpgradeRun Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UpgradeRun resource accepts the following input properties:

    UpgradePrepareReadyId string
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    Delay double
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    EdgeGroups List<UpgradeRunEdgeGroup>
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    EdgeUpgradeSetting UpgradeRunEdgeUpgradeSetting
    EDGE component upgrade plan setting.
    FinalizeUpgradeSetting UpgradeRunFinalizeUpgradeSetting
    FINALIZE_UPGRADE component upgrade plan setting.
    HostGroups List<UpgradeRunHostGroup>
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    HostUpgradeSetting UpgradeRunHostUpgradeSetting
    HOST component upgrade plan setting.
    Interval double
    Interval to check upgrade status in seconds. Default: 30 seconds.
    MaxRetries double
    Timeout double
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    UpgradeGroupPlans List<UpgradeRunUpgradeGroupPlan>
    Upgrade plan for this upgrade
    UpgradeRunId string
    UpgradePrepareReadyId string
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    Delay float64
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    EdgeGroups []UpgradeRunEdgeGroupArgs
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    EdgeUpgradeSetting UpgradeRunEdgeUpgradeSettingArgs
    EDGE component upgrade plan setting.
    FinalizeUpgradeSetting UpgradeRunFinalizeUpgradeSettingArgs
    FINALIZE_UPGRADE component upgrade plan setting.
    HostGroups []UpgradeRunHostGroupArgs
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    HostUpgradeSetting UpgradeRunHostUpgradeSettingArgs
    HOST component upgrade plan setting.
    Interval float64
    Interval to check upgrade status in seconds. Default: 30 seconds.
    MaxRetries float64
    Timeout float64
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    UpgradeGroupPlans []UpgradeRunUpgradeGroupPlanArgs
    Upgrade plan for this upgrade
    UpgradeRunId string
    upgradePrepareReadyId String
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    delay Double
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    edgeGroups List<UpgradeRunEdgeGroup>
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    edgeUpgradeSetting UpgradeRunEdgeUpgradeSetting
    EDGE component upgrade plan setting.
    finalizeUpgradeSetting UpgradeRunFinalizeUpgradeSetting
    FINALIZE_UPGRADE component upgrade plan setting.
    hostGroups List<UpgradeRunHostGroup>
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    hostUpgradeSetting UpgradeRunHostUpgradeSetting
    HOST component upgrade plan setting.
    interval Double
    Interval to check upgrade status in seconds. Default: 30 seconds.
    maxRetries Double
    timeout Double
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    upgradeGroupPlans List<UpgradeRunUpgradeGroupPlan>
    Upgrade plan for this upgrade
    upgradeRunId String
    upgradePrepareReadyId string
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    delay number
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    edgeGroups UpgradeRunEdgeGroup[]
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    edgeUpgradeSetting UpgradeRunEdgeUpgradeSetting
    EDGE component upgrade plan setting.
    finalizeUpgradeSetting UpgradeRunFinalizeUpgradeSetting
    FINALIZE_UPGRADE component upgrade plan setting.
    hostGroups UpgradeRunHostGroup[]
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    hostUpgradeSetting UpgradeRunHostUpgradeSetting
    HOST component upgrade plan setting.
    interval number
    Interval to check upgrade status in seconds. Default: 30 seconds.
    maxRetries number
    timeout number
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    upgradeGroupPlans UpgradeRunUpgradeGroupPlan[]
    Upgrade plan for this upgrade
    upgradeRunId string
    upgrade_prepare_ready_id str
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    delay float
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    edge_groups Sequence[UpgradeRunEdgeGroupArgs]
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    edge_upgrade_setting UpgradeRunEdgeUpgradeSettingArgs
    EDGE component upgrade plan setting.
    finalize_upgrade_setting UpgradeRunFinalizeUpgradeSettingArgs
    FINALIZE_UPGRADE component upgrade plan setting.
    host_groups Sequence[UpgradeRunHostGroupArgs]
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    host_upgrade_setting UpgradeRunHostUpgradeSettingArgs
    HOST component upgrade plan setting.
    interval float
    Interval to check upgrade status in seconds. Default: 30 seconds.
    max_retries float
    timeout float
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    upgrade_group_plans Sequence[UpgradeRunUpgradeGroupPlanArgs]
    Upgrade plan for this upgrade
    upgrade_run_id str
    upgradePrepareReadyId String
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    delay Number
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    edgeGroups List<Property Map>
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    edgeUpgradeSetting Property Map
    EDGE component upgrade plan setting.
    finalizeUpgradeSetting Property Map
    FINALIZE_UPGRADE component upgrade plan setting.
    hostGroups List<Property Map>
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    hostUpgradeSetting Property Map
    HOST component upgrade plan setting.
    interval Number
    Interval to check upgrade status in seconds. Default: 30 seconds.
    maxRetries Number
    timeout Number
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    upgradeGroupPlans List<Property Map>
    Upgrade plan for this upgrade
    upgradeRunId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UpgradeRun resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    States List<UpgradeRunState>
    Upgrade states of each component
    Id string
    The provider-assigned unique ID for this managed resource.
    States []UpgradeRunStateType
    Upgrade states of each component
    id String
    The provider-assigned unique ID for this managed resource.
    states List<UpgradeRunState>
    Upgrade states of each component
    id string
    The provider-assigned unique ID for this managed resource.
    states UpgradeRunState[]
    Upgrade states of each component
    id str
    The provider-assigned unique ID for this managed resource.
    states Sequence[UpgradeRunState]
    Upgrade states of each component
    id String
    The provider-assigned unique ID for this managed resource.
    states List<Property Map>
    Upgrade states of each component

    Look up Existing UpgradeRun Resource

    Get an existing UpgradeRun resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UpgradeRunState, opts?: CustomResourceOptions): UpgradeRun
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delay: Optional[float] = None,
        edge_groups: Optional[Sequence[UpgradeRunEdgeGroupArgs]] = None,
        edge_upgrade_setting: Optional[UpgradeRunEdgeUpgradeSettingArgs] = None,
        finalize_upgrade_setting: Optional[UpgradeRunFinalizeUpgradeSettingArgs] = None,
        host_groups: Optional[Sequence[UpgradeRunHostGroupArgs]] = None,
        host_upgrade_setting: Optional[UpgradeRunHostUpgradeSettingArgs] = None,
        interval: Optional[float] = None,
        max_retries: Optional[float] = None,
        states: Optional[Sequence[UpgradeRunStateArgs]] = None,
        timeout: Optional[float] = None,
        upgrade_group_plans: Optional[Sequence[UpgradeRunUpgradeGroupPlanArgs]] = None,
        upgrade_prepare_ready_id: Optional[str] = None,
        upgrade_run_id: Optional[str] = None) -> UpgradeRun
    func GetUpgradeRun(ctx *Context, name string, id IDInput, state *UpgradeRunState, opts ...ResourceOption) (*UpgradeRun, error)
    public static UpgradeRun Get(string name, Input<string> id, UpgradeRunState? state, CustomResourceOptions? opts = null)
    public static UpgradeRun get(String name, Output<String> id, UpgradeRunState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:UpgradeRun    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Delay double
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    EdgeGroups List<UpgradeRunEdgeGroup>
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    EdgeUpgradeSetting UpgradeRunEdgeUpgradeSetting
    EDGE component upgrade plan setting.
    FinalizeUpgradeSetting UpgradeRunFinalizeUpgradeSetting
    FINALIZE_UPGRADE component upgrade plan setting.
    HostGroups List<UpgradeRunHostGroup>
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    HostUpgradeSetting UpgradeRunHostUpgradeSetting
    HOST component upgrade plan setting.
    Interval double
    Interval to check upgrade status in seconds. Default: 30 seconds.
    MaxRetries double
    States List<UpgradeRunState>
    Upgrade states of each component
    Timeout double
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    UpgradeGroupPlans List<UpgradeRunUpgradeGroupPlan>
    Upgrade plan for this upgrade
    UpgradePrepareReadyId string
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    UpgradeRunId string
    Delay float64
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    EdgeGroups []UpgradeRunEdgeGroupArgs
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    EdgeUpgradeSetting UpgradeRunEdgeUpgradeSettingArgs
    EDGE component upgrade plan setting.
    FinalizeUpgradeSetting UpgradeRunFinalizeUpgradeSettingArgs
    FINALIZE_UPGRADE component upgrade plan setting.
    HostGroups []UpgradeRunHostGroupArgs
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    HostUpgradeSetting UpgradeRunHostUpgradeSettingArgs
    HOST component upgrade plan setting.
    Interval float64
    Interval to check upgrade status in seconds. Default: 30 seconds.
    MaxRetries float64
    States []UpgradeRunStateTypeArgs
    Upgrade states of each component
    Timeout float64
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    UpgradeGroupPlans []UpgradeRunUpgradeGroupPlanArgs
    Upgrade plan for this upgrade
    UpgradePrepareReadyId string
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    UpgradeRunId string
    delay Double
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    edgeGroups List<UpgradeRunEdgeGroup>
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    edgeUpgradeSetting UpgradeRunEdgeUpgradeSetting
    EDGE component upgrade plan setting.
    finalizeUpgradeSetting UpgradeRunFinalizeUpgradeSetting
    FINALIZE_UPGRADE component upgrade plan setting.
    hostGroups List<UpgradeRunHostGroup>
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    hostUpgradeSetting UpgradeRunHostUpgradeSetting
    HOST component upgrade plan setting.
    interval Double
    Interval to check upgrade status in seconds. Default: 30 seconds.
    maxRetries Double
    states List<UpgradeRunState>
    Upgrade states of each component
    timeout Double
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    upgradeGroupPlans List<UpgradeRunUpgradeGroupPlan>
    Upgrade plan for this upgrade
    upgradePrepareReadyId String
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    upgradeRunId String
    delay number
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    edgeGroups UpgradeRunEdgeGroup[]
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    edgeUpgradeSetting UpgradeRunEdgeUpgradeSetting
    EDGE component upgrade plan setting.
    finalizeUpgradeSetting UpgradeRunFinalizeUpgradeSetting
    FINALIZE_UPGRADE component upgrade plan setting.
    hostGroups UpgradeRunHostGroup[]
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    hostUpgradeSetting UpgradeRunHostUpgradeSetting
    HOST component upgrade plan setting.
    interval number
    Interval to check upgrade status in seconds. Default: 30 seconds.
    maxRetries number
    states UpgradeRunState[]
    Upgrade states of each component
    timeout number
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    upgradeGroupPlans UpgradeRunUpgradeGroupPlan[]
    Upgrade plan for this upgrade
    upgradePrepareReadyId string
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    upgradeRunId string
    delay float
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    edge_groups Sequence[UpgradeRunEdgeGroupArgs]
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    edge_upgrade_setting UpgradeRunEdgeUpgradeSettingArgs
    EDGE component upgrade plan setting.
    finalize_upgrade_setting UpgradeRunFinalizeUpgradeSettingArgs
    FINALIZE_UPGRADE component upgrade plan setting.
    host_groups Sequence[UpgradeRunHostGroupArgs]
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    host_upgrade_setting UpgradeRunHostUpgradeSettingArgs
    HOST component upgrade plan setting.
    interval float
    Interval to check upgrade status in seconds. Default: 30 seconds.
    max_retries float
    states Sequence[UpgradeRunStateArgs]
    Upgrade states of each component
    timeout float
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    upgrade_group_plans Sequence[UpgradeRunUpgradeGroupPlanArgs]
    Upgrade plan for this upgrade
    upgrade_prepare_ready_id str
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    upgrade_run_id str
    delay Number
    Initial delay to start upgrade status checks in seconds. Default: 300 seconds.
    edgeGroups List<Property Map>
    EDGE component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    edgeUpgradeSetting Property Map
    EDGE component upgrade plan setting.
    finalizeUpgradeSetting Property Map
    FINALIZE_UPGRADE component upgrade plan setting.
    hostGroups List<Property Map>
    HOST component upgrade unit group configurations. Groups will be reordered following the order they present in this field.
    hostUpgradeSetting Property Map
    HOST component upgrade plan setting.
    interval Number
    Interval to check upgrade status in seconds. Default: 30 seconds.
    maxRetries Number
    states List<Property Map>
    Upgrade states of each component
    timeout Number
    Upgrade status check timeout in seconds. Default: 3600 seconds.
    upgradeGroupPlans List<Property Map>
    Upgrade plan for this upgrade
    upgradePrepareReadyId String
    ID of corresponding nsxt.getUpgradePrepareReady resource. Updating this field will trigger replacement (destroy and create) of this resource.
    upgradeRunId String

    Supporting Types

    UpgradeRunEdgeGroup, UpgradeRunEdgeGroupArgs

    Id string
    ID of the upgrade unit group.
    Enabled bool
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    Parallel bool
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    PauseAfterEachUpgradeUnit bool
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    Id string
    ID of the upgrade unit group.
    Enabled bool
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    Parallel bool
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    PauseAfterEachUpgradeUnit bool
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    id String
    ID of the upgrade unit group.
    enabled Boolean
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    parallel Boolean
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    pauseAfterEachUpgradeUnit Boolean
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    id string
    ID of the upgrade unit group.
    enabled boolean
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    parallel boolean
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    pauseAfterEachUpgradeUnit boolean
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    id str
    ID of the upgrade unit group.
    enabled bool
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    parallel bool
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    pause_after_each_upgrade_unit bool
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    id String
    ID of the upgrade unit group.
    enabled Boolean
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    parallel Boolean
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    pauseAfterEachUpgradeUnit Boolean
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.

    UpgradeRunEdgeUpgradeSetting, UpgradeRunEdgeUpgradeSettingArgs

    Parallel bool
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    PostUpgradeCheck bool
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    Parallel bool
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    PostUpgradeCheck bool
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    parallel Boolean
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    postUpgradeCheck Boolean
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    parallel boolean
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    postUpgradeCheck boolean
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    parallel bool
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    post_upgrade_check bool
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    parallel Boolean
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    postUpgradeCheck Boolean
    Flag to indicate whether run post upgrade check after upgrade. Default: True.

    UpgradeRunFinalizeUpgradeSetting, UpgradeRunFinalizeUpgradeSettingArgs

    Enabled bool
    Finalize upgrade after completion of all the components' upgrade is complete. Default: True.
    Enabled bool
    Finalize upgrade after completion of all the components' upgrade is complete. Default: True.
    enabled Boolean
    Finalize upgrade after completion of all the components' upgrade is complete. Default: True.
    enabled boolean
    Finalize upgrade after completion of all the components' upgrade is complete. Default: True.
    enabled bool
    Finalize upgrade after completion of all the components' upgrade is complete. Default: True.
    enabled Boolean
    Finalize upgrade after completion of all the components' upgrade is complete. Default: True.

    UpgradeRunHostGroup, UpgradeRunHostGroupArgs

    DisplayName string
    The display name of the host group. Should be assigned only for custom host groups and must be unique.
    Enabled bool
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    Hosts List<string>
    The list of hosts to be associated with a custom group.
    Id string
    ID of the upgrade unit group. Should exist only for predefined groups. When creating a custom host group, the value is assigned by NSX.
    MaintenanceModeConfigEvacuatePoweredOffVms bool
    Maintenance mode config of whether evacuate powered off vms.
    MaintenanceModeConfigVsanMode string
    Maintenance mode config of vsan mode. Supported values: evacuate_all_data, ensure_object_accessibility, no_action.
    Parallel bool
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    PauseAfterEachUpgradeUnit bool
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    RebootlessUpgrade bool
    Flag to indicate whether to use rebootless upgrade. Default: True.
    UpgradeMode string
    Upgrade mode. Supported values: maintenance_mode, in_place, stage_in_vlcm.
    DisplayName string
    The display name of the host group. Should be assigned only for custom host groups and must be unique.
    Enabled bool
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    Hosts []string
    The list of hosts to be associated with a custom group.
    Id string
    ID of the upgrade unit group. Should exist only for predefined groups. When creating a custom host group, the value is assigned by NSX.
    MaintenanceModeConfigEvacuatePoweredOffVms bool
    Maintenance mode config of whether evacuate powered off vms.
    MaintenanceModeConfigVsanMode string
    Maintenance mode config of vsan mode. Supported values: evacuate_all_data, ensure_object_accessibility, no_action.
    Parallel bool
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    PauseAfterEachUpgradeUnit bool
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    RebootlessUpgrade bool
    Flag to indicate whether to use rebootless upgrade. Default: True.
    UpgradeMode string
    Upgrade mode. Supported values: maintenance_mode, in_place, stage_in_vlcm.
    displayName String
    The display name of the host group. Should be assigned only for custom host groups and must be unique.
    enabled Boolean
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    hosts List<String>
    The list of hosts to be associated with a custom group.
    id String
    ID of the upgrade unit group. Should exist only for predefined groups. When creating a custom host group, the value is assigned by NSX.
    maintenanceModeConfigEvacuatePoweredOffVms Boolean
    Maintenance mode config of whether evacuate powered off vms.
    maintenanceModeConfigVsanMode String
    Maintenance mode config of vsan mode. Supported values: evacuate_all_data, ensure_object_accessibility, no_action.
    parallel Boolean
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    pauseAfterEachUpgradeUnit Boolean
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    rebootlessUpgrade Boolean
    Flag to indicate whether to use rebootless upgrade. Default: True.
    upgradeMode String
    Upgrade mode. Supported values: maintenance_mode, in_place, stage_in_vlcm.
    displayName string
    The display name of the host group. Should be assigned only for custom host groups and must be unique.
    enabled boolean
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    hosts string[]
    The list of hosts to be associated with a custom group.
    id string
    ID of the upgrade unit group. Should exist only for predefined groups. When creating a custom host group, the value is assigned by NSX.
    maintenanceModeConfigEvacuatePoweredOffVms boolean
    Maintenance mode config of whether evacuate powered off vms.
    maintenanceModeConfigVsanMode string
    Maintenance mode config of vsan mode. Supported values: evacuate_all_data, ensure_object_accessibility, no_action.
    parallel boolean
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    pauseAfterEachUpgradeUnit boolean
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    rebootlessUpgrade boolean
    Flag to indicate whether to use rebootless upgrade. Default: True.
    upgradeMode string
    Upgrade mode. Supported values: maintenance_mode, in_place, stage_in_vlcm.
    display_name str
    The display name of the host group. Should be assigned only for custom host groups and must be unique.
    enabled bool
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    hosts Sequence[str]
    The list of hosts to be associated with a custom group.
    id str
    ID of the upgrade unit group. Should exist only for predefined groups. When creating a custom host group, the value is assigned by NSX.
    maintenance_mode_config_evacuate_powered_off_vms bool
    Maintenance mode config of whether evacuate powered off vms.
    maintenance_mode_config_vsan_mode str
    Maintenance mode config of vsan mode. Supported values: evacuate_all_data, ensure_object_accessibility, no_action.
    parallel bool
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    pause_after_each_upgrade_unit bool
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    rebootless_upgrade bool
    Flag to indicate whether to use rebootless upgrade. Default: True.
    upgrade_mode str
    Upgrade mode. Supported values: maintenance_mode, in_place, stage_in_vlcm.
    displayName String
    The display name of the host group. Should be assigned only for custom host groups and must be unique.
    enabled Boolean
    Flag to indicate whether upgrade of this group is enabled or not. Default: True.
    hosts List<String>
    The list of hosts to be associated with a custom group.
    id String
    ID of the upgrade unit group. Should exist only for predefined groups. When creating a custom host group, the value is assigned by NSX.
    maintenanceModeConfigEvacuatePoweredOffVms Boolean
    Maintenance mode config of whether evacuate powered off vms.
    maintenanceModeConfigVsanMode String
    Maintenance mode config of vsan mode. Supported values: evacuate_all_data, ensure_object_accessibility, no_action.
    parallel Boolean
    Upgrade method to specify whether upgrades of UpgradeUnits in this group are performed in parallel or serially. Default: True.
    pauseAfterEachUpgradeUnit Boolean
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit. Default: False.
    rebootlessUpgrade Boolean
    Flag to indicate whether to use rebootless upgrade. Default: True.
    upgradeMode String
    Upgrade mode. Supported values: maintenance_mode, in_place, stage_in_vlcm.

    UpgradeRunHostUpgradeSetting, UpgradeRunHostUpgradeSettingArgs

    Parallel bool
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    PostUpgradeCheck bool
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    StopOnError bool
    Flag to indicate whether to pause the upgrade plan execution when an error occurs. Default: False.
    Parallel bool
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    PostUpgradeCheck bool
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    StopOnError bool
    Flag to indicate whether to pause the upgrade plan execution when an error occurs. Default: False.
    parallel Boolean
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    postUpgradeCheck Boolean
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    stopOnError Boolean
    Flag to indicate whether to pause the upgrade plan execution when an error occurs. Default: False.
    parallel boolean
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    postUpgradeCheck boolean
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    stopOnError boolean
    Flag to indicate whether to pause the upgrade plan execution when an error occurs. Default: False.
    parallel bool
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    post_upgrade_check bool
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    stop_on_error bool
    Flag to indicate whether to pause the upgrade plan execution when an error occurs. Default: False.
    parallel Boolean
    Upgrade Method to specify whether upgrades of UpgradeUnitGroups in this component are performed serially or in parallel. Default: True.
    postUpgradeCheck Boolean
    Flag to indicate whether run post upgrade check after upgrade. Default: True.
    stopOnError Boolean
    Flag to indicate whether to pause the upgrade plan execution when an error occurs. Default: False.

    UpgradeRunState, UpgradeRunStateArgs

    Details string
    Details about the upgrade status.
    GroupStates List<UpgradeRunStateGroupState>
    State of upgrade group
    Status string
    Upgrade status of component.
    TargetVersion string
    Target component version
    Type string
    Component type.
    Details string
    Details about the upgrade status.
    GroupStates []UpgradeRunStateGroupState
    State of upgrade group
    Status string
    Upgrade status of component.
    TargetVersion string
    Target component version
    Type string
    Component type.
    details String
    Details about the upgrade status.
    groupStates List<UpgradeRunStateGroupState>
    State of upgrade group
    status String
    Upgrade status of component.
    targetVersion String
    Target component version
    type String
    Component type.
    details string
    Details about the upgrade status.
    groupStates UpgradeRunStateGroupState[]
    State of upgrade group
    status string
    Upgrade status of component.
    targetVersion string
    Target component version
    type string
    Component type.
    details str
    Details about the upgrade status.
    group_states Sequence[UpgradeRunStateGroupState]
    State of upgrade group
    status str
    Upgrade status of component.
    target_version str
    Target component version
    type str
    Component type.
    details String
    Details about the upgrade status.
    groupStates List<Property Map>
    State of upgrade group
    status String
    Upgrade status of component.
    targetVersion String
    Target component version
    type String
    Component type.

    UpgradeRunStateGroupState, UpgradeRunStateGroupStateArgs

    GroupId string
    Upgrade group ID
    GroupName string
    Upgrade group name
    Status string
    Upgrade status of the upgrade group
    GroupId string
    Upgrade group ID
    GroupName string
    Upgrade group name
    Status string
    Upgrade status of the upgrade group
    groupId String
    Upgrade group ID
    groupName String
    Upgrade group name
    status String
    Upgrade status of the upgrade group
    groupId string
    Upgrade group ID
    groupName string
    Upgrade group name
    status string
    Upgrade status of the upgrade group
    group_id str
    Upgrade group ID
    group_name str
    Upgrade group name
    status str
    Upgrade status of the upgrade group
    groupId String
    Upgrade group ID
    groupName String
    Upgrade group name
    status String
    Upgrade status of the upgrade group

    UpgradeRunUpgradeGroupPlan, UpgradeRunUpgradeGroupPlanArgs

    Enabled bool
    Flag to indicate whether upgrade of this group is enabled or not
    ExtendedConfig Dictionary<string, string>
    Extended configuration for the group.
    Id string
    ID of upgrade unit group
    Parallel bool
    Upgrade method to specify whether the upgrade is to be performed in parallel or serially
    PauseAfterEachUpgradeUnit bool
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit
    Type string
    Component type
    Enabled bool
    Flag to indicate whether upgrade of this group is enabled or not
    ExtendedConfig map[string]string
    Extended configuration for the group.
    Id string
    ID of upgrade unit group
    Parallel bool
    Upgrade method to specify whether the upgrade is to be performed in parallel or serially
    PauseAfterEachUpgradeUnit bool
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit
    Type string
    Component type
    enabled Boolean
    Flag to indicate whether upgrade of this group is enabled or not
    extendedConfig Map<String,String>
    Extended configuration for the group.
    id String
    ID of upgrade unit group
    parallel Boolean
    Upgrade method to specify whether the upgrade is to be performed in parallel or serially
    pauseAfterEachUpgradeUnit Boolean
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit
    type String
    Component type
    enabled boolean
    Flag to indicate whether upgrade of this group is enabled or not
    extendedConfig {[key: string]: string}
    Extended configuration for the group.
    id string
    ID of upgrade unit group
    parallel boolean
    Upgrade method to specify whether the upgrade is to be performed in parallel or serially
    pauseAfterEachUpgradeUnit boolean
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit
    type string
    Component type
    enabled bool
    Flag to indicate whether upgrade of this group is enabled or not
    extended_config Mapping[str, str]
    Extended configuration for the group.
    id str
    ID of upgrade unit group
    parallel bool
    Upgrade method to specify whether the upgrade is to be performed in parallel or serially
    pause_after_each_upgrade_unit bool
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit
    type str
    Component type
    enabled Boolean
    Flag to indicate whether upgrade of this group is enabled or not
    extendedConfig Map<String>
    Extended configuration for the group.
    id String
    ID of upgrade unit group
    parallel Boolean
    Upgrade method to specify whether the upgrade is to be performed in parallel or serially
    pauseAfterEachUpgradeUnit Boolean
    Flag to indicate whether upgrade should be paused after upgrade of each upgrade-unit
    type String
    Component type

    Import

    ing

    Importing is not supported for this resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt