Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxtDistributedFirewallRule
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.NsxtDistributedFirewallRule

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

Create NsxtDistributedFirewallRule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NsxtDistributedFirewallRule(name: string, args: NsxtDistributedFirewallRuleArgs, opts?: CustomResourceOptions);
@overload
def NsxtDistributedFirewallRule(resource_name: str,
                                args: NsxtDistributedFirewallRuleInitArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def NsxtDistributedFirewallRule(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                vdc_group_id: Optional[str] = None,
                                action: Optional[str] = None,
                                enabled: Optional[bool] = None,
                                ip_protocol: Optional[str] = None,
                                description: Optional[str] = None,
                                destination_groups_excluded: Optional[bool] = None,
                                destination_ids: Optional[Sequence[str]] = None,
                                direction: Optional[str] = None,
                                above_rule_id: Optional[str] = None,
                                comment: Optional[str] = None,
                                logging: Optional[bool] = None,
                                name: Optional[str] = None,
                                network_context_profile_ids: Optional[Sequence[str]] = None,
                                nsxt_distributed_firewall_rule_id: Optional[str] = None,
                                org: Optional[str] = None,
                                source_groups_excluded: Optional[bool] = None,
                                source_ids: Optional[Sequence[str]] = None,
                                app_port_profile_ids: Optional[Sequence[str]] = None)
func NewNsxtDistributedFirewallRule(ctx *Context, name string, args NsxtDistributedFirewallRuleArgs, opts ...ResourceOption) (*NsxtDistributedFirewallRule, error)
public NsxtDistributedFirewallRule(string name, NsxtDistributedFirewallRuleArgs args, CustomResourceOptions? opts = null)
public NsxtDistributedFirewallRule(String name, NsxtDistributedFirewallRuleArgs args)
public NsxtDistributedFirewallRule(String name, NsxtDistributedFirewallRuleArgs args, CustomResourceOptions options)

type: vcd:NsxtDistributedFirewallRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NsxtDistributedFirewallRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NsxtDistributedFirewallRuleInitArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NsxtDistributedFirewallRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NsxtDistributedFirewallRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NsxtDistributedFirewallRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var nsxtDistributedFirewallRuleResource = new Vcd.NsxtDistributedFirewallRule("nsxtDistributedFirewallRuleResource", new()
{
    VdcGroupId = "string",
    Action = "string",
    Enabled = false,
    IpProtocol = "string",
    Description = "string",
    DestinationGroupsExcluded = false,
    DestinationIds = new[]
    {
        "string",
    },
    Direction = "string",
    AboveRuleId = "string",
    Comment = "string",
    Logging = false,
    Name = "string",
    NetworkContextProfileIds = new[]
    {
        "string",
    },
    NsxtDistributedFirewallRuleId = "string",
    Org = "string",
    SourceGroupsExcluded = false,
    SourceIds = new[]
    {
        "string",
    },
    AppPortProfileIds = new[]
    {
        "string",
    },
});
Copy
example, err := vcd.NewNsxtDistributedFirewallRule(ctx, "nsxtDistributedFirewallRuleResource", &vcd.NsxtDistributedFirewallRuleArgs{
VdcGroupId: pulumi.String("string"),
Action: pulumi.String("string"),
Enabled: pulumi.Bool(false),
IpProtocol: pulumi.String("string"),
Description: pulumi.String("string"),
DestinationGroupsExcluded: pulumi.Bool(false),
DestinationIds: pulumi.StringArray{
pulumi.String("string"),
},
Direction: pulumi.String("string"),
AboveRuleId: pulumi.String("string"),
Comment: pulumi.String("string"),
Logging: pulumi.Bool(false),
Name: pulumi.String("string"),
NetworkContextProfileIds: pulumi.StringArray{
pulumi.String("string"),
},
NsxtDistributedFirewallRuleId: pulumi.String("string"),
Org: pulumi.String("string"),
SourceGroupsExcluded: pulumi.Bool(false),
SourceIds: pulumi.StringArray{
pulumi.String("string"),
},
AppPortProfileIds: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var nsxtDistributedFirewallRuleResource = new NsxtDistributedFirewallRule("nsxtDistributedFirewallRuleResource", NsxtDistributedFirewallRuleArgs.builder()
    .vdcGroupId("string")
    .action("string")
    .enabled(false)
    .ipProtocol("string")
    .description("string")
    .destinationGroupsExcluded(false)
    .destinationIds("string")
    .direction("string")
    .aboveRuleId("string")
    .comment("string")
    .logging(false)
    .name("string")
    .networkContextProfileIds("string")
    .nsxtDistributedFirewallRuleId("string")
    .org("string")
    .sourceGroupsExcluded(false)
    .sourceIds("string")
    .appPortProfileIds("string")
    .build());
Copy
nsxt_distributed_firewall_rule_resource = vcd.NsxtDistributedFirewallRule("nsxtDistributedFirewallRuleResource",
    vdc_group_id="string",
    action="string",
    enabled=False,
    ip_protocol="string",
    description="string",
    destination_groups_excluded=False,
    destination_ids=["string"],
    direction="string",
    above_rule_id="string",
    comment="string",
    logging=False,
    name="string",
    network_context_profile_ids=["string"],
    nsxt_distributed_firewall_rule_id="string",
    org="string",
    source_groups_excluded=False,
    source_ids=["string"],
    app_port_profile_ids=["string"])
Copy
const nsxtDistributedFirewallRuleResource = new vcd.NsxtDistributedFirewallRule("nsxtDistributedFirewallRuleResource", {
    vdcGroupId: "string",
    action: "string",
    enabled: false,
    ipProtocol: "string",
    description: "string",
    destinationGroupsExcluded: false,
    destinationIds: ["string"],
    direction: "string",
    aboveRuleId: "string",
    comment: "string",
    logging: false,
    name: "string",
    networkContextProfileIds: ["string"],
    nsxtDistributedFirewallRuleId: "string",
    org: "string",
    sourceGroupsExcluded: false,
    sourceIds: ["string"],
    appPortProfileIds: ["string"],
});
Copy
type: vcd:NsxtDistributedFirewallRule
properties:
    aboveRuleId: string
    action: string
    appPortProfileIds:
        - string
    comment: string
    description: string
    destinationGroupsExcluded: false
    destinationIds:
        - string
    direction: string
    enabled: false
    ipProtocol: string
    logging: false
    name: string
    networkContextProfileIds:
        - string
    nsxtDistributedFirewallRuleId: string
    org: string
    sourceGroupsExcluded: false
    sourceIds:
        - string
    vdcGroupId: string
Copy

NsxtDistributedFirewallRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NsxtDistributedFirewallRule resource accepts the following input properties:

Action This property is required. string
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
VdcGroupId This property is required. string
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
AboveRuleId string

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

AppPortProfileIds List<string>
An optional set of Application Port Profiles.
Comment string
Comment field shown in UI
Description string
Description of firewall rule (not shown in UI)
DestinationGroupsExcluded bool
reverses value of destination_ids for the rule to match everything except specified IDs.
DestinationIds List<string>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
Direction string
One of IN, OUT, or IN_OUT. (default IN_OUT)
Enabled bool
Defines if the rule is enabled (default true)
IpProtocol string
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
Logging bool
Defines if logging for this rule is enabled (default false)
Name string
Explanatory name for firewall rule (uniqueness not enforced)
NetworkContextProfileIds List<string>
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
NsxtDistributedFirewallRuleId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
SourceGroupsExcluded bool
reverses value of source_ids for the rule to match everything except specified IDs.
SourceIds List<string>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
Action This property is required. string
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
VdcGroupId This property is required. string
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
AboveRuleId string

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

AppPortProfileIds []string
An optional set of Application Port Profiles.
Comment string
Comment field shown in UI
Description string
Description of firewall rule (not shown in UI)
DestinationGroupsExcluded bool
reverses value of destination_ids for the rule to match everything except specified IDs.
DestinationIds []string
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
Direction string
One of IN, OUT, or IN_OUT. (default IN_OUT)
Enabled bool
Defines if the rule is enabled (default true)
IpProtocol string
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
Logging bool
Defines if logging for this rule is enabled (default false)
Name string
Explanatory name for firewall rule (uniqueness not enforced)
NetworkContextProfileIds []string
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
NsxtDistributedFirewallRuleId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
SourceGroupsExcluded bool
reverses value of source_ids for the rule to match everything except specified IDs.
SourceIds []string
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
action This property is required. String
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
vdcGroupId This property is required. String
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
aboveRuleId String

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

appPortProfileIds List<String>
An optional set of Application Port Profiles.
comment String
Comment field shown in UI
description String
Description of firewall rule (not shown in UI)
destinationGroupsExcluded Boolean
reverses value of destination_ids for the rule to match everything except specified IDs.
destinationIds List<String>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
direction String
One of IN, OUT, or IN_OUT. (default IN_OUT)
enabled Boolean
Defines if the rule is enabled (default true)
ipProtocol String
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
logging Boolean
Defines if logging for this rule is enabled (default false)
name String
Explanatory name for firewall rule (uniqueness not enforced)
networkContextProfileIds List<String>
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
nsxtDistributedFirewallRuleId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
sourceGroupsExcluded Boolean
reverses value of source_ids for the rule to match everything except specified IDs.
sourceIds List<String>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
action This property is required. string
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
vdcGroupId This property is required. string
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
aboveRuleId string

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

appPortProfileIds string[]
An optional set of Application Port Profiles.
comment string
Comment field shown in UI
description string
Description of firewall rule (not shown in UI)
destinationGroupsExcluded boolean
reverses value of destination_ids for the rule to match everything except specified IDs.
destinationIds string[]
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
direction string
One of IN, OUT, or IN_OUT. (default IN_OUT)
enabled boolean
Defines if the rule is enabled (default true)
ipProtocol string
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
logging boolean
Defines if logging for this rule is enabled (default false)
name string
Explanatory name for firewall rule (uniqueness not enforced)
networkContextProfileIds string[]
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
nsxtDistributedFirewallRuleId string
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
sourceGroupsExcluded boolean
reverses value of source_ids for the rule to match everything except specified IDs.
sourceIds string[]
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
action This property is required. str
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
vdc_group_id This property is required. str
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
above_rule_id str

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

app_port_profile_ids Sequence[str]
An optional set of Application Port Profiles.
comment str
Comment field shown in UI
description str
Description of firewall rule (not shown in UI)
destination_groups_excluded bool
reverses value of destination_ids for the rule to match everything except specified IDs.
destination_ids Sequence[str]
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
direction str
One of IN, OUT, or IN_OUT. (default IN_OUT)
enabled bool
Defines if the rule is enabled (default true)
ip_protocol str
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
logging bool
Defines if logging for this rule is enabled (default false)
name str
Explanatory name for firewall rule (uniqueness not enforced)
network_context_profile_ids Sequence[str]
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
nsxt_distributed_firewall_rule_id str
org str
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
source_groups_excluded bool
reverses value of source_ids for the rule to match everything except specified IDs.
source_ids Sequence[str]
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
action This property is required. String
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
vdcGroupId This property is required. String
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
aboveRuleId String

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

appPortProfileIds List<String>
An optional set of Application Port Profiles.
comment String
Comment field shown in UI
description String
Description of firewall rule (not shown in UI)
destinationGroupsExcluded Boolean
reverses value of destination_ids for the rule to match everything except specified IDs.
destinationIds List<String>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
direction String
One of IN, OUT, or IN_OUT. (default IN_OUT)
enabled Boolean
Defines if the rule is enabled (default true)
ipProtocol String
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
logging Boolean
Defines if logging for this rule is enabled (default false)
name String
Explanatory name for firewall rule (uniqueness not enforced)
networkContextProfileIds List<String>
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
nsxtDistributedFirewallRuleId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
sourceGroupsExcluded Boolean
reverses value of source_ids for the rule to match everything except specified IDs.
sourceIds List<String>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)

Outputs

All input properties are implicitly available as output properties. Additionally, the NsxtDistributedFirewallRule resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing NsxtDistributedFirewallRule Resource

Get an existing NsxtDistributedFirewallRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NsxtDistributedFirewallRuleState, opts?: CustomResourceOptions): NsxtDistributedFirewallRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        above_rule_id: Optional[str] = None,
        action: Optional[str] = None,
        app_port_profile_ids: Optional[Sequence[str]] = None,
        comment: Optional[str] = None,
        description: Optional[str] = None,
        destination_groups_excluded: Optional[bool] = None,
        destination_ids: Optional[Sequence[str]] = None,
        direction: Optional[str] = None,
        enabled: Optional[bool] = None,
        ip_protocol: Optional[str] = None,
        logging: Optional[bool] = None,
        name: Optional[str] = None,
        network_context_profile_ids: Optional[Sequence[str]] = None,
        nsxt_distributed_firewall_rule_id: Optional[str] = None,
        org: Optional[str] = None,
        source_groups_excluded: Optional[bool] = None,
        source_ids: Optional[Sequence[str]] = None,
        vdc_group_id: Optional[str] = None) -> NsxtDistributedFirewallRule
func GetNsxtDistributedFirewallRule(ctx *Context, name string, id IDInput, state *NsxtDistributedFirewallRuleState, opts ...ResourceOption) (*NsxtDistributedFirewallRule, error)
public static NsxtDistributedFirewallRule Get(string name, Input<string> id, NsxtDistributedFirewallRuleState? state, CustomResourceOptions? opts = null)
public static NsxtDistributedFirewallRule get(String name, Output<String> id, NsxtDistributedFirewallRuleState state, CustomResourceOptions options)
resources:  _:    type: vcd:NsxtDistributedFirewallRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AboveRuleId string

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

Action string
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
AppPortProfileIds List<string>
An optional set of Application Port Profiles.
Comment string
Comment field shown in UI
Description string
Description of firewall rule (not shown in UI)
DestinationGroupsExcluded bool
reverses value of destination_ids for the rule to match everything except specified IDs.
DestinationIds List<string>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
Direction string
One of IN, OUT, or IN_OUT. (default IN_OUT)
Enabled bool
Defines if the rule is enabled (default true)
IpProtocol string
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
Logging bool
Defines if logging for this rule is enabled (default false)
Name string
Explanatory name for firewall rule (uniqueness not enforced)
NetworkContextProfileIds List<string>
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
NsxtDistributedFirewallRuleId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
SourceGroupsExcluded bool
reverses value of source_ids for the rule to match everything except specified IDs.
SourceIds List<string>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
VdcGroupId string
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
AboveRuleId string

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

