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

nsxt.ClusterVirtualIp

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 for configuring the virtual IP of NSXT cluster. This resource is supported with NSX 4.1.0 onwards. Only one instance of nsxt.ClusterVirtualIp resource is supported.

    Example Usage

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

const test = new nsxt.ClusterVirtualIp("test", {
    force: true,
    ipAddress: "10.0.0.251",
    ipv6Address: "fd01:1:2:2918:250:56ff:fe8b:7e4d",
});

    import pulumi
import pulumi_nsxt as nsxt

test = nsxt.ClusterVirtualIp("test",
    force=True,
    ip_address="10.0.0.251",
    ipv6_address="fd01:1:2:2918:250:56ff:fe8b:7e4d")

    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.NewClusterVirtualIp(ctx, "test", &nsxt.ClusterVirtualIpArgs{
			Force:       pulumi.Bool(true),
			IpAddress:   pulumi.String("10.0.0.251"),
			Ipv6Address: pulumi.String("fd01:1:2:2918:250:56ff:fe8b:7e4d"),
		})
		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.ClusterVirtualIp("test", new()
    {
        Force = true,
        IpAddress = "10.0.0.251",
        Ipv6Address = "fd01:1:2:2918:250:56ff:fe8b:7e4d",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.ClusterVirtualIp;
import com.pulumi.nsxt.ClusterVirtualIpArgs;
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 ClusterVirtualIp("test", ClusterVirtualIpArgs.builder()
            .force("true")
            .ipAddress("10.0.0.251")
            .ipv6Address("fd01:1:2:2918:250:56ff:fe8b:7e4d")
            .build());

    }
}

    resources:
  test:
    type: nsxt:ClusterVirtualIp
    properties:
      force: 'true'
      ipAddress: 10.0.0.251
      ipv6Address: fd01:1:2:2918:250:56ff:fe8b:7e4d

    Create ClusterVirtualIp Resource

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

    Constructor syntax

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

@overload
def ClusterVirtualIp(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     cluster_virtual_ip_id: Optional[str] = None,
                     force: Optional[bool] = None,
                     ip_address: Optional[str] = None,
                     ipv6_address: Optional[str] = None)
    func NewClusterVirtualIp(ctx *Context, name string, args *ClusterVirtualIpArgs, opts ...ResourceOption) (*ClusterVirtualIp, error)
    public ClusterVirtualIp(string name, ClusterVirtualIpArgs? args = null, CustomResourceOptions? opts = null)
    public ClusterVirtualIp(String name, ClusterVirtualIpArgs args)
public ClusterVirtualIp(String name, ClusterVirtualIpArgs args, CustomResourceOptions options)

    type: nsxt:ClusterVirtualIp
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 ClusterVirtualIpArgs
    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 ClusterVirtualIpArgs
    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 ClusterVirtualIpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterVirtualIpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterVirtualIpArgs
    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 clusterVirtualIpResource = new Nsxt.ClusterVirtualIp("clusterVirtualIpResource", new()
{
    ClusterVirtualIpId = "string",
    Force = false,
    IpAddress = "string",
    Ipv6Address = "string",
});

    example, err := nsxt.NewClusterVirtualIp(ctx, "clusterVirtualIpResource", &nsxt.ClusterVirtualIpArgs{
	ClusterVirtualIpId: pulumi.String("string"),
	Force:              pulumi.Bool(false),
	IpAddress:          pulumi.String("string"),
	Ipv6Address:        pulumi.String("string"),
})

    var clusterVirtualIpResource = new ClusterVirtualIp("clusterVirtualIpResource", ClusterVirtualIpArgs.builder()
    .clusterVirtualIpId("string")
    .force(false)
    .ipAddress("string")
    .ipv6Address("string")
    .build());

    cluster_virtual_ip_resource = nsxt.ClusterVirtualIp("clusterVirtualIpResource",
    cluster_virtual_ip_id="string",
    force=False,
    ip_address="string",
    ipv6_address="string")

    const clusterVirtualIpResource = new nsxt.ClusterVirtualIp("clusterVirtualIpResource", {
    clusterVirtualIpId: "string",
    force: false,
    ipAddress: "string",
    ipv6Address: "string",
});

    type: nsxt:ClusterVirtualIp
properties:
    clusterVirtualIpId: string
    force: false
    ipAddress: string
    ipv6Address: string

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

    ClusterVirtualIpId string
    Force bool
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    IpAddress string
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    Ipv6Address string
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    ClusterVirtualIpId string
    Force bool
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    IpAddress string
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    Ipv6Address string
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    clusterVirtualIpId String
    force Boolean
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    ipAddress String
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    ipv6Address String
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    clusterVirtualIpId string
    force boolean
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    ipAddress string
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    ipv6Address string
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    cluster_virtual_ip_id str
    force bool
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    ip_address str
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    ipv6_address str
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    clusterVirtualIpId String
    force Boolean
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    ipAddress String
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    ipv6Address String
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ClusterVirtualIp Resource

    Get an existing ClusterVirtualIp 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?: ClusterVirtualIpState, opts?: CustomResourceOptions): ClusterVirtualIp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_virtual_ip_id: Optional[str] = None,
        force: Optional[bool] = None,
        ip_address: Optional[str] = None,
        ipv6_address: Optional[str] = None) -> ClusterVirtualIp
    func GetClusterVirtualIp(ctx *Context, name string, id IDInput, state *ClusterVirtualIpState, opts ...ResourceOption) (*ClusterVirtualIp, error)
    public static ClusterVirtualIp Get(string name, Input<string> id, ClusterVirtualIpState? state, CustomResourceOptions? opts = null)
    public static ClusterVirtualIp get(String name, Output<String> id, ClusterVirtualIpState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:ClusterVirtualIp    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:
    ClusterVirtualIpId string
    Force bool
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    IpAddress string
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    Ipv6Address string
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    ClusterVirtualIpId string
    Force bool
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    IpAddress string
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    Ipv6Address string
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    clusterVirtualIpId String
    force Boolean
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    ipAddress String
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    ipv6Address String
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    clusterVirtualIpId string
    force boolean
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    ipAddress string
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    ipv6Address string
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    cluster_virtual_ip_id str
    force bool
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    ip_address str
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    ipv6_address str
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.
    clusterVirtualIpId String
    force Boolean
    A flag to determine if need to ignore duplicate address detection and DNS lookup validation check. Value can be true or false. Default value is false. This argument is supported for NSX 4.0.0 and above.
    ipAddress String
    Virtual IP Address of the cluster. Must be in the same subnet as the manager nodes. Default value is 0.0.0.0.
    ipv6Address String
    Virtual IPv6 Address of the cluster. To set ipv6 virtual IP address, IPv6 interface needs to be configured on manager nodes. Default value is ::. This argument is supported for NSX 4.0.0 and above.

    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