Docs Packages
  1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Cluster
  5. Options
Proxmox Virtual Environment (Proxmox VE) v6.4.1 published on Sunday, Apr 21, 2024 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

proxmoxve.Cluster.Options

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v6.4.1 published on Sunday, Apr 21, 2024 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

    Manages Proxmox VE Cluster Datacenter options.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";

const options = new proxmoxve.cluster.Options("options", {
    bandwidthLimitDefault: 666666,
    bandwidthLimitMigration: 555555,
    emailFrom: "ged@gont.earthsea",
    keyboard: "pl",
    language: "en",
    maxWorkers: 5,
    migrationCidr: "10.0.0.0/8",
    migrationType: "secure",
});

    import pulumi
import pulumi_proxmoxve as proxmoxve

options = proxmoxve.cluster.Options("options",
    bandwidth_limit_default=666666,
    bandwidth_limit_migration=555555,
    email_from="ged@gont.earthsea",
    keyboard="pl",
    language="en",
    max_workers=5,
    migration_cidr="10.0.0.0/8",
    migration_type="secure")

    package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v6/go/proxmoxve/Cluster"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Cluster.NewOptions(ctx, "options", &Cluster.OptionsArgs{
			BandwidthLimitDefault:   pulumi.Int(666666),
			BandwidthLimitMigration: pulumi.Int(555555),
			EmailFrom:               pulumi.String("ged@gont.earthsea"),
			Keyboard:                pulumi.String("pl"),
			Language:                pulumi.String("en"),
			MaxWorkers:              pulumi.Int(5),
			MigrationCidr:           pulumi.String("10.0.0.0/8"),
			MigrationType:           pulumi.String("secure"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ProxmoxVE = Pulumi.ProxmoxVE;

return await Deployment.RunAsync(() => 
{
    var options = new ProxmoxVE.Cluster.Options("options", new()
    {
        BandwidthLimitDefault = 666666,
        BandwidthLimitMigration = 555555,
        EmailFrom = "ged@gont.earthsea",
        Keyboard = "pl",
        Language = "en",
        MaxWorkers = 5,
        MigrationCidr = "10.0.0.0/8",
        MigrationType = "secure",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.Cluster.Options;
import com.pulumi.proxmoxve.Cluster.OptionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var options = new Options("options", OptionsArgs.builder()        
            .bandwidthLimitDefault(666666)
            .bandwidthLimitMigration(555555)
            .emailFrom("ged@gont.earthsea")
            .keyboard("pl")
            .language("en")
            .maxWorkers(5)
            .migrationCidr("10.0.0.0/8")
            .migrationType("secure")
            .build());

    }
}

    resources:
  options:
    type: proxmoxve:Cluster:Options
    properties:
      bandwidthLimitDefault: 666666
      bandwidthLimitMigration: 555555
      emailFrom: ged@gont.earthsea
      keyboard: pl
      language: en
      maxWorkers: 5
      migrationCidr: 10.0.0.0/8
      migrationType: secure

    Create Options Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Options(name: string, args?: OptionsArgs, opts?: CustomResourceOptions);
    @overload
def Options(resource_name: str,
            args: Optional[OptionsArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Options(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            bandwidth_limit_clone: Optional[int] = None,
            bandwidth_limit_default: Optional[int] = None,
            bandwidth_limit_migration: Optional[int] = None,
            bandwidth_limit_move: Optional[int] = None,
            bandwidth_limit_restore: Optional[int] = None,
            console: Optional[str] = None,
            crs_ha: Optional[str] = None,
            crs_ha_rebalance_on_start: Optional[bool] = None,
            description: Optional[str] = None,
            email_from: Optional[str] = None,
            ha_shutdown_policy: Optional[str] = None,
            http_proxy: Optional[str] = None,
            keyboard: Optional[str] = None,
            language: Optional[str] = None,
            mac_prefix: Optional[str] = None,
            max_workers: Optional[int] = None,
            migration_cidr: Optional[str] = None,
            migration_type: Optional[str] = None)
    func NewOptions(ctx *Context, name string, args *OptionsArgs, opts ...ResourceOption) (*Options, error)
    public Options(string name, OptionsArgs? args = null, CustomResourceOptions? opts = null)
    public Options(String name, OptionsArgs args)
public Options(String name, OptionsArgs args, CustomResourceOptions options)

    type: proxmoxve:Cluster:Options
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OptionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OptionsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OptionsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OptionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OptionsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var optionsResource = new ProxmoxVE.Cluster.Options("optionsResource", new()
{
    BandwidthLimitClone = 0,
    BandwidthLimitDefault = 0,
    BandwidthLimitMigration = 0,
    BandwidthLimitMove = 0,
    BandwidthLimitRestore = 0,
    Console = "string",
    CrsHa = "string",
    CrsHaRebalanceOnStart = false,
    Description = "string",
    EmailFrom = "string",
    HaShutdownPolicy = "string",
    HttpProxy = "string",
    Keyboard = "string",
    Language = "string",
    MacPrefix = "string",
    MaxWorkers = 0,
    MigrationCidr = "string",
    MigrationType = "string",
});

    example, err := Cluster.NewOptions(ctx, "optionsResource", &Cluster.OptionsArgs{
	BandwidthLimitClone:     pulumi.Int(0),
	BandwidthLimitDefault:   pulumi.Int(0),
	BandwidthLimitMigration: pulumi.Int(0),
	BandwidthLimitMove:      pulumi.Int(0),
	BandwidthLimitRestore:   pulumi.Int(0),
	Console:                 pulumi.String("string"),
	CrsHa:                   pulumi.String("string"),
	CrsHaRebalanceOnStart:   pulumi.Bool(false),
	Description:             pulumi.String("string"),
	EmailFrom:               pulumi.String("string"),
	HaShutdownPolicy:        pulumi.String("string"),
	HttpProxy:               pulumi.String("string"),
	Keyboard:                pulumi.String("string"),
	Language:                pulumi.String("string"),
	MacPrefix:               pulumi.String("string"),
	MaxWorkers:              pulumi.Int(0),
	MigrationCidr:           pulumi.String("string"),
	MigrationType:           pulumi.String("string"),
})

    var optionsResource = new Options("optionsResource", OptionsArgs.builder()        
    .bandwidthLimitClone(0)
    .bandwidthLimitDefault(0)
    .bandwidthLimitMigration(0)
    .bandwidthLimitMove(0)
    .bandwidthLimitRestore(0)
    .console("string")
    .crsHa("string")
    .crsHaRebalanceOnStart(false)
    .description("string")
    .emailFrom("string")
    .haShutdownPolicy("string")
    .httpProxy("string")
    .keyboard("string")
    .language("string")
    .macPrefix("string")
    .maxWorkers(0)
    .migrationCidr("string")
    .migrationType("string")
    .build());

    options_resource = proxmoxve.cluster.Options("optionsResource",
    bandwidth_limit_clone=0,
    bandwidth_limit_default=0,
    bandwidth_limit_migration=0,
    bandwidth_limit_move=0,
    bandwidth_limit_restore=0,
    console="string",
    crs_ha="string",
    crs_ha_rebalance_on_start=False,
    description="string",
    email_from="string",
    ha_shutdown_policy="string",
    http_proxy="string",
    keyboard="string",
    language="string",
    mac_prefix="string",
    max_workers=0,
    migration_cidr="string",
    migration_type="string")

    const optionsResource = new proxmoxve.cluster.Options("optionsResource", {
    bandwidthLimitClone: 0,
    bandwidthLimitDefault: 0,
    bandwidthLimitMigration: 0,
    bandwidthLimitMove: 0,
    bandwidthLimitRestore: 0,
    console: "string",
    crsHa: "string",
    crsHaRebalanceOnStart: false,
    description: "string",
    emailFrom: "string",
    haShutdownPolicy: "string",
    httpProxy: "string",
    keyboard: "string",
    language: "string",
    macPrefix: "string",
    maxWorkers: 0,
    migrationCidr: "string",
    migrationType: "string",
});

    type: proxmoxve:Cluster:Options
properties:
    bandwidthLimitClone: 0
    bandwidthLimitDefault: 0
    bandwidthLimitMigration: 0
    bandwidthLimitMove: 0
    bandwidthLimitRestore: 0
    console: string
    crsHa: string
    crsHaRebalanceOnStart: false
    description: string
    emailFrom: string
    haShutdownPolicy: string
    httpProxy: string
    keyboard: string
    language: string
    macPrefix: string
    maxWorkers: 0
    migrationCidr: string
    migrationType: string

    Options Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Options resource accepts the following input properties:

    BandwidthLimitClone int
    Clone I/O bandwidth limit in KiB/s.
    BandwidthLimitDefault int
    Default I/O bandwidth limit in KiB/s.
    BandwidthLimitMigration int
    Migration I/O bandwidth limit in KiB/s.
    BandwidthLimitMove int
    Move I/O bandwidth limit in KiB/s.
    BandwidthLimitRestore int
    Restore I/O bandwidth limit in KiB/s.
    Console string
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    CrsHa string
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    CrsHaRebalanceOnStart bool
    Cluster resource scheduling setting for HA rebalance on start.
    Description string
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    EmailFrom string
    email address to send notification from (default is root@$hostname).
    HaShutdownPolicy string
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    HttpProxy string
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    Keyboard string
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    Language string
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    MacPrefix string
    Prefix for autogenerated MAC addresses.
    MaxWorkers int
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    MigrationCidr string
    Cluster wide migration network CIDR.
    MigrationType string
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    BandwidthLimitClone int
    Clone I/O bandwidth limit in KiB/s.
    BandwidthLimitDefault int
    Default I/O bandwidth limit in KiB/s.
    BandwidthLimitMigration int
    Migration I/O bandwidth limit in KiB/s.
    BandwidthLimitMove int
    Move I/O bandwidth limit in KiB/s.
    BandwidthLimitRestore int
    Restore I/O bandwidth limit in KiB/s.
    Console string
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    CrsHa string
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    CrsHaRebalanceOnStart bool
    Cluster resource scheduling setting for HA rebalance on start.
    Description string
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    EmailFrom string
    email address to send notification from (default is root@$hostname).
    HaShutdownPolicy string
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    HttpProxy string
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    Keyboard string
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    Language string
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    MacPrefix string
    Prefix for autogenerated MAC addresses.
    MaxWorkers int
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    MigrationCidr string
    Cluster wide migration network CIDR.
    MigrationType string
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    bandwidthLimitClone Integer
    Clone I/O bandwidth limit in KiB/s.
    bandwidthLimitDefault Integer
    Default I/O bandwidth limit in KiB/s.
    bandwidthLimitMigration Integer
    Migration I/O bandwidth limit in KiB/s.
    bandwidthLimitMove Integer
    Move I/O bandwidth limit in KiB/s.
    bandwidthLimitRestore Integer
    Restore I/O bandwidth limit in KiB/s.
    console String
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    crsHa String
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    crsHaRebalanceOnStart Boolean
    Cluster resource scheduling setting for HA rebalance on start.
    description String
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    emailFrom String
    email address to send notification from (default is root@$hostname).
    haShutdownPolicy String
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    httpProxy String
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    keyboard String
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    language String
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    macPrefix String
    Prefix for autogenerated MAC addresses.
    maxWorkers Integer
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    migrationCidr String
    Cluster wide migration network CIDR.
    migrationType String
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    bandwidthLimitClone number
    Clone I/O bandwidth limit in KiB/s.
    bandwidthLimitDefault number
    Default I/O bandwidth limit in KiB/s.
    bandwidthLimitMigration number
    Migration I/O bandwidth limit in KiB/s.
    bandwidthLimitMove number
    Move I/O bandwidth limit in KiB/s.
    bandwidthLimitRestore number
    Restore I/O bandwidth limit in KiB/s.
    console string
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    crsHa string
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    crsHaRebalanceOnStart boolean
    Cluster resource scheduling setting for HA rebalance on start.
    description string
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    emailFrom string
    email address to send notification from (default is root@$hostname).
    haShutdownPolicy string
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    httpProxy string
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    keyboard string
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    language string
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    macPrefix string
    Prefix for autogenerated MAC addresses.
    maxWorkers number
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    migrationCidr string
    Cluster wide migration network CIDR.
    migrationType string
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    bandwidth_limit_clone int
    Clone I/O bandwidth limit in KiB/s.
    bandwidth_limit_default int
    Default I/O bandwidth limit in KiB/s.
    bandwidth_limit_migration int
    Migration I/O bandwidth limit in KiB/s.
    bandwidth_limit_move int
    Move I/O bandwidth limit in KiB/s.
    bandwidth_limit_restore int
    Restore I/O bandwidth limit in KiB/s.
    console str
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    crs_ha str
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    crs_ha_rebalance_on_start bool
    Cluster resource scheduling setting for HA rebalance on start.
    description str
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    email_from str
    email address to send notification from (default is root@$hostname).
    ha_shutdown_policy str
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    http_proxy str
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    keyboard str
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    language str
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    mac_prefix str
    Prefix for autogenerated MAC addresses.
    max_workers int
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    migration_cidr str
    Cluster wide migration network CIDR.
    migration_type str
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    bandwidthLimitClone Number
    Clone I/O bandwidth limit in KiB/s.
    bandwidthLimitDefault Number
    Default I/O bandwidth limit in KiB/s.
    bandwidthLimitMigration Number
    Migration I/O bandwidth limit in KiB/s.
    bandwidthLimitMove Number
    Move I/O bandwidth limit in KiB/s.
    bandwidthLimitRestore Number
    Restore I/O bandwidth limit in KiB/s.
    console String
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    crsHa String
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    crsHaRebalanceOnStart Boolean
    Cluster resource scheduling setting for HA rebalance on start.
    description String
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    emailFrom String
    email address to send notification from (default is root@$hostname).
    haShutdownPolicy String
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    httpProxy String
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    keyboard String
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    language String
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    macPrefix String
    Prefix for autogenerated MAC addresses.
    maxWorkers Number
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    migrationCidr String
    Cluster wide migration network CIDR.
    migrationType String
    Cluster wide migration type. Must be secure | unsecure (default is secure).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Options resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Options Resource

    Get an existing Options resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OptionsState, opts?: CustomResourceOptions): Options
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bandwidth_limit_clone: Optional[int] = None,
        bandwidth_limit_default: Optional[int] = None,
        bandwidth_limit_migration: Optional[int] = None,
        bandwidth_limit_move: Optional[int] = None,
        bandwidth_limit_restore: Optional[int] = None,
        console: Optional[str] = None,
        crs_ha: Optional[str] = None,
        crs_ha_rebalance_on_start: Optional[bool] = None,
        description: Optional[str] = None,
        email_from: Optional[str] = None,
        ha_shutdown_policy: Optional[str] = None,
        http_proxy: Optional[str] = None,
        keyboard: Optional[str] = None,
        language: Optional[str] = None,
        mac_prefix: Optional[str] = None,
        max_workers: Optional[int] = None,
        migration_cidr: Optional[str] = None,
        migration_type: Optional[str] = None) -> Options
    func GetOptions(ctx *Context, name string, id IDInput, state *OptionsState, opts ...ResourceOption) (*Options, error)
    public static Options Get(string name, Input<string> id, OptionsState? state, CustomResourceOptions? opts = null)
    public static Options get(String name, Output<String> id, OptionsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BandwidthLimitClone int
    Clone I/O bandwidth limit in KiB/s.
    BandwidthLimitDefault int
    Default I/O bandwidth limit in KiB/s.
    BandwidthLimitMigration int
    Migration I/O bandwidth limit in KiB/s.
    BandwidthLimitMove int
    Move I/O bandwidth limit in KiB/s.
    BandwidthLimitRestore int
    Restore I/O bandwidth limit in KiB/s.
    Console string
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    CrsHa string
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    CrsHaRebalanceOnStart bool
    Cluster resource scheduling setting for HA rebalance on start.
    Description string
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    EmailFrom string
    email address to send notification from (default is root@$hostname).
    HaShutdownPolicy string
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    HttpProxy string
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    Keyboard string
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    Language string
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    MacPrefix string
    Prefix for autogenerated MAC addresses.
    MaxWorkers int
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    MigrationCidr string
    Cluster wide migration network CIDR.
    MigrationType string
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    BandwidthLimitClone int
    Clone I/O bandwidth limit in KiB/s.
    BandwidthLimitDefault int
    Default I/O bandwidth limit in KiB/s.
    BandwidthLimitMigration int
    Migration I/O bandwidth limit in KiB/s.
    BandwidthLimitMove int
    Move I/O bandwidth limit in KiB/s.
    BandwidthLimitRestore int
    Restore I/O bandwidth limit in KiB/s.
    Console string
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    CrsHa string
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    CrsHaRebalanceOnStart bool
    Cluster resource scheduling setting for HA rebalance on start.
    Description string
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    EmailFrom string
    email address to send notification from (default is root@$hostname).
    HaShutdownPolicy string
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    HttpProxy string
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    Keyboard string
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    Language string
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    MacPrefix string
    Prefix for autogenerated MAC addresses.
    MaxWorkers int
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    MigrationCidr string
    Cluster wide migration network CIDR.
    MigrationType string
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    bandwidthLimitClone Integer
    Clone I/O bandwidth limit in KiB/s.
    bandwidthLimitDefault Integer
    Default I/O bandwidth limit in KiB/s.
    bandwidthLimitMigration Integer
    Migration I/O bandwidth limit in KiB/s.
    bandwidthLimitMove Integer
    Move I/O bandwidth limit in KiB/s.
    bandwidthLimitRestore Integer
    Restore I/O bandwidth limit in KiB/s.
    console String
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    crsHa String
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    crsHaRebalanceOnStart Boolean
    Cluster resource scheduling setting for HA rebalance on start.
    description String
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    emailFrom String
    email address to send notification from (default is root@$hostname).
    haShutdownPolicy String
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    httpProxy String
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    keyboard String
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    language String
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    macPrefix String
    Prefix for autogenerated MAC addresses.
    maxWorkers Integer
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    migrationCidr String
    Cluster wide migration network CIDR.
    migrationType String
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    bandwidthLimitClone number
    Clone I/O bandwidth limit in KiB/s.
    bandwidthLimitDefault number
    Default I/O bandwidth limit in KiB/s.
    bandwidthLimitMigration number
    Migration I/O bandwidth limit in KiB/s.
    bandwidthLimitMove number
    Move I/O bandwidth limit in KiB/s.
    bandwidthLimitRestore number
    Restore I/O bandwidth limit in KiB/s.
    console string
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    crsHa string
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    crsHaRebalanceOnStart boolean
    Cluster resource scheduling setting for HA rebalance on start.
    description string
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    emailFrom string
    email address to send notification from (default is root@$hostname).
    haShutdownPolicy string
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    httpProxy string
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    keyboard string
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    language string
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    macPrefix string
    Prefix for autogenerated MAC addresses.
    maxWorkers number
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    migrationCidr string
    Cluster wide migration network CIDR.
    migrationType string
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    bandwidth_limit_clone int
    Clone I/O bandwidth limit in KiB/s.
    bandwidth_limit_default int
    Default I/O bandwidth limit in KiB/s.
    bandwidth_limit_migration int
    Migration I/O bandwidth limit in KiB/s.
    bandwidth_limit_move int
    Move I/O bandwidth limit in KiB/s.
    bandwidth_limit_restore int
    Restore I/O bandwidth limit in KiB/s.
    console str
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    crs_ha str
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    crs_ha_rebalance_on_start bool
    Cluster resource scheduling setting for HA rebalance on start.
    description str
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    email_from str
    email address to send notification from (default is root@$hostname).
    ha_shutdown_policy str
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    http_proxy str
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    keyboard str
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    language str
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    mac_prefix str
    Prefix for autogenerated MAC addresses.
    max_workers int
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    migration_cidr str
    Cluster wide migration network CIDR.
    migration_type str
    Cluster wide migration type. Must be secure | unsecure (default is secure).
    bandwidthLimitClone Number
    Clone I/O bandwidth limit in KiB/s.
    bandwidthLimitDefault Number
    Default I/O bandwidth limit in KiB/s.
    bandwidthLimitMigration Number
    Migration I/O bandwidth limit in KiB/s.
    bandwidthLimitMove Number
    Move I/O bandwidth limit in KiB/s.
    bandwidthLimitRestore Number
    Restore I/O bandwidth limit in KiB/s.
    console String
    Select the default Console viewer. Must be applet | vv| html5 | xtermjs. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer compatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
    crsHa String
    Cluster resource scheduling setting for HA. Must be static | basic (default is basic).
    crsHaRebalanceOnStart Boolean
    Cluster resource scheduling setting for HA rebalance on start.
    description String
    Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    emailFrom String
    email address to send notification from (default is root@$hostname).
    haShutdownPolicy String
    Cluster wide HA shutdown policy (). Must be freeze | failover | migrate | conditional (default is conditional).
    httpProxy String
    Specify external http proxy which is used for downloads (example: http://username:password@host:port/).
    keyboard String
    Default keyboard layout for vnc server. Must be de | de-ch | da | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sv | sl | tr.
    language String
    Default GUI language. Must be ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW.
    macPrefix String
    Prefix for autogenerated MAC addresses.
    maxWorkers Number
    Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
    migrationCidr String
    Cluster wide migration network CIDR.
    migrationType String
    Cluster wide migration type. Must be secure | unsecure (default is secure).

    Import

    #!/usr/bin/env sh

    Cluster options are global and can be imported using e.g.:

    $ pulumi import proxmoxve:Cluster/options:Options options cluster

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Proxmox Virtual Environment (Proxmox VE) v6.4.1 published on Sunday, Apr 21, 2024 by Daniel Muehlbachler-Pietrzykowski
    muhlba91/pulumi-proxmoxve