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

nsxt.getPolicyVirtualNetworkAppliance

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

    Use this data source to get the ID and attributes of an existing Virtual Network Appliance (VNA) within a VNA Cluster.

    This data source 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",
});
const vna = cluster.then(cluster => nsxt.getPolicyVirtualNetworkAppliance({
    displayName: "vna-1",
    clusterPath: cluster.path,
}));

    import pulumi
import pulumi_nsxt as nsxt

cluster = nsxt.get_policy_virtual_network_appliance_cluster(display_name="vna-cluster-1")
vna = nsxt.get_policy_virtual_network_appliance(display_name="vna-1",
    cluster_path=cluster.path)

    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 {
		cluster, err := nsxt.LookupPolicyVirtualNetworkApplianceCluster(ctx, &nsxt.LookupPolicyVirtualNetworkApplianceClusterArgs{
			DisplayName: pulumi.StringRef("vna-cluster-1"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = nsxt.LookupPolicyVirtualNetworkAppliance(ctx, &nsxt.LookupPolicyVirtualNetworkApplianceArgs{
			DisplayName: pulumi.StringRef("vna-1"),
			ClusterPath: cluster.Path,
		}, 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",
    });

    var vna = Nsxt.GetPolicyVirtualNetworkAppliance.Invoke(new()
    {
        DisplayName = "vna-1",
        ClusterPath = cluster.Apply(getPolicyVirtualNetworkApplianceClusterResult => getPolicyVirtualNetworkApplianceClusterResult.Path),
    });

});

    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 com.pulumi.nsxt.inputs.GetPolicyVirtualNetworkApplianceArgs;
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());

        final var vna = NsxtFunctions.getPolicyVirtualNetworkAppliance(GetPolicyVirtualNetworkApplianceArgs.builder()
            .displayName("vna-1")
            .clusterPath(cluster.path())
            .build());

    }
}

    variables:
  cluster:
    fn::invoke:
      function: nsxt:getPolicyVirtualNetworkApplianceCluster
      arguments:
        displayName: vna-cluster-1
  vna:
    fn::invoke:
      function: nsxt:getPolicyVirtualNetworkAppliance
      arguments:
        displayName: vna-1
        clusterPath: ${cluster.path}

    Example coming soon!

    Using getPolicyVirtualNetworkAppliance

    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 getPolicyVirtualNetworkAppliance(args: GetPolicyVirtualNetworkApplianceArgs, opts?: InvokeOptions): Promise<GetPolicyVirtualNetworkApplianceResult>
