Administration Guides

AnyCopy Admin & User Guide

Home


Overview

This guide covers how to use AnyCopy to create copy jobs and review settings for copy jobs, copy job history, monitoring copy job progress,  copy job audit logs.

Prerequisites 

  1. RBAC roles have been created for users and administrators of AnyCopy using an AD group and following the RBAC guide here.
  2. Clusters have syncIQ and SnapshotIQ licenses 
  3. All Eyeglass DR & AnyCopy licenses have been assigned to the source and target clusters.
  4. The Eyeglass admin role has been assigned the backup and restore permission for all clusters to be managed by AnyCopy. 

Limitations 

  1. Pre script operations will fail the entire copy job if the pre script return code for the ssh command is > 0
  2. Post script operations will complete the copy job even if the script return codes is in error
  3. Copy Jobs require inventory to complete and will wait until cluster inventory is completed before starting steps.
  4. The copy job file list audit log has no paging to view, for large file lists download the CSV and view in a text editor
  5. The copy job file list is created using Isilon change list using snapshots before and after the copy job. If files are added to the target path before the change change list step runs, these files will appear in the the copy job report file listing even though they were not copied.
  6. SMB share level permissions are used to determine source and target SMB path selection. NTFS ACL's are not used to restrict access to select a folder.
  7. File Collision handling - If a copy job is run more than once,  older files on the source path can overwrite a newer version of that file on the target.  Deleted data on the source path, will not be deleted from the target, since SyncIQ is using copy mode.    These limitations are SyncIQ with no work around.
  8. See a full list of release note items here.


Creating a Copy Job

  1. Login with your AD user name user@domain.com using the proxy login User interface. Refer to the RBAC guide link here.
  2. Open the AnyCopy Icon
  3. Mandatory Fields - Refer to the image below
    1. Job name (no special characters or spaces are allowed in the job name)
    2. Source:
      1. open this input and select a cluster
      2. Expand a smartconnect name (DNS name used to mount the cluster)
      3. Expand an  SMB share
      4. Expand the file system to select the source path that you want to copy all the data at this folder and below to the target folder.
      5. NOTE: SMB shares listed are based on the logged in users AD group membership and it will include shares with the well known Everyone permission.
    3. Destination:
      1. Repeat the same steps as above to select the target cluster path.  NOTE:  You can select the same cluster as the source to copy data between 2 different SMB shares and offload the copy to the cluster.
    4. Notifications:
      1. For a long running copy you may enable email or slack channel updates by selecting the check box "Notify Progress" , enter how often updates should be sent and enter email addresses using a comma separated list of emails that should be notified about this copy job.  
      2. NOTE:  This is useful to notify the end user who is waiting for this copy to be completed to start a new workflow with the data.
      3. (optional) Slack - enter the webhook url to publish updates on progress to a slack channel.
    5. Advanced Section
      1. Block Access to source data - This will lock the file system before the copy starts and no users will be able to save data on the source path if this is used.  It will apply a deny read permission on the SMB shares detected on the source path and below.    Once the copy completes the lockout is removed from the SMB shares.
      2. Allow Scheduling - this will leave the synciq policy after the copy job finishes and allow setting up a schedule within AnyCopy to run this copy on a regular basis.
        1. It also enables the option to use the on demand run now option in the Jobs History tab.  
      3. Copy Share Security to Target - This will read the SMB share definitions found under thee source path and will create the same SMB share(s) on the target cluster and path with the same security options and permissions configured.
      4. Run Scripts before and after allows a scripted action to be taken on the source path or target path or both.  These scripts must be setup by an administrator and should not be used unless directed by the AnyCopy administrator.
    6. Starting the copy jobs by finishing the settings configuration and click Start Copy Job.  See next section on how to monitor the copy job.
  4.    

How to monitor a running Copy Job

  1. Click no the running on the Running Copies tab to view running jobs.
  2. Details about the job are displayed, status and copy details.
    1. Clicking on Copy Details will allow monitoring real time progress, throughput and number of files copied and GB's transferred. 
    2. The lower part of the screen shows each step the copy job is executing depending on the options that were selected.
  3.  
  4. If email notifications was enabled you will get emails showing progress of the copy jobs.
    1. Progress emails will be sent on the interval selected in the copy job.  A final summary email that shows the total files, throughput, job duration, job details and UNC path to the target cluster SMB share is sent as per the example below.  
    2.   

