@muhlba91/pulumi-proxmoxve
Version:
A Pulumi package for creating and managing Proxmox Virtual Environment cloud resources.
204 lines • 7.34 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* QinQ Zone in Proxmox SDN. QinQ also known as VLAN stacking, that uses multiple layers of VLAN tags for isolation. The QinQ zone defines the outer VLAN tag (the Service VLAN) whereas the inner VLAN tag is defined by the VNet. Your physical network switches must support stacked VLANs for this configuration. Due to the double stacking of tags, you need 4 more bytes for QinQ VLANs. For example, you must reduce the MTU to 1496 if you physical interface MTU is 1500.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
*
* const example = new proxmoxve.sdn.zone.Qinq("example", {
* resourceId: "qinq1",
* bridge: "vmbr0",
* serviceVlan: 100,
* serviceVlanProtocol: "802.1ad",
* mtu: 1496,
* dns: "1.1.1.1",
* dnsZone: "example.com",
* ipam: "pve",
* reverseDns: "1.1.1.1",
* });
* ```
*
* ## Import
*
* !/usr/bin/env sh
* QinQ SDN zone can be imported using its unique identifier (zone ID)
*
* ```sh
* $ pulumi import proxmoxve:sdn/zone/qinq:Qinq example qinq1
* ```
*/
export declare class Qinq extends pulumi.CustomResource {
/**
* Get an existing Qinq 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?: QinqState, opts?: pulumi.CustomResourceOptions): Qinq;
/**
* Returns true if the given object is an instance of Qinq. 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 Qinq;
/**
* A local, VLAN-aware bridge that is already configured on each local node
*/
readonly bridge: pulumi.Output<string>;
/**
* 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[]>;
/**
* 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>;
/**
* Service VLAN tag for QinQ. The tag must be between `1` and `4094`.
*/
readonly serviceVlan: pulumi.Output<number>;
/**
* Service VLAN protocol for QinQ. The protocol must be `802.1ad` or `802.1q`.
*/
readonly serviceVlanProtocol: pulumi.Output<string>;
/**
* Indicates the current state of the zone.
*/
readonly state: pulumi.Output<string>;
/**
* Create a Qinq 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: QinqArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Qinq resources.
*/
export interface QinqState {
/**
* A local, VLAN-aware bridge that is already configured on each local node
*/
bridge?: pulumi.Input<string | undefined>;
/**
* 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>;
/**
* 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>;
/**
* Service VLAN tag for QinQ. The tag must be between `1` and `4094`.
*/
serviceVlan?: pulumi.Input<number | undefined>;
/**
* Service VLAN protocol for QinQ. The protocol must be `802.1ad` or `802.1q`.
*/
serviceVlanProtocol?: pulumi.Input<string | undefined>;
/**
* Indicates the current state of the zone.
*/
state?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Qinq resource.
*/
export interface QinqArgs {
/**
* A local, VLAN-aware bridge that is already configured on each local node
*/
bridge: pulumi.Input<string>;
/**
* 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>;
/**
* The unique identifier of the SDN zone.
*/
resourceId: pulumi.Input<string>;
/**
* Reverse DNS API server address.
*/
reverseDns?: pulumi.Input<string | undefined>;
/**
* Service VLAN tag for QinQ. The tag must be between `1` and `4094`.
*/
serviceVlan: pulumi.Input<number>;
/**
* Service VLAN protocol for QinQ. The protocol must be `802.1ad` or `802.1q`.
*/
serviceVlanProtocol?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=qinq.d.ts.map