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

iosxe.getBgp

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 BGP configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Pulumi.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Iosxe.GetBgp.Invoke(new()
        {
            Asn = "65000",
        });
    
    });
    
    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.LookupBgp(ctx, &iosxe.LookupBgpArgs{
    			Asn: "65000",
    		}, 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.GetBgpArgs;
    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.getBgp(GetBgpArgs.builder()
                .asn("65000")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_iosxe as iosxe
    
    example = iosxe.get_bgp(asn="65000")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@pulumi/iosxe";
    
    const example = iosxe.getBgp({
        asn: "65000",
    });
    
    variables:
      example:
        fn::invoke:
          Function: iosxe:getBgp
          Arguments:
            asn: '65000'
    

    Using getBgp

    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 getBgp(args: GetBgpArgs, opts?: InvokeOptions): Promise<GetBgpResult>
    function getBgpOutput(args: GetBgpOutputArgs, opts?: InvokeOptions): Output<GetBgpResult>
    def get_bgp(asn: Optional[str] = None,
                device: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBgpResult
    def get_bgp_output(asn: Optional[pulumi.Input[str]] = None,
                device: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetBgpResult]
    func LookupBgp(ctx *Context, args *LookupBgpArgs, opts ...InvokeOption) (*LookupBgpResult, error)
    func LookupBgpOutput(ctx *Context, args *LookupBgpOutputArgs, opts ...InvokeOption) LookupBgpResultOutput

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

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

    The following arguments are supported:

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

    getBgp Result

    The following output properties are available:

    Asn string
    DefaultIpv4Unicast bool
    Activate ipv4-unicast for a peer by default
    Id string
    The path of the retrieved object.
    LogNeighborChanges bool
    Log neighbor up/down and reset reason
    RouterIdLoopback int
    Loopback interface
    Device string
    A device name from the provider configuration.
    Asn string
    DefaultIpv4Unicast bool
    Activate ipv4-unicast for a peer by default
    Id string
    The path of the retrieved object.
    LogNeighborChanges bool
    Log neighbor up/down and reset reason
    RouterIdLoopback int
    Loopback interface
    Device string
    A device name from the provider configuration.
    asn String
    defaultIpv4Unicast Boolean
    Activate ipv4-unicast for a peer by default
    id String
    The path of the retrieved object.
    logNeighborChanges Boolean
    Log neighbor up/down and reset reason
    routerIdLoopback Integer
    Loopback interface
    device String
    A device name from the provider configuration.
    asn string
    defaultIpv4Unicast boolean
    Activate ipv4-unicast for a peer by default
    id string
    The path of the retrieved object.
    logNeighborChanges boolean
    Log neighbor up/down and reset reason
    routerIdLoopback number
    Loopback interface
    device string
    A device name from the provider configuration.
    asn str
    default_ipv4_unicast bool
    Activate ipv4-unicast for a peer by default
    id str
    The path of the retrieved object.
    log_neighbor_changes bool
    Log neighbor up/down and reset reason
    router_id_loopback int
    Loopback interface
    device str
    A device name from the provider configuration.
    asn String
    defaultIpv4Unicast Boolean
    Activate ipv4-unicast for a peer by default
    id String
    The path of the retrieved object.
    logNeighborChanges Boolean
    Log neighbor up/down and reset reason
    routerIdLoopback Number
    Loopback interface
    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