Struct ServiceRoot 

pub struct ServiceRoot<B: Bmc> {
    pub root: Arc<ServiceRoot>,
    /* private fields */
}

Represents ServiceRoot in the BMC model.

Fields

root: Arc<ServiceRoot>

Content of the root.

Implementations

impl<B: Bmc> ServiceRoot<B>

pub async fn new(bmc: Arc<B>) -> Result<Self, Error<B>>

Create a new service root.

Errors

Returns error if retrieving the root path via Redfish fails.

pub fn replace_bmc(self, bmc: Arc<B>) -> Self

Replace BMC in this root.

pub fn restrict_expand(self) -> Self

Restrict usage of expand.

pub fn vendor(&self) -> Option<Vendor<&str>>

The vendor or manufacturer associated with this Redfish service.

pub fn product(&self) -> Option<Product<&str>>

The product associated with this Redfish service.

pub fn redfish_version(&self) -> Option<RedfishVersion<'_>>

The vendor or manufacturer associated with this Redfish service.

pub async fn account_service( &self, ) -> Result<Option<AccountService<B>>, Error<B>>

Get the account service belonging to the BMC.

Returns Ok(None) when the BMC does not expose AccountService.

Errors

Returns error if retrieving account service data fails.

pub async fn chassis(&self) -> Result<Option<ChassisCollection<B>>, Error<B>>

Get chassis collection in BMC

Returns Ok(None) when the BMC does not expose Chassis.

Errors

Returns error if retrieving chassis collection data fails.

pub async fn systems(&self) -> Result<Option<SystemCollection<B>>, Error<B>>

Get computer system collection in BMC

Returns Ok(None) when the BMC does not expose Systems.

Errors

Returns error if retrieving system collection data fails.

pub async fn update_service(&self) -> Result<Option<UpdateService<B>>, Error<B>>

Get update service in BMC

Returns Ok(None) when the BMC does not expose UpdateService.

Errors

Returns error if retrieving update service data fails.

pub async fn event_service(&self) -> Result<Option<EventService<B>>, Error<B>>

Get event service in BMC

Returns Ok(None) when the BMC does not expose EventService.

Errors

Returns error if retrieving event service data fails.

pub async fn telemetry_service( &self, ) -> Result<Option<TelemetryService<B>>, Error<B>>

Get telemetry service in BMC

Returns Ok(None) when the BMC does not expose TelemetryService.

Errors

Returns error if retrieving telemetry service data fails.

pub async fn session_service( &self, ) -> Result<Option<SessionService<B>>, Error<B>>

Get session service in BMC

Returns Ok(None) when the BMC does not expose SessionService.

Errors

Returns error if retrieving session service data fails.

pub async fn managers(&self) -> Result<Option<ManagerCollection<B>>, Error<B>>

Get manager collection in BMC

Returns Ok(None) when the BMC does not expose Managers.

Errors

Returns error if retrieving manager collection data fails.

pub fn oem_hpe_ilo_service_ext( &self, ) -> Result<Option<HpeiLoServiceExt<B>>, Error<B>>

Get HPE OEM extension in service root

Returns Ok(None) when the BMC does not expose HPE extension.

Errors

Returns error if retrieving manager collection data fails.

Trait Implementations

impl<B: Clone + Bmc> Clone for ServiceRoot<B>

fn clone(&self) -> ServiceRoot<B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Bmc> Resource for ServiceRoot<B>

fn resource_ref(&self) -> &ResourceSchema

Required function. Must be implemented for Redfish resources.

fn id(&self) -> ResourceIdRef<'_>

Identifier of the resource.

fn name(&self) -> ResourceNameRef<'_>

Name of the resource.

fn description(&self) -> Option<ResourceDescriptionRef<'_>>

Description of the resource.

fn oem_id(&self) -> Option<OemIdentifier<&str>>

OEM identifier if present in the resource.

fn odata_id(&self) -> &ODataId

OData identifier of the resource.