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 PveUsbConfig {

    /// The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:   'bus-port(.port)*' (decimal numbers) or  'vendor_id:product_id' (hexadecimal numbers) or  'spice'  You can use the 'lsusb -t' command to list existing usb devices.  NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.  The value 'spice' can be used to add a usb redirection devices for spice.  Either this or the 'mapping' key must be set. 
    #[serde(rename = "host", skip_serializing_if = "Option::is_none")]
    pub host: Option<String>,

    /// The ID of a cluster wide mapping. Either this or the default-key 'host' must be set.
    #[serde(rename = "mapping", skip_serializing_if = "Option::is_none")]
    pub mapping: Option<String>,

    /// Specifies whether if given host option is a USB3 device or port. For modern guests (machine version >= 7.1 and ostype l26 and windows > 7), this flag is irrelevant (all devices are plugged into a xhci controller).
    #[serde(rename = "usb3", skip_serializing_if = "Option::is_none")]
    pub usb3: Option<models::PveBoolean>,


}

impl PveUsbConfig {
    pub fn new() -> PveUsbConfig {
        PveUsbConfig {
            
            host: None,
            
            mapping: None,
            
            usb3: None,
            
        }
    }
}


impl PveUsbConfig {
    /// Serialise this PveUsbConfig 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: `PveUsbConfig `
    /// → `"virtio,bridge=vmbr0"`
    pub fn to_shorthand(&self) -> String {
        let mut parts: Vec<String> = Vec::new();
        
        
        if let Some(ref v) = self.host {
            parts.push(format!("{}", v));
        }
        
        
        
        if let Some(ref v) = self.mapping {
            parts.push(format!("mapping={}", v));
        }
        
        
        if let Some(ref v) = self.usb3 {
            parts.push(format!("usb3={}", v));
        }
        
        parts.join(",")
    }
}