Struct IPMIClient

pub struct IPMIClient { /* private fields */ }

Implementations

impl IPMIClient

pub fn new<A: ToSocketAddrs>( ipmi_server_addr: A, ) -> Result<IPMIClient, IPMIClientError>

Creates client for running IPMI commands against a BMC.

Arguments

• ipmi_server_addr - Socket address of the IPMI server (or BMC LAN controller). Default port for IPMI RMCP is 623 UDP.

Examples

use rust_ipmi::ipmi_client::{IPMIClient, IPMIClientError};

let ipmi_server = "192.168.1.10:623"
let ipmi_client: Result<IPMIClient, IPMIClientError> = IPMIClient::new(ipmi_server)
    .expect("Failed to connect to the IPMI server");

pub fn set_read_timeout( &self, duration: Option<Duration>, ) -> Result<(), IPMIClientError>

Set the read timeout on the ipmi client UDP socket. Default timeout for the socket is set to 20 seconds

Arguments

• duration - The timeout duration. If set to 5 seconds, the ipmi client will wait up to 5 seconds for a response from the BMC until timing out

Examples

use rust_ipmi::ipmi_client::IPMIClient;

let ipmi_server = "192.168.1.10:623"
let ipmi_client = IPMIClient::new(ipmi_server).expect("Failed to connect to the IPMI server");
ipmi_client.set_read_timeout(Some(time::Duration::from_secs(10))).expect("Failed to set the timeout");

pub fn establish_connection<S: ToString>( &mut self, username: S, password: S, ) -> Result<(), IPMIClientError>

Authenticates and establishes a session with the BMC.

Arguments

• username - username used to authenticate against the BMC.
• password - password for the username provided.

Examples

use rust_ipmi::{IPMIClient, IPMIClientError};

let ipmi_server = "192.168.1.10:623";
let mut ipmi_client: IPMIClient = IPMIClient::new(ipmi_server)
    .expect("Failed to connect to the server");

let username = "my-username";
ipmi_client.establish_connection(username, "password")
    .map_err(|e: IPMIClientError| println!("Failed to establish session with BMC: {}", e));

pub fn send_raw_request<C: Into<Option<Vec<u8>>>, T: TryInto<NetFn>>( &mut self, net_fn: T, command_code: u8, data: C, ) -> Result<IpmiPayloadResponse, IPMIClientError>

Run a raw command to the BMC. See “Appendix G - Command Assignments” of the IPMIv2 spec to see a comprehensive list of default IPMI commands.

Arguments

• net_fn - NetFn of your request.
• command_code - u8: Command code of your request.
• data - Data associated with the command.

Examples

use rust_ipmi::{IPMIClient, Payload, IPMIClientError, Command, NetFn};

let ipmi_server = "192.168.1.10:623";
let mut ipmi_client: IPMIClient = IPMIClient::new(ipmi_server)
    .expect("Failed to connect to the server");

ipmi_client.establish_connection("username", "password")
    .map_err(|e: IPMIClientError| println!("Failed to establish session with BMC: {}", e));

let response = ipmi_client
    .send_raw_request(NetFn::App, Command::SetSessionPrivilegeLevel.into(), Some(vec![0x4]))
    .map_err(|e: IPMIClientError| println!("{}", e));

Trait Implementations

impl Debug for IPMIClient

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

Formats the value using the given formatter.