6977c6b100fbb02312e229e3586c0ecb75781a47
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_tsmsm.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_tsmsm.8">
4
5 <refmeta>
6         <refentrytitle>vfs_tsmsm</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_tsmsm</refname>
16         <refpurpose>VFS module for handling offline files with Tivoli Storage Manager Space Management</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = tsmsm</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>The <command>tsmsm</command> VFS module is an
33         extension for handling offline files with Tivoli
34         Storage Manager Space Management.
35         </para>
36
37         <para>
38                 It tries to avoid calling expensive DMAPI calls with some
39                 heuristics based on the fact that number of blocks reported of a
40                 file multiplied by 512 will be bigger than 'online ratio' of
41                 actual size for online (non-migrated) files.
42                 If heuristic check fails, the module calls DMAPI and asks for
43                 a specific attribute which is present for offline (migrated) files.
44                 If this attribute presents, the file is considered offline.
45         </para>
46
47         <para>This module is not stackable.</para>
48
49 </refsect1>
50
51
52 <refsect1>
53         <title>OPTIONS</title>
54
55         <variablelist>
56
57                 <varlistentry>
58
59                 <term>tsmsm:hsm script = [ path to hsm script ]</term>
60                 <listitem>
61                 <para>
62                         hsm script should point to a shell script which
63                         accepts two arguments: operation and filepath.
64                         the tsmsm module only uses "offline" for operation
65                         to set the file under filepath offline.
66                 </para>
67                 </listitem>
68
69                 </varlistentry>
70                 <varlistentry>
71
72                 <term>tsmsm:online ratio = [ number ]</term>
73                 <listitem>
74                 <para>
75                 Ratio to check reported size against actual file size.
76                 The default value is 0.5.
77                 </para>
78                 </listitem>
79
80                 </varlistentry>
81
82                 <varlistentry>
83
84                 <term>tsmsm:dmapi attribute = [ attribute-name ]</term>
85                 <listitem>
86                 <para>
87                 Name of a DMAPI attribute that is present when a file is offline.
88                 The default is "IBMobj" (which is what GPFS uses).
89                 </para>
90                 </listitem>
91
92                 </varlistentry>
93                 <varlistentry>
94
95                 <term>tsmsm:dmapi value = [ value for the DMAPI attribute ]</term>
96                 <listitem>
97                 <para>
98                 Value that the DMAPI attribute should have for the file to
99                 be considered offline. The default is empty (no value required).
100                 </para>
101                 </listitem>
102
103                 </varlistentry>
104
105         </variablelist>
106 </refsect1>
107
108 <refsect1>
109         <title>EXAMPLES</title>
110
111         <para>A GPFS mount with TSM support can be exported via Samba as follows:</para>
112
113 <programlisting>
114         <smbconfsection name="[gpfs_tsm_share]"/>
115         <smbconfoption name="vfs objects">tsmsm gpfs</smbconfoption>
116         <smbconfoption name="path">/test/gpfs_mount</smbconfoption>
117 </programlisting>
118 </refsect1>
119
120 <refsect1>
121         <title>VERSION</title>
122         <para>This man page is correct for version &doc.version; of the Samba suite.
123         </para>
124 </refsect1>
125
126 <refsect1>
127         <title>AUTHOR</title>
128
129         <para>The original Samba software and related utilities
130         were created by Andrew Tridgell. Samba is now developed
131         by the Samba Team as an Open Source project similar
132         to the way the Linux kernel is developed.</para>
133 </refsect1>
134
135 </refentry>