Skip to main content

PostParams

Struct PostParams 

Source
pub struct PostParams {
Show 62 fields pub authsupported: Option<String>, pub base: Option<String>, pub blocksize: Option<String>, pub bwlimit: Option<String>, pub comstar_hg: Option<String>, pub comstar_tg: Option<String>, pub content: Option<String>, pub content_dirs: Option<String>, pub create_base_path: Option<bool>, pub create_subdirs: Option<bool>, pub data_pool: Option<String>, pub datastore: Option<String>, pub disable: Option<bool>, pub domain: Option<DomainStr>, pub encryption_key: Option<String>, pub export: Option<String>, pub fingerprint: Option<FingerprintStr>, pub format: Option<Format>, pub fs_name: Option<String>, pub fuse: Option<bool>, pub is_mountpoint: Option<String>, pub iscsiprovider: Option<String>, pub keyring: Option<String>, pub krbd: Option<bool>, pub lio_tpg: Option<String>, pub master_pubkey: Option<String>, pub max_protected_backups: Option<MaxProtectedBackupsInt>, pub mkdir: Option<bool>, pub monhost: Option<String>, pub mountpoint: Option<String>, pub namespace: Option<String>, pub nocow: Option<bool>, pub nodes: Option<String>, pub nowritecache: Option<bool>, pub options: Option<String>, pub password: Option<PasswordStr>, pub path: Option<String>, pub pool: Option<String>, pub port: Option<PortInt>, pub portal: Option<String>, pub preallocation: Option<Preallocation>, pub prune_backups: Option<String>, pub saferemove: Option<bool>, pub saferemove_stepsize: Option<SaferemoveStepsizeInt>, pub saferemove_throughput: Option<String>, pub server: Option<String>, pub share: Option<String>, pub shared: Option<bool>, pub skip_cert_verification: Option<bool>, pub smbversion: Option<Smbversion>, pub snapshot_as_volume_chain: Option<bool>, pub sparse: Option<bool>, pub storage: String, pub subdir: Option<String>, pub tagged_only: Option<bool>, pub target: Option<String>, pub thinpool: Option<String>, pub ty: Type, pub username: Option<String>, pub vgname: Option<String>, pub zfs_base_path: Option<String>, pub additional_properties: HashMap<String, Value>,
}

Fields§

§authsupported: Option<String>

Authsupported.

§base: Option<String>

Base volume. This volume is automatically activated.

§blocksize: Option<String>

block size

§bwlimit: Option<String>

Set I/O bandwidth limit for various operations (in KiB/s).

§comstar_hg: Option<String>

host group for comstar views

§comstar_tg: Option<String>

target group for comstar views

§content: Option<String>

Allowed content types.

NOTE: the value ‘rootdir’ is used for Containers, and value ‘images’ for VMs.

§content_dirs: Option<String>

Overrides for default content type directories.

§create_base_path: Option<bool>

Create the base directory if it doesn’t exist.

§create_subdirs: Option<bool>

Populate the directory with the default structure.

§data_pool: Option<String>

Data Pool (for erasure coding only)

§datastore: Option<String>

Proxmox Backup Server datastore name.

§disable: Option<bool>

Flag to disable the storage.

§domain: Option<DomainStr>

CIFS domain.

§encryption_key: Option<String>

Encryption key. Use ‘autogen’ to generate one automatically without passphrase.

§export: Option<String>

NFS export path.

§fingerprint: Option<FingerprintStr>

Certificate SHA 256 fingerprint.

§format: Option<Format>

Default image format.

§fs_name: Option<String>

The Ceph filesystem name.

§fuse: Option<bool>

Mount CephFS through FUSE.

§is_mountpoint: Option<String>

Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.

§iscsiprovider: Option<String>

iscsi provider

§keyring: Option<String>

Client keyring contents (for external clusters).

§krbd: Option<bool>

Always access rbd through krbd kernel module.

§lio_tpg: Option<String>

target portal group for Linux LIO targets

§master_pubkey: Option<String>

Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.

§max_protected_backups: Option<MaxProtectedBackupsInt>

Maximal number of protected backups per guest. Use ‘-1’ for unlimited.

§mkdir: Option<bool>

Create the directory if it doesn’t exist and populate it with default sub-dirs. NOTE: Deprecated, use the ‘create-base-path’ and ‘create-subdirs’ options instead.

§monhost: Option<String>

IP addresses of monitors (for external clusters).

§mountpoint: Option<String>

mount point

§namespace: Option<String>

Namespace.

§nocow: Option<bool>

Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system.

§nodes: Option<String>

List of nodes for which the storage configuration applies.

§nowritecache: Option<bool>

disable write caching on the target

§options: Option<String>

NFS/CIFS mount options (see ‘man nfs’ or ‘man mount.cifs’)

§password: Option<PasswordStr>

Password for accessing the share/datastore.

§path: Option<String>

File system path.

§pool: Option<String>

Pool.

§port: Option<PortInt>

Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the ‘options’ option to configure the port via the mount options.

§portal: Option<String>

iSCSI portal (IP or DNS name with optional port).

§preallocation: Option<Preallocation>

Preallocation mode for raw and qcow2 images. Using ‘metadata’ on raw images results in preallocation=off.

§prune_backups: Option<String>

The retention options with shorter intervals are processed first with –keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.

§saferemove: Option<bool>

Zero-out data when removing LVs.

§saferemove_stepsize: Option<SaferemoveStepsizeInt>

Wipe step size in MiB. It will be capped to the maximum supported by the storage.

§saferemove_throughput: Option<String>

Wipe throughput (cstream -t parameter value).

§server: Option<String>

Server IP or DNS name.

§share: Option<String>

CIFS share.

§shared: Option<bool>

Indicate that this is a single storage with the same contents on all nodes (or all listed in the ‘nodes’ option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such!

§skip_cert_verification: Option<bool>

Disable TLS certificate verification, only enable on fully trusted networks!

§smbversion: Option<Smbversion>

SMB protocol version. ‘default’ if not set, negotiates the highest SMB2+ version supported by both the client and server.

§snapshot_as_volume_chain: Option<bool>

Enable support for creating storage-vendor agnostic snapshot through volume backing-chains.

§sparse: Option<bool>

use sparse volumes

§storage: String

The storage identifier.

§subdir: Option<String>

Subdir to mount.

§tagged_only: Option<bool>

Only use logical volumes tagged with ‘pve-vm-ID’.

§target: Option<String>

iSCSI target.

§thinpool: Option<String>

LVM thin pool LV name.

§ty: Type

Storage type.

§username: Option<String>

RBD Id.

§vgname: Option<String>

Volume group name.

§zfs_base_path: Option<String>

Base path where to look for the created ZFS block devices. Set automatically during creation if not specified. Usually ‘/dev/zvol’.

§additional_properties: HashMap<String, Value>

Implementations§

Source§

impl PostParams

Source

pub fn new(storage: String, ty: Type) -> Self

Trait Implementations§

Source§

impl Clone for PostParams

Source§

fn clone(&self) -> PostParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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<'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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more