Action string
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
AppPortProfileIds []string
An optional set of Application Port Profiles.
Comment string
Comment field shown in UI
Description string
Description of firewall rule (not shown in UI)
DestinationGroupsExcluded bool
reverses value of destination_ids for the rule to match everything except specified IDs.
DestinationIds []string
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
Direction string
One of IN, OUT, or IN_OUT. (default IN_OUT)
Enabled bool
Defines if the rule is enabled (default true)
IpProtocol string
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
Logging bool
Defines if logging for this rule is enabled (default false)
Name string
Explanatory name for firewall rule (uniqueness not enforced)
NetworkContextProfileIds []string
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
NsxtDistributedFirewallRuleId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
SourceGroupsExcluded bool
reverses value of source_ids for the rule to match everything except specified IDs.
SourceIds []string
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
VdcGroupId string
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
aboveRuleId String

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

action String
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
appPortProfileIds List<String>
An optional set of Application Port Profiles.
comment String
Comment field shown in UI
description String
Description of firewall rule (not shown in UI)
destinationGroupsExcluded Boolean
reverses value of destination_ids for the rule to match everything except specified IDs.
destinationIds List<String>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
direction String
One of IN, OUT, or IN_OUT. (default IN_OUT)
enabled Boolean
Defines if the rule is enabled (default true)
ipProtocol String
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
logging Boolean
Defines if logging for this rule is enabled (default false)
name String
Explanatory name for firewall rule (uniqueness not enforced)
networkContextProfileIds List<String>
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
nsxtDistributedFirewallRuleId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
sourceGroupsExcluded Boolean
reverses value of source_ids for the rule to match everything except specified IDs.
sourceIds List<String>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
vdcGroupId String
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
aboveRuleId string

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

action string
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
appPortProfileIds string[]
An optional set of Application Port Profiles.
comment string
Comment field shown in UI
description string
Description of firewall rule (not shown in UI)
destinationGroupsExcluded boolean
reverses value of destination_ids for the rule to match everything except specified IDs.
destinationIds string[]
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
direction string
One of IN, OUT, or IN_OUT. (default IN_OUT)
enabled boolean
Defines if the rule is enabled (default true)
ipProtocol string
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
logging boolean
Defines if logging for this rule is enabled (default false)
name string
Explanatory name for firewall rule (uniqueness not enforced)
networkContextProfileIds string[]
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
nsxtDistributedFirewallRuleId string
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
sourceGroupsExcluded boolean
reverses value of source_ids for the rule to match everything except specified IDs.
sourceIds string[]
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
vdcGroupId string
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
above_rule_id str

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

action str
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
app_port_profile_ids Sequence[str]
An optional set of Application Port Profiles.
comment str
Comment field shown in UI
description str
Description of firewall rule (not shown in UI)
destination_groups_excluded bool
reverses value of destination_ids for the rule to match everything except specified IDs.
destination_ids Sequence[str]
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
direction str
One of IN, OUT, or IN_OUT. (default IN_OUT)
enabled bool
Defines if the rule is enabled (default true)
ip_protocol str
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
logging bool
Defines if logging for this rule is enabled (default false)
name str
Explanatory name for firewall rule (uniqueness not enforced)
network_context_profile_ids Sequence[str]
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
nsxt_distributed_firewall_rule_id str
org str
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
source_groups_excluded bool
reverses value of source_ids for the rule to match everything except specified IDs.
source_ids Sequence[str]
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
vdc_group_id str
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.
aboveRuleId String

