PUT v1/bunits/{bunitId}/datacenters/{dataCenterId}/spservers/{spServerId}/domains/{domainId}

Update a domain.
(SP)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId The ID of the business unit of the data center integer

Required

dataCenterId The ID of the data center of the server integer

Required

spServerId The ID of the server of the domain integer

Required

domainId The ID of the domain to update integer

Required

Body Parameters

The domain object to update

Domain
NameDescriptionTypeAdditional information
Name The name of the domain
string

None.

Description The description of the domain.
string

None.

BackupRetention Number of days to retain backup versions of files that are no longer on the client file system
Default value is 30 ~ one month
integer

None.

ArchiveRetention Number of days to retain archive copies
Default value is 365 ~ one year
integer

None.

MissingInTsm If a domain has been deleted on the IBM Storage Protect server but has been assigned to not-activated backup nodes
it cannot be deleted in Cloutility. Instead it is set to be missing and missing domains cannot be selected
for newly created domains.
boolean

None.

Server The server containing the domain
SpServer

None.

Schedules Schedules of the domain
Collection of Schedule

None.

Nodes Backup nodes in the domain
Collection of Node

None.

PolicySets Policy sets in the domain
Collection of PolicySet

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 updated domain

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.