====== Volume Filter ======

The [[object:volume|Volume]] Filter (-V) is used in the [[cli:introduction|Command Line programs]] to filter which [[object:volume|Volumes]] are included in the input process.

===== Volume Filter Sections =====

The [[object:volume|Volume]] filter is divided up into sections [[object:customer|Customer-ID]].[[object:media|Media-ID]].Volume-ID@[[object:repository|Repository-ID]]+-[[common:volume_flags|Flags]].

<note tip>The following sections refer to each individual part of the [[object:volume|Volume]] filter such as -V [[object:customer|Customer-ID]], use of the filter requires the individual parts to be combined into either -V CUST.MEDIA.VOLUME or CUST.MEDIA.VOL@REP+FLAG </note>

==== Customer-ID ====

The [[object:customer|Customer-ID]] section filters the [[object:customer|Customers]] that are considered for input into the [[cli:introduction|Command Line programs]].

Using * will include all [[object:customer|Customer-ID's]].
Using US01 will only include [[object:customer|Customer-ID]] US01.
Using US* will input include [[object:customer|Customer-ID's]] that start with US (eg. US01, US02, US4).
Using !*(US01) will include any [[object:customer|Customer-ID]] that does not match US01.
Using !*(US*) will include any [[object:customer|Customer-ID]] that does not match any [[object:customer|Customer-ID's]] that start with US (eg. US01, US02, US4 would be excluded).

Example filter to include all 
[[object:media|Media]] and [[object:volume|Volumes]] that belong to [[object:customer|Customer]] US01:

<code>
-V "US01.*.*"
</code>

Example filter to include all [[object:media|Media]] and [[object:volume|Volumes]] that belong to [[object:customer|Customers]] that start with US (eg US01, US02, US03)

<code>
-V "US*.*.*"
</code>

Example filter to include all [[object:media|Media]] and [[object:volume|Volumes]] that belong to [[object:customer|Customers]] US01, US02, US03

<code>
-V "*(US01|US02|US03).*.*"
</code>
==== Media-ID ====

The [[object:media|Media-ID]] section filters the [[object:media|Media Types]] that are considered for input into the [[cli:introduction|Command Line programs]].

Using * will include all Media-ID's.
Using LTO will only include  [[object:media|Media-ID]] LTO.
Using LT* will include any Media-IDs that start with LT (eg. LTO, LT02, LTO6).
Using !*(LTO) will include all Media-ID's that does not match LTO.
Using !*(LT*) will include any Media-IDs that do not start with LT.


Example filter to include all [[object:customer|Customer]] and [[object:volume|Volumes]] that belong to [[object:media|Media-ID]] Type LTO:

<code>
-V "*.LTO.*"
</code>

==== Volume-ID ====

The [[object:volume|Volume-ID]] section filters the [[object:volume|Volumes]] that are considered for input into the [[cli:introduction|Command Line programs]].

Using * will include all [[object:volume|Volume-ID's]] 
Using *JA will include all [[object:volume|Volume-ID's]] that end in JA
Using 20* will include all [[object:volume|Volume-ID's]] that start with 20
Using 111000L6 will only include [[object:volume|Volume-ID]] 111000L6


Example filter to include all [[object:customer|Customer]] and [[object:media|Media Type]] that have a [[object:volume|Volume-ID]] ending in the suffix L6:

<code>
-V "*.*.L6*"
</code>

==== Repository-ID ====

The [[object:repository|Repository-ID]] filters the [[object:repository|Repositories]] that are considered for input into the [[cli:introduction|Command Line programs]] and must be preceded by the @ symbol.

Using @OFFS will include only [[object:volume|Volumes]] at the OFFS [[object:repository|Repository]].
Using @!(OFFS) will include all [[object:volume|Volumes]] not at OFFS [[object:repository|Repository]].
Using @*(LIBR|OFFS) will include all [[object:volume|Volume-ID's]] in the OFFS and LIBR Repositories.

Example filter to include all [[object:customer|Customer]], [[object:media|Media]] and [[object:volume|Volumes]] that are in [[object:repository|Repository]] OFFS:

<code>
-V "*.*.*@OFFS"
</code>

==== Flags ====

The [[common:volume_flags|Flag]] filters the [[common:volume_flags|Flag]] values that are considered for input into the [[cli:introduction|Command Line programs]] and must be preceded by the [[object:repository|Repository]] filter (at a minimum@*) and the + symbol.

Using +Z will include all [[object:volume|Volumes]] that have a Z (scratch) [[common:volume_flags|Flag]].
Using +ZN will include all [[object:volume|Volumes]] that have a Z (scratch) [[common:volume_flags|Flag]] and an N (description) [[common:volume_flags|Flag]].
Using +!Z will include all [[object:volume|Volumes]] that don't have a Z (scratch) [[common:volume_flags|Flag]].
Using +!Z!N will include all [[object:volume|Volumes]] that don't have a Z (scratch) [[common:volume_flags|Flag]] and an N (description) [[common:volume_flags|Flag]]. 
Using +!ZN will include all [[object:volume|Volumes]] that don't have a Z (scratch) [[common:volume_flags|Flag]] and and do have an N (description) [[common:volume_flags|Flag]].

Example filter to include all [[object:customer|Customer]], [[object:media|Media]] and [[object:volume|Volumes]] that have a Z [[common:volume_flags|Flag]] (scratch):

<code>
-V "*.*.*@*+Z"
</code>

==== Example ====

Example filter to include [[object:customer|Customer-ID]] US01, [[object:media|Media]] Type LTO, [[object:volume|Volumes]] ending in L6, are in [[object:repository|Repository]] OFFS and have a Z (scratch) [[common:volume_flags|Flag]]:

<code>
-V "US01.LTO.*L6@OFFS+Z"
</code>

===== See Also =====
[[common:volume_flags|Flag Values]]