How to View Copy Job Definitions, Job History, Job edit, Pre and Post script Assignment

  1. Completed jobs and history of each job execution (scheduled or on demand run now) are accessible from the Finished Jobs tab.  This page explains all the controls for jobs after they have run at least once.
  2.  
  3. Column Definitions
    1. Job name - this column is the name of the job entered by the user
    2. User - This column lists the user name of the logged in user that created the job.  
      1. NOTE:  Users can only see jobs they created.  Administrator role in AnyCopy can see all jobs created by all users as per the screenshot below.
    3. Status - This indicates if the copy job completed successfully without error and will show OK or a red error.
    4. Created - This is the date and time the copy job was created. 
    5. Run Now -  This column will show an icon only if the Schedule policy option was enabled, which will leave the policy on the source cluster after the copy finishes.  Pressing the run now option will start the job again based on its  defined settings.   
      1. Any job without the icon, indicates the synciq policy was deleted and the job cannot be run on demand.
      2. NOTE: If the job definition is edited to allow scheduling, then the run now icon will still show the icon and running the job will automatically recreate a new SyncIQ policy if it was previously deleted based on the job definition settings. 
    6. Edit - This opens a dialog box to allow editing the job definition and re-saving it, this is also where the job schedule is configured.  The edit options are the same as the job create settings user interface. Make any needed changes and click Save job Configuration button.
      1. On the edit page the option to select pre or post job operations check box(s) .   Selecting either pre or post and the icon next to the option will provide selection of operation labels configured by your administrator.
      2.  
    7.  Delete Policy - This column will show a trash can icon only if the policy was left behind and still exists on the cluster.
      1. Pressing this icon will immediately delete the synciq policy from the cluster and will display a confirmation box that this will be updated in inventory after the next schedule inventory job completes.
      2. After the next scheduled configuration inventory job runs in Eyeglass the trash can icon will disappear.
      3. Running the on demand option will recreate the SyncIQ policy again.
    8. Run History -  Each execution of a job via a schedule or on demand run now will create a run history with the date and time the job was run and 2 columns with each one providing access to logs.
      1. Time - Shows the date and time of each job execution
      2. Policy Job Summary - will provide an audit log that lists all files copied to the target folder path.
        1. This file list is created using the Isilon changelist feature, where a snapshot is taken on the target path before the copy is started.  After the copy is finished a 2nd snapshot is taken and the cluster API provides the differences which is the file list.
        2. The file list is provided as UNC path to the files using \\smartconnect name\SMB share name\path to file.
        3. Date Stamps of the files - created, modified, last accessed
        4. Action taken - Entry ADS means file was added to the target folder.
        5. Option to download this file to a CSV is available at the bottom of the window.
      3. Policy SyncIQ Report - This shows the diagnostic log captured from SyncIQ that is useful for support debugging or to align the SyncIQ job settings used on the SyncIQ policy.  It can also be used with Dell support if errors occur.   
        1. The file also has a download to txt file option in the UI.

How to Copy to Multiple targets - Content Distribution One to Many

  1. Requirements: 2.5.7 update 1
  2. When creating a new job definition simply click in the target drop down arrow to add additional targets.  Each target can be the same as the source cluster or a different cluster or any combination of local and remote targets.      
    1. This allows copying data to multiple shares on the same cluster or to remote clusters or both.
  3.   
  4. Fill in the remaining job definitions as normal including the option to schedule this copy job on an interval.

How to Edit a Copy Job Definition

  1. NOTE:  A copy job must run once before you can edit the configuration.
  2. NOTE:  An administrator can edit other user jobs.  Users can only edit job definitions they created themselves.
  3. Click the Finished Jobs tab
  4. Click the edit icon for the job you want to edit the configuration.
  5.  


