pub struct CephClient { /* private fields */ }Expand description
A CephClient is a struct that handles communicating with Ceph in a nicer, Rustier way
let client = CephClient::new("admin", "/etc/ceph/ceph.conf")?;
let tree = client.osd_tree()?;Implementations§
Source§impl CephClient
impl CephClient
pub fn new<T1: AsRef<str>, T2: AsRef<str>>( user_id: T1, config_file: T2, ) -> Result<CephClient, RadosError>
pub fn simulate(self) -> Self
pub fn osd_out(&self, osd_id: u64) -> Result<(), RadosError>
pub fn osd_crush_remove(&self, osd_id: u64) -> Result<(), RadosError>
Sourcepub fn osd_pool_get(
&self,
pool: &str,
choice: &PoolOption,
) -> Result<String, RadosError>
pub fn osd_pool_get( &self, pool: &str, choice: &PoolOption, ) -> Result<String, RadosError>
Query a ceph pool.
Sourcepub fn osd_pool_set(
&self,
pool: &str,
key: &str,
value: &str,
) -> Result<(), RadosError>
pub fn osd_pool_set( &self, pool: &str, key: &str, value: &str, ) -> Result<(), RadosError>
Set a pool value
Sourcepub fn osd_set(&self, key: OsdOption, force: bool) -> Result<(), RadosError>
pub fn osd_set(&self, key: OsdOption, force: bool) -> Result<(), RadosError>
Can be used to set options on an OSD
let client = CephClient::new("admin", "/etc/ceph/ceph.conf")?;
client.osd_set(OsdOption::NoDown, false)?;Sourcepub fn osd_unset(&self, key: OsdOption) -> Result<(), RadosError>
pub fn osd_unset(&self, key: OsdOption) -> Result<(), RadosError>
Can be used to unset options on an OSD
let client = CephClient::new("admin", "/etc/ceph/ceph.conf")?;
client.osd_unset(OsdOption::NoDown)?;pub fn osd_tree(&self) -> Result<CrushTree, RadosError>
Sourcepub fn status(&self) -> Result<String, RadosError>
pub fn status(&self) -> Result<String, RadosError>
Get cluster status
Sourcepub fn mon_dump(&self) -> Result<MonDump, RadosError>
pub fn mon_dump(&self) -> Result<MonDump, RadosError>
List all the monitors in the cluster and their current rank
Sourcepub fn mon_quorum(&self) -> Result<String, RadosError>
pub fn mon_quorum(&self) -> Result<String, RadosError>
Get the mon quorum
Sourcepub fn version(&self) -> Result<CephVersion, RadosError>
pub fn version(&self) -> Result<CephVersion, RadosError>
Show mon daemon version
pub fn osd_pool_quota_get(&self, pool: &str) -> Result<u64, RadosError>
pub fn auth_del(&self, osd_id: u64) -> Result<(), RadosError>
pub fn osd_rm(&self, osd_id: u64) -> Result<(), RadosError>
pub fn osd_create(&self, id: Option<u64>) -> Result<u64, RadosError>
pub fn mgr_auth_add(&self, mgr_id: &str) -> Result<(), RadosError>
pub fn osd_auth_add(&self, osd_id: u64) -> Result<(), RadosError>
Sourcepub fn auth_get_key(
&self,
client_type: &str,
id: &str,
) -> Result<String, RadosError>
pub fn auth_get_key( &self, client_type: &str, id: &str, ) -> Result<String, RadosError>
Get a ceph-x key. The id parameter can be either a number or a string depending on the type of client so I went with string.
Sourcepub fn osd_crush_add(
&self,
osd_id: u64,
weight: f64,
host: &str,
) -> Result<(), RadosError>
pub fn osd_crush_add( &self, osd_id: u64, weight: f64, host: &str, ) -> Result<(), RadosError>
add or update crushmap position and weight for an osd
Sourcepub fn osd_crush_reweight(
&self,
osd_id: u64,
weight: f64,
) -> Result<(), RadosError>
pub fn osd_crush_reweight( &self, osd_id: u64, weight: f64, ) -> Result<(), RadosError>
reweight an osd in the CRUSH map
Sourcepub fn osd_safe_to_destroy(&self, osd_id: u64) -> bool
pub fn osd_safe_to_destroy(&self, osd_id: u64) -> bool
check if a single osd is safe to destroy/remove
pub fn mgr_dump(&self) -> Result<MgrDump, RadosError>
pub fn mgr_fail(&self, mgr_id: &str) -> Result<(), RadosError>
pub fn mgr_list_modules(&self) -> Result<Vec<String>, RadosError>
pub fn mgr_list_services(&self) -> Result<Vec<String>, RadosError>
pub fn mgr_enable_module( &self, module: &str, force: bool, ) -> Result<(), RadosError>
pub fn mgr_disable_module(&self, module: &str) -> Result<(), RadosError>
pub fn mgr_metadata(&self) -> Result<Vec<MgrMetadata>, RadosError>
pub fn osd_metadata(&self) -> Result<Vec<OsdMetadata>, RadosError>
pub fn mgr_count_metadata( &self, property: &str, ) -> Result<HashMap<String, u64>, RadosError>
pub fn mgr_versions(&self) -> Result<HashMap<String, u64>, RadosError>
pub fn run_command(&self, command: MonCommand<'_>) -> Result<String, RadosError>
Auto Trait Implementations§
impl Freeze for CephClient
impl RefUnwindSafe for CephClient
impl Send for CephClient
impl Sync for CephClient
impl Unpin for CephClient
impl UnsafeUnpin for CephClient
impl UnwindSafe for CephClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.Source§impl<T> PipeAsRef for T
impl<T> PipeAsRef for T
Source§impl<T> PipeBorrow for T
impl<T> PipeBorrow for T
Source§impl<T> PipeDeref for T
impl<T> PipeDeref for T
Source§impl<T> PipeRef for T
impl<T> PipeRef for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&Self) -> R,
fn tap<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&Self) -> R,
Provides immutable access for inspection. Read more
Source§fn tap_dbg<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&Self) -> R,
fn tap_dbg<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&Self) -> R,
Calls
tap in debug builds, and does nothing in release builds.Source§fn tap_mut<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&mut Self) -> R,
fn tap_mut<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&mut Self) -> R,
Provides mutable access for modification. Read more
Source§fn tap_mut_dbg<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&mut Self) -> R,
fn tap_mut_dbg<F, R>(self, func: F) -> Selfwhere
F: FnOnce(&mut Self) -> R,
Calls
tap_mut in debug builds, and does nothing in release builds.Source§impl<T, U> TapAsRef<U> for Twhere
U: ?Sized,
impl<T, U> TapAsRef<U> for Twhere
U: ?Sized,
Source§fn tap_ref<F, R>(self, func: F) -> Self
fn tap_ref<F, R>(self, func: F) -> Self
Provides immutable access to the reference for inspection.
Source§fn tap_ref_dbg<F, R>(self, func: F) -> Self
fn tap_ref_dbg<F, R>(self, func: F) -> Self
Calls
tap_ref in debug builds, and does nothing in release builds.Source§fn tap_ref_mut<F, R>(self, func: F) -> Self
fn tap_ref_mut<F, R>(self, func: F) -> Self
Provides mutable access to the reference for modification.
Source§impl<T, U> TapBorrow<U> for Twhere
U: ?Sized,
impl<T, U> TapBorrow<U> for Twhere
U: ?Sized,
Source§fn tap_borrow<F, R>(self, func: F) -> Self
fn tap_borrow<F, R>(self, func: F) -> Self
Provides immutable access to the borrow for inspection. Read more
Source§fn tap_borrow_dbg<F, R>(self, func: F) -> Self
fn tap_borrow_dbg<F, R>(self, func: F) -> Self
Calls
tap_borrow in debug builds, and does nothing in release builds.Source§fn tap_borrow_mut<F, R>(self, func: F) -> Self
fn tap_borrow_mut<F, R>(self, func: F) -> Self
Provides mutable access to the borrow for modification.
Source§impl<T> TapDeref for T
impl<T> TapDeref for T
Source§fn tap_deref_dbg<F, R>(self, func: F) -> Self
fn tap_deref_dbg<F, R>(self, func: F) -> Self
Calls
tap_deref in debug builds, and does nothing in release builds.Source§fn tap_deref_mut<F, R>(self, func: F) -> Self
fn tap_deref_mut<F, R>(self, func: F) -> Self
Mutably dereferences
self for modification.