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

iosxe.getBfdTemplateSingleHop

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 BFD Template Single Hop configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Pulumi.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Iosxe.GetBfdTemplateSingleHop.Invoke(new()
        {
            Name = "SH-TEMPLATE-1",
        });
    
    });
    
    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.LookupBfdTemplateSingleHop(ctx, &iosxe.LookupBfdTemplateSingleHopArgs{
    			Name: "SH-TEMPLATE-1",
    		}, 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.GetBfdTemplateSingleHopArgs;
    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.getBfdTemplateSingleHop(GetBfdTemplateSingleHopArgs.builder()
                .name("SH-TEMPLATE-1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_iosxe as iosxe
    
    example = iosxe.get_bfd_template_single_hop(name="SH-TEMPLATE-1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@pulumi/iosxe";
    
    const example = iosxe.getBfdTemplateSingleHop({
        name: "SH-TEMPLATE-1",
    });
    
    variables:
      example:
        fn::invoke:
          Function: iosxe:getBfdTemplateSingleHop
          Arguments:
            name: SH-TEMPLATE-1
    

    Using getBfdTemplateSingleHop

    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 getBfdTemplateSingleHop(args: GetBfdTemplateSingleHopArgs, opts?: InvokeOptions): Promise<GetBfdTemplateSingleHopResult>
    function getBfdTemplateSingleHopOutput(args: GetBfdTemplateSingleHopOutputArgs, opts?: InvokeOptions): Output<GetBfdTemplateSingleHopResult>
    def get_bfd_template_single_hop(device: Optional[str] = None,
                                    name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetBfdTemplateSingleHopResult
    def get_bfd_template_single_hop_output(device: Optional[pulumi.Input[str]] = None,
                                    name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetBfdTemplateSingleHopResult]
    func LookupBfdTemplateSingleHop(ctx *Context, args *LookupBfdTemplateSingleHopArgs, opts ...InvokeOption) (*LookupBfdTemplateSingleHopResult, error)
    func LookupBfdTemplateSingleHopOutput(ctx *Context, args *LookupBfdTemplateSingleHopOutputArgs, opts ...InvokeOption) LookupBfdTemplateSingleHopResultOutput

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

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

    The following arguments are supported:

    Name string
    Device string
    A device name from the provider configuration.
    Name string
    Device string
    A device name from the provider configuration.
    name String
    device String
    A device name from the provider configuration.
    name string
    device string
    A device name from the provider configuration.
    name str
    device str
    A device name from the provider configuration.
    name String
    device String
    A device name from the provider configuration.

    getBfdTemplateSingleHop Result

    The following output properties are available:

    AuthenticationMd5Keychain string
    keychain name
    AuthenticationMeticulousMd5Keychain string
    keychain name
    AuthenticationMeticulousSha1Keychain string
    keychain name
    AuthenticationSha1Keychain string
    keychain name
    DampeningHalfTime int
    Half-life time for the penalty
    DampeningMaxSuppressingTime int
    Maximum duration to suppress a session
    DampeningSuppressTime int
    Value to start suppressing a session
    DampeningUnsuppressTime int
    Value to unsuppress a session
    Echo bool
    Use echo adjunct as bfd detection mechanism
    Id string
    The path of the retrieved object.
    IntervalMicrosecondsMinRx int
    Minimum receive interval capability
    IntervalMicrosecondsMinTx int
    Minimum transmit interval capability
    IntervalMillisecondsBoth int
    Minimum transmit and receive interval capability
    IntervalMillisecondsMinRx int
    Minimum receive interval capability
    IntervalMillisecondsMinTx int
    Minimum transmit interval capability
    IntervalMillisecondsMultiplier int
    Multiplier value used to compute holddown
    Name string
    Device string
    A device name from the provider configuration.
    AuthenticationMd5Keychain string
    keychain name
    AuthenticationMeticulousMd5Keychain string
    keychain name
    AuthenticationMeticulousSha1Keychain string
    keychain name
    AuthenticationSha1Keychain string
    keychain name
    DampeningHalfTime int
    Half-life time for the penalty
    DampeningMaxSuppressingTime int
    Maximum duration to suppress a session
    DampeningSuppressTime int
    Value to start suppressing a session
    DampeningUnsuppressTime int
    Value to unsuppress a session
    Echo bool
    Use echo adjunct as bfd detection mechanism
    Id string
    The path of the retrieved object.
    IntervalMicrosecondsMinRx int
    Minimum receive interval capability
    IntervalMicrosecondsMinTx int
    Minimum transmit interval capability
    IntervalMillisecondsBoth int
    Minimum transmit and receive interval capability
    IntervalMillisecondsMinRx int
    Minimum receive interval capability
    IntervalMillisecondsMinTx int
    Minimum transmit interval capability
    IntervalMillisecondsMultiplier int
    Multiplier value used to compute holddown
    Name string
    Device string
    A device name from the provider configuration.
    authenticationMd5Keychain String
    keychain name
    authenticationMeticulousMd5Keychain String
    keychain name
    authenticationMeticulousSha1Keychain String
    keychain name
    authenticationSha1Keychain String
    keychain name
    dampeningHalfTime Integer
    Half-life time for the penalty
    dampeningMaxSuppressingTime Integer
    Maximum duration to suppress a session
    dampeningSuppressTime Integer
    Value to start suppressing a session
    dampeningUnsuppressTime Integer
    Value to unsuppress a session
    echo Boolean
    Use echo adjunct as bfd detection mechanism
    id String
    The path of the retrieved object.
    intervalMicrosecondsMinRx Integer
    Minimum receive interval capability
    intervalMicrosecondsMinTx Integer
    Minimum transmit interval capability
    intervalMillisecondsBoth Integer
    Minimum transmit and receive interval capability
    intervalMillisecondsMinRx Integer
    Minimum receive interval capability
    intervalMillisecondsMinTx Integer
    Minimum transmit interval capability
    intervalMillisecondsMultiplier Integer
    Multiplier value used to compute holddown
    name String
    device String
    A device name from the provider configuration.
    authenticationMd5Keychain string
    keychain name
    authenticationMeticulousMd5Keychain string
    keychain name
    authenticationMeticulousSha1Keychain string
    keychain name
    authenticationSha1Keychain string
    keychain name
    dampeningHalfTime number
    Half-life time for the penalty
    dampeningMaxSuppressingTime number
    Maximum duration to suppress a session
    dampeningSuppressTime number
    Value to start suppressing a session
    dampeningUnsuppressTime number
    Value to unsuppress a session
    echo boolean
    Use echo adjunct as bfd detection mechanism
    id string
    The path of the retrieved object.
    intervalMicrosecondsMinRx number
    Minimum receive interval capability
    intervalMicrosecondsMinTx number
    Minimum transmit interval capability
    intervalMillisecondsBoth number
    Minimum transmit and receive interval capability
    intervalMillisecondsMinRx number
    Minimum receive interval capability
    intervalMillisecondsMinTx number
    Minimum transmit interval capability
    intervalMillisecondsMultiplier number
    Multiplier value used to compute holddown
    name string
    device string
    A device name from the provider configuration.
    authentication_md5_keychain str
    keychain name
    authentication_meticulous_md5_keychain str
    keychain name
    authentication_meticulous_sha1_keychain str
    keychain name
    authentication_sha1_keychain str
    keychain name
    dampening_half_time int
    Half-life time for the penalty
    dampening_max_suppressing_time int
    Maximum duration to suppress a session
    dampening_suppress_time int
    Value to start suppressing a session
    dampening_unsuppress_time int
    Value to unsuppress a session
    echo bool
    Use echo adjunct as bfd detection mechanism
    id str
    The path of the retrieved object.
    interval_microseconds_min_rx int
    Minimum receive interval capability
    interval_microseconds_min_tx int
    Minimum transmit interval capability
    interval_milliseconds_both int
    Minimum transmit and receive interval capability
    interval_milliseconds_min_rx int
    Minimum receive interval capability
    interval_milliseconds_min_tx int
    Minimum transmit interval capability
    interval_milliseconds_multiplier int
    Multiplier value used to compute holddown
    name str
    device str
    A device name from the provider configuration.
    authenticationMd5Keychain String
    keychain name
    authenticationMeticulousMd5Keychain String
    keychain name
    authenticationMeticulousSha1Keychain String
    keychain name
    authenticationSha1Keychain String
    keychain name
    dampeningHalfTime Number
    Half-life time for the penalty
    dampeningMaxSuppressingTime Number
    Maximum duration to suppress a session
    dampeningSuppressTime Number
    Value to start suppressing a session
    dampeningUnsuppressTime Number
    Value to unsuppress a session
    echo Boolean
    Use echo adjunct as bfd detection mechanism
    id String
    The path of the retrieved object.
    intervalMicrosecondsMinRx Number
    Minimum receive interval capability
    intervalMicrosecondsMinTx Number
    Minimum transmit interval capability
    intervalMillisecondsBoth Number
    Minimum transmit and receive interval capability
    intervalMillisecondsMinRx Number
    Minimum receive interval capability
    intervalMillisecondsMinTx Number
    Minimum transmit interval capability
    intervalMillisecondsMultiplier Number
    Multiplier value used to compute holddown
    name String
    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