clientapi_pve/models/
pve_usb_config.rs

1/*
2 * Proxmox Virtual Environment API
3 *
4 * Generated from apidoc.js. NOT an official Proxmox specification. See https://pve.proxmox.com/pve-docs/api-viewer/ for the upstream documentation.
5 *
6 * The version of the OpenAPI document: 9.x
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct PveUsbConfig {
16
17    /// 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. 
18    #[serde(rename = "host", skip_serializing_if = "Option::is_none")]
19    pub host: Option<String>,
20
21    /// The ID of a cluster wide mapping. Either this or the default-key 'host' must be set.
22    #[serde(rename = "mapping", skip_serializing_if = "Option::is_none")]
23    pub mapping: Option<String>,
24
25    /// 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).
26    #[serde(rename = "usb3", skip_serializing_if = "Option::is_none")]
27    pub usb3: Option<models::PveBoolean>,
28
29
30}
31
32impl PveUsbConfig {
33    pub fn new() -> PveUsbConfig {
34        PveUsbConfig {
35            
36            host: None,
37            
38            mapping: None,
39            
40            usb3: None,
41            
42        }
43    }
44}
45
46
47impl PveUsbConfig {
48    /// Serialise this PveUsbConfig into Proxmox's CLI-style shorthand
49    /// string (`key=value,…`). The property marked `x-pve-default-key`
50    /// is emitted positionally without a `key=` prefix; aliases collapse
51    /// multiple property names to the same wire key.
52    ///
53    /// Example: `PveUsbConfig `
54    /// → `"virtio,bridge=vmbr0"`
55    pub fn to_shorthand(&self) -> String {
56        let mut parts: Vec<String> = Vec::new();
57        
58        
59        if let Some(ref v) = self.host {
60            parts.push(format!("{}", v));
61        }
62        
63        
64        
65        if let Some(ref v) = self.mapping {
66            parts.push(format!("mapping={}", v));
67        }
68        
69        
70        if let Some(ref v) = self.usb3 {
71            parts.push(format!("usb3={}", v));
72        }
73        
74        parts.join(",")
75    }
76}
77
clientapi_pve/models/pve_usb_config.rs

clientapi_pve/models/
pve_usb_config.rs
