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

vcd.ExternalNetworkV2

Explore with Pulumi AI

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

    Create ExternalNetworkV2 Resource

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

    Constructor syntax

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

@overload
def ExternalNetworkV2(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      dedicated_org_id: Optional[str] = None,
                      description: Optional[str] = None,
                      external_network_v2_id: Optional[str] = None,
                      ip_scopes: Optional[Sequence[ExternalNetworkV2IpScopeArgs]] = None,
                      name: Optional[str] = None,
                      nat_and_firewall_service_intention: Optional[str] = None,
                      nsxt_network: Optional[ExternalNetworkV2NsxtNetworkArgs] = None,
                      route_advertisement_intention: Optional[str] = None,
                      use_ip_spaces: Optional[bool] = None,
                      vsphere_networks: Optional[Sequence[ExternalNetworkV2VsphereNetworkArgs]] = None)
    func NewExternalNetworkV2(ctx *Context, name string, args *ExternalNetworkV2Args, opts ...ResourceOption) (*ExternalNetworkV2, error)
    public ExternalNetworkV2(string name, ExternalNetworkV2Args? args = null, CustomResourceOptions? opts = null)
    public ExternalNetworkV2(String name, ExternalNetworkV2Args args)
public ExternalNetworkV2(String name, ExternalNetworkV2Args args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args ExternalNetworkV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ExternalNetworkV2Args
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ExternalNetworkV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExternalNetworkV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExternalNetworkV2Args
    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 externalNetworkV2Resource = new Vcd.ExternalNetworkV2("externalNetworkV2Resource", new()
{
    DedicatedOrgId = "string",
    Description = "string",
    ExternalNetworkV2Id = "string",
    IpScopes = new[]
    {
        new Vcd.Inputs.ExternalNetworkV2IpScopeArgs
        {
            Gateway = "string",
            PrefixLength = 0,
            Dns1 = "string",
            Dns2 = "string",
            DnsSuffix = "string",
            Enabled = false,
            StaticIpPools = new[]
            {
                new Vcd.Inputs.ExternalNetworkV2IpScopeStaticIpPoolArgs
                {
                    EndAddress = "string",
                    StartAddress = "string",
                },
            },
        },
    },
    Name = "string",
    NatAndFirewallServiceIntention = "string",
    NsxtNetwork = new Vcd.Inputs.ExternalNetworkV2NsxtNetworkArgs
    {
        NsxtManagerId = "string",
        NsxtSegmentName = "string",
        NsxtTier0RouterId = "string",
    },
    RouteAdvertisementIntention = "string",
    UseIpSpaces = false,
    VsphereNetworks = new[]
    {
        new Vcd.Inputs.ExternalNetworkV2VsphereNetworkArgs
        {
            PortgroupId = "string",
            VcenterId = "string",
        },
    },
});

    example, err := vcd.NewExternalNetworkV2(ctx, "externalNetworkV2Resource", &vcd.ExternalNetworkV2Args{
	DedicatedOrgId:      pulumi.String("string"),
	Description:         pulumi.String("string"),
	ExternalNetworkV2Id: pulumi.String("string"),
	IpScopes: vcd.ExternalNetworkV2IpScopeArray{
		&vcd.ExternalNetworkV2IpScopeArgs{
			Gateway:      pulumi.String("string"),
			PrefixLength: pulumi.Float64(0),
			Dns1:         pulumi.String("string"),
			Dns2:         pulumi.String("string"),
			DnsSuffix:    pulumi.String("string"),
			Enabled:      pulumi.Bool(false),
			StaticIpPools: vcd.ExternalNetworkV2IpScopeStaticIpPoolArray{
				&vcd.ExternalNetworkV2IpScopeStaticIpPoolArgs{
					EndAddress:   pulumi.String("string"),
					StartAddress: pulumi.String("string"),
				},
			},
		},
	},
	Name:                           pulumi.String("string"),
	NatAndFirewallServiceIntention: pulumi.String("string"),
	NsxtNetwork: &vcd.ExternalNetworkV2NsxtNetworkArgs{
		NsxtManagerId:     pulumi.String("string"),
		NsxtSegmentName:   pulumi.String("string"),
		NsxtTier0RouterId: pulumi.String("string"),
	},
	RouteAdvertisementIntention: pulumi.String("string"),
	UseIpSpaces:                 pulumi.Bool(false),
	VsphereNetworks: vcd.ExternalNetworkV2VsphereNetworkArray{
		&vcd.ExternalNetworkV2VsphereNetworkArgs{
			PortgroupId: pulumi.String("string"),
			VcenterId:   pulumi.String("string"),
		},
	},
})

    var externalNetworkV2Resource = new ExternalNetworkV2("externalNetworkV2Resource", ExternalNetworkV2Args.builder()
    .dedicatedOrgId("string")
    .description("string")
    .externalNetworkV2Id("string")
    .ipScopes(ExternalNetworkV2IpScopeArgs.builder()
        .gateway("string")
        .prefixLength(0)
        .dns1("string")
        .dns2("string")
        .dnsSuffix("string")
        .enabled(false)
        .staticIpPools(ExternalNetworkV2IpScopeStaticIpPoolArgs.builder()
            .endAddress("string")
            .startAddress("string")
            .build())
        .build())
    .name("string")
    .natAndFirewallServiceIntention("string")
    .nsxtNetwork(ExternalNetworkV2NsxtNetworkArgs.builder()
        .nsxtManagerId("string")
        .nsxtSegmentName("string")
        .nsxtTier0RouterId("string")
        .build())
    .routeAdvertisementIntention("string")
    .useIpSpaces(false)
    .vsphereNetworks(ExternalNetworkV2VsphereNetworkArgs.builder()
        .portgroupId("string")
        .vcenterId("string")
        .build())
    .build());

    external_network_v2_resource = vcd.ExternalNetworkV2("externalNetworkV2Resource",
    dedicated_org_id="string",
    description="string",
    external_network_v2_id="string",
    ip_scopes=[{
        "gateway": "string",
        "prefix_length": 0,
        "dns1": "string",
        "dns2": "string",
        "dns_suffix": "string",
        "enabled": False,
        "static_ip_pools": [{
            "end_address": "string",
            "start_address": "string",
        }],
    }],
    name="string",
    nat_and_firewall_service_intention="string",
    nsxt_network={
        "nsxt_manager_id": "string",
        "nsxt_segment_name": "string",
        "nsxt_tier0_router_id": "string",
    },
    route_advertisement_intention="string",
    use_ip_spaces=False,
    vsphere_networks=[{
        "portgroup_id": "string",
        "vcenter_id": "string",
    }])

    const externalNetworkV2Resource = new vcd.ExternalNetworkV2("externalNetworkV2Resource", {
    dedicatedOrgId: "string",
    description: "string",
    externalNetworkV2Id: "string",
    ipScopes: [{
        gateway: "string",
        prefixLength: 0,
        dns1: "string",
        dns2: "string",
        dnsSuffix: "string",
        enabled: false,
        staticIpPools: [{
            endAddress: "string",
            startAddress: "string",
        }],
    }],
    name: "string",
    natAndFirewallServiceIntention: "string",
    nsxtNetwork: {
        nsxtManagerId: "string",
        nsxtSegmentName: "string",
        nsxtTier0RouterId: "string",
    },
    routeAdvertisementIntention: "string",
    useIpSpaces: false,
    vsphereNetworks: [{
        portgroupId: "string",
        vcenterId: "string",
    }],
});

    type: vcd:ExternalNetworkV2
properties:
    dedicatedOrgId: string
    description: string
    externalNetworkV2Id: string
    ipScopes:
        - dns1: string
          dns2: string
          dnsSuffix: string
          enabled: false
          gateway: string
          prefixLength: 0
          staticIpPools:
            - endAddress: string
              startAddress: string
    name: string
    natAndFirewallServiceIntention: string
    nsxtNetwork:
        nsxtManagerId: string
        nsxtSegmentName: string
        nsxtTier0RouterId: string
    routeAdvertisementIntention: string
    useIpSpaces: false
    vsphereNetworks:
        - portgroupId: string
          vcenterId: string

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

    DedicatedOrgId string
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    Description string
    Network friendly description
    ExternalNetworkV2Id string
    IpScopes List<ExternalNetworkV2IpScope>
    One or more IP scopes for the network. See IP Scope below for details.
    Name string
    A unique name for the network
    NatAndFirewallServiceIntention string
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    NsxtNetwork ExternalNetworkV2NsxtNetwork
    NSX-T network definition. See NSX-T Network below for details.
    RouteAdvertisementIntention string

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    UseIpSpaces bool
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    VsphereNetworks List<ExternalNetworkV2VsphereNetwork>
    One or more blocks of vSphere Network..
    DedicatedOrgId string
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    Description string
    Network friendly description
    ExternalNetworkV2Id string
    IpScopes []ExternalNetworkV2IpScopeArgs
    One or more IP scopes for the network. See IP Scope below for details.
    Name string
    A unique name for the network
    NatAndFirewallServiceIntention string
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    NsxtNetwork ExternalNetworkV2NsxtNetworkArgs
    NSX-T network definition. See NSX-T Network below for details.
    RouteAdvertisementIntention string

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    UseIpSpaces bool
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    VsphereNetworks []ExternalNetworkV2VsphereNetworkArgs
    One or more blocks of vSphere Network..
    dedicatedOrgId String
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    description String
    Network friendly description
    externalNetworkV2Id String
    ipScopes List<ExternalNetworkV2IpScope>
    One or more IP scopes for the network. See IP Scope below for details.
    name String
    A unique name for the network
    natAndFirewallServiceIntention String
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    nsxtNetwork ExternalNetworkV2NsxtNetwork
    NSX-T network definition. See NSX-T Network below for details.
    routeAdvertisementIntention String

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    useIpSpaces Boolean
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    vsphereNetworks List<ExternalNetworkV2VsphereNetwork>
    One or more blocks of vSphere Network..
    dedicatedOrgId string
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    description string
    Network friendly description
    externalNetworkV2Id string
    ipScopes ExternalNetworkV2IpScope[]
    One or more IP scopes for the network. See IP Scope below for details.
    name string
    A unique name for the network
    natAndFirewallServiceIntention string
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    nsxtNetwork ExternalNetworkV2NsxtNetwork
    NSX-T network definition. See NSX-T Network below for details.
    routeAdvertisementIntention string

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    useIpSpaces boolean
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    vsphereNetworks ExternalNetworkV2VsphereNetwork[]
    One or more blocks of vSphere Network..
    dedicated_org_id str
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    description str
    Network friendly description
    external_network_v2_id str
    ip_scopes Sequence[ExternalNetworkV2IpScopeArgs]
    One or more IP scopes for the network. See IP Scope below for details.
    name str
    A unique name for the network
    nat_and_firewall_service_intention str
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    nsxt_network ExternalNetworkV2NsxtNetworkArgs
    NSX-T network definition. See NSX-T Network below for details.
    route_advertisement_intention str

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    use_ip_spaces bool
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    vsphere_networks Sequence[ExternalNetworkV2VsphereNetworkArgs]
    One or more blocks of vSphere Network..
    dedicatedOrgId String
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    description String
    Network friendly description
    externalNetworkV2Id String
    ipScopes List<Property Map>
    One or more IP scopes for the network. See IP Scope below for details.
    name String
    A unique name for the network
    natAndFirewallServiceIntention String
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    nsxtNetwork Property Map
    NSX-T network definition. See NSX-T Network below for details.
    routeAdvertisementIntention String

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    useIpSpaces Boolean
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    vsphereNetworks List<Property Map>
    One or more blocks of vSphere Network..

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ExternalNetworkV2 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 ExternalNetworkV2 Resource

    Get an existing ExternalNetworkV2 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?: ExternalNetworkV2State, opts?: CustomResourceOptions): ExternalNetworkV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dedicated_org_id: Optional[str] = None,
        description: Optional[str] = None,
        external_network_v2_id: Optional[str] = None,
        ip_scopes: Optional[Sequence[ExternalNetworkV2IpScopeArgs]] = None,
        name: Optional[str] = None,
        nat_and_firewall_service_intention: Optional[str] = None,
        nsxt_network: Optional[ExternalNetworkV2NsxtNetworkArgs] = None,
        route_advertisement_intention: Optional[str] = None,
        use_ip_spaces: Optional[bool] = None,
        vsphere_networks: Optional[Sequence[ExternalNetworkV2VsphereNetworkArgs]] = None) -> ExternalNetworkV2
    func GetExternalNetworkV2(ctx *Context, name string, id IDInput, state *ExternalNetworkV2State, opts ...ResourceOption) (*ExternalNetworkV2, error)
    public static ExternalNetworkV2 Get(string name, Input<string> id, ExternalNetworkV2State? state, CustomResourceOptions? opts = null)
    public static ExternalNetworkV2 get(String name, Output<String> id, ExternalNetworkV2State state, CustomResourceOptions options)
    resources:  _:    type: vcd:ExternalNetworkV2    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    DedicatedOrgId string
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    Description string
    Network friendly description
    ExternalNetworkV2Id string
    IpScopes List<ExternalNetworkV2IpScope>
    One or more IP scopes for the network. See IP Scope below for details.
    Name string
    A unique name for the network
    NatAndFirewallServiceIntention string
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    NsxtNetwork ExternalNetworkV2NsxtNetwork
    NSX-T network definition. See NSX-T Network below for details.
    RouteAdvertisementIntention string

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    UseIpSpaces bool
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    VsphereNetworks List<ExternalNetworkV2VsphereNetwork>
    One or more blocks of vSphere Network..
    DedicatedOrgId string
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    Description string
    Network friendly description
    ExternalNetworkV2Id string
    IpScopes []ExternalNetworkV2IpScopeArgs
    One or more IP scopes for the network. See IP Scope below for details.
    Name string
    A unique name for the network
    NatAndFirewallServiceIntention string
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    NsxtNetwork ExternalNetworkV2NsxtNetworkArgs
    NSX-T network definition. See NSX-T Network below for details.
    RouteAdvertisementIntention string

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    UseIpSpaces bool
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    VsphereNetworks []ExternalNetworkV2VsphereNetworkArgs
    One or more blocks of vSphere Network..
    dedicatedOrgId String
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    description String
    Network friendly description
    externalNetworkV2Id String
    ipScopes List<ExternalNetworkV2IpScope>
    One or more IP scopes for the network. See IP Scope below for details.
    name String
    A unique name for the network
    natAndFirewallServiceIntention String
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    nsxtNetwork ExternalNetworkV2NsxtNetwork
    NSX-T network definition. See NSX-T Network below for details.
    routeAdvertisementIntention String

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    useIpSpaces Boolean
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    vsphereNetworks List<ExternalNetworkV2VsphereNetwork>
    One or more blocks of vSphere Network..
    dedicatedOrgId string
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    description string
    Network friendly description
    externalNetworkV2Id string
    ipScopes ExternalNetworkV2IpScope[]
    One or more IP scopes for the network. See IP Scope below for details.
    name string
    A unique name for the network
    natAndFirewallServiceIntention string
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    nsxtNetwork ExternalNetworkV2NsxtNetwork
    NSX-T network definition. See NSX-T Network below for details.
    routeAdvertisementIntention string

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    useIpSpaces boolean
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    vsphereNetworks ExternalNetworkV2VsphereNetwork[]
    One or more blocks of vSphere Network..
    dedicated_org_id str
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    description str
    Network friendly description
    external_network_v2_id str
    ip_scopes Sequence[ExternalNetworkV2IpScopeArgs]
    One or more IP scopes for the network. See IP Scope below for details.
    name str
    A unique name for the network
    nat_and_firewall_service_intention str
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    nsxt_network ExternalNetworkV2NsxtNetworkArgs
    NSX-T network definition. See NSX-T Network below for details.
    route_advertisement_intention str

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    use_ip_spaces bool
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    vsphere_networks Sequence[ExternalNetworkV2VsphereNetworkArgs]
    One or more blocks of vSphere Network..
    dedicatedOrgId String
    An Org ID that this network should be dedicated to. Only applicable when use_ip_spaces=true
    description String
    Network friendly description
    externalNetworkV2Id String
    ipScopes List<Property Map>
    One or more IP scopes for the network. See IP Scope below for details.
    name String
    A unique name for the network
    natAndFirewallServiceIntention String
    Configure intentions for NAT and Firewall rule configuration:

    • EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways. This is the default behavior.
    • PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
    • PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.
    nsxtNetwork Property Map
    NSX-T network definition. See NSX-T Network below for details.
    routeAdvertisementIntention String

    Configure intentions for Org VDC network Route Advertisement:

    • IP_SPACE_UPLINKS_ADVERTISED_STRICT - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks cannot be configured to be advertised. This is the default behavior.
    • IP_SPACE_UPLINKS_ADVERTISED_FLEXIBLE - All networks within IP Space associated with IP Space Uplink will be advertised by default. This can be changed on an individual network level later, if necessary. All other networks outside of IP Spaces associated with IP Space Uplinks are not advertised by default but can be configured to be advertised after creation.
    • ALL_NETWORKS_ADVERTISED - All networks, regardless on whether they fall inside of any IP Spaces associated with IP Space Uplinks, will be advertised by default. This can be changed on an individual network level later, if necessary.

    useIpSpaces Boolean
    Defines if the network uses IP Spaces. Do not specify ip_scope when using IP Spaces. (default false)
    vsphereNetworks List<Property Map>
    One or more blocks of vSphere Network..

    Supporting Types

    ExternalNetworkV2IpScope, ExternalNetworkV2IpScopeArgs

    Gateway string
    Gateway of the network
    PrefixLength double
    Network mask
    Dns1 string
    Primary DNS server
    Dns2 string
    Secondary DNS server
    DnsSuffix string
    DNS suffix
    Enabled bool
    If subnet is enabled
    StaticIpPools List<ExternalNetworkV2IpScopeStaticIpPool>
    IP ranges used for static pool allocation in the network
    Gateway string
    Gateway of the network
    PrefixLength float64
    Network mask
    Dns1 string
    Primary DNS server
    Dns2 string
    Secondary DNS server
    DnsSuffix string
    DNS suffix
    Enabled bool
    If subnet is enabled
    StaticIpPools []ExternalNetworkV2IpScopeStaticIpPool
    IP ranges used for static pool allocation in the network
    gateway String
    Gateway of the network
    prefixLength Double
    Network mask
    dns1 String
    Primary DNS server
    dns2 String
    Secondary DNS server
    dnsSuffix String
    DNS suffix
    enabled Boolean
    If subnet is enabled
    staticIpPools List<ExternalNetworkV2IpScopeStaticIpPool>
    IP ranges used for static pool allocation in the network
    gateway string
    Gateway of the network
    prefixLength number
    Network mask
    dns1 string
    Primary DNS server
    dns2 string
    Secondary DNS server
    dnsSuffix string
    DNS suffix
    enabled boolean
    If subnet is enabled
    staticIpPools ExternalNetworkV2IpScopeStaticIpPool[]
    IP ranges used for static pool allocation in the network
    gateway str
    Gateway of the network
    prefix_length float
    Network mask
    dns1 str
    Primary DNS server
    dns2 str
    Secondary DNS server
    dns_suffix str
    DNS suffix
    enabled bool
    If subnet is enabled
    static_ip_pools Sequence[ExternalNetworkV2IpScopeStaticIpPool]
    IP ranges used for static pool allocation in the network
    gateway String
    Gateway of the network
    prefixLength Number
    Network mask
    dns1 String
    Primary DNS server
    dns2 String
    Secondary DNS server
    dnsSuffix String
    DNS suffix
    enabled Boolean
    If subnet is enabled
    staticIpPools List<Property Map>
    IP ranges used for static pool allocation in the network

    ExternalNetworkV2IpScopeStaticIpPool, ExternalNetworkV2IpScopeStaticIpPoolArgs

    EndAddress string
    End address of the IP range
    StartAddress string
    Start address of the IP range
    EndAddress string
    End address of the IP range
    StartAddress string
    Start address of the IP range
    endAddress String
    End address of the IP range
    startAddress String
    Start address of the IP range
    endAddress string
    End address of the IP range
    startAddress string
    Start address of the IP range
    end_address str
    End address of the IP range
    start_address str
    Start address of the IP range
    endAddress String
    End address of the IP range
    startAddress String
    Start address of the IP range

    ExternalNetworkV2NsxtNetwork, ExternalNetworkV2NsxtNetworkArgs

    NsxtManagerId string
    ID of NSX-T manager
    NsxtSegmentName string
    Name of NSX-T segment (for NSX-T segment backed external network)
    NsxtTier0RouterId string
    ID of NSX-T Tier-0 router (for T0 gateway backed external network)
    NsxtManagerId string
    ID of NSX-T manager
    NsxtSegmentName string
    Name of NSX-T segment (for NSX-T segment backed external network)
    NsxtTier0RouterId string
    ID of NSX-T Tier-0 router (for T0 gateway backed external network)
    nsxtManagerId String
    ID of NSX-T manager
    nsxtSegmentName String
    Name of NSX-T segment (for NSX-T segment backed external network)
    nsxtTier0RouterId String
    ID of NSX-T Tier-0 router (for T0 gateway backed external network)
    nsxtManagerId string
    ID of NSX-T manager
    nsxtSegmentName string
    Name of NSX-T segment (for NSX-T segment backed external network)
    nsxtTier0RouterId string
    ID of NSX-T Tier-0 router (for T0 gateway backed external network)
    nsxt_manager_id str
    ID of NSX-T manager
    nsxt_segment_name str
    Name of NSX-T segment (for NSX-T segment backed external network)
    nsxt_tier0_router_id str
    ID of NSX-T Tier-0 router (for T0 gateway backed external network)
    nsxtManagerId String
    ID of NSX-T manager
    nsxtSegmentName String
    Name of NSX-T segment (for NSX-T segment backed external network)
    nsxtTier0RouterId String
    ID of NSX-T Tier-0 router (for T0 gateway backed external network)

    ExternalNetworkV2VsphereNetwork, ExternalNetworkV2VsphereNetworkArgs

    PortgroupId string
    The name of the port group
    VcenterId string
    The vCenter server name
    PortgroupId string
    The name of the port group
    VcenterId string
    The vCenter server name
    portgroupId String
    The name of the port group
    vcenterId String
    The vCenter server name
    portgroupId string
    The name of the port group
    vcenterId string
    The vCenter server name
    portgroup_id str
    The name of the port group
    vcenter_id str
    The vCenter server name
    portgroupId String
    The name of the port group
    vcenterId String
    The vCenter server name

    Package Details

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