| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| common:volume_flags [2018/02/20 01:33] – [Setting and Unsetting Flags] Scott Cunliffe | common:volume_flags [2025/01/21 22:07] (current) – external edit 127.0.0.1 |
|---|
| ====== Volume Flags ====== | ====== Volume Flags ====== |
| |
| Volume Flags represent one or more Boolean statuses of a single tape volume. | [[object:volume|Volume]] Flags represent one or more Boolean statuses of a single tape [[object:volume|Volume]]. |
| |
| Depending on the respective flag, the flag may be automatically set, or may be set and unset by the user. | Depending on the respective Flag, the Flag may be automatically set, or may be set and unset by the user. |
| |
| These flags can be used to filter tapes by status, for instance, scratch tapes, or encrypted tapes, may be used together to facilitate filtering on all scratch tapes, that are not encrypted. | These Flags can be used to filter tapes by status, for instance, scratch tapes, or encrypted tapes, may be used together to facilitate filtering on all scratch tapes, that are not encrypted. |
| |
| |
| ===== Flag Definitions ===== | ===== Flag Definitions ===== |
| ^ Flag Value ^ Description ^ Settable ^ | ^ Flag Value ^ Description ^ Settable ^ |
| | **A** | Volume has a Container Security Tag assigned. | No | | | **A** | (Depreciated function) [[object:volume|Volume]] has a Container Security Tag assigned. | No | |
| | **a** | Volume has failed a Physical Audit or a Logical Audit (Set by Reconciliation). | **Yes** | | | **a** | [[object:volume|Volume]] has failed a Physical Audit or a Logical Audit (Set by Reconciliation). | **Yes** | |
| | **B** | Volume is a Container. | No | | | **B** | [[object:volume|Volume]] is a Container. | No | |
| | **C** | Volume is confirmed in its current Repository. | No | | | **C** | [[object:volume|Volume]] is confirmed in its Current [[object:repository|Repository]]. | No | |
| | **c** | Volume is part of a Consignment. | No | | | **c** | [[object:volume|Volume]] is part of a Consignment. | No | |
| | **D** | Volume has a Move Date. | No | | | **D** | [[object:volume|Volume]] has a Move Date. | No | |
| | **d** | Volume Move Date is in the past. | No | | | **d** | [[object:volume|Volume]] Move Date is in the past. | No | |
| | **E** | Volume is encrypted. | **Yes** | | | **E** | [[object:volume|Volume]] is encrypted. | **Yes** | |
| | **F** | Volume has been set as a [[master:favorites_list|Favorite]] | No | | | **F** | [[object:volume|Volume]] has been set as a [[master:favorites_list|Favorite]] | No | |
| | **G** | Volume has missed a reporting deadline. | **Yes** | | | **G** | [[object:volume|Volume]] has missed a [[technote:reports|reporting]] deadline. | **Yes** | |
| | **H** | Volume Move Date is a Holiday. | No | | | **H** | [[object:volume|Volume]] Move Date is a Holiday. | No | |
| | **h** | Volume is hidden (ghosted). | **Yes** | | | **h** | [[object:volume|Volume]] is hidden (ghosted). | **Yes** | |
| | **I** | Volume is moving internally (from one Slot to another in the same Repository). | No | | | **I** | [[object:volume|Volume]] is moving internally (from one Slot to another in the same [[object:repository|Repository]]). | No | |
| | **K** | Volume has been Picked-Up. | **Yes** | | | **K** | [[object:volume|Volume]] has been Picked-Up. | **Yes** | |
| | **L** | Volume has an update lock and cannot be updated by anyone other than the [[common:tapemaster_user|tapemaster User]]. | **Yes** | | | **L** | [[object:volume|Volume]] has an update lock and cannot be updated by anyone other than the [[common:tapemaster_user|tapemaster User]]. | **Yes** | |
| | **l** | Volume has a move lock and cannot be moved. | **Yes** | | | **l** | [[object:volume|Volume]] has a move lock and cannot be moved. | **Yes** | |
| | **M** | Volume is moving from one Repository to another. | No | | | **M** | [[object:volume|Volume]] is moving from one [[object:repository|Repository]] to another. | No | |
| | **m** | Volume has a Home Slot. | No | | | **m** | [[object:volume|Volume]] has a Home Slot. | No | |
| | **N** | Volume has a Description. | No | | | **N** | [[object:volume|Volume]] has a Description. | No | |
| | **n** | Volume has no Slot assigned. | No | | | **n** | [[object:volume|Volume]] has no Slot assigned. | No | |
| | **O** | Volume is in the Primary Offsite Repository. | No | | | **O** | [[object:volume|Volume]] is in the Primary Offsite [[object:repository|Repository]]. | No | |
| | **o** | Volume is overdue at its Target Repository. | No | | | **o** | [[object:volume|Volume]] is overdue at its Target [[object:repository|Repository]]. | No | |
| | **p** | Volume has been set as Move Pending as its Move Date has been exceeded (Set by [[cli:TMSS10MovePending|TMSS10MovePending]]). | **Yes** | | | **p** | [[object:volume|Volume]] has been set as Move Pending as its Move Date has been exceeded (Set by [[cli:TMSS10MovePending|TMSS10MovePending]]). | **Yes** | |
| | **Q** | Volume has been flagged as unhealthy by a VeriTape system. | **Yes** | | | **Q** | [[object:volume|Volume]] has been flagged as unhealthy by a VeriTape system. | **Yes** | |
| | **r** | Volume has been requested back from a Third-Party. | **Yes** | | | **r** | [[object:volume|Volume]] has been requested back from a Third-Party. | **Yes** | |
| | **S** | Volume always uses [[cookbook:simplemanagement|Simple Management]]. | **Yes** | | | **S** | [[object:volume|Volume]] always uses [[cookbook:simplemanagement|Simple Management]]. | **Yes** | |
| | **t** | Do not assign a Slot to this Volume. | **Yes** | | | **t** | Do not assign a Slot to this [[object:volume|Volume]]. | **Yes** | |
| | **U** | Volume has been scanned out of the current Repository using either TapeTrack Lite or TapeTrack Check Point. | **Yes** | | | **U** | [[object:volume|Volume]] has been scanned out of the Current [[object:repository|Repository]] using either TapeTrack Lite or TapeTrack Check Point. | **Yes** | |
| | **u** | Volume has been flagged as a duplicate. | **Yes** | | | **u** | [[object:volume|Volume]] has been flagged as a duplicate. | **Yes** | |
| | **W** | Volume has a warning (has moved back to its original Repository without having been confirmed at it's destination). | **Yes** | | | **W** | [[object:volume|Volume]] has a warning (has moved back to its original [[object:repository|Repository]] without having been confirmed at it's Target [[object:repository|Repository]]). | **Yes** | |
| | **X** | Volume has been Audit-Scanned. | **Yes** | | | **X** | [[object:volume|Volume]] has been Audit-Scanned. | **Yes** | |
| | **Z** | Volume is Scratch. | **Yes** | | | **Z** | [[object:volume|Volume]] is Scratch. | **Yes** | |
| |
| ===== Using Flags ===== | ===== Using Flags ===== |
| |
| TapeTrack uses many of the volume flags internally to pass information from one program to another, but flags can also be used to filter information for reporting purposes. | TapeTrack uses many of the [[object:volume|Volume]] Flag internally to pass information from one program to another, but Flag can also be used to filter information for [[technote:reports|reporting]] purposes. |
| ==== Using Flags for Reporting ==== | ==== Using Flags for Reporting ==== |
| |
| Volume flags can be used for reporting purposes in both | [[object:volume|Volume]] Flag can be used for [[technote:reports|reporting]] purposes in both |
| [[:#tapetrack-desktop-software|TapeTrack Windows Desktop Programs]] and [[cli:introduction|TapeTrack Command Line Programs]]. | [[:#tapetrack-desktop-software|TapeTrack Windows Desktop Programs]] and [[cli:introduction|TapeTrack Command Line Programs]]. |
| |
| For details on how to use the Volume Flags in reporting see the [[common:volume_flag_filters|Volume Flag Filters]] section. | For details on how to use the [[object:volume|Volume]] Flags in [[technote:reports|reporting]] see the [[common:volume_flag_filters|Volume Flag Filters]] section. |
| |
| ==== Setting and Unsetting Flags ==== | ==== Setting and Unsetting Flags ==== |
| |
| Some volume flags can be set and unset by performing operations on the respective tape volume, for instance, when you move a volume, the tape will get a move flag, and when you confirm a volume the move flag will be removed. | Some [[object:volume|Volume]] Flag can be set and unset by performing operations on the respective [[object:volume|Volume]], for instance, when you move a [[object:volume|Volume]], the [[object:volume|Volume]] will get a move Flag, and when you confirm a [[object:volume|Volume]] the move Flag will be removed. |
| |
| Other flags can only be set and unset by the user requesting that they change, and the remaining flags are a hybrid that are set by an activity, and then unset manually. | Other Flag can only be set and unset by the user requesting that they change, and the remaining Flag are a hybrid that are set by an activity, and then unset manually. |
| |
| === Changing flags via the Command Line === | === Changing Flags via the Command Line === |
| |
| Volume Flags are indirectly set by the following Command Line Programs: | [[object:volume|Volume]] Flags are indirectly set by the following Command Line Programs: |
| |
| ^ Program ^ Notes ^ | ^ Program ^ Notes ^ |
| | [[cli:TMSS10ModifyFlags|TMSS10ModifyFlags]] | Sets and unsets flags that can be modified without performing a corresponding action. | | | [[cli:TMSS10ModifyFlags|TMSS10ModifyFlags]] | Sets and unsets Flags that can be modified without performing a corresponding action. | |
| | [[cli:TMSS10ExpireByDate|TMSS10ExpireByDate]] | Sets the Move Pending Flag. | | | [[cli:TMSS10ExpireByDate|TMSS10ExpireByDate]] | Sets the Move Pending Flag. | |
| |
| |
| === Changing flags via the Desktop === | === Changing Flags via the Desktop === |
| |
| A selection of [[#flag-definitions|Flags]] can be [[:master:set_volume_flags|applied or removed]] from [[:master:volumes|volumes]] via the [[:master:inventory_right_menu|right click inventory window menu]] in TapeMaster. | A selection of [[#flag-definitions|Flags]] can be [[:master:set_volume_flags|applied to or removed from Volumes]] via the [[:master:inventory_right_menu|right-click inventory window menu]] in TapeMaster. |
| | |
| | To remove a W Flag select that [[object:volume|Volume]] and press F2. |
| |
