import * as pulumi from "@pulumi/pulumi"; /** * Use this resource to manage a VRF. * * See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material. * * ## Example Usage * ### example 1 * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@equinix-labs/pulumi-equinix"; * * const example = new equinix.metal.Project("example", {name: "example"}); * const exampleVrf = new equinix.metal.Vrf("exampleVrf", { * description: "VRF with ASN 65000 and a pool of address space that includes 192.168.100.0/25", * name: "example-vrf", * metro: "da", * localAsn: 65000, * ipRanges: [ * "192.168.100.0/25", * "192.168.200.0/25", * ], * projectId: example.id, * }); * ``` * ### example 2 * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@equinix-labs/pulumi-equinix"; * * const example = new equinix.metal.ReservedIpBlock("example", { * description: "Reserved IP block (192.168.100.0/29) taken from on of the ranges in the VRF's pool of address space.", * projectId: exampleEquinixMetalProject.id, * metro: exampleEquinixMetalVrf.metro, * type: "vrf", * vrfId: exampleEquinixMetalVrf.id, * cidr: 29, * network: "192.168.100.0", * }); * const exampleVlan = new equinix.metal.Vlan("exampleVlan", { * description: "A VLAN for Layer2 and Hybrid Metal devices", * metro: exampleEquinixMetalVrf.metro, * projectId: exampleEquinixMetalProject.id, * }); * const exampleGateway = new equinix.metal.Gateway("exampleGateway", { * projectId: exampleEquinixMetalProject.id, * vlanId: exampleVlan.id, * ipReservationId: example.id, * }); * ``` * ### example 3 * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@equinix-labs/pulumi-equinix"; * * const exampleVirtualCircuit = new equinix.metal.VirtualCircuit("exampleVirtualCircuit", { * name: "example-vc", * description: "Virtual Circuit", * connectionId: example.id, * projectId: exampleEquinixMetalProject.id, * portId: example.ports[0].id, * nniVlan: 1024, * vrfId: exampleEquinixMetalVrf.id, * peerAsn: 65530, * subnet: "192.168.100.16/31", * metalIp: "192.168.100.16", * customerIp: "192.168.100.17", * }); * ``` * * ## Import * * This resource can be imported using an existing VRF ID: * * ```sh * $ pulumi import equinix:metal/vrf:Vrf equinix_metal_vrf {existing_id} * ``` */ export declare class Vrf extends pulumi.CustomResource { /** * Get an existing Vrf resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: VrfState, opts?: pulumi.CustomResourceOptions): Vrf; /** * Returns true if the given object is an instance of Vrf. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Vrf; /** * Description of the VRF */ readonly description: pulumi.Output; /** * All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF. */ readonly ipRanges: pulumi.Output; /** * The 4-byte ASN set on the VRF. */ readonly localAsn: pulumi.Output; /** * Metro ID or Code where the VRF will be deployed */ readonly metro: pulumi.Output; /** * User-supplied name of the VRF, unique to the project */ readonly name: pulumi.Output; /** * Project ID where the VRF will be deployed */ readonly projectId: pulumi.Output; /** * Create a Vrf resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: VrfArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Vrf resources. */ export interface VrfState { /** * Description of the VRF */ description?: pulumi.Input; /** * All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF. */ ipRanges?: pulumi.Input[]>; /** * The 4-byte ASN set on the VRF. */ localAsn?: pulumi.Input; /** * Metro ID or Code where the VRF will be deployed */ metro?: pulumi.Input; /** * User-supplied name of the VRF, unique to the project */ name?: pulumi.Input; /** * Project ID where the VRF will be deployed */ projectId?: pulumi.Input; } /** * The set of arguments for constructing a Vrf resource. */ export interface VrfArgs { /** * Description of the VRF */ description?: pulumi.Input; /** * All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF. */ ipRanges?: pulumi.Input[]>; /** * The 4-byte ASN set on the VRF. */ localAsn?: pulumi.Input; /** * Metro ID or Code where the VRF will be deployed */ metro: pulumi.Input; /** * User-supplied name of the VRF, unique to the project */ name?: pulumi.Input; /** * Project ID where the VRF will be deployed */ projectId: pulumi.Input; }