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

nsxt.PolicyEvpnConfig

Explore with Pulumi AI

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

    Create PolicyEvpnConfig Resource

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

    Constructor syntax

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

@overload
def PolicyEvpnConfig(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     display_name: Optional[str] = None,
                     gateway_path: Optional[str] = None,
                     mode: Optional[str] = None,
                     description: Optional[str] = None,
                     evpn_tenant_path: Optional[str] = None,
                     policy_evpn_config_id: Optional[str] = None,
                     tags: Optional[Sequence[PolicyEvpnConfigTagArgs]] = None,
                     vni_pool_path: Optional[str] = None)
    func NewPolicyEvpnConfig(ctx *Context, name string, args PolicyEvpnConfigArgs, opts ...ResourceOption) (*PolicyEvpnConfig, error)
    public PolicyEvpnConfig(string name, PolicyEvpnConfigArgs args, CustomResourceOptions? opts = null)
    public PolicyEvpnConfig(String name, PolicyEvpnConfigArgs args)
public PolicyEvpnConfig(String name, PolicyEvpnConfigArgs args, CustomResourceOptions options)

    type: nsxt:PolicyEvpnConfig
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 PolicyEvpnConfigArgs
    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 PolicyEvpnConfigArgs
    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 PolicyEvpnConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyEvpnConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyEvpnConfigArgs
    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 policyEvpnConfigResource = new Nsxt.PolicyEvpnConfig("policyEvpnConfigResource", new()
{
    DisplayName = "string",
    GatewayPath = "string",
    Mode = "string",
    Description = "string",
    EvpnTenantPath = "string",
    PolicyEvpnConfigId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyEvpnConfigTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    VniPoolPath = "string",
});

    example, err := nsxt.NewPolicyEvpnConfig(ctx, "policyEvpnConfigResource", &nsxt.PolicyEvpnConfigArgs{
	DisplayName:        pulumi.String("string"),
	GatewayPath:        pulumi.String("string"),
	Mode:               pulumi.String("string"),
	Description:        pulumi.String("string"),
	EvpnTenantPath:     pulumi.String("string"),
	PolicyEvpnConfigId: pulumi.String("string"),
	Tags: nsxt.PolicyEvpnConfigTagArray{
		&nsxt.PolicyEvpnConfigTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	VniPoolPath: pulumi.String("string"),
})

    var policyEvpnConfigResource = new PolicyEvpnConfig("policyEvpnConfigResource", PolicyEvpnConfigArgs.builder()
    .displayName("string")
    .gatewayPath("string")
    .mode("string")
    .description("string")
    .evpnTenantPath("string")
    .policyEvpnConfigId("string")
    .tags(PolicyEvpnConfigTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .vniPoolPath("string")
    .build());

    policy_evpn_config_resource = nsxt.PolicyEvpnConfig("policyEvpnConfigResource",
    display_name="string",
    gateway_path="string",
    mode="string",
    description="string",
    evpn_tenant_path="string",
    policy_evpn_config_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    vni_pool_path="string")

    const policyEvpnConfigResource = new nsxt.PolicyEvpnConfig("policyEvpnConfigResource", {
    displayName: "string",
    gatewayPath: "string",
    mode: "string",
    description: "string",
    evpnTenantPath: "string",
    policyEvpnConfigId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    vniPoolPath: "string",
});

    type: nsxt:PolicyEvpnConfig
properties:
    description: string
    displayName: string
    evpnTenantPath: string
    gatewayPath: string
    mode: string
    policyEvpnConfigId: string
    tags:
        - scope: string
          tag: string
    vniPoolPath: string

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

    DisplayName string
    Display name for the resource.
    GatewayPath string
    Policy Path for Tier0 Gateway to configure EVPN on.
    Mode string
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    Description string
    Description for the resource.
    EvpnTenantPath string
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    PolicyEvpnConfigId string
    ID of the resource.
    Tags List<PolicyEvpnConfigTag>
    A list of scope + tag pairs to associate with this resource.
    VniPoolPath string
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    DisplayName string
    Display name for the resource.
    GatewayPath string
    Policy Path for Tier0 Gateway to configure EVPN on.
    Mode string
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    Description string
    Description for the resource.
    EvpnTenantPath string
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    PolicyEvpnConfigId string
    ID of the resource.
    Tags []PolicyEvpnConfigTagArgs
    A list of scope + tag pairs to associate with this resource.
    VniPoolPath string
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    displayName String
    Display name for the resource.
    gatewayPath String
    Policy Path for Tier0 Gateway to configure EVPN on.
    mode String
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    description String
    Description for the resource.
    evpnTenantPath String
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    policyEvpnConfigId String
    ID of the resource.
    tags List<PolicyEvpnConfigTag>
    A list of scope + tag pairs to associate with this resource.
    vniPoolPath String
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    displayName string
    Display name for the resource.
    gatewayPath string
    Policy Path for Tier0 Gateway to configure EVPN on.
    mode string
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    description string
    Description for the resource.
    evpnTenantPath string
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    policyEvpnConfigId string
    ID of the resource.
    tags PolicyEvpnConfigTag[]
    A list of scope + tag pairs to associate with this resource.
    vniPoolPath string
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    display_name str
    Display name for the resource.
    gateway_path str
    Policy Path for Tier0 Gateway to configure EVPN on.
    mode str
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    description str
    Description for the resource.
    evpn_tenant_path str
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    policy_evpn_config_id str
    ID of the resource.
    tags Sequence[PolicyEvpnConfigTagArgs]
    A list of scope + tag pairs to associate with this resource.
    vni_pool_path str
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    displayName String
    Display name for the resource.
    gatewayPath String
    Policy Path for Tier0 Gateway to configure EVPN on.
    mode String
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    description String
    Description for the resource.
    evpnTenantPath String
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    policyEvpnConfigId String
    ID of the resource.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    vniPoolPath String
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    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.
    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.
    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.
    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 PolicyEvpnConfig Resource

    Get an existing PolicyEvpnConfig 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?: PolicyEvpnConfigState, opts?: CustomResourceOptions): PolicyEvpnConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        evpn_tenant_path: Optional[str] = None,
        gateway_path: Optional[str] = None,
        mode: Optional[str] = None,
        path: Optional[str] = None,
        policy_evpn_config_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyEvpnConfigTagArgs]] = None,
        vni_pool_path: Optional[str] = None) -> PolicyEvpnConfig
    func GetPolicyEvpnConfig(ctx *Context, name string, id IDInput, state *PolicyEvpnConfigState, opts ...ResourceOption) (*PolicyEvpnConfig, error)
    public static PolicyEvpnConfig Get(string name, Input<string> id, PolicyEvpnConfigState? state, CustomResourceOptions? opts = null)
    public static PolicyEvpnConfig get(String name, Output<String> id, PolicyEvpnConfigState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyEvpnConfig    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:
    Description string
    Description for the resource.
    DisplayName string
    Display name for the resource.
    EvpnTenantPath string
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    GatewayPath string
    Policy Path for Tier0 Gateway to configure EVPN on.
    Mode string
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    Path string
    The NSX path of the policy resource.
    PolicyEvpnConfigId 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.
    Tags List<PolicyEvpnConfigTag>
    A list of scope + tag pairs to associate with this resource.
    VniPoolPath string
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    Description string
    Description for the resource.
    DisplayName string
    Display name for the resource.
    EvpnTenantPath string
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    GatewayPath string
    Policy Path for Tier0 Gateway to configure EVPN on.
    Mode string
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    Path string
    The NSX path of the policy resource.
    PolicyEvpnConfigId 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.
    Tags []PolicyEvpnConfigTagArgs
    A list of scope + tag pairs to associate with this resource.
    VniPoolPath string
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    description String
    Description for the resource.
    displayName String
    Display name for the resource.
    evpnTenantPath String
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    gatewayPath String
    Policy Path for Tier0 Gateway to configure EVPN on.
    mode String
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    path String
    The NSX path of the policy resource.
    policyEvpnConfigId 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.
    tags List<PolicyEvpnConfigTag>
    A list of scope + tag pairs to associate with this resource.
    vniPoolPath String
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    description string
    Description for the resource.
    displayName string
    Display name for the resource.
    evpnTenantPath string
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    gatewayPath string
    Policy Path for Tier0 Gateway to configure EVPN on.
    mode string
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    path string
    The NSX path of the policy resource.
    policyEvpnConfigId 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.
    tags PolicyEvpnConfigTag[]
    A list of scope + tag pairs to associate with this resource.
    vniPoolPath string
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    description str
    Description for the resource.
    display_name str
    Display name for the resource.
    evpn_tenant_path str
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    gateway_path str
    Policy Path for Tier0 Gateway to configure EVPN on.
    mode str
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    path str
    The NSX path of the policy resource.
    policy_evpn_config_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.
    tags Sequence[PolicyEvpnConfigTagArgs]
    A list of scope + tag pairs to associate with this resource.
    vni_pool_path str
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.
    description String
    Description for the resource.
    displayName String
    Display name for the resource.
    evpnTenantPath String
    Policy path for EVPN tenant. Relevant for ROUTE_SERVER mode.
    gatewayPath String
    Policy Path for Tier0 Gateway to configure EVPN on.
    mode String
    EVPN Mode, one of INLINE or ROUTE_SERVER. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in data forwarding.
    path String
    The NSX path of the policy resource.
    policyEvpnConfigId 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.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    vniPoolPath String
    Path of VNI pool to use. This setting is only applicable (and required) with INLINE mode.

    Supporting Types

    PolicyEvpnConfigTag, PolicyEvpnConfigTagArgs

    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