Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getBgpAddressFamilyIpv4
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

iosxe.getBgpAddressFamilyIpv4

Explore with Pulumi AI

iosxe logo
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

    This data source can read the BGP Address Family IPv4 configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetBgpAddressFamilyIpv4.Invoke(new()
    {
        AfName = "unicast",
        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.LookupBgpAddressFamilyIpv4(ctx, &iosxe.LookupBgpAddressFamilyIpv4Args{
			AfName: "unicast",
			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.GetBgpAddressFamilyIpv4Args;
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.getBgpAddressFamilyIpv4(GetBgpAddressFamilyIpv4Args.builder()
            .afName("unicast")
            .asn("65000")
            .build());

    }
}

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_bgp_address_family_ipv4(af_name="unicast",
    asn="65000")

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

const example = iosxe.getBgpAddressFamilyIpv4({
    afName: "unicast",
    asn: "65000",
});

    variables:
  example:
    fn::invoke:
      Function: iosxe:getBgpAddressFamilyIpv4
      Arguments:
        afName: unicast
        asn: '65000'

    Using getBgpAddressFamilyIpv4

    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 getBgpAddressFamilyIpv4(args: GetBgpAddressFamilyIpv4Args, opts?: InvokeOptions): Promise<GetBgpAddressFamilyIpv4Result>
function getBgpAddressFamilyIpv4Output(args: GetBgpAddressFamilyIpv4OutputArgs, opts?: InvokeOptions): Output<GetBgpAddressFamilyIpv4Result>
    def get_bgp_address_family_ipv4(af_name: Optional[str] = None,
                                asn: Optional[str] = None,
                                device: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetBgpAddressFamilyIpv4Result
def get_bgp_address_family_ipv4_output(af_name: Optional[pulumi.Input[str]] = None,
                                asn: Optional[pulumi.Input[str]] = None,
                                device: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetBgpAddressFamilyIpv4Result]
    func LookupBgpAddressFamilyIpv4(ctx *Context, args *LookupBgpAddressFamilyIpv4Args, opts ...InvokeOption) (*LookupBgpAddressFamilyIpv4Result, error)
func LookupBgpAddressFamilyIpv4Output(ctx *Context, args *LookupBgpAddressFamilyIpv4OutputArgs, opts ...InvokeOption) LookupBgpAddressFamilyIpv4ResultOutput

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

    public static class GetBgpAddressFamilyIpv4 
{
    public static Task<GetBgpAddressFamilyIpv4Result> InvokeAsync(GetBgpAddressFamilyIpv4Args args, InvokeOptions? opts = null)
    public static Output<GetBgpAddressFamilyIpv4Result> Invoke(GetBgpAddressFamilyIpv4InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBgpAddressFamilyIpv4Result> getBgpAddressFamilyIpv4(GetBgpAddressFamilyIpv4Args args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

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

    getBgpAddressFamilyIpv4 Result

    The following output properties are available:

    AfName string
    Asn string
    Id string
    The path of the retrieved object.
    Ipv4UnicastNetworks List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetBgpAddressFamilyIpv4Ipv4UnicastNetwork>
    Specify a network to announce via BGP
    Ipv4UnicastNetworksMasks List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetBgpAddressFamilyIpv4Ipv4UnicastNetworksMask>
    Specify a network to announce via BGP
    Ipv4UnicastRedistributeConnected bool
    Connected
    Ipv4UnicastRedistributeStatic bool
    Static routes
    Device string
    A device name from the provider configuration.
    AfName string
    Asn string
    Id string
    The path of the retrieved object.
    Ipv4UnicastNetworks []GetBgpAddressFamilyIpv4Ipv4UnicastNetwork
    Specify a network to announce via BGP
    Ipv4UnicastNetworksMasks []GetBgpAddressFamilyIpv4Ipv4UnicastNetworksMask
    Specify a network to announce via BGP
    Ipv4UnicastRedistributeConnected bool
    Connected
    Ipv4UnicastRedistributeStatic bool
    Static routes
    Device string
    A device name from the provider configuration.
    afName String
    asn String
    id String
    The path of the retrieved object.
    ipv4UnicastNetworks List<GetBgpAddressFamilyIpv4Ipv4UnicastNetwork>
    Specify a network to announce via BGP
    ipv4UnicastNetworksMasks List<GetBgpAddressFamilyIpv4Ipv4UnicastNetworksMask>
    Specify a network to announce via BGP
    ipv4UnicastRedistributeConnected Boolean
    Connected
    ipv4UnicastRedistributeStatic Boolean
    Static routes
    device String
    A device name from the provider configuration.
    afName string
    asn string
    id string
    The path of the retrieved object.
    ipv4UnicastNetworks GetBgpAddressFamilyIpv4Ipv4UnicastNetwork[]
    Specify a network to announce via BGP
    ipv4UnicastNetworksMasks GetBgpAddressFamilyIpv4Ipv4UnicastNetworksMask[]
    Specify a network to announce via BGP
    ipv4UnicastRedistributeConnected boolean
    Connected
    ipv4UnicastRedistributeStatic boolean
    Static routes
    device string
    A device name from the provider configuration.
    af_name str
    asn str
    id str
    The path of the retrieved object.
    ipv4_unicast_networks Sequence[GetBgpAddressFamilyIpv4Ipv4UnicastNetwork]
    Specify a network to announce via BGP
    ipv4_unicast_networks_masks Sequence[GetBgpAddressFamilyIpv4Ipv4UnicastNetworksMask]
    Specify a network to announce via BGP
    ipv4_unicast_redistribute_connected bool
    Connected
    ipv4_unicast_redistribute_static bool
    Static routes
    device str
    A device name from the provider configuration.
    afName String
    asn String
    id String
    The path of the retrieved object.
    ipv4UnicastNetworks List<Property Map>
    Specify a network to announce via BGP
    ipv4UnicastNetworksMasks List<Property Map>
    Specify a network to announce via BGP
    ipv4UnicastRedistributeConnected Boolean
    Connected
    ipv4UnicastRedistributeStatic Boolean
    Static routes
    device String
    A device name from the provider configuration.

    Supporting Types

    GetBgpAddressFamilyIpv4Ipv4UnicastNetwork

    Backdoor bool
    Specify a BGP backdoor route
    Network string
    RouteMap string
    Route-map to modify the attributes
    Backdoor bool
    Specify a BGP backdoor route
    Network string
    RouteMap string
    Route-map to modify the attributes
    backdoor Boolean
    Specify a BGP backdoor route
    network String
    routeMap String
    Route-map to modify the attributes
    backdoor boolean
    Specify a BGP backdoor route
    network string
    routeMap string
    Route-map to modify the attributes
    backdoor bool
    Specify a BGP backdoor route
    network str
    route_map str
    Route-map to modify the attributes
    backdoor Boolean
    Specify a BGP backdoor route
    network String
    routeMap String
    Route-map to modify the attributes

    GetBgpAddressFamilyIpv4Ipv4UnicastNetworksMask

    Backdoor bool
    Specify a BGP backdoor route
    Mask string
    Network mask
    Network string
    RouteMap string
    Route-map to modify the attributes
    Backdoor bool
    Specify a BGP backdoor route
    Mask string
    Network mask
    Network string
    RouteMap string
    Route-map to modify the attributes
    backdoor Boolean
    Specify a BGP backdoor route
    mask String
    Network mask
    network String
    routeMap String
    Route-map to modify the attributes
    backdoor boolean
    Specify a BGP backdoor route
    mask string
    Network mask
    network string
    routeMap string
    Route-map to modify the attributes
    backdoor bool
    Specify a BGP backdoor route
    mask str
    Network mask
    network str
    route_map str
    Route-map to modify the attributes
    backdoor Boolean
    Specify a BGP backdoor route
    mask String
    Network mask
    network String
    routeMap String
    Route-map to modify the attributes

    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
    lbrlabs/pulumi-iosxe