How to Schedule a Copy Job

  1. Requires 2.5.7 update 1
  2. NOTE: An administrator can edit other user jobs. Users can only edit job definitions they created themselves.
  3. When creating a new job definition Click the Allow Scheduling checkbox and set the interval.  You can also uncheck keep policy after job is finished.  This will delete and create the synciq policy each time the job is scheduled.  This is useful if the target directory contains data that you want to write to in-between copy jobs.
  4. Complete the filling in the job details.
  5. To edit the schedule at a later time, follow the How to edit a job definition in this guide.


How to Review a Copy Job Definition

  1. From the Finished Jobs tab the list of jobs shows columns as described above.  To review the configuration summary of a job definition.  Click the + sign to expand the job details.
  2.  
  3. The options will match the Job configuration or edit screen and are summarized on this screen.   
  4. The screen also shows the "Last run" details and summarizes if the last run was successful, the job run time, and GB copied.   This provides a quick way to see when the last job ran and the details without using the job history view.

How to Delete a Job from the Finished Jobs Tab

  1. Open the AnyCopy Icon
  2. Click the finished job tab
  3. Use the Delete job trashcan next to the job you want to delete.  NOTE:  This cannot be undone.
  4.  


Advanced Administrator Pre and Post Script UI

  1. Overview:
    1. Pre and post script options allow create commands to run on the source or target path or both.  The commands can be ordered and configured as pre or post.
    2. The pre and post commands are a library of functions that can be selected by users using a command label assigned to the commands.
      1. When users enable pre or post scripts they must also select the commands from the library to apply to their job.    They will only see the command label and not the command itself in the UI.
      2. If the user is instructed to use more than on command the order of execution will be managed by the administrator who orders the commands in the pre and post administration UI.
    3. Only AnyCopy Administrators can create pre and post script operations for users to use
    4. The pre and post commands execute on the Isilon over ssh only Linux commands that run on Isilon can be used.   You can use ISI commands.   The command should be single line command to execute all logic or issue multiple commands.
    5. For more complex logic it is possible to create a scripts directory on the Isilon file system and reference a script name for more complex logic that requires a simpler way to maintain the logic within the bash script and simple reference this script name in AnyCopy UI.
  2. The pre AnyCopy Operations tab - This is where new commands can be added for pre copy steps to execute.
  3. The Post AnyCopy Operations tab - This is where new commands can be added for post copy steps to execute.
  4. Path substitution using variables
    1. The following variables can be used to insert an absolute path into your pre and post commands
    2. $DSTPATH - destination absolute path example /ifs/data/projectA is the destination copy target and this path will be replaced if this variable is used
    3. $SRCPATH - source absolute path example /ifs/data/projectA is the source path on the source cluster configured in AnyCopy.   

How to add a command to Pre or Post Operations with Path Variable Substitution 

  1.  
  2. Columns:
    1. Name - this is a name or label on the command to provide an idea of what it does.  no special characters or spaced can be used.
    2. Command is a single line command that will be executed over ssh and should use recursive flags to process a change across all files and folders below the directory.
    3. Cluster - The command can be run on the source or target cluster regardless of the pre or post setting.   Select source or target for this command.
    4. Delete -  This option allows deleting a command from the pre or post list of commands
    5. Up/Down - If multiple commands are used the up and down arrow orders the commands with the command listed at the top of the UI being executed first.   Re-order the commands based on the correct order of processing needed by your script logic.
    6. Selection Check Box - This check box allows testing your script logic by selecting the command and then clicking the Test Selected button.



Pre and Post Script Command Examples

