@equinix-labs/pulumi-equinix/metal/getDeviceBgpNeighbors.d.ts

A Pulumi package for creating and managing equinix cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * 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);
 * ```
 */
export declare function getDeviceBgpNeighbors(args: GetDeviceBgpNeighborsArgs, opts?: pulumi.InvokeOptions): Promise<GetDeviceBgpNeighborsResult>;
/**
 * A collection of arguments for invoking getDeviceBgpNeighbors.
 */
export interface GetDeviceBgpNeighborsArgs {
    /**
     * UUID of BGP-enabled device whose neighbors to list.
     */
    deviceId: string;
}
/**
 * A collection of values returned by getDeviceBgpNeighbors.
 */
export interface GetDeviceBgpNeighborsResult {
    /**
     * array of BGP neighbor records with attributes:
     */
    readonly bgpNeighbors: outputs.metal.GetDeviceBgpNeighborsBgpNeighbor[];
    readonly deviceId: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
}
/**
 * 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);
 * ```
 */
export declare function getDeviceBgpNeighborsOutput(args: GetDeviceBgpNeighborsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDeviceBgpNeighborsResult>;
/**
 * A collection of arguments for invoking getDeviceBgpNeighbors.
 */
export interface GetDeviceBgpNeighborsOutputArgs {
    /**
     * UUID of BGP-enabled device whose neighbors to list.
     */
    deviceId: pulumi.Input<string>;
}