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

vcd.Edgegateway

Explore with Pulumi AI

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

Create Edgegateway Resource

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

Constructor syntax

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

@overload
def Edgegateway(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                external_networks: Optional[Sequence[EdgegatewayExternalNetworkArgs]] = None,
                configuration: Optional[str] = None,
                fw_enabled: Optional[bool] = None,
                ha_enabled: Optional[bool] = None,
                distributed_routing: Optional[bool] = None,
                fips_mode_enabled: Optional[bool] = None,
                fw_default_rule_action: Optional[str] = None,
                fw_default_rule_logging_enabled: Optional[bool] = None,
                description: Optional[str] = None,
                edgegateway_id: Optional[str] = None,
                lb_acceleration_enabled: Optional[bool] = None,
                lb_enabled: Optional[bool] = None,
                lb_logging_enabled: Optional[bool] = None,
                lb_loglevel: Optional[str] = None,
                name: Optional[str] = None,
                org: Optional[str] = None,
                use_default_route_for_dns_relay: Optional[bool] = None,
                vdc: Optional[str] = None)
func NewEdgegateway(ctx *Context, name string, args EdgegatewayArgs, opts ...ResourceOption) (*Edgegateway, error)
public Edgegateway(string name, EdgegatewayArgs args, CustomResourceOptions? opts = null)
public Edgegateway(String name, EdgegatewayArgs args)
public Edgegateway(String name, EdgegatewayArgs args, CustomResourceOptions options)

type: vcd:Edgegateway
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. EdgegatewayArgs
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. EdgegatewayArgs
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. EdgegatewayArgs
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. EdgegatewayArgs
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. EdgegatewayArgs
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 edgegatewayResource = new Vcd.Edgegateway("edgegatewayResource", new()
{
    ExternalNetworks = new[]
    {
        new Vcd.Inputs.EdgegatewayExternalNetworkArgs
        {
            Name = "string",
            EnableRateLimit = false,
            IncomingRateLimit = 0,
            OutgoingRateLimit = 0,
            Subnets = new[]
            {
                new Vcd.Inputs.EdgegatewayExternalNetworkSubnetArgs
                {
                    Gateway = "string",
                    Netmask = "string",
                    IpAddress = "string",
                    SuballocatePools = new[]
                    {
                        new Vcd.Inputs.EdgegatewayExternalNetworkSubnetSuballocatePoolArgs
                        {
                            EndAddress = "string",
                            StartAddress = "string",
                        },
                    },
                    UseForDefaultRoute = false,
                },
            },
        },
    },
    Configuration = "string",
    FwEnabled = false,
    HaEnabled = false,
    DistributedRouting = false,
    FipsModeEnabled = false,
    FwDefaultRuleAction = "string",
    FwDefaultRuleLoggingEnabled = false,
    Description = "string",
    EdgegatewayId = "string",
    LbAccelerationEnabled = false,
    LbEnabled = false,
    LbLoggingEnabled = false,
    LbLoglevel = "string",
    Name = "string",
    Org = "string",
    UseDefaultRouteForDnsRelay = false,
    Vdc = "string",
});
Copy
example, err := vcd.NewEdgegateway(ctx, "edgegatewayResource", &vcd.EdgegatewayArgs{
ExternalNetworks: .EdgegatewayExternalNetworkArray{
&.EdgegatewayExternalNetworkArgs{
Name: pulumi.String("string"),
EnableRateLimit: pulumi.Bool(false),
IncomingRateLimit: pulumi.Float64(0),
OutgoingRateLimit: pulumi.Float64(0),
Subnets: .EdgegatewayExternalNetworkSubnetArray{
&.EdgegatewayExternalNetworkSubnetArgs{
Gateway: pulumi.String("string"),
Netmask: pulumi.String("string"),
IpAddress: pulumi.String("string"),
SuballocatePools: .EdgegatewayExternalNetworkSubnetSuballocatePoolArray{
&.EdgegatewayExternalNetworkSubnetSuballocatePoolArgs{
EndAddress: pulumi.String("string"),
StartAddress: pulumi.String("string"),
},
},
UseForDefaultRoute: pulumi.Bool(false),
},
},
},
},
Configuration: pulumi.String("string"),
FwEnabled: pulumi.Bool(false),
HaEnabled: pulumi.Bool(false),
DistributedRouting: pulumi.Bool(false),
FipsModeEnabled: pulumi.Bool(false),
FwDefaultRuleAction: pulumi.String("string"),
FwDefaultRuleLoggingEnabled: pulumi.Bool(false),
Description: pulumi.String("string"),
EdgegatewayId: pulumi.String("string"),
LbAccelerationEnabled: pulumi.Bool(false),
LbEnabled: pulumi.Bool(false),
LbLoggingEnabled: pulumi.Bool(false),
LbLoglevel: pulumi.String("string"),
Name: pulumi.String("string"),
Org: pulumi.String("string"),
UseDefaultRouteForDnsRelay: pulumi.Bool(false),
Vdc: pulumi.String("string"),
})
Copy
var edgegatewayResource = new Edgegateway("edgegatewayResource", EdgegatewayArgs.builder()
    .externalNetworks(EdgegatewayExternalNetworkArgs.builder()
        .name("string")
        .enableRateLimit(false)
        .incomingRateLimit(0)
        .outgoingRateLimit(0)
        .subnets(EdgegatewayExternalNetworkSubnetArgs.builder()
            .gateway("string")
            .netmask("string")
            .ipAddress("string")
            .suballocatePools(EdgegatewayExternalNetworkSubnetSuballocatePoolArgs.builder()
                .endAddress("string")
                .startAddress("string")
                .build())
            .useForDefaultRoute(false)
            .build())
        .build())
    .configuration("string")
    .fwEnabled(false)
    .haEnabled(false)
    .distributedRouting(false)
    .fipsModeEnabled(false)
    .fwDefaultRuleAction("string")
    .fwDefaultRuleLoggingEnabled(false)
    .description("string")
    .edgegatewayId("string")
    .lbAccelerationEnabled(false)
    .lbEnabled(false)
    .lbLoggingEnabled(false)
    .lbLoglevel("string")
    .name("string")
    .org("string")
    .useDefaultRouteForDnsRelay(false)
    .vdc("string")
    .build());
