libredfish 0.2.0

A redfish library. Useful for querying server hardware from a BMC.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

/*
 * SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
use serde::{Deserialize, Serialize};

// A SerialInterface for Serial-Over-LAN. Machines seem to have always exactly one.
// Comment examples are for Supermicro. Lenovo is simliar. Dell has only name, hence all Options.
#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(rename_all = "PascalCase")]
pub struct SerialInterface {
    pub name: String,
    interface_enabled: Option<bool>,
    signal_type: Option<String>,    // Rs232", Rs485
    bit_rate: Option<String>,       // 1200 through 230400
    parity: Option<String>,         // None, Even, Odd, Mark, Space
    data_bits: Option<String>,      // 5-8 as a string
    stop_bits: Option<String>,      // "1" or "2"
    flow_control: Option<String>,   // None, Software, Hardware
    connector_type: Option<String>, // "RJ45", RJ11, "DB9 Female", "DB9 Male", "DB25 Female", "DB25 Male", USB, mUSB, uUSB
    pin_out: Option<String>,        // Cyclades, Cisco, Digi
}

impl SerialInterface {
    /// Is this serial interface set to the Supermicro defaults, which is also
    /// what we need for Serial Over LAN to work?
    ///
    /// Note that we don't seem to be able to change these via Redfish.
    /// A PATCH to redfish/v1/Managers/1/SerialInterfaces/1 produces a mixture of
    /// - .. is not in the list of valid properties for the resource
    /// - .. is a read only property and cannot be assigned a value
    pub fn is_supermicro_default(&self) -> bool {
        self.interface_enabled == Some(true)
            && self.signal_type.as_deref() == Some("Rs232")
            && self.bit_rate.as_deref() == Some("115200")
            && self.parity.as_deref() == Some("None")
            && self.data_bits.as_deref() == Some("8")
            && self.stop_bits.as_deref() == Some("1")
            && self.flow_control.as_deref() == Some("None")
            && self.connector_type.as_deref() == Some("RJ45")
            && self.pin_out.as_deref() == Some("Cyclades")
    }
}