clientapi-pve 2026.5.24

Generated from apidoc.js. NOT an official Proxmox specification. See https://pve.proxmox.com/pve-docs/api-viewer/ for the upstream documentation.
Documentation
/*
 * Proxmox Virtual Environment API
 *
 * Generated from apidoc.js. NOT an official Proxmox specification. See https://pve.proxmox.com/pve-docs/api-viewer/ for the upstream documentation.
 *
 * The version of the OpenAPI document: 9.x
 * 
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct PveAgentConfig {

    /// Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.
    #[serde(rename = "enabled")]
    pub enabled: models::PveBoolean,

    /// Whether to issue the guest-fsfreeze-freeze and guest-fsfreeze-thaw QEMU guest agent commands. Backups in snapshot mode, clones, snapshots without RAM, importing disks from a running guest, and replications normally issue a guest-fsfreeze-freeze and a respective thaw command when the QEMU Guest agent option is enabled in the guest's configuration and the agent is running inside of the guest.  The deprecated 'freeze-fs-on-backup' setting is treated as an alias for this setting.
    #[serde(rename = "freeze-fs", skip_serializing_if = "Option::is_none")]
    pub freeze_fs: Option<models::PveBoolean>,

    #[serde(rename = "freeze-fs-on-backup", skip_serializing_if = "Option::is_none")]
    pub freeze_fs_on_backup: Option<String>,

    /// Run fstrim after moving a disk or migrating the VM.
    #[serde(rename = "fstrim_cloned_disks", skip_serializing_if = "Option::is_none")]
    pub fstrim_cloned_disks: Option<models::PveBoolean>,

    #[serde(rename = "guest-fsfreeze", skip_serializing_if = "Option::is_none")]
    pub guest_fsfreeze: Option<String>,

    /// Select the agent type
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub r#type: Option<models::PveQemuTypeEnum>,


}

impl PveAgentConfig {
    pub fn new(enabled: models::PveBoolean) -> PveAgentConfig {
        PveAgentConfig {
            
            enabled,
            
            freeze_fs: None,
            
            freeze_fs_on_backup: None,
            
            fstrim_cloned_disks: None,
            
            guest_fsfreeze: None,
            
            r#type: None,
            
        }
    }
}


impl PveAgentConfig {
    /// Serialise this PveAgentConfig into Proxmox's CLI-style shorthand
    /// string (`key=value,…`). The property marked `x-pve-default-key`
    /// is emitted positionally without a `key=` prefix; aliases collapse
    /// multiple property names to the same wire key.
    ///
    /// Example: `PveAgentConfig `
    /// → `"virtio,bridge=vmbr0"`
    pub fn to_shorthand(&self) -> String {
        let mut parts: Vec<String> = Vec::new();
        
        
        parts.push(format!("{}", self.enabled));
        
        
        
        
        if let Some(ref v) = self.freeze_fs {
            parts.push(format!("freeze-fs={}", v));
        }
        
        
        if let Some(ref v) = self.freeze_fs_on_backup {
            parts.push(format!("freeze-fs={}", v));
        }
        
        
        if let Some(ref v) = self.fstrim_cloned_disks {
            parts.push(format!("fstrim_cloned_disks={}", v));
        }
        
        
        if let Some(ref v) = self.guest_fsfreeze {
            parts.push(format!("freeze-fs={}", v));
        }
        
        
        if let Some(ref v) = self.r#type {
            parts.push(format!("type={}", v));
        }
        
        parts.join(",")
    }
}