1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicyGatewayDnsForwarder
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.getPolicyGatewayDnsForwarder

Explore with Pulumi AI

This data source provides information about policy gateways DNS forwarder.

This data source is applicable to NSX Policy Manager, NSX Global Manager and VMC.

Example Usage

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

const myDnsForwarder = nsxt.getPolicyGatewayDnsForwarder({
    displayName: "dns-forwarder1",
    gatewayPath: data.nsxt_policy_tier1_gateway.path,
});
Copy
import pulumi
import pulumi_nsxt as nsxt

my_dns_forwarder = nsxt.get_policy_gateway_dns_forwarder(display_name="dns-forwarder1",
    gateway_path=data["nsxt_policy_tier1_gateway"]["path"])
Copy
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.LookupPolicyGatewayDnsForwarder(ctx, &nsxt.LookupPolicyGatewayDnsForwarderArgs{
			DisplayName: pulumi.StringRef("dns-forwarder1"),
			GatewayPath: pulumi.StringRef(data.Nsxt_policy_tier1_gateway.Path),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    var myDnsForwarder = Nsxt.GetPolicyGatewayDnsForwarder.Invoke(new()
    {
        DisplayName = "dns-forwarder1",
        GatewayPath = data.Nsxt_policy_tier1_gateway.Path,
    });

});
Copy
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.GetPolicyGatewayDnsForwarderArgs;
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 myDnsForwarder = NsxtFunctions.getPolicyGatewayDnsForwarder(GetPolicyGatewayDnsForwarderArgs.builder()
            .displayName("dns-forwarder1")
            .gatewayPath(data.nsxt_policy_tier1_gateway().path())
            .build());

    }
}
Copy
variables:
  myDnsForwarder:
    fn::invoke:
      function: nsxt:getPolicyGatewayDnsForwarder
      arguments:
        displayName: dns-forwarder1
        gatewayPath: ${data.nsxt_policy_tier1_gateway.path}
Copy

Using getPolicyGatewayDnsForwarder

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 getPolicyGatewayDnsForwarder(args: GetPolicyGatewayDnsForwarderArgs, opts?: InvokeOptions): Promise<GetPolicyGatewayDnsForwarderResult>
function getPolicyGatewayDnsForwarderOutput(args: GetPolicyGatewayDnsForwarderOutputArgs, opts?: InvokeOptions): Output<GetPolicyGatewayDnsForwarderResult>
Copy
def get_policy_gateway_dns_forwarder(context: Optional[GetPolicyGatewayDnsForwarderContext] = None,
                                     description: Optional[str] = None,
                                     display_name: Optional[str] = None,
                                     gateway_path: Optional[str] = None,
                                     id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetPolicyGatewayDnsForwarderResult
def get_policy_gateway_dns_forwarder_output(context: Optional[pulumi.Input[GetPolicyGatewayDnsForwarderContextArgs]] = None,
                                     description: Optional[pulumi.Input[str]] = None,
                                     display_name: Optional[pulumi.Input[str]] = None,
                                     gateway_path: Optional[pulumi.Input[str]] = None,
                                     id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetPolicyGatewayDnsForwarderResult]
Copy
func LookupPolicyGatewayDnsForwarder(ctx *Context, args *LookupPolicyGatewayDnsForwarderArgs, opts ...InvokeOption) (*LookupPolicyGatewayDnsForwarderResult, error)
func LookupPolicyGatewayDnsForwarderOutput(ctx *Context, args *LookupPolicyGatewayDnsForwarderOutputArgs, opts ...InvokeOption) LookupPolicyGatewayDnsForwarderResultOutput
Copy

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

public static class GetPolicyGatewayDnsForwarder 
{
    public static Task<GetPolicyGatewayDnsForwarderResult> InvokeAsync(GetPolicyGatewayDnsForwarderArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyGatewayDnsForwarderResult> Invoke(GetPolicyGatewayDnsForwarderInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPolicyGatewayDnsForwarderResult> getPolicyGatewayDnsForwarder(GetPolicyGatewayDnsForwarderArgs args, InvokeOptions options)
public static Output<GetPolicyGatewayDnsForwarderResult> getPolicyGatewayDnsForwarder(GetPolicyGatewayDnsForwarderArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nsxt:index/getPolicyGatewayDnsForwarder:getPolicyGatewayDnsForwarder
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Context GetPolicyGatewayDnsForwarderContext
The context which the object belongs to
Description string
The description of the resource.
DisplayName string
The Display Name of the gateway DNS forwarder to retrieve.
GatewayPath string
Gateway Path for this Service.
Id string
The ID of gateway DNS forwarder to retrieve.
Context GetPolicyGatewayDnsForwarderContext
The context which the object belongs to
Description string
The description of the resource.
DisplayName string
The Display Name of the gateway DNS forwarder to retrieve.
GatewayPath string
Gateway Path for this Service.
Id string
The ID of gateway DNS forwarder to retrieve.
context GetPolicyGatewayDnsForwarderContext
The context which the object belongs to
description String
The description of the resource.
displayName String
The Display Name of the gateway DNS forwarder to retrieve.
gatewayPath String
Gateway Path for this Service.
id String
The ID of gateway DNS forwarder to retrieve.
context GetPolicyGatewayDnsForwarderContext
The context which the object belongs to
description string
The description of the resource.
displayName string
The Display Name of the gateway DNS forwarder to retrieve.
gatewayPath string
Gateway Path for this Service.
id string
The ID of gateway DNS forwarder to retrieve.
context GetPolicyGatewayDnsForwarderContext
The context which the object belongs to
description str
The description of the resource.
display_name str
The Display Name of the gateway DNS forwarder to retrieve.
gateway_path str
Gateway Path for this Service.
id str
The ID of gateway DNS forwarder to retrieve.
context Property Map
The context which the object belongs to
description String
The description of the resource.
displayName String
The Display Name of the gateway DNS forwarder to retrieve.
gatewayPath String
Gateway Path for this Service.
id String
The ID of gateway DNS forwarder to retrieve.

getPolicyGatewayDnsForwarder Result

The following output properties are available:

Description string
The description of the resource.
DisplayName string
Id string
Path string
The NSX path of the policy resource.
Context GetPolicyGatewayDnsForwarderContext
GatewayPath string
Description string
The description of the resource.
DisplayName string
Id string
Path string
The NSX path of the policy resource.
Context GetPolicyGatewayDnsForwarderContext
GatewayPath string
description String
The description of the resource.
displayName String
id String
path String
The NSX path of the policy resource.
context GetPolicyGatewayDnsForwarderContext
gatewayPath String
description string
The description of the resource.
displayName string
id string
path string
The NSX path of the policy resource.
context GetPolicyGatewayDnsForwarderContext
gatewayPath string
description str
The description of the resource.
display_name str
id str
path str
The NSX path of the policy resource.
context GetPolicyGatewayDnsForwarderContext
gateway_path str
description String
The description of the resource.
displayName String
id String
path String
The NSX path of the policy resource.
context Property Map
gatewayPath String

Supporting Types

GetPolicyGatewayDnsForwarderContext

ProjectId This property is required. string
The ID of the project which the object belongs to
ProjectId This property is required. string
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to
projectId This property is required. string
The ID of the project which the object belongs to
project_id This property is required. str
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.