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

nxos.BgpPeerAddressFamilyPrefixListControl

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 peer address family prefix list control 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.BgpPeerAddressFamilyPrefixListControl("example", new()
        {
            Address = "192.168.0.1",
            AddressFamily = "ipv4-ucast",
            Asn = "65001",
            Direction = "in",
            List = "PREFIX_LIST1",
            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.NewBgpPeerAddressFamilyPrefixListControl(ctx, "example", &nxos.BgpPeerAddressFamilyPrefixListControlArgs{
    			Address:       pulumi.String("192.168.0.1"),
    			AddressFamily: pulumi.String("ipv4-ucast"),
    			Asn:           pulumi.String("65001"),
    			Direction:     pulumi.String("in"),
    			List:          pulumi.String("PREFIX_LIST1"),
    			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.BgpPeerAddressFamilyPrefixListControl;
    import com.pulumi.nxos.BgpPeerAddressFamilyPrefixListControlArgs;
    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 BgpPeerAddressFamilyPrefixListControl("example", BgpPeerAddressFamilyPrefixListControlArgs.builder()        
                .address("192.168.0.1")
                .addressFamily("ipv4-ucast")
                .asn("65001")
                .direction("in")
                .list("PREFIX_LIST1")
                .vrf("default")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.BgpPeerAddressFamilyPrefixListControl("example",
        address="192.168.0.1",
        address_family="ipv4-ucast",
        asn="65001",
        direction="in",
        list="PREFIX_LIST1",
        vrf="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.BgpPeerAddressFamilyPrefixListControl("example", {
        address: "192.168.0.1",
        addressFamily: "ipv4-ucast",
        asn: "65001",
        direction: "in",
        list: "PREFIX_LIST1",
        vrf: "default",
    });
    
    resources:
      example:
        type: nxos:BgpPeerAddressFamilyPrefixListControl
        properties:
          address: 192.168.0.1
          addressFamily: ipv4-ucast
          asn: '65001'
          direction: in
          list: PREFIX_LIST1
          vrf: default
    

    Create BgpPeerAddressFamilyPrefixListControl Resource

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

    Constructor syntax

    new BgpPeerAddressFamilyPrefixListControl(name: string, args: BgpPeerAddressFamilyPrefixListControlArgs, opts?: CustomResourceOptions);
    @overload
    def BgpPeerAddressFamilyPrefixListControl(resource_name: str,
                                              args: BgpPeerAddressFamilyPrefixListControlArgs,
                                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def BgpPeerAddressFamilyPrefixListControl(resource_name: str,
                                              opts: Optional[ResourceOptions] = None,
                                              address: Optional[str] = None,
                                              address_family: Optional[str] = None,
                                              asn: Optional[str] = None,
                                              direction: Optional[str] = None,
                                              vrf: Optional[str] = None,
                                              device: Optional[str] = None,
                                              list: Optional[str] = None)
    func NewBgpPeerAddressFamilyPrefixListControl(ctx *Context, name string, args BgpPeerAddressFamilyPrefixListControlArgs, opts ...ResourceOption) (*BgpPeerAddressFamilyPrefixListControl, error)
    public BgpPeerAddressFamilyPrefixListControl(string name, BgpPeerAddressFamilyPrefixListControlArgs args, CustomResourceOptions? opts = null)
    public BgpPeerAddressFamilyPrefixListControl(String name, BgpPeerAddressFamilyPrefixListControlArgs args)
    public BgpPeerAddressFamilyPrefixListControl(String name, BgpPeerAddressFamilyPrefixListControlArgs args, CustomResourceOptions options)
    
    type: nxos:BgpPeerAddressFamilyPrefixListControl
    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 BgpPeerAddressFamilyPrefixListControlArgs
    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 BgpPeerAddressFamilyPrefixListControlArgs
    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 BgpPeerAddressFamilyPrefixListControlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpPeerAddressFamilyPrefixListControlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpPeerAddressFamilyPrefixListControlArgs
    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 bgpPeerAddressFamilyPrefixListControlResource = new Nxos.BgpPeerAddressFamilyPrefixListControl("bgpPeerAddressFamilyPrefixListControlResource", new()
    {
        Address = "string",
        AddressFamily = "string",
        Asn = "string",
        Direction = "string",
        Vrf = "string",
        Device = "string",
        List = "string",
    });
    
    example, err := nxos.NewBgpPeerAddressFamilyPrefixListControl(ctx, "bgpPeerAddressFamilyPrefixListControlResource", &nxos.BgpPeerAddressFamilyPrefixListControlArgs{
    	Address:       pulumi.String("string"),
    	AddressFamily: pulumi.String("string"),
    	Asn:           pulumi.String("string"),
    	Direction:     pulumi.String("string"),
    	Vrf:           pulumi.String("string"),
    	Device:        pulumi.String("string"),
    	List:          pulumi.String("string"),
    })
    
    var bgpPeerAddressFamilyPrefixListControlResource = new BgpPeerAddressFamilyPrefixListControl("bgpPeerAddressFamilyPrefixListControlResource", BgpPeerAddressFamilyPrefixListControlArgs.builder()        
        .address("string")
        .addressFamily("string")
        .asn("string")
        .direction("string")
        .vrf("string")
        .device("string")
        .list("string")
        .build());
    
    bgp_peer_address_family_prefix_list_control_resource = nxos.BgpPeerAddressFamilyPrefixListControl("bgpPeerAddressFamilyPrefixListControlResource",
        address="string",
        address_family="string",
        asn="string",
        direction="string",
        vrf="string",
        device="string",
        list="string")
    
    const bgpPeerAddressFamilyPrefixListControlResource = new nxos.BgpPeerAddressFamilyPrefixListControl("bgpPeerAddressFamilyPrefixListControlResource", {
        address: "string",
        addressFamily: "string",
        asn: "string",
        direction: "string",
        vrf: "string",
        device: "string",
        list: "string",
    });
    
    type: nxos:BgpPeerAddressFamilyPrefixListControl
    properties:
        address: string
        addressFamily: string
        asn: string
        device: string
        direction: string
        list: string
        vrf: string
    

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

    Address string
    Peer address.
    AddressFamily string
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    Asn string
    Autonomous system number.
    Direction string
    Route Control direction. - Choices: in, out - Default value: in
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    List string
    Route Control Prefix-List name.
    Address string
    Peer address.
    AddressFamily string
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    Asn string
    Autonomous system number.
    Direction string
    Route Control direction. - Choices: in, out - Default value: in
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    List string
    Route Control Prefix-List name.
    address String
    Peer address.
    addressFamily String
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    asn String
    Autonomous system number.
    direction String
    Route Control direction. - Choices: in, out - Default value: in
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    list String
    Route Control Prefix-List name.
    address string
    Peer address.
    addressFamily string
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    asn string
    Autonomous system number.
    direction string
    Route Control direction. - Choices: in, out - Default value: in
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    list string
    Route Control Prefix-List name.
    address str
    Peer address.
    address_family str
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    asn str
    Autonomous system number.
    direction str
    Route Control direction. - Choices: in, out - Default value: in
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    list str
    Route Control Prefix-List name.
    address String
    Peer address.
    addressFamily String
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    asn String
    Autonomous system number.
    direction String
    Route Control direction. - Choices: in, out - Default value: in
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    list String
    Route Control Prefix-List name.

    Outputs

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

    Get an existing BgpPeerAddressFamilyPrefixListControl 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?: BgpPeerAddressFamilyPrefixListControlState, opts?: CustomResourceOptions): BgpPeerAddressFamilyPrefixListControl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            address_family: Optional[str] = None,
            asn: Optional[str] = None,
            device: Optional[str] = None,
            direction: Optional[str] = None,
            list: Optional[str] = None,
            vrf: Optional[str] = None) -> BgpPeerAddressFamilyPrefixListControl
    func GetBgpPeerAddressFamilyPrefixListControl(ctx *Context, name string, id IDInput, state *BgpPeerAddressFamilyPrefixListControlState, opts ...ResourceOption) (*BgpPeerAddressFamilyPrefixListControl, error)
    public static BgpPeerAddressFamilyPrefixListControl Get(string name, Input<string> id, BgpPeerAddressFamilyPrefixListControlState? state, CustomResourceOptions? opts = null)
    public static BgpPeerAddressFamilyPrefixListControl get(String name, Output<String> id, BgpPeerAddressFamilyPrefixListControlState 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:
    Address string
    Peer address.
    AddressFamily string
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    Asn string
    Autonomous system number.
    Device string
    A device name from the provider configuration.
    Direction string
    Route Control direction. - Choices: in, out - Default value: in
    List string
    Route Control Prefix-List name.
    Vrf string
    VRF name.
    Address string
    Peer address.
    AddressFamily string
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    Asn string
    Autonomous system number.
    Device string
    A device name from the provider configuration.
    Direction string
    Route Control direction. - Choices: in, out - Default value: in
    List string
    Route Control Prefix-List name.
    Vrf string
    VRF name.
    address String
    Peer address.
    addressFamily String
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    asn String
    Autonomous system number.
    device String
    A device name from the provider configuration.
    direction String
    Route Control direction. - Choices: in, out - Default value: in
    list String
    Route Control Prefix-List name.
    vrf String
    VRF name.
    address string
    Peer address.
    addressFamily string
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    asn string
    Autonomous system number.
    device string
    A device name from the provider configuration.
    direction string
    Route Control direction. - Choices: in, out - Default value: in
    list string
    Route Control Prefix-List name.
    vrf string
    VRF name.
    address str
    Peer address.
    address_family str
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    asn str
    Autonomous system number.
    device str
    A device name from the provider configuration.
    direction str
    Route Control direction. - Choices: in, out - Default value: in
    list str
    Route Control Prefix-List name.
    vrf str
    VRF name.
    address String
    Peer address.
    addressFamily String
    Address Family. - Choices: ipv4-ucast, vpnv4-ucast, ipv6-ucast, vpnv6-ucast, l2vpn-evpn, lnkstate - Default value: ipv4-ucast
    asn String
    Autonomous system number.
    device String
    A device name from the provider configuration.
    direction String
    Route Control direction. - Choices: in, out - Default value: in
    list String
    Route Control Prefix-List name.
    vrf String
    VRF name.

    Import

     $ pulumi import nxos:index/bgpPeerAddressFamilyPrefixListControl:BgpPeerAddressFamilyPrefixListControl example "sys/bgp/inst/dom-[default]/peer-[192.168.0.1]/af-[ipv4-ucast]/pfxctrl-[in]"
    

    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