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

nsxt.ManagerCluster

Explore with Pulumi AI

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

    Example Usage

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

const test = new nsxt.ManagerCluster("test", {nodes: [
    {
        ipAddress: "192.168.240.32",
        password: "testpassword2",
        username: "admin",
    },
    {
        ipAddress: "192.168.240.33",
        password: "testpassword3",
        username: "admin",
    },
]});

    import pulumi
import pulumi_nsxt as nsxt

test = nsxt.ManagerCluster("test", nodes=[
    {
        "ip_address": "192.168.240.32",
        "password": "testpassword2",
        "username": "admin",
    },
    {
        "ip_address": "192.168.240.33",
        "password": "testpassword3",
        "username": "admin",
    },
])

    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.NewManagerCluster(ctx, "test", &nsxt.ManagerClusterArgs{
			Nodes: nsxt.ManagerClusterNodeArray{
				&nsxt.ManagerClusterNodeArgs{
					IpAddress: pulumi.String("192.168.240.32"),
					Password:  pulumi.String("testpassword2"),
					Username:  pulumi.String("admin"),
				},
				&nsxt.ManagerClusterNodeArgs{
					IpAddress: pulumi.String("192.168.240.33"),
					Password:  pulumi.String("testpassword3"),
					Username:  pulumi.String("admin"),
				},
			},
		})
		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 = new Nsxt.ManagerCluster("test", new()
    {
        Nodes = new[]
        {
            new Nsxt.Inputs.ManagerClusterNodeArgs
            {
                IpAddress = "192.168.240.32",
                Password = "testpassword2",
                Username = "admin",
            },
            new Nsxt.Inputs.ManagerClusterNodeArgs
            {
                IpAddress = "192.168.240.33",
                Password = "testpassword3",
                Username = "admin",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.ManagerCluster;
import com.pulumi.nsxt.ManagerClusterArgs;
import com.pulumi.nsxt.inputs.ManagerClusterNodeArgs;
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 test = new ManagerCluster("test", ManagerClusterArgs.builder()
            .nodes(            
                ManagerClusterNodeArgs.builder()
                    .ipAddress("192.168.240.32")
                    .password("testpassword2")
                    .username("admin")
                    .build(),
                ManagerClusterNodeArgs.builder()
                    .ipAddress("192.168.240.33")
                    .password("testpassword3")
                    .username("admin")
                    .build())
            .build());

    }
}

    resources:
  test:
    type: nsxt:ManagerCluster
    properties:
      nodes:
        - ipAddress: 192.168.240.32
          password: testpassword2
          username: admin
        - ipAddress: 192.168.240.33
          password: testpassword3
          username: admin

    Create ManagerCluster Resource

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

    Constructor syntax

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

@overload
def ManagerCluster(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   nodes: Optional[Sequence[ManagerClusterNodeArgs]] = None,
                   api_probing: Optional[ManagerClusterApiProbingArgs] = None,
                   manager_cluster_id: Optional[str] = None)
    func NewManagerCluster(ctx *Context, name string, args ManagerClusterArgs, opts ...ResourceOption) (*ManagerCluster, error)
    public ManagerCluster(string name, ManagerClusterArgs args, CustomResourceOptions? opts = null)
    public ManagerCluster(String name, ManagerClusterArgs args)
public ManagerCluster(String name, ManagerClusterArgs args, CustomResourceOptions options)

    type: nsxt:ManagerCluster
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 ManagerClusterArgs
    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 ManagerClusterArgs
    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 ManagerClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagerClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagerClusterArgs
    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 managerClusterResource = new Nsxt.ManagerCluster("managerClusterResource", new()
{
    Nodes = new[]
    {
        new Nsxt.Inputs.ManagerClusterNodeArgs
        {
            IpAddress = "string",
            Password = "string",
            Username = "string",
            Fqdn = "string",
            Id = "string",
            Status = "string",
        },
    },
    ApiProbing = new Nsxt.Inputs.ManagerClusterApiProbingArgs
    {
        Delay = 0,
        Enabled = false,
        Interval = 0,
        Timeout = 0,
    },
    ManagerClusterId = "string",
});

    example, err := nsxt.NewManagerCluster(ctx, "managerClusterResource", &nsxt.ManagerClusterArgs{
	Nodes: nsxt.ManagerClusterNodeArray{
		&nsxt.ManagerClusterNodeArgs{
			IpAddress: pulumi.String("string"),
			Password:  pulumi.String("string"),
			Username:  pulumi.String("string"),
			Fqdn:      pulumi.String("string"),
			Id:        pulumi.String("string"),
			Status:    pulumi.String("string"),
		},
	},
	ApiProbing: &nsxt.ManagerClusterApiProbingArgs{
		Delay:    pulumi.Float64(0),
		Enabled:  pulumi.Bool(false),
		Interval: pulumi.Float64(0),
		Timeout:  pulumi.Float64(0),
	},
	ManagerClusterId: pulumi.String("string"),
})

    var managerClusterResource = new ManagerCluster("managerClusterResource", ManagerClusterArgs.builder()
    .nodes(ManagerClusterNodeArgs.builder()
        .ipAddress("string")
        .password("string")
        .username("string")
        .fqdn("string")
        .id("string")
        .status("string")
        .build())
    .apiProbing(ManagerClusterApiProbingArgs.builder()
        .delay(0)
        .enabled(false)
        .interval(0)
        .timeout(0)
        .build())
    .managerClusterId("string")
    .build());

    manager_cluster_resource = nsxt.ManagerCluster("managerClusterResource",
    nodes=[{
        "ip_address": "string",
        "password": "string",
        "username": "string",
        "fqdn": "string",
        "id": "string",
        "status": "string",
    }],
    api_probing={
        "delay": 0,
        "enabled": False,
        "interval": 0,
        "timeout": 0,
    },
    manager_cluster_id="string")

    const managerClusterResource = new nsxt.ManagerCluster("managerClusterResource", {
    nodes: [{
        ipAddress: "string",
        password: "string",
        username: "string",
        fqdn: "string",
        id: "string",
        status: "string",
    }],
    apiProbing: {
        delay: 0,
        enabled: false,
        interval: 0,
        timeout: 0,
    },
    managerClusterId: "string",
});

    type: nsxt:ManagerCluster
properties:
    apiProbing:
        delay: 0
        enabled: false
        interval: 0
        timeout: 0
    managerClusterId: string
    nodes:
        - fqdn: string
          id: string
          ipAddress: string
          password: string
          status: string
          username: string

    ManagerCluster 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 ManagerCluster resource accepts the following input properties:

    Nodes List<ManagerClusterNode>
    Nodes in the cluster
    ApiProbing ManagerClusterApiProbing
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    ManagerClusterId string
    Nodes []ManagerClusterNodeArgs
    Nodes in the cluster
    ApiProbing ManagerClusterApiProbingArgs
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    ManagerClusterId string
    nodes List<ManagerClusterNode>
    Nodes in the cluster
    apiProbing ManagerClusterApiProbing
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    managerClusterId String
    nodes ManagerClusterNode[]
    Nodes in the cluster
    apiProbing ManagerClusterApiProbing
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    managerClusterId string
    nodes Sequence[ManagerClusterNodeArgs]
    Nodes in the cluster
    api_probing ManagerClusterApiProbingArgs
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    manager_cluster_id str
    nodes List<Property Map>
    Nodes in the cluster
    apiProbing Property Map
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    managerClusterId String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Revision double
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    Id string
    The provider-assigned unique ID for this managed resource.
    Revision float64
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    id String
    The provider-assigned unique ID for this managed resource.
    revision Double
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    id string
    The provider-assigned unique ID for this managed resource.
    revision number
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    id str
    The provider-assigned unique ID for this managed resource.
    revision float
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    id String
    The provider-assigned unique ID for this managed resource.
    revision Number
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected

    Look up Existing ManagerCluster Resource

    Get an existing ManagerCluster 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?: ManagerClusterState, opts?: CustomResourceOptions): ManagerCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_probing: Optional[ManagerClusterApiProbingArgs] = None,
        manager_cluster_id: Optional[str] = None,
        nodes: Optional[Sequence[ManagerClusterNodeArgs]] = None,
        revision: Optional[float] = None) -> ManagerCluster
    func GetManagerCluster(ctx *Context, name string, id IDInput, state *ManagerClusterState, opts ...ResourceOption) (*ManagerCluster, error)
    public static ManagerCluster Get(string name, Input<string> id, ManagerClusterState? state, CustomResourceOptions? opts = null)
    public static ManagerCluster get(String name, Output<String> id, ManagerClusterState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:ManagerCluster    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:
    ApiProbing ManagerClusterApiProbing
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    ManagerClusterId string
    Nodes List<ManagerClusterNode>
    Nodes in the cluster
    Revision double
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    ApiProbing ManagerClusterApiProbingArgs
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    ManagerClusterId string
    Nodes []ManagerClusterNodeArgs
    Nodes in the cluster
    Revision float64
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    apiProbing ManagerClusterApiProbing
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    managerClusterId String
    nodes List<ManagerClusterNode>
    Nodes in the cluster
    revision Double
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    apiProbing ManagerClusterApiProbing
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    managerClusterId string
    nodes ManagerClusterNode[]
    Nodes in the cluster
    revision number
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    api_probing ManagerClusterApiProbingArgs
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    manager_cluster_id str
    nodes Sequence[ManagerClusterNodeArgs]
    Nodes in the cluster
    revision float
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected
    apiProbing Property Map
    Parameters for probing NSX API endpoint connection. Since NSX nodes might have been created during same apply, we might need to wait until the API endpoint becomes available and all required default objects are created.
    managerClusterId String
    nodes List<Property Map>
    Nodes in the cluster
    revision Number
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected

    Supporting Types

    ManagerClusterApiProbing, ManagerClusterApiProbingArgs

    Delay double
    Initial delay before we start probing API endpoint in seconds. Default is 0.
    Enabled bool
    Whether API connectivity check is enabled. Default is true.
    Interval double
    Interval for probing API endpoint in seconds. Default is 10.
    Timeout double
    Timeout for probing the API endpoint in seconds. Default is 1800.
    Delay float64
    Initial delay before we start probing API endpoint in seconds. Default is 0.
    Enabled bool
    Whether API connectivity check is enabled. Default is true.
    Interval float64
    Interval for probing API endpoint in seconds. Default is 10.
    Timeout float64
    Timeout for probing the API endpoint in seconds. Default is 1800.
    delay Double
    Initial delay before we start probing API endpoint in seconds. Default is 0.
    enabled Boolean
    Whether API connectivity check is enabled. Default is true.
    interval Double
    Interval for probing API endpoint in seconds. Default is 10.
    timeout Double
    Timeout for probing the API endpoint in seconds. Default is 1800.
    delay number
    Initial delay before we start probing API endpoint in seconds. Default is 0.
    enabled boolean
    Whether API connectivity check is enabled. Default is true.
    interval number
    Interval for probing API endpoint in seconds. Default is 10.
    timeout number
    Timeout for probing the API endpoint in seconds. Default is 1800.
    delay float
    Initial delay before we start probing API endpoint in seconds. Default is 0.
    enabled bool
    Whether API connectivity check is enabled. Default is true.
    interval float
    Interval for probing API endpoint in seconds. Default is 10.
    timeout float
    Timeout for probing the API endpoint in seconds. Default is 1800.
    delay Number
    Initial delay before we start probing API endpoint in seconds. Default is 0.
    enabled Boolean
    Whether API connectivity check is enabled. Default is true.
    interval Number
    Interval for probing API endpoint in seconds. Default is 10.
    timeout Number
    Timeout for probing the API endpoint in seconds. Default is 1800.

    ManagerClusterNode, ManagerClusterNodeArgs

    IpAddress string
    Ip address of the node.
    Password string
    The password for login to the node.
    Username string
    The username for login to the node.
    Fqdn string
    FQDN of the node.
    Id string
    Uuid of the cluster node.
    Status string
    Status of the node, value will be one of JOINING, JOINED, REMOVING and REMOVED.
    IpAddress string
    Ip address of the node.
    Password string
    The password for login to the node.
    Username string
    The username for login to the node.
    Fqdn string
    FQDN of the node.
    Id string
    Uuid of the cluster node.
    Status string
    Status of the node, value will be one of JOINING, JOINED, REMOVING and REMOVED.
    ipAddress String
    Ip address of the node.
    password String
    The password for login to the node.
    username String
    The username for login to the node.
    fqdn String
    FQDN of the node.
    id String
    Uuid of the cluster node.
    status String
    Status of the node, value will be one of JOINING, JOINED, REMOVING and REMOVED.
    ipAddress string
    Ip address of the node.
    password string
    The password for login to the node.
    username string
    The username for login to the node.
    fqdn string
    FQDN of the node.
    id string
    Uuid of the cluster node.
    status string
    Status of the node, value will be one of JOINING, JOINED, REMOVING and REMOVED.
    ip_address str
    Ip address of the node.
    password str
    The password for login to the node.
    username str
    The username for login to the node.
    fqdn str
    FQDN of the node.
    id str
    Uuid of the cluster node.
    status str
    Status of the node, value will be one of JOINING, JOINED, REMOVING and REMOVED.
    ipAddress String
    Ip address of the node.
    password String
    The password for login to the node.
    username String
    The username for login to the node.
    fqdn String
    FQDN of the node.
    id String
    Uuid of the cluster node.
    status String
    Status of the node, value will be one of JOINING, JOINED, REMOVING and REMOVED.

    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