Sections

 

Audience

Any user of the Migration App.

This product is currently in Beta. We invite any Customers interested in joining the Beta program to engage Egnyte Professional Services for consideration.

HTTP Status & Errors

Status Code

Status code string representation

Description

Comments

200 OK Success response  
302 Found redirect Redirect Status Code  
303 See Other redirect Redirect Status Code  
401 Unauthorized Authorization Error  
404 Page Not Found Resource not found  
500 Service 

Interval service error

 

 

Source Status

Status Code

Status code string representation

Description

Comments

900 AGENT_STATE_INACTIVE CMM Agent is in "inactive" state  
901 AGENT_STATE_ACTIVE Agent is in "active" state  
902 AGENT_STATE_DEACTIVATED Agent is in "deactivated" state  
903 AGENT_STATE_DELETED Transient state when Agent is deleted  

 

Migration Status

Status Code

Status code string representation

Description

Comments

910 CREATE_MIGRATION: RUNNING Migration creation is in process  
911 CREATE_MIGRATION: SUCCEEDED Migration creation succeeded  
912 CREATE_MIGRATION: FAILED Migration creation failed  
913 CREATE_MIGRATION: STOPPED Migration creation stopped  
914 CREATE_MIGRATION: PAUSED Migration creation paused  
       
930 SCAN : RUNNING Scan is in process  
931 SCAN : FAILED Scan failed  
932 SCAN : SUCCEEDED Scan succeeded  
933 SCAN : STOPPING Scan stopping  
934 SCAN : STOPPED Scan stopped  
935 SCAN : PAUSED scan paused  
       
970 SANITIZE : RUNNING Sanitize is in process  
971 SANITIZE : FAILED Sanitize failed  
972 SANITIZE : SUCCEEDED Sanitize succeeded  
973 SANITIZE : STOPPING Sanitize stopping  
974 SANITIZE : STOPPED Sanitize stopped  
975 SANITIZE : PAUSED Sanitize paused  
       
940 DATA_UPLOAD : RUNNING Data Upload is in process  
941 DATA_UPLOAD : FAILED Data Upload failed  
942 DATA_UPLOAD : SUCCEEDED Data Upload succeeded  
943 DATA_UPLOAD : STOPPING Data Upload stopping  
944 DATA_UPLOAD : STOPPED Data Upload stopped  
945 DATA_UPLOAD : PAUSED Data Upload paused  
       
950 DATA_SYNC : RUNNING Data Sync is in process  
951 DATA_SYNC : FAILED Data Sync failed  
952 DATA_SYNC : SUCCEEDED Data Sync succeeded  
953 DATA_SYNC : STOPPING Data Sync stopping  
954 DATA_SYNC : STOPPED Data Sync stopped  
955 DATA_SYNC : PAUSED Data Sync paused  
       
960 MIGRATE_PERMISSIONS : RUNNING Migrate Permissions is in process  
961 MIGRATE_PERMISSIONS : FAILED Migrate Permissions failed  
962 MIGRATE_PERMISSIONS : SUCCEEDED Migrate Permissions succeeded  
963 MIGRATE_PERMISSIONS : STOPPING Migrate Permissions stopping  
964 MIGRATE_PERMISSIONS : STOPPED Migrate Permissions stopped  
965 MIGRATE_PERMISSIONS : PAUSED Migrate Permissions paused  
       
980 FINALIZE_MIGRATION : RUNNING Delete Migration is in process  
981 FINALIZE_MIGRATION : SUCCEEDED Delete Migration succeeded  
982 FINALIZE_MIGRATION : FAILED Delete Migration failed  
983 FINALIZE_MIGRATION : PAUSED Delete Migration paused  
984 FINALIZE_MIGRATION : STOPPED Delete Migration stopped  
       
985 MIGRATE_DATA : RUNNING Migrate Data is in process  
986 MIGRATE_DATA : FAILED Migrate Data failed  
987 MIGRATE_DATA : SUCCEEDED Migrate Data succeeded  
988 MIGRATE_DATA : STOPPING Migrate Data stopping  
989 MIGRATE_DATA : STOPPED Migrate Data stopped  
990 MIGRATE_DATA : PAUSED Migrate Data paused  

 

Miscellaneous Errors

Status Code

Status code string representation

Description

Comments