Copy
edgegateway_resource = vcd.Edgegateway("edgegatewayResource",
    external_networks=[{
        "name": "string",
        "enable_rate_limit": False,
        "incoming_rate_limit": 0,
        "outgoing_rate_limit": 0,
        "subnets": [{
            "gateway": "string",
            "netmask": "string",
            "ip_address": "string",
            "suballocate_pools": [{
                "end_address": "string",
                "start_address": "string",
            }],
            "use_for_default_route": False,
        }],
    }],
    configuration="string",
    fw_enabled=False,
    ha_enabled=False,
    distributed_routing=False,
    fips_mode_enabled=False,
    fw_default_rule_action="string",
    fw_default_rule_logging_enabled=False,
    description="string",
    edgegateway_id="string",
    lb_acceleration_enabled=False,
    lb_enabled=False,
    lb_logging_enabled=False,
    lb_loglevel="string",
    name="string",
    org="string",
    use_default_route_for_dns_relay=False,
    vdc="string")
Copy
const edgegatewayResource = new vcd.Edgegateway("edgegatewayResource", {
    externalNetworks: [{
        name: "string",
        enableRateLimit: false,
        incomingRateLimit: 0,
        outgoingRateLimit: 0,
        subnets: [{
            gateway: "string",
            netmask: "string",
            ipAddress: "string",
            suballocatePools: [{
                endAddress: "string",
                startAddress: "string",
            }],
            useForDefaultRoute: false,
        }],
    }],
    configuration: "string",
    fwEnabled: false,
    haEnabled: false,
    distributedRouting: false,
    fipsModeEnabled: false,
    fwDefaultRuleAction: "string",
    fwDefaultRuleLoggingEnabled: false,
    description: "string",
    edgegatewayId: "string",
    lbAccelerationEnabled: false,
    lbEnabled: false,
    lbLoggingEnabled: false,
    lbLoglevel: "string",
    name: "string",
    org: "string",
    useDefaultRouteForDnsRelay: false,
    vdc: "string",
});
Copy
type: vcd:Edgegateway
properties:
    configuration: string
    description: string
    distributedRouting: false
    edgegatewayId: string
    externalNetworks:
        - enableRateLimit: false
          incomingRateLimit: 0
          name: string
          outgoingRateLimit: 0
          subnets:
            - gateway: string
              ipAddress: string
              netmask: string
              suballocatePools:
                - endAddress: string
                  startAddress: string
              useForDefaultRoute: false
    fipsModeEnabled: false
    fwDefaultRuleAction: string
    fwDefaultRuleLoggingEnabled: false
    fwEnabled: false
    haEnabled: false
    lbAccelerationEnabled: false
    lbEnabled: false
    lbLoggingEnabled: false
    lbLoglevel: string
    name: string
    org: string
    useDefaultRouteForDnsRelay: false
    vdc: string
