Struct Client 

pub struct Client { /* private fields */ }

Tokio-based asynchronous client API.

This is the default mode (feature async). A tokio-based IPMI v2.0 RMCP+ client.

Implementations

impl Client

pub fn builder(target: SocketAddr) -> ClientBuilder

Create a ClientBuilder.

Examples found in repository

examples/tokio_get_device_id.rs (line 16)

    pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
        // Example:
        //   cargo run --example tokio_get_device_id -- 192.168.1.10:623 admin password
        let mut args = std::env::args().skip(1);
        let target = args.next().ok_or("missing <host:port>")?.parse()?;
        let username = args.next().ok_or("missing <username>")?;
        let password = args.next().ok_or("missing <password>")?;

        let client = Client::builder(target)
            .username(username)
            .password(password)
            .privilege_level(PrivilegeLevel::Administrator)
            .timeout(Duration::from_secs(2))
            .retries(3)
            .build()
            .await?;

        let device_id = client.get_device_id().await?;
        println!("Device: {device_id:?}");

        Ok(())
    }

pub async fn execute<C: Command>(&self, command: C) -> Result<C::Output>

Execute a typed command (single request/response).

pub async fn send_raw( &self, netfn: u8, cmd: u8, data: &[u8], ) -> Result<RawResponse>

Send a raw IPMI request and return the raw response.

pub async fn get_device_id(&self) -> Result<DeviceId>

Convenience wrapper for Get Device ID (App NetFn, cmd 0x01).

Examples found in repository

examples/tokio_get_device_id.rs (line 25)

    pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
        // Example:
        //   cargo run --example tokio_get_device_id -- 192.168.1.10:623 admin password
        let mut args = std::env::args().skip(1);
        let target = args.next().ok_or("missing <host:port>")?.parse()?;
        let username = args.next().ok_or("missing <username>")?;
        let password = args.next().ok_or("missing <password>")?;

        let client = Client::builder(target)
            .username(username)
            .password(password)
            .privilege_level(PrivilegeLevel::Administrator)
            .timeout(Duration::from_secs(2))
            .retries(3)
            .build()
            .await?;

        let device_id = client.get_device_id().await?;
        println!("Device: {device_id:?}");

        Ok(())
    }

pub async fn get_self_test_results(&self) -> Result<SelfTestResult>

Convenience wrapper for Get Self Test Results (App NetFn, cmd 0x04).

pub async fn get_system_guid(&self) -> Result<SystemGuid>

Convenience wrapper for Get System GUID (App NetFn, cmd 0x37).

pub async fn get_chassis_status(&self) -> Result<ChassisStatus>

Convenience wrapper for Get Chassis Status (Chassis NetFn, cmd 0x01).

pub async fn chassis_control(&self, control: ChassisControl) -> Result<()>

Run Chassis Control (Chassis NetFn, cmd 0x02).

pub async fn get_channel_auth_capabilities( &self, channel: u8, privilege: PrivilegeLevel, ) -> Result<ChannelAuthCapabilities>

Convenience wrapper for Get Channel Authentication Capabilities (App NetFn, cmd 0x38).

pub fn managed_session_id(&self) -> u32

Return the managed system (BMC) session ID (SIDC).

pub fn remote_session_id(&self) -> u32

Return the remote console session ID (SIDM).

pub async fn close_session(&self) -> Result<()>

Close the active RMCP+ session (App NetFn, cmd 0x3C).

This is a best-effort operation. If the BMC does not respond (timeout) the client still transitions to a locally closed state and will reject further requests.

pub fn app(&self) -> AppService

A service-style grouping for App netfn commands.

pub fn chassis(&self) -> ChassisService

A service-style grouping for Chassis netfn commands.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.