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

nxos.BgpAddressFamily

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 (VRF) address family 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.BgpAddressFamily("example", new()
        {
            AddressFamily = "ipv4-ucast",
            Asn = "65001",
            CriticalNexthopTimeout = 1800,
            NonCriticalNexthopTimeout = 1800,
            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.NewBgpAddressFamily(ctx, "example", &nxos.BgpAddressFamilyArgs{
    			AddressFamily:             pulumi.String("ipv4-ucast"),
    			Asn:                       pulumi.String("65001"),
    			CriticalNexthopTimeout:    pulumi.Int(1800),
    			NonCriticalNexthopTimeout: pulumi.Int(1800),
    			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.BgpAddressFamily;
    import com.pulumi.nxos.BgpAddressFamilyArgs;
    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 BgpAddressFamily("example", BgpAddressFamilyArgs.builder()        
                .addressFamily("ipv4-ucast")
                .asn("65001")
                .criticalNexthopTimeout(1800)
                .nonCriticalNexthopTimeout(1800)
                .vrf("default")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.BgpAddressFamily("example",
        address_family="ipv4-ucast",
        asn="65001",
        critical_nexthop_timeout=1800,
        non_critical_nexthop_timeout=1800,
        vrf="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.BgpAddressFamily("example", {
        addressFamily: "ipv4-ucast",
        asn: "65001",
        criticalNexthopTimeout: 1800,
        nonCriticalNexthopTimeout: 1800,
        vrf: "default",
    });
    
    resources:
      example:
        type: nxos:BgpAddressFamily
        properties:
          addressFamily: ipv4-ucast
          asn: '65001'
          criticalNexthopTimeout: 1800
          nonCriticalNexthopTimeout: 1800
          vrf: default
    

    Create BgpAddressFamily Resource

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

    Constructor syntax

    new BgpAddressFamily(name: string, args: BgpAddressFamilyArgs, opts?: CustomResourceOptions);
    @overload
    def BgpAddressFamily(resource_name: str,
                         args: BgpAddressFamilyArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def BgpAddressFamily(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         address_family: Optional[str] = None,
                         asn: Optional[str] = None,
                         vrf: Optional[str] = None,
                         critical_nexthop_timeout: Optional[int] = None,
                         device: Optional[str] = None,
                         non_critical_nexthop_timeout: Optional[int] = None)
    func NewBgpAddressFamily(ctx *Context, name string, args BgpAddressFamilyArgs, opts ...ResourceOption) (*BgpAddressFamily, error)
    public BgpAddressFamily(string name, BgpAddressFamilyArgs args, CustomResourceOptions? opts = null)
    public BgpAddressFamily(String name, BgpAddressFamilyArgs args)
    public BgpAddressFamily(String name, BgpAddressFamilyArgs args, CustomResourceOptions options)
    
    type: nxos:BgpAddressFamily
    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 BgpAddressFamilyArgs
    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 BgpAddressFamilyArgs
    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 BgpAddressFamilyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpAddressFamilyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpAddressFamilyArgs
    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 bgpAddressFamilyResource = new Nxos.BgpAddressFamily("bgpAddressFamilyResource", new()
    {
        AddressFamily = "string",
        Asn = "string",
        Vrf = "string",
        CriticalNexthopTimeout = 0,
        Device = "string",
        NonCriticalNexthopTimeout = 0,
    });
    
    example, err := nxos.NewBgpAddressFamily(ctx, "bgpAddressFamilyResource", &nxos.BgpAddressFamilyArgs{
    	AddressFamily:             pulumi.String("string"),
    	Asn:                       pulumi.String("string"),
    	Vrf:                       pulumi.String("string"),
    	CriticalNexthopTimeout:    pulumi.Int(0),
    	Device:                    pulumi.String("string"),
    	NonCriticalNexthopTimeout: pulumi.Int(0),
    })
    
    var bgpAddressFamilyResource = new BgpAddressFamily("bgpAddressFamilyResource", BgpAddressFamilyArgs.builder()        
        .addressFamily("string")
        .asn("string")
        .vrf("string")
        .criticalNexthopTimeout(0)
        .device("string")
        .nonCriticalNexthopTimeout(0)
        .build());
    
    bgp_address_family_resource = nxos.BgpAddressFamily("bgpAddressFamilyResource",
        address_family="string",
        asn="string",
        vrf="string",
        critical_nexthop_timeout=0,
        device="string",
        non_critical_nexthop_timeout=0)
    
    const bgpAddressFamilyResource = new nxos.BgpAddressFamily("bgpAddressFamilyResource", {
        addressFamily: "string",
        asn: "string",
        vrf: "string",
        criticalNexthopTimeout: 0,
        device: "string",
        nonCriticalNexthopTimeout: 0,
    });
    
    type: nxos:BgpAddressFamily
    properties:
        addressFamily: string
        asn: string
        criticalNexthopTimeout: 0
        device: string
        nonCriticalNexthopTimeout: 0
        vrf: string
    

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

    AddressFamily string
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    Asn string
    Autonomous system number.
    Vrf string
    VRF name.
    CriticalNexthopTimeout int
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    Device string
    A device name from the provider configuration.
    NonCriticalNexthopTimeout int
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    AddressFamily string
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    Asn string
    Autonomous system number.
    Vrf string
    VRF name.
    CriticalNexthopTimeout int
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    Device string
    A device name from the provider configuration.
    NonCriticalNexthopTimeout int
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    addressFamily String
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    asn String
    Autonomous system number.
    vrf String
    VRF name.
    criticalNexthopTimeout Integer
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    device String
    A device name from the provider configuration.
    nonCriticalNexthopTimeout Integer
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    addressFamily string
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    asn string
    Autonomous system number.
    vrf string
    VRF name.
    criticalNexthopTimeout number
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    device string
    A device name from the provider configuration.
    nonCriticalNexthopTimeout number
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    address_family str
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    asn str
    Autonomous system number.
    vrf str
    VRF name.
    critical_nexthop_timeout int
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    device str
    A device name from the provider configuration.
    non_critical_nexthop_timeout int
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    addressFamily String
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    asn String
    Autonomous system number.
    vrf String
    VRF name.
    criticalNexthopTimeout Number
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    device String
    A device name from the provider configuration.
    nonCriticalNexthopTimeout Number
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000

    Outputs

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

    Get an existing BgpAddressFamily 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?: BgpAddressFamilyState, opts?: CustomResourceOptions): BgpAddressFamily
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address_family: Optional[str] = None,
            asn: Optional[str] = None,
            critical_nexthop_timeout: Optional[int] = None,
            device: Optional[str] = None,
            non_critical_nexthop_timeout: Optional[int] = None,
            vrf: Optional[str] = None) -> BgpAddressFamily
    func GetBgpAddressFamily(ctx *Context, name string, id IDInput, state *BgpAddressFamilyState, opts ...ResourceOption) (*BgpAddressFamily, error)
    public static BgpAddressFamily Get(string name, Input<string> id, BgpAddressFamilyState? state, CustomResourceOptions? opts = null)
    public static BgpAddressFamily get(String name, Output<String> id, BgpAddressFamilyState 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:
    AddressFamily string
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    Asn string
    Autonomous system number.
    CriticalNexthopTimeout int
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    Device string
    A device name from the provider configuration.
    NonCriticalNexthopTimeout int
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    Vrf string
    VRF name.
    AddressFamily string
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    Asn string
    Autonomous system number.
    CriticalNexthopTimeout int
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    Device string
    A device name from the provider configuration.
    NonCriticalNexthopTimeout int
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    Vrf string
    VRF name.
    addressFamily String
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    asn String
    Autonomous system number.
    criticalNexthopTimeout Integer
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    device String
    A device name from the provider configuration.
    nonCriticalNexthopTimeout Integer
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    vrf String
    VRF name.
    addressFamily string
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    asn string
    Autonomous system number.
    criticalNexthopTimeout number
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    device string
    A device name from the provider configuration.
    nonCriticalNexthopTimeout number
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    vrf string
    VRF name.
    address_family str
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    asn str
    Autonomous system number.
    critical_nexthop_timeout int
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    device str
    A device name from the provider configuration.
    non_critical_nexthop_timeout int
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    vrf str
    VRF name.
    addressFamily String
    Address Family. - Choices: ipv4-ucast, ipv4-mcast, vpnv4-ucast, ipv6-ucast, ipv6-mcast, vpnv6-ucast, vpnv6-mcast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, lnkstate, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt - Default value: ipv4-ucast
    asn String
    Autonomous system number.
    criticalNexthopTimeout Number
    The next-hop address tracking delay timer for critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 3000
    device String
    A device name from the provider configuration.
    nonCriticalNexthopTimeout Number
    The next-hop address tracking delay timer for non-critical next-hop reachability routes. - Range: 1-4294967295 - Default value: 10000
    vrf String
    VRF name.

    Import

     $ pulumi import nxos:index/bgpAddressFamily:BgpAddressFamily example "sys/bgp/inst/dom-[default]/af-[ipv4-ucast]"
    

    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