POST v1/bunits/{bunitId}/datacenters/{dataCenterId}/rubrikservers
Create a new server and starts a synchronization process.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit of the data center | integer |
Required |
dataCenterId |
The ID of the data center where the server is created | integer |
Required |
Body Parameters
The server to be created
RubrikServer| Name | Description | Type | Additional information |
|---|---|---|---|
ApiAddress |
Address of the API of the server used for communication |
string |
None. |
RubrikServerType |
The type of server. Options are 1 = Cloud Management Data 2 = Security Cloud |
RubrikServerType |
None. |
Version |
The version of Rubrik running on the server |
string |
None. |
PrimaryClusterName |
Name of the primary cluster |
string |
Read-only. |
PrimaryClusterId |
Id of the primary cluster |
string |
Read-only. |
BackupPolicies |
All backup policies of the server |
Collection of BackupPolicy |
None. |
Disks |
Collection of RubrikServerDisk |
None. |
|
Type |
The type of server IBM Storage Protect IBM Storage Protect Plus |
ServerType |
None. |
ReportingTime |
The time of day when reporting should be done (default is 8.00 AM) The time is locally for the server |
time interval |
None. |
TimeZone |
The time zone is used during server activity import, which is performed at 08.30 AM every day. Reports are created at the time of import as well. |
TimeZone |
None. |
Name |
Server name. |
string |
None. |
Description |
Server description. |
string |
None. |
IsDefaultServerForBusinessUnit |
A business unit can have one and only one default server and this is used when creating nodes. If a backup node is created for a business unit with no default server this server will be used instead. |
boolean |
None. |
ImportFromServer |
Import activity data from this server. Switching this off could be relevant if the server is used for testing or is somehow not available. |
boolean |
None. |
DeleteMissingItems |
If a data-source is found missing on the server the related consumption unit (if any) is deleted in Cloutility removing the relationship with the business unit. |
boolean |
None. |
LastSuccessfulReportTime |
The date and time when reporting last succeeded on the server. This information is based on the reports of the server |
date |
None. |
LastSuccessfulImportTime |
The date and time when importing last succeeded on the server. This information is based on the reports of the server |
date |
None. |
ErrorsDeactivated |
If the server fails during activity import, ignore it for the remaining tasks and continue. If IgnoreServerOnImportError is false, any import errors for this IBM Storage Protect server will completely stop the activity import daemon for all servers related to the business unit. This property is only relevant if ImportFromServer is enabled. |
boolean |
None. |
ReadOnly |
If a server is read-only, nothing will be created or registered on the server. Only data retrieval will be possible. |
boolean |
None. |
DefaultCredentials |
The credentials used when communicating with the server. |
ServerCredentials |
None. |
DataCenter |
The data center member is only included in few cases because servers are typically retrieved through their respective data center objects and not the other way around. |
DataCenter |
None. |
Errors |
Errors since last reporting |
Collection of ServerError |
None. |
LatestReport |
The latest report for the server |
BackupServerReport |
None. |
Consumers |
List of all data-sources assigned to business units |
Collection of 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 server with created information
RubrikServer| Name | Description | Type | Additional information |
|---|---|---|---|
ApiAddress |
Address of the API of the server used for communication |
string |
None. |
RubrikServerType |
The type of server. Options are 1 = Cloud Management Data 2 = Security Cloud |
RubrikServerType |
None. |
Version |
The version of Rubrik running on the server |
string |
None. |
PrimaryClusterName |
Name of the primary cluster |
string |
Read-only. |
PrimaryClusterId |
Id of the primary cluster |
string |
Read-only. |
BackupPolicies |
All backup policies of the server |
Collection of BackupPolicy |
None. |
Disks |
Collection of RubrikServerDisk |
None. |
|
Type |
The type of server IBM Storage Protect IBM Storage Protect Plus |
ServerType |
None. |
ReportingTime |
The time of day when reporting should be done (default is 8.00 AM) The time is locally for the server |
time interval |
None. |
TimeZone |
The time zone is used during server activity import, which is performed at 08.30 AM every day. Reports are created at the time of import as well. |
TimeZone |
None. |
Name |
Server name. |
string |
None. |
Description |
Server description. |
string |
None. |
IsDefaultServerForBusinessUnit |
A business unit can have one and only one default server and this is used when creating nodes. If a backup node is created for a business unit with no default server this server will be used instead. |
boolean |
None. |
ImportFromServer |
Import activity data from this server. Switching this off could be relevant if the server is used for testing or is somehow not available. |
boolean |
None. |
DeleteMissingItems |
If a data-source is found missing on the server the related consumption unit (if any) is deleted in Cloutility removing the relationship with the business unit. |
boolean |
None. |
LastSuccessfulReportTime |
The date and time when reporting last succeeded on the server. This information is based on the reports of the server |
date |
None. |
LastSuccessfulImportTime |
The date and time when importing last succeeded on the server. This information is based on the reports of the server |
date |
None. |
ErrorsDeactivated |
If the server fails during activity import, ignore it for the remaining tasks and continue. If IgnoreServerOnImportError is false, any import errors for this IBM Storage Protect server will completely stop the activity import daemon for all servers related to the business unit. This property is only relevant if ImportFromServer is enabled. |
boolean |
None. |
ReadOnly |
If a server is read-only, nothing will be created or registered on the server. Only data retrieval will be possible. |
boolean |
None. |
DefaultCredentials |
The credentials used when communicating with the server. |
ServerCredentials |
None. |
DataCenter |
The data center member is only included in few cases because servers are typically retrieved through their respective data center objects and not the other way around. |
DataCenter |
None. |
Errors |
Errors since last reporting |
Collection of ServerError |
None. |
LatestReport |
The latest report for the server |
BackupServerReport |
None. |
Consumers |
List of all data-sources assigned to business units |
Collection of 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.