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

nxos.getBgpPeerAddressFamilyPrefixListControl

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 peer address family prefix list control configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Pulumi.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Nxos.GetBgpPeerAddressFamilyPrefixListControl.Invoke(new()
        {
            Address = "192.168.0.1",
            AddressFamily = "ipv4-ucast",
            Asn = "65001",
            Direction = "in",
            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.LookupBgpPeerAddressFamilyPrefixListControl(ctx, &nxos.LookupBgpPeerAddressFamilyPrefixListControlArgs{
    			Address:       "192.168.0.1",
    			AddressFamily: "ipv4-ucast",
    			Asn:           "65001",
    			Direction:     "in",
    			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.GetBgpPeerAddressFamilyPrefixListControlArgs;
    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.getBgpPeerAddressFamilyPrefixListControl(GetBgpPeerAddressFamilyPrefixListControlArgs.builder()
                .address("192.168.0.1")
                .addressFamily("ipv4-ucast")
                .asn("65001")
                .direction("in")
                .vrf("default")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_nxos as nxos
    
    example = nxos.get_bgp_peer_address_family_prefix_list_control(address="192.168.0.1",
        address_family="ipv4-ucast",
        asn="65001",
        direction="in",
        vrf="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@pulumi/nxos";
    
    const example = nxos.getBgpPeerAddressFamilyPrefixListControl({
        address: "192.168.0.1",
        addressFamily: "ipv4-ucast",
        asn: "65001",
        direction: "in",
        vrf: "default",
    });
    
    variables:
      example:
        fn::invoke:
          Function: nxos:getBgpPeerAddressFamilyPrefixListControl
          Arguments:
            address: 192.168.0.1
            addressFamily: ipv4-ucast
            asn: '65001'
            direction: in
            vrf: default
    

    Using getBgpPeerAddressFamilyPrefixListControl

    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 getBgpPeerAddressFamilyPrefixListControl(args: GetBgpPeerAddressFamilyPrefixListControlArgs, opts?: InvokeOptions): Promise<GetBgpPeerAddressFamilyPrefixListControlResult>
    function getBgpPeerAddressFamilyPrefixListControlOutput(args: GetBgpPeerAddressFamilyPrefixListControlOutputArgs, opts?: InvokeOptions): Output<GetBgpPeerAddressFamilyPrefixListControlResult>
    def get_bgp_peer_address_family_prefix_list_control(address: Optional[str] = None,
                                                        address_family: Optional[str] = None,
                                                        asn: Optional[str] = None,
                                                        device: Optional[str] = None,
                                                        direction: Optional[str] = None,
                                                        vrf: Optional[str] = None,
                                                        opts: Optional[InvokeOptions] = None) -> GetBgpPeerAddressFamilyPrefixListControlResult
    def get_bgp_peer_address_family_prefix_list_control_output(address: Optional[pulumi.Input[str]] = None,
                                                        address_family: Optional[pulumi.Input[str]] = None,
                                                        asn: Optional[pulumi.Input[str]] = None,
                                                        device: Optional[pulumi.Input[str]] = None,
                                                        direction: Optional[pulumi.Input[str]] = None,
                                                        vrf: Optional[pulumi.Input[str]] = None,
                                                        opts: Optional[InvokeOptions] = None) -> Output[GetBgpPeerAddressFamilyPrefixListControlResult]
    func LookupBgpPeerAddressFamilyPrefixListControl(ctx *Context, args *LookupBgpPeerAddressFamilyPrefixListControlArgs, opts ...InvokeOption) (*LookupBgpPeerAddressFamilyPrefixListControlResult, error)
    func LookupBgpPeerAddressFamilyPrefixListControlOutput(ctx *Context, args *LookupBgpPeerAddressFamilyPrefixListControlOutputArgs, opts ...InvokeOption) LookupBgpPeerAddressFamilyPrefixListControlResultOutput

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

    public static class GetBgpPeerAddressFamilyPrefixListControl 
    {
        public static Task<GetBgpPeerAddressFamilyPrefixListControlResult> InvokeAsync(GetBgpPeerAddressFamilyPrefixListControlArgs args, InvokeOptions? opts = null)
        public static Output<GetBgpPeerAddressFamilyPrefixListControlResult> Invoke(GetBgpPeerAddressFamilyPrefixListControlInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBgpPeerAddressFamilyPrefixListControlResult> getBgpPeerAddressFamilyPrefixListControl(GetBgpPeerAddressFamilyPrefixListControlArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nxos:index/getBgpPeerAddressFamilyPrefixListControl:getBgpPeerAddressFamilyPrefixListControl
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Address string
    Peer address.
    AddressFamily string
    Address Family.
    Asn string
    Autonomous system number.
    Direction string
    Route Control direction.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    Address string
    Peer address.
    AddressFamily string
    Address Family.
    Asn string
    Autonomous system number.
    Direction string
    Route Control direction.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    address String
    Peer address.
    addressFamily String
    Address Family.
    asn String
    Autonomous system number.
    direction String
    Route Control direction.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    address string
    Peer address.
    addressFamily string
    Address Family.
    asn string
    Autonomous system number.
    direction string
    Route Control direction.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    address str
    Peer address.
    address_family str
    Address Family.
    asn str
    Autonomous system number.
    direction str
    Route Control direction.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    address String
    Peer address.
    addressFamily String
    Address Family.
    asn String
    Autonomous system number.
    direction String
    Route Control direction.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.

    getBgpPeerAddressFamilyPrefixListControl Result

    The following output properties are available:

    Address string
    Peer address.
    AddressFamily string
    Address Family.
    Asn string
    Autonomous system number.
    Direction string
    Route Control direction.
    Id string
    The distinguished name of the object.
    List string
    Route Control Prefix-List name.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    Address string
    Peer address.
    AddressFamily string
    Address Family.
    Asn string
    Autonomous system number.
    Direction string
    Route Control direction.
    Id string
    The distinguished name of the object.
    List string
    Route Control Prefix-List name.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    address String
    Peer address.
    addressFamily String
    Address Family.
    asn String
    Autonomous system number.
    direction String
    Route Control direction.
    id String
    The distinguished name of the object.
    list String
    Route Control Prefix-List name.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    address string
    Peer address.
    addressFamily string
    Address Family.
    asn string
    Autonomous system number.
    direction string
    Route Control direction.
    id string
    The distinguished name of the object.
    list string
    Route Control Prefix-List name.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    address str
    Peer address.
    address_family str
    Address Family.
    asn str
    Autonomous system number.
    direction str
    Route Control direction.
    id str
    The distinguished name of the object.
    list str
    Route Control Prefix-List name.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    address String
    Peer address.
    addressFamily String
    Address Family.
    asn String
    Autonomous system number.
    direction String
    Route Control direction.
    id String
    The distinguished name of the object.
    list String
    Route Control Prefix-List name.
    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