UNPKG

@muhlba91/pulumi-proxmoxve

Version:

A Pulumi package for creating and managing Proxmox Virtual Environment cloud resources.

119 lines 4.63 kB
import * as pulumi from "@pulumi/pulumi"; /** * > **Deprecated:** Use `proxmoxve.sdn/zone.Vxlan` instead. This data source will be removed in v1.0. * * Retrieves information about a VXLAN Zone in Proxmox SDN. It establishes a tunnel (overlay) on top of an existing network (underlay). This encapsulates layer 2 Ethernet frames within layer 4 UDP datagrams using the default destination port 4789. You have to configure the underlay network yourself to enable UDP connectivity between all peers. Because VXLAN encapsulation uses 50 bytes, the MTU needs to be 50 bytes lower than the outgoing physical interface. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as proxmoxve from "@muhlba91/pulumi-proxmoxve"; * * const example = proxmoxve.sdn.zone.getVxlanLegacy({ * id: "vxlan1", * }); * export const dataProxmoxVirtualEnvironmentSdnZoneVxlan = { * id: example.then(example => example.id), * nodes: example.then(example => example.nodes), * peers: example.then(example => example.peers), * mtu: example.then(example => example.mtu), * dns: example.then(example => example.dns), * dnsZone: example.then(example => example.dnsZone), * ipam: example.then(example => example.ipam), * reverseDns: example.then(example => example.reverseDns), * }; * ``` */ export declare function getVxlanLegacy(args: GetVxlanLegacyArgs, opts?: pulumi.InvokeOptions): Promise<GetVxlanLegacyResult>; /** * A collection of arguments for invoking getVxlanLegacy. */ export interface GetVxlanLegacyArgs { /** * The unique identifier of the SDN zone. */ id: string; } /** * A collection of values returned by getVxlanLegacy. */ export interface GetVxlanLegacyResult { /** * DNS API server address. */ readonly dns: string; /** * DNS domain name. Used to register hostnames, such as `<hostname>.<domain>`. The DNS zone must already exist on the DNS server. */ readonly dnsZone: string; /** * The unique identifier of the SDN zone. */ readonly id: string; /** * IP Address Management system. */ readonly ipam: string; /** * MTU value for the zone. */ readonly mtu: number; /** * The Proxmox nodes which the zone and associated VNets are deployed on */ readonly nodes: string[]; /** * A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here */ readonly peers: string[]; /** * Indicates if the zone has pending configuration changes that need to be applied. */ readonly pending: boolean; /** * Reverse DNS API server address. */ readonly reverseDns: string; /** * Indicates the current state of the zone. */ readonly state: string; } /** * > **Deprecated:** Use `proxmoxve.sdn/zone.Vxlan` instead. This data source will be removed in v1.0. * * Retrieves information about a VXLAN Zone in Proxmox SDN. It establishes a tunnel (overlay) on top of an existing network (underlay). This encapsulates layer 2 Ethernet frames within layer 4 UDP datagrams using the default destination port 4789. You have to configure the underlay network yourself to enable UDP connectivity between all peers. Because VXLAN encapsulation uses 50 bytes, the MTU needs to be 50 bytes lower than the outgoing physical interface. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as proxmoxve from "@muhlba91/pulumi-proxmoxve"; * * const example = proxmoxve.sdn.zone.getVxlanLegacy({ * id: "vxlan1", * }); * export const dataProxmoxVirtualEnvironmentSdnZoneVxlan = { * id: example.then(example => example.id), * nodes: example.then(example => example.nodes), * peers: example.then(example => example.peers), * mtu: example.then(example => example.mtu), * dns: example.then(example => example.dns), * dnsZone: example.then(example => example.dnsZone), * ipam: example.then(example => example.ipam), * reverseDns: example.then(example => example.reverseDns), * }; * ``` */ export declare function getVxlanLegacyOutput(args: GetVxlanLegacyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVxlanLegacyResult>; /** * A collection of arguments for invoking getVxlanLegacy. */ export interface GetVxlanLegacyOutputArgs { /** * The unique identifier of the SDN zone. */ id: pulumi.Input<string>; } //# sourceMappingURL=getVxlanLegacy.d.ts.map