Edit a storage pool

Edit online

Edits an existing storage pool.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Edit Storage Pool API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/editStoragePool.adm HTTP/1.1 Host:{manager.dsnet} id={spId}&description={description}

Curl method

Edit online

curl -u {admin}:{password} 
     -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editStoragePool.adm“ 
     -d ”id={spId}&description={deription}“

Parameters

Edit online
Table 2. Request Parameters for Edit Storage Pool (editStoragePool) API method
Parameter Type Usage Default Description
id Long Required  

ID of an existing storage pool.
name String Optional  

New, unique name for storage pool.
description String Optional  

Description for the storage pool.
advancedConfiguration String Optional  
  • String containing key=value pairs for various advanced configuration options.
  • Takes effect for devices on the storage pool.
  • Advanced configuration must be enabled system wide via the Administration page for any changes to take effect.
analyticsEnabled Boolean Optional false

Enables (true) or disables (false) analytics in the storage pool.
protocolType String Optional  

Protocol type to set for Accesser Service on the Storage Pool. Valid values are s3, soh, or wos.

The system reject requests over SOH/WOS/Open Stack for protected vaults.

When the system is in container mode, the Simple Object API Type is not supported.
accessServicePorts Map Optional  

The complete set of Accesser Service ports (the ports on which the service is listening).

Ports must be one of 80, 443, 8080, 8443, 8337, or 8338 (Container Mode only).
s3VirtualHostSuffix String Optional  

The S3 Virtual Host Suffix is needed when virtual host style addressing is used. The specified value should match the DNS entry that is routing requests to the Slicestor nodes.
staticWebsiteVirtualHostSuffix

String

Optional

  
If Static Website Hosting is wanted, specify the Static Website Virtual Host Suffix.
  • Static Website Hosting must be enabled on one or more vaults.
  • Vaults must have DNS-compliant names.
additionalSubjectAltNames String Optional  

By default, Accesser Service node certificates contain the Slicestor nodes IPs and hostname. This field should be used when extra subject alternative names are needed.

Example - IP:{IP-address-1},IP:{IP-address-2},DNS:{dns-name-1},DNS:{dns-name-2}.
defaultProvisioningCodeId Long Optional  

The manager generated ID of a deployed Container Vault. This vault is used for container creation when a LocationConstraint is not provided during PUT bucket requests. If no default is set, the LocationConstraint is a needed parameter in the PUT bucket request. Container Mode only.

CAUTION:
Parameters from protocolType and below are relevant for Storage Pools with the embedded accesser service only.
managementVaultId Long Management Vault Configuration = manual  

Devices in storage pools must be set at the storage pool level.

Accessers and Managers can still be set individually.
defaultVaultIndexFormat String Optional   The vault index format to be used by default when editing a vault on this storage pool. Valid values are index2, and index4. When nothing is passed, the value is the system default that was set in the configureNameIndexFormat API method.
storagePoolSetAdvancedConfigurations Map Optional   The complete map of storage pool set ids and strings containing the full set of key=value pairs for various advanced configuration options.
  • Takes effect for devices on the storage pool set.
  • Advanced configuration must be enabled system wide using the Administration page for any changes to take effect.
CAUTION:
Requests using this optional parameter must include the complete map of storage pool set id -> advanced configurations for ALL sets in the storage pool. The provided map overwrites all existing values.