iosxe.getBgpIpv4UnicastVrfNeighbor

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

Example Usage

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

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

});

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.LookupBgpIpv4UnicastVrfNeighbor(ctx, &iosxe.LookupBgpIpv4UnicastVrfNeighborArgs{
			Asn: "65000",
			Ip:  "3.3.3.3",
			Vrf: "VRF1",
		}, 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.GetBgpIpv4UnicastVrfNeighborArgs;
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.getBgpIpv4UnicastVrfNeighbor(GetBgpIpv4UnicastVrfNeighborArgs.builder()
            .asn("65000")
            .ip("3.3.3.3")
            .vrf("VRF1")
            .build());

    }
}

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

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

import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_bgp_ipv4_unicast_vrf_neighbor(asn="65000",
    ip="3.3.3.3",
    vrf="VRF1")

variables:
  example:
    fn::invoke:
      Function: iosxe:getBgpIpv4UnicastVrfNeighbor
      Arguments:
        asn: '65000'
        ip: 3.3.3.3
        vrf: VRF1

Using getBgpIpv4UnicastVrfNeighbor

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 getBgpIpv4UnicastVrfNeighbor(args: GetBgpIpv4UnicastVrfNeighborArgs, opts?: InvokeOptions): Promise<GetBgpIpv4UnicastVrfNeighborResult>
function getBgpIpv4UnicastVrfNeighborOutput(args: GetBgpIpv4UnicastVrfNeighborOutputArgs, opts?: InvokeOptions): Output<GetBgpIpv4UnicastVrfNeighborResult>

def get_bgp_ipv4_unicast_vrf_neighbor(asn: Optional[str] = None,
                                      device: Optional[str] = None,
                                      ip: Optional[str] = None,
                                      vrf: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetBgpIpv4UnicastVrfNeighborResult
def get_bgp_ipv4_unicast_vrf_neighbor_output(asn: Optional[pulumi.Input[str]] = None,
                                      device: Optional[pulumi.Input[str]] = None,
                                      ip: Optional[pulumi.Input[str]] = None,
                                      vrf: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetBgpIpv4UnicastVrfNeighborResult]

func LookupBgpIpv4UnicastVrfNeighbor(ctx *Context, args *LookupBgpIpv4UnicastVrfNeighborArgs, opts ...InvokeOption) (*LookupBgpIpv4UnicastVrfNeighborResult, error)
func LookupBgpIpv4UnicastVrfNeighborOutput(ctx *Context, args *LookupBgpIpv4UnicastVrfNeighborOutputArgs, opts ...InvokeOption) LookupBgpIpv4UnicastVrfNeighborResultOutput

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

public static class GetBgpIpv4UnicastVrfNeighbor 
{
    public static Task<GetBgpIpv4UnicastVrfNeighborResult> InvokeAsync(GetBgpIpv4UnicastVrfNeighborArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpIpv4UnicastVrfNeighborResult> Invoke(GetBgpIpv4UnicastVrfNeighborInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBgpIpv4UnicastVrfNeighborResult> getBgpIpv4UnicastVrfNeighbor(GetBgpIpv4UnicastVrfNeighborArgs args, InvokeOptions options)
public static Output<GetBgpIpv4UnicastVrfNeighborResult> getBgpIpv4UnicastVrfNeighbor(GetBgpIpv4UnicastVrfNeighborArgs args, InvokeOptions options)

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

The following arguments are supported:

Asn string
Ip string
Vrf string
Device string: A device name from the provider configuration.

Asn string
Ip string
Vrf string
Device string: A device name from the provider configuration.

asn String
ip String
vrf String
device String: A device name from the provider configuration.

asn string
ip string
vrf string
device string: A device name from the provider configuration.

asn str
ip str
vrf str
device str: A device name from the provider configuration.

asn String
ip String
vrf String
device String: A device name from the provider configuration.

getBgpIpv4UnicastVrfNeighbor Result

The following output properties are available:

Activate bool: Enable the address family for this neighbor
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
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
LogNeighborChangesDisable bool: disable
Password string
PasswordType int: Encryption type (0 to disable encryption, 7 for proprietary)
RemoteAs string: Specify a BGP peer-group remote-as
RouteMaps List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetBgpIpv4UnicastVrfNeighborRouteMap>: Apply route map to neighbor
RouteReflectorClient bool: Configure a neighbor as Route Reflector client
SendCommunity string
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
Vrf string
Device string: A device name from the provider configuration.

Activate bool: Enable the address family for this neighbor
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
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
LogNeighborChangesDisable bool: disable
Password string
PasswordType int: Encryption type (0 to disable encryption, 7 for proprietary)
RemoteAs string: Specify a BGP peer-group remote-as
RouteMaps []GetBgpIpv4UnicastVrfNeighborRouteMap: Apply route map to neighbor
RouteReflectorClient bool: Configure a neighbor as Route Reflector client
SendCommunity string
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
Vrf string
Device string: A device name from the provider configuration.

activate Boolean: Enable the address family for this neighbor
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
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
logNeighborChangesDisable Boolean: disable
password String
passwordType Integer: Encryption type (0 to disable encryption, 7 for proprietary)
remoteAs String: Specify a BGP peer-group remote-as
routeMaps List<GetBgpIpv4UnicastVrfNeighborRouteMap>: Apply route map to neighbor
routeReflectorClient Boolean: Configure a neighbor as Route Reflector client
sendCommunity String
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
vrf String
device String: A device name from the provider configuration.

activate boolean: Enable the address family for this neighbor
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
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
logNeighborChangesDisable boolean: disable
password string
passwordType number: Encryption type (0 to disable encryption, 7 for proprietary)
remoteAs string: Specify a BGP peer-group remote-as
routeMaps GetBgpIpv4UnicastVrfNeighborRouteMap[]: Apply route map to neighbor
routeReflectorClient boolean: Configure a neighbor as Route Reflector client
sendCommunity string
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
vrf string
device string: A device name from the provider configuration.

activate bool: Enable the address family for this neighbor
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_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_disable bool: disable
password str
password_type int: Encryption type (0 to disable encryption, 7 for proprietary)
remote_as str: Specify a BGP peer-group remote-as
route_maps Sequence[GetBgpIpv4UnicastVrfNeighborRouteMap]: Apply route map to neighbor
route_reflector_client bool: Configure a neighbor as Route Reflector client
send_community str
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
vrf str
device str: A device name from the provider configuration.

activate Boolean: Enable the address family for this neighbor
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
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
logNeighborChangesDisable Boolean: disable
password String
passwordType Number: Encryption type (0 to disable encryption, 7 for proprietary)
remoteAs String: Specify a BGP peer-group remote-as
routeMaps List<Property Map>: Apply route map to neighbor
routeReflectorClient Boolean: Configure a neighbor as Route Reflector client
sendCommunity String
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
vrf String
device String: A device name from the provider configuration.