600 ERR_JSON_DECODING JSON Decoding, Encoding Error Internal error. Error code 600
605 ERR_JSON_MARSHAL_UNMARSHAL Object Conversion Error: JSON Marshaling, Unmarshaling Error Internal error. Error code 605
610 ERR_URL_PARSE URL Parse Error Internal error. Error code 610
620 ERR_INVALID_OPCODE Invalid Opcode  
621 ERR_WRONG_TYPE_TO_DEACTIVATE Wrong type (Master/Agent) given to deactivate Agent  
622 ERR_TOKEN_MISSING Token not found  
623 ERR_INVALID_DOMAIN Domain invalid  
624 ERR_SEMVER_PARSE Cannot parse a given version (should match with SEMVER format)  
625 ERR_AGENT_CONTAINS_MIGRATION Error when deleting an agent, cannot delete an agent which has associated migrations.  

 

State Validation Errors

Status Code

Status code string representation

Description

Comments

650 SCAN_INPROGRESS_ERR Returned as part of running a command when Scan command is already in progress  
651 SANITIZE_INPROGRESS_ERR Returned as part of running a command when Sanitize command is already in progress  
652 COPY_INPROGRESS_ERR Returned as part of running a command when Copy (Migrate Data) command is already in progress  
653 SYNC_INPROGRESS_ERR Returned as part of running a command when Sync (Migrate Data) command is already in progress  
654 PERMS_INPROGRESS_ERR Returned as part of running a command when Migrate Permissions command is already in progress  
655 SCAN_REQUIRED_ERR Notifies users that Scan command needs to be executed first  
656 SCAN_STOP_UNREQUIRED_ERR Notifies users that Scan command doesn't need to be stopped  
657 SANITIZE_STOP_UNREQUIRED_ERR Notifies users that Sanitize command doesn't need to be stopped  
658 COPY_STOP_UNREQUIRED_ERR Notifies users that copy (migrate data) command doesn't need to be stopped  
659 SYNC_STOP_UNREQUIRED_ERR Notifies users that Sync (Migrate Data) command doesn't need to be stopped  
660 PERMS_STOP_UNREQUIRED_ERR Notifies users that Migrate Permissions command doesn't need to be stopped  
661 MIGRATION_INPROGRESS_ERR A Migration Job is running. Additional request will be denied.  

 

Database Errors

Status Code

Status code string representation

Description

Comments

800 DB_ERR_GET_DOC_NOT_FOUND Firestore Error: Document not found  
801 DB_ERR_GET_DOC Firestore Error: Failed to get document due to other reasons  
803 DB_ERR_GET_DOCS Firestore Error: Failed to get multiple documents  
804 DB_ERR_GET_USER_DOC_NOT_FOUND Firestore Error: User document not found  
805 DB_ERR_GET_SELECTED_DOCS

Firestore Error: Failed to get multiple documents

Based on Selected field

 
806 DB_ERR_GET_USER_DOC_FOR_DOMAIN Firestore Error: Failed to get user document for a particular domain  
820 DB_ERR_CREATE_REF_ID Firestore Error: Failed to create document reference ID  
821 DB_ERR_CREATE_DOC Firestore Error: Failed to create document  
810 DB_ERR_UPDATE_DOC Firestore Error: Failed to update document  
816 DB_ERR_DELETE_DOC Firestore Error: Failed to delete document  
822 DB_ERR_INCORRECT_COLLECTION_NAME Firestore Error: Incorrect Collection Name provided  

 

Authentication Errors

Status Code

Status code string representation

Description

Comments

700 AUTH_ERR_MISSING_USER_COOKIE Authorization error, userID cookie missing  
702 AUTH_ERR_INCORRECT_DOMAIN Authorization error, incorrect domain  
704 AUTH_ERR_JWT_VALIDATION_MALFORMED Authorization error, JWT (JSON Web Token) validation failed  
705 AUTH_ERR_JWT_VALIDATION_INVALID Authorization error, invalid JWT (JSON Web Token) notification  
706 AUTH_ERR_JWT_VALIDATION_OTHERS Authorization error, other JWT (JSON Web Token) validation errors  
707 AUTH_ERR_JWT_INVALID Authorization error, invalid JWT (JSON Web Token)  
708 AUTH_ERR_JWT_GET_CLAIMS Authorization error, fails to decode JWT (JSON Web Token) fields  
709 AUTH_ERR_MISSING_CMM_VERIFICATION_ID_COOKIE Authorization error, CMMVerificationID cookie missing  
710 AUTH_ERR_MISSING_CMM_USER_ID Authorization error, user ID missing  
711 AUTH_ERR_INCORRECT_CMM_VERIFICATION_ID Authorization error, incorrect CMMVerificationID  
712 AUTH_ERR_HTTP_POST_REQ HTTP POST request error  
713 AUTH_ERR_USER_TOKEN_NOT_FOUND User token missing  
714 AUTH_ERR_HTTP_POST_RESP HTTP POST response error  
715 AUTH_ERR_HTTP_POST_RESP_STATUS_CODE HTTP POST response status code error  

 

