Backup Storage
Overview
An image storage is a storage server that stores VM image templates, including ISO image files.
An image storage must be attached to a zone before the resources in the zone can access it. Note that you can share images across multiple zones by using the image storage.
To better manage image storage and zones, the UI specifies that one image storage can only correspond to one zone. In the UI, when you add an image storage, the image storage will be attached to the current zone by default. When you delete a zone, the image storage attached to the zone will also be deleted.
Image Storage Type
The Cloud supports the following types of image storage:
ImageStore
- Stores image files by means of image slices and supports incremental storage.
- Allows you to create snapshots and images when VM instances are running or stopped.
- Allows you to clone VM instances without data volumes when these VM instances are running, paused, or stopped.
- Allows you to clone VM instances with data volumes when these VM instances are running, paused, or stopped, and with storage types of LocalStorage, NFS, SharedMountPoint (SMP), Ceph, or SharedBlock.
- Supports image synchronization across ImageStore image storage on the same management node.
- Allows you to obtain the existing image files under the URL path in the image storage.
Ceph
Stores image files by means of Ceph distributed block storage.
Allows you to create snapshots and images when VM instances are running or stopped.
Allows you to clone VM instances without data volumes when these VM instances are running, paused, or stopped.
Allows you to clone VM instances with data volumes when these VM instances are running, paused, or stopped, and with the storage type of Ceph.
Allows you to export images on the UI or image storage.
You can export images, copy exported image URLs, and download exported images on the UI.
You can also export images on an image storage.
For example, assume that the image path you use is ceph://bak-t-c9923f9821bf45498fdf9cdfa1749943/61ece0adc7244b0cbd12dafbc5494f0c.
Then, run the following command on the image storage:
rbd export -p bak-t-c9923f9821bf45498fdf9cdfa1749943 --image 61ece0adc7244b0cbd12dafbc5494f0c --path /root/export-test.image # bak-t-c9923f9821bf45498fdf9cdfa1749943 is the name of the pool where the image resides. # 61ece0adc7244b0cbd12dafbc5494f0c is the name of the image. # /root/export-test.image is the name of the exported file.
Alibaba Cloud EBS
- Stores image by means of object storage.
- Allows you to create snapshots and images when VM instances are running or stopped.
- Allows you to clone VM instances without data volumes when these VM instances are running, paused, or stopped.
- Does not allow you to clone VM instances with data volumes.
- Allows you to export images on image storage. For more information, contact the official technical support.
Image Storage | Primary Storage
The following table lists the relationship between primary storage (PS) and image storage (BS).
| PS/BS | ImageStore | Ceph |
| LocalStorage | ○ | × |
| NFS | ○ | × |
| SMP | ○ | × |
| Ceph | ○ | ○ |
| SharedBlock | ○ | × |
| Vhost | ○ | × |
| ZBS (CBD protocol) | ○ | × |
- When primary storage are LocalStorage, NFS, or SMP, the default type for image storage is ImageStore.
- When primary storage are NFS or SMP, you can manually mount the corresponding shared directories to the local directories of the corresponding image storage. In this regard, both primary storage and image storage can use the network shared storage.
- When primary storage is Ceph, you can use the primary storage in the same Ceph cluster as image storage. You can also use the ImageStore primary storage as image storage.
- When primary storage is SharedBlock, the default type for image storage is ImageStore.
- When primary storage is Alibaba Cloud NAS, the default type for image storage is ImageStore.
- When primary storage is Alibaba Cloud EBS, the default type for image storage is Alibaba Cloud EBS.
Inventory
Backup Storage Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 0.6 | ||
| name | The name. For more information, see Resource Property. | 0.6 | ||
| description | The description. For more information, see Resource Property. | Yes | 0.6 | |
| url | The URL. For more information, see URL. | 0.6 | ||
| totalCapacity | The total disk capacity. Unit: byte. For more information, see Capacity. | 0.6 | ||
| availableCapacity | The available disk capacity. Unit: byte. For more information, see Capacity. | 0.6 | ||
| type | The backup dotage type. |
|
0.6 | |
| state | The state. For more information, see State. |
|
0.6 | |
| status | The status. For more information, see Status. |
|
0.6 | |
| attachedZoneUuids | The UUIDs of zones to which the backup storage is attached. | 0.6 | ||
| createDate | The creation date. For more information, see Resource Property. | 0.6 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 0.6 |
Sample
{
"inventories": {
"attachedClusterUuids": [
"967a353c2893409dab9312cf3033a98c"
],
"availableCapacity": 163634831360,
"availablePhysicalCapacity": 186066427904,
"createDate": "Oct 30, 2017 3:05:29 PM",
"description": "",
"lastOpDate": "Oct 31, 2017 10:41:26 AM",
"mountPath": "/Cloud_ps",
"name": "LS-1",
"state": "Enabled",
"status": "Connected",
"systemUsedCapacity": 9330311168,
"totalCapacity": 205177397248,
"totalPhysicalCapacity": 205177397248,
"type": "LocalStorage",
"url": "/Cloud_ps",
"uuid": "037bd212f7a1488da4f94360ccfaf6ab",
"zoneUuid": "e59b71e99d8a4ea1952b578388b8cd1d"
}
}
Image Replication Group Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.5.0 | ||
| name | The name. For more information, see Resource Property. | 3.5.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.5.0 | |
| state | The state. |
|
3.5.0 | |
| backupStorageRefs | The backup storage group list. | 3.5.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.5.0 | |
| createDate | The create date. For more information, see Resource Property. | 3.5.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 |
Sample
{
"inventories": [
{
"uuid": "31cbc4dad8da3ca6a6e3df5c1d5f233e",
"name": "test"
}
]
}
URL
A URL is a string that contains information needed by backup storage to control storage systems. Although its name is URL, the exact format of the string is up to backup storage types and is not necessary to strictly follow the URL convention. This gives flexibilities to plugins to encode information that may not be able to fit in the URL format.
SFTP Backup Storage URL
For an SFTP back storage (also known as backup storage), the URL is an absolute path of a directory in a file system, such as /storage/sftp.
Capacity
ZStack Cloud monitors disk capacities of backup storages to select one suitable backup storage for creating volumes. Different backup storage plugins may report different disk capacities. The capacity of a backup storage is calculated according to the following formulas:
totalCapacity = backup storage's total capacity
availableCapacity = totalCapacity - sum (images' actual sizes)
State
A backup storages has the following two states:
Enabled:
Indicates that images can be registered, backed up, and downloaded.
Disabled:
Indicates that images cannot be registered, backed up, or downloaded. Especially, if an image is only stored on a disabled backup storage, and if the image is not downloaded to image caches of primary storage, this image cannot be used to create VM instances.
Status
The status of a backup storage reflects the command channel status between a ZStack Cloud management node and a backup storage.
Connecting:
Indicates that a ZStack Cloud management node is trying to establish a command channel between the node itself and a backup storage. At this stage, you cannot perform any operation on the backup storage.
Connected:
Indicates that the command channel between a ZStack Cloud management node and a backup storage is established successfully. At this stage, you can perform related operations on the backup storage.
Disconnected:
Indicates that the command channel between a ZStack Cloud management node and a backup storage is lost. At this stage, you cannot perform any operation on the backup storage.
When a ZStack Cloud management node starts, the management node will try to establish command channels to backup storages. When the management node is running, it will periodically send ping commands to the backup storages to check the health status of command channels. Once a backup storage fails to respond, or a ping command times out, the status of the backup storage will be changed to Disconnected.
The status transition diagram of a backup storage is shown in Status Transition Diagram of Backup Storage.
Operations
DeleteBackupStorage
Deletes a backup storage. For example,
DeleteBackupStorage uuid=1613b627cb2e4ffcb30e7e59935064be
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The backup storage UUID. | 0.6 | ||
| deleteMode | The delete mode. For more information, see DeleteResources. | Yes |
|
0.6 |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
QueryBackupStorage
Queries a backup storage. For example,
QueryBackupStorage uuid=ae840e03a0044b759b0a8c09a141a46b
QueryBackupStorage zone.primaryStorage.uuid=037bd212f7a1488da4f94360ccfaf6ab
Primitive Fields of Query
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| image | Image Inventory | The images contained in the backup storage. | 0.6 |
| zone | Zone Inventory | The zone to which the backup storage belongs. | 0.6 |
| volumeSnapshot | Volume Snapshot Inventory | 0.6 |
ReconnectBackupStorage
Reconnects a backup storage. For example,
ReconnectBackupStorage uuid=ab3d53288bd14e6eba6ea56324b66a3f
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The backup storage UUID. | 0.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
ChangeBackupStorageState
Changes the state of a backup storage. For example,
ChangeBackupStorageState uuid=ab3d53288bd14e6eba6ea56324b66a3f stateEvent=disable
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The backup storage UUID. | 0.6 | ||
| stateEvent | The target state of the backup storage. |
|
0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
GetBackupStorageCapacity
Obtains the backup storage capacity. For example,
GetBackupStorageCapacity backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| zoneUuids | The zone UUID list. | Yes | 0.6 | |
| backupStorageUuids | The backup storage UUID list. Make sure that at least one of zoneUuids and backupStorageUuids is specified. Or, set all to true. |
Yes | 0.6 | |
| all | If backupStorageUuids is null, this parameter is set true, which means that all backup storages in the system are queried. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
GetBackupStorageTypes
Obtains the backup storage types. Sample response:
{
"backupStorageTypes": [
"Ceph",
"ImageStoreBackupStorage",
"VCenter",
"SftpBackupStorage"
],
"success": true
}
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
UpdateBackupStorage
Updates information about a backup storage. For example,
UpdateBackupStorage uuid=ab3d53288bd14e6eba6ea56324b66a3f name=test
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The backup storage UUID. | 0.6 | ||
| name | The new name of the backup storage. | Yes | 0.6 | |
| description | The detailed description of the backup storage. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
ExportImageFromBackupStorage
Exports an image from a backup storage. For example,
ExportImageFromBackupStorage backupStorageUuid=ab3d53288bd14e6eba6ea56324b66a3f
imageUuid=889ac0b0d8b758e99e35dc38d017c25c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| backupStorageUuid | The backup storage UUID. | 1.7 | ||
| imageUuid | The image UUID. | 1.7 | ||
| exportFormat | The format for storing the exported image. | Yes | 3.9.0 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 1.7 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 1.7 | |
| timeout | Yes |
DeleteExportedImageFromBackupStorage
Deletes an exported image from a backup storage. For example,
DeleteExportedImageFromBackupStorage backupStorageUuid=ab3d53288bd14e6eba6ea56324b66a3f
imageUuid=889ac0b0d8b758e99e35dc38d017c25c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| backupStorageUuid | The backup storage UUID. | 1.7 | ||
| imageUuid | The image UUID. | 1.7 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 1.7 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 1.7 | |
| timeout | Yes |
SyncImage
Synchronizes image from the metadata of a backup storage. For example:
SyncImage imageStoreUuid=81f447310d194ef5a8c0f7bbdcdc8401
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| imageStoreUuid | The backup storage UUID. | 4.7.11 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 4.7.11 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 4.7.11 |
AttachBackupStorageToZone
Attaches a backup storage to a zone. For example,
AttachBackupStorageToZone backupStorageUuid=d086c30f33914c98a6078269bab7bc8f
zoneUuid=d086c30f33914c98a6078269bab7bc8f
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| backupStorageUuid | The backup storage UUID. | 0.6 | ||
| zoneUuid | The zone UUID. | 0.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
DetachBackupStorageFromZone
Detaches a backup storage from a zone. For example,
DetachBackupStorageFromZone backupStorageUuid=d086c30f33914c98a6078269bab7bc8f
zoneUuid=d086c30f33914c98a6078269bab7bc8f
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| backupStorageUuid | The backup storage UUID. | 0.6 | ||
| zoneUuid | The zone UUID. | 0.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
BackupStorageMigrateImage
Migrates an image across backup storages. For example,
BackupStorageMigrateImage imageUuid=6391e504d07a4086927c2968ff6a710d
srcBackupStorageUuid=cd8dfecb67a94d168ccdf4de72578780 dstBackupStorageUuid=55ef2e4c99334e79b00f1968b4af1595
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| imageUuid | The image UUID. | 2.2 | ||
| srcBackupStorageUuid | The UUID of the source backup storage. | 2.2 | ||
| dstBackupStorageUuid | The UUID of the destination backup storage. | 2.2 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 2.2 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 2.2 | |
| timeout | Yes |
GetBackupStorageCandidatesForImageMigration
Obtains the candidate backup storages for image migration. For example,
GetBackupStorageCandidatesForImageMigration srcBackupStorageUuid=cd8dfecb67a94d168ccdf4de72578780
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| srcBackupStorageUuid | The UUID of the source backup storage where the image is located. | 2.2 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is BackupStorageVO. | Yes | 2.2 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is BackupStorageVO. | Yes | 2.2 | |
| timeout | Yes |
ImageStore Backup Storage
AddImageStoreBackupStorage
Adds an ImageStore backup storage. For example,
AddImageStoreBackupStorage hostname="10.0.33.123" username=admin name=imagestore
url="/data/imagestore" password=password importImages=false
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| hostname | The hostname of the ImageStore backup storage. | 1.6 | ||
| username | The SSH username of the ImageStore backup storage. | 1.6 | ||
| password | The SSH password of the ImageStore backup storage. | 1.6 | ||
| sshPort | The SSH port of the ImageStore backup storage. | Yes | 1.6 | |
| url | The path for storing local data in ImageStore. | 1.6 | ||
| name | The ImageStore name. | 1.6 | ||
| description | The detailed description of ImageStore. | Yes | 1.6 | |
| type | The backup storage type: ImageStoreBackupStorage. | Yes | 1.6 | |
| importImages | Whether to import images. | Yes | 1.9 | |
| resourceUuid | The resource UUID. | Yes | 1.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageStoreBackupStorageVO. | Yes | 1.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageStoreBackupStorageVO. | Yes | 1.6 | |
| timeout | Yes |
When you add an ImageStore backup storage in ZStack Cloud, you can specify the method to mount the storage path of the ImageStore backup storage by adding the fsInfo option to SystemTags.
- Format of the fsInfo option:
fsInfo::type::$TYPE::url::$URL::options::$OPTIONS - Example:
fsInfo::type::nfs::url::172.32.1.119:/nas/nfs2::options::nolock,vers=3,rsize=32768,wsize=32768
- Format of the fsInfo option:
QueryBackupStorage
Queries an ImageStore backup storage. For example,
QueryBackupStorage uuid=ae840e03a0044b759b0a8c09a141a46b
QueryBackupStorage zone.primaryStorage.uuid=037bd212f7a1488da4f94360ccfaf6ab
Primitive Fields of Query
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| image | Image Inventory | The images contained in the ImageStore backup storage. | 0.6 |
| zone | Zone Inventory | The zone to which the ImageStore backup storage belongs. | 0.6 |
| volumeSnapshot | Volume Snapshot Inventory | 0.6 |
UpdateImageStoreBackupStorage
Updates information about an ImageStore backup storage. For example,
UpdateImageStoreBackupStorage uuid=ab3d53288bd14e6eba6ea56324b66a3f name=test-ls
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| hostname | The hostname of the ImageStore backup storage. | Yes | 1.6 | |
| username | The SSH username of the ImageStore backup storage. | Yes | 1.6 | |
| password | The SSH password of the ImageStore backup storage. | Yes | 1.6 | |
| sshPort | The SSH port of the ImageStore backup storage. | Yes | 1.6 | |
| uuid | The UUID of the ImageStore backup storage. | 1.6 | ||
| name | The new name of the ImageStore backup storage. | Yes | 1.6 | |
| description | The detailed description of the ImageStore backup storage. | Yes | 1.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageStoreBackupStorageVO. | Yes | 1.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageStoreBackupStorageVO. | Yes | 1.6 | |
| timeout | Yes |
ReconnectImageStoreBackupStorage
Reconnects an ImageStore backup storage. For example,
ReconnectImageStoreBackupStorage uuid=af6686a6642f41f4a9a3587abc5a96dc
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID of the ImageStore backup storage. | 1.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageStoreBackupStorageVO. | Yes | 1.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageStoreBackupStorageVO. | Yes | 1.6 | |
| timeout | Yes |
ReclaimSpaceFromImageStore
Reclaims disk space from an ImageStore backup storage. For example,
ReclaimSpaceFromImageStore uuid=af6686a6642f41f4a9a3587abc5a96dc
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID of the ImageStore backup storage. | 1.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageStoreBackupStorageVO. | Yes | 1.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageStoreBackupStorageVO. | Yes | 1.1 | |
| timeout | Yes |
Ceph Backup Storage
AddCephBackupStorage
Adds a Ceph backup storage. For example,
AddCephBackupStorage name=ceph2_bs monUrls=root:password@10.0.41.162:22
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| monUrls | The URLs of the Ceph monitor daemon (Ceph mon). | 0.6 | ||
| poolName | The name of the Ceph pool for storing images. | Yes | 0.6 | |
| url | The reserved field for internal use. | 0.6 | ||
| name | The new name of the Ceph backup storage. | 0.6 | ||
| description | The detailed description of the Ceph backup storage. | Yes | 0.6 | |
| type | The backup storage type: Ceph. | Yes | 0.6 | |
| importImages | Whether to import images. | Yes | 1.9 | |
| resourceUuid | The resource UUID. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is CephBackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is CephBackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
QueryCephBackupStorage
Queries a Ceph backup storage. For example,
QueryCephBackupStorage uuid=d655f6a3df09471da0102da605618646
QueryCephBackupStorage mons.hostname=10.0.41.162
Primitive Fields of Query
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| zone | Zone Inventory | The zone to which the Ceph backup storage belongs. | 0.6 |
| image | Image Inventory | The images contained in the Ceph backup storage. | 0.6 |
| mons | 0.6 | ||
| volumeSnapshot | Volume Snapshot Inventory | 0.6 |
UpdateCephBackupStorageMon
Updates the monitor daemon (Ceph mon) of a Ceph backup storage. For example,
UpdateCephBackupStorageMon monUuid=66480dbf545e4f5098866feb7657ca11
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| monUuid | The Ceph mon UUID. | 0.6 | ||
| hostname | The new hostname of the Ceph mon. | Yes | 0.6 | |
| sshUsername | The SSH username of the Ceph mon. | Yes | 0.6 | |
| sshPassword | The SSH password of the Ceph mon. | Yes | 0.6 | |
| sshPort | The SSH port of the Ceph mon. | Yes | 0.6 | |
| monPort | The port of the Ceph mon. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is CephBackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is CephBackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
AddMonToCephBackupStorage
Adds a monitor daemon (Ceph mon) to a Ceph backup storage. For example,
AddMonToCephBackupStorage uuid=d655f6a3df09471da0102da605618646 monUrls=root:password@10.0.41.162:22
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID of the Ceph backup storage. | 0.6 | ||
| monHostnames | The hostnames of the Ceph mon. | 0.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is CephBackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is CephBackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
RemoveMonFromCephBackupStorage
Removes the monitor daemon (Ceph mon) from a Ceph backup storage. For example,
RemoveMonFromCephBackupStorage uuid=d655f6a3df09471da0102da605618646 monHostnames=10.0.41.162
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID of the Ceph backup storage. | 0.6 | ||
| monHostnames | The hostnames of the Ceph mon. | 0.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is CephBackupStorageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is CephBackupStorageVO. | Yes | 0.6 | |
| timeout | Yes |
Tags
You can create a user tag on a backup storage by using resourceType=BackupStorageVO. For example,
CreateUserTag tag=lab1 resourceType=BackupStorageVO \
resourceUuid=2906471068802c501773d3ee55b7766e
