Struct nmstate::NetworkState

#[non_exhaustive]
pub struct NetworkState {
    pub description: String,
    pub hostname: Option<HostNameState>,
    pub dns: Option<DnsState>,
    pub rules: RouteRules,
    pub routes: Routes,
    pub interfaces: Interfaces,
    pub ovsdb: Option<OvsDbGlobalConfig>,
    pub ovn: OvnConfiguration,
    /* private fields */
}

The NetworkState represents the whole network state including both kernel status and configurations provides by backends(NetworkManager, OpenvSwitch databas, and etc).

Example yaml(many lines omitted) serialized NetworkState would be:

hostname:
  running: host.example.org
  config: host.example.org
dns-resolver:
  config:
    server:
    - 2001:db8:1::
    - 192.0.2.1
    search: []
route-rules:
  config:
  - ip-from: 2001:db8:b::/64
    priority: 30000
    route-table: 200
  - ip-from: 192.0.2.2/32
    priority: 30000
    route-table: 200
routes:
  config:
  - destination: 2001:db8:a::/64
    next-hop-interface: eth1
    next-hop-address: 2001:db8:1::2
    metric: 108
    table-id: 200
  - destination: 192.168.2.0/24
    next-hop-interface: eth1
    next-hop-address: 192.168.1.3
    metric: 108
    table-id: 200
interfaces:
- name: eth1
  type: ethernet
  state: up
  mac-address: 0E:F9:2B:28:42:D9
  mtu: 1500
  ipv4:
    enabled: true
    dhcp: false
    address:
    - ip: 192.168.1.3
      prefix-length: 24
  ipv6:
    enabled: true
    dhcp: false
    autoconf: false
    address:
    - ip: 2001:db8:1::1
      prefix-length: 64
ovs-db:
  external_ids:
    hostname: host.example.org
    rundir: /var/run/openvswitch
    system-id: 176866c7-6dc8-400f-98ac-c658509ec09f
  other_config: {}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: String

Description for the whole desire state. Currently it will not be persisted by network backend and will be ignored during applying or querying.

hostname: Option<HostNameState>

Hostname of current host.

dns: Option<DnsState>

DNS resolver status, deserialize and serialize from/to dns-resolver.

rules: RouteRules

Route rule, deserialize and serialize from/to route-rules.

routes: Routes

Route

interfaces: Interfaces

Network interfaces

ovsdb: Option<OvsDbGlobalConfig>

The global configurations of OpenvSwitach daemon

ovn: OvnConfiguration

The OVN configuration in the system

Implementations

impl NetworkState

pub fn gen_conf( &self, ) -> Result<HashMap<String, Vec<(String, String)>>, NmstateError>

Generate offline network configurations. Currently only support generate NetworkManager key file out of NetworkState.

The output is a HashMap with backend name as key and Vec<(config_file_name, config_content>)> as value.

The backend name for NetworkManager is NetworkManager.

impl NetworkState

pub fn is_empty(&self) -> bool

pub fn set_kernel_only(&mut self, value: bool) -> &mut Self

Whether to perform kernel actions(also known as kernel only mode through the document this project) only or not. When set to false, nmstate will contact NetworkManager plugin for querying/applying the network state. Default is false.

pub fn kernel_only(&self) -> bool

pub fn set_verify_change(&mut self, value: bool) -> &mut Self

By default(true), When nmstate applying the network state, after applied the network state, nmstate will verify whether the outcome network configuration matches with desired, if not, will rollback to state before apply(only when NetworkState::set_kernel_only() set to false. When set to false, no verification will be performed.

pub fn set_commit(&mut self, value: bool) -> &mut Self

Only available when NetworkState::set_kernel_only() set to false. When set to false, the network configuration will not commit persistently, and will rollback after timeout defined by NetworkState::set_timeout(). Default to true for making the network state persistent.

pub fn set_timeout(&mut self, value: u32) -> &mut Self

Only available when NetworkState::set_commit() set to false. The time to wait before rolling back the network state to the state before [NetworkState::apply()` invoked.

pub fn set_include_secrets(&mut self, value: bool) -> &mut Self

Whether to include secrets(like password) in NetworkState::retrieve() Default is false.

pub fn set_include_status_data(&mut self, value: bool) -> &mut Self

Deprecated. No use at all.

pub fn set_running_config_only(&mut self, value: bool) -> &mut Self

Query activated/running network configuration excluding:

• IP address retrieved by DHCP or IPv6 auto configuration.
• DNS client resolver retrieved by DHCP or IPv6 auto configuration.
• Routes retrieved by DHCPv4 or IPv6 router advertisement.
• LLDP neighbor information.

pub fn set_memory_only(&mut self, value: bool) -> &mut Self

When set to true, the network state be applied and only stored in memory which will be purged after system reboot.

pub fn new() -> Self

Create empty NetworkState

pub fn new_from_json(net_state_json: &str) -> Result<Self, NmstateError>

Wrapping function of serde_json::from_str() with error mapped to NmstateError.

pub fn new_from_yaml(net_state_yaml: &str) -> Result<Self, NmstateError>

Wrapping function of serde_yaml::from_str() with error mapped to NmstateError.

pub fn append_interface_data(&mut self, iface: Interface)

Append Interface into NetworkState

pub fn hide_secrets(&mut self)

Replace secret string with <_password_hid_by_nmstate>

impl NetworkState

pub fn checkpoint_rollback(checkpoint: &str) -> Result<(), NmstateError>

Rollback a checkpoint. Not available for kernel only mode. Only available for feature query_apply.

pub fn checkpoint_commit(checkpoint: &str) -> Result<(), NmstateError>

Commit a checkpoint. Not available for kernel only mode. Only available for feature query_apply.

pub fn retrieve(&mut self) -> Result<&mut Self, NmstateError>

Retrieve the NetworkState. Only available for feature query_apply.

pub async fn retrieve_async(&mut self) -> Result<&mut Self, NmstateError>

Retrieve the NetworkState. Only available for feature query_apply.

pub fn apply(&self) -> Result<(), NmstateError>

Apply the NetworkState. Only available for feature query_apply.

pub async fn apply_async(&self) -> Result<(), NmstateError>

Apply the NetworkState. Only available for feature query_apply.

pub fn gen_diff(&self, current: &Self) -> Result<Self, NmstateError>

Generate new NetworkState contains only changed properties

impl NetworkState

pub fn generate_revert(&self, current: &Self) -> Result<Self, NmstateError>

impl NetworkState

pub fn merge_desire(&mut self, new_desire: &Self)

Only used for statistics by merging multiple desire states to generate the final statistics.

pub fn statistic( &self, current: &Self, ) -> Result<NmstateStatistic, NmstateError>

Trait Implementations

impl Clone for NetworkState

fn clone(&self) -> NetworkState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NetworkState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NetworkState

fn default() -> NetworkState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NetworkState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NetworkState

fn eq(&self, other: &NetworkState) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NetworkState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<NetworkPolicy> for NetworkState

type Error = NmstateError

The type returned in the event of a conversion error.

fn try_from(policy: NetworkPolicy) -> Result<Self, NmstateError>

Performs the conversion.

impl Eq for NetworkState

impl StructuralPartialEq for NetworkState