Docs Packages
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getBgpAddressFamily
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.getBgpAddressFamily

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

    This data source can read the BGP (VRF) address family configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetBgpAddressFamily.Invoke(new()
    {
        AddressFamily = "ipv4-ucast",
        Asn = "65001",
        Vrf = "default",
    });

});

    package main

import (
	"github.com/lbrlabs/pulumi-nxos/sdk/go/nxos"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nxos.LookupBgpAddressFamily(ctx, &nxos.LookupBgpAddressFamilyArgs{
			AddressFamily: "ipv4-ucast",
			Asn:           "65001",
			Vrf:           "default",
		}, 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.nxos.NxosFunctions;
import com.pulumi.nxos.inputs.GetBgpAddressFamilyArgs;
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 = NxosFunctions.getBgpAddressFamily(GetBgpAddressFamilyArgs.builder()
            .addressFamily("ipv4-ucast")
            .asn("65001")
            .vrf("default")
            .build());

    }
}

    import pulumi
import pulumi_nxos as nxos

example = nxos.get_bgp_address_family(address_family="ipv4-ucast",
    asn="65001",
    vrf="default")

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

const example = nxos.getBgpAddressFamily({
    addressFamily: "ipv4-ucast",
    asn: "65001",
    vrf: "default",
});

    variables:
  example:
    fn::invoke:
      Function: nxos:getBgpAddressFamily
      Arguments:
        addressFamily: ipv4-ucast
        asn: '65001'
        vrf: default

    Using getBgpAddressFamily

    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 getBgpAddressFamily(args: GetBgpAddressFamilyArgs, opts?: InvokeOptions): Promise<GetBgpAddressFamilyResult>
function getBgpAddressFamilyOutput(args: GetBgpAddressFamilyOutputArgs, opts?: InvokeOptions): Output<GetBgpAddressFamilyResult>
    def get_bgp_address_family(address_family: Optional[str] = None,
                           asn: Optional[str] = None,
                           device: Optional[str] = None,
                           vrf: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBgpAddressFamilyResult
def get_bgp_address_family_output(address_family: Optional[pulumi.Input[str]] = None,
                           asn: Optional[pulumi.Input[str]] = None,
                           device: Optional[pulumi.Input[str]] = None,
                           vrf: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBgpAddressFamilyResult]
    func LookupBgpAddressFamily(ctx *Context, args *LookupBgpAddressFamilyArgs, opts ...InvokeOption) (*LookupBgpAddressFamilyResult, error)
func LookupBgpAddressFamilyOutput(ctx *Context, args *LookupBgpAddressFamilyOutputArgs, opts ...InvokeOption) LookupBgpAddressFamilyResultOutput

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

    public static class GetBgpAddressFamily 
{
    public static Task<GetBgpAddressFamilyResult> InvokeAsync(GetBgpAddressFamilyArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpAddressFamilyResult> Invoke(GetBgpAddressFamilyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBgpAddressFamilyResult> getBgpAddressFamily(GetBgpAddressFamilyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: nxos:index/getBgpAddressFamily:getBgpAddressFamily
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AddressFamily string
    Address Family.
    Asn string
    Autonomous system number.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    AddressFamily string
    Address Family.
    Asn string
    Autonomous system number.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    addressFamily String
    Address Family.
    asn String
    Autonomous system number.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    addressFamily string
    Address Family.
    asn string
    Autonomous system number.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    address_family str
    Address Family.
    asn str
    Autonomous system number.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    addressFamily String
    Address Family.
    asn String
    Autonomous system number.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.

    getBgpAddressFamily Result

    The following output properties are available:

    AddressFamily string
    Address Family.
    Asn string
    Autonomous system number.
    CriticalNexthopTimeout int
    The next-hop address tracking delay timer for critical next-hop reachability routes.
    Id string
    The distinguished name of the object.
    NonCriticalNexthopTimeout int
    The next-hop address tracking delay timer for non-critical next-hop reachability routes.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    AddressFamily string
    Address Family.
    Asn string
    Autonomous system number.
    CriticalNexthopTimeout int
    The next-hop address tracking delay timer for critical next-hop reachability routes.
    Id string
    The distinguished name of the object.
    NonCriticalNexthopTimeout int
    The next-hop address tracking delay timer for non-critical next-hop reachability routes.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    addressFamily String
    Address Family.
    asn String
    Autonomous system number.
    criticalNexthopTimeout Integer
    The next-hop address tracking delay timer for critical next-hop reachability routes.
    id String
    The distinguished name of the object.
    nonCriticalNexthopTimeout Integer
    The next-hop address tracking delay timer for non-critical next-hop reachability routes.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    addressFamily string
    Address Family.
    asn string
    Autonomous system number.
    criticalNexthopTimeout number
    The next-hop address tracking delay timer for critical next-hop reachability routes.
    id string
    The distinguished name of the object.
    nonCriticalNexthopTimeout number
    The next-hop address tracking delay timer for non-critical next-hop reachability routes.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    address_family str
    Address Family.
    asn str
    Autonomous system number.
    critical_nexthop_timeout int
    The next-hop address tracking delay timer for critical next-hop reachability routes.
    id str
    The distinguished name of the object.
    non_critical_nexthop_timeout int
    The next-hop address tracking delay timer for non-critical next-hop reachability routes.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    addressFamily String
    Address Family.
    asn String
    Autonomous system number.
    criticalNexthopTimeout Number
    The next-hop address tracking delay timer for critical next-hop reachability routes.
    id String
    The distinguished name of the object.
    nonCriticalNexthopTimeout Number
    The next-hop address tracking delay timer for non-critical next-hop reachability routes.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.

    Package Details

    Repository
    nxos lbrlabs/pulumi-nxos
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nxos Terraform Provider.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
    lbrlabs/pulumi-nxos