Copy

Edgegateway 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 Edgegateway resource accepts the following input properties:

Configuration This property is required. string
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
ExternalNetworks This property is required. List<EdgegatewayExternalNetwork>
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
Description string
DistributedRouting bool
If advanced networking enabled, also enable distributed routing. Default is false.
EdgegatewayId string
FipsModeEnabled bool
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
FwDefaultRuleAction string

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

FwDefaultRuleLoggingEnabled bool
Enable default firewall rule (last in the processing order) logging. Default false.
FwEnabled bool
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
HaEnabled bool
Enable high availability on this edge gateway. Default is false.
LbAccelerationEnabled bool
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
LbEnabled bool
Enable load balancing. Default is false.
LbLoggingEnabled bool
Enables the edge gateway load balancer to collect traffic logs. Default is false.
LbLoglevel string
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
Name string
A unique name for the edge gateway.
Org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
UseDefaultRouteForDnsRelay bool
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
Vdc string
The name of VDC that owns the edge gateway. Optional if defined at provider level.
Configuration This property is required. string
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
ExternalNetworks This property is required. []EdgegatewayExternalNetworkArgs
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
Description string
DistributedRouting bool
If advanced networking enabled, also enable distributed routing. Default is false.
EdgegatewayId string
FipsModeEnabled bool
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
FwDefaultRuleAction string

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

FwDefaultRuleLoggingEnabled bool
Enable default firewall rule (last in the processing order) logging. Default false.
FwEnabled bool
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
HaEnabled bool
Enable high availability on this edge gateway. Default is false.
LbAccelerationEnabled bool
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
LbEnabled bool
Enable load balancing. Default is false.
LbLoggingEnabled bool
Enables the edge gateway load balancer to collect traffic logs. Default is false.
LbLoglevel string
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
Name string
A unique name for the edge gateway.
Org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
UseDefaultRouteForDnsRelay bool
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
Vdc string
The name of VDC that owns the edge gateway. Optional if defined at provider level.
configuration This property is required. String
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
externalNetworks This property is required. List<EdgegatewayExternalNetwork>
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
description String
distributedRouting Boolean
If advanced networking enabled, also enable distributed routing. Default is false.
edgegatewayId String
fipsModeEnabled Boolean
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
fwDefaultRuleAction String

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

fwDefaultRuleLoggingEnabled Boolean
Enable default firewall rule (last in the processing order) logging. Default false.
fwEnabled Boolean
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
haEnabled Boolean
Enable high availability on this edge gateway. Default is false.
lbAccelerationEnabled Boolean
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
lbEnabled Boolean
Enable load balancing. Default is false.
lbLoggingEnabled Boolean
Enables the edge gateway load balancer to collect traffic logs. Default is false.
lbLoglevel String
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
name String
A unique name for the edge gateway.
org String
The name of organization to which the VDC belongs. Optional if defined at provider level.
useDefaultRouteForDnsRelay Boolean
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
vdc String
The name of VDC that owns the edge gateway. Optional if defined at provider level.
configuration This property is required. string
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
externalNetworks This property is required. EdgegatewayExternalNetwork[]
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
description string
distributedRouting boolean
If advanced networking enabled, also enable distributed routing. Default is false.
edgegatewayId string
fipsModeEnabled boolean
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
fwDefaultRuleAction string

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

fwDefaultRuleLoggingEnabled boolean
Enable default firewall rule (last in the processing order) logging. Default false.
fwEnabled boolean
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
haEnabled boolean
Enable high availability on this edge gateway. Default is false.
lbAccelerationEnabled boolean
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
lbEnabled boolean
Enable load balancing. Default is false.
lbLoggingEnabled boolean
Enables the edge gateway load balancer to collect traffic logs. Default is false.
lbLoglevel string
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
name string
A unique name for the edge gateway.
org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
useDefaultRouteForDnsRelay boolean
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
vdc string
The name of VDC that owns the edge gateway. Optional if defined at provider level.
configuration This property is required. str
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
external_networks This property is required. Sequence[EdgegatewayExternalNetworkArgs]
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
description str
distributed_routing bool
If advanced networking enabled, also enable distributed routing. Default is false.
edgegateway_id str
fips_mode_enabled bool
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
fw_default_rule_action str

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

