gRPC API Reference

Package: memory_appliance

Services

MemoryApplianceService

Service definition for the Memory Appliance.

RPCs

SendCommand

Request: SendCommandRequest (streamed)

Response: CommandResponse (streamed)

GetChassis

Request: (google.protobuf.Empty

Response: (Chassis

Message Types

SendCommandRequest

API to send a command to the memory appliance

Fields:

• header (optional MessageHeader)
• connect (ConnectStream)
• heartbeat (KeepAliveHeartbeat)
• reset_intrusion_sensor (ResetIntrusionSensorRequest)
• set_chassis_properties (SetChassisProperties)
• identify_chassis (IdentifyChassis)
• decommission_host (DecommissionHost)
• set_host_properties (SetComputerSystemProperties)
• get_tasks (GetTasks)
• clear_telemetry_metrics (ClearMetricReports)
• clear_telemetry_data (ClearTelemetryData)
• collect_telemetry_data (CollectTelemetryData)
• submit_metric_report (SubmitTestMetricReport)
• identify_omm (IdentifyOMM)
• restart_omm (RestartOMM)
• take_omm_offline (OfflineOMM)
• initialize_omm (InitializeOMM)
• set_virtual_pool_properties (SetVirtualPoolProperties)
• get_capacity_hints (GetCapacityHints)
• destroy_virtual_pool (DestroyVirtualPool)
• change_virtual_pool_capacity_or_bandwidth (ChangeVirtualPoolCapacityOrBandwidth)
• create_virtual_pool (CreateVirtualPool)
• get_memory_region_list (GetMemoryRegionList)
• create_maximum_capacity_virtual_pool (CreateMaximumCapacityVirtualPool)
• set_port_properties (SetPortProperties)
• enable_lane (EnableLane)
• disable_lane (DisableLane)
• train_lane (TrainLane)
• set_connection_properties (SetConnectionProperties)
• identify_memory (IdentifyMemory)
• enable_or_disable_memory (EnableOrDisableMemory)
• configure_photonic_adapter (ConfigurePhotonicAdapter)
• identify_photonic_adapter (IdentifyPhotonicAdapter)
• identify_fan (IdentifyFan)
• reset_sensor_metrics (ResetSensorMetrics)
• reset_power_supply (ResetPowerSupply)
• identify_power_supply (IdentifyPowerSupply)
• reset_manager_ethernet (ResetManagerEthernet)
• reset_manager_ethernet_to_factory_defaults (ResetManagerEthernetToFactoryDefaults)

ConnectStream

Fields:

• empty_payload (google.protobuf.Empty)

CommandResponse

The main response message for the SendCommand bidirectional stream.

Fields:

• message_header (optional ApplianceMessageHeader)
• heartbeat (KeepAliveHeartbeat)
• success (SendCommandSuccess)
• failure (SendCommandFailure)
• task_update (Task)
• tasks (TaskCollection)

SendCommandSuccess

Represents a successful outcome of a SendCommand operation.

Fields:

• update (ApplianceState)
• chassis_update (Chassis)
• software_update_progress (SimpleUpdateProgress)
• new_ssh_key (NewSSHIdentityPublicKey)
• omm_update (OpticalMemoryModule)
• virtual_pool_update (VirtualPool)
• memory_region_update (MemoryRegion)
• port_update (Port)
• photonic_lanes_update (PhotonicLanes)
• connection_update (Connection)
• memory (Memory)
• photonic_adapter (PhotonicAdapter)
• fan (Fan)
• sensor (Sensor)
• power_supply (PowerSupply)
• ethernet_interface (EthernetInterface)

TaskCollection

Fields:

• task (repeated Task)

SendCommandFailure

Represents a failed outcome of a SendCommand operation.

Fields:

• reason (FailureReason)
• error_code (uint32)

Example Usage

#![allow(unused)]
fn main() {
use smartforge::generated::memory_appliance::*;

let mut client = MemoryApplianceServiceClient::connect("http://127.0.0.1:50051").await?;
}

For complete examples, see the grpc_client binary in src/bin/grpc_client.rs.