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

nxos.BgpRouteControl

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 Route Control 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.BgpRouteControl("example", new()
        {
            Asn = "65001",
            EnforceFirstAs = "disabled",
            FibAccelerate = "enabled",
            LogNeighborChanges = "enabled",
            SuppressRoutes = "disabled",
            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.NewBgpRouteControl(ctx, "example", &nxos.BgpRouteControlArgs{
    			Asn:                pulumi.String("65001"),
    			EnforceFirstAs:     pulumi.String("disabled"),
    			FibAccelerate:      pulumi.String("enabled"),
    			LogNeighborChanges: pulumi.String("enabled"),
    			SuppressRoutes:     pulumi.String("disabled"),
    			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.BgpRouteControl;
    import com.pulumi.nxos.BgpRouteControlArgs;
    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 BgpRouteControl("example", BgpRouteControlArgs.builder()        
                .asn("65001")
                .enforceFirstAs("disabled")
                .fibAccelerate("enabled")
                .logNeighborChanges("enabled")
                .suppressRoutes("disabled")
                .vrf("default")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.BgpRouteControl("example",
        asn="65001",
        enforce_first_as="disabled",
        fib_accelerate="enabled",
        log_neighbor_changes="enabled",
        suppress_routes="disabled",
        vrf="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.BgpRouteControl("example", {
        asn: "65001",
        enforceFirstAs: "disabled",
        fibAccelerate: "enabled",
        logNeighborChanges: "enabled",
        suppressRoutes: "disabled",
        vrf: "default",
    });
    
    resources:
      example:
        type: nxos:BgpRouteControl
        properties:
          asn: '65001'
          enforceFirstAs: disabled
          fibAccelerate: enabled
          logNeighborChanges: enabled
          suppressRoutes: disabled
          vrf: default
    

    Create BgpRouteControl Resource

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

    Constructor syntax

    new BgpRouteControl(name: string, args: BgpRouteControlArgs, opts?: CustomResourceOptions);
    @overload
    def BgpRouteControl(resource_name: str,
                        args: BgpRouteControlArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def BgpRouteControl(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        asn: Optional[str] = None,
                        vrf: Optional[str] = None,
                        device: Optional[str] = None,
                        enforce_first_as: Optional[str] = None,
                        fib_accelerate: Optional[str] = None,
                        log_neighbor_changes: Optional[str] = None,
                        suppress_routes: Optional[str] = None)
    func NewBgpRouteControl(ctx *Context, name string, args BgpRouteControlArgs, opts ...ResourceOption) (*BgpRouteControl, error)
    public BgpRouteControl(string name, BgpRouteControlArgs args, CustomResourceOptions? opts = null)
    public BgpRouteControl(String name, BgpRouteControlArgs args)
    public BgpRouteControl(String name, BgpRouteControlArgs args, CustomResourceOptions options)
    
    type: nxos:BgpRouteControl
    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 BgpRouteControlArgs
    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 BgpRouteControlArgs
    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 BgpRouteControlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpRouteControlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpRouteControlArgs
    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 bgpRouteControlResource = new Nxos.BgpRouteControl("bgpRouteControlResource", new()
    {
        Asn = "string",
        Vrf = "string",
        Device = "string",
        EnforceFirstAs = "string",
        FibAccelerate = "string",
        LogNeighborChanges = "string",
        SuppressRoutes = "string",
    });
    
    example, err := nxos.NewBgpRouteControl(ctx, "bgpRouteControlResource", &nxos.BgpRouteControlArgs{
    	Asn:                pulumi.String("string"),
    	Vrf:                pulumi.String("string"),
    	Device:             pulumi.String("string"),
    	EnforceFirstAs:     pulumi.String("string"),
    	FibAccelerate:      pulumi.String("string"),
    	LogNeighborChanges: pulumi.String("string"),
    	SuppressRoutes:     pulumi.String("string"),
    })
    
    var bgpRouteControlResource = new BgpRouteControl("bgpRouteControlResource", BgpRouteControlArgs.builder()        
        .asn("string")
        .vrf("string")
        .device("string")
        .enforceFirstAs("string")
        .fibAccelerate("string")
        .logNeighborChanges("string")
        .suppressRoutes("string")
        .build());
    
    bgp_route_control_resource = nxos.BgpRouteControl("bgpRouteControlResource",
        asn="string",
        vrf="string",
        device="string",
        enforce_first_as="string",
        fib_accelerate="string",
        log_neighbor_changes="string",
        suppress_routes="string")
    
    const bgpRouteControlResource = new nxos.BgpRouteControl("bgpRouteControlResource", {
        asn: "string",
        vrf: "string",
        device: "string",
        enforceFirstAs: "string",
        fibAccelerate: "string",
        logNeighborChanges: "string",
        suppressRoutes: "string",
    });
    
    type: nxos:BgpRouteControl
    properties:
        asn: string
        device: string
        enforceFirstAs: string
        fibAccelerate: string
        logNeighborChanges: string
        suppressRoutes: string
        vrf: string
    

    BgpRouteControl 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 BgpRouteControl resource accepts the following input properties:

    Asn string
    Autonomous system number.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    EnforceFirstAs string
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    FibAccelerate string
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    LogNeighborChanges string
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    SuppressRoutes string
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    Asn string
    Autonomous system number.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    EnforceFirstAs string
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    FibAccelerate string
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    LogNeighborChanges string
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    SuppressRoutes string
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    asn String
    Autonomous system number.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    enforceFirstAs String
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    fibAccelerate String
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    logNeighborChanges String
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    suppressRoutes String
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    asn string
    Autonomous system number.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    enforceFirstAs string
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    fibAccelerate string
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    logNeighborChanges string
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    suppressRoutes string
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    asn str
    Autonomous system number.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    enforce_first_as str
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    fib_accelerate str
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    log_neighbor_changes str
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    suppress_routes str
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    asn String
    Autonomous system number.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    enforceFirstAs String
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    fibAccelerate String
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    logNeighborChanges String
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    suppressRoutes String
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BgpRouteControl 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 BgpRouteControl Resource

    Get an existing BgpRouteControl 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?: BgpRouteControlState, opts?: CustomResourceOptions): BgpRouteControl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            asn: Optional[str] = None,
            device: Optional[str] = None,
            enforce_first_as: Optional[str] = None,
            fib_accelerate: Optional[str] = None,
            log_neighbor_changes: Optional[str] = None,
            suppress_routes: Optional[str] = None,
            vrf: Optional[str] = None) -> BgpRouteControl
    func GetBgpRouteControl(ctx *Context, name string, id IDInput, state *BgpRouteControlState, opts ...ResourceOption) (*BgpRouteControl, error)
    public static BgpRouteControl Get(string name, Input<string> id, BgpRouteControlState? state, CustomResourceOptions? opts = null)
    public static BgpRouteControl get(String name, Output<String> id, BgpRouteControlState 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.
    EnforceFirstAs string
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    FibAccelerate string
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    LogNeighborChanges string
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    SuppressRoutes string
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    Vrf string
    VRF name.
    Asn string
    Autonomous system number.
    Device string
    A device name from the provider configuration.
    EnforceFirstAs string
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    FibAccelerate string
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    LogNeighborChanges string
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    SuppressRoutes string
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    Vrf string
    VRF name.
    asn String
    Autonomous system number.
    device String
    A device name from the provider configuration.
    enforceFirstAs String
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    fibAccelerate String
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    logNeighborChanges String
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    suppressRoutes String
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    vrf String
    VRF name.
    asn string
    Autonomous system number.
    device string
    A device name from the provider configuration.
    enforceFirstAs string
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    fibAccelerate string
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    logNeighborChanges string
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    suppressRoutes string
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    vrf string
    VRF name.
    asn str
    Autonomous system number.
    device str
    A device name from the provider configuration.
    enforce_first_as str
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    fib_accelerate str
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    log_neighbor_changes str
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    suppress_routes str
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    vrf str
    VRF name.
    asn String
    Autonomous system number.
    device String
    A device name from the provider configuration.
    enforceFirstAs String
    Enforce First AS For Ebgp. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: enabled
    fibAccelerate String
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default. - Choices: enabled, disabled - Default value: disabled
    logNeighborChanges String
    Log Neighbor Changes. - Choices: enabled, disabled - Default value: disabled
    suppressRoutes String
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.

    • Choices: enabled, disabled - Default value: enabled
    vrf String
    VRF name.

    Import

     $ pulumi import nxos:index/bgpRouteControl:BgpRouteControl example "sys/bgp/inst/dom-[default]/rtctrl"
    

    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