fw_default_rule_logging_enabled bool
Enable default firewall rule (last in the processing order) logging. Default false.
fw_enabled bool
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
ha_enabled bool
Enable high availability on this edge gateway. Default is false.
lb_acceleration_enabled bool
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
lb_enabled bool
Enable load balancing. Default is false.
lb_logging_enabled bool
Enables the edge gateway load balancer to collect traffic logs. Default is false.
lb_loglevel str
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
name str
A unique name for the edge gateway.
org str
The name of organization to which the VDC belongs. Optional if defined at provider level.
use_default_route_for_dns_relay bool
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
vdc str
The name of VDC that owns the edge gateway. Optional if defined at provider level.
configuration This property is required. String
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
externalNetworks This property is required. List<Property Map>
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
description String
distributedRouting Boolean
If advanced networking enabled, also enable distributed routing. Default is false.
edgegatewayId String
fipsModeEnabled Boolean
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
fwDefaultRuleAction String

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

fwDefaultRuleLoggingEnabled Boolean
Enable default firewall rule (last in the processing order) logging. Default false.
fwEnabled Boolean
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
haEnabled Boolean
Enable high availability on this edge gateway. Default is false.
lbAccelerationEnabled Boolean
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
lbEnabled Boolean
Enable load balancing. Default is false.
lbLoggingEnabled Boolean
Enables the edge gateway load balancer to collect traffic logs. Default is false.
lbLoglevel String
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
name String
A unique name for the edge gateway.
org String
The name of organization to which the VDC belongs. Optional if defined at provider level.
useDefaultRouteForDnsRelay Boolean
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
vdc String
The name of VDC that owns the edge gateway. Optional if defined at provider level.

Outputs

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

DefaultExternalNetworkIp string
(v2.6+) - IP address of edge gateway used for default network
ExternalNetworkIps List<string>
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
Id string
The provider-assigned unique ID for this managed resource.
DefaultExternalNetworkIp string
(v2.6+) - IP address of edge gateway used for default network
ExternalNetworkIps []string
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
Id string
The provider-assigned unique ID for this managed resource.
defaultExternalNetworkIp String
(v2.6+) - IP address of edge gateway used for default network
externalNetworkIps List<String>
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
id String
The provider-assigned unique ID for this managed resource.
defaultExternalNetworkIp string
(v2.6+) - IP address of edge gateway used for default network
externalNetworkIps string[]
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
id string
The provider-assigned unique ID for this managed resource.
default_external_network_ip str
(v2.6+) - IP address of edge gateway used for default network
external_network_ips Sequence[str]
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
id str
The provider-assigned unique ID for this managed resource.
defaultExternalNetworkIp String
(v2.6+) - IP address of edge gateway used for default network
externalNetworkIps List<String>
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Edgegateway Resource

Get an existing Edgegateway 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?: EdgegatewayState, opts?: CustomResourceOptions): Edgegateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[str] = None,
        default_external_network_ip: Optional[str] = None,
        description: Optional[str] = None,
        distributed_routing: Optional[bool] = None,
        edgegateway_id: Optional[str] = None,
        external_network_ips: Optional[Sequence[str]] = None,
        external_networks: Optional[Sequence[EdgegatewayExternalNetworkArgs]] = None,
        fips_mode_enabled: Optional[bool] = None,
        fw_default_rule_action: Optional[str] = None,
        fw_default_rule_logging_enabled: Optional[bool] = None,
        fw_enabled: Optional[bool] = None,
        ha_enabled: Optional[bool] = None,
        lb_acceleration_enabled: Optional[bool] = None,
        lb_enabled: Optional[bool] = None,
        lb_logging_enabled: Optional[bool] = None,
        lb_loglevel: Optional[str] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        use_default_route_for_dns_relay: Optional[bool] = None,
        vdc: Optional[str] = None) -> Edgegateway
