1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getEvpnInstance
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.getEvpnInstance

Explore with Pulumi AI

iosxe logo
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

    This data source can read the EVPN Instance configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Pulumi.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Iosxe.GetEvpnInstance.Invoke(new()
        {
            EvpnInstanceNum = 10,
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iosxe.LookupEvpnInstance(ctx, &iosxe.LookupEvpnInstanceArgs{
    			EvpnInstanceNum: 10,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.iosxe.IosxeFunctions;
    import com.pulumi.iosxe.inputs.GetEvpnInstanceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = IosxeFunctions.getEvpnInstance(GetEvpnInstanceArgs.builder()
                .evpnInstanceNum(10)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_iosxe as iosxe
    
    example = iosxe.get_evpn_instance(evpn_instance_num=10)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@pulumi/iosxe";
    
    const example = iosxe.getEvpnInstance({
        evpnInstanceNum: 10,
    });
    
    variables:
      example:
        fn::invoke:
          Function: iosxe:getEvpnInstance
          Arguments:
            evpnInstanceNum: 10
    

    Using getEvpnInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEvpnInstance(args: GetEvpnInstanceArgs, opts?: InvokeOptions): Promise<GetEvpnInstanceResult>
    function getEvpnInstanceOutput(args: GetEvpnInstanceOutputArgs, opts?: InvokeOptions): Output<GetEvpnInstanceResult>
    def get_evpn_instance(device: Optional[str] = None,
                          evpn_instance_num: Optional[int] = None,
                          opts: Optional[InvokeOptions] = None) -> GetEvpnInstanceResult
    def get_evpn_instance_output(device: Optional[pulumi.Input[str]] = None,
                          evpn_instance_num: Optional[pulumi.Input[int]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetEvpnInstanceResult]
    func LookupEvpnInstance(ctx *Context, args *LookupEvpnInstanceArgs, opts ...InvokeOption) (*LookupEvpnInstanceResult, error)
    func LookupEvpnInstanceOutput(ctx *Context, args *LookupEvpnInstanceOutputArgs, opts ...InvokeOption) LookupEvpnInstanceResultOutput

    > Note: This function is named LookupEvpnInstance in the Go SDK.

    public static class GetEvpnInstance 
    {
        public static Task<GetEvpnInstanceResult> InvokeAsync(GetEvpnInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetEvpnInstanceResult> Invoke(GetEvpnInstanceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEvpnInstanceResult> getEvpnInstance(GetEvpnInstanceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: iosxe:index/getEvpnInstance:getEvpnInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EvpnInstanceNum int
    evpn instance number
    Device string
    A device name from the provider configuration.
    EvpnInstanceNum int
    evpn instance number
    Device string
    A device name from the provider configuration.
    evpnInstanceNum Integer
    evpn instance number
    device String
    A device name from the provider configuration.
    evpnInstanceNum number
    evpn instance number
    device string
    A device name from the provider configuration.
    evpn_instance_num int
    evpn instance number
    device str
    A device name from the provider configuration.
    evpnInstanceNum Number
    evpn instance number
    device String
    A device name from the provider configuration.

    getEvpnInstance Result

    The following output properties are available:

    EvpnInstanceNum int
    evpn instance number
    Id string
    The path of the retrieved object.
    VlanBasedAutoRouteTarget bool
    Automatically set a route-target
    VlanBasedDefaultGatewayAdvertise string
    Advertise Default Gateway MAC/IP routes
    VlanBasedEncapsulation string
    Data encapsulation method
    VlanBasedIpLocalLearningDisable bool
    Disable IP local learning from dataplane
    VlanBasedIpLocalLearningEnable bool
    Enable IP local learning from dataplane
    VlanBasedRd string
    ASN:nn or IP-address:nn
    VlanBasedReOriginateRouteType5 bool
    Re-originate route-type 5
    VlanBasedReplicationTypeIngress bool
    Ingress replication
    VlanBasedReplicationTypeMp2mp bool
    mp2mp replication
    VlanBasedReplicationTypeP2mp bool
    p2mp replication
    VlanBasedReplicationTypeStatic bool
    Static replication
    VlanBasedRouteTarget string
    ASN:nn or IP-address:nn
    VlanBasedRouteTargetBoth string
    ASN:nn or IP-address:nn
    VlanBasedRouteTargetExport string
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    VlanBasedRouteTargetImport string
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    Device string
    A device name from the provider configuration.
    EvpnInstanceNum int
    evpn instance number
    Id string
    The path of the retrieved object.
    VlanBasedAutoRouteTarget bool
    Automatically set a route-target
    VlanBasedDefaultGatewayAdvertise string
    Advertise Default Gateway MAC/IP routes
    VlanBasedEncapsulation string
    Data encapsulation method
    VlanBasedIpLocalLearningDisable bool
    Disable IP local learning from dataplane
    VlanBasedIpLocalLearningEnable bool
    Enable IP local learning from dataplane
    VlanBasedRd string
    ASN:nn or IP-address:nn
    VlanBasedReOriginateRouteType5 bool
    Re-originate route-type 5
    VlanBasedReplicationTypeIngress bool
    Ingress replication
    VlanBasedReplicationTypeMp2mp bool
    mp2mp replication
    VlanBasedReplicationTypeP2mp bool
    p2mp replication
    VlanBasedReplicationTypeStatic bool
    Static replication
    VlanBasedRouteTarget string
    ASN:nn or IP-address:nn
    VlanBasedRouteTargetBoth string
    ASN:nn or IP-address:nn
    VlanBasedRouteTargetExport string
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    VlanBasedRouteTargetImport string
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    Device string
    A device name from the provider configuration.
    evpnInstanceNum Integer
    evpn instance number
    id String
    The path of the retrieved object.
    vlanBasedAutoRouteTarget Boolean
    Automatically set a route-target
    vlanBasedDefaultGatewayAdvertise String
    Advertise Default Gateway MAC/IP routes
    vlanBasedEncapsulation String
    Data encapsulation method
    vlanBasedIpLocalLearningDisable Boolean
    Disable IP local learning from dataplane
    vlanBasedIpLocalLearningEnable Boolean
    Enable IP local learning from dataplane
    vlanBasedRd String
    ASN:nn or IP-address:nn
    vlanBasedReOriginateRouteType5 Boolean
    Re-originate route-type 5
    vlanBasedReplicationTypeIngress Boolean
    Ingress replication
    vlanBasedReplicationTypeMp2mp Boolean
    mp2mp replication
    vlanBasedReplicationTypeP2mp Boolean
    p2mp replication
    vlanBasedReplicationTypeStatic Boolean
    Static replication
    vlanBasedRouteTarget String
    ASN:nn or IP-address:nn
    vlanBasedRouteTargetBoth String
    ASN:nn or IP-address:nn
    vlanBasedRouteTargetExport String
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    vlanBasedRouteTargetImport String
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    device String
    A device name from the provider configuration.
    evpnInstanceNum number
    evpn instance number
    id string
    The path of the retrieved object.
    vlanBasedAutoRouteTarget boolean
    Automatically set a route-target
    vlanBasedDefaultGatewayAdvertise string
    Advertise Default Gateway MAC/IP routes
    vlanBasedEncapsulation string
    Data encapsulation method
    vlanBasedIpLocalLearningDisable boolean
    Disable IP local learning from dataplane
    vlanBasedIpLocalLearningEnable boolean
    Enable IP local learning from dataplane
    vlanBasedRd string
    ASN:nn or IP-address:nn
    vlanBasedReOriginateRouteType5 boolean
    Re-originate route-type 5
    vlanBasedReplicationTypeIngress boolean
    Ingress replication
    vlanBasedReplicationTypeMp2mp boolean
    mp2mp replication
    vlanBasedReplicationTypeP2mp boolean
    p2mp replication
    vlanBasedReplicationTypeStatic boolean
    Static replication
    vlanBasedRouteTarget string
    ASN:nn or IP-address:nn
    vlanBasedRouteTargetBoth string
    ASN:nn or IP-address:nn
    vlanBasedRouteTargetExport string
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    vlanBasedRouteTargetImport string
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    device string
    A device name from the provider configuration.
    evpn_instance_num int
    evpn instance number
    id str
    The path of the retrieved object.
    vlan_based_auto_route_target bool
    Automatically set a route-target
    vlan_based_default_gateway_advertise str
    Advertise Default Gateway MAC/IP routes
    vlan_based_encapsulation str
    Data encapsulation method
    vlan_based_ip_local_learning_disable bool
    Disable IP local learning from dataplane
    vlan_based_ip_local_learning_enable bool
    Enable IP local learning from dataplane
    vlan_based_rd str
    ASN:nn or IP-address:nn
    vlan_based_re_originate_route_type5 bool
    Re-originate route-type 5
    vlan_based_replication_type_ingress bool
    Ingress replication
    vlan_based_replication_type_mp2mp bool
    mp2mp replication
    vlan_based_replication_type_p2mp bool
    p2mp replication
    vlan_based_replication_type_static bool
    Static replication
    vlan_based_route_target str
    ASN:nn or IP-address:nn
    vlan_based_route_target_both str
    ASN:nn or IP-address:nn
    vlan_based_route_target_export str
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    vlan_based_route_target_import str
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    device str
    A device name from the provider configuration.
    evpnInstanceNum Number
    evpn instance number
    id String
    The path of the retrieved object.
    vlanBasedAutoRouteTarget Boolean
    Automatically set a route-target
    vlanBasedDefaultGatewayAdvertise String
    Advertise Default Gateway MAC/IP routes
    vlanBasedEncapsulation String
    Data encapsulation method
    vlanBasedIpLocalLearningDisable Boolean
    Disable IP local learning from dataplane
    vlanBasedIpLocalLearningEnable Boolean
    Enable IP local learning from dataplane
    vlanBasedRd String
    ASN:nn or IP-address:nn
    vlanBasedReOriginateRouteType5 Boolean
    Re-originate route-type 5
    vlanBasedReplicationTypeIngress Boolean
    Ingress replication
    vlanBasedReplicationTypeMp2mp Boolean
    mp2mp replication
    vlanBasedReplicationTypeP2mp Boolean
    p2mp replication
    vlanBasedReplicationTypeStatic Boolean
    Static replication
    vlanBasedRouteTarget String
    ASN:nn or IP-address:nn
    vlanBasedRouteTargetBoth String
    ASN:nn or IP-address:nn
    vlanBasedRouteTargetExport String
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    vlanBasedRouteTargetImport String
    ASN:nn or IP-address:nn (DEPRECATED, use rt-value-entry)
    device String
    A device name from the provider configuration.

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs