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


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 template 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.GetBgpPeerTemplateAddressFamily.Invoke(new()
            AddressFamily = "ipv4-ucast",
            Asn = "65001",
            TemplateName = "SPINE-PEERS",
    package main
    import (
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nxos.LookupBgpPeerTemplateAddressFamily(ctx, &nxos.LookupBgpPeerTemplateAddressFamilyArgs{
    			AddressFamily: "ipv4-ucast",
    			Asn:           "65001",
    			TemplateName:  "SPINE-PEERS",
    		}, 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.GetBgpPeerTemplateAddressFamilyArgs;
    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) {
        public static void stack(Context ctx) {
            final var example = NxosFunctions.getBgpPeerTemplateAddressFamily(GetBgpPeerTemplateAddressFamilyArgs.builder()
    import pulumi
    import pulumi_nxos as nxos
    example = nxos.get_bgp_peer_template_address_family(address_family="ipv4-ucast",
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@pulumi/nxos";
    const example = nxos.getBgpPeerTemplateAddressFamily({
        addressFamily: "ipv4-ucast",
        asn: "65001",
        templateName: "SPINE-PEERS",
          Function: nxos:getBgpPeerTemplateAddressFamily
            addressFamily: ipv4-ucast
            asn: '65001'
            templateName: SPINE-PEERS

    Using getBgpPeerTemplateAddressFamily

    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 getBgpPeerTemplateAddressFamily(args: GetBgpPeerTemplateAddressFamilyArgs, opts?: InvokeOptions): Promise<GetBgpPeerTemplateAddressFamilyResult>
    function getBgpPeerTemplateAddressFamilyOutput(args: GetBgpPeerTemplateAddressFamilyOutputArgs, opts?: InvokeOptions): Output<GetBgpPeerTemplateAddressFamilyResult>
    def get_bgp_peer_template_address_family(address_family: Optional[str] = None,
                                             asn: Optional[str] = None,
                                             device: Optional[str] = None,
                                             template_name: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetBgpPeerTemplateAddressFamilyResult
    def get_bgp_peer_template_address_family_output(address_family: Optional[pulumi.Input[str]] = None,
                                             asn: Optional[pulumi.Input[str]] = None,
                                             device: Optional[pulumi.Input[str]] = None,
                                             template_name: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetBgpPeerTemplateAddressFamilyResult]
    func LookupBgpPeerTemplateAddressFamily(ctx *Context, args *LookupBgpPeerTemplateAddressFamilyArgs, opts ...InvokeOption) (*LookupBgpPeerTemplateAddressFamilyResult, error)
    func LookupBgpPeerTemplateAddressFamilyOutput(ctx *Context, args *LookupBgpPeerTemplateAddressFamilyOutputArgs, opts ...InvokeOption) LookupBgpPeerTemplateAddressFamilyResultOutput

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

    public static class GetBgpPeerTemplateAddressFamily 
        public static Task<GetBgpPeerTemplateAddressFamilyResult> InvokeAsync(GetBgpPeerTemplateAddressFamilyArgs args, InvokeOptions? opts = null)
        public static Output<GetBgpPeerTemplateAddressFamilyResult> Invoke(GetBgpPeerTemplateAddressFamilyInvokeArgs args, InvokeOptions? opts = null)
    public static CompletableFuture<GetBgpPeerTemplateAddressFamilyResult> getBgpPeerTemplateAddressFamily(GetBgpPeerTemplateAddressFamilyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
      function: nxos:index/getBgpPeerTemplateAddressFamily:getBgpPeerTemplateAddressFamily
        # arguments dictionary

    The following arguments are supported:

    AddressFamily string
    Asn string
    TemplateName string
    Device string
    AddressFamily string
    Asn string
    TemplateName string
    Device string
    addressFamily String
    asn String
    templateName String
    device String
    addressFamily string
    asn string
    templateName string
    device string
    addressFamily String
    asn String
    templateName String
    device String

    getBgpPeerTemplateAddressFamily Result

    The following output properties are available:

    Package Details

    nxos lbrlabs/pulumi-nxos
    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