migration.h

Go to the documentation of this file.

/*===============================================
   Copyright 2007 UGS Corp. All Rights Reserved.
   ===============================================*/

#ifndef MIGRATION_H
#define MIGRATION_H

#include <sa/sa.h>
#include <unidefs.h>
#include <sa/libsa_exports.h>

typedef struct VM_policy_info_s
{
    logical is_active;  
    logical migrate_checkedout_file;       
    logical migrate_in_process_file;      
    logical migrate_remote_file;         
    logical purge_immediately;  
    int purge_low_water_mark;        
    int purge_high_water_mark;    
    int  migration_option;
    tag_t src_vol_tag;           
    tag_t dest_vol_tag;            
    int file_size_range_from;     
    int file_size_range_to;      
    int file_size_units;                 
}VM_policy_info_t, *VM_policy_info_p_t;

typedef struct HSM_policy_info_s
{
    logical is_active;  
    logical migrate_on_refile;               
    logical migrate_checkedout_file;       
    logical migrate_in_process_file;      
    logical migrate_remote_file;         
    logical un_migrate_file;         
    logical purge_immediately;  
    int purge_low_water_mark;        
    int purge_high_water_mark;      
    int migrate_from_tier;           
    int migrate_to_tier;            
    int file_size_range_from;     
    int file_size_range_to;      
    int file_size_units;          
    int file_access_times;     
}HSM_policy_info_t, *HSM_policy_info_p_t;

#ifdef __cplusplus
extern "C"{
#endif

    extern SA_API int SA_create_hsm_policy(
        const char          policy_name[SA_name_size_c + 1],         
        const char          policy_desc[SA_description_size_c + 1],  
        date_t              accessed_before,                         
        date_t              accessed_after,                          
        HSM_policy_info_p_t policy_info,                             
        tag_t               query_tag,                               
        int                 entry_count,                             
        const char**        entries,                                 
        const char**        values,                                  
        tag_t*              policy_tag                               
        );

    extern SA_API int SA_modify_hsm_policy(
        tag_t               policy_tag,                              
        const char          policy_desc[SA_description_size_c + 1],  
        date_t              accessed_before,                         
        date_t              accessed_after,                          
        HSM_policy_info_p_t policy_info,                             
        tag_t               query_tag,                               
        int                 entry_count,                             
        const char**        entries,                                 
        const char**        values                                   
        );

    extern SA_API int SA_create_vm_policy(
        const char          policy_name[SA_name_size_c + 1],         
        const char          policy_desc[SA_description_size_c + 1],  
        date_t              accessed_before,                         
        date_t              accessed_after,                          
        VM_policy_info_p_t policy_info,                              
        tag_t               query_tag,                               
        int                 entry_count,                             
        const char**        entries,                                 
        const char**        values,                                  
        tag_t*              policy_tag                               
        );

    extern SA_API int SA_modify_vm_policy(
        tag_t               policy_tag,                              
        const char          policy_desc[SA_description_size_c + 1],  
        date_t              accessed_before,                         
        date_t              accessed_after,                          
        VM_policy_info_p_t policy_info,                              
        tag_t               query_tag,                               
        int                 entry_count,                             
        const char**        entries,                                 
        const char**        values                                   
        );

    extern SA_API int SA_policy_name_of_class(
        tag_t               policy_tag,          
        char**              class_name           
        );
    
    extern SA_API int SA_delete_policy(
        tag_t               policy_tag      
        );

        extern SA_API int SA_find_policy_tag(
            const char          policy_name[SA_name_size_c + 1],   
            tag_t*              policy_tag                         
            );

        extern SA_API int SA_find_policy_tag2(
            const char          *policy_name,                      
            tag_t*              policy_tag                         
            );

        extern SA_API int SA_find_policy_name(
            tag_t               policy_tag,                      
            char                policy_name[SA_name_size_c + 1]  
            );

        extern SA_API int SA_find_policy_name2(
            tag_t               policy_tag,                      
            char                **policy_name                    
            );

        extern SA_API int SA_extent_policies(
            int*               num_of_policies,   
            tag_t**            policies_tags      
            );

        extern SA_API int SA_ask_hsm_policy_info (
            tag_t                    policy_tag, 
            HSM_policy_info_p_t      policy_info 
            );

        extern SA_API int SA_ask_vm_policy_info (
            tag_t                    policy_tag, 
            VM_policy_info_p_t       policy_info 
            );


        extern SA_API int SA_ask_policy_query (
            tag_t               policy_tag,   
            tag_t*              query_tag,    
            int*                entry_count,  
            char***             entries,      
            char***             values        
            );

        extern SA_API int SA_mark_for_migration (
            tag_t                    policy_tag,     
            int*                     num_of_objs,    
            tag_t **                 request_objs    
            );

        extern SA_API int SA_get_pending_requests (
            tag_t                    policy_tag,     
            int*                     num_of_objs,    
            tag_t **                 request_objs    
            );

        extern SA_API int SA_export_pending_requests (
            int                    num_of_requests,   
            const tag_t*           request_tags,      
            int                    format,            
            const char*            export_file_path   
            );
        extern SA_API int SA_migrate_pending_request (
            tag_t                    request_tag,   
            logical                  fms_migration  
            );

        extern SA_API int SA_generate_migration_report (
            tag_t               policy_tag,           
            date_t              migration_from_date,  
            date_t              migration_to_date,    
            const char*         report_file_path      
            );

                        
        extern SA_API int SA_get_hsminfo_tag (
            tag_t               file_tag,      
            tag_t*              hsm_info_tag   
            );
        
        extern SA_API int SA_get_vminfo_tag (
            tag_t               file_tag,     
            tag_t*              vm_info_tag   
            );

#ifdef __cplusplus
}
#endif

#include <sa/libsa_undef.h>
#endif