Go API client for ceph

This is the official Ceph REST API

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: v1
Package version: 0.0.1
Generator version: 7.9.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import ceph "github.com/boyvinall/go-ceph/api"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value ceph.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ceph.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value ceph.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), ceph.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using ceph.ContextOperationServerIndices and ceph.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), ceph.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), ceph.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://ceph.example.com

Class	Method	HTTP request	Description
AuthAPI	ApiAuthCheckPost	Post /api/auth/check	Check token Authentication
AuthAPI	ApiAuthLogoutPost	Post /api/auth/logout
AuthAPI	ApiAuthPost	Post /api/auth	Dashboard Authentication
CephFSSnapshotScheduleAPI	ApiCephfsSnapshotScheduleFsGet	Get /api/cephfs/snapshot/schedule/{fs}
CephFSSnapshotScheduleAPI	ApiCephfsSnapshotScheduleFsPathActivatePost	Post /api/cephfs/snapshot/schedule/{fs}/{path}/activate
CephFSSnapshotScheduleAPI	ApiCephfsSnapshotScheduleFsPathDeactivatePost	Post /api/cephfs/snapshot/schedule/{fs}/{path}/deactivate
CephFSSnapshotScheduleAPI	ApiCephfsSnapshotScheduleFsPathDeleteSnapshotDelete	Delete /api/cephfs/snapshot/schedule/{fs}/{path}/delete_snapshot
CephFSSnapshotScheduleAPI	ApiCephfsSnapshotScheduleFsPathPut	Put /api/cephfs/snapshot/schedule/{fs}/{path}
CephFSSnapshotScheduleAPI	ApiCephfsSnapshotSchedulePost	Post /api/cephfs/snapshot/schedule
CephFSSubvolumeAPI	ApiCephfsSubvolumePost	Post /api/cephfs/subvolume
CephFSSubvolumeAPI	ApiCephfsSubvolumeVolNameDelete	Delete /api/cephfs/subvolume/{vol_name}
CephFSSubvolumeAPI	ApiCephfsSubvolumeVolNameExistsGet	Get /api/cephfs/subvolume/{vol_name}/exists
CephFSSubvolumeAPI	ApiCephfsSubvolumeVolNameGet	Get /api/cephfs/subvolume/{vol_name}
CephFSSubvolumeAPI	ApiCephfsSubvolumeVolNameInfoGet	Get /api/cephfs/subvolume/{vol_name}/info
CephFSSubvolumeAPI	ApiCephfsSubvolumeVolNamePut	Put /api/cephfs/subvolume/{vol_name}
CephfsAPI	ApiCephfsAuthPut	Put /api/cephfs/auth	Set Ceph authentication capabilities for the specified user ID in the given path
CephfsAPI	ApiCephfsFsIdClientClientIdDelete	Delete /api/cephfs/{fs_id}/client/{client_id}
CephfsAPI	ApiCephfsFsIdClientsGet	Get /api/cephfs/{fs_id}/clients
CephfsAPI	ApiCephfsFsIdGet	Get /api/cephfs/{fs_id}
CephfsAPI	ApiCephfsFsIdGetRootDirectoryGet	Get /api/cephfs/{fs_id}/get_root_directory
CephfsAPI	ApiCephfsFsIdLsDirGet	Get /api/cephfs/{fs_id}/ls_dir
CephfsAPI	ApiCephfsFsIdMdsCountersGet	Get /api/cephfs/{fs_id}/mds_counters
CephfsAPI	ApiCephfsFsIdQuotaGet	Get /api/cephfs/{fs_id}/quota	Get Cephfs Quotas of the specified path
CephfsAPI	ApiCephfsFsIdQuotaPut	Put /api/cephfs/{fs_id}/quota
CephfsAPI	ApiCephfsFsIdRenamePathPut	Put /api/cephfs/{fs_id}/rename-path
CephfsAPI	ApiCephfsFsIdSnapshotDelete	Delete /api/cephfs/{fs_id}/snapshot
CephfsAPI	ApiCephfsFsIdSnapshotPost	Post /api/cephfs/{fs_id}/snapshot
CephfsAPI	ApiCephfsFsIdStatfsGet	Get /api/cephfs/{fs_id}/statfs	Get Cephfs statfs of the specified path
CephfsAPI	ApiCephfsFsIdTreeDelete	Delete /api/cephfs/{fs_id}/tree
CephfsAPI	ApiCephfsFsIdTreePost	Post /api/cephfs/{fs_id}/tree
CephfsAPI	ApiCephfsFsIdUnlinkDelete	Delete /api/cephfs/{fs_id}/unlink
CephfsAPI	ApiCephfsFsIdWriteToFilePost	Post /api/cephfs/{fs_id}/write_to_file
CephfsAPI	ApiCephfsGet	Get /api/cephfs
CephfsAPI	ApiCephfsPost	Post /api/cephfs
CephfsAPI	ApiCephfsRemoveNameDelete	Delete /api/cephfs/remove/{name}	Remove CephFS Volume
CephfsAPI	ApiCephfsRenamePut	Put /api/cephfs/rename	Rename CephFS Volume
CephfsSnapshotCloneAPI	ApiCephfsSubvolumeSnapshotClonePost	Post /api/cephfs/subvolume/snapshot/clone	Create a clone of a subvolume snapshot
CephfsSubvolumeGroupAPI	ApiCephfsSubvolumeGroupPost	Post /api/cephfs/subvolume/group
CephfsSubvolumeGroupAPI	ApiCephfsSubvolumeGroupVolNameDelete	Delete /api/cephfs/subvolume/group/{vol_name}
CephfsSubvolumeGroupAPI	ApiCephfsSubvolumeGroupVolNameGet	Get /api/cephfs/subvolume/group/{vol_name}
CephfsSubvolumeGroupAPI	ApiCephfsSubvolumeGroupVolNameInfoGet	Get /api/cephfs/subvolume/group/{vol_name}/info
CephfsSubvolumeGroupAPI	ApiCephfsSubvolumeGroupVolNamePut	Put /api/cephfs/subvolume/group/{vol_name}
CephfsSubvolumeSnapshotAPI	ApiCephfsSubvolumeSnapshotPost	Post /api/cephfs/subvolume/snapshot
CephfsSubvolumeSnapshotAPI	ApiCephfsSubvolumeSnapshotVolNameSubvolNameDelete	Delete /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}
CephfsSubvolumeSnapshotAPI	ApiCephfsSubvolumeSnapshotVolNameSubvolNameGet	Get /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}
CephfsSubvolumeSnapshotAPI	ApiCephfsSubvolumeSnapshotVolNameSubvolNameInfoGet	Get /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}/info
ClusterAPI	ApiClusterGet	Get /api/cluster	Get the cluster status
ClusterAPI	ApiClusterPut	Put /api/cluster	Update the cluster status
ClusterAPI	ApiClusterUserExportPost	Post /api/cluster/user/export	Export Ceph Users
ClusterAPI	ApiClusterUserGet	Get /api/cluster/user	Get list of ceph users
ClusterAPI	ApiClusterUserPost	Post /api/cluster/user	Create Ceph User
ClusterAPI	ApiClusterUserPut	Put /api/cluster/user	Edit Ceph User Capabilities
ClusterAPI	ApiClusterUserUserEntityDelete	Delete /api/cluster/user/{user_entity}	Delete Ceph User
ClusterConfigurationAPI	ApiClusterConfFilterGet	Get /api/cluster_conf/filter	Get Cluster Configuration by name
ClusterConfigurationAPI	ApiClusterConfGet	Get /api/cluster_conf
ClusterConfigurationAPI	ApiClusterConfNameDelete	Delete /api/cluster_conf/{name}
ClusterConfigurationAPI	ApiClusterConfNameGet	Get /api/cluster_conf/{name}
ClusterConfigurationAPI	ApiClusterConfPost	Post /api/cluster_conf
ClusterConfigurationAPI	ApiClusterConfPut	Put /api/cluster_conf
CrushRuleAPI	ApiCrushRuleGet	Get /api/crush_rule	List Crush Rule Configuration
CrushRuleAPI	ApiCrushRuleNameDelete	Delete /api/crush_rule/{name}
CrushRuleAPI	ApiCrushRuleNameGet	Get /api/crush_rule/{name}
CrushRuleAPI	ApiCrushRulePost	Post /api/crush_rule
DaemonAPI	ApiDaemonDaemonNamePut	Put /api/daemon/{daemon_name}
DaemonAPI	ApiDaemonGet	Get /api/daemon
ErasureCodeProfileAPI	ApiErasureCodeProfileGet	Get /api/erasure_code_profile	List Erasure Code Profile Information
ErasureCodeProfileAPI	ApiErasureCodeProfileNameDelete	Delete /api/erasure_code_profile/{name}
ErasureCodeProfileAPI	ApiErasureCodeProfileNameGet	Get /api/erasure_code_profile/{name}
ErasureCodeProfileAPI	ApiErasureCodeProfilePost	Post /api/erasure_code_profile
FeatureTogglesEndpointAPI	ApiFeatureTogglesGet	Get /api/feature_toggles	Get List Of Features
GrafanaAPI	ApiGrafanaDashboardsPost	Post /api/grafana/dashboards
GrafanaAPI	ApiGrafanaUrlGet	Get /api/grafana/url	List Grafana URL Instance
GrafanaAPI	ApiGrafanaValidationParamsGet	Get /api/grafana/validation/{params}
HardwareAPI	ApiHardwareSummaryGet	Get /api/hardware/summary	Retrieve a summary of the hardware health status
HealthAPI	ApiHealthFullGet	Get /api/health/full
HealthAPI	ApiHealthGetClusterCapacityGet	Get /api/health/get_cluster_capacity
HealthAPI	ApiHealthGetClusterFsidGet	Get /api/health/get_cluster_fsid
HealthAPI	ApiHealthGetTelemetryStatusGet	Get /api/health/get_telemetry_status
HealthAPI	ApiHealthMinimalGet	Get /api/health/minimal	Get Cluster's minimal health report
HostAPI	ApiHostGet	Get /api/host	List Host Specifications
HostAPI	ApiHostHostnameDaemonsGet	Get /api/host/{hostname}/daemons
HostAPI	ApiHostHostnameDelete	Delete /api/host/{hostname}
HostAPI	ApiHostHostnameDevicesGet	Get /api/host/{hostname}/devices
HostAPI	ApiHostHostnameGet	Get /api/host/{hostname}
HostAPI	ApiHostHostnameIdentifyDevicePost	Post /api/host/{hostname}/identify_device
HostAPI	ApiHostHostnameInventoryGet	Get /api/host/{hostname}/inventory	Get inventory of a host
HostAPI	ApiHostHostnamePut	Put /api/host/{hostname}
HostAPI	ApiHostHostnameSmartGet	Get /api/host/{hostname}/smart
HostAPI	ApiHostPost	Post /api/host
IscsiAPI	ApiIscsiDiscoveryauthGet	Get /api/iscsi/discoveryauth	Get Iscsi discoveryauth Details
IscsiAPI	ApiIscsiDiscoveryauthPut	Put /api/iscsi/discoveryauth	Set Iscsi discoveryauth
IscsiTargetAPI	ApiIscsiTargetGet	Get /api/iscsi/target
IscsiTargetAPI	ApiIscsiTargetPost	Post /api/iscsi/target
IscsiTargetAPI	ApiIscsiTargetTargetIqnDelete	Delete /api/iscsi/target/{target_iqn}
IscsiTargetAPI	ApiIscsiTargetTargetIqnGet	Get /api/iscsi/target/{target_iqn}
IscsiTargetAPI	ApiIscsiTargetTargetIqnPut	Put /api/iscsi/target/{target_iqn}
LogsAPI	ApiLogsAllGet	Get /api/logs/all	Display Logs Configuration
MdsPerfCounterAPI	ApiPerfCountersMdsServiceIdGet	Get /api/perf_counters/mds/{service_id}
MgrModuleAPI	ApiMgrModuleGet	Get /api/mgr/module	List Mgr modules
MgrModuleAPI	ApiMgrModuleModuleNameDisablePost	Post /api/mgr/module/{module_name}/disable
MgrModuleAPI	ApiMgrModuleModuleNameEnablePost	Post /api/mgr/module/{module_name}/enable
MgrModuleAPI	ApiMgrModuleModuleNameGet	Get /api/mgr/module/{module_name}
MgrModuleAPI	ApiMgrModuleModuleNameOptionsGet	Get /api/mgr/module/{module_name}/options
MgrModuleAPI	ApiMgrModuleModuleNamePut	Put /api/mgr/module/{module_name}
MgrPerfCounterAPI	ApiPerfCountersMgrServiceIdGet	Get /api/perf_counters/mgr/{service_id}
MonPerfCounterAPI	ApiPerfCountersMonServiceIdGet	Get /api/perf_counters/mon/{service_id}
MonitorAPI	ApiMonitorGet	Get /api/monitor	Get Monitor Details
MultiClusterAPI	ApiMultiClusterAuthPost	Post /api/multi-cluster/auth	Authenticate to a remote cluster
MultiClusterAPI	ApiMultiClusterCheckTokenStatusGet	Get /api/multi-cluster/check_token_status
MultiClusterAPI	ApiMultiClusterDeleteClusterClusterNameClusterUserDelete	Delete /api/multi-cluster/delete_cluster/{cluster_name}/{cluster_user}
MultiClusterAPI	ApiMultiClusterEditClusterPut	Put /api/multi-cluster/edit_cluster
MultiClusterAPI	ApiMultiClusterGetConfigGet	Get /api/multi-cluster/get_config
MultiClusterAPI	ApiMultiClusterGetPrometheusApiUrlGet	Get /api/multi-cluster/get_prometheus_api_url
MultiClusterAPI	ApiMultiClusterReconnectClusterPut	Put /api/multi-cluster/reconnect_cluster
MultiClusterAPI	ApiMultiClusterSecurityConfigGet	Get /api/multi-cluster/security_config
MultiClusterAPI	ApiMultiClusterSetConfigPut	Put /api/multi-cluster/set_config
NFSGaneshaAPI	ApiNfsGaneshaClusterGet	Get /api/nfs-ganesha/cluster
NFSGaneshaAPI	ApiNfsGaneshaExportClusterIdExportIdDelete	Delete /api/nfs-ganesha/export/{cluster_id}/{export_id}	Deletes an NFS-Ganesha export
NFSGaneshaAPI	ApiNfsGaneshaExportClusterIdExportIdGet	Get /api/nfs-ganesha/export/{cluster_id}/{export_id}	Get an NFS-Ganesha export
NFSGaneshaAPI	ApiNfsGaneshaExportClusterIdExportIdPut	Put /api/nfs-ganesha/export/{cluster_id}/{export_id}	Updates an NFS-Ganesha export
NFSGaneshaAPI	ApiNfsGaneshaExportGet	Get /api/nfs-ganesha/export	List all NFS-Ganesha exports
NFSGaneshaAPI	ApiNfsGaneshaExportPost	Post /api/nfs-ganesha/export	Creates a new NFS-Ganesha export
NVMeOFGatewayAPI	ApiNvmeofGatewayGet	Get /api/nvmeof/gateway	Get information about the NVMeoF gateway
NVMeOFGatewayAPI	ApiNvmeofGatewayGroupGet	Get /api/nvmeof/gateway/group
NVMeOFSubsystemAPI	ApiNvmeofSubsystemGet	Get /api/nvmeof/subsystem	List all NVMeoF subsystems
NVMeOFSubsystemAPI	ApiNvmeofSubsystemNqnDelete	Delete /api/nvmeof/subsystem/{nqn}	Delete an existing NVMeoF subsystem
NVMeOFSubsystemAPI	ApiNvmeofSubsystemNqnGet	Get /api/nvmeof/subsystem/{nqn}	Get information from a specific NVMeoF subsystem
NVMeOFSubsystemAPI	ApiNvmeofSubsystemPost	Post /api/nvmeof/subsystem	Create a new NVMeoF subsystem
NVMeOFSubsystemConnectionAPI	ApiNvmeofSubsystemNqnConnectionGet	Get /api/nvmeof/subsystem/{nqn}/connection	List all NVMeoF Subsystem Connections
NVMeOFSubsystemHostAllowlistAPI	ApiNvmeofSubsystemNqnHostGet	Get /api/nvmeof/subsystem/{nqn}/host	List all allowed hosts for an NVMeoF subsystem
NVMeOFSubsystemHostAllowlistAPI	ApiNvmeofSubsystemNqnHostHostNqnDelete	Delete /api/nvmeof/subsystem/{nqn}/host/{host_nqn}	Disallow hosts from accessing an NVMeoF subsystem
NVMeOFSubsystemHostAllowlistAPI	ApiNvmeofSubsystemNqnHostPost	Post /api/nvmeof/subsystem/{nqn}/host	Allow hosts to access an NVMeoF subsystem
NVMeOFSubsystemListenerAPI	ApiNvmeofSubsystemNqnListenerGet	Get /api/nvmeof/subsystem/{nqn}/listener	List all NVMeoF listeners
NVMeOFSubsystemListenerAPI	ApiNvmeofSubsystemNqnListenerHostNameTraddrDelete	Delete /api/nvmeof/subsystem/{nqn}/listener/{host_name}/{traddr}	Delete an existing NVMeoF listener
NVMeOFSubsystemListenerAPI	ApiNvmeofSubsystemNqnListenerPost	Post /api/nvmeof/subsystem/{nqn}/listener	Create a new NVMeoF listener
NVMeOFSubsystemNamespaceAPI	ApiNvmeofSubsystemNqnNamespaceGet	Get /api/nvmeof/subsystem/{nqn}/namespace	List all NVMeoF namespaces in a subsystem
NVMeOFSubsystemNamespaceAPI	ApiNvmeofSubsystemNqnNamespaceNsidDelete	Delete /api/nvmeof/subsystem/{nqn}/namespace/{nsid}	Delete an existing NVMeoF namespace
NVMeOFSubsystemNamespaceAPI	ApiNvmeofSubsystemNqnNamespaceNsidGet	Get /api/nvmeof/subsystem/{nqn}/namespace/{nsid}	Get info from specified NVMeoF namespace
NVMeOFSubsystemNamespaceAPI	ApiNvmeofSubsystemNqnNamespaceNsidIoStatsGet	Get /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/io_stats	Get IO stats from specified NVMeoF namespace
NVMeOFSubsystemNamespaceAPI	ApiNvmeofSubsystemNqnNamespaceNsidPatch	Patch /api/nvmeof/subsystem/{nqn}/namespace/{nsid}	Update an existing NVMeoF namespace
NVMeOFSubsystemNamespaceAPI	ApiNvmeofSubsystemNqnNamespacePost	Post /api/nvmeof/subsystem/{nqn}/namespace	Create a new NVMeoF namespace
OSDAPI	ApiOsdFlagsGet	Get /api/osd/flags	Display OSD Flags
OSDAPI	ApiOsdFlagsIndividualGet	Get /api/osd/flags/individual	Displays individual OSD flags
OSDAPI	ApiOsdFlagsIndividualPut	Put /api/osd/flags/individual	Sets OSD flags for a subset of individual OSDs.
OSDAPI	ApiOsdFlagsPut	Put /api/osd/flags	Sets OSD flags for the entire cluster.
OSDAPI	ApiOsdGet	Get /api/osd
OSDAPI	ApiOsdPost	Post /api/osd
OSDAPI	ApiOsdSafeToDeleteGet	Get /api/osd/safe_to_delete
OSDAPI	ApiOsdSafeToDestroyGet	Get /api/osd/safe_to_destroy	Check If OSD is Safe to Destroy
OSDAPI	ApiOsdSettingsGet	Get /api/osd/settings
OSDAPI	ApiOsdSvcIdDelete	Delete /api/osd/{svc_id}
OSDAPI	ApiOsdSvcIdDestroyPost	Post /api/osd/{svc_id}/destroy
OSDAPI	ApiOsdSvcIdDevicesGet	Get /api/osd/{svc_id}/devices
OSDAPI	ApiOsdSvcIdGet	Get /api/osd/{svc_id}
OSDAPI	ApiOsdSvcIdHistogramGet	Get /api/osd/{svc_id}/histogram
OSDAPI	ApiOsdSvcIdMarkPut	Put /api/osd/{svc_id}/mark	Mark OSD flags (out, in, down, lost, ...)
OSDAPI	ApiOsdSvcIdPurgePost	Post /api/osd/{svc_id}/purge
OSDAPI	ApiOsdSvcIdPut	Put /api/osd/{svc_id}
OSDAPI	ApiOsdSvcIdReweightPost	Post /api/osd/{svc_id}/reweight
OSDAPI	ApiOsdSvcIdScrubPost	Post /api/osd/{svc_id}/scrub
OSDAPI	ApiOsdSvcIdSmartGet	Get /api/osd/{svc_id}/smart
OsdPerfCounterAPI	ApiPerfCountersOsdServiceIdGet	Get /api/perf_counters/osd/{service_id}
PerfCountersAPI	ApiPerfCountersGet	Get /api/perf_counters	Display Perf Counters
PoolAPI	ApiPoolGet	Get /api/pool	Display Pool List
PoolAPI	ApiPoolPoolNameConfigurationGet	Get /api/pool/{pool_name}/configuration
PoolAPI	ApiPoolPoolNameDelete	Delete /api/pool/{pool_name}
PoolAPI	ApiPoolPoolNameGet	Get /api/pool/{pool_name}
PoolAPI	ApiPoolPoolNamePut	Put /api/pool/{pool_name}
PoolAPI	ApiPoolPost	Post /api/pool
PrometheusAPI	ApiPrometheusAlertgroupGet	Get /api/prometheus/alertgroup
PrometheusAPI	ApiPrometheusDataGet	Get /api/prometheus/data
PrometheusAPI	ApiPrometheusGet	Get /api/prometheus
PrometheusAPI	ApiPrometheusPrometheusQueryDataGet	Get /api/prometheus/prometheus_query_data
PrometheusAPI	ApiPrometheusRulesGet	Get /api/prometheus/rules
PrometheusAPI	ApiPrometheusSilencePost	Post /api/prometheus/silence
PrometheusAPI	ApiPrometheusSilenceSIdDelete	Delete /api/prometheus/silence/{s_id}
PrometheusAPI	ApiPrometheusSilencesGet	Get /api/prometheus/silences
PrometheusNotificationsAPI	ApiPrometheusNotificationsGet	Get /api/prometheus/notifications
RGWAPI	ApiRgwRolesGet	Get /api/rgw/roles	List RGW roles
RGWAPI	ApiRgwRolesPost	Post /api/rgw/roles	Create RGW role
RGWAPI	ApiRgwRolesPut	Put /api/rgw/roles	Edit RGW role
RGWAPI	ApiRgwRolesRoleNameDelete	Delete /api/rgw/roles/{role_name}	Delete RGW role
RbdAPI	ApiBlockImageCloneFormatVersionGet	Get /api/block/image/clone_format_version
RbdAPI	ApiBlockImageDefaultFeaturesGet	Get /api/block/image/default_features
RbdAPI	ApiBlockImageGet	Get /api/block/image	Display Rbd Images
RbdAPI	ApiBlockImageImageSpecCopyPost	Post /api/block/image/{image_spec}/copy
RbdAPI	ApiBlockImageImageSpecDelete	Delete /api/block/image/{image_spec}
RbdAPI	ApiBlockImageImageSpecFlattenPost	Post /api/block/image/{image_spec}/flatten
RbdAPI	ApiBlockImageImageSpecGet	Get /api/block/image/{image_spec}	Get Rbd Image Info
RbdAPI	ApiBlockImageImageSpecMoveTrashPost	Post /api/block/image/{image_spec}/move_trash
RbdAPI	ApiBlockImageImageSpecPut	Put /api/block/image/{image_spec}
RbdAPI	ApiBlockImagePost	Post /api/block/image
RbdMirroringAPI	ApiBlockMirroringSiteNameGet	Get /api/block/mirroring/site_name	Display Rbd Mirroring sitename
RbdMirroringAPI	ApiBlockMirroringSiteNamePut	Put /api/block/mirroring/site_name
RbdMirroringPoolBootstrapAPI	ApiBlockMirroringPoolPoolNameBootstrapPeerPost	Post /api/block/mirroring/pool/{pool_name}/bootstrap/peer
RbdMirroringPoolBootstrapAPI	ApiBlockMirroringPoolPoolNameBootstrapTokenPost	Post /api/block/mirroring/pool/{pool_name}/bootstrap/token
RbdMirroringPoolModeAPI	ApiBlockMirroringPoolPoolNameGet	Get /api/block/mirroring/pool/{pool_name}	Display Rbd Mirroring Summary
RbdMirroringPoolModeAPI	ApiBlockMirroringPoolPoolNamePut	Put /api/block/mirroring/pool/{pool_name}
RbdMirroringPoolPeerAPI	ApiBlockMirroringPoolPoolNamePeerGet	Get /api/block/mirroring/pool/{pool_name}/peer
RbdMirroringPoolPeerAPI	ApiBlockMirroringPoolPoolNamePeerPeerUuidDelete	Delete /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}
RbdMirroringPoolPeerAPI	ApiBlockMirroringPoolPoolNamePeerPeerUuidGet	Get /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}
RbdMirroringPoolPeerAPI	ApiBlockMirroringPoolPoolNamePeerPeerUuidPut	Put /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}
RbdMirroringPoolPeerAPI	ApiBlockMirroringPoolPoolNamePeerPost	Post /api/block/mirroring/pool/{pool_name}/peer
RbdMirroringSummaryAPI	ApiBlockMirroringSummaryGet	Get /api/block/mirroring/summary	Display Rbd Mirroring Summary
RbdNamespaceAPI	ApiBlockPoolPoolNameNamespaceGet	Get /api/block/pool/{pool_name}/namespace
RbdNamespaceAPI	ApiBlockPoolPoolNameNamespaceNamespaceDelete	Delete /api/block/pool/{pool_name}/namespace/{namespace}
RbdNamespaceAPI	ApiBlockPoolPoolNameNamespacePost	Post /api/block/pool/{pool_name}/namespace
RbdSnapshotAPI	ApiBlockImageImageSpecSnapPost	Post /api/block/image/{image_spec}/snap
RbdSnapshotAPI	ApiBlockImageImageSpecSnapSnapshotNameClonePost	Post /api/block/image/{image_spec}/snap/{snapshot_name}/clone
RbdSnapshotAPI	ApiBlockImageImageSpecSnapSnapshotNameDelete	Delete /api/block/image/{image_spec}/snap/{snapshot_name}
RbdSnapshotAPI	ApiBlockImageImageSpecSnapSnapshotNamePut	Put /api/block/image/{image_spec}/snap/{snapshot_name}
RbdSnapshotAPI	ApiBlockImageImageSpecSnapSnapshotNameRollbackPost	Post /api/block/image/{image_spec}/snap/{snapshot_name}/rollback
RbdTrashAPI	ApiBlockImageTrashGet	Get /api/block/image/trash	Get RBD Trash Details by pool name
RbdTrashAPI	ApiBlockImageTrashImageIdSpecDelete	Delete /api/block/image/trash/{image_id_spec}
RbdTrashAPI	ApiBlockImageTrashImageIdSpecRestorePost	Post /api/block/image/trash/{image_id_spec}/restore
RbdTrashAPI	ApiBlockImageTrashPurgePost	Post /api/block/image/trash/purge
ReportAPI	ApiFeedbackApiKeyDelete	Delete /api/feedback/api_key
ReportAPI	ApiFeedbackApiKeyGet	Get /api/feedback/api_key
ReportAPI	ApiFeedbackApiKeyPost	Post /api/feedback/api_key
ReportAPI	ApiFeedbackGet	Get /api/feedback
ReportAPI	ApiFeedbackPost	Post /api/feedback
RgwBucketAPI	ApiRgwBucketBucketDelete	Delete /api/rgw/bucket/{bucket}
RgwBucketAPI	ApiRgwBucketBucketGet	Get /api/rgw/bucket/{bucket}
RgwBucketAPI	ApiRgwBucketBucketPut	Put /api/rgw/bucket/{bucket}
RgwBucketAPI	ApiRgwBucketDeleteEncryptionDelete	Delete /api/rgw/bucket/deleteEncryption
RgwBucketAPI	ApiRgwBucketGet	Get /api/rgw/bucket
RgwBucketAPI	ApiRgwBucketGetEncryptionConfigGet	Get /api/rgw/bucket/getEncryptionConfig
RgwBucketAPI	ApiRgwBucketGetEncryptionGet	Get /api/rgw/bucket/getEncryption
RgwBucketAPI	ApiRgwBucketPost	Post /api/rgw/bucket
RgwBucketAPI	ApiRgwBucketSetEncryptionConfigPut	Put /api/rgw/bucket/setEncryptionConfig
RgwDaemonAPI	ApiRgwDaemonGet	Get /api/rgw/daemon	Display RGW Daemons
RgwDaemonAPI	ApiRgwDaemonSetMultisiteConfigPut	Put /api/rgw/daemon/set_multisite_config
RgwDaemonAPI	ApiRgwDaemonSvcIdGet	Get /api/rgw/daemon/{svc_id}
RgwMirrorPerfCounterAPI	ApiPerfCountersRbdMirrorServiceIdGet	Get /api/perf_counters/rbd-mirror/{service_id}
RgwMultisiteAPI	ApiRgwMultisiteSyncFlowFlowIdFlowTypeGroupIdDelete	Delete /api/rgw/multisite/sync-flow/{flow_id}/{flow_type}/{group_id}	Remove the sync flow
RgwMultisiteAPI	ApiRgwMultisiteSyncFlowPut	Put /api/rgw/multisite/sync-flow	Create or update the sync flow
RgwMultisiteAPI	ApiRgwMultisiteSyncPipeGroupIdPipeIdDelete	Delete /api/rgw/multisite/sync-pipe/{group_id}/{pipe_id}	Remove the sync pipe
RgwMultisiteAPI	ApiRgwMultisiteSyncPipePut	Put /api/rgw/multisite/sync-pipe	Create or update the sync pipe
RgwMultisiteAPI	ApiRgwMultisiteSyncPolicyGet	Get /api/rgw/multisite/sync-policy	Get the sync policy
RgwMultisiteAPI	ApiRgwMultisiteSyncPolicyGroupGroupIdDelete	Delete /api/rgw/multisite/sync-policy-group/{group_id}	Remove the sync policy group
RgwMultisiteAPI	ApiRgwMultisiteSyncPolicyGroupGroupIdGet	Get /api/rgw/multisite/sync-policy-group/{group_id}	Get the sync policy group
RgwMultisiteAPI	ApiRgwMultisiteSyncPolicyGroupPost	Post /api/rgw/multisite/sync-policy-group	Create the sync policy group
RgwMultisiteAPI	ApiRgwMultisiteSyncPolicyGroupPut	Put /api/rgw/multisite/sync-policy-group	Update the sync policy group
RgwMultisiteAPI	ApiRgwMultisiteSyncStatusGet	Get /api/rgw/multisite/sync_status	Get the sync status
RgwPerfCounterAPI	ApiPerfCountersRgwServiceIdGet	Get /api/perf_counters/rgw/{service_id}
RgwRealmAPI	ApiRgwRealmGet	Get /api/rgw/realm
RgwRealmAPI	ApiRgwRealmGetAllRealmsInfoGet	Get /api/rgw/realm/get_all_realms_info
RgwRealmAPI	ApiRgwRealmGetRealmTokensGet	Get /api/rgw/realm/get_realm_tokens
RgwRealmAPI	ApiRgwRealmImportRealmTokenPost	Post /api/rgw/realm/import_realm_token
RgwRealmAPI	ApiRgwRealmPost	Post /api/rgw/realm
RgwRealmAPI	ApiRgwRealmRealmNameDelete	Delete /api/rgw/realm/{realm_name}
RgwRealmAPI	ApiRgwRealmRealmNameGet	Get /api/rgw/realm/{realm_name}
RgwRealmAPI	ApiRgwRealmRealmNamePut	Put /api/rgw/realm/{realm_name}
RgwSiteAPI	ApiRgwSiteGet	Get /api/rgw/site
RgwUserAPI	ApiRgwUserGet	Get /api/rgw/user	Display RGW Users
RgwUserAPI	ApiRgwUserGetEmailsGet	Get /api/rgw/user/get_emails
RgwUserAPI	ApiRgwUserPost	Post /api/rgw/user
RgwUserAPI	ApiRgwUserUidCapabilityDelete	Delete /api/rgw/user/{uid}/capability
RgwUserAPI	ApiRgwUserUidCapabilityPost	Post /api/rgw/user/{uid}/capability
RgwUserAPI	ApiRgwUserUidDelete	Delete /api/rgw/user/{uid}
RgwUserAPI	ApiRgwUserUidGet	Get /api/rgw/user/{uid}
RgwUserAPI	ApiRgwUserUidKeyDelete	Delete /api/rgw/user/{uid}/key
RgwUserAPI	ApiRgwUserUidKeyPost	Post /api/rgw/user/{uid}/key
RgwUserAPI	ApiRgwUserUidPut	Put /api/rgw/user/{uid}
RgwUserAPI	ApiRgwUserUidQuotaGet	Get /api/rgw/user/{uid}/quota
RgwUserAPI	ApiRgwUserUidQuotaPut	Put /api/rgw/user/{uid}/quota
RgwUserAPI	ApiRgwUserUidSubuserPost	Post /api/rgw/user/{uid}/subuser
RgwUserAPI	ApiRgwUserUidSubuserSubuserDelete	Delete /api/rgw/user/{uid}/subuser/{subuser}
RgwZoneAPI	ApiRgwZoneCreateSystemUserPut	Put /api/rgw/zone/create_system_user
RgwZoneAPI	ApiRgwZoneGet	Get /api/rgw/zone
RgwZoneAPI	ApiRgwZoneGetAllZonesInfoGet	Get /api/rgw/zone/get_all_zones_info
RgwZoneAPI	ApiRgwZoneGetPoolNamesGet	Get /api/rgw/zone/get_pool_names
RgwZoneAPI	ApiRgwZoneGetUserListGet	Get /api/rgw/zone/get_user_list
RgwZoneAPI	ApiRgwZonePost	Post /api/rgw/zone
RgwZoneAPI	ApiRgwZoneZoneNameDelete	Delete /api/rgw/zone/{zone_name}
RgwZoneAPI	ApiRgwZoneZoneNameGet	Get /api/rgw/zone/{zone_name}
RgwZoneAPI	ApiRgwZoneZoneNamePut	Put /api/rgw/zone/{zone_name}
RgwZonegroupAPI	ApiRgwZonegroupGet	Get /api/rgw/zonegroup
RgwZonegroupAPI	ApiRgwZonegroupGetAllZonegroupsInfoGet	Get /api/rgw/zonegroup/get_all_zonegroups_info
RgwZonegroupAPI	ApiRgwZonegroupPost	Post /api/rgw/zonegroup
RgwZonegroupAPI	ApiRgwZonegroupZonegroupNameDelete	Delete /api/rgw/zonegroup/{zonegroup_name}
RgwZonegroupAPI	ApiRgwZonegroupZonegroupNameGet	Get /api/rgw/zonegroup/{zonegroup_name}
RgwZonegroupAPI	ApiRgwZonegroupZonegroupNamePut	Put /api/rgw/zonegroup/{zonegroup_name}
RoleAPI	ApiRoleGet	Get /api/role	Display Role list
RoleAPI	ApiRoleNameClonePost	Post /api/role/{name}/clone
RoleAPI	ApiRoleNameDelete	Delete /api/role/{name}
RoleAPI	ApiRoleNameGet	Get /api/role/{name}
RoleAPI	ApiRoleNamePut	Put /api/role/{name}
RoleAPI	ApiRolePost	Post /api/role
ServiceAPI	ApiServiceGet	Get /api/service
ServiceAPI	ApiServiceKnownTypesGet	Get /api/service/known_types
ServiceAPI	ApiServicePost	Post /api/service
ServiceAPI	ApiServiceServiceNameDaemonsGet	Get /api/service/{service_name}/daemons
ServiceAPI	ApiServiceServiceNameDelete	Delete /api/service/{service_name}
ServiceAPI	ApiServiceServiceNameGet	Get /api/service/{service_name}
ServiceAPI	ApiServiceServiceNamePut	Put /api/service/{service_name}
SettingsAPI	ApiSettingsGet	Get /api/settings	Display Settings Information
SettingsAPI	ApiSettingsNameDelete	Delete /api/settings/{name}
SettingsAPI	ApiSettingsNameGet	Get /api/settings/{name}
SettingsAPI	ApiSettingsNamePut	Put /api/settings/{name}
SettingsAPI	ApiSettingsPut	Put /api/settings
SummaryAPI	ApiSummaryGet	Get /api/summary	Display Summary
TaskAPI	ApiTaskGet	Get /api/task	Display Tasks
TcmuRunnerPerfCounterAPI	ApiPerfCountersTcmuRunnerServiceIdGet	Get /api/perf_counters/tcmu-runner/{service_id}
TelemetryAPI	ApiTelemetryPut	Put /api/telemetry
TelemetryAPI	ApiTelemetryReportGet	Get /api/telemetry/report	Get Detailed Telemetry report
UpgradeAPI	ApiClusterUpgradeGet	Get /api/cluster/upgrade	Get the available versions to upgrade
UpgradeAPI	ApiClusterUpgradePausePut	Put /api/cluster/upgrade/pause	Pause the cluster upgrade
UpgradeAPI	ApiClusterUpgradeResumePut	Put /api/cluster/upgrade/resume	Resume the cluster upgrade
UpgradeAPI	ApiClusterUpgradeStartPost	Post /api/cluster/upgrade/start	Start the cluster upgrade
UpgradeAPI	ApiClusterUpgradeStatusGet	Get /api/cluster/upgrade/status	Get the cluster upgrade status
UpgradeAPI	ApiClusterUpgradeStopPut	Put /api/cluster/upgrade/stop	Stop the cluster upgrade
UserAPI	ApiUserGet	Get /api/user	Get List Of Users
UserAPI	ApiUserPost	Post /api/user
UserAPI	ApiUserUsernameDelete	Delete /api/user/{username}
UserAPI	ApiUserUsernameGet	Get /api/user/{username}
UserAPI	ApiUserUsernamePut	Put /api/user/{username}
UserChangePasswordAPI	ApiUserUsernameChangePasswordPost	Post /api/user/{username}/change_password
UserPasswordPolicyAPI	ApiUserValidatePasswordPost	Post /api/user/validate_password

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

jwt

Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), ceph.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

# Packages

# README