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

Moving assets across protection policies

This example describes how to use REST API to enable or disable moving assets across protection policies. PowerProtect Data Manager can use a protection rule to automatically assign, un-assign, or re-assign assets for protection policies when new assets are discovered or deleted, or an asset field or protection rule changes. By default, the behavior is enabled for all asset types that support protection rules. If the setting is turned off, only unprotected assets are allowed to move to the appropriate protection policy.

The user can enable or disable this feature by configuring the DYNAMIC_FILTER_SETTING through the following REST API.

PUT /api/v2/common-settings/DYNAMIC_FILTER_SETTING

Login

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

Get DYNAMIC_FILTER_SETTING

Get the DYNAMIC_FILTER_SETTING in PowerProtect Data Manager.

URI Operation Description Return Codes
/api/v2/common-settings/DYNAMIC_FILTER_SETTING GET Returns a list of asset types that are enabled for moving across protection policies in PowerProtect Data Manager 200 OK
400 Bad Request
401 Not Authorized
curl --request GET \
  --url https://<your-ppdm-server>:8443/api/v2/common-settings/DYNAMIC_FILTER_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": "DYNAMIC_FILTER_SETTING",
    "properties": [
        {
            "name": "supportMoveAssetsAcrossProtectionPolicy",
            "value": "VMWARE_VIRTUAL_MACHINE, VMAX_STORAGE_GROUP, XTREMIO_CONSISTENCY_GROUP, ORACLE_DATABASE, MICROSOFT_SQL_DATABASE, FILE_SYSTEM, KUBERNETES, SAP_HANA_DATABASE, MICROSOFT_EXCHANGE_DATABASE",
            "type": "LIST"
        }
    ]
}

NOTE: The default value includes all asset types that support the protection rule capability in PowerProtect Data Manager.

Update DYNAMIC_FILTER_SETTING

Disable moving assets across protection policies

This example shows how to use the DYNAMIC_FILTER_SETTING to disable moving VM assets (VMWARE_VIRTUAL_MACHINE) across protection policies.

URI Operation Description Return Codes
/api/v2/common-settings/DYNAMIC_FILTER_SETTING PUT Change DYNAMIC_FILTER_SETTING to disable moving a specific asset type across protection policies. 200 OK
400 Bad Request
401 Not Authorized
curl --request PUT \
  --url https://<your-ppdm-server>:8443/api/v2/common-settings/DYNAMIC_FILTER_SETTING \
  --header 'content-type: application/json' \
  --header 'Authorization:  {{access_token}}'

Sample request body to disable moving VMWARE_VIRTUAL_MACHINE assets across protection policies:

{
    "id": "DYNAMIC_FILTER_SETTING",
    "properties": [
        {
            "name": "supportMoveAssetsAcrossProtectionPolicy",
            "value": "VMAX_STORAGE_GROUP, XTREMIO_CONSISTENCY_GROUP, ORACLE_DATABASE, MICROSOFT_SQL_DATABASE, FILE_SYSTEM, KUBERNETES, SAP_HANA_DATABASE, MICROSOFT_EXCHANGE_DATABASE",
            "type": "LIST"
        }
    ]
}

NOTE: In this sample request, the VMWARE_VIRTUAL_MACHINE asset type is removed from the value property.

Sample response:

{
    "id": "DYNAMIC_FILTER_SETTING",
    "properties": [
        {
            "name": "supportMoveAssetsAcrossProtectionPolicy",
            "value": "VMAX_STORAGE_GROUP, XTREMIO_CONSISTENCY_GROUP, ORACLE_DATABASE, MICROSOFT_SQL_DATABASE, FILE_SYSTEM, KUBERNETES, SAP_HANA_DATABASE, MICROSOFT_EXCHANGE_DATABASE",
            "type": "LIST"
        }
    ]
}

NOTE: Asset type VMWARE_VIRTUAL_MACHINE does not appear in the value property in the DYNAMIC_FILTER_SETTING. VM assets are disabled from moving across protection policies.

Enable moving assets across protection policies

This example shows how to use the DYNAMIC_FILTER_SETTING to enable moving VM assets (VMWARE_VIRTUAL_MACHINE) across protection policies.

URI Operation Description Return Codes
/api/v2/common-settings/DYNAMIC_FILTER_SETTING PUT Change DYNAMIC_FILTER_SETTING to enable moving assets across protection policies for specific asset type. 200 OK
404 Not Found
401 Not Authorized
curl --request PUT \
  --url https://<your-ppdm-server>:8443/api/v2/common-settings/DYNAMIC_FILTER_SETTING \
  --header 'content-type: application/json' \
  --header 'Authorization:  {{access_token}}'

Sample request body to enable moving VM assets across protection policies:

{
    "id": "DYNAMIC_FILTER_SETTING",
    "properties": [
        {
            "name": "supportMoveAssetsAcrossProtectionPolicy",
            "value": "VMWARE_VIRTUAL_MACHINE, VMAX_STORAGE_GROUP, XTREMIO_CONSISTENCY_GROUP, ORACLE_DATABASE, MICROSOFT_SQL_DATABASE, FILE_SYSTEM, KUBERNETES, SAP_HANA_DATABASE, MICROSOFT_EXCHANGE_DATABASE",
            "type": "LIST"
        }
    ]
}

Sample response:

{
    "id": "DYNAMIC_FILTER_SETTING",
    "properties": [
        {
            "name": "supportMoveAssetsAcrossProtectionPolicy",
            "value": "VMWARE_VIRTUAL_MACHINE, VMAX_STORAGE_GROUP, XTREMIO_CONSISTENCY_GROUP, ORACLE_DATABASE, MICROSOFT_SQL_DATABASE, FILE_SYSTEM, KUBERNETES, SAP_HANA_DATABASE, MICROSOFT_EXCHANGE_DATABASE",
            "type": "LIST"
        }
    ]
}

NOTE: Asset type VMWARE_VIRTUAL_MACHINE is added to the value property in the DYNAMIC_FILTER_SETTING. VM assets are enabled to move across protection policies.