1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. getCiscoOmpFeatureTemplate
Cisco Catalyst SD-WAN v0.1.3 published on Tuesday, Sep 24, 2024 by Pulumi

sdwan.getCiscoOmpFeatureTemplate

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.1.3 published on Tuesday, Sep 24, 2024 by Pulumi

    This data source can read the Cisco OMP feature template.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = sdwan.getCiscoOmpFeatureTemplate({
        id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.get_cisco_omp_feature_template(id="f6b2c44c-693c-4763-b010-895aa3d236bd")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sdwan.LookupCiscoOmpFeatureTemplate(ctx, &sdwan.LookupCiscoOmpFeatureTemplateArgs{
    			Id: pulumi.StringRef("f6b2c44c-693c-4763-b010-895aa3d236bd"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Sdwan = Pulumi.Sdwan;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Sdwan.GetCiscoOmpFeatureTemplate.Invoke(new()
        {
            Id = "f6b2c44c-693c-4763-b010-895aa3d236bd",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.SdwanFunctions;
    import com.pulumi.sdwan.inputs.GetCiscoOmpFeatureTemplateArgs;
    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 = SdwanFunctions.getCiscoOmpFeatureTemplate(GetCiscoOmpFeatureTemplateArgs.builder()
                .id("f6b2c44c-693c-4763-b010-895aa3d236bd")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: sdwan:getCiscoOmpFeatureTemplate
          Arguments:
            id: f6b2c44c-693c-4763-b010-895aa3d236bd
    

    Using getCiscoOmpFeatureTemplate

    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 getCiscoOmpFeatureTemplate(args: GetCiscoOmpFeatureTemplateArgs, opts?: InvokeOptions): Promise<GetCiscoOmpFeatureTemplateResult>
    function getCiscoOmpFeatureTemplateOutput(args: GetCiscoOmpFeatureTemplateOutputArgs, opts?: InvokeOptions): Output<GetCiscoOmpFeatureTemplateResult>
    def get_cisco_omp_feature_template(id: Optional[str] = None,
                                       name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetCiscoOmpFeatureTemplateResult
    def get_cisco_omp_feature_template_output(id: Optional[pulumi.Input[str]] = None,
                                       name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetCiscoOmpFeatureTemplateResult]
    func LookupCiscoOmpFeatureTemplate(ctx *Context, args *LookupCiscoOmpFeatureTemplateArgs, opts ...InvokeOption) (*LookupCiscoOmpFeatureTemplateResult, error)
    func LookupCiscoOmpFeatureTemplateOutput(ctx *Context, args *LookupCiscoOmpFeatureTemplateOutputArgs, opts ...InvokeOption) LookupCiscoOmpFeatureTemplateResultOutput

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

    public static class GetCiscoOmpFeatureTemplate 
    {
        public static Task<GetCiscoOmpFeatureTemplateResult> InvokeAsync(GetCiscoOmpFeatureTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetCiscoOmpFeatureTemplateResult> Invoke(GetCiscoOmpFeatureTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCiscoOmpFeatureTemplateResult> getCiscoOmpFeatureTemplate(GetCiscoOmpFeatureTemplateArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: sdwan:index/getCiscoOmpFeatureTemplate:getCiscoOmpFeatureTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The id of the feature template
    Name string
    The name of the feature template
    Id string
    The id of the feature template
    Name string
    The name of the feature template
    id String
    The id of the feature template
    name String
    The name of the feature template
    id string
    The id of the feature template
    name string
    The name of the feature template
    id str
    The id of the feature template
    name str
    The name of the feature template
    id String
    The id of the feature template
    name String
    The name of the feature template

    getCiscoOmpFeatureTemplate Result

    The following output properties are available:

    AdvertiseIpv4Routes List<GetCiscoOmpFeatureTemplateAdvertiseIpv4Route>
    Advertise locally learned routes to OMP
    AdvertiseIpv6Routes List<GetCiscoOmpFeatureTemplateAdvertiseIpv6Route>
    Advertise locally learned routes to OMP
    AdvertisementInterval int
    Set the time between OMP Update packets
    AdvertisementIntervalVariable string
    Variable name
    Description string
    The description of the feature template
    DeviceTypes List<string>
    List of supported device types
    EcmpLimit int
    Set maximum number of OMP paths to install in vEdge route table
    EcmpLimitVariable string
    Variable name
    EorTimer int
    End of RIB timer \n\n seconds
    EorTimerVariable string
    Variable name
    GracefulRestart bool
    Enable or disable OMP graceful restart
    GracefulRestartTimer int
    Set the OMP graceful restart timer
    GracefulRestartTimerVariable string
    Variable name
    GracefulRestartVariable string
    Variable name
    Holdtime int
    Set how long to wait before closing OMP peer connection
    HoldtimeVariable string
    Variable name
    Id string
    The id of the feature template
    IgnoreRegionPathLength bool
    Ignore Region-Path Length During Best-Path Algorithm
    IgnoreRegionPathLengthVariable string
    Variable name
    Name string
    The name of the feature template
    OmpAdminDistanceIpv4 int
    omp-admin-distance-ipv4
    OmpAdminDistanceIpv4Variable string
    Variable name
    OmpAdminDistanceIpv6 int
    omp-admin-distance-ipv6
    OmpAdminDistanceIpv6Variable string
    Variable name
    OverlayAs int
    Set Overlay AS number \n\n or \n\n
    OverlayAsVariable string
    Variable name
    SendPathLimit int
    Set number of TLOC routes advertised between vSmart and vEdge
    SendPathLimitVariable string
    Variable name
    Shutdown bool
    Enable or disable OMP
    ShutdownVariable string
    Variable name
    TemplateType string
    The template type
    TransportGateway string
    Transport gateway path computation
    TransportGatewayVariable string
    Variable name
    Version int
    The version of the feature template
    AdvertiseIpv4Routes []GetCiscoOmpFeatureTemplateAdvertiseIpv4Route
    Advertise locally learned routes to OMP
    AdvertiseIpv6Routes []GetCiscoOmpFeatureTemplateAdvertiseIpv6Route
    Advertise locally learned routes to OMP
    AdvertisementInterval int
    Set the time between OMP Update packets
    AdvertisementIntervalVariable string
    Variable name
    Description string
    The description of the feature template
    DeviceTypes []string
    List of supported device types
    EcmpLimit int
    Set maximum number of OMP paths to install in vEdge route table
    EcmpLimitVariable string
    Variable name
    EorTimer int
    End of RIB timer \n\n seconds
    EorTimerVariable string
    Variable name
    GracefulRestart bool
    Enable or disable OMP graceful restart
    GracefulRestartTimer int
    Set the OMP graceful restart timer
    GracefulRestartTimerVariable string
    Variable name
    GracefulRestartVariable string
    Variable name
    Holdtime int
    Set how long to wait before closing OMP peer connection
    HoldtimeVariable string
    Variable name
    Id string
    The id of the feature template
    IgnoreRegionPathLength bool
    Ignore Region-Path Length During Best-Path Algorithm
    IgnoreRegionPathLengthVariable string
    Variable name
    Name string
    The name of the feature template
    OmpAdminDistanceIpv4 int
    omp-admin-distance-ipv4
    OmpAdminDistanceIpv4Variable string
    Variable name
    OmpAdminDistanceIpv6 int
    omp-admin-distance-ipv6
    OmpAdminDistanceIpv6Variable string
    Variable name
    OverlayAs int
    Set Overlay AS number \n\n or \n\n
    OverlayAsVariable string
    Variable name
    SendPathLimit int
    Set number of TLOC routes advertised between vSmart and vEdge
    SendPathLimitVariable string
    Variable name
    Shutdown bool
    Enable or disable OMP
    ShutdownVariable string
    Variable name
    TemplateType string
    The template type
    TransportGateway string
    Transport gateway path computation
    TransportGatewayVariable string
    Variable name
    Version int
    The version of the feature template
    advertiseIpv4Routes List<GetCiscoOmpFeatureTemplateAdvertiseIpv4Route>
    Advertise locally learned routes to OMP
    advertiseIpv6Routes List<GetCiscoOmpFeatureTemplateAdvertiseIpv6Route>
    Advertise locally learned routes to OMP
    advertisementInterval Integer
    Set the time between OMP Update packets
    advertisementIntervalVariable String
    Variable name
    description String
    The description of the feature template
    deviceTypes List<String>
    List of supported device types
    ecmpLimit Integer
    Set maximum number of OMP paths to install in vEdge route table
    ecmpLimitVariable String
    Variable name
    eorTimer Integer
    End of RIB timer \n\n seconds
    eorTimerVariable String
    Variable name
    gracefulRestart Boolean
    Enable or disable OMP graceful restart
    gracefulRestartTimer Integer
    Set the OMP graceful restart timer
    gracefulRestartTimerVariable String
    Variable name
    gracefulRestartVariable String
    Variable name
    holdtime Integer
    Set how long to wait before closing OMP peer connection
    holdtimeVariable String
    Variable name
    id String
    The id of the feature template
    ignoreRegionPathLength Boolean
    Ignore Region-Path Length During Best-Path Algorithm
    ignoreRegionPathLengthVariable String
    Variable name
    name String
    The name of the feature template
    ompAdminDistanceIpv4 Integer
    omp-admin-distance-ipv4
    ompAdminDistanceIpv4Variable String
    Variable name
    ompAdminDistanceIpv6 Integer
    omp-admin-distance-ipv6
    ompAdminDistanceIpv6Variable String
    Variable name
    overlayAs Integer
    Set Overlay AS number \n\n or \n\n
    overlayAsVariable String
    Variable name
    sendPathLimit Integer
    Set number of TLOC routes advertised between vSmart and vEdge
    sendPathLimitVariable String
    Variable name
    shutdown Boolean
    Enable or disable OMP
    shutdownVariable String
    Variable name
    templateType String
    The template type
    transportGateway String
    Transport gateway path computation
    transportGatewayVariable String
    Variable name
    version Integer
    The version of the feature template
    advertiseIpv4Routes GetCiscoOmpFeatureTemplateAdvertiseIpv4Route[]
    Advertise locally learned routes to OMP
    advertiseIpv6Routes GetCiscoOmpFeatureTemplateAdvertiseIpv6Route[]
    Advertise locally learned routes to OMP
    advertisementInterval number
    Set the time between OMP Update packets
    advertisementIntervalVariable string
    Variable name
    description string
    The description of the feature template
    deviceTypes string[]
    List of supported device types
    ecmpLimit number
    Set maximum number of OMP paths to install in vEdge route table
    ecmpLimitVariable string
    Variable name
    eorTimer number
    End of RIB timer \n\n seconds
    eorTimerVariable string
    Variable name
    gracefulRestart boolean
    Enable or disable OMP graceful restart
    gracefulRestartTimer number
    Set the OMP graceful restart timer
    gracefulRestartTimerVariable string
    Variable name
    gracefulRestartVariable string
    Variable name
    holdtime number
    Set how long to wait before closing OMP peer connection
    holdtimeVariable string
    Variable name
    id string
    The id of the feature template
    ignoreRegionPathLength boolean
    Ignore Region-Path Length During Best-Path Algorithm
    ignoreRegionPathLengthVariable string
    Variable name
    name string
    The name of the feature template
    ompAdminDistanceIpv4 number
    omp-admin-distance-ipv4
    ompAdminDistanceIpv4Variable string
    Variable name
    ompAdminDistanceIpv6 number
    omp-admin-distance-ipv6
    ompAdminDistanceIpv6Variable string
    Variable name
    overlayAs number
    Set Overlay AS number \n\n or \n\n
    overlayAsVariable string
    Variable name
    sendPathLimit number
    Set number of TLOC routes advertised between vSmart and vEdge
    sendPathLimitVariable string
    Variable name
    shutdown boolean
    Enable or disable OMP
    shutdownVariable string
    Variable name
    templateType string
    The template type
    transportGateway string
    Transport gateway path computation
    transportGatewayVariable string
    Variable name
    version number
    The version of the feature template
    Sequence[GetCiscoOmpFeatureTemplateAdvertiseIpv4Route]
    Advertise locally learned routes to OMP
    Sequence[GetCiscoOmpFeatureTemplateAdvertiseIpv6Route]
    Advertise locally learned routes to OMP
    int
    Set the time between OMP Update packets
    str
    Variable name
    description str
    The description of the feature template
    device_types Sequence[str]
    List of supported device types
    ecmp_limit int
    Set maximum number of OMP paths to install in vEdge route table
    ecmp_limit_variable str
    Variable name
    eor_timer int
    End of RIB timer \n\n seconds
    eor_timer_variable str
    Variable name
    graceful_restart bool
    Enable or disable OMP graceful restart
    graceful_restart_timer int
    Set the OMP graceful restart timer
    graceful_restart_timer_variable str
    Variable name
    graceful_restart_variable str
    Variable name
    holdtime int
    Set how long to wait before closing OMP peer connection
    holdtime_variable str
    Variable name
    id str
    The id of the feature template
    ignore_region_path_length bool
    Ignore Region-Path Length During Best-Path Algorithm
    ignore_region_path_length_variable str
    Variable name
    name str
    The name of the feature template
    omp_admin_distance_ipv4 int
    omp-admin-distance-ipv4
    omp_admin_distance_ipv4_variable str
    Variable name
    omp_admin_distance_ipv6 int
    omp-admin-distance-ipv6
    omp_admin_distance_ipv6_variable str
    Variable name
    overlay_as int
    Set Overlay AS number \n\n or \n\n
    overlay_as_variable str
    Variable name
    send_path_limit int
    Set number of TLOC routes advertised between vSmart and vEdge
    send_path_limit_variable str
    Variable name
    shutdown bool
    Enable or disable OMP
    shutdown_variable str
    Variable name
    template_type str
    The template type
    transport_gateway str
    Transport gateway path computation
    transport_gateway_variable str
    Variable name
    version int
    The version of the feature template
    advertiseIpv4Routes List<Property Map>
    Advertise locally learned routes to OMP
    advertiseIpv6Routes List<Property Map>
    Advertise locally learned routes to OMP
    advertisementInterval Number
    Set the time between OMP Update packets
    advertisementIntervalVariable String
    Variable name
    description String
    The description of the feature template
    deviceTypes List<String>
    List of supported device types
    ecmpLimit Number
    Set maximum number of OMP paths to install in vEdge route table
    ecmpLimitVariable String
    Variable name
    eorTimer Number
    End of RIB timer \n\n seconds
    eorTimerVariable String
    Variable name
    gracefulRestart Boolean
    Enable or disable OMP graceful restart
    gracefulRestartTimer Number
    Set the OMP graceful restart timer
    gracefulRestartTimerVariable String
    Variable name
    gracefulRestartVariable String
    Variable name
    holdtime Number
    Set how long to wait before closing OMP peer connection
    holdtimeVariable String
    Variable name
    id String
    The id of the feature template
    ignoreRegionPathLength Boolean
    Ignore Region-Path Length During Best-Path Algorithm
    ignoreRegionPathLengthVariable String
    Variable name
    name String
    The name of the feature template
    ompAdminDistanceIpv4 Number
    omp-admin-distance-ipv4
    ompAdminDistanceIpv4Variable String
    Variable name
    ompAdminDistanceIpv6 Number
    omp-admin-distance-ipv6
    ompAdminDistanceIpv6Variable String
    Variable name
    overlayAs Number
    Set Overlay AS number \n\n or \n\n
    overlayAsVariable String
    Variable name
    sendPathLimit Number
    Set number of TLOC routes advertised between vSmart and vEdge
    sendPathLimitVariable String
    Variable name
    shutdown Boolean
    Enable or disable OMP
    shutdownVariable String
    Variable name
    templateType String
    The template type
    transportGateway String
    Transport gateway path computation
    transportGatewayVariable String
    Variable name
    version Number
    The version of the feature template

    Supporting Types

    GetCiscoOmpFeatureTemplateAdvertiseIpv4Route

    AdvertiseExternalOspf string
    Advertise OSPF external routes
    AdvertiseExternalOspfVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Protocol string
    Set routes to advertise
    AdvertiseExternalOspf string
    Advertise OSPF external routes
    AdvertiseExternalOspfVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Protocol string
    Set routes to advertise
    advertiseExternalOspf String
    Advertise OSPF external routes
    advertiseExternalOspfVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    protocol String
    Set routes to advertise
    advertiseExternalOspf string
    Advertise OSPF external routes
    advertiseExternalOspfVariable string
    Variable name
    optional boolean
    Indicates if list item is considered optional.
    protocol string
    Set routes to advertise
    str
    Advertise OSPF external routes
    str
    Variable name
    optional bool
    Indicates if list item is considered optional.
    protocol str
    Set routes to advertise
    advertiseExternalOspf String
    Advertise OSPF external routes
    advertiseExternalOspfVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    protocol String
    Set routes to advertise

    GetCiscoOmpFeatureTemplateAdvertiseIpv6Route

    Optional bool
    Indicates if list item is considered optional.
    Protocol string
    Set routes to advertise
    Optional bool
    Indicates if list item is considered optional.
    Protocol string
    Set routes to advertise
    optional Boolean
    Indicates if list item is considered optional.
    protocol String
    Set routes to advertise
    optional boolean
    Indicates if list item is considered optional.
    protocol string
    Set routes to advertise
    optional bool
    Indicates if list item is considered optional.
    protocol str
    Set routes to advertise
    optional Boolean
    Indicates if list item is considered optional.
    protocol String
    Set routes to advertise

    Package Details

    Repository
    sdwan pulumi/pulumi-sdwan
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdwan Terraform Provider.
    sdwan logo
    Cisco Catalyst SD-WAN v0.1.3 published on Tuesday, Sep 24, 2024 by Pulumi