Lock Propagation Using REST API
Learn how to manage the lock propagation policy for migration jobs using the DryvIQ REST API.
Table of Contents
Overview
The lock propagation feature allows you to configure if the lock status for files on the source will transfer to the destination with the same setting, assuming the destination platform supports it.
Options | Behaviors |
---|---|
ignore | Lock status for files on the source will not propagate to the destination. |
mirror_lock | Lock status for files on the source will propagate to the destination. |
mirror_owner | Lock owners on the source will propagate to the destination. |
Only Box has full support for lock propagation mirror_owner.
Microsoft Office 365, SharePoint 2013-2016, and OneDrive for Business support reads but not writes. Therefore, lock propagation mirror_owner is fully supported only when one of these connectors are the source, and Box is the destination.
Supported Platforms
- Box
- Office 365
- SharePoint 2013-2016
- OneDrive for Business
Example Scenario
- Create a connector for Box and Office 365.
- Create a new job with the specified lock propagation setting.
- On the source connector (i.e., Box), create a folder with one or more files and lock them.
- Right-click the file on Box and select the “Lock” option.
- Folders cannot be locked on Box.
- Execute the job (i.e., Box to Microsoft Office 365) and verify that the files are copied and that the file is locked on the destination side.
Expected Results
- If the setting is ignore, no locks will be propagated. On Microsoft Office 365, there will be no green arrow on the file icon.
- If the lock setting is mirror, the lock will propagate. On Microsoft Office 365, a green arrow will be present on the file icon indicating it is "checked-out" or locked.
- If the lock setting is mirror_owner, the lock will propagate and be under the ownership of the account mapped from the source.
The mirror_owner setting requires Account Mapping through User-Drive Mapping.
Lock Propagation on NFS
DryvIQ can't unlock files on NFS, so locked files will get flagged. DryvIQ advises that you ignore these locks. When the files get checked back in, DryvIQ will migrate the file on the next job run. You also have the option of identifying the locked files through the flagged items and taking action on the file by either checking it in for the next job run or manually migrating it; however, these actions can result in an extensive flagged item report.
Example JSON
"lock_propagation" : "ignore"
Value Options: ignore (default), mirror_owner, mirror_lock
{
"name":"Bundle X Lock Prop Ignore Test",
"kind": "transfer",
"transfer": {
"audit_level": "trace",
"lock_propagation": "ignore",
"transfer_type": "copy",
"source": {
"connection": { "id": "{{cloud_connection_source}}" }
,
"target":
{"path":"/MASTER_TESTS/Lock Prop Tests"}
},
"destination": {
"connection": { "id": "{{cloud_connection_destination}}" },
"target": {
"path": "/SAP/LB/Bundle X Lock Prop Ignore Tests"
}
}
},
"schedule": {
"mode": "manual"
}
}