Struct PostParams

Source
pub struct PostParams {
Show 40 fields pub all: Option<bool>, pub bwlimit: Option<u64>, pub comment: Option<String>, pub compress: Option<Compress>, pub dow: Option<String>, pub dumpdir: Option<String>, pub enabled: Option<()>, pub exclude: Option<String>, pub exclude_path: Vec<String>, pub id: Option<String>, pub ionice: Option<u64>, pub lockwait: Option<u64>, pub mailnotification: Option<Mailnotification>, pub mailto: Option<String>, pub maxfiles: Option<u64>, pub mode: Option<Mode>, pub node: Option<String>, pub notes_template: Option<String>, pub notification_mode: Option<NotificationMode>, pub notification_policy: Option<NotificationPolicy>, pub notification_target: Option<String>, pub performance: Option<String>, pub pigz: Option<u64>, pub pool: Option<String>, pub protected: Option<bool>, pub prune_backups: Option<String>, pub quiet: Option<bool>, pub remove: Option<bool>, pub repeat_missed: Option<bool>, pub schedule: Option<String>, pub script: Option<String>, pub starttime: Option<String>, pub stdexcludes: Option<bool>, pub stop: Option<bool>, pub stopwait: Option<u64>, pub storage: Option<String>, pub tmpdir: Option<String>, pub vmid: Option<String>, pub zstd: Option<u64>, pub additional_properties: HashMap<String, Value>,
}

Fields§

§all: Option<bool>

Backup all known guest systems on this host.

§bwlimit: Option<u64>

Limit I/O bandwidth (in KiB/s).

§comment: Option<String>

Description for the Job.

§compress: Option<Compress>

Compress dump file.

§dow: Option<String>

Day of week selection.

§dumpdir: Option<String>

Store resulting files to specified directory.

§enabled: Option<()>

Enable or disable the job.

§exclude: Option<String>

Exclude specified guest systems (assumes –all)

§exclude_path: Vec<String>

Exclude certain files/directories (shell globs). Paths starting with ‘/’ are anchored to the container’s root, other paths match relative to each subdirectory.

§id: Option<String>

Job ID (will be autogenerated).

§ionice: Option<u64>

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.

§lockwait: Option<u64>

Maximal time to wait for the global lock (minutes).

§mailnotification: Option<Mailnotification>

Deprecated: use notification targets/matchers instead. Specify when to send a notification mail

§mailto: Option<String>

Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.

§maxfiles: Option<u64>

Deprecated: use ‘prune-backups’ instead. Maximal number of backup files per guest system.

§mode: Option<Mode>

Backup mode.

§node: Option<String>

Only run if executed on this node.

§notes_template: Option<String>

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.

§notification_mode: Option<NotificationMode>

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.

§notification_policy: Option<NotificationPolicy>

Deprecated: Do not use

§notification_target: Option<String>

Deprecated: Do not use

§performance: Option<String>

Other performance-related settings.

§pigz: Option<u64>

Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.

§pool: Option<String>

Backup all known guest systems included in the specified pool.

§protected: Option<bool>

If true, mark backup(s) as protected.

§prune_backups: Option<String>

Use these retention options instead of those from the storage configuration.

§quiet: Option<bool>

Be quiet.

§remove: Option<bool>

Prune older backups according to ‘prune-backups’.

§repeat_missed: Option<bool>

If true, the job will be run as soon as possible if it was missed while the scheduler was not running.

§schedule: Option<String>

Backup schedule. The format is a subset of systemd calendar events.

§script: Option<String>

Use specified hook script.

§starttime: Option<String>

Job Start time.

§stdexcludes: Option<bool>

Exclude temporary files and logs.

§stop: Option<bool>

Stop running backup jobs on this host.

§stopwait: Option<u64>

Maximal time to wait until a guest system is stopped (minutes).

§storage: Option<String>

Store resulting file to this storage.

§tmpdir: Option<String>

Store temporary files to specified directory.

§vmid: Option<String>

The ID of the guest system you want to backup.

§zstd: Option<u64>

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.

§additional_properties: HashMap<String, Value>

Trait Implementations§

Source§

impl Clone for PostParams

Source§

fn clone(&self) -> PostParams

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PostParams

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PostParams

Source§

fn default() -> PostParams

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for PostParams

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PostParams

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,