clientapi_pve/models/
nodes_vzdump_defaults_response_data.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 NodesVzdumpDefaultsResponseData {
16
17    /// Backup all known guest systems on this host.
18    #[serde(rename = "all", skip_serializing_if = "Option::is_none")]
19    pub all: Option<models::PveBoolean>,
20
21    /// Limit I/O bandwidth (in KiB/s).
22    #[serde(rename = "bwlimit", skip_serializing_if = "Option::is_none")]
23    pub bwlimit: Option<i64>,
24
25    /// Compress dump file.
26    #[serde(rename = "compress", skip_serializing_if = "Option::is_none")]
27    pub compress: Option<models::PveCompressEnum>,
28
29    /// Store resulting files to specified directory.
30    #[serde(rename = "dumpdir", skip_serializing_if = "Option::is_none")]
31    pub dumpdir: Option<String>,
32
33    /// Exclude specified guest systems (assumes --all)
34    #[serde(rename = "exclude", skip_serializing_if = "Option::is_none")]
35    pub exclude: Option<String>,
36
37    /// Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
38    #[serde(rename = "exclude-path", skip_serializing_if = "Option::is_none")]
39    pub exclude_path: Option<Vec<String>>,
40
41    /// Options for backup fleecing (VM only).
42    #[serde(rename = "fleecing", skip_serializing_if = "Option::is_none")]
43    pub fleecing: Option<String>,
44
45    /// Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.
46    #[serde(rename = "ionice", skip_serializing_if = "Option::is_none")]
47    pub ionice: Option<i32>,
48
49    /// Maximal time to wait for the global lock (minutes).
50    #[serde(rename = "lockwait", skip_serializing_if = "Option::is_none")]
51    pub lockwait: Option<i64>,
52
53    /// Deprecated: use notification targets/matchers instead. Specify when to send a notification mail
54    #[serde(rename = "mailnotification", skip_serializing_if = "Option::is_none")]
55    pub mailnotification: Option<models::PveMailnotificationEnum>,
56
57    /// Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.
58    #[serde(rename = "mailto", skip_serializing_if = "Option::is_none")]
59    pub mailto: Option<String>,
60
61    /// Backup mode.
62    #[serde(rename = "mode", skip_serializing_if = "Option::is_none")]
63    pub mode: Option<models::PveClusterBackupModeEnum>,
64
65    /// Only run if executed on this node.
66    #[serde(rename = "node", skip_serializing_if = "Option::is_none")]
67    pub node: Option<String>,
68
69    /// Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\\n' and '\\\\' respectively.
70    #[serde(rename = "notes-template", skip_serializing_if = "Option::is_none")]
71    pub notes_template: Option<String>,
72
73    /// Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
74    #[serde(rename = "notification-mode", skip_serializing_if = "Option::is_none")]
75    pub notification_mode: Option<models::PveNotificationModeEnum>,
76
77    /// PBS mode used to detect file changes and switch encoding format for container backups.
78    #[serde(rename = "pbs-change-detection-mode", skip_serializing_if = "Option::is_none")]
79    pub pbs_change_detection_mode: Option<models::PvePbsChangeDetectionModeEnum>,
80
81    /// Other performance-related settings.
82    #[serde(rename = "performance", skip_serializing_if = "Option::is_none")]
83    pub performance: Option<String>,
84
85    /// Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
86    #[serde(rename = "pigz", skip_serializing_if = "Option::is_none")]
87    pub pigz: Option<i64>,
88
89    /// Backup all known guest systems included in the specified pool.
90    #[serde(rename = "pool", skip_serializing_if = "Option::is_none")]
91    pub pool: Option<String>,
92
93    /// If true, mark backup(s) as protected.
94    #[serde(rename = "protected", skip_serializing_if = "Option::is_none")]
95    pub protected: Option<models::PveBoolean>,
96
97    /// Use these retention options instead of those from the storage configuration.
98    #[serde(rename = "prune-backups", skip_serializing_if = "Option::is_none")]
99    pub prune_backups: Option<String>,
100
101    /// Be quiet.
102    #[serde(rename = "quiet", skip_serializing_if = "Option::is_none")]
103    pub quiet: Option<models::PveBoolean>,
104
105    /// Prune older backups according to 'prune-backups'.
106    #[serde(rename = "remove", skip_serializing_if = "Option::is_none")]
107    pub remove: Option<models::PveBoolean>,
108
109    /// Use specified hook script.
110    #[serde(rename = "script", skip_serializing_if = "Option::is_none")]
111    pub script: Option<String>,
112
113    /// Exclude temporary files and logs.
114    #[serde(rename = "stdexcludes", skip_serializing_if = "Option::is_none")]
115    pub stdexcludes: Option<models::PveBoolean>,
116
117    /// Stop running backup jobs on this host.
118    #[serde(rename = "stop", skip_serializing_if = "Option::is_none")]
119    pub stop: Option<models::PveBoolean>,
120
121    /// Maximal time to wait until a guest system is stopped (minutes).
122    #[serde(rename = "stopwait", skip_serializing_if = "Option::is_none")]
123    pub stopwait: Option<i64>,
124
125    /// Store resulting file to this storage.
126    #[serde(rename = "storage", skip_serializing_if = "Option::is_none")]
127    pub storage: Option<String>,
128
129    /// Store temporary files to specified directory.
130    #[serde(rename = "tmpdir", skip_serializing_if = "Option::is_none")]
131    pub tmpdir: Option<String>,
132
133    /// The ID of the guest system you want to backup.
134    #[serde(rename = "vmid", skip_serializing_if = "Option::is_none")]
135    pub vmid: Option<String>,
136
137    /// Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count.
138    #[serde(rename = "zstd", skip_serializing_if = "Option::is_none")]
139    pub zstd: Option<i64>,
140
141
142}
143
144impl NodesVzdumpDefaultsResponseData {
145    pub fn new() -> NodesVzdumpDefaultsResponseData {
146        NodesVzdumpDefaultsResponseData {
147            
148            all: None,
149            
150            bwlimit: None,
151            
152            compress: None,
153            
154            dumpdir: None,
155            
156            exclude: None,
157            
158            exclude_path: None,
159            
160            fleecing: None,
161            
162            ionice: None,
163            
164            lockwait: None,
165            
166            mailnotification: None,
167            
168            mailto: None,
169            
170            mode: None,
171            
172            node: None,
173            
174            notes_template: None,
175            
176            notification_mode: None,
177            
178            pbs_change_detection_mode: None,
179            
180            performance: None,
181            
182            pigz: None,
183            
184            pool: None,
185            
186            protected: None,
187            
188            prune_backups: None,
189            
190            quiet: None,
191            
192            remove: None,
193            
194            script: None,
195            
196            stdexcludes: None,
197            
198            stop: None,
199            
200            stopwait: None,
201            
202            storage: None,
203            
204            tmpdir: None,
205            
206            vmid: None,
207            
208            zstd: None,
209            
210        }
211    }
212}
213
214
clientapi_pve/models/nodes_vzdump_defaults_response_data.rs

clientapi_pve/models/
nodes_vzdump_defaults_response_data.rs
