Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix
  3. API Docs
  4. networkedge
  5. Bgp
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

equinix.networkedge.Bgp

Explore with Pulumi AI

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

Resource equinix.networkedge.Bgp allows creation and management of Equinix Network Edge BGP peering configurations.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var test = new Equinix.NetworkEdge.Bgp("test", new()
    {
        ConnectionId = "54014acf-9730-4b55-a791-459283d05fb1",
        LocalIpAddress = "10.1.1.1/30",
        LocalAsn = 12345,
        RemoteIpAddress = "10.1.1.2",
        RemoteAsn = 66123,
        AuthenticationKey = "secret",
    });

});
Copy
package main

import (
	"github.com/equinix/pulumi-equinix/sdk/go/equinix/networkedge"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkedge.NewBgp(ctx, "test", &networkedge.BgpArgs{
			ConnectionId:      pulumi.String("54014acf-9730-4b55-a791-459283d05fb1"),
			LocalIpAddress:    pulumi.String("10.1.1.1/30"),
			LocalAsn:          pulumi.Int(12345),
			RemoteIpAddress:   pulumi.String("10.1.1.2"),
			RemoteAsn:         pulumi.Int(66123),
			AuthenticationKey: pulumi.String("secret"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.networkedge.Bgp;
import com.pulumi.equinix.networkedge.BgpArgs;
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 test = new Bgp("test", BgpArgs.builder()
            .connectionId("54014acf-9730-4b55-a791-459283d05fb1")
            .localIpAddress("10.1.1.1/30")
            .localAsn(12345)
            .remoteIpAddress("10.1.1.2")
            .remoteAsn(66123)
            .authenticationKey("secret")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@equinix-labs/pulumi-equinix";

const test = new equinix.networkedge.Bgp("test", {
    connectionId: "54014acf-9730-4b55-a791-459283d05fb1",
    localIpAddress: "10.1.1.1/30",
    localAsn: 12345,
    remoteIpAddress: "10.1.1.2",
    remoteAsn: 66123,
    authenticationKey: "secret",
});
Copy
import pulumi
import pulumi_equinix as equinix

test = equinix.networkedge.Bgp("test",
    connection_id="54014acf-9730-4b55-a791-459283d05fb1",
    local_ip_address="10.1.1.1/30",
    local_asn=12345,
    remote_ip_address="10.1.1.2",
    remote_asn=66123,
    authentication_key="secret")
Copy
resources:
  # Create BGP peering configuration on a existing connection
  # between network device and service provider
  test:
    type: equinix:networkedge:Bgp
    properties:
      connectionId: 54014acf-9730-4b55-a791-459283d05fb1
      localIpAddress: 10.1.1.1/30
      localAsn: 12345
      remoteIpAddress: 10.1.1.2
      remoteAsn: 66123
      authenticationKey: secret
Copy

Create Bgp Resource

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

Constructor syntax

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

@overload
def Bgp(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        connection_id: Optional[str] = None,
        local_asn: Optional[int] = None,
        local_ip_address: Optional[str] = None,
        remote_asn: Optional[int] = None,
        remote_ip_address: Optional[str] = None,
        authentication_key: Optional[str] = None)
func NewBgp(ctx *Context, name string, args BgpArgs, opts ...ResourceOption) (*Bgp, error)
public Bgp(string name, BgpArgs args, CustomResourceOptions? opts = null)
public Bgp(String name, BgpArgs args)
public Bgp(String name, BgpArgs args, CustomResourceOptions options)

type: equinix:networkedge:Bgp
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. BgpArgs
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. BgpArgs
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. BgpArgs
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. BgpArgs
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. BgpArgs
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 bgpResource = new Equinix.NetworkEdge.Bgp("bgpResource", new()
{
    ConnectionId = "string",
    LocalAsn = 0,
    LocalIpAddress = "string",
    RemoteAsn = 0,
    RemoteIpAddress = "string",
    AuthenticationKey = "string",
});
Copy
example, err := networkedge.NewBgp(ctx, "bgpResource", &networkedge.BgpArgs{
	ConnectionId:      pulumi.String("string"),
	LocalAsn:          pulumi.Int(0),
	LocalIpAddress:    pulumi.String("string"),
	RemoteAsn:         pulumi.Int(0),
	RemoteIpAddress:   pulumi.String("string"),
	AuthenticationKey: pulumi.String("string"),
})
Copy
var bgpResource = new Bgp("bgpResource", BgpArgs.builder()
    .connectionId("string")
    .localAsn(0)
    .localIpAddress("string")
    .remoteAsn(0)
    .remoteIpAddress("string")
    .authenticationKey("string")
    .build());
Copy
bgp_resource = equinix.networkedge.Bgp("bgpResource",
    connection_id="string",
    local_asn=0,
    local_ip_address="string",
    remote_asn=0,
    remote_ip_address="string",
    authentication_key="string")
Copy
const bgpResource = new equinix.networkedge.Bgp("bgpResource", {
    connectionId: "string",
    localAsn: 0,
    localIpAddress: "string",
    remoteAsn: 0,
    remoteIpAddress: "string",
    authenticationKey: "string",
});
Copy
type: equinix:networkedge:Bgp
properties:
    authenticationKey: string
    connectionId: string
    localAsn: 0
    localIpAddress: string
    remoteAsn: 0
    remoteIpAddress: string
Copy

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

ConnectionId
This property is required.
Changes to this property will trigger replacement.
string
identifier of a connection established between. network device and remote service provider that will be used for peering.
LocalAsn This property is required. int
Local ASN number.
LocalIpAddress This property is required. string
IP address in CIDR format of a local device.
RemoteAsn This property is required. int
Remote ASN number.
RemoteIpAddress This property is required. string
IP address of remote peer.
AuthenticationKey string
shared key used for BGP peer authentication.
ConnectionId
This property is required.
Changes to this property will trigger replacement.
string
identifier of a connection established between. network device and remote service provider that will be used for peering.
LocalAsn This property is required. int
Local ASN number.
LocalIpAddress This property is required. string
IP address in CIDR format of a local device.
RemoteAsn This property is required. int
Remote ASN number.
RemoteIpAddress This property is required. string
IP address of remote peer.
AuthenticationKey string
shared key used for BGP peer authentication.
connectionId
This property is required.
Changes to this property will trigger replacement.
String
identifier of a connection established between. network device and remote service provider that will be used for peering.
localAsn This property is required. Integer
Local ASN number.
localIpAddress This property is required. String
IP address in CIDR format of a local device.
remoteAsn This property is required. Integer
Remote ASN number.
remoteIpAddress This property is required. String
IP address of remote peer.
authenticationKey String
shared key used for BGP peer authentication.
connectionId
This property is required.
Changes to this property will trigger replacement.
string
identifier of a connection established between. network device and remote service provider that will be used for peering.
localAsn This property is required. number
Local ASN number.
localIpAddress This property is required. string
IP address in CIDR format of a local device.
remoteAsn This property is required. number
Remote ASN number.
remoteIpAddress This property is required. string
IP address of remote peer.
authenticationKey string
shared key used for BGP peer authentication.
connection_id
This property is required.
Changes to this property will trigger replacement.
str
identifier of a connection established between. network device and remote service provider that will be used for peering.
local_asn This property is required. int
Local ASN number.
local_ip_address This property is required. str
IP address in CIDR format of a local device.
remote_asn This property is required. int
Remote ASN number.
remote_ip_address This property is required. str
IP address of remote peer.
authentication_key str
shared key used for BGP peer authentication.
connectionId
This property is required.
Changes to this property will trigger replacement.
String
identifier of a connection established between. network device and remote service provider that will be used for peering.
localAsn This property is required. Number
Local ASN number.
localIpAddress This property is required. String
IP address in CIDR format of a local device.
remoteAsn This property is required. Number
Remote ASN number.
remoteIpAddress This property is required. String
IP address of remote peer.
authenticationKey String
shared key used for BGP peer authentication.

Outputs

All input properties are implicitly available as output properties. Additionally, the Bgp resource produces the following output properties:

DeviceId string
unique identifier of a network device that is a local peer in a given BGP peering configuration.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningStatus string
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
State string
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
Uuid string
BGP peering configuration unique identifier.
DeviceId string
unique identifier of a network device that is a local peer in a given BGP peering configuration.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningStatus string
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
State string
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
Uuid string
BGP peering configuration unique identifier.
deviceId String
unique identifier of a network device that is a local peer in a given BGP peering configuration.
id String
The provider-assigned unique ID for this managed resource.
provisioningStatus String
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
state String
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
uuid String
BGP peering configuration unique identifier.
deviceId string
unique identifier of a network device that is a local peer in a given BGP peering configuration.
id string
The provider-assigned unique ID for this managed resource.
provisioningStatus string
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
state string
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
uuid string
BGP peering configuration unique identifier.
device_id str
unique identifier of a network device that is a local peer in a given BGP peering configuration.
id str
The provider-assigned unique ID for this managed resource.
provisioning_status str
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
state str
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
uuid str
BGP peering configuration unique identifier.
deviceId String
unique identifier of a network device that is a local peer in a given BGP peering configuration.
id String
The provider-assigned unique ID for this managed resource.
provisioningStatus String
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
state String
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
uuid String
BGP peering configuration unique identifier.

Look up Existing Bgp Resource

Get an existing Bgp 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?: BgpState, opts?: CustomResourceOptions): Bgp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication_key: Optional[str] = None,
        connection_id: Optional[str] = None,
        device_id: Optional[str] = None,
        local_asn: Optional[int] = None,
        local_ip_address: Optional[str] = None,
        provisioning_status: Optional[str] = None,
        remote_asn: Optional[int] = None,
        remote_ip_address: Optional[str] = None,
        state: Optional[str] = None,
        uuid: Optional[str] = None) -> Bgp
func GetBgp(ctx *Context, name string, id IDInput, state *BgpState, opts ...ResourceOption) (*Bgp, error)
public static Bgp Get(string name, Input<string> id, BgpState? state, CustomResourceOptions? opts = null)
public static Bgp get(String name, Output<String> id, BgpState state, CustomResourceOptions options)
resources:  _:    type: equinix:networkedge:Bgp    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:
AuthenticationKey string
shared key used for BGP peer authentication.
ConnectionId Changes to this property will trigger replacement. string
identifier of a connection established between. network device and remote service provider that will be used for peering.
DeviceId string
unique identifier of a network device that is a local peer in a given BGP peering configuration.
LocalAsn int
Local ASN number.
LocalIpAddress string
IP address in CIDR format of a local device.
ProvisioningStatus string
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
RemoteAsn int
Remote ASN number.
RemoteIpAddress string
IP address of remote peer.
State string
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
Uuid string
BGP peering configuration unique identifier.
AuthenticationKey string
shared key used for BGP peer authentication.
ConnectionId Changes to this property will trigger replacement. string
identifier of a connection established between. network device and remote service provider that will be used for peering.
DeviceId string
unique identifier of a network device that is a local peer in a given BGP peering configuration.
LocalAsn int
Local ASN number.
LocalIpAddress string
IP address in CIDR format of a local device.
ProvisioningStatus string
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
RemoteAsn int
Remote ASN number.
RemoteIpAddress string
IP address of remote peer.
State string
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
Uuid string
BGP peering configuration unique identifier.
authenticationKey String
shared key used for BGP peer authentication.
connectionId Changes to this property will trigger replacement. String
identifier of a connection established between. network device and remote service provider that will be used for peering.
deviceId String
unique identifier of a network device that is a local peer in a given BGP peering configuration.
localAsn Integer
Local ASN number.
localIpAddress String
IP address in CIDR format of a local device.
provisioningStatus String
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
remoteAsn Integer
Remote ASN number.
remoteIpAddress String
IP address of remote peer.
state String
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
uuid String
BGP peering configuration unique identifier.
authenticationKey string
shared key used for BGP peer authentication.
connectionId Changes to this property will trigger replacement. string
identifier of a connection established between. network device and remote service provider that will be used for peering.
deviceId string
unique identifier of a network device that is a local peer in a given BGP peering configuration.
localAsn number
Local ASN number.
localIpAddress string
IP address in CIDR format of a local device.
provisioningStatus string
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
remoteAsn number
Remote ASN number.
remoteIpAddress string
IP address of remote peer.
state string
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
uuid string
BGP peering configuration unique identifier.
authentication_key str
shared key used for BGP peer authentication.
connection_id Changes to this property will trigger replacement. str
identifier of a connection established between. network device and remote service provider that will be used for peering.
device_id str
unique identifier of a network device that is a local peer in a given BGP peering configuration.
local_asn int
Local ASN number.
local_ip_address str
IP address in CIDR format of a local device.
provisioning_status str
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
remote_asn int
Remote ASN number.
remote_ip_address str
IP address of remote peer.
state str
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
uuid str
BGP peering configuration unique identifier.
authenticationKey String
shared key used for BGP peer authentication.
connectionId Changes to this property will trigger replacement. String
identifier of a connection established between. network device and remote service provider that will be used for peering.
deviceId String
unique identifier of a network device that is a local peer in a given BGP peering configuration.
localAsn Number
Local ASN number.
localIpAddress String
IP address in CIDR format of a local device.
provisioningStatus String
BGP peering configuration provisioning status, one of PROVISIONING, PENDING_UPDATE, PROVISIONED, FAILED.
remoteAsn Number
Remote ASN number.
remoteIpAddress String
IP address of remote peer.
state String
BGP peer state, one of Idle, Connect, Active, OpenSent, OpenConfirm, Established.
uuid String
BGP peering configuration unique identifier.

Package Details

Repository
equinix equinix/pulumi-equinix
License
Apache-2.0
Notes
This Pulumi package is based on the equinix Terraform Provider.
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix