Edit a mirror template
Edit a mirror template. Returns success or failure status.
Request
Security
| Any | Super User | System Admin | Security Admin | Operator |
|---|---|---|---|---|
| superUser | systemAdmin |
HTTP method
POST /manager/api/{apiResponseType}/1.0/editMirrorTemplate.adm HTTP/1.1
Host:{manager.dsnet} id={mirrorId}&name={mirrorName}
Curl method
curl -X POST -u admin:password --header ”Content-Type:
application/x-www-form-urlencoded“ --header ”Accept: application/json“ -k
'https://192.168.25.14/manager/api/json/1.0/editMirrorTemplate.adm' -d 'id=1'
Parameters
| Parameter | Type | Usage | Default | Description |
|---|---|---|---|---|
| id | Long | Required |
The ID of the mirror template to modify. |
|
| name | String | Required |
The name for the new mirror template. |
|
| description | String | Optional |
The description to assign to the mirror template. |
|
| synchronousOperations | Optional |
Contains mirror operations and a flag that represents whether they are synchronous operations (true) or not (false). |
||
| versioning |
Versioning state to set for vaults that are created that use this vault template. |
|||
| deleteRestricted | Boolean |
Boolean representing whether the created vault is restricted on deletes or not. |
||
| segmentSize | Required |
Size of segments when data is being written. |
||
| segmentSizeUnit |
Unit of measurement for segment size value. |
|||
| softQuotaSize |
The soft quota size of the vault, which is combined with softQuotaUnit. |
|||
| softQuotaUnit |
The unit value to use for soft quota size. For example: bytes, kB, MB, KiB, MiB, etc. |
|||
| hardQuotaSize |
The hard quota size of the vault, which is combined with hardQuotaUnit. |
|||
| hardQuotaUnit |
The unit value to use for hard quota size. For example: bytes, kB, MB, KiB, MiB, etc. |
|||
| nameIndexEnabled | Boolean |
Boolean representing whether Named Index should be enabled or not. |
||
| recoveryListingEnabled | Boolean |
Boolean representing whether Recovery Listing should be enabled or not. |
||
| allowedIps | A comma-separated list of ALL IP addresses (+ optionally action groups) that should have access to the vault | |||
| accessPoolIds |
An array of Access Pool IDs that are deployed to vaults created from this vault template. It should not be provided along with accessPoolMap. |
|||
| accessPoolMap |
A map of Access Pool IDs to an action value, representing whether the access pool should be added or removed from the list of deployed Access Pools. It should not be provided along with accessPoolIds. |
|||
| accessMap | A map of IP address to action representing whether to add or remove the IP (+ optionally action groups) from the set of allowed | |||
| storagePoolId1 | Required |
The Storage Pool on which the first vault template should be created. |
||
| vaultWidth1 | Required | |||
| threshold1 | Required |
The IDA threshold |
||
| writeThreshold1 |
The number of sites you need to write data to in order for the request to be considered successful. |
|||
| alertLevel1 |
The number of healthy Slicestor devices that are needed to be considered healthy. |
|||
| privacyEnabled1 | Boolean | Optional | true |
Enable (true) or disable (false) SecureSlice™ for vaults created from vault template 1. If not provided, value defaults to the system level SecureSlice™ configuration. |
| privacyAlgorithm1 | String |
Valid privacy algorithms are aont-aes-gcm-256, aont-rc4-128, aont-aes-128, or aont-aes-256. If not provided, value defaults to the system level SecureSlice™ configuration. |
||
| storagePoolId2 | Required |
The Storage Pool on which the second vault template should be created. |
||
| vaultWidth2 | Required | |||
| threshold2 | Required |
The IDA threshold |
||
| writeThreshold2 |
The number of sites you need to write data to in order for the request to be considered successful. |
|||
| alertLevel2 |
The number of healthy Slicestor devices that are needed to be considered healthy. |
|||
| privacyEnabled2 | true |
Enable (true) or disable (false) SecureSlice™ for vaults created from vault template 2. If not provided, value defaults to the system level SecureSlice™ configuration. |
||
| privacyAlgorithm2 |
Valid privacy algorithms are aont-aes-gcm-256, aont-rc4-128, aont-aes-128, or aont-aes-256. If not provided, value defaults to the system level SecureSlice™ configuration. |
|||
| protectionState | String | Optional | disabled | Possible values are–disabled, or enabled. Note: To support backwards compatibility with ClevOS 3.12.0, this
request accepts the value
Compliance for the Status parameter in
addition to Retention. The protection state Retention and
Compliance are used interchangeably. |
| minimumRetentionPeriod | Long | Optional | 0 days | Accepts value in days. Minimum value should be ≥ 0 days. This parameter is only valid if protection state is set to enabled. Note: This is for vault mode only.
|
| maximumRetentionPeriod | Long | Optional | 36159 days | Accepts value in days. Maximum value should be ≤ 2,147,483,647 days. This parameter is only valid if protection state is set to enabled. Note: This is for vault mode
only.
|
| defaultRetentionPeriod | Long | Optional | 730 days | Accepts value in days. The default must be ≥mininumumRetentionPeriod and
≤maximumRetentionPeriod retention period. This parameter is only valid if protection state is set to enabled. Either defaultRetentionPeriod or defaultPermanentRetentionDurationEnabled should be specified, but not both. Note: This is for vault mode only.
|
| restrictiveAccessControlEnabled | Boolean | Optional | false | Enable restrictive access control on a protected mirror. Note: When Restrictive Access
Control is enabled, users with vault access permissions do not obtain equivalent object access
permissions. Object read, metadata write, and access control updates can only be performed by the
owner of the object in a protected vault or any user authorized by the owner. If this setting is
disabled, users with vault permissions inherit equivalent object permissions, such as the ability to
modify object protection. Once enabled, you cannot disable Restrictive Access Control.
Note:
Access pool cannot be deployed on protected mirror until it has both primary and secondary
vaults.
|
| permanentRetentionEnabled | Boolean | Optional | false | This
allows objects to have permanent retention. This parameter is only valid if protection state is set to enabled. Note: This is vault mode only.
|
| defaultPermanentRetentionDurationEnabled | Boolean | Optional | false |
When set to true, objects written into this mirror without a specific retention period will have permanent retention. This parameter is only valid if protection state is set to enabled. Either defaultRetentionPeriod or defaultPermanentRetentionDurationEnabled should be specified, but not both. Note: This is vault mode only.
|
| powerSafeWriteEnabled | Boolean | Boolean representing whether the created vault should have Power Safe Write enabled. | ||
| indexFormat | String | Optional | The vault index format to be used when editing a mirror template. Valid values are index2 and index4. When nothing is passed, the value is the system default that was set in the configureNameIndexFormat API method. |
Response
Returns success or failure status.
JSON response example
{
”responseStatus“: ”ok“,
”responseHeader“: {
”status“: ”ok“,
”now“: 1399577922741,
”requestId“: ”U2vdQsCoDkMAACkJCP0AAAAI“
},
”responseData“: {}
}