Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyTier0GatewayInterface
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyTier0GatewayInterface

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyTier0GatewayInterface Resource

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

    Constructor syntax

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

@overload
def PolicyTier0GatewayInterface(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                display_name: Optional[str] = None,
                                subnets: Optional[Sequence[str]] = None,
                                gateway_path: Optional[str] = None,
                                mtu: Optional[float] = None,
                                ospf: Optional[PolicyTier0GatewayInterfaceOspfArgs] = None,
                                enable_pim: Optional[bool] = None,
                                dhcp_relay_path: Optional[str] = None,
                                ipv6_ndra_profile_path: Optional[str] = None,
                                access_vlan_id: Optional[float] = None,
                                nsx_id: Optional[str] = None,
                                edge_node_path: Optional[str] = None,
                                policy_tier0_gateway_interface_id: Optional[str] = None,
                                segment_path: Optional[str] = None,
                                site_path: Optional[str] = None,
                                description: Optional[str] = None,
                                tags: Optional[Sequence[PolicyTier0GatewayInterfaceTagArgs]] = None,
                                type: Optional[str] = None,
                                urpf_mode: Optional[str] = None)
    func NewPolicyTier0GatewayInterface(ctx *Context, name string, args PolicyTier0GatewayInterfaceArgs, opts ...ResourceOption) (*PolicyTier0GatewayInterface, error)
    public PolicyTier0GatewayInterface(string name, PolicyTier0GatewayInterfaceArgs args, CustomResourceOptions? opts = null)
    public PolicyTier0GatewayInterface(String name, PolicyTier0GatewayInterfaceArgs args)
