clientapi-pve 2026.5.24

Generated from apidoc.js. NOT an official Proxmox specification. See https://pve.proxmox.com/pve-docs/api-viewer/ for the upstream documentation.
Documentation
/*
 * Proxmox Virtual Environment API
 *
 * Generated from apidoc.js. NOT an official Proxmox specification. See https://pve.proxmox.com/pve-docs/api-viewer/ for the upstream documentation.
 *
 * The version of the OpenAPI document: 9.x
 * 
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct ClusterOptionsSetOptionsRequest {

    /// Set I/O bandwidth limit for various operations (in KiB/s).
    #[serde(rename = "bwlimit", skip_serializing_if = "Option::is_none")]
    pub bwlimit: Option<Box<models::PveBwlimitField>>,

    /// Consent text that is displayed before logging in.
    #[serde(rename = "consent-text", skip_serializing_if = "Option::is_none")]
    pub consent_text: Option<String>,

    /// Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible 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.
    #[serde(rename = "console", skip_serializing_if = "Option::is_none")]
    pub console: Option<models::PveConsoleEnum>,

    /// Cluster resource scheduling settings.
    #[serde(rename = "crs", skip_serializing_if = "Option::is_none")]
    pub crs: Option<Box<models::PveCrsField>>,

    /// A list of settings you want to delete.
    #[serde(rename = "delete", skip_serializing_if = "Option::is_none")]
    pub delete: Option<String>,

    /// Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Specify email address to send notification from (default is root@$hostname)
    #[serde(rename = "email_from", skip_serializing_if = "Option::is_none")]
    pub email_from: Option<String>,

    /// Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.  WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP
    #[serde(rename = "fencing", skip_serializing_if = "Option::is_none")]
    pub fencing: Option<models::PveClusterOptionsFencingEnum>,

    /// Cluster wide HA settings.
    #[serde(rename = "ha", skip_serializing_if = "Option::is_none")]
    pub ha: Option<Box<models::PveHaField>>,

    /// Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
    #[serde(rename = "http_proxy", skip_serializing_if = "Option::is_none")]
    pub http_proxy: Option<String>,

    /// Default keybord layout for vnc server.
    #[serde(rename = "keyboard", skip_serializing_if = "Option::is_none")]
    pub keyboard: Option<models::PveKeyboardEnum>,

    /// Default GUI language.
    #[serde(rename = "language", skip_serializing_if = "Option::is_none")]
    pub language: Option<models::PveClusterOptionsLanguageEnum>,

    /// The location of the cluster.
    #[serde(rename = "location", skip_serializing_if = "Option::is_none")]
    pub location: Option<Box<models::PveLocationField>>,

    /// Prefix for the auto-generated MAC addresses of virtual guests. The default `BC:24:11` is the Organizationally Unique Identifier (OUI) assigned by the IEEE to Proxmox Server Solutions GmbH for a MAC Address Block Large (MA-L). You're allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or NAT/Masquerading).   Note that when you run multiple cluster that (partially) share the networks of their virtual guests, it's highly recommended that you extend the default MAC prefix, or generate a custom (valid) one, to reduce the chance of MAC collisions. For example, add a separate extra hexadecimal to the Proxmox OUI for each cluster, like `BC:24:11:0` for the first, `BC:24:11:1` for the second, and so on.  Alternatively, you can also separate the networks of the guests logically, e.g., by using VLANs.  For publicly accessible guests it's recommended that you get your own https://standards.ieee.org/products-programs/regauth/[OUI from the IEEE] registered or coordinate with your, or your hosting providers, network admins.
    #[serde(rename = "mac_prefix", skip_serializing_if = "Option::is_none")]
    pub mac_prefix: Option<String>,

    /// Defines how many workers (per node) are maximal started  on actions like 'stopall VMs' or task from the ha-manager.
    #[serde(rename = "max_workers", skip_serializing_if = "Option::is_none")]
    pub max_workers: Option<i64>,

    /// For cluster wide migration settings.
    #[serde(rename = "migration", skip_serializing_if = "Option::is_none")]
    pub migration: Option<Box<models::PveMigrationField>>,

    /// Control the range for the free VMID auto-selection pool.
    #[serde(rename = "next-id", skip_serializing_if = "Option::is_none")]
    pub next_id: Option<Box<models::PveNextIdField>>,

    /// Cluster-wide notification settings.
    #[serde(rename = "notify", skip_serializing_if = "Option::is_none")]
    pub notify: Option<Box<models::PveNotifyField>>,

    /// A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`.
    #[serde(rename = "registered-tags", skip_serializing_if = "Option::is_none")]
    pub registered_tags: Option<String>,

    /// For cluster wide replication settings.
    #[serde(rename = "replication", skip_serializing_if = "Option::is_none")]
    pub replication: Option<Box<models::PveReplicationField>>,

    /// Tag style options.
    #[serde(rename = "tag-style", skip_serializing_if = "Option::is_none")]
    pub tag_style: Option<Box<models::PveTagStyleField>>,

    /// u2f
    #[serde(rename = "u2f", skip_serializing_if = "Option::is_none")]
    pub u2f: Option<Box<models::PveU2fField>>,

    /// Privilege options for user-settable tags
    #[serde(rename = "user-tag-access", skip_serializing_if = "Option::is_none")]
    pub user_tag_access: Option<Box<models::PveUserTagAccessField>>,

    /// webauthn configuration
    #[serde(rename = "webauthn", skip_serializing_if = "Option::is_none")]
    pub webauthn: Option<Box<models::PveWebauthnField>>,


}

impl ClusterOptionsSetOptionsRequest {
    pub fn new() -> ClusterOptionsSetOptionsRequest {
        ClusterOptionsSetOptionsRequest {
            
            bwlimit: None,
            
            consent_text: None,
            
            console: None,
            
            crs: None,
            
            delete: None,
            
            description: None,
            
            email_from: None,
            
            fencing: None,
            
            ha: None,
            
            http_proxy: None,
            
            keyboard: None,
            
            language: None,
            
            location: None,
            
            mac_prefix: None,
            
            max_workers: None,
            
            migration: None,
            
            next_id: None,
            
            notify: None,
            
            registered_tags: None,
            
            replication: None,
            
            tag_style: None,
            
            u2f: None,
            
            user_tag_access: None,
            
            webauthn: None,
            
        }
    }
}