API Explorer
API Explorer
Introduction
What's New
Appliance Management
Application Data Management
Asset Management
Asset Metadata
Authentication and Authorization
Cloud Disaster Recovery
Compliance
Copy Management
Credentials Management
Discovery
File Level Restore
Installation
Inventory Source Management
Kubernetes Data Management
Licenses Management
Location Management
Log Management
Monitoring
Protection Policies
Recovery and Reuse Management
Remote Service
Search Clusters
Secrets Manager
Server Disaster Recovery
Storage Management
Telemetry Setting
Upgrade
User Security Management
Virtual Machine Data Management
Whitelist Management

Setting extended retention stage values

This tutorial describes how to set the extended retention look-back or look-forward option.

The following API operations are used:

GET /api/v2/common-settings/COMPLIANCE_SETTING
PUT /api/v2/common-settings/COMPLIANCE_SETTING

How it works

You can configure a policy with three extended retention stages:

Extend retention stage Designated day
Weekly First day of week (Sunday)
Monthly First day of month
Yearly Last day of year (December 31)

These stages enable you to retain copies that occur weekly, monthly, and yearly on the designated days. If no valid copy is available on the designated day, the system looks back or forward in time to acquire a valid copy. You control the look-back or look-forward behavior by the enableLookForward property setting.

Look forward

To look forward in time, set enableLookForward=true. When enableLookForward=true, an additional setting is enabled for each extended retention stage. This setting has the value PnD, where n=number of retries on subsequent days. The PnD settings determine how many days to look forward in time for a valid copy.

For example, in the weekly extended retention, if you configure the system to look forward one day (P1D), it first looks for a Sunday copy. If no Sunday copy is available, it looks for one on Monday. If Monday has no copy, the extended retention fails and no copy is retained. To retry daily for the whole week, use P7D. Monthly and yearly extended retentions work similarly.

Look back

The default setting is to look back in time for a valid copy. When enableLookForward=false, the PnD settings are not used.

For example, in the weekly extended retention, if no Sunday copy is available, the system looks back daily for up to a week until a valid copy is acquired. Similarly, in the monthly extended retention, if no Sunday copy is available, the system looks back daily for up to four weeks until a valid copy is acquired. These behaviors are not configurable.

Usage

The configuration of weekly, monthly, and yearly extended retentions depends on your requirements. For example, the look-back option might be useful for new installation or upgrade use cases. How you use the look-forward option also depends on your requirements. If the failure of a weekly copy has a low priority, you could set the weekly PnD to P0D, allowing the extended retention to fail if no Sunday copy is available. Monthly and yearly extended retentions might have higher priorities with settings of P2D or greater to ensure that a copy is acquired and retained.

Login

Use the login API to retrieve the access token. For more details, see the tutorial that describes authentication and authorization.

Get extended retention setting

Get the current look-back or look-forward setting by using the GET operation:

URI Operation Description Return Codes
/api/v2/common-settings/COMPLIANCE_SETTING GET Returns compliance internal setting parameters 200 OK
404 Not Found
401 Not Authorized

Sample request:

curl --request GET \
  --url https://<your-ppdm-server>:8443/api/v2/common-settings/COMPLIANCE_SETTING \
  --header 'content-type: application/json' \
  --header 'Authorization:  {{access_token}}'
  • The access_token is obtained from the Login API call.

Sample response:

OK (200)
{
    "id": "COMPLIANCE_SETTING",
    "properties": [
        {
            "name": "scheduleEnable",
            "value": "true",
            "type": "BOOLEAN"
        },
        {
            "name": "stopQueue",
            "value": "false",
            "type": "BOOLEAN"
        },
        {
            "name": "scheduleTime",
            "value": "0 0 0 * * ?",
            "type": "STRING"
        },
        {
            "name": "defaultCopyDeletionTimeout",
            "value": "60",
            "type": "LONG"
        },
        {
            "name": "brownfieldExpiredDeletion",
            "value": "false",
            "type": "BOOLEAN"
        },
        {
            "name": "enableLookForward",
            "value": "false",
            "type": "BOOLEAN"
        },
        {
            "name": "lookForwardWeekly",
            "value": "P2D",
            "type": "STRING"
        },
        {
            "name": "lookForwardMonthly",
            "value": "P2D",
            "type": "STRING"
        },
        {
            "name": "lookForwardYearly",
            "value": "P2D",
            "type": "STRING"
        }
    ]
}

Change extended retention setting

Change the extended retention setting by using the PUT operation:

URI Operation Description Return Codes
/api/v2/common-settings/COMPLIANCE_SETTING PUT Change extended retention setting 200 OK
400 Valid Request
401 Request not allowed
403 Not Authorized

Sample request:

PUT api/v2/common-settings/COMPLIANCE_SETTING

The request includes this request body:

json
{
    "id": "COMPLIANCE_SETTING",
    "properties": [
        {
            "name": "enableLookForward",
            "value": "false",
            "type": "BOOLEAN"
        },
        {
            "name": "lookForwardWeekly",
            "value": "P2D",
            "type": "STRING"
        },
        {
            "name": "lookForwardMonthly",
            "value": "P2D",
            "type": "STRING"
        },
        {
            "name": "lookForwardYearly",
            "value": "P2D",
            "type": "STRING"
        }
    ]
}
Property name Value Description
enableLookForward true
false
true: Look forward if no copy is available on the designated day
false: Look back if no copy is available on the designated day
lookForwardWeekly
lookForwardMonthly
lookForwardYearly
PnD, where n=number of retries lookForwardWeekly: Number of retries for weekly extended retention schedule
lookForwardMonthly: Number of retries for monthly extended retention schedule
lookForwardYearly: Number of retries for yearly extended retention schedule
These properties are valid only if the look-forward option is enabled (enableLookForward=true).
Examples:
P0D - Grace period of zero days. If no copy is available on the designated day, the extended retention fails.
P1D - Grace period of one day. If no copy is available on the designated day, retry the next day. If no copy is available on that day, the extended retention fails.