Skip to main content

clientapi_pve/models/
cluster_options_set_options_request.rs

1/*
2 * Proxmox Virtual Environment API
3 *
4 * Generated from apidoc.js. NOT an official Proxmox specification. See https://pve.proxmox.com/pve-docs/api-viewer/ for the upstream documentation.
5 *
6 * The version of the OpenAPI document: 9.x
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct ClusterOptionsSetOptionsRequest {
16
17    /// Set I/O bandwidth limit for various operations (in KiB/s).
18    #[serde(rename = "bwlimit", skip_serializing_if = "Option::is_none")]
19    pub bwlimit: Option<Box<models::PveBwlimitField>>,
20
21    /// Consent text that is displayed before logging in.
22    #[serde(rename = "consent-text", skip_serializing_if = "Option::is_none")]
23    pub consent_text: Option<String>,
24
25    /// 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.
26    #[serde(rename = "console", skip_serializing_if = "Option::is_none")]
27    pub console: Option<models::PveConsoleEnum>,
28
29    /// Cluster resource scheduling settings.
30    #[serde(rename = "crs", skip_serializing_if = "Option::is_none")]
31    pub crs: Option<Box<models::PveCrsField>>,
32
33    /// A list of settings you want to delete.
34    #[serde(rename = "delete", skip_serializing_if = "Option::is_none")]
35    pub delete: Option<String>,
36
37    /// Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
38    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
39    pub description: Option<String>,
40
41    /// Specify email address to send notification from (default is root@$hostname)
42    #[serde(rename = "email_from", skip_serializing_if = "Option::is_none")]
43    pub email_from: Option<String>,
44
45    /// 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
46    #[serde(rename = "fencing", skip_serializing_if = "Option::is_none")]
47    pub fencing: Option<models::PveClusterOptionsFencingEnum>,
48
49    /// Cluster wide HA settings.
50    #[serde(rename = "ha", skip_serializing_if = "Option::is_none")]
51    pub ha: Option<Box<models::PveHaField>>,
52
53    /// Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
54    #[serde(rename = "http_proxy", skip_serializing_if = "Option::is_none")]
55    pub http_proxy: Option<String>,
56
57    /// Default keybord layout for vnc server.
58    #[serde(rename = "keyboard", skip_serializing_if = "Option::is_none")]
59    pub keyboard: Option<models::PveKeyboardEnum>,
60
61    /// Default GUI language.
62    #[serde(rename = "language", skip_serializing_if = "Option::is_none")]
63    pub language: Option<models::PveClusterOptionsLanguageEnum>,
64
65    /// The location of the cluster.
66    #[serde(rename = "location", skip_serializing_if = "Option::is_none")]
67    pub location: Option<Box<models::PveLocationField>>,
68
69    /// 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.
70    #[serde(rename = "mac_prefix", skip_serializing_if = "Option::is_none")]
71    pub mac_prefix: Option<String>,
72
73    /// Defines how many workers (per node) are maximal started  on actions like 'stopall VMs' or task from the ha-manager.
74    #[serde(rename = "max_workers", skip_serializing_if = "Option::is_none")]
75    pub max_workers: Option<i64>,
76
77    /// For cluster wide migration settings.
78    #[serde(rename = "migration", skip_serializing_if = "Option::is_none")]
79    pub migration: Option<Box<models::PveMigrationField>>,
80
81    /// Control the range for the free VMID auto-selection pool.
82    #[serde(rename = "next-id", skip_serializing_if = "Option::is_none")]
83    pub next_id: Option<Box<models::PveNextIdField>>,
84
85    /// Cluster-wide notification settings.
86    #[serde(rename = "notify", skip_serializing_if = "Option::is_none")]
87    pub notify: Option<Box<models::PveNotifyField>>,
88
89    /// 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`.
90    #[serde(rename = "registered-tags", skip_serializing_if = "Option::is_none")]
91    pub registered_tags: Option<String>,
92
93    /// For cluster wide replication settings.
94    #[serde(rename = "replication", skip_serializing_if = "Option::is_none")]
95    pub replication: Option<Box<models::PveReplicationField>>,
96
97    /// Tag style options.
98    #[serde(rename = "tag-style", skip_serializing_if = "Option::is_none")]
99    pub tag_style: Option<Box<models::PveTagStyleField>>,
100
101    /// u2f
102    #[serde(rename = "u2f", skip_serializing_if = "Option::is_none")]
103    pub u2f: Option<Box<models::PveU2fField>>,
104
105    /// Privilege options for user-settable tags
106    #[serde(rename = "user-tag-access", skip_serializing_if = "Option::is_none")]
107    pub user_tag_access: Option<Box<models::PveUserTagAccessField>>,
108
109    /// webauthn configuration
110    #[serde(rename = "webauthn", skip_serializing_if = "Option::is_none")]
111    pub webauthn: Option<Box<models::PveWebauthnField>>,
112
113
114}
115
116impl ClusterOptionsSetOptionsRequest {
117    pub fn new() -> ClusterOptionsSetOptionsRequest {
118        ClusterOptionsSetOptionsRequest {
119            
120            bwlimit: None,
121            
122            consent_text: None,
123            
124            console: None,
125            
126            crs: None,
127            
128            delete: None,
129            
130            description: None,
131            
132            email_from: None,
133            
134            fencing: None,
135            
136            ha: None,
137            
138            http_proxy: None,
139            
140            keyboard: None,
141            
142            language: None,
143            
144            location: None,
145            
146            mac_prefix: None,
147            
148            max_workers: None,
149            
150            migration: None,
151            
152            next_id: None,
153            
154            notify: None,
155            
156            registered_tags: None,
157            
158            replication: None,
159            
160            tag_style: None,
161            
162            u2f: None,
163            
164            user_tag_access: None,
165            
166            webauthn: None,
167            
168        }
169    }
170}
171
172