Set Event
Using the set event command, you can specify the circumstances for when archived data is deleted.
You can use the set event command in the following ways:
- Prevent the deletion of data at the end of its assigned retention period (Deletion hold)
- Allow the expiration to take place, as defined by the archive copy group (Release a deletion hold)
- Start the expiration clock to run when a particular event occurs (Notify the server that an event occurred)
Objects that are affected can be specified with a standard file specification (including wildcards), a list of files whose names are in the file that is specified using the filelist option, or a group of archived files with the description specified with the description option.
Interaction with down-level servers
If the set event command is issued when the client is connected to a server that does not support event-based policy (previous to Tivoli® Storage Manager 5.2.2), the command is rejected with an error message that indicates the current server does not support event-based policy.
Supported Clients
This command is valid for all clients.
Syntax
>>-SET Event---- -TYPE=--+-Hold--------------+------------------> +-Release-----------+ '-Activateretention-' >-- --<filespec>-- -- -filelist=<filespec>-- -- -description=---> >-- -pick------------------------------------------------------><
Parameters
- TYPE=
-
Specifies the event type setting. This parameter must be specified.
- hold
-
Prevents the object from being deleted regardless of expiration policy.
- release
-
Allows normal event-controlled expiration to take place.
- activateretention
-
Signals the server that the controlling event occurred and starts to run the expiration clock.
- -pick
-
Provides a list of objects from which the user can select to apply the event.
The following options can also be used and serve their usual purpose:
- Dateformat
- Numberformat
- Noprompt
- Subdir
- Timeformat
Examples
- Task
- The following example displays the verbose and statistics output
from the set event command set event type=hold
/home/accounting/ledgers/*05.books, with objects rebound
(as opposed to archived or some other notation).
Rebinding--> 274 /home/accounting/ledgers/ jan05.books Rebinding--> 290 /home/accounting/ledgers/ feb05.books Total number of objects archived: 0 Total number of objects failed: 0 Total number of objects rebound: 2 Total number of bytes transferred: 0 B Data transfer time: 0.00 sec Network data transfer rate: 0.00 KB/sec Aggregate data transfer rate: 0.00 KB/sec Objects compressed by: 0% Elapsed processing time: 00:00:02
- Task
- The following example displays the verbose and statistics output
from the set event command set event type=hold
\\user\c$\tsm521\debug\bin\winnt_unicode\dsm.opt, with objects
rebound (as opposed to archived or some other notation).
Rebinding--> 274 \\user\c$\tsm521\debug\ bin\winnt_unicode\dsm.opt Rebinding--> 290 \\user\c$\tsm521\debug\ bin\winnt_unicode\dsm.opt Total number of objects inspected: 2 Total number of objects archived: 0 Total number of objects updated: 0 Total number of objects rebound: 2 Total number of objects deleted: 0 Total number of objects expired: 0 Total number of objects failed: 0 Total number of bytes transferred: 0 B Data transfer time: 0.00 sec Network data transfer rate: 0.00 KB/sec Aggregate data transfer rate: 0.00 KB/sec Objects compressed by: 0% Elapsed processing time: 00:00:02
- Task
- The -pick option used with the set event command set
event type=activate /user/tsm521/common/unix shows the event
type instead of the command name:
TSM Scrollable PICK Window - Retention Event : ACTIVATE # Archive Date/Time File Size File ----------------------------------------------------- 1. | 08/05/2003 08:47:46 766 B /user/tsm521 /common/unix 2. | 08/01/2003 10:38:11 766 B /user/tsm521 /common/unix 3. | 08/05/2003 08:47:46 5.79 KB /user/tsm521 /common/unix 4. | 08/01/2003 10:38:11 5.79 KB /user/tsm521 /common/unix 5. | 08/05/2003 08:47:46 10.18 KB /user/tsm521 /common/unix
- Task
- The -pick option used with the set event command set
event type=activate \user\c$\tsm521\common\winnt shows the
event type instead of the command name:
TSM Scrollable PICK Window - Retention Event : ACTIVATE # Archive Date/Time File Size File --------------------------------------------------------- 1. | 08/05/2003 08:47:46 766 B \\user\c$\tsm521 \common\winnt 2. | 08/01/2003 10:38:11 766 B \\user\c$\tsm521 \common\winnt 3. | 08/05/2003 08:47:46 5.79 KB \\user\c$\tsm521 \common\winnt 4. | 08/01/2003 10:38:11 5.79 KB \\user\c$\tsm521 \common\winnt 5. | 08/05/2003 08:47:46 10.18 KB \\user\c$\tsm521 \common\winnt