Packet v3.2.2, Nov 12 20

packet.BgpSession

Provides a resource to manage BGP sessions in Packet Host. Refer to Packet 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 Packet’s upstream routers.

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: packet: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

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

id String: The provider-assigned unique ID for this managed resource.
status String

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

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

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

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

Package Details

Repository: Packet pulumi/pulumi-packet
License: Apache-2.0
Notes: This Pulumi package is based on the packet Terraform Provider.