func GetEdgegateway(ctx *Context, name string, id IDInput, state *EdgegatewayState, opts ...ResourceOption) (*Edgegateway, error)
public static Edgegateway Get(string name, Input<string> id, EdgegatewayState? state, CustomResourceOptions? opts = null)
public static Edgegateway get(String name, Output<String> id, EdgegatewayState state, CustomResourceOptions options)
resources:  _:    type: vcd:Edgegateway    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:
Configuration string
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
DefaultExternalNetworkIp string
(v2.6+) - IP address of edge gateway used for default network
Description string
DistributedRouting bool
If advanced networking enabled, also enable distributed routing. Default is false.
EdgegatewayId string
ExternalNetworkIps List<string>
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
ExternalNetworks List<EdgegatewayExternalNetwork>
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
FipsModeEnabled bool
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
FwDefaultRuleAction string

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

FwDefaultRuleLoggingEnabled bool
Enable default firewall rule (last in the processing order) logging. Default false.
FwEnabled bool
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
HaEnabled bool
Enable high availability on this edge gateway. Default is false.
LbAccelerationEnabled bool
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
LbEnabled bool
Enable load balancing. Default is false.
LbLoggingEnabled bool
Enables the edge gateway load balancer to collect traffic logs. Default is false.
LbLoglevel string
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
Name string
A unique name for the edge gateway.
Org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
UseDefaultRouteForDnsRelay bool
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
Vdc string
The name of VDC that owns the edge gateway. Optional if defined at provider level.
Configuration string
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
DefaultExternalNetworkIp string
(v2.6+) - IP address of edge gateway used for default network
Description string
DistributedRouting bool
If advanced networking enabled, also enable distributed routing. Default is false.
EdgegatewayId string
ExternalNetworkIps []string
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
ExternalNetworks []EdgegatewayExternalNetworkArgs
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
FipsModeEnabled bool
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
FwDefaultRuleAction string

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

FwDefaultRuleLoggingEnabled bool
Enable default firewall rule (last in the processing order) logging. Default false.
FwEnabled bool
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
HaEnabled bool
Enable high availability on this edge gateway. Default is false.
LbAccelerationEnabled bool
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
LbEnabled bool
Enable load balancing. Default is false.
LbLoggingEnabled bool
Enables the edge gateway load balancer to collect traffic logs. Default is false.
LbLoglevel string
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
Name string
A unique name for the edge gateway.
Org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
UseDefaultRouteForDnsRelay bool
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
Vdc string
The name of VDC that owns the edge gateway. Optional if defined at provider level.
configuration String
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
defaultExternalNetworkIp String
(v2.6+) - IP address of edge gateway used for default network
description String
distributedRouting Boolean
If advanced networking enabled, also enable distributed routing. Default is false.
edgegatewayId String
externalNetworkIps List<String>
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
externalNetworks List<EdgegatewayExternalNetwork>
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
fipsModeEnabled Boolean
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
fwDefaultRuleAction String

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

fwDefaultRuleLoggingEnabled Boolean
Enable default firewall rule (last in the processing order) logging. Default false.
fwEnabled Boolean
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
haEnabled Boolean
Enable high availability on this edge gateway. Default is false.
lbAccelerationEnabled Boolean
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
lbEnabled Boolean
Enable load balancing. Default is false.
lbLoggingEnabled Boolean
Enables the edge gateway load balancer to collect traffic logs. Default is false.
lbLoglevel String
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
name String
A unique name for the edge gateway.
org String
The name of organization to which the VDC belongs. Optional if defined at provider level.
useDefaultRouteForDnsRelay Boolean
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
vdc String
The name of VDC that owns the edge gateway. Optional if defined at provider level.
configuration string
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
defaultExternalNetworkIp string
(v2.6+) - IP address of edge gateway used for default network
description string
distributedRouting boolean
If advanced networking enabled, also enable distributed routing. Default is false.
edgegatewayId string
externalNetworkIps string[]
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
externalNetworks EdgegatewayExternalNetwork[]
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
fipsModeEnabled boolean
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
fwDefaultRuleAction string

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

fwDefaultRuleLoggingEnabled boolean
Enable default firewall rule (last in the processing order) logging. Default false.
fwEnabled boolean
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
haEnabled boolean
Enable high availability on this edge gateway. Default is false.
lbAccelerationEnabled boolean
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
lbEnabled boolean
Enable load balancing. Default is false.
lbLoggingEnabled boolean
Enables the edge gateway load balancer to collect traffic logs. Default is false.
lbLoglevel string
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
name string
A unique name for the edge gateway.
org string
The name of organization to which the VDC belongs. Optional if defined at provider level.
useDefaultRouteForDnsRelay boolean
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
vdc string
The name of VDC that owns the edge gateway. Optional if defined at provider level.
configuration str
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
default_external_network_ip str
(v2.6+) - IP address of edge gateway used for default network
description str
distributed_routing bool
If advanced networking enabled, also enable distributed routing. Default is false.
edgegateway_id str
external_network_ips Sequence[str]
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
external_networks Sequence[EdgegatewayExternalNetworkArgs]
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
fips_mode_enabled bool
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
fw_default_rule_action str

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

