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

nxos.getBgpPeerAddressFamily

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 configuration.

    Example Usage

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

    Using getBgpPeerAddressFamily

    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 getBgpPeerAddressFamily(args: GetBgpPeerAddressFamilyArgs, opts?: InvokeOptions): Promise<GetBgpPeerAddressFamilyResult>
    function getBgpPeerAddressFamilyOutput(args: GetBgpPeerAddressFamilyOutputArgs, opts?: InvokeOptions): Output<GetBgpPeerAddressFamilyResult>
    def get_bgp_peer_address_family(address: Optional[str] = None,
                                    address_family: Optional[str] = None,
                                    asn: Optional[str] = None,
                                    device: Optional[str] = None,
                                    vrf: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetBgpPeerAddressFamilyResult
    def get_bgp_peer_address_family_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,
                                    vrf: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetBgpPeerAddressFamilyResult]
    func LookupBgpPeerAddressFamily(ctx *Context, args *LookupBgpPeerAddressFamilyArgs, opts ...InvokeOption) (*LookupBgpPeerAddressFamilyResult, error)
    func LookupBgpPeerAddressFamilyOutput(ctx *Context, args *LookupBgpPeerAddressFamilyOutputArgs, opts ...InvokeOption) LookupBgpPeerAddressFamilyResultOutput

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

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

    The following arguments are supported:

    Address string
    AddressFamily string
    Asn string
    Vrf string
    Device string
    Address string
    AddressFamily string
    Asn string
    Vrf string
    Device string
    address String
    addressFamily String
    asn String
    vrf String
    device String
    address string
    addressFamily string
    asn string
    vrf string
    device string
    address String
    addressFamily String
    asn String
    vrf String
    device String

    getBgpPeerAddressFamily Result

    The following output properties are available:

    Address string
    AddressFamily string
    Asn string
    Control string
    Id string
    SendCommunityExtended string
    SendCommunityStandard string
    Vrf string
    Device string
    Address string
    AddressFamily string
    Asn string
    Control string
    Id string
    SendCommunityExtended string
    SendCommunityStandard string
    Vrf string
    Device string
    address String
    addressFamily String
    asn String
    control String
    id String
    sendCommunityExtended String
    sendCommunityStandard String
    vrf String
    device String
    address string
    addressFamily string
    asn string
    control string
    id string
    sendCommunityExtended string
    sendCommunityStandard string
    vrf string
    device string
    address String
    addressFamily String
    asn String
    control String
    id String
    sendCommunityExtended String
    sendCommunityStandard String
    vrf String
    device String

    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