Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getBgpInstance
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.getBgpInstance

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 instance configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetBgpInstance.Invoke();

});

    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.LookupBgpInstance(ctx, nil, 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.GetBgpInstanceArgs;
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.getBgpInstance();

    }
}

    import pulumi
import pulumi_nxos as nxos

example = nxos.get_bgp_instance()

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

const example = nxos.getBgpInstance({});

    variables:
  example:
    fn::invoke:
      Function: nxos:getBgpInstance
      Arguments: {}

    Using getBgpInstance

    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 getBgpInstance(args: GetBgpInstanceArgs, opts?: InvokeOptions): Promise<GetBgpInstanceResult>
function getBgpInstanceOutput(args: GetBgpInstanceOutputArgs, opts?: InvokeOptions): Output<GetBgpInstanceResult>
    def get_bgp_instance(device: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetBgpInstanceResult
def get_bgp_instance_output(device: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetBgpInstanceResult]
    func LookupBgpInstance(ctx *Context, args *LookupBgpInstanceArgs, opts ...InvokeOption) (*LookupBgpInstanceResult, error)
func LookupBgpInstanceOutput(ctx *Context, args *LookupBgpInstanceOutputArgs, opts ...InvokeOption) LookupBgpInstanceResultOutput

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

    public static class GetBgpInstance 
{
    public static Task<GetBgpInstanceResult> InvokeAsync(GetBgpInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpInstanceResult> Invoke(GetBgpInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBgpInstanceResult> getBgpInstance(GetBgpInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Device string
    A device name from the provider configuration.
    Device string
    A device name from the provider configuration.
    device String
    A device name from the provider configuration.
    device string
    A device name from the provider configuration.
    device str
    A device name from the provider configuration.
    device String
    A device name from the provider configuration.

    getBgpInstance Result

    The following output properties are available:

    AdminState string
    Administrative state.
    Asn string
    Autonomous system number.
    EnhancedErrorHandling bool
    Enable BGP Enhanced Error Handling.
    Id string
    The distinguished name of the object.
    Device string
    A device name from the provider configuration.
    AdminState string
    Administrative state.
    Asn string
    Autonomous system number.
    EnhancedErrorHandling bool
    Enable BGP Enhanced Error Handling.
    Id string
    The distinguished name of the object.
    Device string
    A device name from the provider configuration.
    adminState String
    Administrative state.
    asn String
    Autonomous system number.
    enhancedErrorHandling Boolean
    Enable BGP Enhanced Error Handling.
    id String
    The distinguished name of the object.
    device String
    A device name from the provider configuration.
    adminState string
    Administrative state.
    asn string
    Autonomous system number.
    enhancedErrorHandling boolean
    Enable BGP Enhanced Error Handling.
    id string
    The distinguished name of the object.
    device string
    A device name from the provider configuration.
    admin_state str
    Administrative state.
    asn str
    Autonomous system number.
    enhanced_error_handling bool
    Enable BGP Enhanced Error Handling.
    id str
    The distinguished name of the object.
    device str
    A device name from the provider configuration.
    adminState String
    Administrative state.
    asn String
    Autonomous system number.
    enhancedErrorHandling Boolean
    Enable BGP Enhanced Error Handling.
    id String
    The distinguished name of the object.
    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