Docs Packages
  1. Packages
  2. Packet
  3. API Docs
  4. getDeviceBgpNeighbors
Packet v3.2.2 published on Thursday, Nov 12, 2020 by Pulumi
pulumi/pulumi-packet

packet.getDeviceBgpNeighbors

Explore with Pulumi AI

packet logo
Packet v3.2.2 published on Thursday, Nov 12, 2020 by Pulumi
pulumi/pulumi-packet

    Use this datasource to retrieve list of BGP neighbors of a device in the Packet 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 Packet, see the packet.BgpSession resource documentation.

    Example Usage

    using Pulumi;
using Packet = Pulumi.Packet;

class MyStack : Stack
{
    public MyStack()
    {
        var test = Output.Create(Packet.GetDeviceBgpNeighbors.InvokeAsync(new Packet.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-packet/sdk/v3/go/packet"
	"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := packet.GetDeviceBgpNeighbors(ctx, &packet.GetDeviceBgpNeighborsArgs{
			DeviceId: "4c641195-25e5-4c3c-b2b7-4cd7a42c7b40",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("bgpNeighborsListing", test.BgpNeighbors)
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_packet as packet

test = packet.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 packet from "@pulumi/packet";

const test = packet.getDeviceBgpNeighbors({
    deviceId: "4c641195-25e5-4c3c-b2b7-4cd7a42c7b40",
});
export const bgpNeighborsListing = test.then(test => test.bgpNeighbors);

    Coming soon!

    Using getDeviceBgpNeighbors

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDeviceBgpNeighbors(args: GetDeviceBgpNeighborsArgs, opts?: InvokeOptions): Promise<GetDeviceBgpNeighborsResult>
function getDeviceBgpNeighborsOutput(args: GetDeviceBgpNeighborsOutputArgs, opts?: InvokeOptions): Output<GetDeviceBgpNeighborsResult>
    def get_device_bgp_neighbors(device_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetDeviceBgpNeighborsResult
def get_device_bgp_neighbors_output(device_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetDeviceBgpNeighborsResult]
    func GetDeviceBgpNeighbors(ctx *Context, args *GetDeviceBgpNeighborsArgs, opts ...InvokeOption) (*GetDeviceBgpNeighborsResult, error)
func GetDeviceBgpNeighborsOutput(ctx *Context, args *GetDeviceBgpNeighborsOutputArgs, opts ...InvokeOption) GetDeviceBgpNeighborsResultOutput

    > Note: This function is named GetDeviceBgpNeighbors in the Go SDK.

    public static class GetDeviceBgpNeighbors 
{
    public static Task<GetDeviceBgpNeighborsResult> InvokeAsync(GetDeviceBgpNeighborsArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceBgpNeighborsResult> Invoke(GetDeviceBgpNeighborsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDeviceBgpNeighborsResult> getDeviceBgpNeighbors(GetDeviceBgpNeighborsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: packet:index/getDeviceBgpNeighbors:getDeviceBgpNeighbors
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DeviceId string
    UUID of BGP-enabled device whose neighbors to list
    DeviceId string
    UUID of BGP-enabled device whose neighbors to list
    deviceId String
    UUID of BGP-enabled device whose neighbors to list
    deviceId string
    UUID of BGP-enabled device whose neighbors to list
    device_id str
    UUID of BGP-enabled device whose neighbors to list
    deviceId String
    UUID of BGP-enabled device whose neighbors to list

    getDeviceBgpNeighbors Result

    The following output properties are available:

    BgpNeighbors List<GetDeviceBgpNeighborsBgpNeighbor>
    array of BGP neighbor records with attributes:
    DeviceId string
    Id string
    The provider-assigned unique ID for this managed resource.
    BgpNeighbors []GetDeviceBgpNeighborsBgpNeighbor
    array of BGP neighbor records with attributes:
    DeviceId string
    Id string
    The provider-assigned unique ID for this managed resource.
    bgpNeighbors List<GetDeviceBgpNeighborsBgpNeighbor>
    array of BGP neighbor records with attributes:
    deviceId String
    id String
    The provider-assigned unique ID for this managed resource.
    bgpNeighbors GetDeviceBgpNeighborsBgpNeighbor[]
    array of BGP neighbor records with attributes:
    deviceId string
    id string
    The provider-assigned unique ID for this managed resource.
    bgp_neighbors Sequence[GetDeviceBgpNeighborsBgpNeighbor]
    array of BGP neighbor records with attributes:
    device_id str
    id str
    The provider-assigned unique ID for this managed resource.
    bgpNeighbors List<Property Map>
    array of BGP neighbor records with attributes:
    deviceId String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetDeviceBgpNeighborsBgpNeighbor

    AddressFamily int
    IP address version, 4 or 6
    CustomerAs int
    Local autonomous system number
    CustomerIp 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
    PeerAs int
    Peer AS number (different than customer_as for EBGP)
    RoutesIns List<GetDeviceBgpNeighborsBgpNeighborRoutesIn>
    Array of incoming routes. Each route has attributes:
    RoutesOuts List<GetDeviceBgpNeighborsBgpNeighborRoutesOut>
    Array of outgoing routes in the same format
    PeerIps List<string>
    Array of IP addresses of this neighbor's peers
    AddressFamily int
    IP address version, 4 or 6
    CustomerAs int
    Local autonomous system number
    CustomerIp 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
    PeerAs int
    Peer AS number (different than customer_as for EBGP)
    RoutesIns []GetDeviceBgpNeighborsBgpNeighborRoutesIn
    Array of incoming routes. Each route has attributes:
    RoutesOuts []GetDeviceBgpNeighborsBgpNeighborRoutesOut
    Array of outgoing routes in the same format
    PeerIps []string
    Array of IP addresses of this neighbor's peers
    addressFamily Integer
    IP address version, 4 or 6
    customerAs Integer
    Local autonomous system number
    customerIp 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
    peerAs Integer
    Peer AS number (different than customer_as for EBGP)
    routesIns List<GetDeviceBgpNeighborsBgpNeighborRoutesIn>
    Array of incoming routes. Each route has attributes:
    routesOuts List<GetDeviceBgpNeighborsBgpNeighborRoutesOut>
    Array of outgoing routes in the same format
    peerIps List<String>
    Array of IP addresses of this neighbor's peers
    addressFamily number
    IP address version, 4 or 6
    customerAs number
    Local autonomous system number
    customerIp 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
    peerAs number
    Peer AS number (different than customer_as for EBGP)
    routesIns GetDeviceBgpNeighborsBgpNeighborRoutesIn[]
    Array of incoming routes. Each route has attributes:
    routesOuts GetDeviceBgpNeighborsBgpNeighborRoutesOut[]
    Array of outgoing routes in the same format
    peerIps 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[GetDeviceBgpNeighborsBgpNeighborRoutesIn]
    Array of incoming routes. Each route has attributes:
    routes_outs Sequence[GetDeviceBgpNeighborsBgpNeighborRoutesOut]
    Array of outgoing routes in the same format
    peer_ips Sequence[str]
    Array of IP addresses of this neighbor's peers
    addressFamily Number
    IP address version, 4 or 6
    customerAs Number
    Local autonomous system number
    customerIp 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
    peerAs Number
    Peer AS number (different than customer_as for EBGP)
    routesIns List<Property Map>
    Array of incoming routes. Each route has attributes:
    routesOuts List<Property Map>
    Array of outgoing routes in the same format
    peerIps List<String>
    Array of IP addresses of this neighbor's peers

    GetDeviceBgpNeighborsBgpNeighborRoutesIn

    Exact bool
    (bool) Whether the route is exact
    Route string
    CIDR expression of route (ip/mask)
    Exact bool
    (bool) Whether the route is exact
    Route string
    CIDR expression of route (ip/mask)
    exact Boolean
    (bool) Whether the route is exact
    route String
    CIDR expression of route (ip/mask)
    exact boolean
    (bool) Whether the route is exact
    route string
    CIDR expression of route (ip/mask)
    exact bool
    (bool) Whether the route is exact
    route str
    CIDR expression of route (ip/mask)
    exact Boolean
    (bool) Whether the route is exact
    route String
    CIDR expression of route (ip/mask)

    GetDeviceBgpNeighborsBgpNeighborRoutesOut

    Exact bool
    (bool) Whether the route is exact
    Route string
    CIDR expression of route (ip/mask)
    Exact bool
    (bool) Whether the route is exact
    Route string
    CIDR expression of route (ip/mask)
    exact Boolean
    (bool) Whether the route is exact
    route String
    CIDR expression of route (ip/mask)
    exact boolean
    (bool) Whether the route is exact
    route string
    CIDR expression of route (ip/mask)
    exact bool
    (bool) Whether the route is exact
    route str
    CIDR expression of route (ip/mask)
    exact Boolean
    (bool) Whether the route is exact
    route String
    CIDR expression of route (ip/mask)

    Package Details

    Repository
    Packet pulumi/pulumi-packet
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the packet Terraform Provider.
    packet logo
    Packet v3.2.2 published on Thursday, Nov 12, 2020 by Pulumi
    pulumi/pulumi-packet