Docs Home
Packet v3.2.2 published on Thursday, Nov 12, 2020 by Pulumi
packet.BgpSession
Explore with Pulumi AI
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
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: packet: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.
var bgpSessionResource = new Packet.BgpSession("bgpSessionResource", new()
{
AddressFamily = "string",
DeviceId = "string",
DefaultRoute = false,
});
example, err := packet.NewBgpSession(ctx, "bgpSessionResource", &packet.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 = packet.BgpSession("bgpSessionResource",
address_family="string",
device_id="string",
default_route=False)
const bgpSessionResource = new packet.BgpSession("bgpSessionResource", {
addressFamily: "string",
deviceId: "string",
defaultRoute: false,
});
type: packet: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:
- Address
Family string ipv4oripv6- Device
Id string - ID of device
- Default
Route bool - Boolean flag to set the default route policy. False by default.
- Address
Family string ipv4oripv6- Device
Id string - ID of device
- Default
Route bool - Boolean flag to set the default route policy. False by default.
- address
Family String ipv4oripv6- device
Id String - ID of device
- default
Route Boolean - Boolean flag to set the default route policy. False by default.
- address
Family string ipv4oripv6- device
Id string - ID of device
- default
Route boolean - Boolean flag to set the default route policy. False by default.
- address_
family str ipv4oripv6- device_
id str - ID of device
- default_
route bool - Boolean flag to set the default route policy. False by default.
- address
Family String ipv4oripv6- device
Id String - ID of device
- default
Route 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:
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) -> BgpSessionfunc 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: packet: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.
- Address
Family string ipv4oripv6- Default
Route bool - Boolean flag to set the default route policy. False by default.
- Device
Id string - ID of device
- Status string
- Address
Family string ipv4oripv6- Default
Route bool - Boolean flag to set the default route policy. False by default.
- Device
Id string - ID of device
- Status string
- address
Family String ipv4oripv6- default
Route Boolean - Boolean flag to set the default route policy. False by default.
- device
Id String - ID of device
- status String
- address
Family string ipv4oripv6- default
Route boolean - Boolean flag to set the default route policy. False by default.
- device
Id string - ID of device
- status string
- address_
family str ipv4oripv6- default_
route bool - Boolean flag to set the default route policy. False by default.
- device_
id str - ID of device
- status str
- address
Family String ipv4oripv6- default
Route Boolean - Boolean flag to set the default route policy. False by default.
- device
Id 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
packetTerraform Provider.