Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Nsxt Provider
  4. API Docs
  5. getPolicyVirtualNetworkApplianceCluster
Viewing docs for nsxt 3.12.1
published on Friday, Sep 11, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

nsxt.getPolicyVirtualNetworkApplianceCluster

Viewing docs for nsxt 3.12.1
published on Friday, Sep 11, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

    This data source provides information about a Virtual Network Appliance (VNA) Cluster configured on NSX, including its deployed cluster members.

    This data source is applicable to NSX Policy Manager and is supported with NSX 9.1.1 onwards.

    Example Usage

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

const cluster = nsxt.getPolicyVirtualNetworkApplianceCluster({
    displayName: "vna-cluster-1",
});

    import pulumi
import pulumi_nsxt as nsxt

cluster = nsxt.get_policy_virtual_network_appliance_cluster(display_name="vna-cluster-1")

    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.LookupPolicyVirtualNetworkApplianceCluster(ctx, &nsxt.LookupPolicyVirtualNetworkApplianceClusterArgs{
			DisplayName: pulumi.StringRef("vna-cluster-1"),
		}, 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 cluster = Nsxt.GetPolicyVirtualNetworkApplianceCluster.Invoke(new()
    {
        DisplayName = "vna-cluster-1",
    });

});

    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.GetPolicyVirtualNetworkApplianceClusterArgs;
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 cluster = NsxtFunctions.getPolicyVirtualNetworkApplianceCluster(GetPolicyVirtualNetworkApplianceClusterArgs.builder()
            .displayName("vna-cluster-1")
            .build());

    }
}

    variables:
  cluster:
    fn::invoke:
      function: nsxt:getPolicyVirtualNetworkApplianceCluster
      arguments:
        displayName: vna-cluster-1

    Example coming soon!

    Lookup by ID

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

const cluster = nsxt.getPolicyVirtualNetworkApplianceCluster({
    id: "abc123",
});

    import pulumi
import pulumi_nsxt as nsxt

cluster = nsxt.get_policy_virtual_network_appliance_cluster(id="abc123")

    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.LookupPolicyVirtualNetworkApplianceCluster(ctx, &nsxt.LookupPolicyVirtualNetworkApplianceClusterArgs{
			Id: pulumi.StringRef("abc123"),
		}, 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 cluster = Nsxt.GetPolicyVirtualNetworkApplianceCluster.Invoke(new()
    {
        Id = "abc123",
    });

});

    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.GetPolicyVirtualNetworkApplianceClusterArgs;
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 cluster = NsxtFunctions.getPolicyVirtualNetworkApplianceCluster(GetPolicyVirtualNetworkApplianceClusterArgs.builder()
            .id("abc123")
            .build());

    }
}

    variables:
  cluster:
    fn::invoke:
      function: nsxt:getPolicyVirtualNetworkApplianceCluster
      arguments:
        id: abc123

    Example coming soon!

    Lookup under a specific site and enforcement point

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

const cluster = nsxt.getPolicyVirtualNetworkApplianceCluster({
    displayName: "vna-cluster-1",
    sitePath: "/infra/sites/site1",
    enforcementPoint: "default",
});

    import pulumi
import pulumi_nsxt as nsxt

cluster = nsxt.get_policy_virtual_network_appliance_cluster(display_name="vna-cluster-1",
    site_path="/infra/sites/site1",
    enforcement_point="default")

    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.LookupPolicyVirtualNetworkApplianceCluster(ctx, &nsxt.LookupPolicyVirtualNetworkApplianceClusterArgs{
			DisplayName:      pulumi.StringRef("vna-cluster-1"),
			SitePath:         pulumi.StringRef("/infra/sites/site1"),
			EnforcementPoint: pulumi.StringRef("default"),
		}, 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 cluster = Nsxt.GetPolicyVirtualNetworkApplianceCluster.Invoke(new()
    {
        DisplayName = "vna-cluster-1",
        SitePath = "/infra/sites/site1",
        EnforcementPoint = "default",
    });

});

    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.GetPolicyVirtualNetworkApplianceClusterArgs;
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 cluster = NsxtFunctions.getPolicyVirtualNetworkApplianceCluster(GetPolicyVirtualNetworkApplianceClusterArgs.builder()
            .displayName("vna-cluster-1")
            .sitePath("/infra/sites/site1")
            .enforcementPoint("default")
            .build());

    }
}

    variables:
  cluster:
    fn::invoke:
      function: nsxt:getPolicyVirtualNetworkApplianceCluster
      arguments:
        displayName: vna-cluster-1
        sitePath: /infra/sites/site1
        enforcementPoint: default

    Example coming soon!

    Using getPolicyVirtualNetworkApplianceCluster

    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 getPolicyVirtualNetworkApplianceCluster(args: GetPolicyVirtualNetworkApplianceClusterArgs, opts?: InvokeOptions): Promise<GetPolicyVirtualNetworkApplianceClusterResult>
