1. Packages
  2. Vcd Provider
  3. API Docs
  4. getNsxtDistributedFirewall
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getNsxtDistributedFirewall

Explore with Pulumi AI

The Distributed Firewall data source reads all defined rules for a particular VDC Group.

There is a different data source vcd.NsxtDistributedFirewallRule resource are available that can fetch a single firewall rule by name.

Example Usage

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

const g1 = vcd.getVdcGroup({
    org: "my-org",
    name: "my-vdc-group",
});
const t1 = g1.then(g1 => vcd.getNsxtDistributedFirewall({
    org: "my-org",
    vdcGroupId: g1.id,
}));
Copy
import pulumi
import pulumi_vcd as vcd

g1 = vcd.get_vdc_group(org="my-org",
    name="my-vdc-group")
t1 = vcd.get_nsxt_distributed_firewall(org="my-org",
    vdc_group_id=g1.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		g1, err := vcd.LookupVdcGroup(ctx, &vcd.LookupVdcGroupArgs{
			Org:  pulumi.StringRef("my-org"),
			Name: pulumi.StringRef("my-vdc-group"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vcd.LookupNsxtDistributedFirewall(ctx, &vcd.LookupNsxtDistributedFirewallArgs{
			Org:        pulumi.StringRef("my-org"),
			VdcGroupId: g1.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var g1 = Vcd.GetVdcGroup.Invoke(new()
    {
        Org = "my-org",
        Name = "my-vdc-group",
    });

    var t1 = Vcd.GetNsxtDistributedFirewall.Invoke(new()
    {
        Org = "my-org",
        VdcGroupId = g1.Apply(getVdcGroupResult => getVdcGroupResult.Id),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetVdcGroupArgs;
import com.pulumi.vcd.inputs.GetNsxtDistributedFirewallArgs;
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 g1 = VcdFunctions.getVdcGroup(GetVdcGroupArgs.builder()
            .org("my-org")
            .name("my-vdc-group")
            .build());

        final var t1 = VcdFunctions.getNsxtDistributedFirewall(GetNsxtDistributedFirewallArgs.builder()
            .org("my-org")
            .vdcGroupId(g1.applyValue(getVdcGroupResult -> getVdcGroupResult.id()))
            .build());

    }
}
Copy
variables:
  g1:
    fn::invoke:
      function: vcd:getVdcGroup
      arguments:
        org: my-org
        name: my-vdc-group
  t1:
    fn::invoke:
      function: vcd:getNsxtDistributedFirewall
      arguments:
        org: my-org
        vdcGroupId: ${g1.id}
Copy

Using getNsxtDistributedFirewall

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 getNsxtDistributedFirewall(args: GetNsxtDistributedFirewallArgs, opts?: InvokeOptions): Promise<GetNsxtDistributedFirewallResult>
function getNsxtDistributedFirewallOutput(args: GetNsxtDistributedFirewallOutputArgs, opts?: InvokeOptions): Output<GetNsxtDistributedFirewallResult>
Copy
def get_nsxt_distributed_firewall(id: Optional[str] = None,
                                  org: Optional[str] = None,
                                  vdc_group_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetNsxtDistributedFirewallResult
def get_nsxt_distributed_firewall_output(id: Optional[pulumi.Input[str]] = None,
                                  org: Optional[pulumi.Input[str]] = None,
                                  vdc_group_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetNsxtDistributedFirewallResult]
Copy
func LookupNsxtDistributedFirewall(ctx *Context, args *LookupNsxtDistributedFirewallArgs, opts ...InvokeOption) (*LookupNsxtDistributedFirewallResult, error)
func LookupNsxtDistributedFirewallOutput(ctx *Context, args *LookupNsxtDistributedFirewallOutputArgs, opts ...InvokeOption) LookupNsxtDistributedFirewallResultOutput
Copy

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

public static class GetNsxtDistributedFirewall 
{
    public static Task<GetNsxtDistributedFirewallResult> InvokeAsync(GetNsxtDistributedFirewallArgs args, InvokeOptions? opts = null)
    public static Output<GetNsxtDistributedFirewallResult> Invoke(GetNsxtDistributedFirewallInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNsxtDistributedFirewallResult> getNsxtDistributedFirewall(GetNsxtDistributedFirewallArgs args, InvokeOptions options)
public static Output<GetNsxtDistributedFirewallResult> getNsxtDistributedFirewall(GetNsxtDistributedFirewallArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vcd:index/getNsxtDistributedFirewall:getNsxtDistributedFirewall
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

VdcGroupId This property is required. string
The ID of a VDC Group
Id string
Org string
The name of organization in which Distributed Firewall is located. Optional if defined at provider level.
VdcGroupId This property is required. string
The ID of a VDC Group
Id string
Org string
The name of organization in which Distributed Firewall is located. Optional if defined at provider level.
vdcGroupId This property is required. String
The ID of a VDC Group
id String
org String
The name of organization in which Distributed Firewall is located. Optional if defined at provider level.
vdcGroupId This property is required. string
The ID of a VDC Group
id string
org string
The name of organization in which Distributed Firewall is located. Optional if defined at provider level.
vdc_group_id This property is required. str
The ID of a VDC Group
id str
org str
The name of organization in which Distributed Firewall is located. Optional if defined at provider level.
vdcGroupId This property is required. String
The ID of a VDC Group
id String
org String
The name of organization in which Distributed Firewall is located. Optional if defined at provider level.

getNsxtDistributedFirewall Result

The following output properties are available:

Supporting Types

GetNsxtDistributedFirewallRule

Action This property is required. string
AppPortProfileIds This property is required. List<string>
Comment This property is required. string
Description This property is required. string
DestinationGroupsExcluded This property is required. bool
DestinationIds This property is required. List<string>
Direction This property is required. string
Enabled This property is required. bool
Id This property is required. string
IpProtocol This property is required. string
Logging This property is required. bool
Name This property is required. string
NetworkContextProfileIds This property is required. List<string>
SourceGroupsExcluded This property is required. bool
SourceIds This property is required. List<string>
Action This property is required. string
AppPortProfileIds This property is required. []string
Comment This property is required. string
Description This property is required. string
DestinationGroupsExcluded This property is required. bool
DestinationIds This property is required. []string
Direction This property is required. string
Enabled This property is required. bool
Id This property is required. string
IpProtocol This property is required. string
Logging This property is required. bool
Name This property is required. string
NetworkContextProfileIds This property is required. []string
SourceGroupsExcluded This property is required. bool
SourceIds This property is required. []string
action This property is required. String
appPortProfileIds This property is required. List<String>
comment This property is required. String
description This property is required. String
destinationGroupsExcluded This property is required. Boolean
destinationIds This property is required. List<String>
direction This property is required. String
enabled This property is required. Boolean
id This property is required. String
ipProtocol This property is required. String
logging This property is required. Boolean
name This property is required. String
networkContextProfileIds This property is required. List<String>
sourceGroupsExcluded This property is required. Boolean
sourceIds This property is required. List<String>
action This property is required. string
appPortProfileIds This property is required. string[]
comment This property is required. string
description This property is required. string
destinationGroupsExcluded This property is required. boolean
destinationIds This property is required. string[]
direction This property is required. string
enabled This property is required. boolean
id This property is required. string
ipProtocol This property is required. string
logging This property is required. boolean
name This property is required. string
networkContextProfileIds This property is required. string[]
sourceGroupsExcluded This property is required. boolean
sourceIds This property is required. string[]
action This property is required. str
app_port_profile_ids This property is required. Sequence[str]
comment This property is required. str
description This property is required. str
destination_groups_excluded This property is required. bool
destination_ids This property is required. Sequence[str]
direction This property is required. str
enabled This property is required. bool
id This property is required. str
ip_protocol This property is required. str
logging This property is required. bool
name This property is required. str
network_context_profile_ids This property is required. Sequence[str]
source_groups_excluded This property is required. bool
source_ids This property is required. Sequence[str]
action This property is required. String
appPortProfileIds This property is required. List<String>
comment This property is required. String
description This property is required. String
destinationGroupsExcluded This property is required. Boolean
destinationIds This property is required. List<String>
direction This property is required. String
enabled This property is required. Boolean
id This property is required. String
ipProtocol This property is required. String
logging This property is required. Boolean
name This property is required. String
networkContextProfileIds This property is required. List<String>
sourceGroupsExcluded This property is required. Boolean
sourceIds This property is required. List<String>

Package Details

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