fw_default_rule_logging_enabled bool
Enable default firewall rule (last in the processing order) logging. Default false.
fw_enabled bool
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
ha_enabled bool
Enable high availability on this edge gateway. Default is false.
lb_acceleration_enabled bool
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
lb_enabled bool
Enable load balancing. Default is false.
lb_logging_enabled bool
Enables the edge gateway load balancer to collect traffic logs. Default is false.
lb_loglevel str
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
name str
A unique name for the edge gateway.
org str
The name of organization to which the VDC belongs. Optional if defined at provider level.
use_default_route_for_dns_relay bool
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
vdc str
The name of VDC that owns the edge gateway. Optional if defined at provider level.
configuration String
Configuration of the vShield edge VM for this gateway. One of: compact, full ("Large"), x-large, full4 ("Quad Large").
defaultExternalNetworkIp String
(v2.6+) - IP address of edge gateway used for default network
description String
distributedRouting Boolean
If advanced networking enabled, also enable distributed routing. Default is false.
edgegatewayId String
externalNetworkIps List<String>
(v2.6+) - A list of IP addresses assigned to edge gateway interfaces connected to external networks.
externalNetworks List<Property Map>
One or more blocks defining external networks, their subnets, IP addresses and IP pool suballocation attached to edge gateway interfaces. Details are in external network block below.
fipsModeEnabled Boolean
When FIPS mode is enabled, any secure communication to or from the NSX Edge uses cryptographic algorithms or protocols that are allowed by United States Federal Information Processing Standards (FIPS). FIPS mode turns on the cipher suites that comply with FIPS. Default is false. Note: to use FIPS mode it must be enabled in vCD system settings.
fwDefaultRuleAction String

Default firewall rule (last in the processing order) action. One of accept or deny. Default deny.

fwDefaultRuleLoggingEnabled Boolean
Enable default firewall rule (last in the processing order) logging. Default false.
fwEnabled Boolean
Enable firewall. Default true. Note: Disabling Firewall will also disable NAT and other NAT dependent features like Load Balancer.
haEnabled Boolean
Enable high availability on this edge gateway. Default is false.
lbAccelerationEnabled Boolean
Enable to configure the load balancer to use the faster L4 engine rather than L7 engine. The L4 TCP VIP is processed before the edge gateway firewall so no allow firewall rule is required. Default is false. Note: L7 VIPs for HTTP and HTTPS are processed after the firewall, so when Acceleration Enabled is not selected, an edge gateway firewall rule must exist to allow access to the L7 VIP for those protocols. When Acceleration Enabled is selected and the server pool is in non-transparent mode, an SNAT rule is added, so you must ensure that the firewall is enabled on the edge gateway.
lbEnabled Boolean
Enable load balancing. Default is false.
lbLoggingEnabled Boolean
Enables the edge gateway load balancer to collect traffic logs. Default is false.
lbLoglevel String
Choose the severity of events to be logged. One of emergency, alert, critical, error, warning, notice, info, debug
name String
A unique name for the edge gateway.
org String
The name of organization to which the VDC belongs. Optional if defined at provider level.
useDefaultRouteForDnsRelay Boolean
When default route is set, it will be used for gateways' default routing and DNS forwarding. Default is false.
vdc String
The name of VDC that owns the edge gateway. Optional if defined at provider level.

Supporting Types

EdgegatewayExternalNetwork
, EdgegatewayExternalNetworkArgs

