PATCH v1/bunits/{bunitId}/datacenters/{dataCenterId}/spservers/{spServerId}

Overwrites the resource's property values with the values specified in the delta object.

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 to update integer

Required

Body Parameters

Delta object containing values to update

SpServer

Request Formats

application/json, text/json

Sample:

Sample not available.

Response Information

Resource Description

SpServer
NameDescriptionTypeAdditional information
DedupStatsGenerationTime The time of day when dedup stats should be generated (default is 6.30 AM)
The time is locally for the server
time interval

None.

Version Current version of the server (1.x.x.x)
integer

None.

VersionName Current version, release, level and sublevel of the server
string

Read-only.

Release Current release of the server version (x.2.x.x)
integer

None.

Level Current level of the server version (x.x.3.x)
integer

None.

SubLevel Current sublevel of the server version (x.x.x.4)
integer

None.

InstallDate The date the server was installed
Used for resetting node IDs when seeing new install date
date

None.

MachineName Machine name of the server.
string

None.

ExternalReference Unique external reference
string

None.

NodeNetworkAddress The address which client machines use when communicating with the IBM Storage Protect server.
string

None.

NodeNetworkPort The port which client machines use when communicating with the IBM Storage Protect server.
integer

None.

PortalNetworkAddress The address which Cloutility uses when communicating with the IBM Storage Protect server.
string

None.

Port The port used for communication.
integer

None.

UseSsl Use SSL encryption during communication.
boolean

None.

ImportActivityLogs If activity logs are not a necessity omitting import will help performance and need of storage in database and memory
boolean

None.

GenerateDedupsStats Generate dedups stats.
boolean

None.

DeleteOldDedupStats By default old dedup stats are deleted and only latest retained.
If complete history is desired set to false
boolean

None.

GenerateDedupStatsForStoragePool Whether dedupstats should be generated for the entire storage pool
This is only available for servers with version 8.1 or higher
true: dedupstats are generated for entire storage pool. Wait seconds are not used for generating more efficiently
false: dedupstats are generated for each node using wait seconds between each command
boolean

None.

GenerateDedupsStatsWaitSeconds How long
This should only be turned off in case of severe performance problems.
Note that if disabled, all backup nodes on this server will report 0 GB-
values for business units being settled according to front-end capacity.
integer

None.

AllowedDedupStatThreads The number of threads generating dedup stats that are allowed to run simultanious
on the server.
integer

None.

ImportOverlapMinutes Because SP may delay writing summaries to the DB2
In this case the importer may miss delayed summaries.
By setting the Activity Overlap Minutes you will allow the importer
to go further back in time when importing and hence pick up the
missing summaries. This may result in a performance loss as more
data is handled
integer

None.

ImportStoragePoolInfoFromScale Information about how much storage is used and available on a storage pool
can be found in Scale. If the user does not wish to use Scale to get this information
it will be fetched from storage pools directories. These may not be as accurate as information
from Scale
boolean

None.

LowestAllowedClientVersion The lowest allowed client version nodes connected to this server can have.

If a backup node has a client with a lower version alarms will be made.
string

None.

LowestCompatibleClientVersion The lowest compatible client version nodes connected to this server can have.

If a backup node has a client with a lower version alarms will be made.
string

None.

DeleteTimeStart The time of day when deletion from IBM Storage Protect server is allowed
time interval

None.

DeleteTimeEnd The time of day when deletion from IBM Storage Protect server is allowed
time interval

None.

Domains The domains available on the server.
Collection of Domain

None.

ClientOptionSets The client option sets available on the server.
Collection of ClientOptionSet

None.

Type The type of server:
1: IBM Storage Protect
2: IBM Storage Protect Plus
3: Rubrik (CDM or SC)
4: Cohesity (Cluster or Helios)
5: PoINT Archival Gateway
ServerType

None.

ReportingTime The time of day when reporting should be done (default is 08: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.