@equinix-labs/pulumi-equinix/metal/getDeviceBgpNeighbors.js

A Pulumi package for creating and managing equinix cloud resources.

"use strict";
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getDeviceBgpNeighborsOutput = exports.getDeviceBgpNeighbors = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
 * 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
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@equinix-labs/pulumi-equinix";
 *
 * const test = equinix.metal.getDeviceBgpNeighbors({
 *     deviceId: "4c641195-25e5-4c3c-b2b7-4cd7a42c7b40",
 * });
 * export const bgpNeighborsListing = test.then(test => test.bgpNeighbors);
 * ```
 */
function getDeviceBgpNeighbors(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("equinix:metal/getDeviceBgpNeighbors:getDeviceBgpNeighbors", {
        "deviceId": args.deviceId,
    }, opts);
}
exports.getDeviceBgpNeighbors = 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
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@equinix-labs/pulumi-equinix";
 *
 * const test = equinix.metal.getDeviceBgpNeighbors({
 *     deviceId: "4c641195-25e5-4c3c-b2b7-4cd7a42c7b40",
 * });
 * export const bgpNeighborsListing = test.then(test => test.bgpNeighbors);
 * ```
 */
function getDeviceBgpNeighborsOutput(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("equinix:metal/getDeviceBgpNeighbors:getDeviceBgpNeighbors", {
        "deviceId": args.deviceId,
    }, opts);
}
exports.getDeviceBgpNeighborsOutput = getDeviceBgpNeighborsOutput;
//# sourceMappingURL=getDeviceBgpNeighbors.js.map