Name

msretention — Set the retention period for an MSS file.

Synopsis

msretention [-project proj] [-R] -period retpd (1) password options path...


(1) [-rpwd read_password] [-wpwd write_password]

Description

The msretention utility sets the retention period of the specified MSS files, which must be between 1 and 32,767 days, inclusive. Retention periods should be intelligently selected to match the useful life of the file. The default retention period is 32 days.

If an MSS file, with a class of service of usage=normal, is not referenced (either by reading, rewriting or touching) for a period of retpd days, it will be purged. A purged MSS file becomes a trash MSS file, and will be kept for approximately 29 days after it was purged. See msrecover(1NCAR) for more information.

Warning

MSS files with a class of service of usage=backup behave differently. These files are permanently deleted from the system retpd days after they were created. They are not placed into the trash, nor are they recoverable. In particular, accesses to these files do not extend their life. See Chapter 5, MSS File Life Cycles and the msclass(1NCAR) and msrecover(1NCAR) documentation for more information.

Options

msretention specific options:

-R

Recursively set the retention period. For each operand that names a directory, msretention shall set the specified retpd on all MSS files in the hierarchy.

-pe[riod] retpd

Specifies the retention period in days. Must be between 1 and 32,767, inclusive.

-p[roject] proj

Supply proj as the project number for charging. Currently, no charging is done for metadata operations, so this option is a placeholder for when charging might be imposed.

The common password related options are:

-rpwd password

Supply the read password for the following MSS files. If another read password was specified prior to this point in this command line, and the following MSS files do no have a read password, a null password must be given: -rpwd ''. If the MSS files do not have a read password, this option must not be used.

-wpwd password

Supply the write password for the following MSS files. If another write password was specified prior to this point in this command line, and the following MSS files do no have a write password, a null password must be given: -wpwd ''. If the MSS files do not have a write password, this option must not be used.

Operands

path

A pathname of an MSS file whose retention period is to be modified. If the recursive option (-R) is set, then all MSS files contained within the directory hierarchy named by path will have their retention period modified.

Example

Example 37. Set a retention period.

msretention -wpwd yoyo -pe 365 mydata

Environment Variables

See Environment Variables section of the Command Behavior and Envrionment chapter for details.

Exit Status

See Exit Status Codes section of the Command Behavior and Environment chapter for details.

See Also

msallinfo(1NCAR), msfind(1NCAR), msls(1NCAR), msrawinfo(1NCAR), msrecover(1NCAR), msrm(1NCAR)

Copyright

2008 University Corporation for Atmospheric Research, all rights reserved.