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

nxos.getBgpGracefulRestart

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) graceful restart configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetBgpGracefulRestart.Invoke(new()
    {
        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.LookupBgpGracefulRestart(ctx, &nxos.LookupBgpGracefulRestartArgs{
			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.GetBgpGracefulRestartArgs;
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.getBgpGracefulRestart(GetBgpGracefulRestartArgs.builder()
            .asn("65001")
            .vrf("default")
            .build());

    }
}

    import pulumi
import pulumi_nxos as nxos

example = nxos.get_bgp_graceful_restart(asn="65001",
    vrf="default")

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

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

    variables:
  example:
    fn::invoke:
      Function: nxos:getBgpGracefulRestart
      Arguments:
        asn: '65001'
        vrf: default

    Using getBgpGracefulRestart

    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 getBgpGracefulRestart(args: GetBgpGracefulRestartArgs, opts?: InvokeOptions): Promise<GetBgpGracefulRestartResult>
function getBgpGracefulRestartOutput(args: GetBgpGracefulRestartOutputArgs, opts?: InvokeOptions): Output<GetBgpGracefulRestartResult>
    def get_bgp_graceful_restart(asn: Optional[str] = None,
                             device: Optional[str] = None,
                             vrf: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetBgpGracefulRestartResult
def get_bgp_graceful_restart_output(asn: Optional[pulumi.Input[str]] = None,
                             device: Optional[pulumi.Input[str]] = None,
                             vrf: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetBgpGracefulRestartResult]
    func LookupBgpGracefulRestart(ctx *Context, args *LookupBgpGracefulRestartArgs, opts ...InvokeOption) (*LookupBgpGracefulRestartResult, error)
func LookupBgpGracefulRestartOutput(ctx *Context, args *LookupBgpGracefulRestartOutputArgs, opts ...InvokeOption) LookupBgpGracefulRestartResultOutput

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

    public static class GetBgpGracefulRestart 
{
    public static Task<GetBgpGracefulRestartResult> InvokeAsync(GetBgpGracefulRestartArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpGracefulRestartResult> Invoke(GetBgpGracefulRestartInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBgpGracefulRestartResult> getBgpGracefulRestart(GetBgpGracefulRestartArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

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

    getBgpGracefulRestart Result

    The following output properties are available:

    Asn string
    Autonomous system number.
    Id string
    The distinguished name of the object.
    RestartInterval int
    The graceful restart interval.
    StaleInterval int
    The stale interval for routes advertised by the BGP peer.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    Asn string
    Autonomous system number.
    Id string
    The distinguished name of the object.
    RestartInterval int
    The graceful restart interval.
    StaleInterval int
    The stale interval for routes advertised by the BGP peer.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    asn String
    Autonomous system number.
    id String
    The distinguished name of the object.
    restartInterval Integer
    The graceful restart interval.
    staleInterval Integer
    The stale interval for routes advertised by the BGP peer.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    asn string
    Autonomous system number.
    id string
    The distinguished name of the object.
    restartInterval number
    The graceful restart interval.
    staleInterval number
    The stale interval for routes advertised by the BGP peer.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    asn str
    Autonomous system number.
    id str
    The distinguished name of the object.
    restart_interval int
    The graceful restart interval.
    stale_interval int
    The stale interval for routes advertised by the BGP peer.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    asn String
    Autonomous system number.
    id String
    The distinguished name of the object.
    restartInterval Number
    The graceful restart interval.
    staleInterval Number
    The stale interval for routes advertised by the BGP peer.
    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