PUT v1/bunits/{bunitId}
Update business unit.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit to update | integer |
Required |
Body Parameters
The updated business unit
BusinessUnit| Name | Description | Type | Additional information |
|---|---|---|---|
ParentBusinessUnit |
The business unit that is the parent in the heirarchy. |
BusinessUnit |
None. |
Server |
The default IBM Storage Protect server for the business unit. If one is set this is where backup nodes will be created. Overrides servers of ancestral business units |
SpServer |
None. |
SpPlusServer |
The default IBM Storage Protect Plus server for the business unit. If one is set this is where hypervisors will be created. Overrides servers of ancestral business units |
SpPlusServer |
None. |
RubrikServer |
The default Rubrik server for the business unit. If one is set this is where data-sources will be created. Overrides servers of ancestral business units |
RubrikServer |
None. |
CohesityServer |
The default Cohesity server for the business unit. If one is set this is where data-sources will be created. Overrides servers of ancestral business units |
CohesityServer |
None. |
PointPartitions |
The PoINT partitions available for the business unit. These can be used when creating buckets. Available partitions are inherited by all descendants until new filtering is done. |
Collection of PointPartition |
None. |
Contract |
The contract contains information about the business unit's relation to its parent. |
Contract |
Required. |
DataCenters |
Data center is a collection of IBM Storage Protect servers. Data centers are only available for business units with their own IBM Storage Protect-infrastructure IBM Storage Protect servers are not available to business units with a parent that has a data center. |
Collection of DataCenter |
None. |
TimeZone |
The timezone of the business unit |
TimeZone |
Required. |
Users |
A list of users |
Collection of User |
None. |
Supporters |
A list of users subscribing to node comments |
Collection of User |
None. |
NotificationAddresses |
A list of notification addresses |
Collection of Address |
None. |
Addresses |
A list of addresses |
Collection of Address |
None. |
BusinessUnits |
A list of child business units. These are the customers of the business unit. |
Collection of BusinessUnit |
None. |
DomainFilter |
The filter will be applied to determine which domains (filtered by name) that are available to the business unit when creating new nodes. |
Collection of string |
None. |
ClientOptionSetFilter |
The filter will be applied to determine which client option sets (filtered by name) that are available to the business unit when creating new nodes. |
Collection of string |
None. |
Name |
The name of the business unit |
string |
Required. |
GroupName |
The group name of the business unit |
string |
None. |
Note |
A field for various information about the business unit |
string |
None. |
SupportResponsible |
Gets or sets a value indicating whether [support responsible]. |
boolean |
None. |
RegistrationNumber |
The public registration number of the business unit |
string |
None. |
InvoiceDay |
The day of the month customers of this business unit are invoiced. Default value is zero (0) and represents the last day of the month. |
integer |
None. |
BillingStorageTypeId |
Information about what kind of storagetype is used when billing the business unit |
integer |
None. |
BillingStorageType |
Information about what kind of storagetype is used when billing the business unit |
BillingStorageType |
None. |
UseScheduleBindings |
Use schedule bindings on the business unit's infrastructure. |
boolean |
None. |
BrandConfig |
The branding configuration of the business unit. |
BrandConfig |
None. |
Consumers |
A list of all consumption units of the business unit |
Collection of Consumer |
None. |
StatusReports |
A list of all status reports of the business unit |
Collection of StatusReport |
None. |
StorageLimit |
A limit to how much storage a business unit may consume and used for calculating storage utilization. Overrides any included amounts on relevant subscriptions. Set to 0 if ignored. |
integer |
None. |
TransferLimit |
A limit to how much a business unit may transfer and used for calculating transfer utilization. Overrides any included amounts on relevant subscriptions. Set to 0 if ignored. |
integer |
None. |
NodeLimit |
A limit to how many nodes a business unit may have. Overrides any included amounts on relevant subscriptions. Set to 0 if ignored. |
integer |
None. |
PasswordExpirationDays |
Users in the hierarchy will need to update their password after n days Set to 0 (zero) to disable |
integer |
None. |
RequireTotp |
The users of the business unit and the underlying hierarchy must use TOTP when logging in |
boolean |
None. |
RequiredApproversOfDeleteRequest |
The number of users needed to approve a deletion request before the request is approved at this level. |
integer |
None. |
FinalDeleteRequestApprover |
Whether or not the business unit is the final approver of deletion requests or if the requests are sent higher up the system. |
boolean |
None. |
UsersCanApproveOwnRequests |
If users have the right privileges they are allowed to approve any deletion request even though the themselves requested it |
boolean |
None. |
ReportRemotely |
Whether or not the business unit should be reported to parent system |
boolean |
None. |
SynchronizeConsumerNames |
If set to true consumption units of the business unit will be renamed if their related data-sources are renamed If null setting is inherited from parent. If false, renaming data-sources will have no effect on the name of consumption units |
boolean |
None. |
RemoteId |
The ID the business unit has in a remote system. The ID indicates that the business unit was reported into the system If this ID exists the business unit will be restricted from most functionality in the system like creating consumer units, data centers etc. |
integer |
None. |
SystemId |
The unique ID of the system belonging to the business unit |
globally unique identifier |
None. |
ReportErrorConfig |
A report error configuration. |
ReportErrorConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available report error configuration in the ancestor heirarchy. |
NodeReportDeliveryConfig |
Default settings for how node reports are sent. If subscribers of node reports have no settings these are used |
NodeReportDeliveryConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available node report delivery configuration in the ancestor heirarchy. |
NodeDeletionRule |
Rule that determines how nodes and file spaces managed by the business unit are deleted on backend servers |
NodeDeletionRule |
None. |
Tags |
A list of tags describing the business unit |
Collection of Tag |
None. |
StatusReportDeliveryConfig |
Default settings for how status reports are sent. If subscribers of status reports have no settings these are used |
StatusReportDeliveryConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available status report delivery configuration in the ancestor heirarchy. |
ConsumptionUnitDeliveryConfig |
Default settings for how status report consumption unit incident mails are sent. If subscribers of status reports have no settings these are used |
StatusReportConsumptionUnitDeliveryConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available status report consumption unit delivery configuration in the ancestor heirarchy. |
JobDeliveryConfig |
Default settings for how jobs are sent. If subscribers of jobs have no settings these are used |
JobDeliveryConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available job delivery configuration in the ancestor heirarchy. |
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 updated business unit
BusinessUnit| Name | Description | Type | Additional information |
|---|---|---|---|
ParentBusinessUnit |
The business unit that is the parent in the heirarchy. |
BusinessUnit |
None. |
Server |
The default IBM Storage Protect server for the business unit. If one is set this is where backup nodes will be created. Overrides servers of ancestral business units |
SpServer |
None. |
SpPlusServer |
The default IBM Storage Protect Plus server for the business unit. If one is set this is where hypervisors will be created. Overrides servers of ancestral business units |
SpPlusServer |
None. |
RubrikServer |
The default Rubrik server for the business unit. If one is set this is where data-sources will be created. Overrides servers of ancestral business units |
RubrikServer |
None. |
CohesityServer |
The default Cohesity server for the business unit. If one is set this is where data-sources will be created. Overrides servers of ancestral business units |
CohesityServer |
None. |
PointPartitions |
The PoINT partitions available for the business unit. These can be used when creating buckets. Available partitions are inherited by all descendants until new filtering is done. |
Collection of PointPartition |
None. |
Contract |
The contract contains information about the business unit's relation to its parent. |
Contract |
Required. |
DataCenters |
Data center is a collection of IBM Storage Protect servers. Data centers are only available for business units with their own IBM Storage Protect-infrastructure IBM Storage Protect servers are not available to business units with a parent that has a data center. |
Collection of DataCenter |
None. |
TimeZone |
The timezone of the business unit |
TimeZone |
Required. |
Users |
A list of users |
Collection of User |
None. |
Supporters |
A list of users subscribing to node comments |
Collection of User |
None. |
NotificationAddresses |
A list of notification addresses |
Collection of Address |
None. |
Addresses |
A list of addresses |
Collection of Address |
None. |
BusinessUnits |
A list of child business units. These are the customers of the business unit. |
Collection of BusinessUnit |
None. |
DomainFilter |
The filter will be applied to determine which domains (filtered by name) that are available to the business unit when creating new nodes. |
Collection of string |
None. |
ClientOptionSetFilter |
The filter will be applied to determine which client option sets (filtered by name) that are available to the business unit when creating new nodes. |
Collection of string |
None. |
Name |
The name of the business unit |
string |
Required. |
GroupName |
The group name of the business unit |
string |
None. |
Note |
A field for various information about the business unit |
string |
None. |
SupportResponsible |
Gets or sets a value indicating whether [support responsible]. |
boolean |
None. |
RegistrationNumber |
The public registration number of the business unit |
string |
None. |
InvoiceDay |
The day of the month customers of this business unit are invoiced. Default value is zero (0) and represents the last day of the month. |
integer |
None. |
BillingStorageTypeId |
Information about what kind of storagetype is used when billing the business unit |
integer |
None. |
BillingStorageType |
Information about what kind of storagetype is used when billing the business unit |
BillingStorageType |
None. |
UseScheduleBindings |
Use schedule bindings on the business unit's infrastructure. |
boolean |
None. |
BrandConfig |
The branding configuration of the business unit. |
BrandConfig |
None. |
Consumers |
A list of all consumption units of the business unit |
Collection of Consumer |
None. |
StatusReports |
A list of all status reports of the business unit |
Collection of StatusReport |
None. |
StorageLimit |
A limit to how much storage a business unit may consume and used for calculating storage utilization. Overrides any included amounts on relevant subscriptions. Set to 0 if ignored. |
integer |
None. |
TransferLimit |
A limit to how much a business unit may transfer and used for calculating transfer utilization. Overrides any included amounts on relevant subscriptions. Set to 0 if ignored. |
integer |
None. |
NodeLimit |
A limit to how many nodes a business unit may have. Overrides any included amounts on relevant subscriptions. Set to 0 if ignored. |
integer |
None. |
PasswordExpirationDays |
Users in the hierarchy will need to update their password after n days Set to 0 (zero) to disable |
integer |
None. |
RequireTotp |
The users of the business unit and the underlying hierarchy must use TOTP when logging in |
boolean |
None. |
RequiredApproversOfDeleteRequest |
The number of users needed to approve a deletion request before the request is approved at this level. |
integer |
None. |
FinalDeleteRequestApprover |
Whether or not the business unit is the final approver of deletion requests or if the requests are sent higher up the system. |
boolean |
None. |
UsersCanApproveOwnRequests |
If users have the right privileges they are allowed to approve any deletion request even though the themselves requested it |
boolean |
None. |
ReportRemotely |
Whether or not the business unit should be reported to parent system |
boolean |
None. |
SynchronizeConsumerNames |
If set to true consumption units of the business unit will be renamed if their related data-sources are renamed If null setting is inherited from parent. If false, renaming data-sources will have no effect on the name of consumption units |
boolean |
None. |
RemoteId |
The ID the business unit has in a remote system. The ID indicates that the business unit was reported into the system If this ID exists the business unit will be restricted from most functionality in the system like creating consumer units, data centers etc. |
integer |
None. |
SystemId |
The unique ID of the system belonging to the business unit |
globally unique identifier |
None. |
ReportErrorConfig |
A report error configuration. |
ReportErrorConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available report error configuration in the ancestor heirarchy. |
NodeReportDeliveryConfig |
Default settings for how node reports are sent. If subscribers of node reports have no settings these are used |
NodeReportDeliveryConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available node report delivery configuration in the ancestor heirarchy. |
NodeDeletionRule |
Rule that determines how nodes and file spaces managed by the business unit are deleted on backend servers |
NodeDeletionRule |
None. |
Tags |
A list of tags describing the business unit |
Collection of Tag |
None. |
StatusReportDeliveryConfig |
Default settings for how status reports are sent. If subscribers of status reports have no settings these are used |
StatusReportDeliveryConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available status report delivery configuration in the ancestor heirarchy. |
ConsumptionUnitDeliveryConfig |
Default settings for how status report consumption unit incident mails are sent. If subscribers of status reports have no settings these are used |
StatusReportConsumptionUnitDeliveryConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available status report consumption unit delivery configuration in the ancestor heirarchy. |
JobDeliveryConfig |
Default settings for how jobs are sent. If subscribers of jobs have no settings these are used |
JobDeliveryConfig |
If left unspecified, the system will default to an inherited configuration, ie. the first available job delivery configuration in the ancestor heirarchy. |
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.