Viewing docs for nsxt 3.11.0
published on Monday, Dec 15, 2025 by vmware
published on Monday, Dec 15, 2025 by vmware
Viewing docs for nsxt 3.11.0
published on Monday, Dec 15, 2025 by vmware
published on Monday, Dec 15, 2025 by vmware
This data source provides information about policy Tier-0 gateways configured on NSX.
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 tier0GwGateway = nsxt.getPolicyTier0Gateway({
displayName: "tier0-gw",
});
import pulumi
import pulumi_nsxt as nsxt
tier0_gw_gateway = nsxt.get_policy_tier0_gateway(display_name="tier0-gw")
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.LookupPolicyTier0Gateway(ctx, &nsxt.LookupPolicyTier0GatewayArgs{
DisplayName: pulumi.StringRef("tier0-gw"),
}, 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 tier0GwGateway = Nsxt.GetPolicyTier0Gateway.Invoke(new()
{
DisplayName = "tier0-gw",
});
});
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.GetPolicyTier0GatewayArgs;
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 tier0GwGateway = NsxtFunctions.getPolicyTier0Gateway(GetPolicyTier0GatewayArgs.builder()
.displayName("tier0-gw")
.build());
}
}
variables:
tier0GwGateway:
fn::invoke:
function: nsxt:getPolicyTier0Gateway
arguments:
displayName: tier0-gw
Global Infra
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const tier0GwGatewayGlobal = nsxt.getPolicyTier0Gateway({
context: {
fromGlobal: true,
},
displayName: "tier0-gw",
});
import pulumi
import pulumi_nsxt as nsxt
tier0_gw_gateway_global = nsxt.get_policy_tier0_gateway(context={
"from_global": True,
},
display_name="tier0-gw")
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.LookupPolicyTier0Gateway(ctx, &nsxt.LookupPolicyTier0GatewayArgs{
Context: nsxt.GetPolicyTier0GatewayContext{
FromGlobal: pulumi.BoolRef(true),
},
DisplayName: pulumi.StringRef("tier0-gw"),
}, 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 tier0GwGatewayGlobal = Nsxt.GetPolicyTier0Gateway.Invoke(new()
{
Context = new Nsxt.Inputs.GetPolicyTier0GatewayContextInputArgs
{
FromGlobal = true,
},
DisplayName = "tier0-gw",
});
});
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.GetPolicyTier0GatewayArgs;
import com.pulumi.nsxt.inputs.GetPolicyTier0GatewayContextArgs;
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 tier0GwGatewayGlobal = NsxtFunctions.getPolicyTier0Gateway(GetPolicyTier0GatewayArgs.builder()
.context(GetPolicyTier0GatewayContextArgs.builder()
.fromGlobal(true)
.build())
.displayName("tier0-gw")
.build());
}
}
variables:
tier0GwGatewayGlobal:
fn::invoke:
function: nsxt:getPolicyTier0Gateway
arguments:
context:
fromGlobal: true
displayName: tier0-gw
Using getPolicyTier0Gateway
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 getPolicyTier0Gateway(args: GetPolicyTier0GatewayArgs, opts?: InvokeOptions): Promise<GetPolicyTier0GatewayResult>
function getPolicyTier0GatewayOutput(args: GetPolicyTier0GatewayOutputArgs, opts?: InvokeOptions): Output<GetPolicyTier0GatewayResult>def get_policy_tier0_gateway(context: Optional[GetPolicyTier0GatewayContext] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
edge_cluster_path: Optional[str] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPolicyTier0GatewayResult
def get_policy_tier0_gateway_output(context: Optional[pulumi.Input[GetPolicyTier0GatewayContextArgs]] = None,
description: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
edge_cluster_path: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPolicyTier0GatewayResult]func LookupPolicyTier0Gateway(ctx *Context, args *LookupPolicyTier0GatewayArgs, opts ...InvokeOption) (*LookupPolicyTier0GatewayResult, error)
func LookupPolicyTier0GatewayOutput(ctx *Context, args *LookupPolicyTier0GatewayOutputArgs, opts ...InvokeOption) LookupPolicyTier0GatewayResultOutput> Note: This function is named LookupPolicyTier0Gateway in the Go SDK.
public static class GetPolicyTier0Gateway
{
public static Task<GetPolicyTier0GatewayResult> InvokeAsync(GetPolicyTier0GatewayArgs args, InvokeOptions? opts = null)
public static Output<GetPolicyTier0GatewayResult> Invoke(GetPolicyTier0GatewayInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPolicyTier0GatewayResult> getPolicyTier0Gateway(GetPolicyTier0GatewayArgs args, InvokeOptions options)
public static Output<GetPolicyTier0GatewayResult> getPolicyTier0Gateway(GetPolicyTier0GatewayArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getPolicyTier0Gateway:getPolicyTier0Gateway
arguments:
# arguments dictionaryThe following arguments are supported:
- Context
Get
Policy Tier0Gateway Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the Tier-0 gateway to retrieve.
- Edge
Cluster stringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- Id string
- The ID of Tier-0 gateway to retrieve.
- Context
Get
Policy Tier0Gateway Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the Tier-0 gateway to retrieve.
- Edge
Cluster stringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- Id string
- The ID of Tier-0 gateway to retrieve.
- context
Get
Policy Tier0Gateway Context - The context which the object belongs to
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of the Tier-0 gateway to retrieve.
- edge
Cluster StringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- id String
- The ID of Tier-0 gateway to retrieve.
- context
Get
Policy Tier0Gateway Context - The context which the object belongs to
- description string
- The description of the resource.
- display
Name string - The Display Name prefix of the Tier-0 gateway to retrieve.
- edge
Cluster stringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- id string
- The ID of Tier-0 gateway to retrieve.
- context
Get
Policy Tier0Gateway Context - The context which the object belongs to
- description str
- The description of the resource.
- display_
name str - The Display Name prefix of the Tier-0 gateway to retrieve.
- edge_
cluster_ strpath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- id str
- The ID of Tier-0 gateway to retrieve.
- context Property Map
- The context which the object belongs to
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of the Tier-0 gateway to retrieve.
- edge
Cluster StringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- id String
- The ID of Tier-0 gateway to retrieve.
getPolicyTier0Gateway Result
The following output properties are available:
- Description string
- The description of the resource.
- Display
Name string - Edge
Cluster stringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- Id string
- Path string
- The NSX path of the policy resource.
- Context
Get
Policy Tier0Gateway Context
- Description string
- The description of the resource.
- Display
Name string - Edge
Cluster stringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- Id string
- Path string
- The NSX path of the policy resource.
- Context
Get
Policy Tier0Gateway Context
- description String
- The description of the resource.
- display
Name String - edge
Cluster StringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- id String
- path String
- The NSX path of the policy resource.
- context
Get
Policy Tier0Gateway Context
- description string
- The description of the resource.
- display
Name string - edge
Cluster stringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- id string
- path string
- The NSX path of the policy resource.
- context
Get
Policy Tier0Gateway Context
- description str
- The description of the resource.
- display_
name str - edge_
cluster_ strpath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- id str
- path str
- The NSX path of the policy resource.
- context
Get
Policy Tier0Gateway Context
- description String
- The description of the resource.
- display
Name String - edge
Cluster StringPath - The path of the Edge cluster where this Tier-0 gateway is placed. This attribute is not set for NSX Global Manager, where gateway can span across multiple sites.
- id String
- path String
- The NSX path of the policy resource.
- context Property Map
Supporting Types
GetPolicyTier0GatewayContext
- From
Global bool - Set to True if the data source will need to search Tier-0 gateway created in a global manager instance (/global-infra)
- Project
Id string - Id of the project which the resource belongs to.
- From
Global bool - Set to True if the data source will need to search Tier-0 gateway created in a global manager instance (/global-infra)
- Project
Id string - Id of the project which the resource belongs to.
- from
Global Boolean - Set to True if the data source will need to search Tier-0 gateway created in a global manager instance (/global-infra)
- project
Id String - Id of the project which the resource belongs to.
- from
Global boolean - Set to True if the data source will need to search Tier-0 gateway created in a global manager instance (/global-infra)
- project
Id string - Id of the project which the resource belongs to.
- from_
global bool - Set to True if the data source will need to search Tier-0 gateway created in a global manager instance (/global-infra)
- project_
id str - Id of the project which the resource belongs to.
- from
Global Boolean - Set to True if the data source will need to search Tier-0 gateway created in a global manager instance (/global-infra)
- project
Id String - Id of the project which the resource belongs to.
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxtTerraform Provider.
Viewing docs for nsxt 3.11.0
published on Monday, Dec 15, 2025 by vmware
published on Monday, Dec 15, 2025 by vmware
