# README
Client API
The client API is the interface between client and server gRPC applications and provides capabilities to manage storage and network hardware local to the storage nodes in addition to DAOS pools and services.
# Functions
GetConfig loads a configuration file from the path given, or from the default location if none is provided.
MockScanResp mocks scan results from scm and nvme for multiple servers.
NewConfiguration creates a new instance of the Configuration struct populated with defaults and default external interface.
NewConnect is a factory for Connect interface to operate over multiple clients.
StorageFormatRequest attempts to format nonvolatile storage devices on a remote server over gRPC.
# Constants
PoolRebuildStateBusy indicates that the rebuild process is in progress.
PoolRebuildStateDone indicates that the rebuild process has completed.
PoolRebuildStateIdle indicates that the rebuild process is idle.
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
AccessControlList is a structure for the access control list.
ClientBioResult is a container for output of BIO health query client requests.
ClientResult is a container for output of any type of client request.
ClientSmdResult is a container for output of SMD dev list query client requests.
ClientStateResult is a container for output of device state query requests.
Configuration contains all known configuration variables available to the client.
LeaderQueryReq contains the inputs for the leader query command.
LeaderQueryResp contains the status of the request and, if successful, the MS leader and set of replicas in the system.
ListPoolsReq contains the inputs for the list pools command.
ListPoolsResp contains the status of the request and, if successful, the list of pools in the system.
No description provided by the author
NvmeScanResult represents the result of scanning for SCM modules installed on a storage node.
PoolCreateReq struct contains request.
PoolCreateResp struct contains response.
PoolDeleteACLReq contains the input parameters for PoolDeleteACL.
PoolDeleteACLResp returns the updated ACL for the pool.
PoolDestroyReq struct contains request.
PoolDiscovery represents the basic discovery information for a pool.
PoolGetACLReq contains the input parameters for PoolGetACL.
PoolGetACLResp contains the output results for PoolGetACL.
PoolOverwriteACLReq contains the input parameters for PoolOverwriteACL.
PoolOverwriteACLResp returns the updated ACL for the pool.
No description provided by the author
No description provided by the author
No description provided by the author
PoolSetPropReq contains pool set-prop parameters.
PoolSetPropResp contains the response to a pool set-prop operation.
PoolUpdateACLReq contains the input parameters for PoolUpdateACL.
PoolUpdateACLResp returns the updated ACL for the pool.
No description provided by the author
ScmScanResult represents the result of scanning for SCM modules installed on a storage node and SCM namespaces.
StorageFormatReq encapsulated subsystem format parameters.
No description provided by the author
StorageScanReq encapsulated subsystem scan parameters.
StorageScanResp encapsulated subsystem results.
No description provided by the author
SystemQueryReq contains the inputs for the system query request.
SystemQueryResp contains the request response.
SystemStartReq contains the inputs for the system start request.
SystemStartResp contains the request response.
SystemStopReq contains the inputs for the system stop command.
SystemStopResp contains the request response.
# Interfaces
Connect is an external interface providing functionality across multiple connected clients (controllers).
Control interface provides connection handling capabilities.
ControllerFactory is an interface providing capability to connect clients.
External interface provides methods to support various os operations.
# Type aliases
Addresses is an alias for a slice of <ipv4/hostname>:<port> addresses.
No description provided by the author
NvmeScanResults maps NvmeScanResult structs to the addresses of remote servers identified by an address string.
No description provided by the author
ResultMap map client addresses to method call ClientResults.
No description provided by the author
No description provided by the author
No description provided by the author
ScmScanMap maps ScmModuleScanResult structs to the addresses of remote servers identified by an address string.
StorageFormatResults stores results of format operations on NVMe controllers and SCM mountpoints.