POST v1/bunits/{bunitId}/vmfilespaces
Assign a VM file space to a business unit
This will create a consumption unit.
All data related to the VM file space will be substracted from that of the backup node
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
The ID of the business unit that the VM file space should be assigned to | integer |
Required |
Body Parameters
The VM file space to assign
FilespaceName | Description | Type | Additional information |
---|---|---|---|
TsmFilespaceId |
The ID of the file space in SP. The ID is not unique for the file space in general. Only when related to a backup node |
string |
None. |
Type |
The file space storage type. FILESPACE_TYPE on SP. |
string |
None. |
DeleteCommand |
The command that will be sent to IBM Storage Protect server if the file space is to be deleted This property is only set if the file space has an approved deletion request |
string |
None. |
CapacityMegaBytes |
The storage capacity in the file space. CAPACITY on the IBM Storage Protect server. |
decimal number |
None. |
FrontEndCapacityMegaBytes |
The front-end capacity in the file space Calculated on the IBM Storage Protect server |
integer |
None. |
PercentageUtilized |
The percentage of utilized capacity in the file space. PTC_UTIL on SP. |
decimal number |
None. |
LastBackupStart |
Specifies the start date and time of the last incremental backup of the file space. BACKUP_START on SP. |
date |
None. |
LastBackupEnd |
Specifies the completion date and time of the last incremental backup of the file space. BACKUP_END on SP. |
date |
None. |
Occupancies |
Information about how much storage the file space occupies on the IBM Storage Protect server. |
Collection of Occupancy |
None. |
DedupStats |
Information about how much storage the file space occupies on the IBM Storage Protect server. |
Collection of DedupStat |
None. |
Activities |
Information about activity of the file space on the IBM Storage Protect server. |
Collection of Activity |
None. |
Events |
Information about activity of the file space on the IBM Storage Protect server. |
Collection of Event |
None. |
Node |
The backup node the file space is related to on the IBM Storage Protect server |
Node |
None. |
DataMover |
The backup node currently responsible for backing up the file space |
Node |
None. |
DeleteProcess |
Information about the deletion of the file space if this has been requested |
DeleteProcess |
None. |
RetentionSets |
A list of the retention sets the file space is a part of |
Collection of RetentionSet |
None. |
DeleteRequest |
Information about request for getting the file space deleted |
DeleteRequest |
None. |
Name |
Name of the data-source |
string |
None. |
DataSourceState |
DataSourceState |
None. |
|
DataSourcePlatform |
DataSourcePlatform |
None. |
|
DataSourceType |
DataSourceType |
None. |
|
BackupServer |
Server |
None. |
|
Consumer |
Consumption unit that relates the VM to a business unit |
Consumer |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The assigned VM file space along with the newly created consumption unit
FilespaceName | Description | Type | Additional information |
---|---|---|---|
TsmFilespaceId |
The ID of the file space in SP. The ID is not unique for the file space in general. Only when related to a backup node |
string |
None. |
Type |
The file space storage type. FILESPACE_TYPE on SP. |
string |
None. |
DeleteCommand |
The command that will be sent to IBM Storage Protect server if the file space is to be deleted This property is only set if the file space has an approved deletion request |
string |
None. |
CapacityMegaBytes |
The storage capacity in the file space. CAPACITY on the IBM Storage Protect server. |
decimal number |
None. |
FrontEndCapacityMegaBytes |
The front-end capacity in the file space Calculated on the IBM Storage Protect server |
integer |
None. |
PercentageUtilized |
The percentage of utilized capacity in the file space. PTC_UTIL on SP. |
decimal number |
None. |
LastBackupStart |
Specifies the start date and time of the last incremental backup of the file space. BACKUP_START on SP. |
date |
None. |
LastBackupEnd |
Specifies the completion date and time of the last incremental backup of the file space. BACKUP_END on SP. |
date |
None. |
Occupancies |
Information about how much storage the file space occupies on the IBM Storage Protect server. |
Collection of Occupancy |
None. |
DedupStats |
Information about how much storage the file space occupies on the IBM Storage Protect server. |
Collection of DedupStat |
None. |
Activities |
Information about activity of the file space on the IBM Storage Protect server. |
Collection of Activity |
None. |
Events |
Information about activity of the file space on the IBM Storage Protect server. |
Collection of Event |
None. |
Node |
The backup node the file space is related to on the IBM Storage Protect server |
Node |
None. |
DataMover |
The backup node currently responsible for backing up the file space |
Node |
None. |
DeleteProcess |
Information about the deletion of the file space if this has been requested |
DeleteProcess |
None. |
RetentionSets |
A list of the retention sets the file space is a part of |
Collection of RetentionSet |
None. |
DeleteRequest |
Information about request for getting the file space deleted |
DeleteRequest |
None. |
Name |
Name of the data-source |
string |
None. |
DataSourceState |
DataSourceState |
None. |
|
DataSourcePlatform |
DataSourcePlatform |
None. |
|
DataSourceType |
DataSourceType |
None. |
|
BackupServer |
Server |
None. |
|
Consumer |
Consumption unit that relates the VM to a business unit |
Consumer |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.