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

nxos.getBgpVrf

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 domain (VRF) configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetBgpVrf.Invoke(new()
    {
        Asn = "65001",
        Name = "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.LookupBgpVrf(ctx, &nxos.LookupBgpVrfArgs{
			Asn:  "65001",
			Name: "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.GetBgpVrfArgs;
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.getBgpVrf(GetBgpVrfArgs.builder()
            .asn("65001")
            .name("default")
            .build());

    }
}

    import pulumi
import pulumi_nxos as nxos

example = nxos.get_bgp_vrf(asn="65001",
    name="default")

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

const example = nxos.getBgpVrf({
    asn: "65001",
    name: "default",
});

    variables:
  example:
    fn::invoke:
      Function: nxos:getBgpVrf
      Arguments:
        asn: '65001'
        name: default

    Using getBgpVrf

    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 getBgpVrf(args: GetBgpVrfArgs, opts?: InvokeOptions): Promise<GetBgpVrfResult>
function getBgpVrfOutput(args: GetBgpVrfOutputArgs, opts?: InvokeOptions): Output<GetBgpVrfResult>
    def get_bgp_vrf(asn: Optional[str] = None,
                device: Optional[str] = None,
                name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBgpVrfResult
def get_bgp_vrf_output(asn: Optional[pulumi.Input[str]] = None,
                device: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetBgpVrfResult]
    func LookupBgpVrf(ctx *Context, args *LookupBgpVrfArgs, opts ...InvokeOption) (*LookupBgpVrfResult, error)
func LookupBgpVrfOutput(ctx *Context, args *LookupBgpVrfOutputArgs, opts ...InvokeOption) LookupBgpVrfResultOutput

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

    public static class GetBgpVrf 
{
    public static Task<GetBgpVrfResult> InvokeAsync(GetBgpVrfArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpVrfResult> Invoke(GetBgpVrfInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBgpVrfResult> getBgpVrf(GetBgpVrfArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Asn string
    Autonomous system number.
    Name string
    VRF name.
    Device string
    A device name from the provider configuration.
    Asn string
    Autonomous system number.
    Name string
    VRF name.
    Device string
    A device name from the provider configuration.
    asn String
    Autonomous system number.
    name String
    VRF name.
    device String
    A device name from the provider configuration.
    asn string
    Autonomous system number.
    name string
    VRF name.
    device string
    A device name from the provider configuration.
    asn str
    Autonomous system number.
    name str
    VRF name.
    device str
    A device name from the provider configuration.
    asn String
    Autonomous system number.
    name String
    VRF name.
    device String
    A device name from the provider configuration.

    getBgpVrf Result

    The following output properties are available:

    Asn string
    Autonomous system number.
    Id string
    The distinguished name of the object.
    Name string
    VRF name.
    RouterId string
    Router ID.
    Device string
    A device name from the provider configuration.
    Asn string
    Autonomous system number.
    Id string
    The distinguished name of the object.
    Name string
    VRF name.
    RouterId string
    Router ID.
    Device string
    A device name from the provider configuration.
    asn String
    Autonomous system number.
    id String
    The distinguished name of the object.
    name String
    VRF name.
    routerId String
    Router ID.
    device String
    A device name from the provider configuration.
    asn string
    Autonomous system number.
    id string
    The distinguished name of the object.
    name string
    VRF name.
    routerId string
    Router ID.
    device string
    A device name from the provider configuration.
    asn str
    Autonomous system number.
    id str
    The distinguished name of the object.
    name str
    VRF name.
    router_id str
    Router ID.
    device str
    A device name from the provider configuration.
    asn String
    Autonomous system number.
    id String
    The distinguished name of the object.
    name String
    VRF name.
    routerId String
    Router ID.
    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