JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Sun QFS and Sun Storage Archive Manager 5.3 Reference Manual     Sun QFS and Sun Storage Archive Manager 5.3 Information Library
search filter icon
search icon

Document Information

Preface

1.  User Commands (Man Pages Section 1)

2.  Maintenance Commands (Man Pages Section 1M)

3.  Library Functions (Man Pages Section 3)

intro_libsam(3)

intro_libsamrpc(3)

qfs_listio(3)

sam_advise(3)

sam_archive(3)

sam_audit(3)

sam_cancelstage(3)

sam_chmed(3)

sam_clear_request(3)

sam_closecat(3)

sam_damage(3)

sam_devstat(3)

sam_devstr(3)

sam_errno(3)

sam_exarchive(3)

sam_export(3)

sam_getcatalog(3)

sam_getfsdata(3)

sam_getfsdisks(3)

sam_import(3)

sam_load(3)

sam_lstat(3)

sam_mig_create_file(3)

sam_mig_mount_media(3)

sam_mig_rearchive(3)

sam_mig_release_device(3)

sam_mig_stage_end(3)

sam_mig_stage_error(3)

sam_mig_stage_file(3)

sam_mig_stage_write(3)

sam_move(3)

sam_odlabel(3)

sam_opencat(3)

sam_readrminfo(3)

sam_rearch(3)

sam_release(3)

sam_request(3)

sam_restore_copy(3)

sam_restore_file(3)

sam_segment(3)

sam_segment_stat(3)

sam_segment_vsn_stat(3)

sam_set_fs_contig(3)

sam_set_fs_thresh(3)

sam_set_state(3)

sam_setfa(3)

sam_settings(3)

sam_ssum(3)

sam_stage(3)

sam_stat(3)

sam_tplabel(3)

sam_unarchive(3)

sam_undamage(3)

sam_unload(3)

sam_unrearch(3)

sam_vsn_stat(3)

usam_mig_cancel_stage_req(3)

usam_mig_initialize(3)

usam_mig_stage_file_req(3)

4.  Library Functions (Man Pages Section 3X)

5.  File Formats (Man Pages Section 4)

6.  Standards, Environment, and Macros (Man Pages Section 5)

7.  Device and Network Interfaces (Man Pages Section 7)

sam_damage(3)

NAME
     sam_damage - Sets damaged attribute on a file or directory

SYNOPSIS
     cc [ flag  ... ] file    ...  -L/opt/SUNWsamfs/lib  -lsam  [library ... ]

     #include "/opt/SUNWsamfs/include/lib.h"

     int sam_damage(const char *path, int num_opts, ... );

DESCRIPTION
     sam_damage() lets you mark archive copies of  a  file  or  a
     directory  as  damaged,  using a Sun Storage Archive Manager
     system call.  path is the file on which to  set  the  attri-
     butes,  followed  by a sequence of num_opts input characters
     or options.  Individual options are described below.

     The function marks copies of a file or directory as  damaged
     based  on  the archive copy number and/or the media type and
     VSN specified.  There are several ways to mark one  or  more
     copies as damaged.  These ways are as follows:

     o  By copy number

     o  By copy number, media type, and VSN

     o  By copy number and media type

     o  By media type

     o  By media type and VSN

     If a fatal error is detected when staging an  archive  copy,
     that  archive  copy  is  marked as damaged.  An archive copy
     that is damaged is not selected for staging.

OPTIONS
     a         Rearchives the damaged copy.

     c copy_no Marks the specified archive copy  number  as  dam-
               aged.   If  one or more 'c' options are specified,
               only those archive copies (1,  2,  3,  or  4)  are
               marked  as  damaged.   Specify  1,  2, 3, or 4 for
               copy_no.  Either a "c  copy_no"  or  a  "m  media"
               option must be specified.

     M         Marks only metadata  as  damaged.   This  includes
               directories,     the     segment     index,    and
               removable-media  files.   Regular  files  are  not
               marked as damaged.  If you are marking a directory
               as damaged, you must specify the "M" option.

     m media_type
               Marks all copies from the specified media_type  as
               damaged.   For  the  list  of  possible media_type
               specifications, see the mcf(4) man page.  Either a
               "c  copy_no"  or a "m media" option must be speci-
               fied.  If you specify a "m media" option, you  can
               also specify a "v vsn" option.

     o         Specifies that the file must be online  before  it
               is  marked as damaged. If the file is offline, the
               sam_damage function stages the file to disk before
               deleting any entries.

     v vsn     Marks the archive copies on vsn as  damaged.   For
               vsn,  specify  a volume serial name (VSN).  If you
               specify a "v vsn" option, you must also specify  a
               "m media" option.

RETURN VALUES
     Upon successful completion a value of 0 is returned.  Other-
     wise, a value of -1 is returned and errno is set to indicate
     the error.

ERRORS
     sam_damage() fails if one or more of the following are true:

     EINVAL              An invalid option was specified, or  the
                         file  is  neither  a  regular file nor a
                         directory.

     EPERM               Not the owner or superuser.

     EFAULT              Argument points to an illegal address.

     EINTR               A   signal   was   caught   during   the
                         sam_damage() function.

     ELOOP               Too many symbolic links were encountered
                         in translating path.

     ENAMETOOLONG        The length of the path argument  exceeds
                         {PATH_MAX}, or the length of a path com-
                         ponent    exceeds    {NAME_MAX}    while
                         {_POSIX_NO_TRUNC} is in effect.

     ENOENT              The named file does not exist or is  the
                         null pathname.

     ENOLINK             path points to a remote machine and  the
                         link   to  that  machine  is  no  longer
                         active.

     ENOTDIR             A component of the path prefix is not  a
                         directory.

SEE ALSO
     damage(1m), mcf(4)