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

nxos.BgpGracefulRestart

Explore with Pulumi AI

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

    This resource can manage the BGP domain (VRF) graceful restart configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.BgpGracefulRestart("example", new()
        {
            Asn = "65001",
            RestartInterval = 240,
            StaleInterval = 1800,
            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.NewBgpGracefulRestart(ctx, "example", &nxos.BgpGracefulRestartArgs{
    			Asn:             pulumi.String("65001"),
    			RestartInterval: pulumi.Int(240),
    			StaleInterval:   pulumi.Int(1800),
    			Vrf:             pulumi.String("default"),
    		})
    		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.BgpGracefulRestart;
    import com.pulumi.nxos.BgpGracefulRestartArgs;
    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) {
            var example = new BgpGracefulRestart("example", BgpGracefulRestartArgs.builder()        
                .asn("65001")
                .restartInterval(240)
                .staleInterval(1800)
                .vrf("default")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.BgpGracefulRestart("example",
        asn="65001",
        restart_interval=240,
        stale_interval=1800,
        vrf="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.BgpGracefulRestart("example", {
        asn: "65001",
        restartInterval: 240,
        staleInterval: 1800,
        vrf: "default",
    });
    
    resources:
      example:
        type: nxos:BgpGracefulRestart
        properties:
          asn: '65001'
          restartInterval: 240
          staleInterval: 1800
          vrf: default
    

    Create BgpGracefulRestart Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BgpGracefulRestart(name: string, args: BgpGracefulRestartArgs, opts?: CustomResourceOptions);
    @overload
    def BgpGracefulRestart(resource_name: str,
                           args: BgpGracefulRestartArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def BgpGracefulRestart(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           asn: Optional[str] = None,
                           vrf: Optional[str] = None,
                           device: Optional[str] = None,
                           restart_interval: Optional[int] = None,
                           stale_interval: Optional[int] = None)
    func NewBgpGracefulRestart(ctx *Context, name string, args BgpGracefulRestartArgs, opts ...ResourceOption) (*BgpGracefulRestart, error)
    public BgpGracefulRestart(string name, BgpGracefulRestartArgs args, CustomResourceOptions? opts = null)
    public BgpGracefulRestart(String name, BgpGracefulRestartArgs args)
    public BgpGracefulRestart(String name, BgpGracefulRestartArgs args, CustomResourceOptions options)
    
    type: nxos:BgpGracefulRestart
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BgpGracefulRestartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BgpGracefulRestartArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BgpGracefulRestartArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpGracefulRestartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpGracefulRestartArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var bgpGracefulRestartResource = new Nxos.BgpGracefulRestart("bgpGracefulRestartResource", new()
    {
        Asn = "string",
        Vrf = "string",
        Device = "string",
        RestartInterval = 0,
        StaleInterval = 0,
    });
    
    example, err := nxos.NewBgpGracefulRestart(ctx, "bgpGracefulRestartResource", &nxos.BgpGracefulRestartArgs{
    	Asn:             pulumi.String("string"),
    	Vrf:             pulumi.String("string"),
    	Device:          pulumi.String("string"),
    	RestartInterval: pulumi.Int(0),
    	StaleInterval:   pulumi.Int(0),
    })
    
    var bgpGracefulRestartResource = new BgpGracefulRestart("bgpGracefulRestartResource", BgpGracefulRestartArgs.builder()        
        .asn("string")
        .vrf("string")
        .device("string")
        .restartInterval(0)
        .staleInterval(0)
        .build());
    
    bgp_graceful_restart_resource = nxos.BgpGracefulRestart("bgpGracefulRestartResource",
        asn="string",
        vrf="string",
        device="string",
        restart_interval=0,
        stale_interval=0)
    
    const bgpGracefulRestartResource = new nxos.BgpGracefulRestart("bgpGracefulRestartResource", {
        asn: "string",
        vrf: "string",
        device: "string",
        restartInterval: 0,
        staleInterval: 0,
    });
    
    type: nxos:BgpGracefulRestart
    properties:
        asn: string
        device: string
        restartInterval: 0
        staleInterval: 0
        vrf: string
    

    BgpGracefulRestart Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The BgpGracefulRestart resource accepts the following input properties:

    Asn string
    Autonomous system number.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    RestartInterval int
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    StaleInterval int
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    Asn string
    Autonomous system number.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    RestartInterval int
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    StaleInterval int
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    asn String
    Autonomous system number.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    restartInterval Integer
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    staleInterval Integer
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    asn string
    Autonomous system number.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    restartInterval number
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    staleInterval number
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    asn str
    Autonomous system number.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    restart_interval int
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    stale_interval int
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    asn String
    Autonomous system number.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    restartInterval Number
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    staleInterval Number
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BgpGracefulRestart resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BgpGracefulRestart Resource

    Get an existing BgpGracefulRestart resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BgpGracefulRestartState, opts?: CustomResourceOptions): BgpGracefulRestart
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            asn: Optional[str] = None,
            device: Optional[str] = None,
            restart_interval: Optional[int] = None,
            stale_interval: Optional[int] = None,
            vrf: Optional[str] = None) -> BgpGracefulRestart
    func GetBgpGracefulRestart(ctx *Context, name string, id IDInput, state *BgpGracefulRestartState, opts ...ResourceOption) (*BgpGracefulRestart, error)
    public static BgpGracefulRestart Get(string name, Input<string> id, BgpGracefulRestartState? state, CustomResourceOptions? opts = null)
    public static BgpGracefulRestart get(String name, Output<String> id, BgpGracefulRestartState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Asn string
    Autonomous system number.
    Device string
    A device name from the provider configuration.
    RestartInterval int
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    StaleInterval int
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    Vrf string
    VRF name.
    Asn string
    Autonomous system number.
    Device string
    A device name from the provider configuration.
    RestartInterval int
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    StaleInterval int
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    Vrf string
    VRF name.
    asn String
    Autonomous system number.
    device String
    A device name from the provider configuration.
    restartInterval Integer
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    staleInterval Integer
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    vrf String
    VRF name.
    asn string
    Autonomous system number.
    device string
    A device name from the provider configuration.
    restartInterval number
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    staleInterval number
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    vrf string
    VRF name.
    asn str
    Autonomous system number.
    device str
    A device name from the provider configuration.
    restart_interval int
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    stale_interval int
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    vrf str
    VRF name.
    asn String
    Autonomous system number.
    device String
    A device name from the provider configuration.
    restartInterval Number
    The graceful restart interval. - Range: 1-3600 - Default value: 120
    staleInterval Number
    The stale interval for routes advertised by the BGP peer. - Range: 1-3600 - Default value: 300
    vrf String
    VRF name.

    Import

     $ pulumi import nxos:index/bgpGracefulRestart:BgpGracefulRestart example "sys/bgp/inst/dom-[default]/gr"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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