Websocket Errors

Status Code

Status code string representation

Description

Comments

850 WEBSOCKET_REQUEST_ERR_MISSING_DOMAIN Domain cannot be empty. Only displayed during registration
851 WEBSOCKET_REQUEST_ERR_MISSING_USERNAME Username cannot be empty. Only displayed during registration
852 WEBSOCKET_REQUEST_ERR_MISSING_AGENT_ID Agent Id cannot be empty. Only displayed during registration
853 WEBSOCKET_REQUEST_ERR_INCORRECT_DOMAIN Domain name is incorrect Only displayed during registration
854 WEBSOCKET_REQUEST_ERR_INCORRECT_USERNAME Username is incorrect Only displayed during registration
855 WEBSOCKET_REQUEST_ERR_INCORRECT_AGENT_ID Agent Id is invalid Only displayed during registration
856 WEBSOCKET_REQUEST_ERR_AGENT_STATUS_ACTIVE Agent already in "Active" status Only displayed during registration
857 WEBSOCKET_REQUEST_ERR_GET_USER_DB_FAILURE User missing for Agent Only displayed during registration
858 WEBSOCKET_REQUEST_ERR_GET_USER_DB_NOT_FOUND Control Plane error (DB obj fetch error) Only displayed during registration
859 WEBSOCKET_REQUEST_ERR_INTERNAL_ERROR Control Plane Error (object conversion error) Only displayed during registration
860 WEBSOCKET_REQUEST_ERR_AGENT_TOKEN_FAILURE Fail to fetch internal token for agent Only displayed during registration
861 WEBSOCKET_REQUEST_ERR_SOCKET_UPGRADE Invalid Connection URL (861) Only displayed during registration
862 WEBSOCKET_REQUEST_ERR_AGENT_STATUS_DEACTIVATED Agent in "deactivate" status Only displayed during registration
863 WEBSOCKET_REQUEST_ERR_MISSING_AGENT_VERSION Agent Version is missing  
864 WEBSOCKET_REQUEST_ERR_UNSUPPORTED_AGENT_VERSION Agent version is invalid  
865 WEBSOCKET_REQUEST_ERR_WRONG_AGENT_VERSION Agent version doesn't match with SEMVER format  

 

Agent Upgrade

Status Code

Status code string representation

Description

Comments

993 AGENT_UPGRADE_RUNNING When upgrade is started, agent disconnects (inactive) and runs the process.  
994 AGENT_UPGRADE_SUCCEEDED When agent comes back with its version info, Control Plane judges if upgrade succeeded based on both the current and latest version. If same, succeeded.  
995 AGENT_UPGRADE_FAILED When agent comes back with its version info, Control Plane judges if upgrade succeeded based on both the current and latest version. If different, failed.  
996 AGENT_UPGRADE_TIMEOUT When upgrade took longer than 10 minutes  

 

Agent

Status Code

Status code string representation

Description

Comments

0 BLANKERRORCODE    
0 NOERRORCODE    
1010 UNSUPPORTED_VERSION_ERROR When the CMM Agent (whose version is not supported by the Control Plane) tries to establish connection with CP, this error is returned.   
1011 VERSION_UPTODATE_ERROR When UI requests a CMM Agent update, the agent can already be up-to-date. Control Plane returns this error to prevent further action.  
1020 INVALID_COMMAND_DATA_FORMAT_ERROR When a sub-process (spawned by the CMM Agent) is not able to decode the message received from Control Plane, the sub-process exits without any further action and returns this error.  
1030 INVALID_COMMAND_DATA_ERROR    
1040 TOO_MANY_OPEN_FILE_HANDLES_ERROR    
1050 INVALID_COMMAND_ERROR When Control Plane sends incorrect OPCODE to the CMM Agent, this error is returned to CP.  
1060 CREATE_MIGRATION_REPORT_ERROR    
1070 UPDATE_MIGRATION_REPORT_ERROR    
1080 INVALID_MIGRATION_REPORT_PATH_ERROR When migration-summary report folder path is invalid, this error is returned to Control Plane  
1090 INVALID_EXECUTABLE_PATH When the the CMM Agent binary path fetched from environment variable is invalid, this error occurs.  
1100 COMMAND_START_ERROR This occurs when sub-process is unable to be started by the CMM Agent.  
1120 PIPE_READ_ERROR    
1130 PIPE_DECODE_ERROR    
1150 INVALID_MESSAGE    
1160 MIGRATION_LOCK_ERROR    
1180 AUTH_FAILED_ERROR    
2010 MIGRATION_INVALID_SOURCE_PATH_ERROR This occurs when the source mentioned in create-migration step is invalid.  
2030 MIGRATION_CREATE_ERROR    
2040 MIGRATION_UPDATE_ERROR This occurs when the CMM Agent is unable to update the attributes related to a migration in migration-info file.  
2050 MIGRATION_DELETE_ERROR    
2060 DISK_HASH_CREATE_ERROR This occurs when the CMM Agent is unable to create persistent data store locally (i.e., diskhash file).  
2070 DISK_HASH_DELETE_ERROR    
2080 MIGRATION_NOT_FOUND_ERROR In any stage, if the CMM Agent is unable to find the migration-id in migration-info, this error is returned .  
2090 MIGRATION_FINALIZE_ERROR If any error occurs during finalize migration, this error is returned.  
2100 DISK_HASH_LOAD_ERROR When the CMM Agent is unable to load/read the persistent data store (i.e., diskhash) during copy/sync, this is returned.  
3010 SCAN_INVALID_EXCLUDE_RULE_ERROR    
3020 SCAN_REPORT_FOLDER_ERROR

When the CMM Agent is unable to get the scan-report folder location while scanning the source data, this is returned.

 
3030 INVALID_SOURCE_PATH_ERROR When the source path/root folder path is invalid while scanning the data source, this is returned.  
3040 SCAN_FAILURE_ERROR When any fatal error occurs that could stop the scanning step (other than mentioned above) while scanning the data-source, this error is returned. It means that scan has failed for the current source path.  
4010 SANITIZE_RENAME_ERROR If any error occurs while sanitizing/renaming the files/folders, this is returned.  
4020 SANITIZE_REPORT_FOLDER_ERROR If the CMM Agent is unable to find the sanitize folder location for a particular migration-id in the LocalAppData/egnyte-agent (for Windows), this is returned.  
4030 SANITIZE_INVALID_SCAN_RESULT_ERROR Before starting the Sanitize operation, CMM Agent does a scan on the source to be sanitized. If the Agent finds any error while scanning the source, this error is returned.  
5010 COPY_FILTER_FFL_ERROR    
5030 COPY_UPLOAD_REPORT_FOLDER_ERROR    
5040 COPY_INVALID_SCAN_RESULT_ERROR During the copy/data upload operation, if the CMM Agent is unable to find the scan-report that was generated in scan operation, this is returned  
5050 UPLOAD_FAILURE_ERROR If the file is unable to upload to destination domain for any reason, this error is returned.  
6010 PFFL_FETCH_ERROR During Sync operation, if the CMM Agent encounters any error while fetching the pFFL (partial FFL) from Egnyte CFS, this error is returned.  
6020 PFFL_REPORT_PATH_ERROR During Sync operation, if the CMM Agent is unable to create local persistent data store for pFFL (partial FFL), this error occurs.  
6030 DISK_HASH_PATH_ERROR During Sync operation, if the CMM Agent is unable to find the path for persistent data store, this error occurs.  
6040 SYNC_UPLOAD_REPORT_FOLDER_ERROR During Sync operation, if the CMM Agent is unable to find the location (or path is invalid) for "status" folder then this error occurs. This "status" contains the success and failure reports that shows which file is successfully uploaded and which encountered error.  
6050 SYNC_DIFF_CALCULATE_ERROR During Sync operation, if there is any error occurred while diff calculation step, then error occurs.  
6060 SYNC_FAILURE_ERROR    
6070 DISKHASH_DELETE_ERROR    
7010 PERMISSION_MIGRATION_IN_PROGRESS If the user tries to restart a Permission migration which is still in progress, this error occurs.  
7020 PERMISSION_TRANSLATION_ERROR Permissions Extraction (1), Permissions Translation (2), and Permissions Apply to Destination Domain (3) are the three steps in permissions-migration. If any errors occur in the Permissions Translation step, this error occurs.  
7030 PERMISSION_APPLY_FAILURE If any errors occur in the Permissions Application step, this error is returned.