function getPolicyVirtualNetworkApplianceClusterOutput(args: GetPolicyVirtualNetworkApplianceClusterOutputArgs, opts?: InvokeOutputOptions): Output<GetPolicyVirtualNetworkApplianceClusterResult>
    def get_policy_virtual_network_appliance_cluster(description: Optional[str] = None,
                                                 display_name: Optional[str] = None,
                                                 enforcement_point: Optional[str] = None,
                                                 id: Optional[str] = None,
                                                 site_path: Optional[str] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetPolicyVirtualNetworkApplianceClusterResult
def get_policy_virtual_network_appliance_cluster_output(description: pulumi.Input[Optional[str]] = None,
                                                 display_name: pulumi.Input[Optional[str]] = None,
                                                 enforcement_point: pulumi.Input[Optional[str]] = None,
                                                 id: pulumi.Input[Optional[str]] = None,
                                                 site_path: pulumi.Input[Optional[str]] = None,
                                                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetPolicyVirtualNetworkApplianceClusterResult]
    func LookupPolicyVirtualNetworkApplianceCluster(ctx *Context, args *LookupPolicyVirtualNetworkApplianceClusterArgs, opts ...InvokeOption) (*LookupPolicyVirtualNetworkApplianceClusterResult, error)
func LookupPolicyVirtualNetworkApplianceClusterOutput(ctx *Context, args *LookupPolicyVirtualNetworkApplianceClusterOutputArgs, opts ...InvokeOption) LookupPolicyVirtualNetworkApplianceClusterResultOutput

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

    public static class GetPolicyVirtualNetworkApplianceCluster 
{
    public static Task<GetPolicyVirtualNetworkApplianceClusterResult> InvokeAsync(GetPolicyVirtualNetworkApplianceClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyVirtualNetworkApplianceClusterResult> Invoke(GetPolicyVirtualNetworkApplianceClusterInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyVirtualNetworkApplianceClusterResult> Invoke(GetPolicyVirtualNetworkApplianceClusterInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetPolicyVirtualNetworkApplianceClusterResult> getPolicyVirtualNetworkApplianceCluster(GetPolicyVirtualNetworkApplianceClusterArgs args, InvokeOptions options)
public static Output<GetPolicyVirtualNetworkApplianceClusterResult> getPolicyVirtualNetworkApplianceCluster(GetPolicyVirtualNetworkApplianceClusterArgs args, InvokeOptions options)
public static Output<GetPolicyVirtualNetworkApplianceClusterResult> getPolicyVirtualNetworkApplianceCluster(GetPolicyVirtualNetworkApplianceClusterArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: nsxt:index/getPolicyVirtualNetworkApplianceCluster:getPolicyVirtualNetworkApplianceCluster
  arguments:
    # arguments dictionary
    data "nsxt_get_policy_virtual_network_appliance_cluster" "name" {
    # arguments
}

    The following arguments are supported:

    Description string
    The description of the resource.
    DisplayName string
    The display name prefix of the Virtual Network Appliance Cluster to retrieve.
    EnforcementPoint string
    ID of the enforcement point under the given site_path. Defaults to default.
    Id string
    The ID of the Virtual Network Appliance Cluster to retrieve. If set, no additional argument is required.
    SitePath string
    Path to the site this cluster belongs to. Defaults to the default site path.
    Description string
    The description of the resource.
    DisplayName string
    The display name prefix of the Virtual Network Appliance Cluster to retrieve.
    EnforcementPoint string
    ID of the enforcement point under the given site_path. Defaults to default.
    Id string
    The ID of the Virtual Network Appliance Cluster to retrieve. If set, no additional argument is required.
    SitePath string
    Path to the site this cluster belongs to. Defaults to the default site path.
    description string
    The description of the resource.
    display_name string
    The display name prefix of the Virtual Network Appliance Cluster to retrieve.
    enforcement_point string
    ID of the enforcement point under the given site_path. Defaults to default.
    id string
    The ID of the Virtual Network Appliance Cluster to retrieve. If set, no additional argument is required.
    site_path string
    Path to the site this cluster belongs to. Defaults to the default site path.
    description String
    The description of the resource.
    displayName String
    The display name prefix of the Virtual Network Appliance Cluster to retrieve.
    enforcementPoint String
    ID of the enforcement point under the given site_path. Defaults to default.
    id String
    The ID of the Virtual Network Appliance Cluster to retrieve. If set, no additional argument is required.
    sitePath String
    Path to the site this cluster belongs to. Defaults to the default site path.
    description string
    The description of the resource.
    displayName string
    The display name prefix of the Virtual Network Appliance Cluster to retrieve.
    enforcementPoint string
    ID of the enforcement point under the given site_path. Defaults to default.
    id string
    The ID of the Virtual Network Appliance Cluster to retrieve. If set, no additional argument is required.
    sitePath string
    Path to the site this cluster belongs to. Defaults to the default site path.
    description str
    The description of the resource.
    display_name str
    The display name prefix of the Virtual Network Appliance Cluster to retrieve.
    enforcement_point str
    ID of the enforcement point under the given site_path. Defaults to default.
    id str
    The ID of the Virtual Network Appliance Cluster to retrieve. If set, no additional argument is required.
    site_path str
    Path to the site this cluster belongs to. Defaults to the default site path.
    description String
    The description of the resource.
    displayName String
    The display name prefix of the Virtual Network Appliance Cluster to retrieve.
    enforcementPoint String
    ID of the enforcement point under the given site_path. Defaults to default.
    id String
    The ID of the Virtual Network Appliance Cluster to retrieve. If set, no additional argument is required.
    sitePath String
    Path to the site this cluster belongs to. Defaults to the default site path.

    getPolicyVirtualNetworkApplianceCluster Result

    The following output properties are available:

    ApplianceFormFactor string
    The form factor of the virtual network appliances in the cluster (SMALL, MEDIUM, LARGE, XLARGE).
    Description string
    The description of the resource.
    DisplayName string
    Id string
    Members List<GetPolicyVirtualNetworkApplianceClusterMember>
    List of cluster members as reported by NSX once VNA appliances are deployed. Each entry contains:
    Path string
    The NSX policy path of the resource.
    ServiceType string
    The service type of the cluster (VPC_SERVICES or ROUTE_CONTROLLER).
    EnforcementPoint string
    SitePath string
    ApplianceFormFactor string
    The form factor of the virtual network appliances in the cluster (SMALL, MEDIUM, LARGE, XLARGE).
    Description string
    The description of the resource.
    DisplayName string
    Id string
    Members []GetPolicyVirtualNetworkApplianceClusterMember
    List of cluster members as reported by NSX once VNA appliances are deployed. Each entry contains:
    Path string
    The NSX policy path of the resource.
    ServiceType string
    The service type of the cluster (VPC_SERVICES or ROUTE_CONTROLLER).
    EnforcementPoint string
    SitePath string
    appliance_form_factor string
    The form factor of the virtual network appliances in the cluster (SMALL, MEDIUM, LARGE, XLARGE).
    description string
    The description of the resource.
    display_name string
    id string
    members list(object)
    List of cluster members as reported by NSX once VNA appliances are deployed. Each entry contains:
    path string
    The NSX policy path of the resource.
    service_type string
    The service type of the cluster (VPC_SERVICES or ROUTE_CONTROLLER).
    enforcement_point string
    site_path string
    applianceFormFactor String
    The form factor of the virtual network appliances in the cluster (SMALL, MEDIUM, LARGE, XLARGE).
    description String
    The description of the resource.
    displayName String
    id String
    members List<GetPolicyVirtualNetworkApplianceClusterMember>
    List of cluster members as reported by NSX once VNA appliances are deployed. Each entry contains:
    path String
    The NSX policy path of the resource.
    serviceType String
    The service type of the cluster (VPC_SERVICES or ROUTE_CONTROLLER).
    enforcementPoint String
    sitePath String
    applianceFormFactor string
    The form factor of the virtual network appliances in the cluster (SMALL, MEDIUM, LARGE, XLARGE).
    description string
    The description of the resource.
    displayName string
    id string
    members GetPolicyVirtualNetworkApplianceClusterMember[]
    List of cluster members as reported by NSX once VNA appliances are deployed. Each entry contains:
    path string
    The NSX policy path of the resource.
    serviceType string
    The service type of the cluster (VPC_SERVICES or ROUTE_CONTROLLER).
    enforcementPoint string
    sitePath string
    appliance_form_factor str
    The form factor of the virtual network appliances in the cluster (SMALL, MEDIUM, LARGE, XLARGE).
    description str
    The description of the resource.
    display_name str
    id str
    members Sequence[GetPolicyVirtualNetworkApplianceClusterMember]
    List of cluster members as reported by NSX once VNA appliances are deployed. Each entry contains:
    path str
    The NSX policy path of the resource.
    service_type str
    The service type of the cluster (VPC_SERVICES or ROUTE_CONTROLLER).
    enforcement_point str
    site_path str
    applianceFormFactor String
    The form factor of the virtual network appliances in the cluster (SMALL, MEDIUM, LARGE, XLARGE).
    description String
    The description of the resource.
    displayName String
    id String
    members List<Property Map>
    List of cluster members as reported by NSX once VNA appliances are deployed. Each entry contains:
    path String
    The NSX policy path of the resource.
    serviceType String
    The service type of the cluster (VPC_SERVICES or ROUTE_CONTROLLER).
    enforcementPoint String
    sitePath String

    Supporting Types

    GetPolicyVirtualNetworkApplianceClusterMember

    AppliancePath string
    The NSX policy path of the deployed virtual appliance.
    ApplianceUniqueId string
    The virtual appliance network unique ID generated by the API.
    EdgeTransportNodePath string
    The NSX policy path of the corresponding edge transport node.
    AppliancePath string
    The NSX policy path of the deployed virtual appliance.
    ApplianceUniqueId string
    The virtual appliance network unique ID generated by the API.
    EdgeTransportNodePath string
    The NSX policy path of the corresponding edge transport node.
    appliance_path string
    The NSX policy path of the deployed virtual appliance.
    appliance_unique_id string
    The virtual appliance network unique ID generated by the API.
    edge_transport_node_path string
    The NSX policy path of the corresponding edge transport node.
    appliancePath String
    The NSX policy path of the deployed virtual appliance.
    applianceUniqueId String
    The virtual appliance network unique ID generated by the API.
    edgeTransportNodePath String
    The NSX policy path of the corresponding edge transport node.
    appliancePath string
    The NSX policy path of the deployed virtual appliance.
    applianceUniqueId string
    The virtual appliance network unique ID generated by the API.
    edgeTransportNodePath string
    The NSX policy path of the corresponding edge transport node.
    appliance_path str
    The NSX policy path of the deployed virtual appliance.
    appliance_unique_id str
    The virtual appliance network unique ID generated by the API.
    edge_transport_node_path str
    The NSX policy path of the corresponding edge transport node.
    appliancePath String
    The NSX policy path of the deployed virtual appliance.
    applianceUniqueId String
    The virtual appliance network unique ID generated by the API.
    edgeTransportNodePath String
    The NSX policy path of the corresponding edge transport node.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    Viewing docs for nsxt 3.12.1
    published on Friday, Sep 11, 2026 by vmware
    Schema (JSON)
    vmware/terraform-provider-nsxt

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial