package
10.0.96+incompatible
Repository: https://github.com/libopenstorage/openstorage.git
Documentation: pkg.go.dev

# README

OpenStorage API usage

Any storage product that uses the openstorage API can be managed via this API. Below are some examples of using this API.

Enumerate nodes in a cluster


import (
    ...
    
    "github.com/libopenstorage/gossip/types"
    "github.com/libopenstorage/openstorage/api"
    "github.com/libopenstorage/openstorage/api/client/cluster"
)

type myapp struct {
    manager cluster.Cluster
}

func (c *myapp) init() {
    // Choose the default version.
    // Leave the host blank to use the local UNIX socket, or pass in an IP and a port at which the server is listening on.
    clnt, err := cluster.NewClusterClient("", cluster.APIVersion)
    if err != nil {
        fmt.Printf("Failed to initialize client library: %v\n", err)
        os.Exit(1)
    }
    c.manager = cluster.ClusterManager(clnt)
}

func (c *myapp) listNodes() {
    cluster, err := c.manager.Enumerate()
    if err != nil {
        cmdError(context, fn, err)
        return
    }
    
    // cluster is now a hashmap of nodes... do something useful with it:
    for _, n := range cluster.Nodes {
    
     }
}

Inspect a volume in a cluster


import (
    ...
    
    "github.com/libopenstorage/openstorage/api"
    volumeclient "github.com/libopenstorage/openstorage/api/client/volume"
    "github.com/libopenstorage/openstorage/volume"
)

type myapp struct {
    volDriver volume.VolumeDriver
}

func (c *myapp) init() {
    // Choose the default version.
    // Leave the host blank to use the local UNIX socket, or pass in an IP and a port at which the server is listening on.
    clnt, err := volumeclient.NewDriverClient("", v.name, volume.APIVersion)
    if err != nil {
        fmt.Printf("Failed to initialize client library: %v\n", err)
        os.Exit(1)
    }
    v.volDriver = volumeclient.VolumeDriver(clnt)
}

func (c *myapp) inspect(id string) {
    stats, err := v.volDriver.Stats(id, true)
    if err != nil {
        return
    }
    
    // stats is an object that has various volume properties and statistics.
}

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
Package mock is a generated GoMock package.
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
CosTypeSimpleValueOf returns the string format of CosType.
DriverTypeSimpleValueOf returns the string format of DriverType.
FSTypeSimpleValueOf returns the string format of FSType.
GetAllEnumInfo returns an EnumInfo for every proto enum.
GraphDriverChangeTypeSimpleValueOf returns the string format of GraphDriverChangeType.
IoProfileSimpleValueOf returns the string format of IoProfile.
IsAdminByContext checks if the context userInfo contains admin privileges.
IsAdminByUser returns true if the user is an ownership admin, meaning, that they belong to any group.
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OwnershipSetUsernameFromContext is used to create a new ownership object for a volume.
ParseProxyEndpoint parses the proxy endpoint and returns the proxy protocol and the endpoint.
ProxyProtocolSimpleValueOf returns the string format of ProxyProtocol.
RegisterOpenStorageAlertsHandler registers the http handlers for service OpenStorageAlerts to "mux".
RegisterOpenStorageAlertsHandlerClient registers the http handlers for service OpenStorageAlerts to "mux".
RegisterOpenStorageAlertsHandlerFromEndpoint is same as RegisterOpenStorageAlertsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageAlertsHandlerServer registers the http handlers for service OpenStorageAlerts to "mux".
No description provided by the author
RegisterOpenStorageBucketHandler registers the http handlers for service OpenStorageBucket to "mux".
RegisterOpenStorageBucketHandlerClient registers the http handlers for service OpenStorageBucket to "mux".
RegisterOpenStorageBucketHandlerFromEndpoint is same as RegisterOpenStorageBucketHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageBucketHandlerServer registers the http handlers for service OpenStorageBucket to "mux".
No description provided by the author
RegisterOpenStorageCloudBackupHandler registers the http handlers for service OpenStorageCloudBackup to "mux".
RegisterOpenStorageCloudBackupHandlerClient registers the http handlers for service OpenStorageCloudBackup to "mux".
RegisterOpenStorageCloudBackupHandlerFromEndpoint is same as RegisterOpenStorageCloudBackupHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageCloudBackupHandlerServer registers the http handlers for service OpenStorageCloudBackup to "mux".
No description provided by the author
RegisterOpenStorageClusterDomainsHandler registers the http handlers for service OpenStorageClusterDomains to "mux".
RegisterOpenStorageClusterDomainsHandlerClient registers the http handlers for service OpenStorageClusterDomains to "mux".
RegisterOpenStorageClusterDomainsHandlerFromEndpoint is same as RegisterOpenStorageClusterDomainsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageClusterDomainsHandlerServer registers the http handlers for service OpenStorageClusterDomains to "mux".
No description provided by the author
RegisterOpenStorageClusterHandler registers the http handlers for service OpenStorageCluster to "mux".
RegisterOpenStorageClusterHandlerClient registers the http handlers for service OpenStorageCluster to "mux".
RegisterOpenStorageClusterHandlerFromEndpoint is same as RegisterOpenStorageClusterHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageClusterHandlerServer registers the http handlers for service OpenStorageCluster to "mux".
RegisterOpenStorageClusterPairHandler registers the http handlers for service OpenStorageClusterPair to "mux".
RegisterOpenStorageClusterPairHandlerClient registers the http handlers for service OpenStorageClusterPair to "mux".
RegisterOpenStorageClusterPairHandlerFromEndpoint is same as RegisterOpenStorageClusterPairHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageClusterPairHandlerServer registers the http handlers for service OpenStorageClusterPair to "mux".
No description provided by the author
No description provided by the author
RegisterOpenStorageCredentialsHandler registers the http handlers for service OpenStorageCredentials to "mux".
RegisterOpenStorageCredentialsHandlerClient registers the http handlers for service OpenStorageCredentials to "mux".
RegisterOpenStorageCredentialsHandlerFromEndpoint is same as RegisterOpenStorageCredentialsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageCredentialsHandlerServer registers the http handlers for service OpenStorageCredentials to "mux".
No description provided by the author
RegisterOpenStorageDiagsHandler registers the http handlers for service OpenStorageDiags to "mux".
RegisterOpenStorageDiagsHandlerClient registers the http handlers for service OpenStorageDiags to "mux".
RegisterOpenStorageDiagsHandlerFromEndpoint is same as RegisterOpenStorageDiagsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageDiagsHandlerServer registers the http handlers for service OpenStorageDiags to "mux".
No description provided by the author
RegisterOpenStorageFilesystemCheckHandler registers the http handlers for service OpenStorageFilesystemCheck to "mux".
RegisterOpenStorageFilesystemCheckHandlerClient registers the http handlers for service OpenStorageFilesystemCheck to "mux".
RegisterOpenStorageFilesystemCheckHandlerFromEndpoint is same as RegisterOpenStorageFilesystemCheckHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageFilesystemCheckHandlerServer registers the http handlers for service OpenStorageFilesystemCheck to "mux".
No description provided by the author
RegisterOpenStorageFilesystemTrimHandler registers the http handlers for service OpenStorageFilesystemTrim to "mux".
RegisterOpenStorageFilesystemTrimHandlerClient registers the http handlers for service OpenStorageFilesystemTrim to "mux".
RegisterOpenStorageFilesystemTrimHandlerFromEndpoint is same as RegisterOpenStorageFilesystemTrimHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageFilesystemTrimHandlerServer registers the http handlers for service OpenStorageFilesystemTrim to "mux".
No description provided by the author
RegisterOpenStorageIdentityHandler registers the http handlers for service OpenStorageIdentity to "mux".
RegisterOpenStorageIdentityHandlerClient registers the http handlers for service OpenStorageIdentity to "mux".
RegisterOpenStorageIdentityHandlerFromEndpoint is same as RegisterOpenStorageIdentityHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageIdentityHandlerServer registers the http handlers for service OpenStorageIdentity to "mux".
No description provided by the author
RegisterOpenStorageJobHandler registers the http handlers for service OpenStorageJob to "mux".
RegisterOpenStorageJobHandlerClient registers the http handlers for service OpenStorageJob to "mux".
RegisterOpenStorageJobHandlerFromEndpoint is same as RegisterOpenStorageJobHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageJobHandlerServer registers the http handlers for service OpenStorageJob to "mux".
No description provided by the author
RegisterOpenStorageMigrateHandler registers the http handlers for service OpenStorageMigrate to "mux".
RegisterOpenStorageMigrateHandlerClient registers the http handlers for service OpenStorageMigrate to "mux".
RegisterOpenStorageMigrateHandlerFromEndpoint is same as RegisterOpenStorageMigrateHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageMigrateHandlerServer registers the http handlers for service OpenStorageMigrate to "mux".
No description provided by the author
RegisterOpenStorageMountAttachHandler registers the http handlers for service OpenStorageMountAttach to "mux".
RegisterOpenStorageMountAttachHandlerClient registers the http handlers for service OpenStorageMountAttach to "mux".
RegisterOpenStorageMountAttachHandlerFromEndpoint is same as RegisterOpenStorageMountAttachHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageMountAttachHandlerServer registers the http handlers for service OpenStorageMountAttach to "mux".
No description provided by the author
RegisterOpenStorageNodeHandler registers the http handlers for service OpenStorageNode to "mux".
RegisterOpenStorageNodeHandlerClient registers the http handlers for service OpenStorageNode to "mux".
RegisterOpenStorageNodeHandlerFromEndpoint is same as RegisterOpenStorageNodeHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageNodeHandlerServer registers the http handlers for service OpenStorageNode to "mux".
No description provided by the author
RegisterOpenStorageObjectstoreHandler registers the http handlers for service OpenStorageObjectstore to "mux".
RegisterOpenStorageObjectstoreHandlerClient registers the http handlers for service OpenStorageObjectstore to "mux".
RegisterOpenStorageObjectstoreHandlerFromEndpoint is same as RegisterOpenStorageObjectstoreHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageObjectstoreHandlerServer registers the http handlers for service OpenStorageObjectstore to "mux".
No description provided by the author
RegisterOpenStoragePolicyHandler registers the http handlers for service OpenStoragePolicy to "mux".
RegisterOpenStoragePolicyHandlerClient registers the http handlers for service OpenStoragePolicy to "mux".
RegisterOpenStoragePolicyHandlerFromEndpoint is same as RegisterOpenStoragePolicyHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStoragePolicyHandlerServer registers the http handlers for service OpenStoragePolicy to "mux".
No description provided by the author
RegisterOpenStoragePoolHandler registers the http handlers for service OpenStoragePool to "mux".
RegisterOpenStoragePoolHandlerClient registers the http handlers for service OpenStoragePool to "mux".
RegisterOpenStoragePoolHandlerFromEndpoint is same as RegisterOpenStoragePoolHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStoragePoolHandlerServer registers the http handlers for service OpenStoragePool to "mux".
No description provided by the author
RegisterOpenStorageRoleHandler registers the http handlers for service OpenStorageRole to "mux".
RegisterOpenStorageRoleHandlerClient registers the http handlers for service OpenStorageRole to "mux".
RegisterOpenStorageRoleHandlerFromEndpoint is same as RegisterOpenStorageRoleHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageRoleHandlerServer registers the http handlers for service OpenStorageRole to "mux".
No description provided by the author
RegisterOpenStorageSchedulePolicyHandler registers the http handlers for service OpenStorageSchedulePolicy to "mux".
RegisterOpenStorageSchedulePolicyHandlerClient registers the http handlers for service OpenStorageSchedulePolicy to "mux".
RegisterOpenStorageSchedulePolicyHandlerFromEndpoint is same as RegisterOpenStorageSchedulePolicyHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageSchedulePolicyHandlerServer registers the http handlers for service OpenStorageSchedulePolicy to "mux".
No description provided by the author
RegisterOpenStorageVolumeHandler registers the http handlers for service OpenStorageVolume to "mux".
RegisterOpenStorageVolumeHandlerClient registers the http handlers for service OpenStorageVolume to "mux".
RegisterOpenStorageVolumeHandlerFromEndpoint is same as RegisterOpenStorageVolumeHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageVolumeHandlerServer registers the http handlers for service OpenStorageVolume to "mux".
No description provided by the author
ScanPolicyActioinValueof returns value of string.
ScanPolicyTriggerValueof returns value of string.
No description provided by the author
No description provided by the author
StatusKindMapLength used only for unit testing.
StatusSimpleValueOf returns the string format of Status.
No description provided by the author
No description provided by the author
VolumeActionParamSimpleValueOf returns the string format of VolumeAction.
VolumeStateSimpleValueOf returns the string format of VolumeState.
VolumeStatusSimpleValueOf returns the string format of VolumeStatus.

# Constants

AdminGroup is the value that can be set in the token claims Group which gives the user access to any resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Default, disallow uncredentialed access to the backend storage.
Read only, uncredentialed users can call ListBucket and GetObject.
Read/Write, uncredentialed users can read objects as well as PutObject.
No description provided by the author
Write only, uncredentialed users can only call PutObject.
Attached and available externally.
Attached but only available internally.
Switching from External to Internal.
AutoAggregation value indicates driver to select aggregation level.
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
Invalid includes Failed, Stopped, and Aborted used as filter to enumerate cloud backups.
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
Migrate all volumes in the cluster.
Migrate a single volume.
Migrate a group of volumes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Default pairing mode.
Paired for DisasterRecovery.
Paired for one-time migration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Done indicates diags collection has finished.
Failed indicates diags collection has failed.
Pending indicates the diags collection is pending and hasn't started.
Running indicates diags collection is actively running.
Unspecified means uninitialized or unknown state.
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
This specifies that the rule is preferred and can be best effort.
This specifies that the rule is required and must be strictly enforced.
Custom the volume is exported over custom interface.
Invalid uninitialized value.
ISCSI the volume is exported over ISCSI.
NFS the volume is exported over NFS.
PXD the volume is exported over Portworx block interface.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
fastpath activated and enabled.
fastpath error'd, possible stuck failure.
fastpath inactive.
fastpath operation setup in progress.
backward compatible state.
fastpath unsupported, disabled.
FilesystemCheck operation completed successfully.
FilesystemCheck operation failed due to internal error.
FilesystemCheck operation is in progress.
FilesystemCheck operation not running for the specified volume.
FilesystemCheck operation started for the specified volume.
FilesystemCheck operation was stopped by the user.
Filesystem Check operation is an unknown state.
filesystem is a healthy.
filesystem has errors, these cannot be fixed automatically, user needs to review the reported errors and take appropriate action.
filesystem has errors, but can be fixed safely.
filesystem health status is unknown.
Filesystem Trim operation completed successfully for the specified volume.
Filesystem Trim operation failed due to internal error for the specified volume.
Filesystem Trim operation is in progress for the specified volume.
Filesystem Trim operation is not running for the specified volume.
Filesystem Trim operation started for the specified volume.
Filesystem Trim operation was stopped by the user for the specified volume.
Filesystem Trim operation is an unknown state.
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
when we are running on physical hardware.
When we do not know the machine type alsp the default.
when we are running on virtual machine.
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
Cancelled indicates job is cancelled.
Job for transferring cloud drives between nodes.
Job for collecting diags from the cluster nodes.
Done indicates job has finished processing.
Job for draining volume attachments.
Failed indicates job has failed.
None.
Paused indicates job is paused.
Pending indicates job is still pending and has not started work.
Running indicates job is actively running.
Unspecified.
Unspecified.
DoesNotExist means the 'key' should NOT exist.
Exists means the 'key' should just exist regardless of the value.
Gt means the 'key' should be greater than the value(s).
In means the value for 'key' should be in one of the given value(s).
Lt means the 'key' should be less than the value(s).
NotIn means the value for 'key' should NOT be in one of the given value(s).
Strings for VolumeSpec.
Perform a force_detach during detach operation.
No description provided by the author
No description provided by the author
OptBackupSchedUUID is the UUID of the backup-schedule.
OptBkupOpState is the desired operational state (stop/pause/resume) of backup/restore.
OptCatalogMaxDepth query parameter used to limit the depth we return.
OptVolumeSubFolder query parameter used to catalog a particular path inside a volume.
OptCloudBackupID is the backID in the cloud.
OptCloudBackupIgnoreCreds ignores credentials for incr backups.
OptConfigLabel query parameter used to lookup volume by set of labels.
OptCredAccKey for s3.
OptOptCredAzureAccountKey is the accountkey for azure as the cloud provider.
OptCredAzureAccountName is the account name for azure as the cloud provider.
OptCredBucket is the optional bucket name.
OptCredDisablePathStyle does not enforce path style for s3.
OptCredDisableSSL indicated if SSL should be disabled.
OptCredEncrKey is the key used to encrypt data.
OptCredEndpoint indicate the cloud endpoint.
OptCredGoogleJsonKey for google cloud.
OptCredGoogleProjectID projectID for google cloud.
OptCredIAMPolicy if "true", indicates IAM creds to be used.
OptCredName indicates unique name of credential.
OptCredNFSMountOpts is the optional mount options.
OptCredNFSServer is the server address for NFS access.
OptCredNFSSubPath is the sub-path for objects.
OptCredNFSTimeout is the optional timeout value.
Credential ownership key in params.
OptCredProxy proxy key in params.
OptCredRegion indicates the region for s3.
OptCredSecretKey for s3.
OptCredStorageClass indicates the storage class to be used for puts allowed values are STANDARD, STANDARD_IA,ONEZONE_IA, REDUCED_REDUNDANCY.
OptCredType indicates type of credential.
OptCredUUID is the UUID of the credential.
OptCumulative query parameter used to request cumulative stats.
OptLabel query parameter used to lookup volume by set of labels.
OptName query parameter used to lookup volume by name.
OptQuiesceID query parameter use for quiesce.
OptRemoteCredUUID is the UUID of the remote cluster credential.
OptSnapID query parameter used to lookup snapshot by ID.
OptSrcVolID is the source volume ID of the backup.
OptTimeout query parameter used to indicate timeout seconds.
OptVolumeService query parameter used to request background volume services.
OptVolumeID query parameter used to lookup volume by ID.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Administrator access.
Read access only and cannot affect the resource.
Write access and can affect the resource.
Invalid uninitialized value.
NFS indicates that the external data source is NFS and the volume will be reflected over NFS protocol.
PURE_BLOCK indicates that the external data source is a pure_block volume.
PURE_FILE indicates that the external data source is a pure_file volume.
PXD indicates that the external data source is a Portworx block volume.
S3 indicates that the external data source is an object store.
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
Default: whateever was cloudbakup's option for the parameter.
No description provided by the author
No description provided by the author
Allowed storage classes s3.
Allowed storage classes s3.
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
Beongs to this cluster.
not this.
Unknown.
Backup.
Restore.
Unknown.
Pause the backup or restore.
Resume the backup or restore.
Stop a backup or restore.
Unknown state.
Aborted.
Active.
Done.
Failed.
Invalid, used by enumerate, includes failed, stopped and aborted.
Not started.
Paused.
Queued.
Stopped.
Unknown.
gRPC root path used to extract service and API information.
Alert enumeration.
Cloud backup of volumes management.
Cluster management.
Cluster Pair service.
Credentials management.
Migrate service.
Mount/Attach Support.
Node management.
Object Storage management.
Role service.
Schedule policy management.
StoragePolicy Service.
Unknown service.
Volume management.
Operation failed.
Operation is in progress.
Operation pending.
Resize operation.
Operation is successful.
Add a new drive to resize the pool.
Automatically pick the optimum resize operation type.
Resize existing drives to resize the pool.
Friday.
Monday.
Saturday.
Sunday.
Thursday.
Tuesday.
Wednesday.
SDK version major value of this specification.
SDK version minor value of this specification.
Must be set in the proto file; ignore.
SDK version patch value of this specification.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Fail over to the new NFS server quickly.
Give the old NFS server more time to come back up before triggering the failover.
Unspecified.
Export the shared4 service on an internal cluster IP.
Expose the sharedv4 service on cloud provider's load balancer.
Export the sharedv4 service on each Node's IP.
Do not use sharedv4 service feature.
Unspecified.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
SpecBestEffortLocationProvisioning default is false.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
spec key cannot change due to parity with existing PSO storageclasses.
Strings for VolumeSpec.
Strings for VolumeSpec.
SpecForceUnsuppportedFsType is of type boolean and if true it sets the VolumeSpec.force_unsupported_fs_type.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
SpecMatchSrcVolProvision defaults to false.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Add statuses before MAX and update the number for MAX.
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
StatusSeverityHigh indicates a BAD status.
StatusSeverityLow indicates an OK status.
StatusSeverityMedium indicates a status which is in transition from OK to BAD or vice versa.
Magnetic spinning disk.
NVME disk.
SSD disk.
Node is secured with authentication and authorization.
Node is secured, but in the process of removing security.
Node is unsecure.
Security status type is unknown.
Strings for VolumeSpec.
Indicates new replica was added.
Indicates existing replica was removed.
Cancelled indicates job is cancelled.
Done indicates job has finished processing.
Paused indicates job is paused.
Pending indicates job is still pending and has not started work.
Running indicates job is actively running.
AbsolutePercent indicates absolute percent comparison.
DeltaMeanPercent indicates mean percent comparison threshold.
ProvisionSpace indicates rebalance for provisioned space.
UsedSpace indicates rebalance for used space.
summary for unbalanced pools.
summary for unbalanced provisioned space.
summary for unbalanced used space.
summary for unbalanced volumes.
Api clientserver Constants.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
No description provided by the author
Maps to the boolean value false.
Maps to the boolean value true.
Policy will make sure the value must be equal.
Policy will make sure the requested value must be less than or equal.
Policy will make sure the requested value must be greater than or equal.
Volume is attached to container.
Volume is ready to be assigned to a container.
Volume is deleted, it will remain in this state while resources are asynchronously reclaimed.
Volume is detached but associated with a container.
Volume detach is in progress.
Volume is in error state.
No description provided by the author
Volume is transitioning to new state.
Volume is undergoing restore.
Volume is trying to be detached.
Volume is up but with degraded performance In a RAID group, this may indicate a problem with one or more drives.
Volume is in fail mode.
No description provided by the author
Volume is not present.
Volume is healthy.
Enable on-demand copy-on-write on the volume.
Value is uninitialized or unknown.

# Variables

Enum value maps for AlertActionType.
Enum value maps for AlertActionType.
Enum value maps for AnonymousBucketAccessMode.
Enum value maps for AnonymousBucketAccessMode.
Enum value maps for AttachState.
Enum value maps for AttachState.
Enum value maps for CloudMigrate_OperationType.
Enum value maps for CloudMigrate_OperationType.
Enum value maps for CloudMigrate_Stage.
Enum value maps for CloudMigrate_Stage.
Enum value maps for CloudMigrate_Status.
Enum value maps for CloudMigrate_Status.
Enum value maps for ClusterPairMode_Mode.
Enum value maps for ClusterPairMode_Mode.
Enum value maps for CosType.
Enum value maps for CosType.
Enum value maps for DiagsCollectionStatus_State.
Enum value maps for DiagsCollectionStatus_State.
Enum value maps for DriverType.
Enum value maps for DriverType.
Enum value maps for EnforcementType.
Enum value maps for EnforcementType.
Enum value maps for ExportProtocol.
Enum value maps for ExportProtocol.
Enum value maps for FastpathProtocol.
Enum value maps for FastpathProtocol.
Enum value maps for FastpathStatus.
Enum value maps for FastpathStatus.
No description provided by the author
Enum value maps for FilesystemCheck_FilesystemCheckStatus.
Enum value maps for FilesystemCheck_FilesystemCheckStatus.
Enum value maps for FilesystemHealthStatus.
Enum value maps for FilesystemHealthStatus.
Enum value maps for FilesystemTrim_FilesystemTrimStatus.
Enum value maps for FilesystemTrim_FilesystemTrimStatus.
Enum value maps for FSType.
Enum value maps for FSType.
Enum value maps for GraphDriverChangeType.
Enum value maps for GraphDriverChangeType.
Enum value maps for HardwareType.
Enum value maps for HardwareType.
Enum value maps for IoProfile.
Enum value maps for IoProfile.
Enum value maps for Job_State.
Enum value maps for Job_State.
Enum value maps for Job_Type.
Enum value maps for Job_Type.
Enum value maps for LabelSelectorRequirement_Operator.
Enum value maps for LabelSelectorRequirement_Operator.
Enum value maps for OperationFlags.
Enum value maps for OperationFlags.
Enum value maps for Ownership_AccessType.
Enum value maps for Ownership_AccessType.
Enum value maps for ProxyProtocol.
Enum value maps for ProxyProtocol.
Enum value maps for ResourceType.
Enum value maps for ResourceType.
Enum value maps for RestoreParamBoolType.
Enum value maps for RestoreParamBoolType.
Enum value maps for ScanPolicy_ScanAction.
Enum value maps for ScanPolicy_ScanAction.
Enum value maps for ScanPolicy_ScanTrigger.
Enum value maps for ScanPolicy_ScanTrigger.
Enum value maps for SdkCloudBackupClusterType.
Enum value maps for SdkCloudBackupClusterType.
Enum value maps for SdkCloudBackupOpType.
Enum value maps for SdkCloudBackupOpType.
Enum value maps for SdkCloudBackupRequestedState.
Enum value maps for SdkCloudBackupRequestedState.
Enum value maps for SdkCloudBackupStatusType.
Enum value maps for SdkCloudBackupStatusType.
Enum value maps for SdkServiceCapability_OpenStorageService_Type.
Enum value maps for SdkServiceCapability_OpenStorageService_Type.
Enum value maps for SdkStoragePool_OperationStatus.
Enum value maps for SdkStoragePool_OperationStatus.
Enum value maps for SdkStoragePool_OperationType.
Enum value maps for SdkStoragePool_OperationType.
Enum value maps for SdkStoragePool_ResizeOperationType.
Enum value maps for SdkStoragePool_ResizeOperationType.
Enum value maps for SdkTimeWeekday.
Enum value maps for SdkTimeWeekday.
Enum value maps for SdkVersion_Version.
Enum value maps for SdkVersion_Version.
Enum value maps for SeverityType.
Enum value maps for SeverityType.
Enum value maps for Sharedv4FailoverStrategy_Value.
Enum value maps for Sharedv4FailoverStrategy_Value.
Enum value maps for Sharedv4ServiceSpec_ServiceType.
Enum value maps for Sharedv4ServiceSpec_ServiceType.
Enum value maps for Status.
Enum value maps for Status.
Enum value maps for StorageMedium.
Enum value maps for StorageMedium.
Enum value maps for StorageNode_SecurityStatus.
Enum value maps for StorageNode_SecurityStatus.
Enum value maps for StorageRebalanceAudit_StorageRebalanceAction.
Enum value maps for StorageRebalanceAudit_StorageRebalanceAction.
Enum value maps for StorageRebalanceJobState.
Enum value maps for StorageRebalanceJobState.
Enum value maps for StorageRebalanceTriggerThreshold_Metric.
Enum value maps for StorageRebalanceTriggerThreshold_Metric.
Enum value maps for StorageRebalanceTriggerThreshold_Type.
Enum value maps for StorageRebalanceTriggerThreshold_Type.
Enum value maps for StorageRebalanceWorkSummary_Type.
Enum value maps for StorageRebalanceWorkSummary_Type.
Enum value maps for VolumeActionParam.
Enum value maps for VolumeActionParam.
Enum value maps for VolumeSpecPolicy_PolicyOp.
Enum value maps for VolumeSpecPolicy_PolicyOp.
Enum value maps for VolumeState.
Enum value maps for VolumeState.
Enum value maps for VolumeStatus.
Enum value maps for VolumeStatus.
Enum value maps for Xattr_Value.
Enum value maps for Xattr_Value.

# Structs

Active Request.
Active Requests.
Alert is a structure that represents an alert object.
Alerts is an array of Alert objects.
Defines the bucket access credential object.
Defines a request to create a bucket.
Defines a response to the creation of a bucket.
Defines the request to delete a bucket.
Empty response.
Defines a request to grant access to the bucket.
Defines a response to the creation of a bucket.
Defines the request to revoke access to the bucket.
Empty response.
Provides details on exclusive and shared storage used by snapshot/volume specifically for copy-on-write(COW) snapshots.
Defines the response for CapacityUsage request.
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
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
Callers must read the existing schedule and modify required fields.
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
Request to stop a cloud migration.
No description provided by the author
No description provided by the author
Request to start a cloud migration.
Response to start a cloud migration.
Request for cloud migration operation status.
Response with a status of the cloud migration operations.
Cluster represents the state of the cluster.
Used to send a request to create a cluster pair.
Response for a pair request.
Response to get a cluster pair.
Information about a cluster pair.
No description provided by the author
Used to process a pair request from a remote cluster.
Response after a pairing has been processed.
Response to enumerate all the cluster pairs.
Response to get the cluster token.
ClusterResponse specifies a response that gets returned when requesting the cluster.
No description provided by the author
CredCreateRequest is the input for CredCreate command.
CredCreateResponse is returned for CredCreate command.
CredUpdateRequest is the input for CredsUpdate command.
No description provided by the author
DiagsNodeSelector allows selecting nodes for diags collection User can select NodeLabelSelector AND/OR NodeIDs.
DiagsVolumeSelector allows selecting volumes for diags collection User can select VolumeLabelSelector AND/OR VolumeIDs.
DrainAttachments summary of the volumes whose attachments need to be drained from a node.
ExportSpec defines how the volume is exported..
FastpathConfig part of volume.
No description provided by the author
No description provided by the author
No description provided by the author
FluentDConfig describes ip and port of a fluentdhost.
FstrimVolUsageInfo.
GraphDriverChanges represent a list of changes between the filesystem layers specified by the ID and Parent.
Group represents VolumeGroup / namespace All volumes in the same group share this object.
GroupSnapCreateRequest specifies a request to create a snapshot of given group.
GroupSnapCreateRequest specifies a response that get's returned when creating a group snapshot.
IoStrategy defines how I/O should be performed to backing storage media.
IoThrottle defines IO throttle limits for a volume read_iops : maximum read iops this volume is allowed write_iops : maximum write iops this volume is allowed read_bw_mbytes : maximum read bandwidth this volume is allowed in MegaBytes write_bw_mbytes : maximum write bandwidth this volume is allowed in MegaBytes.
Job is a generic job object that can encapsulate other messages which follow the job framework of APIs.
No description provided by the author
No description provided by the author
No description provided by the author
JobAudit is an audit entry for a job describing the different operations performed as a part of the job.
JobSummary provides a summary of a job.
JobWorkSummary describes an action taken while performing the hob.
No description provided by the author
LabelSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.
Locate response would be used to return a set of mounts and/or Container IDs and their mount paths.
MountOptions defines the mount options with which a volume is mounted.
NFSProxySpec is the spec for proxying an NFS share.
Node describes the state of a node.
Options for draining volume attachment from a node.
NodeDrainAttachmentsJob describe a job to drain volume attachments from a node.
ObjectstoreInfo is a structure that has current objectstore info.
Ownership information for resource.
No description provided by the author
PublicAccessControl allows assigning public ownership.
ProxySpec defines how this volume will reflect an external data source.
PureBlockSpec is the spec for proxying a volume on pure_block backends.
PureFileSpec is the spec for proxying a volume on pure_file backends.
PXDProxySpec is the spec for proxying a Portworx volume.
Purges the RelaxedReclaim queue.
No description provided by the author
ReplicaSet set of machine IDs (nodes) to which part of this volume is erasure coded - for clustered storage arrays.
No description provided by the author
No description provided by the author
No description provided by the author
RestoreSpec allows some of the restore volume properties of to be modified while restoring the cloud baackup.
RuntimeStateMap is a list of name value mapping of driver specific runtime information.
S3ProxySpec is the spec for proxying an external object store.
ScanPolicy defines when a filesystem check is triggered and what action to take User can specify *one* of the following valid policies 1.
SchedulerTopology defines the topology information of the storage node in scheduler context.
SdkAlertsAlertTypeQuery queries for alerts using alert type and it requires that resource type be provided as well.
SdkAlertsCountSpan to store count range information.
SdkAlertsDeleteRequest is a request message to delete alerts.
SdkAlertsDeleteResponse is empty.
SdkAlertsEnumerateRequest is a request message to enumerate alerts.
SdkAlertsEnumerateResponse is a list of alerts.
SdkAlertsOption contains options for filtering alerts.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SdkAlertsQuery is one of the query types and a list of options.
No description provided by the author
No description provided by the author
No description provided by the author
SdkAlertsResourceIdQuery queries for alerts using resource id and it requires that both alert type and resource type be provided as well.
SdkAlertsResourceTypeQuery queries for alerts using only resource id.
SdkAlertsTimeSpan to store time window information.
SdkAutoFSTrimPopRequest defines the request to pop a volume to autofstrim queue.
SdkAutoFSTrimPopResponse defines the response to pop a volume to autofstrim queue.
SdkAutoFSTrimPushRequest defines the request to push a volume to autofstrim queue.
SdkAutoFSTrimPushResponse defines the response to push a volume to autofstrim queue.
SdkAutoFSTrimStatusRequest defines a request to get status of autofs trim operation.
SdkAutoFSTrimStatusResponse defines the response for a SdkAutoFSTrimStatusRequest.
SdkAutoFSTrimUsageRequest defines a request to get status of autofs trim operation.
SdkAutoFSTrimUsageResponse defines the response for a SdkAutoFSTrimUsageRequest.
Defines credentials for Aws/S3 endpoints.
Defines the response for AWS/S3 credentials.
Defines credentials for Azure.
Defines the response for Azure credentials.
Defines a request to get catalog of a backup stored by a cloud provider.
Defines a response containing the contents of a backup stored by a cloud provider.
Defines a request to create a backup of a volume to the cloud.
Empty response.
Defines a request to delete all the backups stored by a cloud provider for a specified volume.
Empty response.
Defines a request to delete a single backup stored by a cloud provider.
Empty response.
Defines a request to list the backups stored by a cloud provider.
Defines a response which lists all the backups stored by a cloud provider.
Defines a request to create a group backup of a group to the cloud.
Empty response.
SdkCloudBackupHistoryItem contains information about a backup for a specific volume.
Defines a request to retrieve the history of the backups for a specific volume to a cloud provider.
Defines a response containing a list of history of backups to a cloud provider.
SdkCloudBackupInfo has information about a backup stored by a cloud provider.
Defines a request to restore a volume from an existing backup stored by a cloud provider.
Defines a response when restoring a volume from a backup stored by a cloud provider.
Defines a request to create a schedule for volume backups to a cloud provider.
Defines a response containing the id of a schedule for a volume backup to a cloud provider.
Defines a request to delete a backup schedule.
Empty response.
Empty request.
Defines a response containing a map listing the schedules for volume backups to a cloud provider.
SdkCloudBackupScheduleInfo describes a schedule for volume backups to a cloud provider.
Defines a request to update a schedule for volume backups to a cloud provider.
Empty response.
Defines a request to retrieve the size of the volume for the specificed volume.
Defines a response containing the size of the volume.
Defines a request to change the state of a backup or restore to or from a cloud provider.
Empty response.
SdkCloudBackupStatus defines the status of a backup stored by a cloud provider.
Defines a request to retrieve the status of a backup or restore for a specified volume.
Defines a response containing the status of the backups for a specified volume.
Defines a request to stop a cloud migration.
Empty Response.
Defines a migration request.
No description provided by the author
Defines a migration request for all volumes in a cluster.
Defines a migration request for a volume.
Defines a migration request for a volume group.
No description provided by the author
No description provided by the author
Defines a response for the migration that was started.
Request for cloud migration operation status.
Defines a response for the status request.
Defines a request to activate a cluster domain.
Empty response.
Defines a request to deactivate a cluster domain.
Empty response.
Defines a request to inspect a cluster domain.
Defines a response to inspecting a cluster domain.
Empty request.
Defines a response when enumerating cluster domains.
Empty request.
Defines a response when inspecting the current cluster.
Defines a request for creating a cluster pair.
Defines a result of the cluster pair.
Defines a delete request for a cluster pair.
Empty response.
Empty Request.
Defines a list of cluster pair.
Empty request.
Defines a response for the token request.
Defines a cluster pair inspect request.
Defines a cluster pair inspect response.
Empty request.
Defines a response for the token request.
Defines a request to create credentials.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Defines a response from creating a credential.
Defines a request to remove any references to credentials.
Empty response.
Defines the request to delete credentials.
Empty response.
Empty request.
Defines response for a enumeration of credentials.
Defines the request to inspection for credentials.
Defines the response to an inspection of a credential.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Defines request for credential update.
Defines response for credential update.
Defines a request to validate credentials.
Empty response.
SdkDiagsCollectRequest is the request object that specifies what should be part of the diags that are collected User can specify both Node and Volume or just one of them.
SdkDiagsCollectResponse defines a response for an SDK request to collect diags.
Defines a request to list all the jobs.
Defines a response will all the known jobs.
No description provided by the author
No description provided by the author
SdkFilesystemCheckStartRequest defines a request to start a background filesystem consistency check operation.
SdkFilesystemCheckStartResponse defines the response for a SdkFilesystemCheckStartRequest.
SdkFilesystemCheckStatusRequest defines a request to get status of a background filesystem check operation.
SdkFilesystemCheckStatusResponse defines the response for a SdkFilesystemCheckStatusRequest.
SdkFilesystemCheckStopRequest defines a request to stop a background filesystem check operation.
Empty response.
SdkFilesystemTrimStartRequest defines a request to start a background filesystem trim operation.
SdkFilesystemTrimStartResponse defines the response for a SdkFilesystemTrimStartRequest.
SdkFilesystemTrimStatusRequest defines a request to get status of a background filesystem trim operation.
SdkFilesystemTrimStatusResponse defines the response for a SdkFilesystemTrimStatusRequest.
SdkFilesystemTrimStopRequest defines a request to stop a background filesystem trim operation.
Empty response.
Defines a request to get the status of an existing job.
Defines the status of an existing job.
No description provided by the author
No description provided by the author
Defines credentials for Google.
Defines the response for Google credentials.
Empty request.
Defines a response containing the capabilities of the cluster.
Empty request.
Defines a response containing version information.
Defines a response for an SDK request that spins up a new job to perform the request.
Defines credentials for NFS.
Defines the response for NFS credential.
SdkNodeCordonAttachmentsRequest request for disabling new volume attachments from a node.
SdkNodeCordonAttachmentsRespinse response for disabling new volume attachments from a node.
Defines a node drain volume attachments request.
Empty request.
Defines a response with a list of node ids.
Defines a request to list nodes with given filter.
Defines a response with a list of nodes.
Empty request.
Defines a response when inspecting a node.
Defines a request when inspecting a node.
Defines a response when inspecting a node.
Defines request to trigger RelaxedReclaim purge for a given node.
Defines response containing status of the trigger.
SdkNodeUncordonAttachmentsRequest request for re-enabling volume attachments for a node.
SdkNodeUncordonAttachmentsRespinse response for enabling new volume attachments from a node.
Defines request to retrieve all volumes/snapshots capacity usage details for a given node.
Defines response containing Node's volumes/snapshot capacity usage details.
Defines a request to create an object store.
Defines a response when an object store has been created for a specified volume.
Defines a request to delete an object store service from a volume.
Empty response.
Defines a request to get information about an object store endpoint.
Defines a response when inspecting an object store endpoint.
Defines a request to update an object store.
Empty response.
Define a request to create storage policy.
Empty response.
Empty Request.
Define default storage policy response.
Define a request to delete storage policy.
Empty Response.
Empty request.
Define a storage policy enumerate response.
Define a request to inspect storage policy.
Define a storage policy inspect response.
Empty Request.
Empty Response.
Define a request to set default storage policy.
Empty Response.
Define a request to update storage policy.
Empty Response.
No description provided by the author
Defines a request for creating a role.
Response contains informaiton about the creation of the role.
Defines a request to delete a role.
Empty response.
Empty request.
Respose to enumerate all roles.
Defines a request to inspect a role.
Response to inspection request.
Defines a request to update an existing role.
Response contains information about the updated role.
SdkRule is the message used to construct custom roles in the OpenStorage SDK.
Defines a schedule policy.
Define a schedule policy request.
Empty response.
Define schedule policy deletion request.
Empty response.
Empty request.
Defines a schedule policy enumerate response.
Define a schedule policy inspection request.
Defines a schedule policy inspection response.
Defines a schedule policy interval.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Defines a daily schedule.
Defines a monthly schedule.
Defines a periodic schedule.
Defines a weekly schedule.
Define a request to update a schedule policy.
Empty response.
Defines a capability of he cluster.
No description provided by the author
No description provided by the author
A SdkStoragePolicy represents minimum set of volume specs to be follow while creating volumes.
No description provided by the author
Defines a request when inspect a storage pool.
No description provided by the author
No description provided by the author
Defines a response when resizing a storage pool.
No description provided by the author
SdkStorageRebalanceResponse is the response to a storage rebalance request.
Defines a request to update an existing job.
Defines the response for an update to an existing job.
No description provided by the author
No description provided by the author
SDK version in Major.Minor.Patch format.
Options to attach device.
Defines a request to attach a volume to the node receiving this request.
Defines a response from the node which received the request to attach.
Defines request to retrieve volume/snapshot capacity usage details.
Defines response containing volume/snapshot capacity usage details.
Request message to get the volume catalog.
Response message to get volume catalog.
Defines a request to clone a volume or create a volume from a snapshot.
Defines the response when creating a clone from a volume or a snapshot.
Defines a request to create a volume.
Defines a response to the creation of a volume.
Defines the request to delete a volume.
Empty response.
No description provided by the author
Defines a request to detach a volume.
Empty response.
Defines a request to list volumes.
Defines the response when listing volumes.
Defines a request to list volumes.
Defines the response when listing volumes.
Defines the request to inspect a volume.
Defines the response when inspecting a volume.
Defines the request to inspect volumes using a filter.
Defines the response when inspecting volumes using a filter.
Defines a request to mount a volume to the node receiving this request.
Empty response.
Defines the request when creating a snapshot from a volume.
Defines a response after creating a snapshot of a volume.
Defines a request to list the snaphots.
Defines a response when listing snapshots.
Defines a request to list the snaphots.
Defines a response when listing snapshots.
Defines a request to restore a volume to a snapshot.
Empty response.
Defines a request to update the snapshot schedule of a volume.
Empty response.
Defines a request to retrieve volume statistics.
Defines a response containing drive statistics.
Options to unmount device.
Defines a request to unmount a volume on the node receiving this request.
Empty response.
This request is used to adjust or set new values in the volume.
Empty response.
Sharedv4FailoverStrategy specifies how long to wait before failing over to a new server.
Sharedv4ServiceSpec when set, creates a service endpoint for accessing a sharedv4 volume.
Sharedv4Spec specifies common properties of sharedv4 and sharedv4 service volumes.
SnapCreateRequest specifies a request to create a snapshot of given volume.
SnapCreateRequest specifies a response that get's returned when creating a snapshot.
Source is a structure that can be given to a volume to seed the volume with data.
StatPoint represents the basic structure of a single Stat reported TODO: This is the first step to introduce stats in openstorage.
Stats is a structure that represents last collected stats for a volume.
StorageCluster represents the state and information about the cluster.
StorageNode describes the state of the node.
StoragePool groups different storage devices based on their CosType.
StoragePoolOperation defines an operation being performed on a storage pool.
StorageRebalanceAudit describes the action taken during rebalance.
StorageRebalanceJob describes job input and current status.
StorageRebalanceSummary describes summary for the job.
No description provided by the author
No description provided by the author
StorageResource groups properties of a storage device.
Version information about the storage system.
TokenSecretContext contains all nessesary information to get a token secret from any provider.
TopologyRequirement defines the topology requirement for a volume.
UnimplementedOpenStorageAlertsServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageBucketServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageCloudBackupServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageClusterDomainsServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageClusterPairServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageClusterServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageCredentialsServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageDiagsServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageFilesystemCheckServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageFilesystemTrimServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageIdentityServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageJobServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageMigrateServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageMountAttachServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageNodeServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageObjectstoreServer can be embedded to have forward compatible implementations.
UnimplementedOpenStoragePolicyServer can be embedded to have forward compatible implementations.
UnimplementedOpenStoragePoolServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageRoleServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageSchedulePolicyServer can be embedded to have forward compatible implementations.
UnimplementedOpenStorageVolumeServer can be embedded to have forward compatible implementations.
Volume represents an abstract storage volume.
VolumeConsumer identifies a consumer for a Volume.
VolumeCreateRequest is a structure that has the locator, source and spec to create a volume.
VolumeCreateResponse.
VolumeInfo.
Options used for volume inspection.
VolumeLocator is a structure that is attached to a volume and is used to carry opaque metadata.
No description provided by the author
VolumePlacementStrategy defines a strategy for placing volumes in the cluster which will be a series of rules All the rules specified will be applied for volume placement.
VolumeResponse is a structure that wraps an error.
No description provided by the author
VolumeServiceRequest provides details on what volume service command to perform in background on the volume.
VolumeServiceResponse specifies the response to a Volume Service command performed on a volumen.
VolumeSet specifies a request to update a volume.
VolumeSetResponse.
VolumeSpec has the properties needed to create a volume.
VolumeSpecPolicy provides a method to set volume storage policy.
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
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
VolumeSpecUpdate provides a method to set any of the VolumeSpec of an existing volume.
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
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
VolumeStateAction specifies desired actions.
Provides volume's exclusive bytes and its total usage.
Provides capacity usage of a node in terms of volumes.
Xattr defines implementation specific volume attribute.

# Interfaces

No description provided by the author
No description provided by the author
OpenStorageAlertsClient is the client API for OpenStorageAlerts service.
OpenStorageAlertsServer is the server API for OpenStorageAlerts service.
OpenStorageBucketClient is the client API for OpenStorageBucket service.
OpenStorageBucketServer is the server API for OpenStorageBucket service.
OpenStorageCloudBackupClient is the client API for OpenStorageCloudBackup service.
OpenStorageCloudBackupServer is the server API for OpenStorageCloudBackup service.
OpenStorageClusterClient is the client API for OpenStorageCluster service.
OpenStorageClusterDomainsClient is the client API for OpenStorageClusterDomains service.
OpenStorageClusterDomainsServer is the server API for OpenStorageClusterDomains service.
OpenStorageClusterPairClient is the client API for OpenStorageClusterPair service.
OpenStorageClusterPairServer is the server API for OpenStorageClusterPair service.
OpenStorageClusterServer is the server API for OpenStorageCluster service.
OpenStorageCredentialsClient is the client API for OpenStorageCredentials service.
OpenStorageCredentialsServer is the server API for OpenStorageCredentials service.
OpenStorageDiagsClient is the client API for OpenStorageDiags service.
OpenStorageDiagsServer is the server API for OpenStorageDiags service.
OpenStorageFilesystemCheckClient is the client API for OpenStorageFilesystemCheck service.
OpenStorageFilesystemCheckServer is the server API for OpenStorageFilesystemCheck service.
OpenStorageFilesystemTrimClient is the client API for OpenStorageFilesystemTrim service.
OpenStorageFilesystemTrimServer is the server API for OpenStorageFilesystemTrim service.
OpenStorageIdentityClient is the client API for OpenStorageIdentity service.
OpenStorageIdentityServer is the server API for OpenStorageIdentity service.
OpenStorageJobClient is the client API for OpenStorageJob service.
OpenStorageJobServer is the server API for OpenStorageJob service.
OpenStorageMigrateClient is the client API for OpenStorageMigrate service.
OpenStorageMigrateServer is the server API for OpenStorageMigrate service.
OpenStorageMountAttachClient is the client API for OpenStorageMountAttach service.
OpenStorageMountAttachServer is the server API for OpenStorageMountAttach service.
OpenStorageNodeClient is the client API for OpenStorageNode service.
OpenStorageNodeServer is the server API for OpenStorageNode service.
OpenStorageObjectstoreClient is the client API for OpenStorageObjectstore service.
OpenStorageObjectstoreServer is the server API for OpenStorageObjectstore service.
OpenStoragePolicyClient is the client API for OpenStoragePolicy service.
OpenStoragePolicyServer is the server API for OpenStoragePolicy service.
OpenStoragePoolClient is the client API for OpenStoragePool service.
OpenStoragePoolServer is the server API for OpenStoragePool service.
OpenStorageRoleClient is the client API for OpenStorageRole service.
OpenStorageRoleServer is the server API for OpenStorageRole service.
OpenStorageSchedulePolicyClient is the client API for OpenStorageSchedulePolicy service.
OpenStorageSchedulePolicyServer is the server API for OpenStorageSchedulePolicy service.
OpenStorageVolumeClient is the client API for OpenStorageVolume service.
OpenStorageVolumeServer is the server API for OpenStorageVolume service.

