iosxe.getBgpIpv4UnicastNeighbor

Explore with Pulumi AI

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

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetBgpIpv4UnicastNeighbor.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.LookupBgpIpv4UnicastNeighbor(ctx, &iosxe.LookupBgpIpv4UnicastNeighborArgs{
			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.GetBgpIpv4UnicastNeighborArgs;
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.getBgpIpv4UnicastNeighbor(GetBgpIpv4UnicastNeighborArgs.builder()
            .asn("65000")
            .ip("3.3.3.3")
            .build());

    }
}

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

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

import pulumi
import pulumi_iosxe as iosxe

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

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

Using getBgpIpv4UnicastNeighbor

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.

TypeScript
Python
Go
C#
Java
YAML

function getBgpIpv4UnicastNeighbor(args: GetBgpIpv4UnicastNeighborArgs, opts?: InvokeOptions): Promise<GetBgpIpv4UnicastNeighborResult>
function getBgpIpv4UnicastNeighborOutput(args: GetBgpIpv4UnicastNeighborOutputArgs, opts?: InvokeOptions): Output<GetBgpIpv4UnicastNeighborResult>

def get_bgp_ipv4_unicast_neighbor(asn: Optional[str] = None,
                                  device: Optional[str] = None,
                                  ip: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetBgpIpv4UnicastNeighborResult
def get_bgp_ipv4_unicast_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[GetBgpIpv4UnicastNeighborResult]

func LookupBgpIpv4UnicastNeighbor(ctx *Context, args *LookupBgpIpv4UnicastNeighborArgs, opts ...InvokeOption) (*LookupBgpIpv4UnicastNeighborResult, error)
func LookupBgpIpv4UnicastNeighborOutput(ctx *Context, args *LookupBgpIpv4UnicastNeighborOutputArgs, opts ...InvokeOption) LookupBgpIpv4UnicastNeighborResultOutput

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

public static class GetBgpIpv4UnicastNeighbor 
{
    public static Task<GetBgpIpv4UnicastNeighborResult> InvokeAsync(GetBgpIpv4UnicastNeighborArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpIpv4UnicastNeighborResult> Invoke(GetBgpIpv4UnicastNeighborInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBgpIpv4UnicastNeighborResult> getBgpIpv4UnicastNeighbor(GetBgpIpv4UnicastNeighborArgs args, InvokeOptions options)
public static Output<GetBgpIpv4UnicastNeighborResult> getBgpIpv4UnicastNeighbor(GetBgpIpv4UnicastNeighborArgs args, InvokeOptions options)

fn::invoke:
  function: iosxe:index/getBgpIpv4UnicastNeighbor:getBgpIpv4UnicastNeighbor
  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.

getBgpIpv4UnicastNeighbor Result

The following output properties are available:

Activate bool: Enable the address family for this neighbor
Asn string
Id string: The path of the retrieved object.
Ip string
RouteMaps List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetBgpIpv4UnicastNeighborRouteMap>: Apply route map to neighbor
RouteReflectorClient bool: Configure a neighbor as Route Reflector client
SendCommunity string
Device string: A device name from the provider configuration.

Activate bool: Enable the address family for this neighbor
Asn string
Id string: The path of the retrieved object.
Ip string
RouteMaps []GetBgpIpv4UnicastNeighborRouteMap: Apply route map to neighbor
RouteReflectorClient bool: Configure a neighbor as Route Reflector client
SendCommunity string
Device string: A device name from the provider configuration.

activate Boolean: Enable the address family for this neighbor
asn String
id String: The path of the retrieved object.
ip String
routeMaps List<GetBgpIpv4UnicastNeighborRouteMap>: Apply route map to neighbor
routeReflectorClient Boolean: Configure a neighbor as Route Reflector client
sendCommunity String
device String: A device name from the provider configuration.

activate boolean: Enable the address family for this neighbor
asn string
id string: The path of the retrieved object.
ip string
routeMaps GetBgpIpv4UnicastNeighborRouteMap[]: Apply route map to neighbor
routeReflectorClient boolean: Configure a neighbor as Route Reflector client
sendCommunity string
device string: A device name from the provider configuration.

activate bool: Enable the address family for this neighbor
asn str
id str: The path of the retrieved object.
ip str
route_maps Sequence[GetBgpIpv4UnicastNeighborRouteMap]: Apply route map to neighbor
route_reflector_client bool: Configure a neighbor as Route Reflector client
send_community str
device str: A device name from the provider configuration.

activate Boolean: Enable the address family for this neighbor
asn String
id String: The path of the retrieved object.
ip String
routeMaps List<Property Map>: Apply route map to neighbor
routeReflectorClient Boolean: Configure a neighbor as Route Reflector client
sendCommunity String
device String: A device name from the provider configuration.