1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getHostUpgradeGroup
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.getHostUpgradeGroup

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    This data source provides information about a Host Upgrade Group configured on NSX.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const test = nsxt.getHostUpgradeGroup({
        upgradePrepareId: nsxt_upgrade_prepare.test.id,
        displayName: "hostupgradegroup1",
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    test = nsxt.get_host_upgrade_group(upgrade_prepare_id=nsxt_upgrade_prepare["test"]["id"],
        display_name="hostupgradegroup1")
    
    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.GetHostUpgradeGroup(ctx, &nsxt.GetHostUpgradeGroupArgs{
    			UpgradePrepareId: nsxt_upgrade_prepare.Test.Id,
    			DisplayName:      pulumi.StringRef("hostupgradegroup1"),
    		}, 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 test = Nsxt.GetHostUpgradeGroup.Invoke(new()
        {
            UpgradePrepareId = nsxt_upgrade_prepare.Test.Id,
            DisplayName = "hostupgradegroup1",
        });
    
    });
    
    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.GetHostUpgradeGroupArgs;
    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 test = NsxtFunctions.getHostUpgradeGroup(GetHostUpgradeGroupArgs.builder()
                .upgradePrepareId(nsxt_upgrade_prepare.test().id())
                .displayName("hostupgradegroup1")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: nsxt:getHostUpgradeGroup
          arguments:
            upgradePrepareId: ${nsxt_upgrade_prepare.test.id}
            displayName: hostupgradegroup1
    

    Using getHostUpgradeGroup

    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 getHostUpgradeGroup(args: GetHostUpgradeGroupArgs, opts?: InvokeOptions): Promise<GetHostUpgradeGroupResult>
    function getHostUpgradeGroupOutput(args: GetHostUpgradeGroupOutputArgs, opts?: InvokeOptions): Output<GetHostUpgradeGroupResult>
    def get_host_upgrade_group(description: Optional[str] = None,
                               display_name: Optional[str] = None,
                               id: Optional[str] = None,
                               upgrade_prepare_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetHostUpgradeGroupResult
    def get_host_upgrade_group_output(description: Optional[pulumi.Input[str]] = None,
                               display_name: Optional[pulumi.Input[str]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               upgrade_prepare_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetHostUpgradeGroupResult]
    func GetHostUpgradeGroup(ctx *Context, args *GetHostUpgradeGroupArgs, opts ...InvokeOption) (*GetHostUpgradeGroupResult, error)
    func GetHostUpgradeGroupOutput(ctx *Context, args *GetHostUpgradeGroupOutputArgs, opts ...InvokeOption) GetHostUpgradeGroupResultOutput

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

    public static class GetHostUpgradeGroup 
    {
        public static Task<GetHostUpgradeGroupResult> InvokeAsync(GetHostUpgradeGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetHostUpgradeGroupResult> Invoke(GetHostUpgradeGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHostUpgradeGroupResult> getHostUpgradeGroup(GetHostUpgradeGroupArgs args, InvokeOptions options)
    public static Output<GetHostUpgradeGroupResult> getHostUpgradeGroup(GetHostUpgradeGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getHostUpgradeGroup:getHostUpgradeGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    UpgradePrepareId string
    ID of corresponding nsxt.UpgradePrepare resource.
    Description string
    The description of the resource.
    DisplayName string
    The Display Name of the Host Upgrade Group to retrieve.
    Id string
    The ID of Host Upgrade Group to retrieve
    UpgradePrepareId string
    ID of corresponding nsxt.UpgradePrepare resource.
    Description string
    The description of the resource.
    DisplayName string
    The Display Name of the Host Upgrade Group to retrieve.
    Id string
    The ID of Host Upgrade Group to retrieve
    upgradePrepareId String
    ID of corresponding nsxt.UpgradePrepare resource.
    description String
    The description of the resource.
    displayName String
    The Display Name of the Host Upgrade Group to retrieve.
    id String
    The ID of Host Upgrade Group to retrieve
    upgradePrepareId string
    ID of corresponding nsxt.UpgradePrepare resource.
    description string
    The description of the resource.
    displayName string
    The Display Name of the Host Upgrade Group to retrieve.
    id string
    The ID of Host Upgrade Group to retrieve
    upgrade_prepare_id str
    ID of corresponding nsxt.UpgradePrepare resource.
    description str
    The description of the resource.
    display_name str
    The Display Name of the Host Upgrade Group to retrieve.
    id str
    The ID of Host Upgrade Group to retrieve
    upgradePrepareId String
    ID of corresponding nsxt.UpgradePrepare resource.
    description String
    The description of the resource.
    displayName String
    The Display Name of the Host Upgrade Group to retrieve.
    id String
    The ID of Host Upgrade Group to retrieve

    getHostUpgradeGroup Result

    The following output properties are available:

    Description string
    The description of the resource.
    DisplayName string
    Id string
    UpgradePrepareId string
    Description string
    The description of the resource.
    DisplayName string
    Id string
    UpgradePrepareId string
    description String
    The description of the resource.
    displayName String
    id String
    upgradePrepareId String
    description string
    The description of the resource.
    displayName string
    id string
    upgradePrepareId string
    description str
    The description of the resource.
    display_name str
    id str
    upgrade_prepare_id str
    description String
    The description of the resource.
    displayName String
    id String
    upgradePrepareId String

    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