CBT Task
Inventory
Properties
| Name | Description | Optional | Valid Values | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 5.3.28 | ||
| name | The resource name. | 5.3.28 | ||
| description | The resource description. | 5.3.28 | ||
| status | The task status. | 5.3.28 | ||
| createDate | See Resource Property | 5.3.28 | ||
| lastOpDate | See Resource Property | 5.3.28 |
Operations
CreateCbtTask
Creates a CBT task. For example,
CreateCbtTask name=testParameters
| Name | Description | Optional | Valid Values | Starting Version |
|---|---|---|---|---|
| name | The resource name. | 5.3.28 | ||
| description | The resource description. | Yes | 5.3.28 | |
| resourceUuid | The resource UUID. | Yes | 5.3.28 | |
| tagUuids | The tag UUID list. | Yes | 5.3.28 | |
| userTags | The user tags. See CreateUserTag | Yes | 5.3.28 | |
| systemTags | The system tags. See CreateSystemTag | Yes | 5.3.28 | |
| timeout | Yes |
DeleteCbtTask
Deletes a CBT task. For example,
DeleteCbtTask uuid=7017b8d5bef63877a528a5f56517c829Parameters
| Name | Description | Optional | Valid Values | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 5.3.28 | ||
| force | Yes | 5.3.28 | ||
| deleteMode | The deletion mode (Permissive / Enforcing，Permissive). | Yes | 5.3.28 | |
| userTags | The user tags. See CreateUserTag | Yes | 5.3.28 | |
| systemTags | The system tags. See CreateSystemTag | Yes | 5.3.28 | |
| timeout | Yes |
QueryCbtTask
Queries a CBT task. For example,
QueryCbtTask Uuid=c675eb9b802b42248739c5a2a4330ee7Primitive Fields of Query
Nested And Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| resourceRefs | 5.3.28 |
EnableCbtTask
Enables a CBT task. For example,
EnableCbtTask uuid=7017b8d5bef63877a528a5f56517c829Parameters
| Name | Description | Optional | Valid Values | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 5.3.28 | ||
| bitmapName | Yes | 5.3.28 | ||
| userTags | The user tags. See CreateUserTag | Yes | 5.3.28 | |
| systemTags | The system tags. See CreateSystemTag | Yes | 5.3.28 | |
| timeout | Yes |
DisableCbtTask
Disables a CBT task. For example,
DisableCbtTask uuid=7017b8d5bef63877a528a5f56517c829Parameters
| Name | Description | Optional | Valid Values | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 5.3.28 | ||
| force | Forcible or not. | Yes | 5.3.28 | |
| userTags | The user tags. See CreateUserTag | Yes | 5.3.28 | |
| systemTags | The system tags. See CreateSystemTag | Yes | 5.3.28 | |
| timeout | Yes |
ExportNbdVolumes
Exports a volume as an NBD device. For example,
ExportNbdVolumes volumeUuids=8d7de4e1c3b73fc49772b0fef78b0fc7 vmInstanceUuid=7d8c1dec326c3230be08d3c82fb7a476Parameters
| Name | Description | Optional | Valid Values | Starting Version |
|---|---|---|---|---|
| volumeUuids | The volume UUID list. | 5.3.28 | ||
| vmInstanceUuid | The VM UUID. | 5.3.28 | ||
| userTags | The user tags. See CreateUserTag | Yes | 5.3.28 | |
| systemTags | The system tags. See CreateSystemTag | Yes | 5.3.28 | |
| timeout | Yes |
UnexportNbdVolumes
Stops exporting a volume as an NBD device. For example,
UnexportNbdVolumes volumeUuids=8d7de4e1c3b73fc49772b0fef78b0fc7 vmInstanceUuid=7d8c1dec326c3230be08d3c82fb7a476Parameters
| Name | Description | Optional | Valid Values | Starting Version |
|---|---|---|---|---|
| volumeUuids | The volume UUID list. | 5.3.28 | ||
| vmInstanceUuid | The VM UUID. | 5.3.28 | ||
| userTags | The user tags. See CreateUserTag | Yes | 5.3.28 | |
| systemTags | The system tags. See CreateSystemTag | Yes | 5.3.28 | |
| timeout | Yes |