# Type aliases

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
State is an enum for state of diags collection on a given node.
No description provided by the author
Defines the types of enforcement on the given rules.
ExportProtocol defines how the device is exported..
No description provided by the author
fastpath extensions.
FilesystemChecktatus represents the status codes returned from OpenStorageFilesystemCheck service APIs().
No description provided by the author
FilesystemTrimStatus represents the status codes returned from OpenStorageFilesystemTrim service APIs().
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
State is an enum for state of a node drain operation.
Type are the supported job types.
This defines operator types used in a label matching rule.
No description provided by the author
Access types can be set by owner to have different levels of access to a resource.
ProxyProtocol defines the protocol used for proxy.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CloudBackup operations types.
CloudBackup operations types.
SdkCloudBackupRequestedState defines states to set a specified backup or restore to or from a cloud provider.
CloudBackup status types.
No description provided by the author
OperationStatus captures the various statuses of a storage pool operation.
OperationType defines the various operations that are performed on a storage pool.
Defines the operation types available to resize a storage pool.
Defines times of day.
These values are constants that can be used by the client and server applications.
No description provided by the author
No description provided by the author
Type of sharedv4 service.
No description provided by the author
StatusKind indicates the severity of a status.
No description provided by the author
No description provided by the author
StorageRebalanceAction describes type of rebalance action.
StorageRebalanceJobState is an enum for state of the current rebalance operation.
Metric is an enum that defines the metric to use for rebalance.
Type is an enum that defines the type fo the trigger threshold.
Type is an enum to indicate the type of work summary.
No description provided by the author
This defines an operator for the policy comparisons.
VolumeState represents the state of a volume.
VolumeStatus represents a health status for a volume.
No description provided by the author