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

nxos.getBgpRouteControl

Explore with Pulumi AI

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

    This data source can read the BGP Route Control configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Pulumi.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Nxos.GetBgpRouteControl.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.LookupBgpRouteControl(ctx, &nxos.LookupBgpRouteControlArgs{
    			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.GetBgpRouteControlArgs;
    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.getBgpRouteControl(GetBgpRouteControlArgs.builder()
                .asn("65001")
                .vrf("default")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_nxos as nxos
    
    example = nxos.get_bgp_route_control(asn="65001",
        vrf="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@pulumi/nxos";
    
    const example = nxos.getBgpRouteControl({
        asn: "65001",
        vrf: "default",
    });
    
    variables:
      example:
        fn::invoke:
          Function: nxos:getBgpRouteControl
          Arguments:
            asn: '65001'
            vrf: default
    

    Using getBgpRouteControl

    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 getBgpRouteControl(args: GetBgpRouteControlArgs, opts?: InvokeOptions): Promise<GetBgpRouteControlResult>
    function getBgpRouteControlOutput(args: GetBgpRouteControlOutputArgs, opts?: InvokeOptions): Output<GetBgpRouteControlResult>
    def get_bgp_route_control(asn: Optional[str] = None,
                              device: Optional[str] = None,
                              vrf: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetBgpRouteControlResult
    def get_bgp_route_control_output(asn: Optional[pulumi.Input[str]] = None,
                              device: Optional[pulumi.Input[str]] = None,
                              vrf: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetBgpRouteControlResult]
    func LookupBgpRouteControl(ctx *Context, args *LookupBgpRouteControlArgs, opts ...InvokeOption) (*LookupBgpRouteControlResult, error)
    func LookupBgpRouteControlOutput(ctx *Context, args *LookupBgpRouteControlOutputArgs, opts ...InvokeOption) LookupBgpRouteControlResultOutput

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

    public static class GetBgpRouteControl 
    {
        public static Task<GetBgpRouteControlResult> InvokeAsync(GetBgpRouteControlArgs args, InvokeOptions? opts = null)
        public static Output<GetBgpRouteControlResult> Invoke(GetBgpRouteControlInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBgpRouteControlResult> getBgpRouteControl(GetBgpRouteControlArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nxos:index/getBgpRouteControl:getBgpRouteControl
      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.

    getBgpRouteControl Result

    The following output properties are available:

    Asn string
    Autonomous system number.
    EnforceFirstAs string
    Enforce First AS For Ebgp. Can be configured only for VRF default.
    FibAccelerate string
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default.
    Id string
    The distinguished name of the object.
    LogNeighborChanges string
    Log Neighbor Changes.
    SuppressRoutes string
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    Asn string
    Autonomous system number.
    EnforceFirstAs string
    Enforce First AS For Ebgp. Can be configured only for VRF default.
    FibAccelerate string
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default.
    Id string
    The distinguished name of the object.
    LogNeighborChanges string
    Log Neighbor Changes.
    SuppressRoutes string
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    asn String
    Autonomous system number.
    enforceFirstAs String
    Enforce First AS For Ebgp. Can be configured only for VRF default.
    fibAccelerate String
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default.
    id String
    The distinguished name of the object.
    logNeighborChanges String
    Log Neighbor Changes.
    suppressRoutes String
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    asn string
    Autonomous system number.
    enforceFirstAs string
    Enforce First AS For Ebgp. Can be configured only for VRF default.
    fibAccelerate string
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default.
    id string
    The distinguished name of the object.
    logNeighborChanges string
    Log Neighbor Changes.
    suppressRoutes string
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    asn str
    Autonomous system number.
    enforce_first_as str
    Enforce First AS For Ebgp. Can be configured only for VRF default.
    fib_accelerate str
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default.
    id str
    The distinguished name of the object.
    log_neighbor_changes str
    Log Neighbor Changes.
    suppress_routes str
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    asn String
    Autonomous system number.
    enforceFirstAs String
    Enforce First AS For Ebgp. Can be configured only for VRF default.
    fibAccelerate String
    Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor. Can be configured only for VRF default.
    id String
    The distinguished name of the object.
    logNeighborChanges String
    Log Neighbor Changes.
    suppressRoutes String
    Suppress Routes: Advertise only routes that are programmed in hardware to peers. Can be configured only for VRF default.
    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