Equinix Metal v3.2.1, Dec 30 21

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

equinix-metal.BgpSession

Explore with Pulumi AI

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

Create BgpSession Resource

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

new BgpSession(name: string, args: BgpSessionArgs, opts?: CustomResourceOptions);

@overload
def BgpSession(resource_name: str,
               args: BgpSessionArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def BgpSession(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               address_family: Optional[str] = None,
               device_id: Optional[str] = None,
               default_route: Optional[bool] = 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.

Parameters

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.

Constructor example

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

TypeScript
Python
Go
C#
Java
YAML

var bgpSessionResource = new EquinixMetal.BgpSession("bgpSessionResource", new()
{
    AddressFamily = "string",
    DeviceId = "string",
    DefaultRoute = false,
});

example, err := equinixmetal.NewBgpSession(ctx, "bgpSessionResource", &equinixmetal.BgpSessionArgs{
	AddressFamily: pulumi.String("string"),
	DeviceId:      pulumi.String("string"),
	DefaultRoute:  pulumi.Bool(false),
})

var bgpSessionResource = new BgpSession("bgpSessionResource", BgpSessionArgs.builder()
    .addressFamily("string")
    .deviceId("string")
    .defaultRoute(false)
    .build());

bgp_session_resource = equinix_metal.BgpSession("bgpSessionResource",
    address_family="string",
    device_id="string",
    default_route=False)

const bgpSessionResource = new equinix_metal.BgpSession("bgpSessionResource", {
    addressFamily: "string",
    deviceId: "string",
    defaultRoute: false,
});

type: equinix-metal:BgpSession
properties:
    addressFamily: string
    defaultRoute: false
    deviceId: string

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

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

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.

TypeScript
Python
Go
C#
Java
YAML

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)

resources:  _:    type: equinix-metal:BgpSession    get:      id: ${id}

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 Metal pulumi/pulumi-equinix-metal
License: Apache-2.0
Notes: This Pulumi package is based on the metal Terraform Provider.

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

pulumi/pulumi-equinix-metal

equinix-metal.BgpSession

On this page

On this page

Create BgpSession Resource

Constructor syntax

Parameters

Constructor example

BgpSession Resource Properties

Inputs

Outputs

Look up Existing BgpSession Resource

Package Details

On this page

On this page