equinix logo
Equinix v0.2.1, May 4 23

equinix.metal.BgpSession

Explore with Pulumi AI

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var deviceId = config.Require("deviceId");
    var bgp = new Equinix.Metal.BgpSession("bgp", new()
    {
        DeviceId = deviceId,
        AddressFamily = "ipv4",
    });

    return new Dictionary<string, object?>
    {
        ["bgpSessionStatus"] = bgp.Status,
    };
});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		deviceId := cfg.Require("deviceId")
		bgp, err := metal.NewBgpSession(ctx, "bgp", &metal.BgpSessionArgs{
			DeviceId:      pulumi.String(deviceId),
			AddressFamily: pulumi.String("ipv4"),
		})
		if err != nil {
			return err
		}
		ctx.Export("bgpSessionStatus", bgp.Status)
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.equinix.pulumi.metal.BgpSession;
import com.equinix.pulumi.metal.BgpSessionArgs;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var deviceId = config.get("deviceId").get();
        var bgp = new BgpSession("bgp", BgpSessionArgs.builder()        
            .deviceId(deviceId)
            .addressFamily("ipv4")
            .build());

        ctx.export("bgpSessionStatus", bgp.status());
    }
}
import pulumi
import pulumi_equinix as equinix

config = pulumi.Config()
device_id = config.require("deviceId")
bgp = equinix.metal.BgpSession("bgp",
    device_id=device_id,
    address_family="ipv4")
pulumi.export("bgpSessionStatus", bgp.status)
import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@equinix-labs/pulumi-equinix";

const config = new pulumi.Config();
const deviceId = config.require("deviceId");
const bgp = new equinix.metal.BgpSession("bgp", {
    deviceId: deviceId,
    addressFamily: "ipv4",
});
export const bgpSessionStatus = bgp.status;
config:
  deviceId:
    type: string
resources:
  bgp:
    type: equinix:metal:BgpSession
    properties:
      deviceId: ${deviceId}
      addressFamily: ipv4
outputs:
  bgpSessionStatus: ${bgp.status}

Create BgpSession Resource

new BgpSession(name: string, args: BgpSessionArgs, opts?: CustomResourceOptions);
@overload
def BgpSession(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               address_family: Optional[str] = None,
               default_route: Optional[bool] = None,
               device_id: Optional[str] = None)
@overload
def BgpSession(resource_name: str,
               args: BgpSessionArgs,
               opts: Optional[ResourceOptions] = None)
func NewBgpSession(ctx *Context, name string, args BgpSessionArgs, opts ...ResourceOption) (*BgpSession, error)
public BgpSession(string name, BgpSessionArgs args, CustomResourceOptions? opts = null)
public BgpSession(String name, BgpSessionArgs args)
public BgpSession(String name, BgpSessionArgs args, CustomResourceOptions options)
type: equinix:metal:BgpSession
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args BgpSessionArgs
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 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.
name String
The unique name of the resource.
args BgpSessionArgs
The arguments to resource properties.
options 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 Architecture and Concepts 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.

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.

addressFamily String

ipv4 or ipv6.

deviceId String

ID of device.

defaultRoute Boolean

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

Status of the session - up or down

Id string

The provider-assigned unique ID for this managed resource.

Status string

Status of the session - up or down

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the session - up or down

id string

The provider-assigned unique ID for this managed resource.

status string

Status of the session - up or down

id str

The provider-assigned unique ID for this managed resource.

status str

Status of the session - up or down

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the session - up or down

Look up 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)
public static BgpSession get(String name, Output<String> id, BgpSessionState 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:
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

Status of the session - up or down

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

Status of the session - up or down

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

Status of the session - up or down

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

Status of the session - up or down

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

Status of the session - up or down

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

Status of the session - up or down

Package Details

Repository
equinix equinix/pulumi-equinix
License
Apache-2.0
Notes

This Pulumi package is based on the equinix Terraform Provider.