public PolicyTier0GatewayInterface(String name, PolicyTier0GatewayInterfaceArgs args, CustomResourceOptions options)

    type: nsxt:PolicyTier0GatewayInterface
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 PolicyTier0GatewayInterfaceArgs
    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 PolicyTier0GatewayInterfaceArgs
    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 PolicyTier0GatewayInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyTier0GatewayInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyTier0GatewayInterfaceArgs
    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 policyTier0GatewayInterfaceResource = new Nsxt.PolicyTier0GatewayInterface("policyTier0GatewayInterfaceResource", new()
{
    DisplayName = "string",
    Subnets = new[]
    {
        "string",
    },
    GatewayPath = "string",
    Mtu = 0,
    Ospf = new Nsxt.Inputs.PolicyTier0GatewayInterfaceOspfArgs
    {
        AreaPath = "string",
        BfdProfilePath = "string",
        DeadInterval = 0,
        EnableBfd = false,
        Enabled = false,
        HelloInterval = 0,
        NetworkType = "string",
    },
    EnablePim = false,
    DhcpRelayPath = "string",
    Ipv6NdraProfilePath = "string",
    AccessVlanId = 0,
    NsxId = "string",
    EdgeNodePath = "string",
    PolicyTier0GatewayInterfaceId = "string",
    SegmentPath = "string",
    SitePath = "string",
    Description = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyTier0GatewayInterfaceTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    Type = "string",
    UrpfMode = "string",
});

    example, err := nsxt.NewPolicyTier0GatewayInterface(ctx, "policyTier0GatewayInterfaceResource", &nsxt.PolicyTier0GatewayInterfaceArgs{
	DisplayName: pulumi.String("string"),
	Subnets: pulumi.StringArray{
		pulumi.String("string"),
	},
	GatewayPath: pulumi.String("string"),
	Mtu:         pulumi.Float64(0),
	Ospf: &nsxt.PolicyTier0GatewayInterfaceOspfArgs{
		AreaPath:       pulumi.String("string"),
		BfdProfilePath: pulumi.String("string"),
		DeadInterval:   pulumi.Float64(0),
		EnableBfd:      pulumi.Bool(false),
		Enabled:        pulumi.Bool(false),
		HelloInterval:  pulumi.Float64(0),
		NetworkType:    pulumi.String("string"),
	},
	EnablePim:                     pulumi.Bool(false),
	DhcpRelayPath:                 pulumi.String("string"),
	Ipv6NdraProfilePath:           pulumi.String("string"),
	AccessVlanId:                  pulumi.Float64(0),
	NsxId:                         pulumi.String("string"),
	EdgeNodePath:                  pulumi.String("string"),
	PolicyTier0GatewayInterfaceId: pulumi.String("string"),
	SegmentPath:                   pulumi.String("string"),
	SitePath:                      pulumi.String("string"),
	Description:                   pulumi.String("string"),
	Tags: nsxt.PolicyTier0GatewayInterfaceTagArray{
		&nsxt.PolicyTier0GatewayInterfaceTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	Type:     pulumi.String("string"),
	UrpfMode: pulumi.String("string"),
})

    var policyTier0GatewayInterfaceResource = new PolicyTier0GatewayInterface("policyTier0GatewayInterfaceResource", PolicyTier0GatewayInterfaceArgs.builder()
    .displayName("string")
    .subnets("string")
    .gatewayPath("string")
    .mtu(0)
    .ospf(PolicyTier0GatewayInterfaceOspfArgs.builder()
        .areaPath("string")
        .bfdProfilePath("string")
        .deadInterval(0)
        .enableBfd(false)
        .enabled(false)
        .helloInterval(0)
        .networkType("string")
        .build())
    .enablePim(false)
    .dhcpRelayPath("string")
    .ipv6NdraProfilePath("string")
    .accessVlanId(0)
    .nsxId("string")
    .edgeNodePath("string")
    .policyTier0GatewayInterfaceId("string")
    .segmentPath("string")
    .sitePath("string")
    .description("string")
    .tags(PolicyTier0GatewayInterfaceTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .type("string")
    .urpfMode("string")
    .build());

    policy_tier0_gateway_interface_resource = nsxt.PolicyTier0GatewayInterface("policyTier0GatewayInterfaceResource",
    display_name="string",
    subnets=["string"],
    gateway_path="string",
    mtu=0,
    ospf={
        "area_path": "string",
        "bfd_profile_path": "string",
        "dead_interval": 0,
        "enable_bfd": False,
        "enabled": False,
        "hello_interval": 0,
        "network_type": "string",
    },
    enable_pim=False,
    dhcp_relay_path="string",
    ipv6_ndra_profile_path="string",
    access_vlan_id=0,
    nsx_id="string",
    edge_node_path="string",
    policy_tier0_gateway_interface_id="string",
    segment_path="string",
    site_path="string",
    description="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    type="string",
    urpf_mode="string")

    const policyTier0GatewayInterfaceResource = new nsxt.PolicyTier0GatewayInterface("policyTier0GatewayInterfaceResource", {
    displayName: "string",
    subnets: ["string"],
    gatewayPath: "string",
    mtu: 0,
    ospf: {
        areaPath: "string",
        bfdProfilePath: "string",
        deadInterval: 0,
        enableBfd: false,
        enabled: false,
        helloInterval: 0,
        networkType: "string",
    },
    enablePim: false,
    dhcpRelayPath: "string",
    ipv6NdraProfilePath: "string",
    accessVlanId: 0,
    nsxId: "string",
    edgeNodePath: "string",
    policyTier0GatewayInterfaceId: "string",
    segmentPath: "string",
    sitePath: "string",
    description: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    type: "string",
    urpfMode: "string",
});

    type: nsxt:PolicyTier0GatewayInterface
properties:
    accessVlanId: 0
    description: string
    dhcpRelayPath: string
    displayName: string
    edgeNodePath: string
    enablePim: false
    gatewayPath: string
    ipv6NdraProfilePath: string
    mtu: 0
    nsxId: string
    ospf:
        areaPath: string
        bfdProfilePath: string
        deadInterval: 0
        enableBfd: false
        enabled: false
        helloInterval: 0
        networkType: string
    policyTier0GatewayInterfaceId: string
    segmentPath: string
    sitePath: string
    subnets:
        - string
    tags:
        - scope: string
          tag: string
    type: string
    urpfMode: string

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

    DisplayName string
    Display name of the resource.
    GatewayPath string
    Policy path for the Tier-0 Gateway.
    Subnets List<string>
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    AccessVlanId double
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    Description string
    Description of the resource.
    DhcpRelayPath string
    DHCP relay path to be associated with this interface.
    EdgeNodePath string
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    EnablePim bool
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    Ipv6NdraProfilePath string
    IPv6 NDRA profile to be associated with this interface.
    Mtu double
    Maximum Transmission Unit for this interface.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Ospf PolicyTier0GatewayInterfaceOspf
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    PolicyTier0GatewayInterfaceId string
    ID of the resource.
    SegmentPath string
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    SitePath string
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    Tags List<PolicyTier0GatewayInterfaceTag>
    A list of scope + tag pairs to associate with this resource.
    Type string
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    UrpfMode string
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    DisplayName string
    Display name of the resource.
    GatewayPath string
    Policy path for the Tier-0 Gateway.
    Subnets []string
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    AccessVlanId float64
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    Description string
    Description of the resource.
    DhcpRelayPath string
    DHCP relay path to be associated with this interface.
    EdgeNodePath string
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    EnablePim bool
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    Ipv6NdraProfilePath string
    IPv6 NDRA profile to be associated with this interface.
    Mtu float64
    Maximum Transmission Unit for this interface.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Ospf PolicyTier0GatewayInterfaceOspfArgs
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    PolicyTier0GatewayInterfaceId string
    ID of the resource.
    SegmentPath string
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    SitePath string
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    Tags []PolicyTier0GatewayInterfaceTagArgs
    A list of scope + tag pairs to associate with this resource.
    Type string
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    UrpfMode string
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    displayName String
    Display name of the resource.
    gatewayPath String
    Policy path for the Tier-0 Gateway.
    subnets List<String>
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    accessVlanId Double
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    description String
    Description of the resource.
    dhcpRelayPath String
    DHCP relay path to be associated with this interface.
    edgeNodePath String
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    enablePim Boolean
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    ipv6NdraProfilePath String
    IPv6 NDRA profile to be associated with this interface.
    mtu Double
    Maximum Transmission Unit for this interface.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    ospf PolicyTier0GatewayInterfaceOspf
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    policyTier0GatewayInterfaceId String
    ID of the resource.
    segmentPath String
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    sitePath String
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    tags List<PolicyTier0GatewayInterfaceTag>
    A list of scope + tag pairs to associate with this resource.
    type String
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    urpfMode String
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    displayName string
    Display name of the resource.
    gatewayPath string
    Policy path for the Tier-0 Gateway.
    subnets string[]
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    accessVlanId number
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    description string
    Description of the resource.
    dhcpRelayPath string
    DHCP relay path to be associated with this interface.
    edgeNodePath string
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    enablePim boolean
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    ipv6NdraProfilePath string
    IPv6 NDRA profile to be associated with this interface.
    mtu number
    Maximum Transmission Unit for this interface.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    ospf PolicyTier0GatewayInterfaceOspf
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    policyTier0GatewayInterfaceId string
    ID of the resource.
    segmentPath string
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    sitePath string
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    tags PolicyTier0GatewayInterfaceTag[]
    A list of scope + tag pairs to associate with this resource.
    type string
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    urpfMode string
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    display_name str
    Display name of the resource.
    gateway_path str
    Policy path for the Tier-0 Gateway.
    subnets Sequence[str]
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    access_vlan_id float
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    description str
    Description of the resource.
    dhcp_relay_path str
    DHCP relay path to be associated with this interface.
    edge_node_path str
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    enable_pim bool
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    ipv6_ndra_profile_path str
    IPv6 NDRA profile to be associated with this interface.
    mtu float
    Maximum Transmission Unit for this interface.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    ospf PolicyTier0GatewayInterfaceOspfArgs
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    policy_tier0_gateway_interface_id str
    ID of the resource.
    segment_path str
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    site_path str
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    tags Sequence[PolicyTier0GatewayInterfaceTagArgs]
    A list of scope + tag pairs to associate with this resource.
    type str
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    urpf_mode str
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    displayName String
    Display name of the resource.
    gatewayPath String
    Policy path for the Tier-0 Gateway.
    subnets List<String>
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    accessVlanId Number
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    description String
    Description of the resource.
    dhcpRelayPath String
    DHCP relay path to be associated with this interface.
    edgeNodePath String
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    enablePim Boolean
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    ipv6NdraProfilePath String
    IPv6 NDRA profile to be associated with this interface.
    mtu Number
    Maximum Transmission Unit for this interface.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    ospf Property Map
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    policyTier0GatewayInterfaceId String
    ID of the resource.
    segmentPath String
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    sitePath String
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    type String
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    urpfMode String
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddresses List<string>
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    LocaleServiceId string
    Id of associated Gateway Locale Service on NSX
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddresses []string
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    LocaleServiceId string
    Id of associated Gateway Locale Service on NSX
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddresses List<String>
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    localeServiceId String
    Id of associated Gateway Locale Service on NSX
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddresses string[]
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    localeServiceId string
    Id of associated Gateway Locale Service on NSX
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_addresses Sequence[str]
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    locale_service_id str
    Id of associated Gateway Locale Service on NSX
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddresses List<String>
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    localeServiceId String
    Id of associated Gateway Locale Service on NSX
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing PolicyTier0GatewayInterface Resource

    Get an existing PolicyTier0GatewayInterface 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?: PolicyTier0GatewayInterfaceState, opts?: CustomResourceOptions): PolicyTier0GatewayInterface
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_vlan_id: Optional[float] = None,
        description: Optional[str] = None,
        dhcp_relay_path: Optional[str] = None,
        display_name: Optional[str] = None,
        edge_node_path: Optional[str] = None,
        enable_pim: Optional[bool] = None,
        gateway_path: Optional[str] = None,
        ip_addresses: Optional[Sequence[str]] = None,
        ipv6_ndra_profile_path: Optional[str] = None,
        locale_service_id: Optional[str] = None,
        mtu: Optional[float] = None,
        nsx_id: Optional[str] = None,
        ospf: Optional[PolicyTier0GatewayInterfaceOspfArgs] = None,
        path: Optional[str] = None,
        policy_tier0_gateway_interface_id: Optional[str] = None,
        revision: Optional[float] = None,
        segment_path: Optional[str] = None,
        site_path: Optional[str] = None,
        subnets: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[PolicyTier0GatewayInterfaceTagArgs]] = None,
        type: Optional[str] = None,
        urpf_mode: Optional[str] = None) -> PolicyTier0GatewayInterface
    func GetPolicyTier0GatewayInterface(ctx *Context, name string, id IDInput, state *PolicyTier0GatewayInterfaceState, opts ...ResourceOption) (*PolicyTier0GatewayInterface, error)
    public static PolicyTier0GatewayInterface Get(string name, Input<string> id, PolicyTier0GatewayInterfaceState? state, CustomResourceOptions? opts = null)
    public static PolicyTier0GatewayInterface get(String name, Output<String> id, PolicyTier0GatewayInterfaceState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyTier0GatewayInterface    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:
    AccessVlanId double
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    Description string
    Description of the resource.
    DhcpRelayPath string
    DHCP relay path to be associated with this interface.
    DisplayName string
    Display name of the resource.
    EdgeNodePath string
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    EnablePim bool
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    GatewayPath string
    Policy path for the Tier-0 Gateway.
    IpAddresses List<string>
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    Ipv6NdraProfilePath string
    IPv6 NDRA profile to be associated with this interface.
    LocaleServiceId string
    Id of associated Gateway Locale Service on NSX
    Mtu double
    Maximum Transmission Unit for this interface.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Ospf PolicyTier0GatewayInterfaceOspf
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    Path string
    The NSX path of the policy resource.
    PolicyTier0GatewayInterfaceId string
    ID of the resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    SegmentPath string
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    SitePath string
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    Subnets List<string>
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    Tags List<PolicyTier0GatewayInterfaceTag>
    A list of scope + tag pairs to associate with this resource.
    Type string
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    UrpfMode string
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    AccessVlanId float64
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    Description string
    Description of the resource.
    DhcpRelayPath string
    DHCP relay path to be associated with this interface.
    DisplayName string
    Display name of the resource.
    EdgeNodePath string
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    EnablePim bool
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    GatewayPath string
    Policy path for the Tier-0 Gateway.
    IpAddresses []string
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    Ipv6NdraProfilePath string
    IPv6 NDRA profile to be associated with this interface.
    LocaleServiceId string
    Id of associated Gateway Locale Service on NSX
    Mtu float64
    Maximum Transmission Unit for this interface.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Ospf PolicyTier0GatewayInterfaceOspfArgs
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    Path string
    The NSX path of the policy resource.
    PolicyTier0GatewayInterfaceId string
    ID of the resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    SegmentPath string
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    SitePath string
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    Subnets []string
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    Tags []PolicyTier0GatewayInterfaceTagArgs
    A list of scope + tag pairs to associate with this resource.
    Type string
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    UrpfMode string
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    accessVlanId Double
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    description String
    Description of the resource.
    dhcpRelayPath String
    DHCP relay path to be associated with this interface.
    displayName String
    Display name of the resource.
    edgeNodePath String
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    enablePim Boolean
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    gatewayPath String
    Policy path for the Tier-0 Gateway.
    ipAddresses List<String>
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    ipv6NdraProfilePath String
    IPv6 NDRA profile to be associated with this interface.
    localeServiceId String
    Id of associated Gateway Locale Service on NSX
    mtu Double
    Maximum Transmission Unit for this interface.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    ospf PolicyTier0GatewayInterfaceOspf
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    path String
    The NSX path of the policy resource.
    policyTier0GatewayInterfaceId String
    ID of the resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    segmentPath String
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    sitePath String
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    subnets List<String>
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    tags List<PolicyTier0GatewayInterfaceTag>
    A list of scope + tag pairs to associate with this resource.
    type String
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    urpfMode String
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    accessVlanId number
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    description string
    Description of the resource.
    dhcpRelayPath string
    DHCP relay path to be associated with this interface.
    displayName string
    Display name of the resource.
    edgeNodePath string
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    enablePim boolean
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    gatewayPath string
    Policy path for the Tier-0 Gateway.
    ipAddresses string[]
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    ipv6NdraProfilePath string
    IPv6 NDRA profile to be associated with this interface.
    localeServiceId string
    Id of associated Gateway Locale Service on NSX
    mtu number
    Maximum Transmission Unit for this interface.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    ospf PolicyTier0GatewayInterfaceOspf
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    path string
    The NSX path of the policy resource.
    policyTier0GatewayInterfaceId string
    ID of the resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    segmentPath string
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    sitePath string
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    subnets string[]
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    tags PolicyTier0GatewayInterfaceTag[]
    A list of scope + tag pairs to associate with this resource.
    type string
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    urpfMode string
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    access_vlan_id float
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    description str
    Description of the resource.
    dhcp_relay_path str
    DHCP relay path to be associated with this interface.
    display_name str
    Display name of the resource.
    edge_node_path str
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    enable_pim bool
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    gateway_path str
    Policy path for the Tier-0 Gateway.
    ip_addresses Sequence[str]
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    ipv6_ndra_profile_path str
    IPv6 NDRA profile to be associated with this interface.
    locale_service_id str
    Id of associated Gateway Locale Service on NSX
    mtu float
    Maximum Transmission Unit for this interface.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    ospf PolicyTier0GatewayInterfaceOspfArgs
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    path str
    The NSX path of the policy resource.
    policy_tier0_gateway_interface_id str
    ID of the resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    segment_path str
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    site_path str
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    subnets Sequence[str]
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    tags Sequence[PolicyTier0GatewayInterfaceTagArgs]
    A list of scope + tag pairs to associate with this resource.
    type str
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    urpf_mode str
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.
    accessVlanId Number
    Access VLAN ID, relevant only for VRF interfaces. This attribute is supported with NSX 3.0.0 onwards.
    description String
    Description of the resource.
    dhcpRelayPath String
    DHCP relay path to be associated with this interface.
    displayName String
    Display name of the resource.
    edgeNodePath String
    Path of edge node for this interface, relevant for interfaces of type EXTERNAL.
    enablePim Boolean
    Flag to enable Protocol Independent Multicast, relevant only for interfaces of type EXTERNAL. This attribute will always be false for other interface types. This attribute is supported with NSX 3.0.0 onwards, and only for local managers.
    gatewayPath String
    Policy path for the Tier-0 Gateway.
    ipAddresses List<String>
    list of Ip Addresses picked from each subnet in subnets field. This attribute can serve as source_addresses field of nsxt.PolicyBgpNeighbor resource.
    ipv6NdraProfilePath String
    IPv6 NDRA profile to be associated with this interface.
    localeServiceId String
    Id of associated Gateway Locale Service on NSX
    mtu Number
    Maximum Transmission Unit for this interface.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    ospf Property Map
    OSPF configuration block - supported for EXTERNAL interface only. Not supported on Global Manager.
    path String
    The NSX path of the policy resource.
    policyTier0GatewayInterfaceId String
    ID of the resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    segmentPath String
    Policy path for segment to be connected with this Tier1 Gateway. This argemnt is required for interfaces of type SERVICE and EXTERNAL.
    sitePath String
    Path of the site the Tier0 edge cluster belongs to. This configuration is required for global manager only. path field of the existing nsxt.PolicySite can be used here.
    subnets List<String>
    list of Ip Addresses/Prefixes in CIDR format, to be associated with this interface.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    type String
    Type of this interface, one of SERVICE, EXTERNAL, LOOPBACK. Default is EXTERNAL
    urpfMode String
    Unicast Reverse Path Forwarding mode, one of NONE, STRICT. Default is STRICT. This attribute is supported with NSX 3.0.0 onwards.

    Supporting Types

    PolicyTier0GatewayInterfaceOspf, PolicyTier0GatewayInterfaceOspfArgs

    AreaPath string
    Policy path to OSPF area defined on this Tier0 Gateway.
    BfdProfilePath string
    Policy path to BFD profile. Relevant only if BFD is enabled.
    DeadInterval double
    Interval to wait before declaring OSPF peer as down, in seconds. Defaults to 40. Must be at least 3 times greater than hello_interval.
    EnableBfd bool
    Flag that controls whether OSPF will register for BFD event. Default is false.
    Enabled bool
    Flag to enable/disable OSPF for this interface. Default is true.
    HelloInterval double
    Interval between OSPF Hello Packets, in seconds. Defaults to 10.
    NetworkType string
    OSPF network type, one of BROADCAST and P2P. Default is BROADCAST.
    AreaPath string
    Policy path to OSPF area defined on this Tier0 Gateway.
    BfdProfilePath string
    Policy path to BFD profile. Relevant only if BFD is enabled.
    DeadInterval float64
    Interval to wait before declaring OSPF peer as down, in seconds. Defaults to 40. Must be at least 3 times greater than hello_interval.
    EnableBfd bool
    Flag that controls whether OSPF will register for BFD event. Default is false.
    Enabled bool
    Flag to enable/disable OSPF for this interface. Default is true.
    HelloInterval float64
    Interval between OSPF Hello Packets, in seconds. Defaults to 10.
    NetworkType string
    OSPF network type, one of BROADCAST and P2P. Default is BROADCAST.
    areaPath String
    Policy path to OSPF area defined on this Tier0 Gateway.
    bfdProfilePath String
    Policy path to BFD profile. Relevant only if BFD is enabled.
    deadInterval Double
    Interval to wait before declaring OSPF peer as down, in seconds. Defaults to 40. Must be at least 3 times greater than hello_interval.
    enableBfd Boolean
    Flag that controls whether OSPF will register for BFD event. Default is false.
    enabled Boolean
    Flag to enable/disable OSPF for this interface. Default is true.
    helloInterval Double
    Interval between OSPF Hello Packets, in seconds. Defaults to 10.
    networkType String
    OSPF network type, one of BROADCAST and P2P. Default is BROADCAST.
    areaPath string
    Policy path to OSPF area defined on this Tier0 Gateway.
    bfdProfilePath string
    Policy path to BFD profile. Relevant only if BFD is enabled.
    deadInterval number
    Interval to wait before declaring OSPF peer as down, in seconds. Defaults to 40. Must be at least 3 times greater than hello_interval.
    enableBfd boolean
    Flag that controls whether OSPF will register for BFD event. Default is false.
    enabled boolean
    Flag to enable/disable OSPF for this interface. Default is true.
    helloInterval number
    Interval between OSPF Hello Packets, in seconds. Defaults to 10.
    networkType string
    OSPF network type, one of BROADCAST and P2P. Default is BROADCAST.
    area_path str
    Policy path to OSPF area defined on this Tier0 Gateway.
    bfd_profile_path str
    Policy path to BFD profile. Relevant only if BFD is enabled.
    dead_interval float
    Interval to wait before declaring OSPF peer as down, in seconds. Defaults to 40. Must be at least 3 times greater than hello_interval.
    enable_bfd bool
    Flag that controls whether OSPF will register for BFD event. Default is false.
    enabled bool
    Flag to enable/disable OSPF for this interface. Default is true.
    hello_interval float
    Interval between OSPF Hello Packets, in seconds. Defaults to 10.
    network_type str
    OSPF network type, one of BROADCAST and P2P. Default is BROADCAST.
    areaPath String
    Policy path to OSPF area defined on this Tier0 Gateway.
    bfdProfilePath String
    Policy path to BFD profile. Relevant only if BFD is enabled.
    deadInterval Number
    Interval to wait before declaring OSPF peer as down, in seconds. Defaults to 40. Must be at least 3 times greater than hello_interval.
    enableBfd Boolean
    Flag that controls whether OSPF will register for BFD event. Default is false.
    enabled Boolean
    Flag to enable/disable OSPF for this interface. Default is true.
    helloInterval Number
    Interval between OSPF Hello Packets, in seconds. Defaults to 10.
    networkType String
    OSPF network type, one of BROADCAST and P2P. Default is BROADCAST.

    PolicyTier0GatewayInterfaceTag, PolicyTier0GatewayInterfaceTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt