Crate redfish

Crate redfish 

Source
Expand description

Production-grade Rust SDK for DMTF Redfish.

This crate provides:

  • An async-first Client (Tokio-based)
  • An optional [BlockingClient] behind the blocking feature
  • Common Redfish services (service root, systems, chassis, managers, sessions)
  • Platform services (accounts, events, tasks, updates)
  • Registries/JsonSchemas discovery endpoints
  • A safe and structured error model (Error)

Most users will start with Client::builder or [BlockingClient::builder].

Re-exports§

pub use api::ActionResponse;
pub use types::Account;
pub use types::AccountCreateRequest;
pub use types::AccountService;
pub use types::AccountUpdateRequest;
pub use types::Bios;
pub use types::BiosSettings;
pub use types::BiosSettingsUpdateRequest;
pub use types::Boot;
pub use types::BootSourceOverrideEnabled;
pub use types::BootSourceOverrideTarget;
pub use types::Chassis;
pub use types::Collection;
pub use types::ComputerSystem;
pub use types::ComputerSystemUpdateRequest;
pub use types::Drive;
pub use types::EthernetInterface;
pub use types::EthernetInterfaceUpdateRequest;
pub use types::EventService;
pub use types::EventSubscription;
pub use types::EventSubscriptionCreateRequest;
pub use types::EventSubscriptionUpdateRequest;
pub use types::JsonSchemaFile;
pub use types::LogEntry;
pub use types::LogService;
pub use types::Manager;
pub use types::ManagerNetworkProtocol;
pub use types::ManagerNetworkProtocolUpdateRequest;
pub use types::MessageRegistryFile;
pub use types::ODataQuery;
pub use types::OdataId;
pub use types::Power;
pub use types::ResetType;
pub use types::Role;
pub use types::Sensor;
pub use types::ServiceRoot;
pub use types::Session;
pub use types::SimpleUpdateRequest;
pub use types::SoftwareInventory;
pub use types::Storage;
pub use types::SubmitTestEventRequest;
pub use types::Task;
pub use types::TaskService;
pub use types::Thermal;
pub use types::UpdateService;

Modules§

api
types

Structs§

Client
ClientBuilder
Builder for the async Client.
Credentials
Username/password credentials.
Error
Error type returned by this crate.
HeaderMap
Re-exported HTTP types used in the public API. A specialized multimap for header names and values.
HeaderName
Re-exported HTTP types used in the public API. Represents an HTTP header field name
HeaderValue
Re-exported HTTP types used in the public API. Represents an HTTP header field value.
Method
Re-exported HTTP types used in the public API. The Request Method (VERB)
RequestContext
Additional context about the request that triggered an error.
RetryPolicy
Retry policy configuration. Retry policy for transient failures.
SessionToken
Redfish session token.
StatusCode
Re-exported HTTP types used in the public API. An HTTP status code (status-code in RFC 9110 et al.).

Enums§

Auth
Authentication configuration.
ErrorKind
Coarse error category. Use Error::kind to inspect.

Type Aliases§

Result
Convenience alias.