getDeviceBgpNeighbors
Use this datasource to retrieve list of BGP neighbors of a device in the Equinix Metal host.
To have any BGP neighbors listed, the device must be in BGP-enabled project and have a BGP session assigned.
To learn more about using BGP in Equinix Metal, see the equinix-metal.BgpSession resource documentation.
Example Usage
using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;
class MyStack : Stack
{
public MyStack()
{
var test = Output.Create(EquinixMetal.GetDeviceBgpNeighbors.InvokeAsync(new EquinixMetal.GetDeviceBgpNeighborsArgs
{
DeviceId = "4c641195-25e5-4c3c-b2b7-4cd7a42c7b40",
}));
this.BgpNeighborsListing = test.Apply(test => test.BgpNeighbors);
}
[Output("bgpNeighborsListing")]
public Output<string> BgpNeighborsListing { get; set; }
}
package main
import (
"github.com/pulumi/pulumi-equinix-metal/sdk/go/equinix-metal"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
test, err := equinix - metal.GetDeviceBgpNeighbors(ctx, &equinix-metal.GetDeviceBgpNeighborsArgs{
DeviceId: "4c641195-25e5-4c3c-b2b7-4cd7a42c7b40",
}, nil)
if err != nil {
return err
}
ctx.Export("bgpNeighborsListing", test.BgpNeighbors)
return nil
})
}
import pulumi
import pulumi_equinix_metal as equinix_metal
test = equinix_metal.get_device_bgp_neighbors(device_id="4c641195-25e5-4c3c-b2b7-4cd7a42c7b40")
pulumi.export("bgpNeighborsListing", test.bgp_neighbors)
import * as pulumi from "@pulumi/pulumi";
import * as equinix_metal from "@pulumi/equinix-metal";
const test = equinix_metal.getDeviceBgpNeighbors({
deviceId: "4c641195-25e5-4c3c-b2b7-4cd7a42c7b40",
});
export const bgpNeighborsListing = test.then(test => test.bgpNeighbors);
Using getDeviceBgpNeighbors
function getDeviceBgpNeighbors(args: GetDeviceBgpNeighborsArgs, opts?: InvokeOptions): Promise<GetDeviceBgpNeighborsResult>
def get_device_bgp_neighbors(device_id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetDeviceBgpNeighborsResult
func GetDeviceBgpNeighbors(ctx *Context, args *GetDeviceBgpNeighborsArgs, opts ...InvokeOption) (*GetDeviceBgpNeighborsResult, error)
Note: This function is named
GetDeviceBgpNeighbors
in the Go SDK.
public static class GetDeviceBgpNeighbors {
public static Task<GetDeviceBgpNeighborsResult> InvokeAsync(GetDeviceBgpNeighborsArgs args, InvokeOptions? opts = null)
}
The following arguments are supported:
- Device
Id string UUID of BGP-enabled device whose neighbors to list
- Device
Id string UUID of BGP-enabled device whose neighbors to list
- device
Id string UUID of BGP-enabled device whose neighbors to list
- device_
id str UUID of BGP-enabled device whose neighbors to list
getDeviceBgpNeighbors Result
The following output properties are available:
- Bgp
Neighbors List<Pulumi.Equinix Metal. Outputs. Get Device Bgp Neighbors Bgp Neighbor> array of BGP neighbor records with attributes:
- Device
Id string - Id string
The provider-assigned unique ID for this managed resource.
- Bgp
Neighbors []GetDevice Bgp Neighbors Bgp Neighbor array of BGP neighbor records with attributes:
- Device
Id string - Id string
The provider-assigned unique ID for this managed resource.
- bgp
Neighbors GetDevice Bgp Neighbors Bgp Neighbor[] array of BGP neighbor records with attributes:
- device
Id string - id string
The provider-assigned unique ID for this managed resource.
- bgp_
neighbors Sequence[GetDevice Bgp Neighbors Bgp Neighbor] array of BGP neighbor records with attributes:
- device_
id str - id str
The provider-assigned unique ID for this managed resource.
Supporting Types
GetDeviceBgpNeighborsBgpNeighbor
- Address
Family int IP address version, 4 or 6
- Customer
As int Local autonomous system number
- Customer
Ip string Local used peer IP address
- Md5Enabled bool
Whether BGP session is password enabled
- Md5Password string
BGP session password in plaintext (not a checksum)
- Multihop bool
Whether the neighbor is in EBGP multihop session
- Peer
As int Peer AS number (different than customer_as for EBGP)
- Routes
Ins List<Pulumi.Equinix Metal. Inputs. Get Device Bgp Neighbors Bgp Neighbor Routes In Args> Array of incoming routes. Each route has attributes:
- Routes
Outs List<Pulumi.Equinix Metal. Inputs. Get Device Bgp Neighbors Bgp Neighbor Routes Out Args> Array of outgoing routes in the same format
- Peer
Ips List<string> Array of IP addresses of this neighbor’s peers
- Address
Family int IP address version, 4 or 6
- Customer
As int Local autonomous system number
- Customer
Ip string Local used peer IP address
- Md5Enabled bool
Whether BGP session is password enabled
- Md5Password string
BGP session password in plaintext (not a checksum)
- Multihop bool
Whether the neighbor is in EBGP multihop session
- Peer
As int Peer AS number (different than customer_as for EBGP)
- Routes
Ins []GetDevice Bgp Neighbors Bgp Neighbor Routes In Array of incoming routes. Each route has attributes:
- Routes
Outs []GetDevice Bgp Neighbors Bgp Neighbor Routes Out Array of outgoing routes in the same format
- Peer
Ips []string Array of IP addresses of this neighbor’s peers
- address
Family number IP address version, 4 or 6
- customer
As number Local autonomous system number
- customer
Ip string Local used peer IP address
- md5Enabled boolean
Whether BGP session is password enabled
- md5Password string
BGP session password in plaintext (not a checksum)
- multihop boolean
Whether the neighbor is in EBGP multihop session
- peer
As number Peer AS number (different than customer_as for EBGP)
- routes
Ins GetDevice Bgp Neighbors Bgp Neighbor Routes In[] Array of incoming routes. Each route has attributes:
- routes
Outs GetDevice Bgp Neighbors Bgp Neighbor Routes Out[] Array of outgoing routes in the same format
- peer
Ips string[] Array of IP addresses of this neighbor’s peers
- address_
family int IP address version, 4 or 6
- customer_
as int Local autonomous system number
- customer_
ip str Local used peer IP address
- md5_
enabled bool Whether BGP session is password enabled
- md5_
password str BGP session password in plaintext (not a checksum)
- multihop bool
Whether the neighbor is in EBGP multihop session
- peer_
as int Peer AS number (different than customer_as for EBGP)
- routes_
ins Sequence[GetDevice Bgp Neighbors Bgp Neighbor Routes In Args] Array of incoming routes. Each route has attributes:
- routes_
outs Sequence[GetDevice Bgp Neighbors Bgp Neighbor Routes Out Args] Array of outgoing routes in the same format
- peer_
ips Sequence[str] Array of IP addresses of this neighbor’s peers
GetDeviceBgpNeighborsBgpNeighborRoutesIn
GetDeviceBgpNeighborsBgpNeighborRoutesOut
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.