Struct PutParams

pub struct PutParams {

    pub bwlimit: Option<String>,
    pub console: Option<Console>,
    pub crs: Option<String>,
    pub delete: Option<String>,
    pub description: Option<String>,
    pub email_from: Option<String>,
    pub fencing: Option<Fencing>,
    pub ha: Option<String>,
    pub http_proxy: Option<String>,
    pub keyboard: Option<Keyboard>,
    pub language: Option<Language>,
    pub mac_prefix: Option<String>,
    pub max_workers: Option<u64>,
    pub migration: Option<String>,
    pub migration_unsecure: Option<bool>,
    pub next_id: Option<String>,
    pub notify: Option<String>,
    pub registered_tags: Option<String>,
    pub tag_style: Option<String>,
    pub u2f: Option<String>,
    pub user_tag_access: Option<String>,
    pub webauthn: Option<String>,
    pub additional_properties: HashMap<String, Value>,
}

Fields

bwlimit: Option<String>

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

console: Option<Console>

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.

crs: Option<String>

Cluster resource scheduling settings.

delete: Option<String>

A list of settings you want to delete.

description: Option<String>

Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.

email_from: Option<String>

Specify email address to send notification from (default is root@$hostname)

fencing: Option<Fencing>

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

ha: Option<String>

Cluster wide HA settings.

http_proxy: Option<String>

Specify external http proxy which is used for downloads (example: ‘http://username:password@host:port/’)

keyboard: Option<Keyboard>

Default keybord layout for vnc server.

language: Option<Language>

Default GUI language.

mac_prefix: Option<String>

Prefix for the auto-generated MAC addresses of virtual guests. The default ‘BC:24:11’ is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You’re allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT). 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.

max_workers: Option<u64>

Defines how many workers (per node) are maximal started on actions like ‘stopall VMs’ or task from the ha-manager.

migration: Option<String>

For cluster wide migration settings.

migration_unsecure: Option<bool>

Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the ‘migration’ property instead!

next_id: Option<String>

Control the range for the free VMID auto-selection pool.

notify: Option<String>

Cluster-wide notification settings.

registered_tags: Option<String>

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.

tag_style: Option<String>

Tag style options.

u2f: Option<String>

u2f

user_tag_access: Option<String>

Privilege options for user-settable tags

webauthn: Option<String>

webauthn configuration

additional_properties: HashMap<String, Value>

Trait Implementations

impl Clone for PutParams

fn clone(&self) -> PutParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutParams

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

Formats the value using the given formatter.

impl Default for PutParams

fn default() -> PutParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PutParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PutParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.