Name This property is required. string
A unique name for the edge gateway.
EnableRateLimit bool
Enable rate limiting
IncomingRateLimit double
Incoming rate limit (Mbps)
OutgoingRateLimit double
Outgoing rate limit (Mbps)
Subnets List<EdgegatewayExternalNetworkSubnet>
Name This property is required. string
A unique name for the edge gateway.
EnableRateLimit bool
Enable rate limiting
IncomingRateLimit float64
Incoming rate limit (Mbps)
OutgoingRateLimit float64
Outgoing rate limit (Mbps)
Subnets []EdgegatewayExternalNetworkSubnet
name This property is required. String
A unique name for the edge gateway.
enableRateLimit Boolean
Enable rate limiting
incomingRateLimit Double
Incoming rate limit (Mbps)
outgoingRateLimit Double
Outgoing rate limit (Mbps)
subnets List<EdgegatewayExternalNetworkSubnet>
name This property is required. string
A unique name for the edge gateway.
enableRateLimit boolean
Enable rate limiting
incomingRateLimit number
Incoming rate limit (Mbps)
outgoingRateLimit number
Outgoing rate limit (Mbps)
subnets EdgegatewayExternalNetworkSubnet[]
name This property is required. str
A unique name for the edge gateway.
enable_rate_limit bool
Enable rate limiting
incoming_rate_limit float
Incoming rate limit (Mbps)
outgoing_rate_limit float
Outgoing rate limit (Mbps)
subnets Sequence[EdgegatewayExternalNetworkSubnet]
name This property is required. String
A unique name for the edge gateway.
enableRateLimit Boolean
Enable rate limiting
incomingRateLimit Number
Incoming rate limit (Mbps)
outgoingRateLimit Number
Outgoing rate limit (Mbps)
subnets List<Property Map>

EdgegatewayExternalNetworkSubnet
, EdgegatewayExternalNetworkSubnetArgs

Gateway This property is required. string
Gateway address for a subnet
Netmask This property is required. string
Netmask address for a subnet
IpAddress string
IP address on the edge gateway - will be auto-assigned if not defined
SuballocatePools List<EdgegatewayExternalNetworkSubnetSuballocatePool>
Define zero or more blocks to sub-allocate pools on the edge gateway
UseForDefaultRoute bool
Defines if this subnet should be used as default gateway for edge
Gateway This property is required. string
Gateway address for a subnet
Netmask This property is required. string
Netmask address for a subnet
IpAddress string
IP address on the edge gateway - will be auto-assigned if not defined
SuballocatePools []EdgegatewayExternalNetworkSubnetSuballocatePool
Define zero or more blocks to sub-allocate pools on the edge gateway
UseForDefaultRoute bool
Defines if this subnet should be used as default gateway for edge
gateway This property is required. String
Gateway address for a subnet
netmask This property is required. String
Netmask address for a subnet
ipAddress String
IP address on the edge gateway - will be auto-assigned if not defined
suballocatePools List<EdgegatewayExternalNetworkSubnetSuballocatePool>
Define zero or more blocks to sub-allocate pools on the edge gateway
useForDefaultRoute Boolean
Defines if this subnet should be used as default gateway for edge
gateway This property is required. string
Gateway address for a subnet
netmask This property is required. string
Netmask address for a subnet
ipAddress string
IP address on the edge gateway - will be auto-assigned if not defined
suballocatePools EdgegatewayExternalNetworkSubnetSuballocatePool[]
Define zero or more blocks to sub-allocate pools on the edge gateway
useForDefaultRoute boolean
Defines if this subnet should be used as default gateway for edge
gateway This property is required. str
Gateway address for a subnet
netmask This property is required. str
Netmask address for a subnet
ip_address str
IP address on the edge gateway - will be auto-assigned if not defined
suballocate_pools Sequence[EdgegatewayExternalNetworkSubnetSuballocatePool]
Define zero or more blocks to sub-allocate pools on the edge gateway
use_for_default_route bool
Defines if this subnet should be used as default gateway for edge
gateway This property is required. String
Gateway address for a subnet
netmask This property is required. String
Netmask address for a subnet
ipAddress String
IP address on the edge gateway - will be auto-assigned if not defined
suballocatePools List<Property Map>
Define zero or more blocks to sub-allocate pools on the edge gateway
useForDefaultRoute Boolean
Defines if this subnet should be used as default gateway for edge

EdgegatewayExternalNetworkSubnetSuballocatePool
, EdgegatewayExternalNetworkSubnetSuballocatePoolArgs

EndAddress This property is required. string
StartAddress This property is required. string
EndAddress This property is required. string
StartAddress This property is required. string
endAddress This property is required. String
startAddress This property is required. String
endAddress This property is required. string
startAddress This property is required. string
end_address This property is required. str
start_address This property is required. str
endAddress This property is required. String
startAddress This property is required. String

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