Edit an access pool

Edit online

Edit an existing Access Pool in the system.

Request

Edit online

Security

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

HTTP method

Edit online

Not using *Map parameters

POST /manager/api/{apiResponseType}/1.0/editAccessPool.adm HTTP/1.1
Host:{manager.dsnet} id={apId}
                     &name={newName}
                     &description={newDescription}
                     &vaultIds={vId1}
                     &vaultIds={vId2}
                     &vaultIds={vId3}
                     &mirrorIds={mId1}
                     &protocolType={s3|soh}
                     &accessServicePorts[https]={443|8443}
                     &accessDeviceIds={aDid1}
                     &s3VirtualHostSuffix={s3VirtualHostSuffix}
                     &additionalSubjectAltNames={additionalSubjectAltNames}
                     &includeDefaultIpsInAltNames={true|false}
                     &privateKeyPem={privateKeyPem}
                     &certificatePem={certificatePem}

or using *Map parameters

POST /manager/api/{apiResponseType}/1.0/editAccessPool.adm HTTP/1.1
Host:{manager.dsnet} id={apId}
                     &name={newName}
                     &description={newDescription}
                     &protocolType={s3|soh}
                     &accessServicePorts[https]={443|8443}
                     &s3VirtualHostSuffix={s3VirtualHostSuffix}
                     &additionalSubjectAltNames={additionalSubjectAltNames}
                     &includeDefaultIpsInAltNames={true|false}
                     &accessDeviceMap[{adMap1}]={add|remove}
                     &accessDeviceMap[300]={add|remove}
                     &vaultMap[{vMap1}]={add|remove}
                     &vaultMap[{vMap2}]={add|remove}
                     &mirrorMap[{mMap1}]={add|remove}
                     &mirrorMap[{mMap2}]={add|remove}
                     &privateKeyPem={privateKeyPem}
                     &certificatePem={certificatePem}

Curl method

Edit online

Not Using *Map parameters

curl -X 
POST -u admin:password 
     --header ”Content-Type: application/x-www-form-urlencoded“
     --header ”Accept: application/json“ 
     -k "https://{manager.dsnet}/manager/api/json/1.0/editAccessPool.adm" 
     -d "id={apId}
            &name={newName}
            &description={newDescription}
            &vaultIds={vId1}
            &vaultIds={vId2}
            &vaultIds={vId3}
            &mirrorIds={mId1}
            &protocolType={s3|soh}
            &accessServicePorts[https]={443|8443}
            &accessDeviceIds={aId1}
            &s3VirtualHostSuffix={s3VirtualHostSuffix}
            &additionalSubjectAltNames={additionalSubjectAltNames}
            &includeDefaultIpsInAltNames={true|false}
            &privateKeyPem={privateKeyPem}
            &certificatePem={certificatePem}
            "

Using *Map parameters

curl -X 
POST -u admin:password 
     --header ”Content-Type: application/x-www-form-urlencoded“
     --header ”Accept: application/json“ 
     -k "https://{manager.dsnet}/manager/api/json/1.0/editAccessPool.adm" 
     -d "id={apId}
            &name={newName} 
            &description={newDescription}
            &protocolType={s3|soh}
            &accessServicePorts[https]={443|8443}
            &s3VirtualHostSuffix={s3VirtualHostSuffix}
            &additionalSubjectAltNames={additionalSubjectAltNames}
            &includeDefaultIpsInAltNames={true|false} 
            &accessDeviceMap[{adId1}]={add|remove}
            &accessDeviceMap[{adIds]={add|remove}
            &vaultMap[{vId1}]={add|remove}
            &vaultMap[{vId2}]={add|remove}
            &mirrorMap[{mId1}]={add|remove}
            &mirrorMap[{mId2}]={add|remove} 
            &privateKeyPem={privateKeyPem}
            &certificatePem={certificatePem}
            "

Parameters

Edit online
Table 2. Request Parameters for Edit Access Pool (editAccessPool) API method
Parameter Type Usage Default Description
id

Long

Required

  

Manager-generated ID of an Access Pool
name

String

Optional

  

New name for Access Pool
description

String

Optional

  

New description for the Access Pool
vaultIds

Set

Optional

  

Updated list of Vault IDs to be deployed to Access Pool
mirrorIds

Set

Optional

  

Updated list of Vault Mirror IDs to be deployed to the Access Pool
protocolType

String

Required

  

Protocol type to set for Access Pool: s3, soh, or wos

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

Map

Optional

  

The complete set of Accesser device service ports (the ports on which the Accesser device will be 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 required when virtual host style addressing is used. The specified value should match the DNS entry that is routing requests to the Accesser 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 node certificates contain the Accesser nodes IP(s) and hostname. This field should be used when additional subject alternative names are required.

Example: IP:{IP-address-1},IP:{IP-address-2},DNS:{dns-name-1},DNS:{dns-name-2}
includeDefaultIpsInAltNames

Boolean

Optional

true

If the External PKI feature is being used and the certificate is being signed by a commercial certificate authority, it may not be possible to include the Accesser node IP(s) in the certificate. In this case, this parameter should be set to false to avoid a failure when the certificate is loaded into the Manager.
accessDeviceIds

Set

Optional

  

Updated list of Accesser node IDs to be deployed to the Access Pool
accessDeviceMap

Map

Optional

  

Map of Accesser node IDs to action, to either add or remove. This should not be provided along with accessDeviceIds
vaultMap

Map

Optional

  

Map of Vault ids to action, to either add or remove. This should not be provided along with vaultIds
mirrorMap

Map

Optional

  

Map of Mirror ids to action, to either add or remove. This should not be provided along with mirrorIds
defaultProvisioningCodeId

Long

Optional

  

The manager generated id of a deployed Container Vault. This vault will be used for container creation when a LocationConstraint is not provided during PUT bucket requests. If no default is set, the LocationConstraint will be a required parameter in the PUT bucket request. Container Mode 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.
privateKeyPem String Optional The trusted external private key associated with the external certificate(s). Note that if the privateKeyPem and CertificatePem parameters are present but empty, existing external certificate chain will be removed.
certificatePem String Optional The certificate(s) associated with the private key. Enter the host certificate and any intermediary CA certificates up to the root CA. Note that if the privateKeyPem and CertificatePem parameters are present but empty, existing external certificate chain will be removed.