@muhlba91/pulumi-proxmoxve
Version:
A Pulumi package for creating and managing Proxmox Virtual Environment cloud resources.
182 lines • 6.75 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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 = new proxmoxve.sdn.zone.Vxlan("example", {
* resourceId: "vxlan1",
* peers: [
* "10.0.0.1",
* "10.0.0.2",
* "10.0.0.3",
* ],
* mtu: 1450,
* dns: "1.1.1.1",
* dnsZone: "example.com",
* ipam: "pve",
* reverseDns: "1.1.1.1",
* });
* ```
*
* ## Import
*
* !/usr/bin/env sh
* VXLAN SDN zone can be imported using its unique identifier (zone ID)
*
* ```sh
* $ pulumi import proxmoxve:sdn/zone/vxlan:Vxlan example vxlan1
* ```
*/
export declare class Vxlan extends pulumi.CustomResource {
/**
* Get an existing Vxlan 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<pulumi.ID>, state?: VxlanState, opts?: pulumi.CustomResourceOptions): Vxlan;
/**
* Returns true if the given object is an instance of Vxlan. 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 Vxlan;
/**
* DNS API server address.
*/
readonly dns: pulumi.Output<string | undefined>;
/**
* DNS domain name. Used to register hostnames, such as `<hostname>.<domain>`. The DNS zone must already exist on the DNS server.
*/
readonly dnsZone: pulumi.Output<string | undefined>;
/**
* IP Address Management system.
*/
readonly ipam: pulumi.Output<string | undefined>;
/**
* MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
*/
readonly mtu: pulumi.Output<number>;
/**
* The Proxmox nodes which the zone and associated VNets should be deployed on
*/
readonly nodes: pulumi.Output<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: pulumi.Output<string[]>;
/**
* Indicates if the zone has pending configuration changes that need to be applied.
*/
readonly pending: pulumi.Output<boolean>;
/**
* The unique identifier of the SDN zone.
*/
readonly resourceId: pulumi.Output<string>;
/**
* Reverse DNS API server address.
*/
readonly reverseDns: pulumi.Output<string | undefined>;
/**
* Indicates the current state of the zone.
*/
readonly state: pulumi.Output<string>;
/**
* Create a Vxlan 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: VxlanArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Vxlan resources.
*/
export interface VxlanState {
/**
* DNS API server address.
*/
dns?: pulumi.Input<string | undefined>;
/**
* DNS domain name. Used to register hostnames, such as `<hostname>.<domain>`. The DNS zone must already exist on the DNS server.
*/
dnsZone?: pulumi.Input<string | undefined>;
/**
* IP Address Management system.
*/
ipam?: pulumi.Input<string | undefined>;
/**
* MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
*/
mtu?: pulumi.Input<number | undefined>;
/**
* The Proxmox nodes which the zone and associated VNets should be deployed on
*/
nodes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* 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
*/
peers?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Indicates if the zone has pending configuration changes that need to be applied.
*/
pending?: pulumi.Input<boolean | undefined>;
/**
* The unique identifier of the SDN zone.
*/
resourceId?: pulumi.Input<string | undefined>;
/**
* Reverse DNS API server address.
*/
reverseDns?: pulumi.Input<string | undefined>;
/**
* Indicates the current state of the zone.
*/
state?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Vxlan resource.
*/
export interface VxlanArgs {
/**
* DNS API server address.
*/
dns?: pulumi.Input<string | undefined>;
/**
* DNS domain name. Used to register hostnames, such as `<hostname>.<domain>`. The DNS zone must already exist on the DNS server.
*/
dnsZone?: pulumi.Input<string | undefined>;
/**
* IP Address Management system.
*/
ipam?: pulumi.Input<string | undefined>;
/**
* MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
*/
mtu?: pulumi.Input<number | undefined>;
/**
* The Proxmox nodes which the zone and associated VNets should be deployed on
*/
nodes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* 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
*/
peers: pulumi.Input<pulumi.Input<string>[]>;
/**
* The unique identifier of the SDN zone.
*/
resourceId: pulumi.Input<string>;
/**
* Reverse DNS API server address.
*/
reverseDns?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=vxlan.d.ts.map