function getPolicyVirtualNetworkApplianceOutput(args: GetPolicyVirtualNetworkApplianceOutputArgs, opts?: InvokeOutputOptions): Output<GetPolicyVirtualNetworkApplianceResult>
    def get_policy_virtual_network_appliance(cluster_path: Optional[str] = None,
                                         description: Optional[str] = None,
                                         display_name: Optional[str] = None,
                                         id: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetPolicyVirtualNetworkApplianceResult
def get_policy_virtual_network_appliance_output(cluster_path: pulumi.Input[Optional[str]] = None,
                                         description: pulumi.Input[Optional[str]] = None,
                                         display_name: pulumi.Input[Optional[str]] = None,
                                         id: pulumi.Input[Optional[str]] = None,
                                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetPolicyVirtualNetworkApplianceResult]
    func LookupPolicyVirtualNetworkAppliance(ctx *Context, args *LookupPolicyVirtualNetworkApplianceArgs, opts ...InvokeOption) (*LookupPolicyVirtualNetworkApplianceResult, error)
func LookupPolicyVirtualNetworkApplianceOutput(ctx *Context, args *LookupPolicyVirtualNetworkApplianceOutputArgs, opts ...InvokeOption) LookupPolicyVirtualNetworkApplianceResultOutput

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

    public static class GetPolicyVirtualNetworkAppliance 
{
    public static Task<GetPolicyVirtualNetworkApplianceResult> InvokeAsync(GetPolicyVirtualNetworkApplianceArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyVirtualNetworkApplianceResult> Invoke(GetPolicyVirtualNetworkApplianceInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyVirtualNetworkApplianceResult> Invoke(GetPolicyVirtualNetworkApplianceInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetPolicyVirtualNetworkApplianceResult> getPolicyVirtualNetworkAppliance(GetPolicyVirtualNetworkApplianceArgs args, InvokeOptions options)
public static Output<GetPolicyVirtualNetworkApplianceResult> getPolicyVirtualNetworkAppliance(GetPolicyVirtualNetworkApplianceArgs args, InvokeOptions options)
public static Output<GetPolicyVirtualNetworkApplianceResult> getPolicyVirtualNetworkAppliance(GetPolicyVirtualNetworkApplianceArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: nsxt:index/getPolicyVirtualNetworkAppliance:getPolicyVirtualNetworkAppliance
  arguments:
    # arguments dictionary
    data "nsxt_get_policy_virtual_network_appliance" "name" {
    # arguments
}

    The following arguments are supported:

    ClusterPath string
    Policy path of the parent nsxt.PolicyVirtualNetworkApplianceCluster.
    Description string
    Description of the Virtual Network Appliance.
    DisplayName string
    Display name of the Virtual Network Appliance. Prefix matching is supported when no exact match is found.
    Id string
    The NSX ID of the Virtual Network Appliance. Conflicts with display_name.
    ClusterPath string
    Policy path of the parent nsxt.PolicyVirtualNetworkApplianceCluster.
    Description string
    Description of the Virtual Network Appliance.
    DisplayName string
    Display name of the Virtual Network Appliance. Prefix matching is supported when no exact match is found.
    Id string
    The NSX ID of the Virtual Network Appliance. Conflicts with display_name.
    cluster_path string
    Policy path of the parent nsxt.PolicyVirtualNetworkApplianceCluster.
    description string
    Description of the Virtual Network Appliance.
    display_name string
    Display name of the Virtual Network Appliance. Prefix matching is supported when no exact match is found.
    id string
    The NSX ID of the Virtual Network Appliance. Conflicts with display_name.
    clusterPath String
    Policy path of the parent nsxt.PolicyVirtualNetworkApplianceCluster.
    description String
    Description of the Virtual Network Appliance.
    displayName String
    Display name of the Virtual Network Appliance. Prefix matching is supported when no exact match is found.
    id String
    The NSX ID of the Virtual Network Appliance. Conflicts with display_name.
    clusterPath string
    Policy path of the parent nsxt.PolicyVirtualNetworkApplianceCluster.
    description string
    Description of the Virtual Network Appliance.
    displayName string
    Display name of the Virtual Network Appliance. Prefix matching is supported when no exact match is found.
    id string
    The NSX ID of the Virtual Network Appliance. Conflicts with display_name.
    cluster_path str
    Policy path of the parent nsxt.PolicyVirtualNetworkApplianceCluster.
    description str
    Description of the Virtual Network Appliance.
    display_name str
    Display name of the Virtual Network Appliance. Prefix matching is supported when no exact match is found.
    id str
    The NSX ID of the Virtual Network Appliance. Conflicts with display_name.
    clusterPath String
    Policy path of the parent nsxt.PolicyVirtualNetworkApplianceCluster.
    description String
    Description of the Virtual Network Appliance.
    displayName String
    Display name of the Virtual Network Appliance. Prefix matching is supported when no exact match is found.
    id String
    The NSX ID of the Virtual Network Appliance. Conflicts with display_name.

    getPolicyVirtualNetworkAppliance Result

    The following output properties are available:

    ClusterPath string
    Description string
    Description of the Virtual Network Appliance.
    DisplayName string
    FailureDomainPath string
    Policy path of the failure domain.
    Hostname string
    Hostname or FQDN of the Virtual Network Appliance VM.
    Id string
    Path string
    Policy path of the Virtual Network Appliance.
    ClusterPath string
    Description string
    Description of the Virtual Network Appliance.
    DisplayName string
    FailureDomainPath string
    Policy path of the failure domain.
    Hostname string
    Hostname or FQDN of the Virtual Network Appliance VM.
    Id string
    Path string
    Policy path of the Virtual Network Appliance.
    cluster_path string
    description string
    Description of the Virtual Network Appliance.
    display_name string
    failure_domain_path string
    Policy path of the failure domain.
    hostname string
    Hostname or FQDN of the Virtual Network Appliance VM.
    id string
    path string
    Policy path of the Virtual Network Appliance.
    clusterPath String
    description String
    Description of the Virtual Network Appliance.
    displayName String
    failureDomainPath String
    Policy path of the failure domain.
    hostname String
    Hostname or FQDN of the Virtual Network Appliance VM.
    id String
    path String
    Policy path of the Virtual Network Appliance.
    clusterPath string
    description string
    Description of the Virtual Network Appliance.
    displayName string
    failureDomainPath string
    Policy path of the failure domain.
    hostname string
    Hostname or FQDN of the Virtual Network Appliance VM.
    id string
    path string
    Policy path of the Virtual Network Appliance.
    cluster_path str
    description str
    Description of the Virtual Network Appliance.
    display_name str
    failure_domain_path str
    Policy path of the failure domain.
    hostname str
    Hostname or FQDN of the Virtual Network Appliance VM.
    id str
    path str
    Policy path of the Virtual Network Appliance.
    clusterPath String
    description String
    Description of the Virtual Network Appliance.
    displayName String
    failureDomainPath String
    Policy path of the failure domain.
    hostname String
    Hostname or FQDN of the Virtual Network Appliance VM.
    id String
    path String
    Policy path of the Virtual Network Appliance.

    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