ID of an existing vcd.NsxtDistributedFirewallRule entry, above which the newly created firewall rule will be positioned. Note. By default, new rule will be created at the bottom of the list

When activating Distributed Firewall with resource vcd.VdcGroup, there is a default firewall rule created which can make inconvenient to use this resource. For that reason, resource vcd.VdcGroup has a parameter remove_default_firewall_rule which can remove default firewall rule.

action String
Defines if it should ALLOW, DROP, REJECT traffic. REJECT is only supported in VCD 10.2.2+
appPortProfileIds List<String>
An optional set of Application Port Profiles.
comment String
Comment field shown in UI
description String
Description of firewall rule (not shown in UI)
destinationGroupsExcluded Boolean
reverses value of destination_ids for the rule to match everything except specified IDs.
destinationIds List<String>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
direction String
One of IN, OUT, or IN_OUT. (default IN_OUT)
enabled Boolean
Defines if the rule is enabled (default true)
ipProtocol String
One of IPV4, IPV6, or IPV4_IPV6 (default IPV4_IPV6)
logging Boolean
Defines if logging for this rule is enabled (default false)
name String
Explanatory name for firewall rule (uniqueness not enforced)
networkContextProfileIds List<String>
An optional set of Network Context Profiles. Can be looked up using vcd.getNsxtNetworkContextProfile data source.
nsxtDistributedFirewallRuleId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
sourceGroupsExcluded Boolean
reverses value of source_ids for the rule to match everything except specified IDs.
sourceIds List<String>
A set of source object Firewall Groups (IP Sets or Security groups). Leaving it empty matches Any (all)
vdcGroupId String
The ID of VDC Group to manage Distributed Firewall in. Can be looked up using vcd.VdcGroup resource or data source.

Package Details

Repository
vcd vmware/terraform-provider-vcd
License
Notes
This Pulumi package is based on the vcd Terraform Provider.
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd