nmstate 2.2.60

Library for networking management in a declarative manner
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

// SPDX-License-Identifier: Apache-2.0

use serde::{Deserialize, Serialize};

use crate::{BaseInterface, ErrorKind, InterfaceType, NmstateError};

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
/// Linux kernel IPVLAN interface. The example YAML output of
/// [crate::NetworkState] with an IPVLAN interface would be:
/// ```yaml
/// ---
/// interfaces:
///   - name: ipvlan0
///     type: ipvlan
///     state: up
///     ipvlan:
///       base-iface: eth1
///       mode: l3
///       private: true
/// ```
pub struct IpVlanInterface {
    #[serde(flatten)]
    pub base: BaseInterface,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ipvlan: Option<IpVlanConfig>,
}

impl Default for IpVlanInterface {
    fn default() -> Self {
        Self {
            base: BaseInterface {
                iface_type: InterfaceType::IpVlan,
                ..Default::default()
            },
            ipvlan: None,
        }
    }
}

impl IpVlanInterface {
    pub fn new() -> Self {
        Self::default()
    }

    pub(crate) fn sanitize(
        &self,
        is_desired: bool,
    ) -> Result<(), NmstateError> {
        if is_desired
            && let Some(conf) = &self.ipvlan
            && conf.private == Some(true)
            && conf.vepa == Some(true)
        {
            let e = NmstateError::new(
                ErrorKind::InvalidArgument,
                "Both private and VEPA flags cannot be enabled at the same \
                 time"
                    .to_string(),
            );
            log::error!("{e}");
            return Err(e);
        }
        Ok(())
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "kebab-case", deny_unknown_fields)]
#[non_exhaustive]
pub struct IpVlanConfig {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub base_iface: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub mode: Option<IpVlanMode>,
    #[serde(
        skip_serializing_if = "Option::is_none",
        default,
        deserialize_with = "crate::deserializer::option_bool_or_string"
    )]
    pub private: Option<bool>,
    #[serde(
        skip_serializing_if = "Option::is_none",
        default,
        deserialize_with = "crate::deserializer::option_bool_or_string"
    )]
    pub vepa: Option<bool>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
#[non_exhaustive]
#[derive(Default)]
pub enum IpVlanMode {
    /// Deserialize and serialize from/to `l2`.
    L2,
    /// Deserialize and serialize from/to `l3`.
    #[default]
    L3,
    #[serde(rename = "l3s")]
    /// Deserialize and serialize from/to `l3s`.
    L3S,
}

impl From<IpVlanMode> for u32 {
    fn from(v: IpVlanMode) -> u32 {
        match v {
            IpVlanMode::L2 => 1,
            IpVlanMode::L3 => 2,
            IpVlanMode::L3S => 3,
        }
    }
}