Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. BgpPeerAddressFamilyRouteControl
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.BgpPeerAddressFamilyRouteControl

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

    This resource can manage the BGP peer address family route 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.BgpPeerAddressFamilyRouteControl("example", new()
    {
        Address = "192.168.0.1",
        AddressFamily = "ipv4-ucast",
        Asn = "65001",
        Direction = "in",
        RouteMapName = "ROUTE_MAP1",
        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.NewBgpPeerAddressFamilyRouteControl(ctx, "example", &nxos.BgpPeerAddressFamilyRouteControlArgs{
			Address:       pulumi.String("192.168.0.1"),
			AddressFamily: pulumi.String("ipv4-ucast"),
			Asn:           pulumi.String("65001"),
			Direction:     pulumi.String("in"),
			RouteMapName:  pulumi.String("ROUTE_MAP1"),
			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.BgpPeerAddressFamilyRouteControl;
import com.pulumi.nxos.BgpPeerAddressFamilyRouteControlArgs;
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 BgpPeerAddressFamilyRouteControl("example", BgpPeerAddressFamilyRouteControlArgs.builder()        
            .address("192.168.0.1")
            .addressFamily("ipv4-ucast")
            .asn("65001")
            .direction("in")
            .routeMapName("ROUTE_MAP1")
            .vrf("default")
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.BgpPeerAddressFamilyRouteControl("example",
    address="192.168.0.1",
    address_family="ipv4-ucast",
    asn="65001",
    direction="in",
    route_map_name="ROUTE_MAP1",
    vrf="default")

    import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@lbrlabs/pulumi-nxos";

const example = new nxos.BgpPeerAddressFamilyRouteControl("example", {
    address: "192.168.0.1",
    addressFamily: "ipv4-ucast",
    asn: "65001",
    direction: "in",
    routeMapName: "ROUTE_MAP1",
    vrf: "default",
});

    resources:
  example:
    type: nxos:BgpPeerAddressFamilyRouteControl
    properties:
      address: 192.168.0.1
      addressFamily: ipv4-ucast
      asn: '65001'
      direction: in
      routeMapName: ROUTE_MAP1
      vrf: default

    Create BgpPeerAddressFamilyRouteControl Resource

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

    Constructor syntax

    new BgpPeerAddressFamilyRouteControl(name: string, args: BgpPeerAddressFamilyRouteControlArgs, opts?: CustomResourceOptions);
    @overload
def BgpPeerAddressFamilyRouteControl(resource_name: str,
                                     args: BgpPeerAddressFamilyRouteControlArgs,
                                     opts: Optional[ResourceOptions] = None)

@overload
def BgpPeerAddressFamilyRouteControl(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,
                                     route_map_name: Optional[str] = None)
    func NewBgpPeerAddressFamilyRouteControl(ctx *Context, name string, args BgpPeerAddressFamilyRouteControlArgs, opts ...ResourceOption) (*BgpPeerAddressFamilyRouteControl, error)
    public BgpPeerAddressFamilyRouteControl(string name, BgpPeerAddressFamilyRouteControlArgs args, CustomResourceOptions? opts = null)
    public BgpPeerAddressFamilyRouteControl(String name, BgpPeerAddressFamilyRouteControlArgs args)
public BgpPeerAddressFamilyRouteControl(String name, BgpPeerAddressFamilyRouteControlArgs args, CustomResourceOptions options)

    type: nxos:BgpPeerAddressFamilyRouteControl
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 BgpPeerAddressFamilyRouteControlArgs
    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 BgpPeerAddressFamilyRouteControlArgs
    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 BgpPeerAddressFamilyRouteControlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpPeerAddressFamilyRouteControlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpPeerAddressFamilyRouteControlArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var bgpPeerAddressFamilyRouteControlResource = new Nxos.BgpPeerAddressFamilyRouteControl("bgpPeerAddressFamilyRouteControlResource", new()
{
    Address = "string",
    AddressFamily = "string",
    Asn = "string",
    Direction = "string",
    Vrf = "string",
    Device = "string",
    RouteMapName = "string",
});

    example, err := nxos.NewBgpPeerAddressFamilyRouteControl(ctx, "bgpPeerAddressFamilyRouteControlResource", &nxos.BgpPeerAddressFamilyRouteControlArgs{
	Address:       pulumi.String("string"),
	AddressFamily: pulumi.String("string"),
	Asn:           pulumi.String("string"),
	Direction:     pulumi.String("string"),
	Vrf:           pulumi.String("string"),
	Device:        pulumi.String("string"),
	RouteMapName:  pulumi.String("string"),
})

    var bgpPeerAddressFamilyRouteControlResource = new BgpPeerAddressFamilyRouteControl("bgpPeerAddressFamilyRouteControlResource", BgpPeerAddressFamilyRouteControlArgs.builder()
    .address("string")
    .addressFamily("string")
    .asn("string")
    .direction("string")
    .vrf("string")
    .device("string")
    .routeMapName("string")
    .build());

    bgp_peer_address_family_route_control_resource = nxos.BgpPeerAddressFamilyRouteControl("bgpPeerAddressFamilyRouteControlResource",
    address="string",
    address_family="string",
    asn="string",
    direction="string",
    vrf="string",
    device="string",
    route_map_name="string")

    const bgpPeerAddressFamilyRouteControlResource = new nxos.BgpPeerAddressFamilyRouteControl("bgpPeerAddressFamilyRouteControlResource", {
    address: "string",
    addressFamily: "string",
    asn: "string",
    direction: "string",
    vrf: "string",
    device: "string",
    routeMapName: "string",
});

    type: nxos:BgpPeerAddressFamilyRouteControl
properties:
    address: string
    addressFamily: string
    asn: string
    device: string
    direction: string
    routeMapName: string
    vrf: string

    BgpPeerAddressFamilyRouteControl Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BgpPeerAddressFamilyRouteControl 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.
    RouteMapName string
    Route Control Route-Map 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.
    RouteMapName string
    Route Control Route-Map 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.
    routeMapName String
    Route Control Route-Map 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.
    routeMapName string
    Route Control Route-Map 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.
    route_map_name str
    Route Control Route-Map 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.
    routeMapName String
    Route Control Route-Map name.

    Outputs

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

    Get an existing BgpPeerAddressFamilyRouteControl 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?: BgpPeerAddressFamilyRouteControlState, opts?: CustomResourceOptions): BgpPeerAddressFamilyRouteControl
    @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,
        route_map_name: Optional[str] = None,
        vrf: Optional[str] = None) -> BgpPeerAddressFamilyRouteControl
    func GetBgpPeerAddressFamilyRouteControl(ctx *Context, name string, id IDInput, state *BgpPeerAddressFamilyRouteControlState, opts ...ResourceOption) (*BgpPeerAddressFamilyRouteControl, error)
    public static BgpPeerAddressFamilyRouteControl Get(string name, Input<string> id, BgpPeerAddressFamilyRouteControlState? state, CustomResourceOptions? opts = null)
    public static BgpPeerAddressFamilyRouteControl get(String name, Output<String> id, BgpPeerAddressFamilyRouteControlState 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
    RouteMapName string
    Route Control Route-Map 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
    RouteMapName string
    Route Control Route-Map 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
    routeMapName String
    Route Control Route-Map 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
    routeMapName string
    Route Control Route-Map 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
    route_map_name str
    Route Control Route-Map 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
    routeMapName String
    Route Control Route-Map name.
    vrf String
    VRF name.

    Import

     $ pulumi import nxos:index/bgpPeerAddressFamilyRouteControl:BgpPeerAddressFamilyRouteControl example "sys/bgp/inst/dom-[default]/peer-[192.168.0.1]/af-[ipv4-ucast]/rtctrl-[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
    lbrlabs/pulumi-nxos