rustmiko 0.6.0

A Netmiko rewrite for Rust
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

use std::error::Error;
use std::io;
use std::net::ToSocketAddrs;
use regex::Regex;
use crate::devices::generic::connection::Connection;
use crate::devices::generic::device_types::config::{Configurable, ConfigurationMode, InterfaceConfigurable};
use crate::devices::generic::device_types::interfaces::Interface;

/// A cisco (catalyst) device API implementation.
///
/// Usage of the base type is not suggested unless you implement your own ConnectionHandler.
/// It's recommended to use one of the predefined types:
/// [`CiscoSSH`] or
/// [`CiscoTelnet`]
///
/// [`CiscoSSH`]: crate::devices::cisco::CiscoSSH
/// [`CiscoTelnet`]: crate::devices::cisco::CiscoTelnet
pub struct CiscoDevice<C: Connection> {
    connection: C,
    prompt_end: Regex,
}

impl<C: Connection<ConnectionHandler = C>> CiscoDevice<C> {
    pub fn connect<A: ToSocketAddrs>(addr: A, username: &str, password: &str) -> Result<CiscoDevice<C>, Box<dyn Error>> {
        Ok(CiscoDevice {
            connection: C::connect(addr, Some(username), Some(password))?,
            prompt_end: Regex::new("#")?,
        })
    }

    pub fn enable(&mut self, password: &str) -> io::Result<()> {
        self.execute_raw("enable")?;
        if !password.is_empty() {
            self.execute_raw(password)?;
        }
        Ok(())
    }

    pub fn save(&mut self) -> io::Result<()> {
        self.execute_raw("write memory")
    }
}

impl<C: Connection> Configurable for CiscoDevice<C> {
    type SessionType = Self;

    fn enter_config(&mut self) -> io::Result<ConfigurationMode<Self>> {
        self.execute_raw("configure terminal")?;
        Ok(ConfigurationMode::enter(self))
    }

    fn execute_raw(&mut self, command: &str) -> io::Result<()> {
        self.connection.execute_raw(command, &self.prompt_end)
    }

    fn exit(&mut self) -> io::Result<()> {
        self.execute_raw("exit")
    }
}

impl<'a, C: Connection> InterfaceConfigurable for ConfigurationMode<'a, CiscoDevice<C>> {
    fn interface_up(&mut self, interface: &Interface) -> io::Result<()> {
        self.session.execute_raw(&format!("interface {}", interface.name()))?;
        self.session.execute_raw("no shutdown")?;
        self.session.exit()
    }

    fn interface_down(&mut self, interface: &Interface) -> io::Result<()> {
        self.session.execute_raw(&format!("interface {}", interface.name()))?;
        self.session.execute_raw("shutdown")?;
        self.session.exit()
    }
}

/// Reaches the save command through to the session, since cisco allows saving in config mode
impl<'a, C: Connection<ConnectionHandler = C>> ConfigurationMode<'a, CiscoDevice<C>> {
    pub fn save(&mut self) -> io::Result<()> {
        self.session.save()
    }
}