Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

BgpSession

Provides a resource to manage BGP sessions in Equinix Metal Host. Refer to Equinix Metal BGP documentation for more details.

You need to have BGP config enabled in your project.

BGP session must be linked to a device running BIRD or other BGP routing daemon which will control route advertisements via the session to Equinix Metal’s upstream routers.

Create a BgpSession Resource

new BgpSession(name: string, args: BgpSessionArgs, opts?: CustomResourceOptions);
def BgpSession(resource_name: str, opts: Optional[ResourceOptions] = None, address_family: Optional[str] = None, default_route: Optional[bool] = None, device_id: Optional[str] = None)
func NewBgpSession(ctx *Context, name string, args BgpSessionArgs, opts ...ResourceOption) (*BgpSession, error)
public BgpSession(string name, BgpSessionArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args BgpSessionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BgpSessionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BgpSessionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

BgpSession Resource Properties

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

Inputs

The BgpSession resource accepts the following input properties:

AddressFamily string

ipv4 or ipv6

DeviceId string

ID of device

DefaultRoute bool

Boolean flag to set the default route policy. False by default.

AddressFamily string

ipv4 or ipv6

DeviceId string

ID of device

DefaultRoute bool

Boolean flag to set the default route policy. False by default.

addressFamily string

ipv4 or ipv6

deviceId string

ID of device

defaultRoute boolean

Boolean flag to set the default route policy. False by default.

address_family str

ipv4 or ipv6

device_id str

ID of device

default_route bool

Boolean flag to set the default route policy. False by default.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Status string
Id string
The provider-assigned unique ID for this managed resource.
Status string
id string
The provider-assigned unique ID for this managed resource.
status string
id str
The provider-assigned unique ID for this managed resource.
status str

Look up an Existing BgpSession Resource

Get an existing BgpSession 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?: BgpSessionState, opts?: CustomResourceOptions): BgpSession
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, address_family: Optional[str] = None, default_route: Optional[bool] = None, device_id: Optional[str] = None, status: Optional[str] = None) -> BgpSession
func GetBgpSession(ctx *Context, name string, id IDInput, state *BgpSessionState, opts ...ResourceOption) (*BgpSession, error)
public static BgpSession Get(string name, Input<string> id, BgpSessionState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AddressFamily string

ipv4 or ipv6

DefaultRoute bool

Boolean flag to set the default route policy. False by default.

DeviceId string

ID of device

Status string
AddressFamily string

ipv4 or ipv6

DefaultRoute bool

Boolean flag to set the default route policy. False by default.

DeviceId string

ID of device

Status string
addressFamily string

ipv4 or ipv6

defaultRoute boolean

Boolean flag to set the default route policy. False by default.

deviceId string

ID of device

status string
address_family str

ipv4 or ipv6

default_route bool

Boolean flag to set the default route policy. False by default.

device_id str

ID of device

status str

Package Details

Repository
https://github.com/pulumi/pulumi-equinix-metal
License
Apache-2.0
Notes
This Pulumi package is based on the metal Terraform Provider.