These are examples to lock down data after a copy to remove all directory and file permissions and inheritance.   

  1. Apply read only to users group and other
    1. This command example will set the permissions on the source files to read only for Other and will try to set Owner, Group to read only.  NOTE: Directory inheritance may need to be disabled first.  Using chmod u+r,g+r,o+r 
    2. Uses $DSTPATH variable
    3. Recursive for files only
    4. sleep 2; find $DSTPATH -type f -iname "*" -print0 | xargs -I {} -0 chmod u+r,g+r,o+r {} 
    5. Cluster target
    6. Used as post script
  2. Remove inheritance and remove file ACES
    1. This command disables directory permissions from flowing down the directory tree so that permissions can be customized after the copy is completed.    This examples uses  3 commands on 1 line with a semi colon to allow each to run using a single line.  This can be used to combine steps into a single command entry
    2. It applies a block of inheritance with +dacl_protected , removes directory ACL and synthetic  auto inheritance
    3. It removes all ACE entries from all files using chmod -D
    4. Uses $DSTPATH variable
    5. Recursive for directories only and recursive for files to remove all ACE entries using chmod -c +dacl_protected  and chmod -c -sacl_auto_inherited  and  chmod -c -dacl_auto_inherited 
    6. Cluster is set to target
    7. Used as post script
    8. sleep 10; find $DSTPATH -type d -iname "*" -print0 | xargs -I {} -0 chmod -c +dacl_protected {};find $DSTPATH -type d -iname "*" -print0 | xargs -I {} -0 chmod -c -dacl_auto_inherited {};find $DSTPATH -type d -iname "*" -print0 | xargs -I {} -0 chmod -c -sacl_auto_inherited {}  ; find $DSTPATH -iname "*" -print0 | xargs -I {} -0 chmod -D {} 

Solution Example post Script Remove Inheritance and file ACE's with Read only data

  1. See how the above examples were used to create a solution to remove all permissions and inheritances of file and folder permissions.
  2.   
  3. Configure the Copy job to select the 2 labels configured in the post script operations tab and ordered as shown. 
  4.   

How to Extend the Copy Log Changelist job timeout

  1. Open an SSH session to Eyeglass
  2. Login as admin
  3. Elevate to root using : sudo su (enter admin password when prompted)
  4. Type the command below and press Enter
  5. sudo su
  6. Type the command below and press Enter
  7. sudo vi /opt/superna/sca/data/system.xml
  8. Once the file is opened, find/locate the tag below
  9. <changelistTimeout>300</changelistTimeout>
  10. Press i or "Insert" from your keyboard
  11. Replace 300 with new time out value - suggest 1800 the tag should look like <changelistTimeout>1800</changelistTimeout>
  12. If the file does not contain the tag add the following lines at the bottom of the file but before the </config> with new timeout value (example is 1800 s)
  13. <anycopy><changelistTimeout>1800</changelistTimeout></anycopy>
  14. Save the file:
  15. wq!
  16. Restart SCA service
  17. systemctl restart sca

How to Test script logic

  1. Not available in current release


POSIX Mode - How it Works

  1. Overview: If you are using NFS or AD authenticated users to access file systems with unified permissions using UID and GID locally generated by the cluster or stored in Active Directory RFC2703 UID and GID as properties of the user account can be used to present folders to the logged in user based on their UID/GID  or the other permission on a folder.   This allows posix permissions for owner, group or other to restrict what folders the user can see when selecting data to copy.
    1. How Owner, group, other permissions determine what is browsable in the GUI.
      1. The source input box enforces owner , group and other Only if the logged in user has Read permissions to the folder.  If they do not, the folder will not display.
      2. The target input box enforces owner , group and other Only if the logged in user has Read & Write permissions to the folder. If they do not, the folder will not display. 
  2. Example below shows 2 folders with folder1 secured to an AD user using UID and GID stored in AD, and folder2 is owned by root and wheel.
    1.   
  3. In this example the user demo1 logs into Eyeglass and has been assigned the AnyCopy user role to login.   When the user tries to browser under an SMB share (NOTE:  the user must have access to the SMB shares where posix data is stored. )   
    1. After login Eyeglass will have the UID and GID assigned to the user in Active Directory.
  4. The user will expand folders under the share and a REST API is used to check the owner and group of the folders,  the user must be either owner or member of the group granting access to the folder.  See screenshot below that only lists folder1.
  5.  

Advanced POSIX Permissions Mode Configuration

  1. To enable this mode
  2. ssh as admin
  3. sudo -s
  4. nano /opt/superna/sca/data/system.xml
  5. Inside the tags <anycopy>     and </anycopy> add this value
  6. <usePosixPermissions>true</usePosixPermissions>
  7. control+x  answer yes to save
  8. systemctl restart sca
  9. done





© Superna LLC