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

nxos.getBgp

Explore with Pulumi AI

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

This data source can read the global BGP configuration.

Example Usage

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

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

});
Copy
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.LookupBgp(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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.GetBgpArgs;
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.getBgp();

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

const example = nxos.getBgp({});
Copy
import pulumi
import pulumi_nxos as nxos

example = nxos.get_bgp()
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getBgp
      Arguments: {}
Copy

Using getBgp

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 getBgp(args: GetBgpArgs, opts?: InvokeOptions): Promise<GetBgpResult>
function getBgpOutput(args: GetBgpOutputArgs, opts?: InvokeOptions): Output<GetBgpResult>
Copy
def get_bgp(device: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetBgpResult
def get_bgp_output(device: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetBgpResult]
Copy
func LookupBgp(ctx *Context, args *LookupBgpArgs, opts ...InvokeOption) (*LookupBgpResult, error)
func LookupBgpOutput(ctx *Context, args *LookupBgpOutputArgs, opts ...InvokeOption) LookupBgpResultOutput
Copy

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

public static class GetBgp 
{
    public static Task<GetBgpResult> InvokeAsync(GetBgpArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpResult> Invoke(GetBgpInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBgpResult> getBgp(GetBgpArgs args, InvokeOptions options)
public static Output<GetBgpResult> getBgp(GetBgpArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getBgp:getBgp
  arguments:
    # arguments dictionary
Copy

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.

getBgp Result

The following output properties are available:

AdminState string
Administrative state.
Id string
The distinguished name of the object.
Device string
A device name from the provider configuration.
AdminState string
Administrative state.
Id string
The distinguished name of the object.
Device string
A device name from the provider configuration.
adminState String
Administrative state.
id String
The distinguished name of the object.
device String
A device name from the provider configuration.
adminState string
Administrative state.
id string
The distinguished name of the object.
device string
A device name from the provider configuration.
admin_state str
Administrative state.
id str
The distinguished name of the object.
device str
A device name from the provider configuration.
adminState String
Administrative state.
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.
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs