Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. BgpIpv4UnicastNeighbor
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

iosxe.BgpIpv4UnicastNeighbor

Explore with Pulumi AI

Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

This resource can manage the BGP IPv4 Unicast Neighbor configuration.

Example Usage

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.BgpIpv4UnicastNeighbor;
import com.pulumi.iosxe.BgpIpv4UnicastNeighborArgs;
import com.pulumi.iosxe.inputs.BgpIpv4UnicastNeighborRouteMapArgs;
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 BgpIpv4UnicastNeighbor("example", BgpIpv4UnicastNeighborArgs.builder()        
            .activate(true)
            .asn("65000")
            .ip("3.3.3.3")
            .routeMaps(BgpIpv4UnicastNeighborRouteMapArgs.builder()
                .in_out("in")
                .route_map_name("RM1")
                .build())
            .routeReflectorClient(false)
            .sendCommunity("both")
            .build());

    }
}
Copy

Coming soon!

Coming soon!

resources:
  example:
    type: iosxe:BgpIpv4UnicastNeighbor
    properties:
      activate: true
      asn: '65000'
      ip: 3.3.3.3
      routeMaps:
        - in_out: in
          route_map_name: RM1
      routeReflectorClient: false
      sendCommunity: both
Copy

Create BgpIpv4UnicastNeighbor Resource

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

Constructor syntax

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

@overload
def BgpIpv4UnicastNeighbor(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           asn: Optional[str] = None,
                           ip: Optional[str] = None,
                           activate: Optional[bool] = None,
                           delete_mode: Optional[str] = None,
                           device: Optional[str] = None,
                           route_maps: Optional[Sequence[BgpIpv4UnicastNeighborRouteMapArgs]] = None,
                           route_reflector_client: Optional[bool] = None,
                           send_community: Optional[str] = None)
func NewBgpIpv4UnicastNeighbor(ctx *Context, name string, args BgpIpv4UnicastNeighborArgs, opts ...ResourceOption) (*BgpIpv4UnicastNeighbor, error)
public BgpIpv4UnicastNeighbor(string name, BgpIpv4UnicastNeighborArgs args, CustomResourceOptions? opts = null)
public BgpIpv4UnicastNeighbor(String name, BgpIpv4UnicastNeighborArgs args)
public BgpIpv4UnicastNeighbor(String name, BgpIpv4UnicastNeighborArgs args, CustomResourceOptions options)

type: iosxe:BgpIpv4UnicastNeighbor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BgpIpv4UnicastNeighborArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BgpIpv4UnicastNeighborArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BgpIpv4UnicastNeighborArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BgpIpv4UnicastNeighborArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BgpIpv4UnicastNeighborArgs
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 bgpIpv4UnicastNeighborResource = new Iosxe.BgpIpv4UnicastNeighbor("bgpIpv4UnicastNeighborResource", new()
{
    Asn = "string",
    Ip = "string",
    Activate = false,
    DeleteMode = "string",
    Device = "string",
    RouteMaps = new[]
    {
        new Iosxe.Inputs.BgpIpv4UnicastNeighborRouteMapArgs
        {
            InOut = "string",
            RouteMapName = "string",
        },
    },
    RouteReflectorClient = false,
    SendCommunity = "string",
});
Copy
example, err := iosxe.NewBgpIpv4UnicastNeighbor(ctx, "bgpIpv4UnicastNeighborResource", &iosxe.BgpIpv4UnicastNeighborArgs{
	Asn:        pulumi.String("string"),
	Ip:         pulumi.String("string"),
	Activate:   pulumi.Bool(false),
	DeleteMode: pulumi.String("string"),
	Device:     pulumi.String("string"),
	RouteMaps: iosxe.BgpIpv4UnicastNeighborRouteMapArray{
		&iosxe.BgpIpv4UnicastNeighborRouteMapArgs{
			InOut:        pulumi.String("string"),
			RouteMapName: pulumi.String("string"),
		},
	},
	RouteReflectorClient: pulumi.Bool(false),
	SendCommunity:        pulumi.String("string"),
})
Copy
var bgpIpv4UnicastNeighborResource = new BgpIpv4UnicastNeighbor("bgpIpv4UnicastNeighborResource", BgpIpv4UnicastNeighborArgs.builder()
    .asn("string")
    .ip("string")
    .activate(false)
    .deleteMode("string")
    .device("string")
    .routeMaps(BgpIpv4UnicastNeighborRouteMapArgs.builder()
        .inOut("string")
        .routeMapName("string")
        .build())
    .routeReflectorClient(false)
    .sendCommunity("string")
    .build());
Copy
bgp_ipv4_unicast_neighbor_resource = iosxe.BgpIpv4UnicastNeighbor("bgpIpv4UnicastNeighborResource",
    asn="string",
    ip="string",
    activate=False,
    delete_mode="string",
    device="string",
    route_maps=[{
        "in_out": "string",
        "route_map_name": "string",
    }],
    route_reflector_client=False,
    send_community="string")
Copy
const bgpIpv4UnicastNeighborResource = new iosxe.BgpIpv4UnicastNeighbor("bgpIpv4UnicastNeighborResource", {
    asn: "string",
    ip: "string",
    activate: false,
    deleteMode: "string",
    device: "string",
    routeMaps: [{
        inOut: "string",
        routeMapName: "string",
    }],
    routeReflectorClient: false,
    sendCommunity: "string",
});
Copy
type: iosxe:BgpIpv4UnicastNeighbor
properties:
    activate: false
    asn: string
    deleteMode: string
    device: string
    ip: string
    routeMaps:
        - inOut: string
          routeMapName: string
    routeReflectorClient: false
    sendCommunity: string
Copy

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

Asn This property is required. string
Ip This property is required. string
Activate bool
Enable the address family for this neighbor - Default value: true
DeleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
Device string
A device name from the provider configuration.
RouteMaps List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpIpv4UnicastNeighborRouteMap>
Apply route map to neighbor
RouteReflectorClient bool
Configure a neighbor as Route Reflector client
SendCommunity string
  • Choices: both, extended, standard
Asn This property is required. string
Ip This property is required. string
Activate bool
Enable the address family for this neighbor - Default value: true
DeleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
Device string
A device name from the provider configuration.
RouteMaps []BgpIpv4UnicastNeighborRouteMapArgs
Apply route map to neighbor
RouteReflectorClient bool
Configure a neighbor as Route Reflector client
SendCommunity string
  • Choices: both, extended, standard
asn This property is required. String
ip This property is required. String
activate Boolean
Enable the address family for this neighbor - Default value: true
deleteMode String
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device String
A device name from the provider configuration.
routeMaps List<BgpIpv4UnicastNeighborRouteMap>
Apply route map to neighbor
routeReflectorClient Boolean
Configure a neighbor as Route Reflector client
sendCommunity String
  • Choices: both, extended, standard
asn This property is required. string
ip This property is required. string
activate boolean
Enable the address family for this neighbor - Default value: true
deleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device string
A device name from the provider configuration.
routeMaps BgpIpv4UnicastNeighborRouteMap[]
Apply route map to neighbor
routeReflectorClient boolean
Configure a neighbor as Route Reflector client
sendCommunity string
  • Choices: both, extended, standard
asn This property is required. str
ip This property is required. str
activate bool
Enable the address family for this neighbor - Default value: true
delete_mode str
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device str
A device name from the provider configuration.
route_maps Sequence[BgpIpv4UnicastNeighborRouteMapArgs]
Apply route map to neighbor
route_reflector_client bool
Configure a neighbor as Route Reflector client
send_community str
  • Choices: both, extended, standard
asn This property is required. String
ip This property is required. String
activate Boolean
Enable the address family for this neighbor - Default value: true
deleteMode String
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device String
A device name from the provider configuration.
routeMaps List<Property Map>
Apply route map to neighbor
routeReflectorClient Boolean
Configure a neighbor as Route Reflector client
sendCommunity String
  • Choices: both, extended, standard

Outputs

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

Get an existing BgpIpv4UnicastNeighbor 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?: BgpIpv4UnicastNeighborState, opts?: CustomResourceOptions): BgpIpv4UnicastNeighbor
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activate: Optional[bool] = None,
        asn: Optional[str] = None,
        delete_mode: Optional[str] = None,
        device: Optional[str] = None,
        ip: Optional[str] = None,
        route_maps: Optional[Sequence[BgpIpv4UnicastNeighborRouteMapArgs]] = None,
        route_reflector_client: Optional[bool] = None,
        send_community: Optional[str] = None) -> BgpIpv4UnicastNeighbor
func GetBgpIpv4UnicastNeighbor(ctx *Context, name string, id IDInput, state *BgpIpv4UnicastNeighborState, opts ...ResourceOption) (*BgpIpv4UnicastNeighbor, error)
public static BgpIpv4UnicastNeighbor Get(string name, Input<string> id, BgpIpv4UnicastNeighborState? state, CustomResourceOptions? opts = null)
public static BgpIpv4UnicastNeighbor get(String name, Output<String> id, BgpIpv4UnicastNeighborState state, CustomResourceOptions options)
resources:  _:    type: iosxe:BgpIpv4UnicastNeighbor    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Activate bool
Enable the address family for this neighbor - Default value: true
Asn string
DeleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
Device string
A device name from the provider configuration.
Ip string
RouteMaps List<Lbrlabs.PulumiPackage.Iosxe.Inputs.BgpIpv4UnicastNeighborRouteMap>
Apply route map to neighbor
RouteReflectorClient bool
Configure a neighbor as Route Reflector client
SendCommunity string
  • Choices: both, extended, standard
Activate bool
Enable the address family for this neighbor - Default value: true
Asn string
DeleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
Device string
A device name from the provider configuration.
Ip string
RouteMaps []BgpIpv4UnicastNeighborRouteMapArgs
Apply route map to neighbor
RouteReflectorClient bool
Configure a neighbor as Route Reflector client
SendCommunity string
  • Choices: both, extended, standard
activate Boolean
Enable the address family for this neighbor - Default value: true
asn String
deleteMode String
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device String
A device name from the provider configuration.
ip String
routeMaps List<BgpIpv4UnicastNeighborRouteMap>
Apply route map to neighbor
routeReflectorClient Boolean
Configure a neighbor as Route Reflector client
sendCommunity String
  • Choices: both, extended, standard
activate boolean
Enable the address family for this neighbor - Default value: true
asn string
deleteMode string
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device string
A device name from the provider configuration.
ip string
routeMaps BgpIpv4UnicastNeighborRouteMap[]
Apply route map to neighbor
routeReflectorClient boolean
Configure a neighbor as Route Reflector client
sendCommunity string
  • Choices: both, extended, standard
activate bool
Enable the address family for this neighbor - Default value: true
asn str
delete_mode str
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device str
A device name from the provider configuration.
ip str
route_maps Sequence[BgpIpv4UnicastNeighborRouteMapArgs]
Apply route map to neighbor
route_reflector_client bool
Configure a neighbor as Route Reflector client
send_community str
  • Choices: both, extended, standard
activate Boolean
Enable the address family for this neighbor - Default value: true
asn String
deleteMode String
Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
device String
A device name from the provider configuration.
ip String
routeMaps List<Property Map>
Apply route map to neighbor
routeReflectorClient Boolean
Configure a neighbor as Route Reflector client
sendCommunity String
  • Choices: both, extended, standard

Supporting Types

BgpIpv4UnicastNeighborRouteMap
, BgpIpv4UnicastNeighborRouteMapArgs

InOut This property is required. string
RouteMapName This property is required. string
InOut This property is required. string
RouteMapName This property is required. string
inOut This property is required. String
routeMapName This property is required. String
inOut This property is required. string
routeMapName This property is required. string
in_out This property is required. str
route_map_name This property is required. str
inOut This property is required. String
routeMapName This property is required. String

Import

 $ pulumi import iosxe:index/bgpIpv4UnicastNeighbor:BgpIpv4UnicastNeighbor example "Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-bgp:bgp=65000/address-family/no-vrf/ipv4=unicast/ipv4-unicast/neighbor=3.3.3.3"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
iosxe lbrlabs/pulumi-iosxe
License
Apache-2.0
Notes
This Pulumi package is based on the iosxe Terraform Provider.
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe