Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Cluster
  5. Options
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

proxmoxve.Cluster.Options

Explore with Pulumi AI

Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

Manages Proxmox VE Cluster Datacenter options.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

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 com.pulumi.proxmoxve.Cluster.inputs.OptionsNextIdArgs;
import com.pulumi.proxmoxve.Cluster.inputs.OptionsNotifyArgs;
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")
            .nextId(OptionsNextIdArgs.builder()
                .lower(100)
                .upper(999999999)
                .build())
            .notify(OptionsNotifyArgs.builder()
                .ha_fencing_mode("never")
                .ha_fencing_target("default-matcher")
                .package_replication("always")
                .package_replication_target("default-matcher")
                .package_updates("always")
                .package_updates_target("default-matcher")
                .build())
            .build());

    }
}
Copy
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
      nextId:
        lower: 100
        upper: 9.99999999e+08
      notify:
        ha_fencing_mode: never
        ha_fencing_target: default-matcher
        package_replication: always
        package_replication_target: default-matcher
        package_updates: always
        package_updates_target: default-matcher
Copy

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,
            next_id: Optional[_cluster.OptionsNextIdArgs] = None,
            notify: Optional[_cluster.OptionsNotifyArgs] = 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. OptionsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor 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",
    NextId = new ProxmoxVE.Cluster.Inputs.OptionsNextIdArgs
    {
        Lower = 0,
        Upper = 0,
    },
    Notify = new ProxmoxVE.Cluster.Inputs.OptionsNotifyArgs
    {
        HaFencingMode = "string",
        HaFencingTarget = "string",
        PackageUpdates = "string",
        PackageUpdatesTarget = "string",
        Replication = "string",
        ReplicationTarget = "string",
    },
});
Copy
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"),
	NextId: &cluster.OptionsNextIdArgs{
		Lower: pulumi.Int(0),
		Upper: pulumi.Int(0),
	},
	Notify: &cluster.OptionsNotifyArgs{
		HaFencingMode:        pulumi.String("string"),
		HaFencingTarget:      pulumi.String("string"),
		PackageUpdates:       pulumi.String("string"),
		PackageUpdatesTarget: pulumi.String("string"),
		Replication:          pulumi.String("string"),
		ReplicationTarget:    pulumi.String("string"),
	},
})
Copy
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")
    .nextId(OptionsNextIdArgs.builder()
        .lower(0)
        .upper(0)
        .build())
    .notify(OptionsNotifyArgs.builder()
        .haFencingMode("string")
        .haFencingTarget("string")
        .packageUpdates("string")
        .packageUpdatesTarget("string")
        .replication("string")
        .replicationTarget("string")
        .build())
    .build());
Copy
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",
    next_id={
        "lower": 0,
        "upper": 0,
    },
    notify={
        "ha_fencing_mode": "string",
        "ha_fencing_target": "string",
        "package_updates": "string",
        "package_updates_target": "string",
        "replication": "string",
        "replication_target": "string",
    })
Copy
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",
    nextId: {
        lower: 0,
        upper: 0,
    },
    notify: {
        haFencingMode: "string",
        haFencingTarget: "string",
        packageUpdates: "string",
        packageUpdatesTarget: "string",
        replication: "string",
        replicationTarget: "string",
    },
});
Copy
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
    nextId:
        lower: 0
        upper: 0
    notify:
        haFencingMode: string
        haFencingTarget: string
        packageUpdates: string
        packageUpdatesTarget: string
        replication: string
        replicationTarget: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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 | insecure (default is secure).
NextId Pulumi.ProxmoxVE.Cluster.Inputs.OptionsNextId
The ranges for the next free VM ID auto-selection pool.
Notify Pulumi.ProxmoxVE.Cluster.Inputs.OptionsNotify
Cluster-wide notification settings.
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 | insecure (default is secure).
NextId OptionsNextIdArgs
The ranges for the next free VM ID auto-selection pool.
Notify OptionsNotifyArgs
Cluster-wide notification settings.
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 | insecure (default is secure).
nextId OptionsNextId
The ranges for the next free VM ID auto-selection pool.
notify_ OptionsNotify
Cluster-wide notification settings.
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 | insecure (default is secure).
nextId OptionsNextId
The ranges for the next free VM ID auto-selection pool.
notify OptionsNotify
Cluster-wide notification settings.
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 | insecure (default is secure).
next_id cluster.OptionsNextIdArgs
The ranges for the next free VM ID auto-selection pool.
notify cluster.OptionsNotifyArgs
Cluster-wide notification settings.
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 | insecure (default is secure).
nextId Property Map
The ranges for the next free VM ID auto-selection pool.
notify Property Map
Cluster-wide notification settings.

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,
        next_id: Optional[_cluster.OptionsNextIdArgs] = None,
        notify: Optional[_cluster.OptionsNotifyArgs] = 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)
resources:  _:    type: proxmoxve:Cluster:Options    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 | insecure (default is secure).
NextId Pulumi.ProxmoxVE.Cluster.Inputs.OptionsNextId
The ranges for the next free VM ID auto-selection pool.
Notify Pulumi.ProxmoxVE.Cluster.Inputs.OptionsNotify
Cluster-wide notification settings.
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 | insecure (default is secure).
NextId OptionsNextIdArgs
The ranges for the next free VM ID auto-selection pool.
Notify OptionsNotifyArgs
Cluster-wide notification settings.
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 | insecure (default is secure).
nextId OptionsNextId
The ranges for the next free VM ID auto-selection pool.
notify_ OptionsNotify
Cluster-wide notification settings.
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 | insecure (default is secure).
nextId OptionsNextId
The ranges for the next free VM ID auto-selection pool.
notify OptionsNotify
Cluster-wide notification settings.
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 | insecure (default is secure).
next_id cluster.OptionsNextIdArgs
The ranges for the next free VM ID auto-selection pool.
notify cluster.OptionsNotifyArgs
Cluster-wide notification settings.
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 | insecure (default is secure).
nextId Property Map
The ranges for the next free VM ID auto-selection pool.
notify Property Map
Cluster-wide notification settings.

Supporting Types

OptionsNextId
, OptionsNextIdArgs

Lower int
The minimum number for the next free VM ID. Must be higher or equal to 100
Upper int
The maximum number for the next free VM ID. Must be less or equal to 999999999
Lower int
The minimum number for the next free VM ID. Must be higher or equal to 100
Upper int
The maximum number for the next free VM ID. Must be less or equal to 999999999
lower Integer
The minimum number for the next free VM ID. Must be higher or equal to 100
upper Integer
The maximum number for the next free VM ID. Must be less or equal to 999999999
lower number
The minimum number for the next free VM ID. Must be higher or equal to 100
upper number
The maximum number for the next free VM ID. Must be less or equal to 999999999
lower int
The minimum number for the next free VM ID. Must be higher or equal to 100
upper int
The maximum number for the next free VM ID. Must be less or equal to 999999999
lower Number
The minimum number for the next free VM ID. Must be higher or equal to 100
upper Number
The maximum number for the next free VM ID. Must be less or equal to 999999999

OptionsNotify
, OptionsNotifyArgs

HaFencingMode string
Cluster-wide notification settings for the HA fencing mode. Must be always | never.
HaFencingTarget string
Cluster-wide notification settings for the HA fencing target.
PackageUpdates string
Cluster-wide notification settings for package updates. Must be auto | always | never.
PackageUpdatesTarget string
Cluster-wide notification settings for the package updates target.
Replication string
Cluster-wide notification settings for replication. Must be always | never.
ReplicationTarget string
Cluster-wide notification settings for the replication target.
HaFencingMode string
Cluster-wide notification settings for the HA fencing mode. Must be always | never.
HaFencingTarget string
Cluster-wide notification settings for the HA fencing target.
PackageUpdates string
Cluster-wide notification settings for package updates. Must be auto | always | never.
PackageUpdatesTarget string
Cluster-wide notification settings for the package updates target.
Replication string
Cluster-wide notification settings for replication. Must be always | never.
ReplicationTarget string
Cluster-wide notification settings for the replication target.
haFencingMode String
Cluster-wide notification settings for the HA fencing mode. Must be always | never.
haFencingTarget String
Cluster-wide notification settings for the HA fencing target.
packageUpdates String
Cluster-wide notification settings for package updates. Must be auto | always | never.
packageUpdatesTarget String
Cluster-wide notification settings for the package updates target.
replication String
Cluster-wide notification settings for replication. Must be always | never.
replicationTarget String
Cluster-wide notification settings for the replication target.
haFencingMode string
Cluster-wide notification settings for the HA fencing mode. Must be always | never.
haFencingTarget string
Cluster-wide notification settings for the HA fencing target.
packageUpdates string
Cluster-wide notification settings for package updates. Must be auto | always | never.
packageUpdatesTarget string
Cluster-wide notification settings for the package updates target.
replication string
Cluster-wide notification settings for replication. Must be always | never.
replicationTarget string
Cluster-wide notification settings for the replication target.
ha_fencing_mode str
Cluster-wide notification settings for the HA fencing mode. Must be always | never.
ha_fencing_target str
Cluster-wide notification settings for the HA fencing target.
package_updates str
Cluster-wide notification settings for package updates. Must be auto | always | never.
package_updates_target str
Cluster-wide notification settings for the package updates target.
replication str
Cluster-wide notification settings for replication. Must be always | never.
replication_target str
Cluster-wide notification settings for the replication target.
haFencingMode String
Cluster-wide notification settings for the HA fencing mode. Must be always | never.
haFencingTarget String
Cluster-wide notification settings for the HA fencing target.
packageUpdates String
Cluster-wide notification settings for package updates. Must be auto | always | never.
packageUpdatesTarget String
Cluster-wide notification settings for the package updates target.
replication String
Cluster-wide notification settings for replication. Must be always | never.
replicationTarget String
Cluster-wide notification settings for the replication target.

Import

#!/usr/bin/env sh

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

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

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.
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve