1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getBgpNeighbor
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

iosxe.getBgpNeighbor

iosxe logo
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

    This data source can read the BGP Neighbor configuration.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Iosxe = Pulumi.Iosxe;

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetBgpNeighbor.Invoke(new()
    {
        Asn = "65000",
        Ip = "3.3.3.3",
    });

});

    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.LookupBgpNeighbor(ctx, &iosxe.LookupBgpNeighborArgs{
			Asn: "65000",
			Ip:  "3.3.3.3",
		}, 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.GetBgpNeighborArgs;
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.getBgpNeighbor(GetBgpNeighborArgs.builder()
            .asn("65000")
            .ip("3.3.3.3")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@pulumi/iosxe";

const example = iosxe.getBgpNeighbor({
    asn: "65000",
    ip: "3.3.3.3",
});

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_bgp_neighbor(asn="65000",
    ip="3.3.3.3")

    variables:
  example:
    fn::invoke:
      Function: iosxe:getBgpNeighbor
      Arguments:
        asn: '65000'
        ip: 3.3.3.3

    Using getBgpNeighbor

    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 getBgpNeighbor(args: GetBgpNeighborArgs, opts?: InvokeOptions): Promise<GetBgpNeighborResult>
function getBgpNeighborOutput(args: GetBgpNeighborOutputArgs, opts?: InvokeOptions): Output<GetBgpNeighborResult>
    def get_bgp_neighbor(asn: Optional[str] = None,
                     device: Optional[str] = None,
                     ip: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetBgpNeighborResult
def get_bgp_neighbor_output(asn: Optional[pulumi.Input[str]] = None,
                     device: Optional[pulumi.Input[str]] = None,
                     ip: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetBgpNeighborResult]
    func LookupBgpNeighbor(ctx *Context, args *LookupBgpNeighborArgs, opts ...InvokeOption) (*LookupBgpNeighborResult, error)
func LookupBgpNeighborOutput(ctx *Context, args *LookupBgpNeighborOutputArgs, opts ...InvokeOption) LookupBgpNeighborResultOutput

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

    public static class GetBgpNeighbor 
{
    public static Task<GetBgpNeighborResult> InvokeAsync(GetBgpNeighborArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpNeighborResult> Invoke(GetBgpNeighborInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBgpNeighborResult> getBgpNeighbor(GetBgpNeighborArgs args, InvokeOptions options)
public static Output<GetBgpNeighborResult> getBgpNeighbor(GetBgpNeighborArgs args, InvokeOptions options)

    fn::invoke:
  function: iosxe:index/getBgpNeighbor:getBgpNeighbor
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getBgpNeighbor Result

    The following output properties are available:

    Asn string
    ClusterId string
    Description string
    Neighbor specific description
    DisableConnectedCheck bool
    one-hop away EBGP peer using loopback address
    EbgpMultihop bool
    Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
    EbgpMultihopMaxHop int
    FallOverBfdCheckControlPlaneFailure bool
    Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
    FallOverBfdMultiHop bool
    Force BFD multi-hop to detect failure
    FallOverBfdSingleHop bool
    Force BFD single-hop to detect failure
    FallOverBfdStrictMode bool
    Enable BFD strict-mode
    FallOverDefaultEnable bool
    FallOverDefaultRouteMap string
    FallOverMaximumMetricRouteMap string
    Id string
    The path of the retrieved object.
    Ip string
    LocalAs string
    LocalAsDualAs bool
    Accept either real AS or local AS from the ebgp peer
    LocalAsNoPrepend bool
    Do not prepend local-as to updates from ebgp peers
    LocalAsReplaceAs bool
    Replace real AS with local AS in the EBGP updates
    LogNeighborChanges bool
    Log neighbor up/down and reset reason
    Password string
    PasswordType int
    Encryption type (0 to disable encryption, 7 for proprietary)
    RemoteAs string
    Specify a BGP peer-group remote-as
    Shutdown bool
    Administratively shut down this neighbor
    TimersHoldtime int
    TimersKeepaliveInterval int
    TimersMinimumNeighborHold int
    TtlSecurityHops int
    IP hops
    UpdateSourceLoopback string
    Loopback interface
    Version int
    Set the BGP version to match a neighbor
    Device string
    A device name from the provider configuration.
    Asn string
    ClusterId string
    Description string
    Neighbor specific description
    DisableConnectedCheck bool
    one-hop away EBGP peer using loopback address
    EbgpMultihop bool
    Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
    EbgpMultihopMaxHop int
    FallOverBfdCheckControlPlaneFailure bool
    Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
    FallOverBfdMultiHop bool
    Force BFD multi-hop to detect failure
    FallOverBfdSingleHop bool
    Force BFD single-hop to detect failure
    FallOverBfdStrictMode bool
    Enable BFD strict-mode
    FallOverDefaultEnable bool
    FallOverDefaultRouteMap string
    FallOverMaximumMetricRouteMap string
    Id string
    The path of the retrieved object.
    Ip string
    LocalAs string
    LocalAsDualAs bool
    Accept either real AS or local AS from the ebgp peer
    LocalAsNoPrepend bool
    Do not prepend local-as to updates from ebgp peers
    LocalAsReplaceAs bool
    Replace real AS with local AS in the EBGP updates
    LogNeighborChanges bool
    Log neighbor up/down and reset reason
    Password string
    PasswordType int
    Encryption type (0 to disable encryption, 7 for proprietary)
    RemoteAs string
    Specify a BGP peer-group remote-as
    Shutdown bool
    Administratively shut down this neighbor
    TimersHoldtime int
    TimersKeepaliveInterval int
    TimersMinimumNeighborHold int
    TtlSecurityHops int
    IP hops
    UpdateSourceLoopback string
    Loopback interface
    Version int
    Set the BGP version to match a neighbor
    Device string
    A device name from the provider configuration.
    asn String
    clusterId String
    description String
    Neighbor specific description
    disableConnectedCheck Boolean
    one-hop away EBGP peer using loopback address
    ebgpMultihop Boolean
    Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
    ebgpMultihopMaxHop Integer
    fallOverBfdCheckControlPlaneFailure Boolean
    Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
    fallOverBfdMultiHop Boolean
    Force BFD multi-hop to detect failure
    fallOverBfdSingleHop Boolean
    Force BFD single-hop to detect failure
    fallOverBfdStrictMode Boolean
    Enable BFD strict-mode
    fallOverDefaultEnable Boolean
    fallOverDefaultRouteMap String
    fallOverMaximumMetricRouteMap String
    id String
    The path of the retrieved object.
    ip String
    localAs String
    localAsDualAs Boolean
    Accept either real AS or local AS from the ebgp peer
    localAsNoPrepend Boolean
    Do not prepend local-as to updates from ebgp peers
    localAsReplaceAs Boolean
    Replace real AS with local AS in the EBGP updates
    logNeighborChanges Boolean
    Log neighbor up/down and reset reason
    password String
    passwordType Integer
    Encryption type (0 to disable encryption, 7 for proprietary)
    remoteAs String
    Specify a BGP peer-group remote-as
    shutdown Boolean
    Administratively shut down this neighbor
    timersHoldtime Integer
    timersKeepaliveInterval Integer
    timersMinimumNeighborHold Integer
    ttlSecurityHops Integer
    IP hops
    updateSourceLoopback String
    Loopback interface
    version Integer
    Set the BGP version to match a neighbor
    device String
    A device name from the provider configuration.
    asn string
    clusterId string
    description string
    Neighbor specific description
    disableConnectedCheck boolean
    one-hop away EBGP peer using loopback address
    ebgpMultihop boolean
    Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
    ebgpMultihopMaxHop number
    fallOverBfdCheckControlPlaneFailure boolean
    Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
    fallOverBfdMultiHop boolean
    Force BFD multi-hop to detect failure
    fallOverBfdSingleHop boolean
    Force BFD single-hop to detect failure
    fallOverBfdStrictMode boolean
    Enable BFD strict-mode
    fallOverDefaultEnable boolean
    fallOverDefaultRouteMap string
    fallOverMaximumMetricRouteMap string
    id string
    The path of the retrieved object.
    ip string
    localAs string
    localAsDualAs boolean
    Accept either real AS or local AS from the ebgp peer
    localAsNoPrepend boolean
    Do not prepend local-as to updates from ebgp peers
    localAsReplaceAs boolean
    Replace real AS with local AS in the EBGP updates
    logNeighborChanges boolean
    Log neighbor up/down and reset reason
    password string
    passwordType number
    Encryption type (0 to disable encryption, 7 for proprietary)
    remoteAs string
    Specify a BGP peer-group remote-as
    shutdown boolean
    Administratively shut down this neighbor
    timersHoldtime number
    timersKeepaliveInterval number
    timersMinimumNeighborHold number
    ttlSecurityHops number
    IP hops
    updateSourceLoopback string
    Loopback interface
    version number
    Set the BGP version to match a neighbor
    device string
    A device name from the provider configuration.
    asn str
    cluster_id str
    description str
    Neighbor specific description
    disable_connected_check bool
    one-hop away EBGP peer using loopback address
    ebgp_multihop bool
    Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
    ebgp_multihop_max_hop int
    fall_over_bfd_check_control_plane_failure bool
    Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
    fall_over_bfd_multi_hop bool
    Force BFD multi-hop to detect failure
    fall_over_bfd_single_hop bool
    Force BFD single-hop to detect failure
    fall_over_bfd_strict_mode bool
    Enable BFD strict-mode
    fall_over_default_enable bool
    fall_over_default_route_map str
    fall_over_maximum_metric_route_map str
    id str
    The path of the retrieved object.
    ip str
    local_as str
    local_as_dual_as bool
    Accept either real AS or local AS from the ebgp peer
    local_as_no_prepend bool
    Do not prepend local-as to updates from ebgp peers
    local_as_replace_as bool
    Replace real AS with local AS in the EBGP updates
    log_neighbor_changes bool
    Log neighbor up/down and reset reason
    password str
    password_type int
    Encryption type (0 to disable encryption, 7 for proprietary)
    remote_as str
    Specify a BGP peer-group remote-as
    shutdown bool
    Administratively shut down this neighbor
    timers_holdtime int
    timers_keepalive_interval int
    timers_minimum_neighbor_hold int
    ttl_security_hops int
    IP hops
    update_source_loopback str
    Loopback interface
    version int
    Set the BGP version to match a neighbor
    device str
    A device name from the provider configuration.
    asn String
    clusterId String
    description String
    Neighbor specific description
    disableConnectedCheck Boolean
    one-hop away EBGP peer using loopback address
    ebgpMultihop Boolean
    Allow EBGP neighbors not on directly connected networks. For single-hop ebgp peers, delete ebgp-multihop directly.
    ebgpMultihopMaxHop Number
    fallOverBfdCheckControlPlaneFailure Boolean
    Retrieve control plane dependent failure info from BFD for BGP GR/NSR operation
    fallOverBfdMultiHop Boolean
    Force BFD multi-hop to detect failure
    fallOverBfdSingleHop Boolean
    Force BFD single-hop to detect failure
    fallOverBfdStrictMode Boolean
    Enable BFD strict-mode
    fallOverDefaultEnable Boolean
    fallOverDefaultRouteMap String
    fallOverMaximumMetricRouteMap String
    id String
    The path of the retrieved object.
    ip String
    localAs String
    localAsDualAs Boolean
    Accept either real AS or local AS from the ebgp peer
    localAsNoPrepend Boolean
    Do not prepend local-as to updates from ebgp peers
    localAsReplaceAs Boolean
    Replace real AS with local AS in the EBGP updates
    logNeighborChanges Boolean
    Log neighbor up/down and reset reason
    password String
    passwordType Number
    Encryption type (0 to disable encryption, 7 for proprietary)
    remoteAs String
    Specify a BGP peer-group remote-as
    shutdown Boolean
    Administratively shut down this neighbor
    timersHoldtime Number
    timersKeepaliveInterval Number
    timersMinimumNeighborHold Number
    ttlSecurityHops Number
    IP hops
    updateSourceLoopback String
    Loopback interface
    version Number
    Set the BGP version to match a neighbor
    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
    Viewing docs for Cisco IOS XE v0.0.1
    published on Friday, Sep 22, 2023 by lbrlabs
    Schema (JSON)
    lbrlabs/pulumi-iosxe
      Try Pulumi Cloud free. Your team will thank you.