Freenas 9.2.1 Setup Guide

FreeNAS is 2011-2014 iXsystems
FreeNAS and the FreeNAS logo are registered trademarks of iXsystems.

FreeBS is a registered trademark of the FreeBS Fo!ndation
"o#er art $y %enny &osen$erg
FreeNAS 9.2.1 Users Guide Page 2 of 280
Table of Contents
Section 1: Introduction and Installation
1 Introduction........................................................................................................................................9
1.1 What's New in 9.2.1..................................................................................................................10
1.2 Known Issues............................................................................................................................11
1.3 Hardware Recommendations....................................................................................................12
1.3.1 Architecture.......................................................................................................................12
1.3.2 RAM.................................................................................................................................12
1.3.3 Comact or !"# $%ash.....................................................................................................13
1.3.& "tora'e (is)s and Contro%%ers..........................................................................................13
1.3.* Networ) Inter+aces............................................................................................................1&
1.3., RAI( -.er.iew................................................................................................................1*
1.3./ 0$" -.er.iew...................................................................................................................1/
2 Insta%%in' and !'radin' $reeNA"1...............................................................................................19
2.1 2ettin' $reeNA"1...................................................................................................................20
2.2 $reeNA"1 in a 3irtua% 4n.ironment.......................................................................................20
2.2.1 3irtua%#o5.........................................................................................................................21
2.2.1.1Creatin' the 3irtua% Machine ............................................................................................... 21
2.2.1.2Creatin' (e.ices +or "tora'e and Insta%%ation Media .......................................................... 2,
2.2.1.3Con+i'urin' the #rid'ed Adater ........................................................................................ 26
2.2.1.&Runnin' $reeNA"1 +rom a !"# Ima'e ............................................................................. 29
2.2.2 3MWare 4"7i..................................................................................................................30
2.3 Insta%%in' +rom C(R-M...........................................................................................................3&
2.& #urnin' an IM2 $i%e................................................................................................................3/
2.&.1 !sin' 58cat and dd on a $ree#"( or 9inu5 ":stem........................................................3/
2.&.2 !sin' Ke)a and dd on an -" 7 ":stem...........................................................................3/
2.&.3 !sin' /;0i and Win32(is)Ima'er on Windows.............................................................36
2.&.& <rou=%eshootin'................................................................................................................&0
2.* Initia% "etu...............................................................................................................................&0
2., !'radin' $reeNA"1 ............................................................................................................&&
2.,.1 >rearin' +or the !'rade.................................................................................................&*
2.,.2 !sin' the I"- to !'rade.................................................................................................&*
2.,.3 !sin' the 2!I to !'rade ...............................................................................................&/
2.,.& !n%oc)in' an 4ncr:ted 3o%ume......................................................................................&9
2.,.* I+ "omethin' 2oes Wron'................................................................................................&9
2.,., !'radin' a 0$" >oo%......................................................................................................*0
Section 2: Using te Gra!ical Interface............................................................."2
3 ?uic) "tart 2uide and Account Con+i'uration................................................................................*2
3.1 ?uic) "tart 2uide.....................................................................................................................*2
3.1.1 "et the Root >assword......................................................................................................*2
3.1.2 "et the Administrati.e 4mai% Address..............................................................................*2
3.1.3 4na=%e Conso%e 9o''in'...................................................................................................*3
3.1.& Con+i'ure "tora'e.............................................................................................................*3
3.1.* Create !sers@2rous or Inte'rate with A(@9(A>...........................................................*3
3.1., Con+i'ure >ermissions......................................................................................................*&
3.1./ Con+i'ure "harin'.............................................................................................................*&
FreeNAS 9.2.1 Users Guide Page # of 280
3.1.6 "tart A%ica=%e "er.iceAsB...............................................................................................**
3.1.9 <est Con+i'uration +rom C%ient.........................................................................................**
3.1.10 #ac)u the Con+i'uration...............................................................................................**
3.2 Account Con+i'uration ............................................................................................................**
3.2.1 2rous...............................................................................................................................**
3.2.2 !sers.................................................................................................................................*6
& ":stem Con+i'uration.......................................................................................................................,1
&.1 Cron Co=s..................................................................................................................................,2
&.2 Init@"hutdown "crits...............................................................................................................,3
&.3 N<> "er.ers..............................................................................................................................,&
&.& Rs:nc <as)s..............................................................................................................................,,
&.&.1 Creatin' an Rs:nc <as).....................................................................................................,/
&.&.2 Con+i'urin' Rs:nc Modu%e Mode #etween <wo $reeNA"1 ":stems............................,9
&.&.3 Con+i'urin' Rs:nc o.er ""H Mode #etween <wo $reeNA"1 ":stems........................./1
&.* ".M.A.R.<. <ests......................................................................................................................./3
&., "ettin's...................................................................................................................................../*
&.,.1 2enera% <a=......................................................................................................................./*
&.,.2 Ad.anced <a=...................................................................................................................//
&.,.2.1Autotune .............................................................................................................................. /6
&.,.3 4mai% <a=........................................................................................................................../9
&.,.& ""9 <a=.............................................................................................................................60
&./ ":sct%s.......................................................................................................................................62
&.6 ":stem In+ormation..................................................................................................................63
&.9 <una=%es....................................................................................................................................6&
&.9.1 Reco.erin' $rom Incorrect <una=%es................................................................................6,
* Networ) Con+i'uration.....................................................................................................................6/
*.1 2%o=a% Con+i'uration................................................................................................................6/
*.2 Inter+aces...................................................................................................................................69
*.3 I>MI..........................................................................................................................................91
*.& 9in) A''re'ations....................................................................................................................93
*.&.1 Considerations When !sin' 9AC>D M>I-D N$"D or 4"7i .............................................9&
*.&.2 Creatin' a 9in) A''re'ation ...........................................................................................9&
*.* Networ) "ummar:....................................................................................................................99
*., "tatic Routes.............................................................................................................................99
*./ 39ANs......................................................................................................................................99
, "tora'e Con+i'uration....................................................................................................................101
,.1 >eriodic "nashot <as)s.........................................................................................................101
,.1.1 Creatin' a >eriodic "nashot <as)..................................................................................101
,.1.2 Mana'in' >eriodic "nashot <as)s................................................................................103
,.2 Re%ication <as)s....................................................................................................................10*
,.2.1 Con+i'ure >!99.............................................................................................................10*
,.2.2 Con+i'ure >!"H.............................................................................................................10,
,.2.3 <rou=%eshootin' Re%ication...........................................................................................106
,.3 3o%umes..................................................................................................................................109
,.3.1 Auto Imortin' 3o%umes.................................................................................................110
,.3.1.1Auto Imortin' a 249I;4ncr:ted 0$" >oo% .................................................................... 111
,.3.2 Imortin' 3o%umes..........................................................................................................112
FreeNAS 9.2.1 Users Guide Page $ of 280
,.3.3 !$" 3o%ume Mana'er.....................................................................................................113
,.3.& 0$" 3o%ume Mana'er.....................................................................................................11*
,.3.&.14ncr:tion .......................................................................................................................... 11/
Creatin' an 4ncr:ted 3o%ume.....................................................................................................116
,.3.&.2Manua% 3o%ume Creation ................................................................................................... 116
,.3.* 45tendin' a 0$" 3o%ume................................................................................................120
,.3., Creatin' 0$" (atasets....................................................................................................121
,.3.,.1(edu%ication ..................................................................................................................... 123
,.3.,.2Comression ...................................................................................................................... 123
,.3./ Creatin' a 8.o%................................................................................................................12&
,.3.6 3iewin' (is)s.................................................................................................................12*
,.3.9 3iewin' 3o%umes............................................................................................................12*
,.3.9.1Ke: Mana'ement +or 4ncr:ted 3o%umes ......................................................................... 130
,.3.10 "ettin' >ermissions.......................................................................................................131
,.3.11 3iewin' Mu%tiaths.......................................................................................................133
,.3.12 Re%acin' a $ai%ed (ri.e..............................................................................................133
,.3.12.1Re%acin' a $ai%ed (ri.e in an 4ncr:ted >oo% ............................................................... 13*
,.3.12.2Remo.in' a 9o' or Cache (e.ice ................................................................................... 13,
,.3.13 Re%acin' (ri.es to 2row a 0$" >oo%.........................................................................13,
,.3.13.14na=%in' 0$" >oo% 45ansion A+ter (ri.e Re%acement ............................................... 13/
,.3.1& "%ittin' a Mirrored 0$" "tora'e >oo%.........................................................................136
,.& 0$" "cru=s.............................................................................................................................1&0
/ "harin' Con+i'uration....................................................................................................................1&1
/.1 A%e AA$>B "hares................................................................................................................1&2
/.1.1 Creatin' A$> "hares.......................................................................................................1&3
/.1.2 Connectin' to A$> "hares As 2uest..............................................................................1&&
/.1.3 !sin' <ime Machine.......................................................................................................1&,
/.2 !ni5 AN$"B "hares..................................................................................................................1&6
/.2.1 Creatin' N$" "hares.......................................................................................................1&9
/.2.2 "am%e N$" "hare Con+i'uration...................................................................................1*1
/.2.3 Connectin' to the N$" "hare..........................................................................................1*1
/.2.3.1$rom #"( or 9inu5 C%ients ............................................................................................... 1*1
/.2.3.2$rom Microso+t C%ients ...................................................................................................... 1*2
/.2.3.3$rom Mac -" 7 C%ients .................................................................................................... 1*3
/.2.& <rou=%eshootin'..............................................................................................................1**
/.3 Windows ACI$"B "hares.........................................................................................................1**
/.3.1 Creatin' CI$" "hares......................................................................................................1**
/.3.2 Con+i'urin' Anon:mous Access....................................................................................1*/
/.3.3 Con+i'urin' 9oca% !ser Access......................................................................................1,0
/.3.& Con+i'urin' "hadow Coies...........................................................................................1,2
/.3.&.1>rereEuisites ....................................................................................................................... 1,2
/.3.&.2Con+i'uration 45am%e ...................................................................................................... 1,2
6 "er.ices Con+i'uration...................................................................................................................1,&
6.1 Contro% "er.ices......................................................................................................................1,*
6.2 A$>.........................................................................................................................................1,,
6.2.1 <rou=%eshootin'..............................................................................................................1,/
6.3 CI$"........................................................................................................................................1,/
FreeNAS 9.2.1 Users Guide Page " of 280
6.3.1 <rou=%eshootin' <is......................................................................................................1/0
6.& (irector: "er.ices..................................................................................................................1/0
6.&.1 Acti.e (irector:..............................................................................................................1/1
6.&.1.1!sin' a Ke:ta= .................................................................................................................. 1/&
6.&.1.2<rou=%eshootin' <is ......................................................................................................... 1/*
6.&.2 (omain Contro%%er .........................................................................................................1/*
6.&.3 9(A>..............................................................................................................................1//
6.&.& NI"..................................................................................................................................1/6
6.&.* N<&.................................................................................................................................1/9
6.* (:namic (N".........................................................................................................................160
6., $<>.........................................................................................................................................162
6.,.1 $<> Con+i'uration -tions.............................................................................................162
6.,.2 Anon:mous $<>.............................................................................................................16*
6.,.3 "eci+ied !ser Access in chroot.....................................................................................16,
6.,.& 4ncr:tin' $<>...............................................................................................................16/
6.,.* <rou=%eshootin'..............................................................................................................16/
6./ i"C"I.......................................................................................................................................166
6./.1 Authori8ed Accesses.......................................................................................................169
6./.2 45tents.............................................................................................................................191
6./.2.1Addin' an 45tent ............................................................................................................... 192
6./.3 Initiators..........................................................................................................................193
6./.& >orta%s.............................................................................................................................19*
6./.* <ar'et 2%o=a% Con+i'uration..........................................................................................19,
6./., <ar'ets.............................................................................................................................199
6././ <ar'et@45tents.................................................................................................................201
6./.6 Connectin' to i"C"I "hare.............................................................................................201
6./.9 2rowin' 9!Ns................................................................................................................202
6./.9.10.o% #ased 9!N ................................................................................................................ 202
6./.9.2$i%e 45tent #ased 9!N ...................................................................................................... 203
6.6 N$".........................................................................................................................................203
6.9 Rs:nc......................................................................................................................................20*
6.9.1 Rs:nc Modu%es................................................................................................................20*
6.10 ".M.A.R.<.............................................................................................................................20/
6.11 "NM>....................................................................................................................................206
6.12 ""H.......................................................................................................................................209
6.12.1 ""H Con+i'uration "creen............................................................................................209
6.12.2 Chrootin' Command 9ine "$<> !sers .......................................................................211
6.12.3 <rou=%eshootin' ""H Connections...............................................................................212
6.13 <$<>.....................................................................................................................................213
6.1& !>".......................................................................................................................................21&
9 >%u'ins............................................................................................................................................21*
9.1 Insta%%in' a $reeNA"1 >#I !sin' >%u'ins............................................................................21,
9.1.1 Mana'in' an Insta%%ed $reeNA"1 >#I..........................................................................216
9.1.2 !datin' an Insta%%ed $reeNA"1 >#I............................................................................219
9.1.3 Insta%%in' Additiona% >#Is...............................................................................................219
9.1.& (e%etin' a >#I.................................................................................................................220
9.2 A.ai%a=%e $reeNA"1 >#Is.....................................................................................................221
FreeNAS 9.2.1 Users Guide Page % of 280
9.2.1 >#I ReEuests...................................................................................................................222
10 Cai%s...............................................................................................................................................222
10.1 Cai%s Con+i'uration................................................................................................................22&
10.2 Addin' Cai%s..........................................................................................................................22*
10.2.1 Mana'in' Cai%s..............................................................................................................226
10.2.2 Accessin' a Cai% !sin' ""H Instead o+ its "he%% Icon...................................................229
10.2.2.14dit a Cai%'s "ettin's ......................................................................................................... 230
10.2.2.2Addin' "tora'e ................................................................................................................ 231
10.3 Cai% <em%ates.......................................................................................................................23&
10.3.1 Creatin' Four -wn <em%ates......................................................................................23*
10.& Insta%%in' $reeNA"1 >#Is ..................................................................................................23,
10.* Insta%%in' non;>#I "o+tware ................................................................................................236
10.*.1 Insta%%in' $ree#"( >ac)a'es with )'n'.....................................................................236
10.*.2 Comi%in' $ree#"( >orts with ma)e...........................................................................239
10.*.3 Con+i'urin' and "tartin' Insta%%ed $ree#"( "o+tware................................................2&2
11 Reortin'......................................................................................................................................2&3
12 Additiona% -tions.......................................................................................................................2&&
12.1 (is%a: ":stem >rocesses.....................................................................................................2&&
12.2 "he%%......................................................................................................................................2&*
12.3 Re=oot...................................................................................................................................2&/
12.& "hutdown..............................................................................................................................2&6
12.* He%......................................................................................................................................2&6
12., 9o' -ut.................................................................................................................................2&9
12./ A%ert......................................................................................................................................2&9
Section #: Getting &el!........................................................................................2"0
13 $reeNA"1 "uort Resources.....................................................................................................2*0
13.1 We=site and "ocia% Media.....................................................................................................2*0
13.2 $orums..................................................................................................................................2*0
13.3 "uort (ata=ase..................................................................................................................2*2
13.& IRC........................................................................................................................................2*3
13.* Mai%in' 9ists.........................................................................................................................2*&
13., >ro+essiona% "uort.............................................................................................................2*&
1& !se+u% Command 9ine !ti%ities...................................................................................................2**
1&.1 Ier+......................................................................................................................................2**
1&.2 Neter+..................................................................................................................................2*6
1&.3 I-8one...................................................................................................................................2*9
1&.& arcstat....................................................................................................................................2,2
1&.&.1 !sin' the "crits...........................................................................................................2,2
1&.* 7((......................................................................................................................................2,/
1&., twGc%i....................................................................................................................................2,9
1&./ Me'aC%i................................................................................................................................2/1
1&.6 +reenas;de=u'........................................................................................................................2/1
1&.9 tmu5......................................................................................................................................2/1
1&.10 (midecode..........................................................................................................................2/2
Section $: 'ontri(uting to FreeNAS................................................................2)#
1* How to 2et In.o%.ed....................................................................................................................2/3
FreeNAS 9.2.1 Users Guide Page ) of 280
1*.1 Assist with 9oca%i8ation ......................................................................................................2/3
1*.2 <est an !comin' 3ersion....................................................................................................2/*
1*.2.1 Ro%%in' Four -wn <estin' "nashot.............................................................................2/*
1, !sin' the $reeNA"1 A>I............................................................................................................2/*
1,.1 #ui%din' a 9oca% Co: o+ the A>Is.......................................................................................2/,
1,.2 A "im%e A>I 45am%e.........................................................................................................2//
1,.3 A More Com%e5 45am%e...................................................................................................2/9
Section 1: Introduction and Installation
Preface
Written =: users o+ the $reeNA"1 networ);attached stora'e oeratin' s:stem.
3ersion 9.2.1
>u=%ished $e=ruar: /D 201&
Co:ri'ht H 2011;201& i7s:stems.
<his 2uide co.ers the insta%%ation and use o+ $reeNA"1 9.2.1. I+ :ou are runnin' a .ersion o+
$reeNA"1 that is ear%ier than $reeNA"1 9.2.1D it is recommended that :ou u'rade to or insta%%
$reeNA"1 9.2.1. <his .ersion +i5es man: =u's +rom re.ious .ersions and se.era% +eatures mentioned
in this 2uide were not a.ai%a=%e in ear%ier .ersions o+ $reeNA"1.
<he $reeNA"1 !sers 2uide is a wor) in ro'ress and re%ies on the contri=utions o+ man: indi.idua%s.
I+ :ou are interested in he%in' us to imro.e the 2uideD .isit doc.+reenas.or' and create a wi)i %o'in
account. I+ :ou use IRC $reenodeD :ou are we%come to Ioin the J+reenas channe% where :ou wi%% +ind
other $reeNA"1 users.
<he $reeNA"1 !sers 2uide is +ree%: a.ai%a=%e +or sharin' and redistri=ution under the terms o+ the
Creati.e Commons Attri=ution 9icense. <his means that :ou ha.e ermission to co:D distri=uteD
trans%ateD and adat the wor) as %on' as :ou attri=ute i7s:stems as the ori'ina% source o+ the 2uide.
$reeNA"1 and the $reeNA"1 %o'o are re'istered trademar)s o+ i7s:stems.
3ware1 and 9"I1 are trademar)s or re'istered trademar)s o+ 9"I Cororation.
Acti.e (irector:1 is a re'istered trademar) or trademar) o+ Microso+t Cororation in the !nited "tates
and@or other countries.
A%eD Mac and Mac -" are trademar)s o+ A%e Inc.D re'istered in the !.". and other countries.
Che%sio1 is a re'istered trademar) o+ Che%sio Communications.
Cisco1 is a re'istered trademar) or trademar) o+ Cisco ":stemsD Inc. and@or its a++i%iates in the !nited
"tates and certain other countries.
(Ian'o1 is a re'istered trademar) o+ (Ian'o "o+tware $oundation.
$ace=oo)1 is a re'istered trademar) o+ $ace=oo) Inc.
$ree#"( and the $ree#"( %o'o are re'istered trademar)s o+ the $ree#"( $oundation.
$usion;io is a trademar) or re'istered trademar) o+ $usion;ioD Inc.
Inte%D the Inte% %o'oD >entium InsideD and >entium are trademar)s o+ Inte% Cororation in the !.". and@or
other countries.
9in)edIn1 is a re'istered trademar) o+ 9in)edIn Cororation.
9inu51 is a re'istered trademar) o+ 9inus <or.a%ds.
Mar.e%%1 is a re'istered trademar) o+ Mar.e%% or its a++i%iates.
<witter is a trademar) o+ <witterD Inc. in the !nited "tates and other countries.
!NI71 is a re'istered trademar) o+ <he -en 2rou.
3irtua%#o51 is a re'istered trademar) o+ -rac%e.
3MWare1 is a re'istered trademar) o+ 3MWareD Inc.
Wi)iedia1 is a re'istered trademar) o+ the Wi)imedia $oundationD Inc.D a non;ro+it or'ani8ation.
Windows1 is a re'istered trademar) o+ Microso+t Cororation in the !nited "tates and other countries.
*+!ogra!ic 'on,entions
<he $reeNA"1 9.2.1 !sers 2uide uses the +o%%owin' t:o'rahic con.entionsK
(old te-t: reresents a command written at the command %ine. In usa'e e5am%esD the +ont is chan'ed
to Courier 10 with an: command outut dis%a:ed in un=o%ded te5t.
itali' te(t) used to reresent de.ice namesD +i%e name athsD or te5t that is inut into a 2!I +ie%d.
bold italic text: used to emhasi8e an imortant oint.
1 Introduction
$reeNA"1 is an em=edded oen source networ);attached stora'e ANA"B s:stem =ased on $ree#"(
and re%eased under a #"( %icense. A NA" ro.ides an oeratin' s:stem that has =een otimi8ed +or +i%e
stora'e and sharin'.
Nota=%e +eatures in $reeNA"1 inc%udeK
suorts A$>D CI$"D $<>D N$"D ""H Ainc%udin' "$<>BD and <$<> as +i%e sharin' mechanisms
suorts e5ortin' +i%e or de.ice e5tents .ia i"C"I
suorts Acti.e (irector: or 9(A> +or user authentication as we%% as manua% user and 'rou
creation
suorts the creation and imort o+ !$"2 =ased .o%umesD inc%udin' 'mirrorD 'strieD and 'raid3
suorts the creation and imort o+ 0$" oo%sD ena=%in' man: +eatures not a.ai%a=%e in !$"2
such as EuotasD snashotsD comressionD re%icationD and datasets +or sharin' su=sets o+ .o%umes
u'rade rocedure sa.es the current oeratin' s:stem to an inacti.e artitionD a%%owin' +or an
eas: re.ersa% o+ an undesira=%e u'rade
s:stem noti+ications are automatica%%: mai%ed to the root user account
(Ian'o dri.en 'rahica% user inter+ace a.ai%a=%e throu'h a we= =rowser
secure re%icationD automatic 0$" snashotsD schedu%in' o+ 0$" scru=sD and cron mana'ement
are a%% con+i'ura=%e throu'h the 'rahica% inter+ace
suort +or menu %oca%i8ation and )e:=oard %a:outs
"MAR< monitorin' and !>" mana'ement in 2!I
suort +or Windows AC9s and !NI7 +i%es:stem ermissions
eriodic 0$" snashots are .isi=%e in Windows as shadow coies
inc%udes tmu5D a #"(;%icensed uti%it: simi%ar to 2N! screen
1.1 .at/s Ne0 in 9.2.1
$reeNA"1 9.2.1 +i5es this %ist o+ =u's and introduces the +o%%owin' +eaturesK
0$" has =een udated to =e on ar with I%%umos =u' +i5es and +eature sets. Nota=%e new +eatures
areK 8+s =oo)mar)sD 8+s send +rom read;on%: oo%sDa.oid transmittin' ho%es durin' 8+s sendD add
=%oc) contents rint to 8streamdumD ara%%e% 8d= readsD and ; Aarsa=%eB otion to 8+s %ist.
N$" with 0$" er+ormance chan'es which ro.ide noticea=%e Au to &0LB imro.ement.
"NM> D N<>D and #IN( ha.e =een atched to address recent securit: .u%nera=i%ities. "ecurit:
atches ha.e a%so =een a%ied to address randomness and maed memor:.
!date dIan'o to 1., and doIo to 1.9.2.
!date Nut to 2./.1.
!dated the 9"I ,2 H#A dri.er AmsB to .ersion 1,. !sers o+ the ms dri.er shou%d udate
their +irmware to hase 1,.
Added the e5erimenta% 9"I 122 "A" dri.er as a modu%e which can =e ena=%ed =: addin' a
tuna=%e with a M3aria=%eM o+ m*slsi+,load and a M3a%ueM o+ -.S. <his dri.er is +or =eta testin'
and is on%: a.ai%a=%e +or ,&;=it s:stems. $or roduction useD consider usin' a ,2 "A" adaterD
such as the 9"I 920/.
"am=a has =een udated to "am=a &.1.3. <his adds suort +or "M#3D which is ena=%ed =:
de+au%tD the a=i%it: +or $reeNA"1 to =e a Windows (omain Contro%%erD ad.anced +eatures %i)e
ser.er;side co: suort in Windows 2006 and %aterD and mu%ti%e :ears worth o+ imro.ements
o.er the .ersion o+ "am=a that shied in 9.2.0.
"witched +rom A.ahi to m(N"Resonder +or 0erocon+ networ) con+i'urationD imro.in' the
Mac share =rowsin' e5erience.
A M"eria% >ort AddressM +ie%d has =een added to ":stem N "ettin's N Ad.ancedD a%%owin' :ou
to seci+: a seria% ort address other than C-M1.
I>MI has =een added to Networ). <his wi%% on%: aear i+ the s:stem has I>MI hardware and
the I>MI dri.er is %oaded.
<he 6.5 .o%ume mana'er can now =e accessed +rom the MManua% setuM =utton o+ 0$" 3o%ume
Mana'er. "ince a manua% setu a%%ows +or the creation o+ non;otima% .o%umes and contains no
anti;+ootshootin' %o'icD it is meant +or ad.anced users who )now e5act%: what the: are doin'
and understand the rami+ications o+ creatin' non;otima% .o%umes. It is instead recommended to
use dis)s o+ the same si8e and to %et 0$" 3o%ume Mana'er create a .o%ume that has =een
otimi8ed +or redundanc: and caacit:.
OInitia%i8e "a+e%:P has =een remo.ed +or now +rom 0$" 3o%ume Mana'er as the time needed +or
this action to com%ete can =e si'ni+icant.
MComressionM and MComression RatioM co%umns ha.e =een added to the 3iew 3o%umes
screen.
<he non;+unctiona% share assword +ie%d has =een remo.ed +rom A%e AA$>B "hares.
Added the a=i%it: to use a )e:ta= +or A( Ioins in Acti.e (irector:. <his e%iminates the need to
use the A( Administrator account to Ioin $reeNA"1 to A( and c%oses a %on' standin' issue o+
needin' the A( Admin assword in the $reeNA"1 con+i'uration data=ase.
(omain Contro%%er has =een added as a (irector: "er.ice and can =e used to con+i'ure
$reeNA"1 as a (omain Contro%%er. In order to con+i'ure this ser.iceD it must +irst =e se%ected in
the ":stem N "ettin's N 2enera% N (irector: "er.ice dro;down menu.
#: de+au%tD N$" !(> suort is disa=%ed as it con+uses some c%ients. A M"er.e !(> N$"
c%ientsM chec)=o5 has =een added to N$" to o.erride this de+au%t.
Reortin' has =een di.ided into ta=s to ma)e it easier to .iew reorts =: t:e o+ acti.it:.
Added 'rahs to Reortin' that show indi.idua% dis) acti.it:.
>er;Iai% s:sct% .a%ues can now =e seci+ied when creatin' or editin' a Cai%.
<he trafso0 command %ine uti%it: has =een added which can =e used to .iew connections to
the $reeNA"1 s:stem.
<he !traidconf command %ine uti%it: has =een added +or Hi'h>oint stora'e contro%%ers
mana'ement.
1.2 1no0n Issues
#e+ore insta%%in' $reeNA"1 :ou shou%d =e aware o+ the +o%%owin' )nown issuesK
UPGRADES FROM FreeNAS 0.7x ARE UNSUPPORTED. <he s:stem has no wa: to
imort con+i'uration settin's +rom 0./5 .ersions o+ $reeNA"1D meanin' that :ou wi%% ha.e to
manua%%: recreate :our con+i'uration. Howe.erD :ou shou%d =e a=%e to imort suorted
$reeNA"1 0./5 .o%umes.
The FS !"#rade "roced!re i$ %o%&re'er$ible. (o not u'rade :our 0$" .ersion un%ess :ou
are a=so%ute%: sure that :ou wi%% ne.er want to 'o =ac) to the re.ious .ersion. <here is no
re.ersin' a 0$" oo% u'radeD and there is no wa: +or a s:stem with an o%der .ersion o+ 0$" to
access oo%s that ha.e =een u'raded.
<he a.ai%a=%e sace reorted in the arent 8oo% ma: not re+%ect rea%it: and can =e con+usin'
=ecause the a.ai%a=%e sace reresented =: datasets or 8.o%s can e5ceed that o+ the arent 8oo%.
(is)s with certain con+i'urations can 'et ro=ed =: 24-M and =ecome essentia%%: unwrita=%e
without manua% inter.ention. $or instanceD i+ :ou use dis)s that re.ious%: had a 'mirror on
themD the s:stem ma: ic) that u and the dis)s wi%% =e una.ai%a=%e unti% the e5istin' 'mirror is
stoed and destro:ed.
<he ms dri.er +or ,2 9"I "A" H#As is .ersion 1,D which reEuires hase 1, +irmware on the
contro%%er. Runnin' o%der +irmware can cause man: woesD inc%udin' the +ai%ure to ro=e a%% o+
the attached dis)sD which can %ead to de'raded or una.ai%a=%e arra:s.
1.# &ard0are 2eco33endations
"ince $reeNA"1 9.2.1 is =ased on $ree#"( 9.2D it suorts the same hardware +ound in the amd,&
and i36, sections o+ the $ree#"( 9.2 Hardware Comati=i%it: 9ist .
Actua% hardware reEuirements wi%% .ar: deendin' uon what :ou are usin' :our $reeNA"1 s:stem
+or. <his section ro.ides some 'uide%ines to 'et :ou started. Fou can a%so s)im throu'h the $reeNA"1
Hardware $orum +or er+ormance tis +rom other $reeNA"1 users or to ost Euestions re'ardin' the
hardware =est suited to meet :our reEuirements. <his +orum ost ro.ides some seci+ic
recommendations i+ :ou are %annin' on urchasin' hardware.
1.#.1 Arcitecture
Whi%e $reeNA"1 is a.ai%a=%e +or =oth 32;=it and ,&;=it architecturesD ,&;=it hardware is recommended
+or seed and er+ormance. A 32;=it s:stem can on%: address u to & 2# o+ RAMD ma)in' it oor%:
suited to the RAM reEuirements o+ 0$". I+ :ou on%: ha.e access to a 32;=it s:stemD consider usin'
!$" instead o+ 0$".
1.#.2 2A4
<he =est wa: to 'et the most out o+ :our $reeNA"1 s:stem is to insta%% as much RAM as ossi=%e. I+
:our RAM is %imitedD consider usin' !$" unti% :ou can a++ord =etter hardware. $reeNA"1 with 0$"
t:ica%%: reEuires a minimum o+ 6 2# o+ RAM in order to ro.ide 'ood er+ormance and sta=i%it:. <he
more RAMD the =etter the er+ormanceD and the $reeNA"1 $orums ro.ide anecdota% e.idence +rom
users on how much er+ormance is 'ained =: addin' more RAM. $or s:stems with %ar'e dis) caacit:
A'reater than 6 <#BD a 'enera% ru%e o+ thum= is 1 2# o+ RAM +or e.er: 1 <# o+ stora'e. <his ost
descri=es how RAM is used =: 0$".
I+ :ou %an to use :our ser.er +or home useD :ou can o+ten so+ten the ru%e o+ thum= o+ 1 2# o+ RAM +or
e.er: 1 <# o+ stora'eD thou'h 6 2# o+ RAM is sti%% the recommended minimum. I+ er+ormance is
inadeEuate :ou shou%d consider addin' more RAM as a +irst remed:. <he sweet sot +or most users in
home@sma%% =usiness is 1,2# o+ RAM.
It is ossi=%e to use 0$" on s:stems with %ess than 6 2# o+ RAM. Howe.erD $reeNA"1 as distri=uted
is con+i'ured to =e suita=%e +or s:stems meetin' the si8in' recommendations a=o.e. I+ :ou wish to use
0$" on a sma%%er memor: s:stemD some tunin' wi%% =e necessar:D and er+ormance wi%% =e A%i)e%:
su=stantia%%:B reduced. 0$" wi%% automatica%%: disa=%e re;+etchin' Acachin'B on s:stems where it is not
a=%e to use at %east & 2# o+ memor: Iust +or 0$" cache and data structures. <his ost descri=es man: o+
the re%e.ant tuna=%es.
I+ :our s:stem suorts it and :our =ud'et a%%ows +or itD insta%% 4CC RAM.
I+ :ou %an to use 0$" dedu%icationD a 'enera% ru%e o+ thum= is * 2# RAM er <# o+ stora'e to =e
dedu%icated.
I+ :ou use Acti.e (irector: with $reeNA"1D add an additiona% 2 2# o+ RAM +or win=ind's interna%
cache.
I+ :ou are insta%%in' $reeNA"1 on a head%ess s:stemD disa=%e the shared memor: settin's +or the .ideo
card in the #I-".
I+ :ou on%: %an to use !$"D :ou ma: =e a=%e to 'et =: with as %itt%e as 22# o+ RAM.
I+ :ou don't ha.e at %east 62# o+ RAM with 0$" or 22# o+ RAM with !$"D :ou shou%d consider
'ettin' more ower+u% hardware =e+ore usin' $reeNA"1 to store :our data. -therwiseD data %oss ma:
resu%t.
.A2NING: to ensure consistenc: +or the chec)summin' and arit: ca%cu%ations er+ormed =: 0$"D
4CC RAM is hi'h%: recommended. !sin' non;4CC RAM can cause unreco.era=%e dama'e to a 8oo%
resu%tin' in a %oss o+ a%% data in the oo%.
1.#.# 'o3!act or US5 Flas
<he $reeNA"1 oeratin' s:stem is a runnin' ima'e. <his means that it shou%d not =e insta%%ed onto a
hard dri.eD =ut rather to a !"# or comact +%ash de.ice that is at %east 2 2# in si8e. I+ :ou don't ha.e
comact +%ashD :ou can instead use a !"# thum= dri.e that is dedicated to the runnin' ima'e and
which sta:s inserted in the !"# s%ot. Whi%e technica%%: :ou can insta%% $reeNA"1 onto a hard dri.eD
this is discoura'ed as :ou wi%% %ose the stora'e caacit: o+ the dri.e. In other wordsD the oeratin'
s:stem wi%% ta)e o.er the dri.e and wi%% not a%%ow :ou to store data on itD re'ard%ess o+ the si8e o+ the
dri.e.
<he $reeNA"1 insta%%ation wi%% artition the oeratin' s:stem dri.e into two artitions. -ne artition
ho%ds the current oeratin' s:stem and the other artition is used when :ou u'rade. <his a%%ows :ou to
sa+e%: u'rade to a new ima'e or to re.ert to an o%der ima'e shou%d :ou encounter ro=%ems.
!"# 3.0 suort is disa=%ed =: de+au%t as it current%: is not comati=%e with some hardwareD inc%udin'
Haswe%% A9:n5 ointB chisets. I+ :ou recei.e a M+ai%ed with error 19M messa'e when tr:in' to =oot
$reeNA"1D ma)e sure that 5HCI@!"#3 is disa=%ed in the s:stem #I-". Whi%e this wi%% downc%oc) the
!"# orts to 2.0D the =ootu and shutdown times wi%% not =e si'ni+icant%: di++erent. <o see i+ !"# 3.0
suort wor)s with :our hardwareD create a <una=%e named (h'i,loadD set its .a%ue to -.SD and re=oot
the s:stem.
It is hi'h%: recommended that when usin' a !"# stic)D that on%: name =rand !"# stic)s are used as
o++;=rand stic)s ma: not =e +u%%: comati=%e with $reeNA"1.
N6*7: "( cards to !"# con.erters are not recommended as these ha.e caused ro=%ems +or man:
users. When usin' a C$ adaterD a.oid the no;name =rands to ensure comati=i%it:D re%ia=i%it:D and
er+ormance.
FreeNAS 9.2.1 Users Guide Page 1# of 280
1.#.$ Storage 8is9s and 'ontrollers
<he (is) section o+ the $ree#"( Hardware 9ist %ists the suorted dis) contro%%ers. In additionD
suort +or 3ware ,'=s RAI( contro%%ers has =een added a%on' with the C9I uti%it: t0:cli +or
mana'in' 3ware RAI( contro%%ers.
$reeNA"1 suorts hot %u''a=%e dri.es. Ma)e sure that AHCI is ena=%ed in the #I-". Note that hot
%u''in' is %ot the $a(e as a hot sareD which is not suorted at this time.
I+ :ou need re%ia=%e dis) a%ertin'D immediate reortin' o+ a +ai%ed dri.eD and or swain'D use a +u%%:
mana'ea=%e hardware RAI( contro%%er such as a 9"I Me'aRAI( contro%%er or a 3Ware twa;comati=%e
contro%%er. <he current $ree#"( 0$" im%ementation wi%% not notice that a dri.e is 'one unti% :ou
re=oot or ut the .o%ume on hi'h %oad. More in+ormation a=out 9"I cards and $reeNA"1 can =e +ound
in this +orum ost.
"u''estions +or testin' dis)s =e+ore addin' them to a RAI( arra: can =e +ound in this +orum ost.
<his artic%e ro.ides a 'ood o.er.iew o+ hard dri.es which are we%% suited +or a NA".
I+ :ou ha.e some mone: to send and wish to otimi8e :our dis) su=s:stemD consider :our read@write
needsD :our =ud'etD and :our RAI( reEuirements.
I+ :ou ha.e stead:D non;conti'uous writesD use dis)s with %ow see) times. 45am%es are 10K or 1*K
"A" dri.es which cost a=out Q1@2#. An e5am%e con+i'uration wou%d =e si5 ,00 2# 1*K "A" dri.es
in a RAI( 10 which wou%d :ie%d 1.6 <# o+ usa=%e sace or ei'ht ,00 2# 1*K "A" dri.es in a RAI(
10 which wou%d :ie%d 2.& <# o+ usa=%e sace.
/200 R>M "A<A dis)s are desi'ned +or sin'%e;user seEuentia% I@- and are not a 'ood choice +or mu%ti;
user writes.
I+ :ou ha.e the =ud'et and hi'h er+ormance is a )e: reEuirementD consider a $usion;I@- card which is
otimi8ed +or massi.e random access. <hese cards are e5ensi.e and are suited +or hi'h end s:stems
that demand er+ormance. A $usion;I@- can =e +ormatted with a +i%es:stem and used as direct stora'eR
when used this wa:D it does not ha.e the write issues t:ica%%: associated with a +%ash de.ice. A $usion;
I@- can a%so =e used as a cache de.ice when :our 0$" dataset si8e is =i''er than :our RAM. (ue to the
increased throu'hutD s:stems runnin' these cards t:ica%%: use mu%ti%e 10 2i'4 networ) inter+aces.
I+ :ou wi%% =e usin' 0$"D (is) "ace ReEuirements +or 0$" "tora'e >oo%s recommends a minimum o+
1, 2# o+ dis) sace. (ue to the wa: that 0$" creates swaD )o! ca% %ot *or(at le$$ tha% + G, o*
$"ace -ith FS. Howe.erD on a dri.e that is =e%ow the minimum recommended si8e :ou %ose a +air
amount o+ stora'e sace to swaK +or e5am%eD on a & 2# dri.eD 2 2# wi%% =e reser.ed +or swa.
I+ :ou are new to 0$" and are urchasin' hardwareD read throu'h 0$" "tora'e >oo%s
Recommendations +irst.
0$" uses d:namic =%oc) si8in'D meanin' that it is caa=%e o+ striin' di++erent si8ed dis)s. Howe.erD i+
:ou care a=out er+ormanceD use dis)s o+ the same si8e. $urtherD when creatin' a RAI(0D on%: the si8e
o+ the sma%%est dis) wi%% =e used on each dis).
1.#." Net0or9 Interfaces
<he 4thernet section o+ the $ree#"( Hardware Notes indicates which inter+aces are suorted =: each
dri.er. Whi%e man: inter+aces are suortedD $reeNA"1 users ha.e seen the =est er+ormance +rom
Inte% and Che%sio inter+acesD so consider these =rands i+ :ou are urchasin' a new inter+ace. Rea%te)s
FreeNAS 9.2.1 Users Guide Page 1$ of 280
wi%% er+orm oor%: under C>! %oad as inter+aces with these chisets do not ro.ide their own
rocessors.
At a minimum :ou wi%% want to use a 2i'4 inter+ace. Whi%e 2i'4 inter+aces and switches are
a++orda=%e +or home useD it shou%d =e noted that modern dis)s can easi%: saturate 110 M#@s. I+ :ou
reEuire a hi'her networ) throu'hutD :ou can =ond mu%ti%e 2i'4 cards to'ether usin' the 9AC> t:e
o+ 9in) A''re'ation. Howe.erD an: switches wi%% need to suort 9AC> which means :ou wi%% need a
more e5ensi.e mana'ed switch rather than a home user 'rade switch.
I+ networ) er+ormance is a reEuirement and :ou ha.e some mone: to sendD use 10 2i'4 inter+aces
and a mana'ed switch. I+ :ou are urchasin' a mana'ed switchD consider one that suorts 9AC> and
Ium=o +rames as =oth can =e used to increase networ) throu'hut.
N6*7: at this time the +o%%owin' are %ot suortedK In+ini#andD $i=reChanne% o.er 4thernetD or
wire%ess inter+aces.
I+ networ) seed is a reEuirementD consider =oth :our hardware and the t:e o+ shares that :ou create.
-n the same hardwareD CI$" wi%% =e s%ower than $<> or N$" as "am=a is sin'%e;threaded. I+ :ou wi%%
=e usin' CI$"D use a +ast C>!.
Wa)e on 9AN AW-9B suort is deendent uon the $ree#"( dri.er +or the inter+ace. I+ the dri.er
suorts W-9D it can =e ena=%ed usin' i+con+i'A6B. <o determine i+ W-9 is suorted on a articu%ar
inter+aceD seci+: the inter+ace name to the +o%%owin' command. In this e5am%eD the caa=i%ities %ine
indicates that W-9 is suorted +or the re0 inter+aceK
ifconfig -m em0
re0: flags=8943<UP,BROADCAST,RUNNING,PROMISC,SIMPLEX,MULTICAST> metric 0 mtu 1500
options=42098<VLAN_MTU,VLAN_HWTAGGING,VLAN_HWCSUM,WOL_MAGIC,VLAN_HWTSO>
capabilities=5399b<RXCSUM,TXCSUM,VLAN_MTU,VLAN_HWTAGGING,VLAN_HWCSUM,TSO4,WOL_UCAST
,WOL_MCAST,
WOL_MAGIC,VLAN_HWFILTER,VLAN_H WTSO>
I+ :ou +ind that W-9 suort is indicated =ut not wor)in' +or a articu%ar inter+aceD su=mit a =u'
reort.
1.#.% 2AI8 6,er,ie0
(ata redundanc: and seed are imortant considerations +or an: networ) attached stora'e s:stem.
Most NA" s:stems use mu%ti%e dis)s to store dataD meanin' :ou shou%d decide which t:e o+ RAI( to
use $efore insta%%in' $reeNA"1. <his section ro.ides an o.er.iew o+ RAI( t:es to assist :ou in
decidin' which t:e =est suits :our reEuirements.
2AI8 0: ro.ides otima% er+ormance and a%%ows :ou to add dis)s as needed. Pro'ide$ .ero
red!%da%c)/ (ea%i%# i* o%e di$0 *ail$/ all o* the data o% all o* the di$0$ i$ lo$t. <he more dis)s in the
RAI( 0D the more %i)e%: the chance o+ a +ai%ure.
2AI8 1: ro.ides redundanc: as data is coied AmirroredB to two or more dri.es. >ro.ides 'ood read
er+ormance =ut ma: ha.e s%ower write er+ormanceD deendin' uon how the mirrors are setu and
the num=er o+ 0I9s and 92ARCs.
2AI8 ": reEuires a minimum o+ three dis)s and can to%erate the %oss o+ one dis) without %osin' data.
(is) reads are +ast =ut write seed can =e reduced =: as much as *0L. I+ a dis) +ai%sD it is mar)ed as
de'raded =ut the s:stem wi%% continue to oerate unti% the dri.e is re%aced and the RAI( is re=ui%t.
FreeNAS 9.2.1 Users Guide Page 1" of 280
Howe.erD shou%d another dis) +ai% =e+ore the RAI( is re=ui%tD a%% data wi%% =e %ost.
2AI8 %: reEuires a minimum o+ +our dis)s and can to%erate the %oss o+ two dis)s without %osin' data.
#ene+its +rom ha.in' man: dis)s as er+ormanceD +au%t to%eranceD and cost e++icienc: are a%% imro.ed
re%ati.e%: with more dis)s. <he %ar'er the +ai%ed dri.eD the %on'er it ta)es to re=ui%d the arra:. Reads are
.er: +ast =ut writes are s%ower than a RAI( *.
2AI8 10: reEuires a minimum o+ +our dis)s and num=er o+ dis)s is a%wa:s e.en as this t:e o+ RAI(
mirrors stried sets. <his t:e o+ RAI( can sur.i.e the +ai%ure o+ an: one dri.e. I+ :ou %ose a second
dri.e +rom the $a(e mirrored setD :ou wi%% %ose the arra:. Howe.erD i+ :ou %ose a second dri.e +rom a
di++erent mirrored setD the arra: wi%% continue to oerate in a de'raded state. RAI( 10 si'ni+icant%:
outer+orms RAI(02D esecia%%: on writes.
2AI8 %0: reEuires a minimum o+ ei'ht dis)s. Com=ines RAI( 0 striin' with the distri=uted dou=%e
arit: o+ RAI( , =: striin' 2 &;dis) RAI( , arra:s. RAI( ,0 re=ui%d times are ha%+ that o+ RAI( ,.
2AI8;1: 0$" so+tware so%ution that is eEui.a%ent to RAI(*. Its ad.anta'e o.er RAI( * is that it
a.oids the write;ho%e and does not reEuire an: secia% hardwareD meanin' it can =e used on commodit:
dis)s. I+ :our $reeNA"1 s:stem wi%% =e used +or stead: writesD RAI(0 is a oor choice due to the
s%ow write seed.
2AI8;2: dou=%e;arit: 0$" so+tware so%ution that is simi%ar to RAI(;,. Its ad.anta'e o.er RAI( * is
that it a%so a.oids the write;ho%e and does not reEuire an: secia% hardwareD meanin' it can =e used on
commodit: dis)s. RAI(02 a%%ows :ou to %ose one dri.e without an: de'radation as it =asica%%:
=ecomes a RAI(01 unti% :ou re%ace the +ai%ed dri.e and resi%.er. At this timeD RAI(02 on $ree#"(
is s%ower than RAI(01.
2AI8;#: tri%e;arit: 0$" so+tware so%ution. RAI(03 o++ers three arit: dri.es and can oerate in
de'raded mode i+ u to three dri.es +ai% with no restrictions on which dri.es can +ai%.
N6*7: instead o+ mi5in' 0$" RAI( with hardware RAI(D it is recommended that :ou %ace :our
hardware RAI( contro%%er in C#-( mode and %et 0$" hand%e the RAI(. Accordin' to Wi)iediaK
O0$" can not +u%%: rotect the user's data when usin' a hardware RAI( contro%%erD as it is not a=%e to
er+orm the automatic se%+;hea%in' un%ess it contro%s the redundanc: o+ the dis)s and data. 0$" re+ers
directD e5c%usi.e access to the dis)sD with nothin' in =etween that inter+eres. I+ the user insists on usin'
hardware;%e.e% RAI(D the contro%%er shou%d =e con+i'ured as C#-( mode Ai.e. turn o++ RAI(;
+unctiona%it:B +or 0$" to =e a=%e to 'uarantee data inte'rit:. Note that hardware RAI( con+i'ured as
C#-( ma: sti%% detach dis)s that do not resond in timeR and as such ma: reEuire <94R@CC<9@4RC;
ena=%ed dis)s to re.ent dri.e droouts. <hese %imitations do not a%: when usin' a non;RAI(
contro%%erD which is the re+erred method o+ su%:in' dis)s to 0$".P
When determinin' the t:e o+ RAI(0 to useD consider whether :our 'oa% is to ma5imum dis) sace or
ma5imum er+ormanceK
RAI(01 ma5imi8es dis) sace and 'enera%%: er+orms we%% when data is written and read in
%ar'e chun)s A126K or moreB.
RAI(02 o++ers =etter data a.ai%a=i%it: and si'ni+icant%: =etter mean time to data %oss AM<<(9B
than RAI(01.
A mirror consumes more dis) sace =ut 'enera%%: er+orms =etter with sma%% random reads.
FreeNAS 9.2.1 Users Guide Page 1% of 280
$or =etter er+ormanceD a mirror is stron'%: +a.ored o.er an: RAI(0D articu%ar%: +or %ar'eD
uncachea=%eD random read %oads.
When determinin' how man: dis)s to use in a RAI(0D the +o%%owin' con+i'urations ro.ide otima%
er+ormance. Arra: si8es =e:ond 12 dis)s are not recommended.
"tart a RAI(01 at at 3D *D or 9 dis)s.
"tart a RAI(02 at &D ,D or 10 dis)s.
"tart a RAI(03 at *D /D or 11 dis)s.
<he recommended num=er o+ dis)s er 'rou is =etween 3 and 9. I+ :ou ha.e more dis)sD use mu%ti%e
'rous.
<he +o%%owin' resources can a%so he% :ou determine the RAI( con+i'uration =est suited to :our
stora'e needsK
What is the #est RAI(0 Con+i'uration
2ettin' the Most out o+ 0$" >oo%s
A C%oser 9oo) at 0$"D 3de.s and >er+ormance
N6*7: NO RA1D SO2UT1ON PRO31DES A REP2A4EMENT FOR A RE21A,2E ,A45UP
STRATEG6. ,AD STUFF 4AN ST122 7APPEN AND 6OU 8122 ,E G2AD T7AT 6OU
,A45ED UP 6OUR DATA 87EN 1T DOES. "ee >eriodic "nashot <as)s and Re%ication <as)s i+
:ou wou%d %i)e to use 0$" snashots and rs:nc as art o+ :our =ac)u strate':.
1.#.) ;FS 6,er,ie0
Whi%e 0$" isn't hardwareD an o.er.iew is inc%uded in this section as the decision to use 0$" ma:
imact on :our hardware choices and whether or not to use hardware RAI(.
I+ :ou are new to 0$"D the Wi)iedia entr: on 0$" ro.ides an e5ce%%ent startin' oint to %earn a=out
its +eatures. <hese resources are a%so use+u% to =oo)mar) and re+er to as neededK
$ree#"( 0$" <unin' 2uide
0$" Administration 2uide
#ecomin' a 0$" NinIa A.ideoB
"%ideshow e5%ainin' 3(e.D 8oo%D 0I9 and 92ARC and other new=ie mista)esS
A Crash Course on 0$"
<he +o%%owin' is a '%ossar: o+ terms used =: 0$"K
Pool: a co%%ection o+ de.ices that ro.ides h:sica% stora'e and data re%ication mana'ed =: 0$". <his
oo%ed stora'e mode% e%iminates the concet o+ .o%umes and the associated ro=%ems o+ artitionsD
ro.isionin'D wasted =andwidth and stranded stora'e. In $reeNA"1D 0$" 3o%ume Mana'er is used to
create 0$" oo%s.
8ataset: once a oo% is createdD it can =e di.ided into datasets. A dataset is simi%ar to a +o%der in that it
suorts ermissions. A dataset is a%so simi%ar to a +i%es:stem in that :ou can set roerties such as
Euotas and comression.
FreeNAS 9.2.1 Users Guide Page 1) of 280
;,ol: 0$" stora'e oo%s can ro.ide .o%umes +or a%ications that need raw;de.ice semantics such as
swa de.ices or i"C"I de.ice e5tents. In other wordsD a 8.o% is a .irtua% =%oc) de.ice in a 0$" stora'e
oo%.
Sna!sot: a read;on%: oint;in;time co: o+ a +i%es:stem. "nashots can =e created Euic)%: andD i+
%itt%e data chan'esD new snashots ta)e u .er: %itt%e sace. $or e5am%eD a snashot where no +i%es ha.e
chan'ed ta)es 0 M# o+ stora'eD =ut i+ :ou chan'e a 10 2# +i%e it wi%% )ee a co: o+ =oth the o%d and
the new 10 2# .ersion. "nashots ro.ide a c%e.er wa: o+ )eein' a histor: o+ +i%esD shou%d :ou need
to reco.er an o%der co: or e.en a de%eted +i%e. $or this reasonD man: administrators ta)e snashots
o+ten Ae.'. e.er: 1* minutesBD store them +or a eriod o+ time Ae.'. +or a monthBD and store them on
another s:stem. "uch a strate': a%%ows the administrator to ro%% the s:stem =ac) to a seci+ic time orD i+
there is a catastrohic %ossD an o++;site snashot can restore the s:stem u to the %ast snashot inter.a%
Ae.'. within 1* minutes o+ the data %ossB. "nashots can =e c%oned or ro%%ed =ac)D =ut the +i%es on the
snashot cannot =e accessed indeendent%:.
'lone: a writa=%e co: o+ a snashot which can on%: =e created on the same 0$" .o%ume. C%ones
ro.ide an e5treme%: sace;e++icient wa: to store man: coies o+ most%:;shared data such as
wor)sacesD so+tware insta%%ationsD and dis)%ess c%ients. C%ones do not inherit the roerties o+ the
arent datasetD =ut rather inherit the roerties =ased on where the c%one is created in the 0$" oo%.
#ecause a c%one initia%%: shares a%% its dis) sace with the ori'ina% snashotD its used roert: is initia%%:
8ero. As chan'es are made to the c%oneD it uses more sace.
8edu!lication: the rocess o+ e%iminatin' du%icate coies o+ data in order to sa.e sace. -nce
dedu%icaton occursD it can imro.e 0$" er+ormance as %ess data is written and stored. Howe.erD the
rocess o+ dedu%icatin' the data is RAM intensi.e and a 'enera% ru%e o+ thum= is * 2# RAM er <#
o+ stora'e to =e dedu%icated. 1% (o$t ca$e$/ e%abli%# co("re$$io% -ill "ro'ide co("arable
"er*or(a%ce. In $reeNA"1D dedu%ication can =e ena=%ed at the dataset %e.e% and there is no wa: to
undedu data once it is dedu%icatedK switchin' dedu%ication o++ has NO AFFE4T on e5istin' data.
<he more data :ou write to a dedu%icated datasetD the more RAM it reEuiresD and there is no uer
=ound on this. When the s:stem starts storin' the ((<s Adedu ta=%esB on dis) =ecause the: no %on'er
+it into RAMD er+ormance craters. $urthermoreD imortin' an unc%ean oo% can reEuire =etween 3;*
2# o+ RAM er <# o+ dedued dataD and i+ the s:stem doesn't ha.e the needed RAM it wi%% anicD with
the on%: so%ution =ein' to add more RAM or to recreate the oo%. Thi%0 care*!ll) be*ore e%abli%#
ded!"9
;I<: A0$" Intent 9o'B is e++ecti.e%: a +i%es:stem Iourna% that mana'es writes. <he 0I9 is a temorar:
stora'e area +or s:nc writes unti% the: are written as:nchronous%: to the 0$" oo%. I+ the s:stem has
man: s:nc writesD such as +rom a data=ase ser.erD er+ormance can =e increased =: addin' a dedicated
%o' de.ice As%o'B usin' 0$" 3o%ume Mana'er. I+ the s:stem has +ew s:nc writesD a s%o' wi%% not seed
u writes to the oo%. A more detai%ed e5%anation can =e +ound in this +orum ost.
A dedicated %o' de.ice wi%% ha.e no a++ect on CI$"D A$>D or i"C"I as these rotoco%s rare%: use s:nc
writes. A dedicated %o' de.ice can increase write er+ormance o.er N$"D esecia%%: +or 4"7i. When
creatin' a dedicated %o' de.iceD it is recommended to use a +ast ""( with a suercaacitor or a =an) o+
caacitors that can hand%e writin' the contents o+ the ""('s RAM to the ""(. I+ :ou don't ha.e access
to such an ""(D tr: disa=%in' s:nc writes on the N$" dataset usin' 8+sA6B instead.
<he =ilstat uti%it: can =e run +rom "he%% to he% determine i+ the s:stem wou%d =ene+it +rom a dedicated
0I9 de.ice. "ee this we=site +or usa'e in+ormation.
I+ :ou decide to create a dedicated %o' de.ice to seed u N$" writesD the ""( can =e ha%+ the si8e o+
s:stem RAM as an:thin' %ar'er than that is unused caacit:. <he %o' de.ice $ho!ld be (irrored o% a
FS':; "ool beca!$e i* o%e o* the lo# de'ice$ *ail$/ the "ool i$ !%reco'erable and the oo% must =e
recreated and the data restored +rom a =ac)u. <he %o' de.ice does not need to =e mirrored on a
0$".26 oo% as the s:stem wi%% re.ert to usin' the 0I9 i+ the %o' de.ice +ai%s and on%: the data in the
de.ice which had not =een written to the oo% wi%% =e %ost At:ica%%: the %ast +ew seconds o+ writesB. Fou
can re%ace the %ost %o' de.ice in the 3iew 3o%umes N 3o%ume "tatus screen. Note that a dedicated %o'
de.ice can not =e shared =etween 0$" oo%s and that the same de.ice cannot ho%d =oth a %o' and a
cache de.ice.
<2A2': 0$" uses a RAM cache to reduce read %atenc:. I+ an ""( is dedicated as a cache de.iceD it is
)nown as an 92ARC and 0$" uses it to store more reads which can increase random read er+ormance.
Howe.erD addin' a cache de.ice wi%% not imro.e a s:stem with too %itt%e RAM and wi%% actua%%:
decrease er+ormance as 0$" uses RAM to trac) the contents o+ 92ARC. RAM is a%wa:s +aster than
dis)sD so a%wa:s add as much RAM as ossi=%e =e+ore determinin' i+ the s:stem wou%d =ene+it +rom a
92ARC de.ice.
I+ :ou ha.e a %ot o+ a%ications that do %ar'e amounts o+ random readsD on a dataset sma%% enou'h to +it
into the 92ARCD read er+ormance ma: =e increased =: addin' a dedicated cache de.ice usin' 0$"
3o%ume Mana'er. ""( cache de.ices on%: he% i+ :our wor)in' set is %ar'er than s:stem RAMD =ut
sma%% enou'h that a si'ni+icant ercenta'e o+ it wi%% +it on the ""(. A+ter addin' an 92ARCD monitor
its e++ecti.eness usin' too%s such as arcstat. I+ :ou need to increase the si8e o+ an e5istin' 92ARCD :ou
can strie another cache de.ice =: addin' another de.ice. <he 2!I wi%% a%wa:s strie 92ARCD not
mirror itD as the contents o+ 92ARC are recreated at =oot.
9osin' an 92ARC de.ice wi%% not a++ect the inte'rit: o+ the oo%D =ut ma: ha.e an imact on read
er+ormanceD deendin' uon the wor)%oad and the ratio o+ dataset si8e to cache si8e. Note that a
dedicated 92ARC de.ice can not =e shared =etween 0$" oo%s.
Scru(: simi%ar to 4CC memor: scru==in'D a%% data is read to detect %atent errors whi%e the:'re sti%%
correcta=%e. A scru= tra.erses the entire stora'e oo% to read e.er: data =%oc)D .a%idates it a'ainst its
2*,;=it chec)sumD and reairs it i+ necessar:.
2 Installing and U!grading FreeNAS
#e+ore insta%%in'D it is imortant to remem=er that the $reeNA"1 oeratin' s:stem must =e insta%%ed on
a searate de.ice +rom the dri.eAsB that wi%% ho%d the stora'e data. In other wordsD i+ :ou on%: ha.e one
dis) dri.e :ou wi%% =e a=%e to use the $reeNA"1 'rahica% inter+ace =ut won't =e a=%e to store an: dataD
which a+ter a%%D is the who%e oint o+ a NA" s:stem. I+ :ou are a home user who is e5erimentin' with
$reeNA"1D :ou can insta%% $reeNA"1 on an ine5ensi.e !"# thum= dri.e and use the comuter's
dis)AsB +or stora'e.
<his section descri=es the +o%%owin'K
2ettin' $reeNA"1
$reeNA"1 in a 3irtua% 4n.ironment
Insta%%in' +rom C(R-M
#urnin' an IM2 $i%e
Initia% "etu
!'radin' $ reeNA"1
2.1 Getting FreeNAS
$reeNA"1 9.2.1 can =e down%oaded +rom the down%oad a'e o+ the $reeNA"1 we=site. $reeNA"1 is
a.ai%a=%e +or 32;=it A536,B and ,&;=it A5,&B architectures. Fou shou%d down%oad the architecture t:e
that matches :our C>!'s caa=i%ities.
N6*7: there are man: =ui%t;in %imitations in the 32;=it .ersion. Fou shou%d on%: insta%% this .ersion i+
:our C>! a=so%ute%: does not suort ,&;=it.
<he down%oad a'e contains the +o%%owin' t:es o+ +i%es. (own%oad one +i%e that meets :our needsK
'8 Installer: this is a =oota=%e insta%%er that can =e written to C(R-M. <his is descri=ed in
more detai% in Insta%%in' +rom C(R-M.
8is9 I3age: this is a comressed ima'e o+ the oeratin' s:stem that needs to =e written to a
!"# or comact +%ash de.ice. #urnin' an IM2 $i%e descri=es how to write the ima'e.
GUI U!grade or <egac+ U!grade: this is a comressed +irmware u'rade ima'e. I+ :our
intent is to u'rade $reeNA"1D down%oad the correct +i%e +or :our architecture and .ersion and
see the section on !'radin' $reeNA"1. (own%oad the 2!I !'rade i+ :ou are u'radin'
+rom .ersion 6.2.0;#4<A3 throu'h 9.1.0. (own%oad the %e'ac: u'rade i+ :ou are u'radin'
+rom .ersion 6.0.1#4<A3 throu'h 6.2.0;#4<A2.
4ach +i%e has an associated "HA2*, hash which shou%d =e used to .eri+: the inte'rit: o+ the
down%oaded +i%e =e+ore writin' it to the insta%%ation media. <he command :ou use to .eri+: the
chec)sum .aries =: oeratin' s:stemK
on a #"( s:stem use the command sa2"% na3e:of:file
on a 9inu5 s:stem use the command sa2"%su3 na3e:of:file
on a Mac s:stem use the command sasu3 >a 2"% na3e:of:file
on a Windows s:stem or Mac s:stemD :ou can insta%% a uti%it: such as HashCa%c or Hash<a=
2.2 FreeNAS in a ?irtual 7n,iron3ent
$reeNA" can =e run inside a .irtua% en.ironment +or de.e%omentD e5erimentationD and educationa%
uroses. >%ease note that runnin' $reeNA" in roduction as a .irtua% machine is not recommended. I+
:ou decide to use $reeNA"1 within a .irtua% en.ironmentD read this ost +irst as it contains use+u%
'uide%ines +or minimi8in' the ris) o+ %osin' :our data.
In order to insta%% or run $reeNA"1 within a .irtua% en.ironmentD :ou wi%% need to create a .irtua%
machine that meets the +o%%owin' minimum reEuirementsK
at lea$t 20&6 M# =ase memor: si8e A!$"B or &09, M# A0$"B
a .irtua% dis) at lea$t < G, i% $i.e to ho%d the oeratin' s:stem and swa
at %east one more .irtua% dis) at lea$t = G, i% $i.e to =e used as data stora'e
a =rid'ed adater
<his section demonstrates how to create and access a .irtua% machine within the 3irtua%#o5 and
3MWare 4"7i en.ironments.
2.2.1 ?irtual5o-
3irtua%#o5 is an oen source .irtua%i8ation ro'ram ori'ina%%: created =: "un Micros:stems.
3irtua%#o5 runs on WindowsD #"(D 9inu5D MacintoshD and -en"o%aris. It can =e con+i'ured to use a
down%oaded $reeNA"1 .iso or .img.(/ +i%eD and ma)es a 'ood testin' en.ironment +or racticin'
con+i'urations or %earnin' how to use the +eatures ro.ided =: $reeNA"1.
2.2.1.1 Creating the Virtual Machine
<o create the .irtua% machineD start 3irtua%#o5 and c%ic) the ONewP =uttonD seen in $i'ure 2.2aD to start
the new .irtua% machine wi8ard.
Figure 2.2a: Initial ?irtual5o- Screen
C%ic) the ONe5tP =utton to see the screen in $i'ure 2.2=. 4nter a name +or the .irtua% machineD c%ic) the
O-eratin' ":stemP dro;down menu and se%ect #"(D and se%ect O$ree#"( A,&;=itBP +rom the
O3ersionP drodown.
Figure 2.2(: *+!e in a Na3e and Select te 6!erating S+ste3 for te Ne0 ?irtual 4acine
C%ic) ONe5tP to see the screen in $i'ure 2.2c. <he =ase memor: si8e must =e chan'ed to at lea$t <0=>
M,. 1* )o!r $)$te( ha$ e%o!#h (e(or)/ $elect at lea$t =0?@ M, $o that )o! ca% !$e FS. When
+inishedD c%ic) ONe5tP to see the screen in $i'ure 2.2d.
Figure 2.2c: Select te A3ount of 4e3or+ 2eser,ed for te ?irtual 4acine
Figure 2.2d: Select .eter to Use an 7-isting or 'reate a Ne0 ?irtual &ard 8ri,e
C%ic) OCreateP to %aunch the OCreate 3irtua% Hard (ri.e Wi8ardP shown in $i'ure 2.2e.
Figure 2.2e: 'reate Ne0 ?irtual &ard 8ri,e .i=ard
"e%ect one o+ the +o%%owin' t:esK
?8I: se%ect this otion i+ :ou down%oaded the I"-.
?481: se%ect this otion i+ :ou con.erted the .img +i%e to 3M(K +ormat usin' the instructions
in Runnin' $reeNA"1 +rom a !"# Ima'e.
-nce :ou ma)e a se%ectionD c%ic) the ONe5tP =utton to see the screen in $i'ure 2.2+.
Figure 2.2f: Select te Storage *+!e for te ?irtual 8is9
Fou can now choose whether :ou want O(:namica%%: a%%ocatedP or O$i5ed;si8eP stora'e. <he +irst
otion uses dis) sace as needed unti% it reaches the ma5imum si8e that :ou wi%% set in the ne5t screen.
<he second otion creates a dis) the same si8e as that seci+ied amount o+ dis) saceD whether it is used
or not. Choose the +irst otion i+ :ou are worried a=out dis) saceR otherwiseD choose the second otion
as it a%%ows 3irtua%#o5 to run s%i'ht%: +aster. -nce :ou se%ect ONe5tPD :ou wi%% see the screen in $i'ure
2.2'.
Figure 2.2g: Select te File Na3e and Si=e of te ?irtual 8is9
<his screen is used to set the si8e Aor uer %imitB o+ the .irtua% machine. 1%crea$e the de*a!lt $i.e to <
or = G,. !se the +o%der icon to =rowse to a director: on dis) with su++icient sace to ho%d the .irtua%
machine.
-nce :ou ma)e :our se%ection and ress ONe5tPD :ou wi%% see a summar: o+ :our choices. !se the
O#ac)P =utton to return to a re.ious screen i+ :ou need to chan'e an: .a%ues. -therwiseD c%ic)
O$inishP to +inish usin' the wi8ard. <he .irtua% machine wi%% =e %isted in the %e+t +rameD as seen in the
e5am%e in $i'ure 2.2h.
Figure 2.2: *e Ne0 ?irtual 4acine
2.2.1.2 Creating Devices for Storage and Installation Media
Ne5tD create the .irtua% dis)AsB to =e used +or stora'e. C%ic) the O"tora'eP h:er%in) in the ri'ht +rame
to access the stora'e screen seen in $i'ure 2.2i.
Figure 2.2i: *e Storage Settings of te ?irtual 4acine
C%ic) the OAdd AttachmentP =uttonD se%ect OAdd Hard (is)P +rom the o;u menuD then c%ic) the
OCreate New (is)P =utton. <his wi%% %aunch the Create New 3irtua% Hard (ri.e Wi8ard Aseen in
$i'ures 2.2e and 2.2+B. "ince this dis) wi%% =e used +or stora'eD create a si8e aroriate to :our needsD
ma)in' sure that it is at lea$t = G, in si8e. I+ :ou wish to ractice RAI( con+i'urationsD create as
man: .irtua% dis)s as :ou need. Fou wi%% =e a=%e to create 2 dis)s on the I(4 contro%%er. I+ :ou need
additiona% dis)sD c%ic) the OAdd Contro%%erP =utton to create another contro%%er to attach dis)s to.
Ne5tD create the de.ice +or the insta%%ation media.
I+ :ou wi%% =e insta%%in' +rom an I"-D hi'h%i'ht the word O4mt:PD then c%ic) the C( icon as seen in
$i'ure 2.2I.
Figure 2.2@: 'onfiguring te IS6 Installation 4edia
C%ic) OChoose a .irtua% C(@(3( dis) +i%e...P to =rowse to the %ocation o+ the .iso +i%e. A%ternate%:D i+
:ou ha.e =urned the .iso to dis)D se%ect the detected OHost (ri.eP.
(eendin' uon the e5tensions a.ai%a=%e in :our C>!D :ou ma: or ma: not =e a=%e to use the I"-. I+
:ou recei.e the error O:our C>! does not suort %on' modeP when :ou tr: to =oot the I"-D :our C>!
either does not ha.e the reEuired e5tension or AM(;3@3<;5 is disa=%ed in the s:stem #I-".
N-<4K i+ :ou recei.e a )erne% anic when =ootin' into the I"-D sto the .irtua% machine. <henD 'o to
":stem and chec) the =o5 O4na=%e I- A>ICP.
2.2.1.3 Configuring the Bridged Adater
<o con+i'ure the networ) adaterD 'o to "ettin's N Networ). In the OAttached toP dro;down menu
se%ect O#rid'ed AdaterPD then se%ect the name o+ the h:sica% inter+ace +rom the ONameP dro;down
menu. In the e5am%e shown in $i'ure 2.2)D the Inte% >ro@1000 4thernet card is attached to the networ)
and has a de.ice name o+ re0.
-nce :our con+i'uration is com%eteD c%ic) the O"tartP arrow. I+ :ou con+i'ured the I"-D insta%%
$reeNA"1 as descri=ed in Insta%%in' +rom C(R-M. -nce $reeNA"1 is insta%%edD ress $12 to access
the =oot menu in order to se%ect the rimar: hard dis) as the =oot otion. Fou can ermanent%: =oot
+rom dis) =: remo.in' the C(@(3( de.ice in O"tora'eP or =: unchec)in' C(@(3(;R-M in the
O#oot -rderP section o+ O":stemP.
I+ :ou con+i'ured the 3M(KD the .irtua% machine wi%% =oot direct%: into $reeNA"1.
Figure 2.29: 'onfiguring a 5ridged Ada!ter in ?irtual5o-
2.2.1.! "unning #ree$AS% fro& a 'SB I&age
I+ :ou wi%% =e runnin' $reeNA"1 +rom an .img.(/ +i%e instead o+ insta%%in' it +rom the I"-D :ou must
+irst down%oad and insta%% the -rac%e 3M 3irtua%#o5 45tension >ac) that matches :our .ersion o+
3irtua%#o5. <he e5tension ac) ena=%es !"# suort.
Ne5tD uncomress and =urn the $reeNA"1 .img.(/ +i%e usin' the instructions at #urnin' an Ima'e $i%e.
-nce the ima'e is =urned to the !"# de.iceD %ea.e the de.ice inserted.
<he 3irtua%#o5 2!I does not automatica%%: ro.ide a wa: to se%ect a !"# de.ice to =oot +rom.
Howe.erD :ou can use a command %ine uti%it: to %in) the !"# de.ice to a .#mdk +i%e so that it can =e
se%ected as a =oot de.ice. <o do this on a Windows s:stemD oen a command romt in administrati.e
mode Ari'ht;c%ic) c3d +rom the Run menu and se%ect Run as administratorBD and run the commands
shown in $i'ure 2.2%. #e+ore runnin' these commandsD .eri+: the h:sica% dri.e num=er +rom "tart
menu N ri'ht;c%ic) Comuter N Mana'e N "tora'e N (is) Mana'ement. I+ the !"# dri.e is
di++erent than (is) 1D chan'e the num=er in 00.01hysi'alri#e1 to match the dis) num=er. Fou can a%so
seci+: where to sa.e the .#mdk +i%e. Ma)e sure that the securit: ta= o+ the sa.ed +i%e 'i.es O$u%%
contro%P ermissions to !sers so that the +i%e can =e accessed =: 3irtua%#o5.
Figure 2.2l: 'reating te ,3d9 File in .indo0s
-nce :ou ha.e a .#mdk +i%eD create a new .irtua% machine whi%e the !"# stic) is inserted. When :ou
'et to $i'ure 2.2eD se%ect O!se e5istin' hard dis)P and =rowse to :our .#mdk +i%e. C%ic) ONe5tPD then
OCreateP. <his wi%% create the .irtua% machine and =rin' :ou to $i'ure 2.2h. Fou can then create :our
stora'e dis)s and =rid'ed adater as usua%. When +inishedD start the .irtua% machine and it wi%% =oot
direct%: into $reeNA"1.
2.2.2 ?4.are 7SAi
I+ :ou are considerin' usin' 4"7iD read this ost +or an e5%anation o+ wh: i"C"I wi%% =e +aster than
N$".
4"7i is is a =are;meta% h:er.isor architecture created =: 3Mware Inc. Commercia% and +ree .ersions
o+ the 3MWare ."here H:er.isor oeratin' s:stem A4"7iB are a.ai%a=%e +rom the 3MWare we=site.
-nce the oeratin' s:stem is insta%%ed on suorted hardwareD use a we= =rowser to connect to its I>
address. <he we%come screen wi%% ro.ide a %in) to down%oad the 3Mware ."here c%ient which is used
to create and mana'e .irtua% machines.
-nce the 3Mware ."here c%ient is insta%%edD use it to connect to the 4"7i ser.er. <o create a new
.irtua% machineD c%ic) $i%e N New N 3irtua% Machine. <he New 3irtua% Machine Wi8ard wi%% %aunch
as seen in $i'ure 2.2m.
C%ic) ONe5tP and inut a name +or the .irtua% machine. C%ic) ONe5tP and hi'h%i'ht a datastore. An
e5am%e is shown in $i'ure 2.2n. C%ic) ONe5tP. In the screen shown in $i'ure 2.2oD c%ic) O-therP then
se%ect a $ree#"( architecture that matches the $reeNA"1 architecture.
FreeNAS 9.2.1 Users Guide Page #0 of 280
Figure 2.23: Ne0 ?irtual 4acine .i=ard
Figure 2.2n: Select a 8atastore
Figure 2.2o: Select te 6!erating S+ste3
C%ic) ONe5tP and create a .irtua% dis) +i%e o+ 2 G, to ho%d the $reeNA"1 oeratin' s:stemD as shown
in $i'ure 2.2.
C%ic) ONe5tP then O$inishP. Four .irtua% machine wi%% =e %isted in the %e+t +rame. Ri'ht;c%ic) the .irtua%
machine and se%ect O4dit "ettin'sP to access the screen shown in $i'ure 2.2E.
Increase the OMemor: Con+i'urationP to at lea$t <0=> M, .
!nder OC>!sPD ma)e sure that on%: 1 .irtua% rocessor is %istedD otherwise :ou wi%% =e una=%e to start
an: $reeNA"1 ser.ices.
<o create a stora'e dis)D c%ic) Hard dis) 1 N Add. In the O(e.ice <:eP menuD hi'h%i'ht OHard (is)P
and c%ic)P Ne5tP. "e%ect OCreate a new .irtua% dis)P and c%ic) ONe5tP. In the screen shown in $i'ure
2.2rD se%ect the si8e o+ the dis). I+ :ou wou%d %i)e the si8e to =e d:namica%%: a%%ocated as neededD chec)
the =o5 OA%%ocate and commit sace on demand A<hin >ro.isionin'BP. C%ic) ONe5tPD then ONe5tPD then
O$inishP to create the dis). Reeat to create the amount o+ stora'e dis)s needed to meet :our
reEuirements.
Figure 2.2!: 'reate a 8is9 for te 6!erating S+ste3
Figure 2.2B: ?irtual 4acine/s Settings
FreeNAS 9.2.1 Users Guide Page ## of 280
Figure 2.2r: 'reating a Storage 8is9
2.# Installing fro3 '8264
I+ :ou re+er to insta%% $reeNA"1 usin' a menu;dri.en insta%%erD down%oad the I"- ima'e that matches
the architecture o+ the s:stem :ou wi%% insta%% onto A32; or ,&;=itB and =urn it to a C(R-M.
N6*7: the insta%%er on the C(R-M wi%% reco'ni8e i+ a re.ious .ersion o+ $reeNA"1 is a%read:
insta%%edD meanin' the C(R-M can a%so =e used to u'rade $reeNA"1. Howe.erD the insta%%er can not
er+orm an u'rade +rom a $reeNA"1 ./ s:stem.
Insert the C(R-M into the s:stem and =oot +rom it. -nce the media has +inished =ootin'D :ou wi%% =e
resented with the conso%e setu menu seen in $i'ure 2.3a.
N6*7: i+ the insta%%er does not =ootD chec) that the C( dri.e is %isted +irst in the =oot order in the
#I-". "ome mother=oards ma: reEuire :ou to connect the C(R-M to "A<A0 Athe +irst connectorB in
order to =oot +rom C(R-M. I+ it sta%%s durin' =ootD chec) the "HA2*, hash o+ :our I"- a'ainst that
%isted in the Re%ease NotesR i+ the hash does not matchD re;down%oad the +i%e. I+ the hash is correctD tr:
=urnin' the C( a'ain at a %ower seed.
FreeNAS 9.2.1 Users Guide Page #$ of 280
Figure 2.#a: FreeNAS 'onsole Setu!
>ress enter to se%ect the de+au%t otion o+ O1 Insta%%@!'rade to hard dri.e@+%ash de.iceD etc.P. <he ne5t
menuD seen in $i'ure 2.3=D wi%% %ist a%% a.ai%a=%e dri.esD inc%udin' an: inserted !"# thum= dri.es which
wi%% =e'in with da. In this e5am%eD the user is insta%%in' into 3irtua%#o5 and has created a & 2# .irtua%
dis) to ho%d the oeratin' s:stem.
N6*7: at this timeD the insta%%er does not chec) the si8e o+ the insta%% media =e+ore attemtin' an
insta%%ation. A 2 2# de.ice is reEuiredD =ut the insta%% wi%% aear to com%ete success+u%%: on sma%%er
de.icesD on%: to +ai% at =oot. I+ usin' a !"# thum= dri.eD an & 2# dri.e is recommended as man: 2 2#
thum= dri.es ha.e a sma%%er caacit: which wi%% resu%t in a seemin'%: success+u% insta%%ation that +ai%s
to =oot.
!se :our arrow )e:s to hi'h%i'ht the !"#D comact +%ash de.iceD or .irtua% dis) to insta%% intoD then ta=
to -K and ress enter. $reeNA"1 wi%% issue the warnin' seen in $i'ure 2.3cD remindin' :ou not to
insta%% onto a stora'e dri.e.
>ress enter and $reeNA"1 wi%% e5tract the ima'e +rom the I"- and trans+er it to the de.ice. -nce the
insta%%ation is com%eteD :ou shou%d see a messa'e simi%ar to $i'ure 2.3d.
>ress enter to return to the +irst menuD seen in $i'ure 2.3a. Hi'h%i'ht O3 Re=oot ":stemP and ress
enter. Remo.e the C(R-M. I+ :ou insta%%ed onto a !"# thum= dri.eD %ea.e the thum= dri.e inserted.
Ma)e sure that the de.ice :ou insta%%ed to is %isted as the +irst =oot entr: in the #I-" so that the s:stem
wi%% =oot +rom it. $reeNA"1 shou%d now =e a=%e to =oot into the Conso%e setu menu descri=ed in
Initia% "etu.
FreeNAS 9.2.1 Users Guide Page #" of 280
Figure 2.#(: Selecting .ic 8ri,e to Install Into
Figure 2.#c: FreeNAS Installation .arning
Figure 2.#d: FreeNAS Installation 'o3!lete
FreeNAS 9.2.1 Users Guide Page #% of 280
2.$ 5urning an I4G File
I+ :our s:stem does not ha.e a C(R-M dri.e to insta%% +romD :ou can instead write the oeratin'
s:stem direct%: to a comact +%ash card or !"# thum=dri.e. (own%oad the img.(/ +i%eD uncomress the
+i%eD and write it to a comact +%ash card or !"# thum=dri.e that is 2 2# or %ar'er. Fou then =oot into
that de.ice to %oad the $reeNA"1 oeratin' s:stem. <his section demonstrates how to write the ima'e
usin' se.era% di++erent oeratin' s:stems. <he !net=ootin too% is not suorted at this time.
8ANG72C <he dd command demonstrated in this section is .er: ower+u% and can destro: an:
e5istin' data on the seci+ied de.ice. #e 'er) $!re that :ou )now the de.ice name to write to and that
:ou do not t:o the de.ice name when usin' ddS I+ :ou are uncom+orta=%e writin' the ima'e :ourse%+D
down%oad the .iso +i%e instead and use the instructions in Insta%%in' +rom C(R-M.
-nce :ou ha.e written the ima'e to the de.iceD ma)e sure the =oot order in the #I-" is set to =oot
+rom that de.ice and =oot the s:stem. It shou%d =oot into the Conso%e setu menu descri=ed in Initia%
"etu. I+ it does notD tr: the su''estions in the <rou=%eshootin' section.
2.$.1 Using -=cat and dd on a Free5S8 or <inu- S+ste3
-n a $ree#"( or 9inu5 s:stemD the -=cat and dd commands can =e used to uncomress and write the
.(/ ima'e to an inserted !"# thum= dri.e or comact +%ash de.ice. 45am%e 2.&a demonstrates writin'
the ima'e to the +irst !"# de.ice A2de#2da0B on a $ree#"( s:stem. "u=stitute the +i%ename o+ :our .(/
+i%e and the de.ice name reresentin' the de.ice to write to on :our s:stem.
7-a3!le 2.$a: .riting te I3age to a US5 *u3( 8ri,e
xzcat FreeNAS-9.2.1-RELEASE-x64.img.xz | dd of=/dev/da0 bs=64k
0+244141 records in
0+244141 records out
2000000000 bytes transferred in 596.039857 secs (3355480 bytes/sec)
When usin' the dd commandK
ofD re+ers to the outut +i%eR in our caseD the de.ice name o+ the +%ash card or remo.a=%e !"#
dri.e. Fou ma: ha.e to increment the num=er in the name i+ it is not the +irst !"# de.ice. -n
9inu5D use 2de#2sdX3 where X re+ers to the %etter o+ the !"# de.ice.
(sD re+ers to the =%oc) si8e
2.$.2 Using 1e9a and dd on an 6S A S+ste3
-n an -" 7 s:stemD :ou can down%oad and insta%% Ke)a to uncomress the ima'e. In $IN(4RD
na.i'ate to the %ocation where :ou sa.ed the down%oaded .(/ +i%e. Ri'ht;c%ic) the .(/ +i%e and se%ect
O-en With Ke)aP. A+ter a +ew minutes :ou wi%% ha.e a %ar'e +i%e with the same nameD =ut no .(/
e5tension.
Insert the !"# thum= dri.e and 'o to 9aunchad N !ti%ities N (is) !ti%it:. !nmount an: mounted
artitions on the !"# thum= dri.e. Chec) that the !"# thum= dri.e has on%: one artitionD otherwise
:ou wi%% 'et artition ta=%e errors on =oot. I+ neededD use (is) !ti%it: to setu one artition on the !"#
dri.eR se%ectin' M+ree saceM when creatin' the artition wor)s +ine.
FreeNAS 9.2.1 Users Guide Page #) of 280
Ne5tD determine the de.ice name o+ the inserted !"# thum= dri.e. $rom <4RMINA9D na.i'ate to :our
(es)to then t:e this commandK
diskutil list
/dev/disk0
#: TYPE NAME SIZE IDENTIFIER
0: GUID_partition_scheme *500.1 GB disk0
1: EFI 209.7 MB disk0s1
2: Apple_HFS Macintosh HD 499.2 GB disk0s2
3: Apple_Boot Recovery HD 650.0 MB disk0s3
/dev/disk1
#: TYPE NAME SIZE IDENTIFIER
0: FDisk_partition_scheme *8.0 GB disk1
1: DOS_FAT_32 UNTITLED 8.0 GB disk1s1
<his wi%% show :ou which de.ices are a.ai%a=%e to the s:stem. 9ocate :our !"# stic) and record the
ath. I+ :ou are not sure which ath is the correct one +or the !"# stic)D remo.e the de.iceD run the
command a'ainD and comare the di++erence. -nce :ou are sure o+ the de.ice nameD na.i'ate to the
(es)to +rom <4RMINA9D unmount the !"# stic)D and use the dd command to write the ima'e to the
!"# stic). In 45am%e 2.&=D the !"# thum= dri.e is 2de#2disk1. "u=stitute the name o+ :our
uncomressed +i%e and the correct ath to :our !"# thum= dri.e.
7-a3!le 2.$(: Using dd on an 6S A S+ste3
diskutil unmountDisk /dev/disk1
Unmount of all volumes on disk1 was successful
dd if=FreeNAS-9.2.1-RELEASE-x64.img of=/dev/disk1 bs=64k
N6*7: i+ :ou 'et the error OResource =us:P when :ou run the dd commandD 'o to A%ications N
!ti%ities N (is) !ti%it:D +ind :our !"# thum= dri.eD and c%ic) on its artitions to ma)e sure a%% o+ them
are unmounted. I+ :ou 'et the error OddK @de.@dis)1K >ermission deniedPD run the dd command =:
t:in' sudo dd ifDFreeNAS>9.2.1>27<7AS7>-%$.i3g ofDEde,Edis91 (sD%$9D which wi%% romt +or
:our assword.
<he dd command wi%% ta)e some minutes to com%ete. Wait unti% :ou 'et a romt =ac) and a messa'e
that dis%a:s how %on' it too) to write the ima'e to the !"# dri.e.
2.$.# Using )>;i! and .in#28is9I3ager on .indo0s
Windows users wi%% need to down%oad a uti%it: that can uncomress .(/ +i%es and a uti%it: that can create
a !"# =oota=%e ima'e +rom the uncomressed .img +i%e.
<his section wi%% demonstrate how to use /;0i and Win32(is)Ima'er to =urn the ima'e +i%e. When
down%oadin' Win32(is)Ima'erD down%oad the %atest .ersion that ends in -$inary./i* and use /;0i to
un8i its e5ecuta=%e.
-nce =oth uti%ities are insta%%edD %aunch the /;0i $i%e Mana'er and =rowse to the %ocation containin'
:our down%oaded .img.(/ +i%eD as seen in $i'ure 2.&a.
Figure 2.$a: Using )>;i! to 7-tract I3age File
C%ic) the 45tract =uttonD =rowse to the ath to e5tract toD and c%ic) -K. <he e5tracted ima'e wi%% end in
.img and is now read: to =e written to a !"# de.ice usin' Win32(is)Ima'er.
Ne5tD %aunch Win32(is)Ima'erD shown in $i'ure 2.&=. !se the =rowse =utton to =rowse to the %ocation
o+ the .img +i%e. Insert a !"# thum= dri.e and se%ect its dri.e %etter +rom the (e.ice dro;down menu.
C%ic) the Write =utton and the ima'e wi%% =e written to the !"# thum= dri.e.
Figure 2.$(: Using .in#28is9I3ager to .rite te I3age
2.$.$ *rou(lesooting
I+ the s:stem does not =oot into $reeNA"1D there are se.era% thin's that :ou can chec) to reso%.e the
situation.
$irstD chec) the s:stem #I-" and see i+ there is an otion to chan'e the !"# emu%ation +rom
C(@(3(@+%o: to hard dri.e. I+ it sti%% wi%% not =ootD chec) to see i+ the card@dri.e is !(MA
com%iant.
"ome users ha.e +ound that some =rands o+ 2 2# !"# stic)s do not wor) as the: are not rea%%: 2 2#
in si8eD =ut chan'in' to a & 2# stic) +i5es the ro=%em.
I+ :ou are writin' the ima'e to a comact +%ash cardD ma)e sure that it is M"(-" +ormatted.
I+ the s:stem starts to =oot =ut han's with this reeated error messa'eK
run_interrupt_driven_hooks: still waiting after 60 seconds for xpt_config
'o into the s:stem #I-" and see i+ there is an on=oard de.ice con+i'uration +or a 139& Contro%%er. I+ soD
disa=%e the de.ice and tr: =ootin' a'ain.
I+ the =urned ima'e +ai%s to =oot and the ima'e was =urned usin' a Windows s:stemD wie the !"#
stic) =e+ore tr:in' a second =urn usin' a uti%it: such as Acti.eT Ki%%(is). -therwiseD the second =urn
attemt wi%% +ai% as Windows does not understand the artition which was written +rom the ima'e +i%e.
#e .er: care+u% that :ou seci+: the !"# stic) when usin' a wie uti%it:S
2." Initial Setu!
When :ou =oot into $reeNA"1D the Conso%e "etuD shown in $i'ure 2.*aD wi%% aear at the end o+ the
=oot rocess. I+ :ou ha.e access to the the $reeNA"1 s:stem's )e:=oard and monitorD this Conso%e
"etu menu can =e used to administer the s:stem shou%d the administrati.e 2!I =ecome inaccessi=%e.
N6*7: :ou can access the Conso%e "etu menu +rom within the $reeNA"1 2!I =: t:in' EetcEnetcli
+rom "he%%. Fou can disa=%e the Conso%e "etu menu =: unchec)in' the M4na=%e Conso%e MenuM in
":stem N "ettin's N Ad.anced.
FreeNAS 9.2.1 Users Guide Page $0 of 280
Figure 2."a: FreeNAS 'onsole Setu! 4enu
<his menu ro.ides the +o%%owin' otionsK
1F 'onfigure Net0or9 Interfaces: ro.ides a con+i'uration wi8ard to con+i'ure the s:stem's networ)
inter+aces.
2F 'onfigure <in9 Aggregation: a%%ows :ou to either create a new %in) a''re'ation or to de%ete an
e5istin' %in) a''re'ation.
#F 'onfigure ?<AN Interface: used to create or de%ete a 39AN inter+ace.
$F 'onfigure 8efault 2oute: used to set the I>.& or I>., de+au%t 'atewa:. When romtedD inut the
I> address o+ the de+au%t 'atewa:.
"F 'onfigure Static 2outes: wi%% romt +or the destination networ) and the 'atewa: I> address. Re;
enter this otion +or each route :ou need to add.
%F 'onfigure 8NS: wi%% romt +or the name o+ the (N" domain then the I> address o+ the +irst (N"
ser.er. <o inut mu%ti%e (N" ser.ersD ress enter to inut the ne5t one. When +inishedD ress enter
twice to %ea.e this otion.
)F 2eset .e(GUI login credentials: i+ :ou are una=%e to %o'in to the 'rahica% administrati.e
inter+aceD se%ect this otion. <he ne5t time the 'rahica% inter+ace is accessedD it wi%% romt to set the
root assword.
8F 2eset to factor+ defaults: i+ :ou wish to de%ete all o+ the con+i'uration chan'es made in the
administrati.e 2!ID se%ect this otion. -nce the con+i'uration is resetD the s:stem wi%% re=oot. Fou wi%%
need to 'o to "tora'e N 3o%umes N Auto Imort 3o%ume to re;imort :our .o%ume.
9F Sell: enters a she%% in order to run $ree#"( commands. <o %ea.e the she%%D t:e e-it.
10F 2e(oot: re=oots the s:stem.
11F Sutdo0n: ha%ts the s:stem.
(urin' =ootD $reeNA"1 wi%% automatica%%: tr: to connect to a (HC> ser.er +rom a%% %i.e inter+aces. I+
it success+u%%: recei.es an I> addressD it wi%% dis%a: the I> address which can =e used to access the
'rahica% conso%e. In the e5am%e seen in $i'ure 2.*aD the $reeNA"1 s:stem is accessi=%e +rom
htt*)22142.156.1.70.
I+ :our $reeNA"1 ser.er is not connected to a networ) with a (HC> ser.erD :ou can use the networ)
con+i'uration wi8ard to manua%%: con+i'ure the inter+ace as seen in 45am%e 2.*a. In this e5am%eD the
$reeNA"1 s:stem has one networ) inter+ace Aem0B.
7-a3!le 2."a: 4anuall+ Setting an IP Address fro3 te 'onsole 4enu
Enter an option from 1-11: 1
1) em0
Select an interface (q to quit): 1
Delete existing config? (y/n) n
Configure interface for DHCP? (y/n) n
Configure IPv4? (y/n) y
Interface name: (press enter as can be blank)
Several input formats are supported
Example 1 CIDR Notation:
192.168.1.1/24
Example 2 IP and Netmask separate:
IP: 192.168.1.1
Netmask: 255.255.255.0, or /24 or 24
IPv4 Address: 192.168.1.108/24
Saving interface configuration: Ok
Configure IPv6? (y/n) n
Restarting network: ok
You may try the following URLs to access the web user interface:
http://192.168.1.108
-nce the s:stem has an I> addressD inut that address into a 'rahica% we= =rowser +rom a comuter
caa=%e o+ accessin' the networ) containin' the $reeNA"1 s:stem. Fou shou%d =e romted to create
a assword +or the root userD as seen in $i'ure 2.*=.
Figure 2."(: Set te 2oot Pass0ord
"ettin' a assword is mandator: and the assword can not =e =%an). "ince this assword ro.ides
access to the administrati.e 2!ID it shou%d =e a hard;to;'uess assword. -nce the assword has =een
inut and con+irmedD :ou shou%d see the administrati.e 2!I as shown in the e5am%e in $i'ure 2.*c.
FreeNAS 9.2.1 Users Guide Page $# of 280
Figure 2."c: FreeNAS Gra!ical 'onfiguration 4enu
I+ :ou are una=%e to access the I> address +rom a =rowserD chec) the +o%%owin'K
Are ro5: settin's ena=%ed in the =rowser con+i'urationU I+ soD disa=%e the settin's and tr:
connectin' a'ain.
I+ the a'e does not %oadD ma)e sure that :ou can !ing the $reeNA"1 s:stem's I> address. I+ the
address is in a ri.ate I> address ran'eD :ou wi%% on%: =e a=%e to access the s:stem +rom within
the ri.ate networ).
I+ the user inter+ace %oads =ut is unresonsi.e or seems to =e missin' menu itemsD tr: usin' a
di++erent we= =rowser. I49 has )nown issues and wi%% not dis%a: the 'rahica% administrati.e
inter+ace correct%: i+ comati=i%it: mode is turned on. I+ :ou can't access the 2!I usin' Internet
45%orerD use $ire+o5 instead.
I+ :ou recei.e OAn error occurredSP messa'es when attemtin' to con+i'ure an item in the 2!ID
ma)e sure that the =rowser is set to a%%ow coo)ies +rom the $reeNA"1 s:stem.
<his =%o' ost descri=es some a%ications which can =e used to access the $reeNA"1 s:stem +rom an
i>ad or i>hone.
2.% U!grading FreeNAS
$reeNA"1 ro.ides two methods +or er+ormin' an u'radeK an I"- u'rade or an u'rade usin' the
'rahica% administrati.e inter+ace. !n%ess the Re%ease Notes indicate that :our current .ersion reEuires
an I"- u'radeD :ou can use either u'rade method. #oth methods are descri=ed in this section.
,e*ore "er*or(i%# a% !"#rade/ al-a)$ bac0!" )o!r co%*i#!ratio% *ile a%d )o!r data.
When u'radin'D be a-are o* the *ollo-i%# ca'eat$:
Neither u'rade method can =e used to mi'rate +rom $reeNA" 0./5. InsteadD insta%% $reeNA"1
and either auto;imort suorted so+tware RAI( or imort suorted +i%es:stems. Fou wi%% need
to recreate :our con+i'uration as the insta%%ation rocess wi%% not imort 0./ con+i'uration
settin's.
FreeNAS 9.2.1 Users Guide Page $$ of 280
2.%.1 Pre!aring for te U!grade
#e+ore u'radin' the s:stem to 9.2.1D er+orm the +o%%owin' stesK
1. (own%oad the .iso or .t(/ +i%e that matches the s:stem's architecture to the comuter that :ou use
to access the $reeNA"1 s:stem.
2. 9ocate and con+irm the "HA2*, hash +or the +i%e that :ou down%oaded in the Re%ease Notes +or
the .ersion that :ou are u'radin' to.
3. ,ac0!" the FreeNAS co%*i#!ratio% in ":stem N "ettin's N 2enera% N "a.e Con+i'.
&. I+ an: .o%umes are encr:tedD ma)e sure that :ou ha.e set the asshrase and ha.e coies o+ the
encr:tion )e: and the %atest reco.er: )e:.
*. Warn users that the $reeNA"1 shares wi%% =e una.ai%a=%e durin' the u'radeR :ou shou%d
schedu%e the u'rade +or a time that wi%% %east imact users.
,. "to a%% ser.ices in "er.ices N Contro% "er.ices.
2.%.2 Using te IS6 to U!grade
#urn the down%oaded .iso +i%e to a C(R-M.
Insert the C(R-M into the s:stem and =oot +rom it. -nce the media has +inished =ootin' into the
insta%%ation menuD ress enter to se%ect the de+au%t otion o+ O1 Insta%%@!'rade to hard dri.e@+%ash
de.iceD etc.P As with a +resh insta%%D the insta%%er wi%% resent a screen showin' a%% a.ai%a=%e dri.esR
se%ect the de.ice $reeNA"1 is insta%%ed into and ress enter.
<he insta%%er wi%% reco'ni8e that an ear%ier .ersion o+ $reeNA"1 is insta%%ed on the de.ice and wi%%
resent the messa'e shown in $i'ure 2.,a.
N6*7: i+ :ou se%ect to er+orm a Fresh 8nstallD :ou wi%% ha.e to restore the =ac)u o+ :our
con+i'uration.
<o er+orm an u'radeD ress enter to accet the de+au%t o+ 9*grade 8nstall. A'ainD the insta%%er wi%%
remind :ou that the oeratin' s:stem shou%d =e insta%%ed on a thum= dri.e. >ress enter to start the
u'rade. -nce the insta%%er has +inished unac)in' the new ima'eD :ou wi%% see the menu shown in
$i'ure 2.,=. <he data=ase +i%e that is reser.ed and mi'rated contains :our $reeNA"1 con+i'uration
settin's.
>ress enter and $reeNA"1 wi%% indicate that the u'rade is com%ete and that :ou shou%d re=ootD as
seen in $i'ure 2.,c.
FreeNAS 9.2.1 Users Guide Page $" of 280
Figure 2.%a: U!grading a FreeNAS Installation
Figure 2.%(: FreeNAS 0ill Preser,e and 4igrate Settings

(urin' the re=oot there ma: =e a con.ersion o+ the re.ious con+i'uration data=ase to the new .ersion
o+ the data=ase. <his haens durin' the OA%:in' data=ase schema chan'esP %ine in the re=oot c:c%e.
<his con.ersion can ta)e a %on' time to +inish so =e atient and the =oot shou%d com%ete norma%%:. I+
+or some reason :ou end u with data=ase errors =ut the 'rahica% administrati.e inter+ace is accessi=%eD
FreeNAS 9.2.1 Users Guide Page $% of 280
'o to "ettin's N 2enera% and use the !%oad Con+i' =utton to u%oad the con+i'uration that :ou sa.ed
=e+ore :ou started the u'rade.
Figure 2.%c: U!grade is 'o3!lete
2.%.# Using te GUI to U!grade
<o er+orm an u'rade usin' this methodD down%oad the %atest .ersion o+ the .t(/ +i%e that matches the
architecture o+ the s:stem A32; or ,&;=itB. <henD 'o to ":stem N "ettin's N Ad.anced N $irmware
!date as shown in $i'ure 2.,d.
!se the dro;down menu to se%ect an e5istin' .o%ume to temorari%: %ace the +irmware +i%e durin' the
u'rade. A%ternate%:D se%ect OMemor: de.iceP to a%%ow the s:stem to create a temorar: RAM dis) to
=e used durin' the u'rade. A+ter ma)in' :our se%ectionD c%ic) the A%: !date =utton to see the
screen shown in $i'ure 2.,e.
<his screen a'ain reminds :ou to =ac)u :our con+i'uration =e+ore roceedin'. I+ :ou ha.e not :etD
c%ic) the Oc%ic) hereP %in).
#rowse to the %ocation o+ the down%oaded .t(/ +i%eD then aste its "HA2*, sum.
When +inishedD c%ic) the A%: !date =utton to =e'in the u'rade ro'ress. #ehind the scenesD the
+o%%owin' stes are occurrin'K
the "HA2*, hash is con+irmed and an error wi%% dis%a: i+ it does not matchR i+ :ou 'et this
errorD dou=%e;chec) that :ou asted the correct chec)sum and tr: astin' a'ain
the new ima'e is uncomressed and written to the !"# comact or +%ash dri.eR this can ta)e a
+ew minutes so =e atient
once the new ima'e is writtenD :ou wi%% momentari%: %ose :our connection as the $reeNA"1
s:stem wi%% automatica%%: re=oot into the new .ersion o+ the oeratin' s:stem
$reeNA"1 wi%% actua%%: re=oot twiceK once the new oeratin' s:stem %oadsD the u'rade
rocess a%ies the new data=ase schema and re=oots a'ain
assumin' a%% went we%%D the $reeNA"1 s:stem wi%% recei.e the same I> +rom the (HC> ser.erR
re+resh :our =rowser a+ter a moment to see i+ :ou can access the s:stem
FreeNAS 9.2.1 Users Guide Page $) of 280
Figure 2.%d: U!grading FreeNAS Fro3 te GUI
Figure 2.%e: Ste! 2 of 2
2.%.$ Unloc9ing an 7ncr+!ted ?olu3e
I+ :our dis)s are encr:ted and :ou ha.e created a asshrase and sa.ed the reco.er: )e:D the .o%ume
wi%% automatica%%: =e %oc)ed durin' an u'rade. <his is to re.ent an unauthori8ed user +rom usin' an
u'rade rocedure to 'ain access to the data on the encr:ted dis)s. A+ter the u'radeD the %oc)ed
.o%umes wi%% =e una.ai%a=%e unti% the: are un%oc)ed with the asshrase and reco.er: )e:.
<o un%oc) the .o%umeD 'o to "tora'e N 3o%umes N 3iew 3o%umes and hi'h%i'ht the %oc)ed .o%ume.
As seen in $i'ure 2.,+D c%ic)in' the O!n%oc)P icon wi%% romt +or the asshrase or reco.er: )e:. Fou
can a%so se%ect which ser.ices to start when the .o%ume is un%oc)ed.
Figure 2.%f: Unloc9ing an 7ncr+!ted ?olu3e
2.%." If So3eting Goes .rong
I+ the $reeNA"1 s:stem does not =ecome a.ai%a=%e a+ter the u'radeD :ou wi%% need h:sica% access to
the s:stem to +ind out what went wron'. $rom the conso%e menu :ou can determine i+ it recei.ed an I>
address and use otion O1B Con+i'ure Networ) Inter+acesP i+ it did not.
I+ this does not +i5 the ro=%emD 'o into otion O9B "he%%P and read the s:stem %o' with this commandK
more /var/log/messages
I+ the data=ase u'rade +ai%edD a +i%e ca%%ed 2data2!*grade-failed shou%d =e created with the detai%s.
I+ the ro=%em is not o=.ious or :ou are unsure how to +i5 itD see $reeNA"1 "uort Resources.
$reeNA"1 suorts two oeratin' s:stems on the oeratin' s:stem de.iceK the current oeratin'
s:stem andD i+ :ou ha.e er+ormed an u'radeD the re.ious%: insta%%ed .ersion o+ the oeratin' s:stem.
<his a%%ows :ou to re=oot into the re.ious .ersion shou%d :ou e5erience a ro=%em with the u'raded
.ersion.
<he u'rade rocess automatica%%: con+i'ures the s:stem to =oot +rom the new oeratin' s:stem. I+ the
s:stem remains inaccessi=%e and :ou wish to re.ert =ac) to the re.ious insta%%ationD t:e re(oot +rom
the she%% or se%ect O10B Re=ootP +rom the conso%e menu. Watch the =oot screens and ress the other =oot
otion At:ica%%: F2B +rom the $reeNA"1 conso%e when :ou see the +o%%owin' otions at the .er:
=e'innin' o+ the =oot rocess. In this e5am%eD Boot) F1 re+ers to the de+au%t otion Athe new%:
u'raded .ersionBD so ressin' F2 wi%% =oot into the re.ious .ersion.
F1 FreeBSD
F2 FreeBSD
Boot: F1
N6*7: i+ a re.ious%: wor)in' $reeNA"1 s:stem han's a+ter a $reeNA"1 u'radeD chec) to see i+
there is a #I-"@#MC +irmware u'rade a.ai%a=%e as that ma: +i5 the issue.
I+ the u'rade com%ete%: +ai%sD don't anic. <he data is sti%% on :our dis)s and :ou sti%% ha.e a co: o+
:our sa.ed con+i'uration. Fou can a%wa:sK
1. >er+orm a +resh insta%%ation.
2. Imort :our .o%umes in "tora'e N Auto Imort 3o%ume.
3. Restore the con+i'uration in ":stem N "ettin's N !%oad Con+i'.
2.%.% U!grading a ;FS Pool
0$" oo%s that are created usin' 0$" 3o%ume Mana'er on $reeNA"1 9.5 ha.e 0$" +eature +%a's
ena=%ed. $eature +%a's are sometimes re+erred to as 0$" .ersion *000. 0$" oo%s that were created in
$reeNA"1 6.3.5 use 0$".26. An: 0$" oo%s that were created in an: re.ious 6.5 .ersions o+
$reeNA"1 use 0$".1*. I+ :ou auto;imort a 0$" oo% +rom an: 6.5 .ersionD it wi%% remain at its
ori'ina% 0$" .ersion un%ess :ou u'rade the oo%. <his means that the oo% wi%% not understand an:
+eature +%a'sD such as 90& comressionD unti% the oo% is u'raded.
I+ :ou wish to u'rade an e5istin' 0$".1* or 0$".26 oo%D =e aware o+ the +o%%owin' ca.eats +irstK
the 0$" .ersion u'rade must =e er+ormed +rom the command %ineD it can not =e er+ormed
usin' the 2!I.
the oo% u'rade is a one;wa: street meanin' that i* )o! cha%#e )o!r (i%d )o! ca% %ot #o
bac0 to a% earlier FS 'er$io% or down'rade to an ear%ier .ersion o+ $reeNA"1 that does not
suort +eature +%a's.
FreeNAS 9.2.1 Users Guide Page "0 of 280
=e+ore er+ormin' an: oeration that ma: a++ect the data on a stora'e dis)D al-a)$ bac0!" )o!r
data *ir$t a%d 'eri*) the i%te#rit) o* the bac0!". Whi%e it is un%i)e%: that the oo% u'rade wi%%
a++ect the dataD it is a%wa:s =etter to =e sa+e than sorr:.
<o er+orm the 0$" .ersion u'radeD oen "he%%. <he +o%%owin' commands wi%% determine the oo%
state and .ersion. In this e5am%eD the oo% name is #ol!me1 and the 0$" .ersion is 26.
zpool status
pool: volume1
state: ONLINE
status: The pool is formatted using a legacy on-disk format. The pool can
still be used, but some features are unavailable.
action: Upgrade the pool using 'zpool upgrade'. Once this is done, the
pool will no longer be accessible on software that does not support feature
flags.
scan: none requested
config:
NAME STATE READ WRITE CKSUM
volume1 ONLINE 0 0 0
gptid/ea16925b-e96e-11e2-9ed5-e06995777a82 ONLINE 0 0 0
gptid/ea8f3a7b-e96e-11e2-9ed5-e06995777a82 ONLINE 0 0 0
gptid/eb064d06-e96e-11e2-9ed5-e06995777a82 ONLINE 0 0 0
gptid/eb7ba402-e96e-11e2-9ed5-e06995777a82 ONLINE 0 0 0
errors: No known data errors
zpool get version volume1
NAME PROPERTY VALUE SOURCE
volume1 version 28 local
Ne5tD .eri+: that the status o+ the oo% is hea%th:K
zpool status -x
all pools are healthy
N6*7: do not u'rade the oo% i+ its status does not show as hea%th:.
<o u'rade a oo% named #ol!me1K
zpool upgrade volume1
This system supports ZFS pool feature flags.
Successfully upgraded 'volume1' from version 28 to feature flags.
Enabled the following features on 'volume1':
async_destroy
empty_bpobj
lz4_compress
<he u'rade itse%+ shou%d on%: ta)e a seconds and is non;disruti.e. <his means that :ou do not need to
sto an: sharin' ser.ices in order to u'rade the oo%. Howe.erD :ou shou%d choose to u'rade when
the oo% is not =ein' hea.i%: used. <he u'rade rocess wi%% susend I@- +or a short eriodD =ut shou%d
=e near%: instantaneous on a Euiet oo%.
Section 2: Using the Graphical Interface
<his section o+ the 2uide descri=es a%% o+ the con+i'uration screens a.ai%a=%e within the $reeNA"1
'rahica% administrati.e inter+ace. It =e'ins with a ?uic) "tart 2uide that ro.ides an o.er.iew o+ the
$reeNA"1 con+i'uration wor)+%ow.
<he con+i'uration screens are %isted in the order that the: aear within the $reeNA"1 con+i'uration
tree +ound in the %e+t +rame o+ the 'rahica% administrati.e inter+ace.
N6*7: it is imortant to use the 2!I Aor the conso%eB +or a%% con+i'uration chan'es. $reeNA"1 uses a
con+i'uration data=ase to store its settin's. Whi%e :ou can use the command %ine to modi+: :our
con+i'urationD chan'es made at the command %ine are not written to the con+i'uration data=ase. <his
means that an: chan'es made at the command %ine wi%% not ersist a+ter a re=oot and wi%% =e
o.erwritten =: the .a%ues in the con+i'uration data=ase durin' an u'rade.
# Guic9 Start Guide and Account 'onfiguration
<his section contains a ?uic) "tart 2uide to 'et :ou started with :our $reeNA"1 con+i'uration. It is
+o%%owed =: the account section o+ the 2!I which a%%ows :ou to chan'e the administrati.e assword
and mana'e users and 'rous.
#.1 Guic9 Start Guide
<his section demonstrates the initia% rearation that shou%d =e er+ormed =e+ore :ou start to con+i'ure
the $reeNA"1 s:stem. It then ro.ides an o.er.iew o+ the con+i'uration wor)+%ow a%on' with ointers
to the section in the 9.2.1 !sers 2uide that contains the detai%s and con+i'uration e5am%es +or each
ste in the con+i'uration wor)+%ow.
#.1.1 Set te 2oot Pass0ord
<he +irst time :ou access the $reeNA"1 administrati.e inter+aceD a o;u window wi%% romt :ou to
set the root assword. Fou shou%d set a hard to 'uess assword as an:one who )nows this assword can
'ain access to the $reeNA"1 administrati.e 2!I.
N6*7: +or securit: reasonsD the ""H ser.ice and root ""H %o'ins are disa=%ed =: de+au%t. !n%ess these
are setD the on%: wa: to access a she%% as root is to 'ain h:sica% access to the conso%e menu or to access
the we= she%% within the administrati.e 2!I. <his means that the $reeNA"1 s:stem shou%d =e )et
h:sica%%: secure and that the administrati.e 2!I shou%d =e =ehind a roer%: con+i'ured +irewa%% and
rotected =: a secure assword.
#.1.2 Set te Ad3inistrati,e 73ail Address
$reeNA"1 ro.ides an A%ert icon in the uer ri'ht corner to ro.ide a .isua% indication o+ e.ents that
warrant administrati.e attention. <he a%ert s:stem automatica%%: emai%s the root user account whene.er
an a%ert is issued. $reeNA"1 a%so sends a dai%: emai% to the root user which shou%d =e read in order to
determine the o.era%% hea%th o+ the s:stem.
<o set the emai% address +or the root accountD 'o to Account N !sers N 3iew !sers. C%ic) the Chan'e
4;mai% =utton associated with the root user account and inut the emai% address o+ the erson to recei.e
the administrati.e emai%s.
#.1.# 7na(le 'onsole <ogging
<o .iew s:stem messa'es within the 'rahica% administrati.e inter+aceD 'o to ":stem N "ettin's N
Ad.anced. Chec) the =o5 O"how conso%e messa'es in the +ooterP and c%ic) "a.e. <he outut o+ tail
>f E,arElogE3essages wi%% now =e dis%a:ed at the =ottom o+ the screen. I+ :ou c%ic) the conso%e
messa'es areaD it wi%% o;u as a windowD a%%owin' :ou to scro%% throu'h the outut and to co: its
contents.
Fou are now read: to start con+i'urin' the $reeNA"1 s:stem. <:ica%%:D the con+i'uration wor)+%ow
wi%% use the +o%%owin' stes in their %isted order.
#.1.$ 'onfigure Storage
$reeNA"1 suorts the creation o+ =oth !$" and 0$" .o%umesR howe.erD 0$" .o%umes are
recommended to 'et the most out o+ :our $reeNA"1 s:stem.
When creatin' a .o%umeD :ou ha.e se.era% choices deendin' uon :our stora'e reEuirements and
whether or not data a%read: e5ists on the dis)AsB. <he +o%%owin' otions are a.ai%a=%eK
1. Auto;imort an e5istin' !$" dis)D 'strie ARAI(0BD 'mirror ARAI(1BD or 'raid3 ARAI(3B in
"tora'e N 3o%umes N Auto Imort 3o%ume.
2. Auto;imort an e5istin' 0$" dis)D strieD mirrorD RAI(01D RAI(02D or RAI(03 in "tora'e N
3o%umes N Auto Imort 3o%ume. Auto;imortin' is descri=ed in more detai% in Auto
Imortin' 3o%umes .
3. Imort a dis) that is +ormatted with !$"D N<$"D M"(-"D or 47<2 in "tora'e N 3o%umes N
Imort 3o%ume. <his is descri=ed in more detai% in Imortin' 3o%umes.
&. $ormat dis)AsB with !$" and otiona%%: create a 'strie ARAI(0BD 'mirror ARAI(1BD or 'raid3
ARAI(3B in "tora'e N 3o%umes N !$" 3o%ume Mana'er.
*. $ormat dis)AsB with 0$" and otiona%%: create a strieD mirrorD RAI(01D RAI(02D or RAI(03
in "tora'e N 3o%umes N 0$" 3o%ume Mana'er.
I+ :ou +ormat :our dis)AsB with 0$"D additiona% otions are a.ai%a=%eK
1. (i.ide the 0$" oo% into datasets to ro.ide more +%e5i=i%it: when con+i'urin' user access to
data. (ataset creation is descri=ed in Creatin' 0$" (atasets.
2. Create a 0.o% to =e used when con+i'urin' an i"C"I de.ice e5tent. 0.o% creation is descri=ed in
Creatin' a 8.o%.
#.1." 'reate UsersEGrou!s or Integrate 0it A8E<8AP
$reeNA"1 suorts a .ariet: o+ user access scenariosK
the use o+ an anon:mous or 'uest account that e.er:one in the networ) uses to access the stored
data
the creation o+ indi.idua% user accounts where each user has access to their own 0$" dataset
the addition o+ indi.idua% user accounts to 'rous where each 'rou has access to their own
FreeNAS 9.2.1 Users Guide Page "# of 280
.o%ume or 0$" dataset
the imort o+ e5istin' accounts +rom an -en9(A> or Acti.e (irector: ser.er
When con+i'urin' :our $reeNA"1 s:stemD $elect o%e o* the *ollo-i%#/ deendin' uon whether or not
the networ) has an e5istin' -en9(A> or Acti.e (irector: domain. -en9(A> and Acti.e (irector:
are mutua%%: e5c%usi.eD meanin' that :ou can not use =oth =ut must choose one or the other.
1. Manua%%: create users and 'rous. !ser mana'ement is descri=ed in !sers and 'rou
mana'ement is descri=ed in 2rous.
2. Imort e5istin' Acti.e (irector: account in+ormation usin' the instructions in Acti.e (irector:.
3. Imort e5istin' -en9(A> account in+ormation usin' the instructions in 9(A>.
#.1.% 'onfigure Per3issions
"ettin' ermissions is an imortant asect o+ con+i'urin' access to stora'e data. <he 'rahica%
administrati.e inter+ace is meant to set the i%itial ermissions in order to ma)e a .o%ume or dataset
accessi=%e as a share. -nce a share is a.ai%a=%eD the c%ient oeratin' s:stem shou%d =e used to +ine;tune
the ermissions o+ the +i%es and directories that are created =: the c%ient.
Con+i'ured .o%umes and datasets wi%% aear in "tora'e N 3o%umes. 4ach .o%ume and dataset wi%%
ha.e its own Chan'e >ermissions otionD a%%owin' +or 'reater +%e5i=i%it: when ro.idin' access to data.
#e+ore creatin' :our sharesD determine which users shou%d ha.e access to which data. <his wi%% he%
:ou to determine i+ mu%ti%e .o%umesD datasetsD and@or shares shou%d =e created to meet the ermissions
needs o+ :our en.ironment.
#.1.) 'onfigure Saring
-nce :our .o%umes ha.e =een con+i'ured with ermissionsD :ou are read: to con+i'ure the t:e o+
share or ser.ice that :ou determine is suita=%e +or :our networ).
$reeNA"1 suorts se.era% t:es o+ shares and sharin' ser.ices +or ro.idin' stora'e data to the
c%ients in a networ). It is recommended that :ou $elect o%l) o%e t)"e o* $hare "er 'ol!(e or data$et in
order to re.ent ossi=%e con+%icts =etween di++erent t:es o+ shares. <he t:e o+ share :ou create
deends uon the oeratin' s:stemAsB runnin' in :our networ)D :our securit: reEuirementsD and
e5ectations +or networ) trans+er seeds. <he +o%%owin' t:es o+ shares and ser.ices are a.ai%a=%eK
A!!le HAFPF: $reeNA"1 uses Netata%) to ro.ide sharin' ser.ices to A%e c%ients. <his t:e
o+ share is a 'ood choice i+ a%% o+ :our comuters run Mac -" 7. Con+i'uration e5am%es can
=e +ound in section /.1.
Uni- HNFSF: this t:e o+ share is accessi=%e =: Mac -" 7D 9inu5D #"(D and
ro+essiona%@enterrise .ersions o+ Windows. It is a 'ood choice i+ there are man: di++erent
oeratin' s:stems in :our networ). Con+i'uration e5am%es can =e +ound in section /.2.
.indo0s H'IFSF: $reeNA"1 uses "am=a to ro.ide the "M#@CI$" sharin' ser.ice. <his t:e
o+ share is accessi=%e =: WindowsD Mac -" 7D 9inu5D and #"( comutersD =ut it is s%ower than
an N$" share. I+ :our networ) contains on%: Windows s:stemsD this is a 'ood choice.
Con+i'uration e5am%es can =e +ound in section /.3.
FreeNAS 9.2.1 Users Guide Page "$ of 280
F*P: this ser.ice ro.ides +ast access +rom an: oeratin' s:stemD usin' a cross;%at+orm $<>
and +i%e mana'er c%ient a%ication such as $i%e8i%%a. $reeNA"1 suorts encr:tion and chroot
+or $<>. Con+i'uration e5am%es can =e +ound in section 6.,.
SS&: this ser.ice ro.ides encr:ted connections +rom an: oeratin' s:stem usin' ""H
command %ine uti%ities or the 'rahica% Win"C> a%ication +or Windows c%ients. Con+i'uration
e5am%es can =e +ound in section 6.12.
iS'SI: $reeNA"1 uses ist't to e5ort .irtua% dis) dri.es that are accessi=%e to c%ients runnin'
i"C"I initiator so+tware. Con+i'uration e5am%es can =e +ound in section 6./.
#.1.8 Start A!!lica(le Ser,iceHsF
-nce :ou ha.e con+i'ured :our share or ser.iceD :ou wi%% need to start its associated ser.iceAsB in order
to im%ement the con+i'uration. #: de+au%tD a%% ser.ices are o++ unti% :ou start them. <he status o+
ser.ices is mana'ed usin' "er.ices N Contro% "er.ices. <o start a ser.iceD c%ic) its red -$$ =utton.
A+ter a second or soD it wi%% chan'e to a =%ue -ND indicatin' that the ser.ice has =een ena=%ed. Watch
the conso%e messa'es as the ser.ice starts to determine i+ there are an: error messa'es.
#.1.9 *est 'onfiguration fro3 'lient
I+ the ser.ice success+u%%: startsD tr: to ma)e a connection to the ser.ice +rom a c%ient s:stem. $or
e5am%eD use Windows 45%orer to tr: to connect to a CI$" shareD use an $<> c%ient such as $i%e8i%%a to
tr: to connect to an $<> shareD or use $inder on a Mac -" 7 s:stem to tr: to connect to an A$> share.
I+ the ser.ice starts correct%: and :ou can ma)e a connection =ut recei.e ermissions errorsD chec) that
the user has ermissions to the .o%ume@dataset =ein' accessed.
#.1.10 5ac9u! te 'onfiguration
-nce :ou ha.e tested :our con+i'urationD =e sure to =ac) it u. 2o to ":stem N "ettin's and c%ic) the
"a.e Con+i' =utton. Four =rowser wi%% ro.ide an otion to sa.e a co: o+ the con+i'uration data=ase.
Fou shou%d bac0!" )o!r co%*i#!ratio% -he%e'er )o! (a0e co%*i#!ratio% cha%#e$ a%d al-a)$
be*ore !"#radi%# FreeNAS.
#.2 Account 'onfiguration
<his section descri=es how to manua%%: create and mana'e users and 'rous.
#.2.1 Grou!s
<he 2rous inter+ace a%%ows :ou to mana'e !NI7;st:%e 'rous on the $reeNA"1 s:stem.
N6*7: i+ Acti.e (irector: or -en9(A> is runnin' on :our networ)D :ou do not need to recreate the
networ)'s users or 'rous. InsteadD imort the e5istin' account in+ormation into $reeNA"1 usin'
"er.ices N (irector: "er.ices N Acti.e (irector: or "er.ices N (irector: "er.ices N 9(A>.
<his section descri=es how to create a 'rou and assi'n it user accounts. <he ne5t section wi%% descri=e
how to create user accounts.
FreeNAS 9.2.1 Users Guide Page "" of 280
I+ :ou c%ic) 2rous N 3iew 2rousD :ou wi%% see a screen simi%ar to $i'ure 3.2a.
Figure #.2a: FreeNAS Grou!s 4anage3ent
A%% 'rous that came with the oeratin' s:stem wi%% =e %isted. 4ach 'rou has an entr: indicatin' the
'rou I(D 'rou nameD whether or not it is a =ui%t;in 'rou which was insta%%ed with $reeNA"1D and
whether or not the 'rou's mem=ers are a%%owed to use sudo. I+ :ou c%ic) a 'rou entr:D a Mem=ers
=utton wi%% aear. C%ic) this =utton to .iew and modi+: that 'rou's mem=ershi.
+ :ou c%ic) the Add 2rou =uttonD :ou wi%% see the screen shown in $i'ure 3.2=. <a=%e 3.2a summari8es
the a.ai%a=%e otions when creatin' a 'rou.
FreeNAS 9.2.1 Users Guide Page "% of 280
Figure #.2(: 'reating a Ne0 Grou!
*a(le #.2a: 6!tions .en 'reating a Grou!
Setting ?alue 8escri!tion
2rou I( strin'
the ne5t a.ai%a=%e 'rou I( wi%% =e su''ested +or :ouR =: con.entionD !NI7
'rous containin' user accounts ha.e an I( 'reater than 1000 and 'rous
reEuired =: a ser.ice ha.e an I( eEua% to the de+au%t ort num=er used =: the
ser.ice Ae.'. the sshd 'rou has an I( o+ 22B
2rou
Name
strin' mandator:
>ermit "udo chec)=o5 i+ chec)edD mem=ers o+ the 'rou ha.e ermission to use sudo
A%%ow
reeated
2I(s
chec)=o5
a%%ows mu%ti%e 'rous to share the same 'rou idR this is use+u% when a 2I( is
a%read: associated with the !NI7 ermissions +or e5istin' data
-nce the 'rou and users are createdD :ou can assi'n users as mem=ers o+ a 'rou. C%ic) on 3iew
2rous then the Mem=ers =utton +or the 'rou :ou wish to assi'n users to. Hi'h%i'ht the user in the
Mem=er users %ist Awhich shows a%% user accounts on the s:stemB and c%ic) the VV to mo.e that user to
the ri'ht +rame. <he user accounts which aear in the ri'ht +rame wi%% =e added as mem=ers o+ that
'rou.
In the e5am%e shown in $i'ure 3.2cD the data1 'rou has =een created and the !ser1 user account has
=een created with a rimar: 'rou o+ !ser1. <he Mem=ers =utton +or the data1 'rou has =een se%ected
and !ser1 has =een added as a mem=er o+ that 'rou.
FreeNAS 9.2.1 Users Guide Page ") of 280
<o de%ete a 'rouD c%ic) its (e%ete 2rou =utton. <he o;u messa'e wi%% as) whether or not :ou
wou%d a%so %i)e to de%ete a%% mem=ers o+ that 'rou. Note that the =ui%t;in 'rous do not ro.ide a
(e%ete 2rou =utton.
Figure #.2c: Assigning a User as a 4e3(er of a Grou!
#.2.2 Users
$reeNA"1 suorts usersD 'rousD and ermissionsD a%%owin' 'reat +%e5i=i%it: in con+i'urin' which
users ha.e access to the data stored on $reeNA"1. In order to assi'n ermissions which wi%% =e used
=: sharesD :ou wi%% need to do o%e o* the *ollo-i%#K
1. Create a 'uest account that a%% users wi%% use.
2. Create a user account +or e.er: user in the networ) where the name o+ each account is the same
as a %o'on name used on a comuter. $or e5am%eD i+ a Windows s:stem has a %o'in name o+
$o$smithD :ou shou%d create a user account with the name $o$smith on $reeNA"1. I+ :our
intent is to assi'n 'rous o+ users di++erent ermissions to sharesD :ou wi%% need to a%so create
'rous and assi'n users to the 'rous.
3. I+ :our networ) uses Acti.e (irector: to mana'e user accounts and ermissionsD ena=%e the
Acti.e (irector: ser.ice.
&. I+ :our networ) uses an -en9(A> ser.er to mana'e user accounts and ermissionsD ena=%e the
9(A> ser.ice.
!ser accounts can =e 'i.en ermissions to .o%umes or datasets. I+ :ou wish to use 'rous to mana'e
ermissionsD :ou shou%d create the user accounts +irstD then assi'n the accounts as mem=ers o+ the
'rous. <his section demonstrates how to create a user account.
N6*7: i+ Acti.e (irector: or -en9(A> is runnin' on :our networ)D :ou do not need to recreate the
networ)'s users or 'rous. InsteadD imort the e5istin' account in+ormation into $reeNA"1 usin'
"er.ices N Acti.e (irector: or "er.ices N 9(A>.
Account N !sers N 3iew !sers ro.ides a %istin' o+ a%% o+ the s:stem accounts that were insta%%ed
with the $reeNA"1 oeratin' s:stemD as shown in $i'ure 3.2d.
Figure #.2d: 4anaging User Accounts
4ach account entr: indicates the user I(D usernameD rimar: 'rou I(D home director:D de+au%t she%%D
+u%% nameD whether or not it is a =ui%t;in user that came with the $reeNA"1 insta%%ationD the emai%
addressD whether or not %o'ins are disa=%edD whether or not the user account is %oc)edD and whether or
not the user is a%%owed to use sudo. <o reorder the %istD c%ic) the desired co%umn.
I+ :ou c%ic) a user accountD the +o%%owin' =uttons wi%% aear +or that accountK
'ange Pass0ord: ro.ides +ie%ds to enter and con+irm the new assword.
4odif+ User: used to modi+: the account's settin'sD as %isted in <a=%e 3.2=.
Au-iliar+ Grou!s: used to ma)e the account a mem=er o+ additiona% 'rous.
'ange 7>3ail: used to chan'e the emai% address associated with the account.
N6*7: it is imortant to set the emai% address +or the =ui%t;in root user account as imortant s:stem
messa'es are sent to the root user. $or securit: reasonsD assword %o'ins are disa=%ed +or the root
account and chan'in' this settin' is hi'h%: discoura'ed.
4.er: account that came with the $reeNA"1 oeratin' s:stemD e5cet +or the root userD is a s:stem
account. 4ach s:stem account is used =: a ser.ice and shou%d not =e a.ai%a=%e +or use as a %o'in
account. $or this reasonD the de+au%t she%% is no%o'inA6B. $or securit: reasonsD and to re.ent =rea)a'e
o+ s:stem ser.icesD :ou shou%d not modi+: the s:stem accounts.
<o create a user accountD c%ic) the Add New !ser =utton to oen the screen shown in $i'ure 3.2e.
"ome settin's are on%: a.ai%a=%e in Ad.anced Mode. <o see these settin'sD either c%ic) the Ad.anced
Mode =utton or con+i'ure the s:stem to a%wa:s dis%a: these settin's =: chec)in' the =o5 O"how
ad.anced +ie%ds =: de+au%tP in ":stem N "ettin's N Ad.anced. <a=%e 3.2= summari8es the otions
which are a.ai%a=%e when :ou create or modi+: a user account.
Figure #.2e: Adding or 7diting a User Account
*a(le #.2(: User Account 'onfiguration
!ser I( inte'er
're:ed out i+ user a%read: createdR when creatin' an accountD the
ne5t numeric I( wi%% =e su''estedR =: con.entionD user accounts
ha.e an I( 'reater than 1000 and s:stem accounts ha.e an I(
eEua% to the de+au%t ort num=er used =: the ser.ice
!sername strin'
're:ed out i+ user a%read: createdR ma5imum 32 characters to a%%ow
+or %on'er A( names thou'h a ma5imum o+ 6 is recommended +or
interoera=i%it:R can inc%ude numera%s =ut can not inc%ude a sace
Create a new
rimar: 'rou
chec)=o5
=: de+au%tD a rimar: 'rou with the same name as the user wi%% =e
createdR unchec) this =o5 to se%ect a di++erent rimar: 'rou name
AN6*7K in !ni5D a rimar: 'rou is not the same as a
secondar:@au5i%iar: 'rouB
>rimar: 2rou
dro;down
menu
must unchec) "reate a ne: *rimary gro!* in order to access this
menuR +or securit: reasonsD $ree#"( wi%% not 'i.e a user su
ermissions i+ :heel is their rimar: 'rou;;i+ :our intent is to
'i.e a user su accessD add them to the :heel 'rou in the Au5i%iar:
'rous section
Home (irector: =rowse =utton
%ea.e as 2none(istent +or s:stem accountsD otherwise =rowse to the
name o+ an exi$ti%# .o%ume or dataset that the user wi%% =e
assi'ned ermission to access
FreeNAS 9.2.1 Users Guide Page %0 of 280
Home (irector:
Mode
chec)=o5es
on%: a.ai%a=%e in Ad.anced Mode and wi%% =e read;on%: +or =ui%t;in
usersR sets de+au%t ermissions o+ user's home director:
"he%%
dro;down
menu
i+ creatin' a s:stem accountD choose nologinR i+ creatin' a user
accountD se%ect she%% o+ choice
$u%% Name strin' mandator:D ma: contain saces
4;mai% strin' emai% address associated with the account
>assword strin' mandator: un%ess chec) =o5 to disa=%e assword %o'ins
>assword
con+irmation
strin' must match 1ass:ord
(isa=%e assword
%o'in
chec)=o5
when chec)edD the user can not %o' into the $reeNA"1 s:stem or
authenticate to a CI$" shareR to undo this settin'D set a assword
+or the user usin' the MChan'e >asswordM =utton +or the user in
M3iew !sersMR chec)in' this =o5 wi%% 're: out ;o'k !ser which is
mutua%%: e5c%usi.e
9oc) user chec)=o5
a chec)ed =o5 re.ents user +rom %o''in' in unti% the account is
un%oc)ed A=o5 is unchec)edBR chec)in' this =o5 wi%% 're: out
isa$le *ass:ord login which is mutua%%: e5c%usi.e
>ermit "udo chec)=o5 i+ chec)edD mem=ers o+ the 'rou ha.e ermission to use sudo
""H >u=%ic Ke: strin'
aste the user's "!blic )e: to =e used +or ""H )e: authentication
Ado %ot "a$te the "ri'ate 0e)9B
Au5i%iar: 'rous
mouse
se%ection
hi'h%i'ht the 'rouAsB :ou wish to add the user to and use the VV
=utton to add the user to the hi'h%i'hted 'rous
$ S+ste3 'onfiguration
<he ":stem section o+ the administrati.e 2!I contains the +o%%owin' entriesK
'ron Io(s : ro.ides a 'rahica% +ront;end to cronta=A*B
InitESutdo0n Scri!ts : used to con+i'ure a command or scrit to automatica%%: e5ecute durin'
s:stem startu or shutdown
N*P Ser,ers : used to con+i'ure N<> ser.er settin's
2s+nc *as9s : a%%ows :ou to schedu%e rs:nc tas)s
S.4.A.2.*. *ests : a%%ows :ou to schedu%e which ".M.A.R.<. tests to run on a er;dis) =asis
Settings : used to con+i'ure s:stem wide settin's such as time8oneD emai% setuD H<<>" accessD
and +irmware u'rades
S+sctls : ro.ides a +ront;end +or tunin' the $reeNA"1 s:stem =: interactin' with the
under%:in' $ree#"( )erne%
S+ste3 Infor3ation : ro.ides 'enera% $reeNA"1 s:stem in+ormation such as hostnameD
oeratin' s:stem .ersionD %at+ormD and utime
*una(les : ro.ides a +ront;end to %oad additiona% )erne% modu%es at =oot time
4ach o+ these is descri=ed in more detai% in this section.
$.1 'ron Io(s
cronA6B is a daemon that runs a command or scrit on a re'u%ar schedu%e as a seci+ied user. <:ica%%:D
the user who wishes to schedu%e a tas) manua%%: creates a cronta=A*B usin' s:nta5 that can =e
er%e5in' to new !ni5 users. <he $reeNA"1 2!I ma)es it eas: to schedu%e when :ou wou%d %i)e the
tas) to occur.
N6*7: due to a %imitation in $ree#"(D users with account names that contain saces or e5ceed 1/
characters are una=%e to create cron Io=s.
$i'ure &.1a shows the screen that oens when :ou c%ic) ":stem N Cron Co=s N Add Cron Co=.
Figure $.1a: 'reating a 'ron Io(
<a=%e &.1a summari8es the con+i'ura=%e otions when creatin' a cron Io=.
*a(le $.1a: 'ron Io( 6!tions
!ser
dro;down
menu
ma)e sure the se%ected user has ermission to run the seci+ied
command or scrit
Command strin'
the *!ll "ath to the command or scrit to =e runR i+ it is a scritD test it
at the command %ine +irst to ma)e sure that it wor)s as e5ected
"hort
descrition
strin' otiona%
Minute
s%ider or
minute
se%ections
i+ use the s%iderD cron Io= occurs e.er: N minutesR i+ use minute
se%ectionsD cron Io= occurs at the hi'h%i'hted minutes
Hour
s%ider or hour
se%ections
i+ use the s%iderD cron Io= occurs e.er: N hoursR i+ use hour se%ectionsD
cron Io= occurs at the hi'h%i'hted hours
(a: o+ month
s%ider or
month
se%ections
i+ use the s%iderD cron Io= occurs e.er: N da:sR i+ use da: se%ectionsD
cron Io= occurs on the hi'h%i'hted da:s each month
Month chec)=o5es cron Io= occurs on the se%ected months
(a: o+ wee) chec)=o5es cron Io= occurs on the se%ected da:s
Redirect "tdout chec)=o5 disa=%es emai%in' standard outut to the root user account
Redirect "tderr chec)=o5 disa=%es emai%in' errors to the root user account
4na=%ed chec)=o5 unchec) i+ :ou wou%d %i)e to disa=%e the cron Io= without de%etin' it
$.2 InitESutdo0n Scri!ts
$reeNA"1 ro.ides the a=i%it: to schedu%e commands or scrits to run at s:stem startu or shutdown.
$i'ure &.2a shows the screen that oens when :ou c%ic) ":stem N Init@"hutdown "crits N Add
Init@"hutdown "crit. <a=%e &.2a summari8es the a.ai%a=%e otions.
When schedu%in' a commandD ma)e sure that the command is in :our ath or 'i.e the +u%% ath to the
command. -ne wa: to test the ath is to t:e 0ic co33and:na3e. I+ the command is not +oundD it
is not in :our ath.
When schedu%in' a scritD ma)e sure that the scrit is e5ecuta=%e and has =een +u%%: tested to ensure
that it achie.es the desired resu%ts.
FreeNAS 9.2.1 Users Guide Page %# of 280
Figure $.2a: Add an InitESutdo0n Scri!t
*a(le $.2a: 6!tions .en Adding an InitESutdo0n Scri!t
<:e dro;down menu
se%ect +rom "ommand A+or an e5ecuta=%eB or S'ri*t A+or an e5ecuta=%e
scritB
Command strin'
i+ "ommand is se%ectedD inut the command %us an: desired otionsR i+
S'ri*t is se%ectedD =rowse to the %ocation o+ the scrit
<:e dro;down menu
se%ect when the command@scrit wi%% runR choices are 1re 8nit A.er: ear%:
in =oot rocess =e+ore +i%es:stems are mountedBD 1ost 8nit Atowards end
o+ =oot rocess =e+ore $reeNA" ser.ices are startedBD or Sh!tdo:n
$.# N*P Ser,ers
<he networ) time rotoco% AN<>B is used to s:nchroni8e the time on the comuters in a networ).
Accurate time is necessar: +or the success+u% oeration o+ time sensiti.e a%ications such as Acti.e
(irector:.
#: de+au%tD $reeNA"1 is re;con+i'ured to use three u=%ic N<> ser.ers. I+ :our networ) is usin'
Acti.e (irector:D ensure that the $reeNA"1 s:stem and the Acti.e (irector: (omain Contro%%er ha.e
=een con+i'ured to use the same N<> ser.ers.
$i'ure &.3a shows the de+au%t N<> con+i'uration +or $reeNA"1. I+ :ou wish to chan'e a de+au%t ser.er
to match the settin's used =: :our networ)'s domain contro%%erD c%ic) an entr: to access its O4ditP
=utton. A%ternate%:D :ou can de%ete the de+au%t N<> ser.ers and c%ic) OAdd N<> "er.erP to create :our
own. $i'ure &.3= shows the OAdd N<> "er.erP screen and <a=%e &.3a summari8es the otions when
addin' or editin' an N<> ser.er. nt.con+A*B e5%ains these otions in more detai%.
FreeNAS 9.2.1 Users Guide Page %$ of 280
Figure $.#a: 8efault N*P 'onfiguration
Figure $.#(: Add or 7dit a N*P Ser,er
FreeNAS 9.2.1 Users Guide Page %" of 280
*a(le $.#a: N*P Ser,er 6!tions
Address strin' name o+ N<> ser.er
#urst chec)=o5
recommended when <a(. 1oll is 'reater than 10R on%: use on :our own ser.ers
i.e. do %ot use with a u=%ic N<> ser.er
I#urst chec)=o5 seeds the initia% s:nchroni8ation Aseconds instead o+ minutesB
>re+er chec)=o5
shou%d on%: =e used +or N<> ser.ers that are )nown to =e hi'h%: accurateD such
as those with time monitorin' hardware
Min. >o%% inte'er ower o+ 2 in secondsR can not =e %ower than 4 or hi'her than <a(. 1oll
Ma5. >o%% inte'er ower o+ 2 in secondsR can not =e hi'her than 17 or %ower than <in. 1oll
$orce chec)=o5 +orces the addition o+ the N<> ser.erD e.en i+ it is current%: unreacha=%e
$.$ 2s+nc *as9s
Rs:nc is a uti%it: that automatica%%: coies seci+ied data +rom one s:stem to another o.er a networ).
-nce the initia% data is coiedD rs:nc reduces the amount o+ data sent o.er the networ) =: sendin' on%:
the di++erences =etween the source and destination +i%es. Rs:nc can =e used +or =ac)usD mirrorin' data
on mu%ti%e s:stemsD or +or co:in' +i%es =etween s:stems.
<o con+i'ure rs:ncD :ou need to con+i'ure =oth ends o+ the connectionK
te rs+nc ser,er: this s:stem u%%s Arecei.esB the data. <his s:stem is re+erred to as 19;; in the
con+i'uration e5am%es.
te rs+nc client: this s:stem ushes AsendsB the data. <his s:stem is re+erred to as 19S= in the
con+i'uration e5am%es.
$reeNA"1 can =e con+i'ured as either an rs:nc c%ient or an rs:nc ser.er. <he oosite end o+ the
connection can =e another $reeNA"1 s:stem or an: other s:stem runnin' rs:nc. In $reeNA"1
termino%o':D an r:snc tas) de+ines which data is s:nchroni8ed =etween the two s:stems. I+ :ou are
s:nchroni8in' data =etween two $reeNA"1 s:stemsD create the rs:nc tas) on the rs:nc c%ient.
$reeNA"1 suorts two modes o+ rs:nc oerationK
rs+nc 3odule 3ode: e5orts a director: treeD and its con+i'ured settin'sD as a s:m=o%ic name
o.er an unencr:ted connection. <his mode reEuires that at %east one modu%e =e de+ined on the
rs:nc ser.er. It can =e de+ined in the $reeNA"1 2!I under "er.ices N Rs:nc N Rs:nc
Modu%es. In other oeratin' s:stemsD the modu%e is de+ined in rs:ncd.con+A*B.
rs+nc o,er SS&: s:nchroni8es o.er an encr:ted connection. ReEuires the con+i'uration o+
""H user and host u=%ic )e:s.
<his section summari8es the otions when creatin' an Rs:nc <as). It then ro.ides a con+i'uration
e5am%e =etween two $reeNA"1 s:stems +or each mode o+ rs:nc oeration.
FreeNAS 9.2.1 Users Guide Page %% of 280
$.$.1 'reating an 2s+nc *as9
$i'ure &.&a shows the screen that aears when :ou c%ic) ":stem N Rs:nc <as)s N Add Rs:nc <as).
<a=%e &.&a summari8es the otions that can =e con+i'ured when creatin' an rs:nc tas).
Figure $.$a: Adding an 2s+nc *as9
*a(le $.$a: 2s+nc 'onfiguration 6!tions
>ath =rowse =utton
=rowse to the .o%ume@dataset@director: that :ou wish to co:R note
that a ath %en'th 'reater than 2** characters wi%% +ai%
Remote Host strin' I> address or hostname o+ the remote s:stem that wi%% store the co:
Remote ""H
>ort
inte'er
on%: a.ai%a=%e in &syn' o#er SS= modeR a%%ows :ou to seci+: an
a%ternate ""H ort other than the de+au%t o+ 22
Rs:nc mode
dro;down
menu
choices are &syn' mod!le or &syn' o#er SS=
Remote Modu%e
Name @ Remote
>ath
strin'
when usin' &syn' mod!le modeD at %east one modu%e must =e de+ined
in rs:ncd.con+A*B o+ rs:nc ser.er or in "er.ices N Rs:nc N Rs:nc
Modu%es o+ another $reeNA"1 s:stemR when usin' &syn' o#er SS=
modeD inut the ath on the remote host to ush or u%% Ae.'.
2mnt2#ol!meB
(irection
dro;down
menu
choices are 1!sh or 1!llR de+au%t is to ush +rom the $reeNA"1
s:stem to a remote host
FreeNAS 9.2.1 Users Guide Page %) of 280
"hort
(escrition
strin' otiona%
Minute
s%ider or
minute
se%ections
i+ use the s%iderD s:nc occurs e.er: N minutesR i+ use minute
se%ectionsD s:nc occurs at the hi'h%i'hted minutes
Hour
s%ider or hour
se%ections
i+ use the s%iderD s:nc occurs e.er: N hoursR i+ use hour se%ectionsD
s:nc occurs at the hi'h%i'hted hours
(a: o+ month
s%ider or da:
se%ections
i+ use the s%iderD s:nc occurs e.er: N da:sR i+ use da: se%ectionsD s:nc
occurs on the hi'h%i'hted da:s
Month chec)=o5es tas) occurs on the se%ected months
(a: o+ wee) chec)=o5es tas) occurs on the se%ected da:s o+ the wee)
!ser
dro;down
menu
seci+ied user must ha.e ermission to write to the seci+ied director:
on the remote s:stemR due to a %imitation in $ree#"(D the user name
can not contain saces or e5ceed 1/ characters
Recursi.e chec)=o5
i+ chec)edD co: wi%% inc%ude a%% su=directories o+ the seci+ied
.o%ume
<imes chec)=o5 reser.e modi+ication times o+ +i%es
Comress chec)=o5
recommended on s%ow connections as reduces si8e o+ data to =e
transmitted
Archi.e chec)=o5
eEui.a%ent to >rl!tgo8 Arecursi.eD co: s:m%in)s as s:m%in)sD
reser.e ermissionsD reser.e modi+ication timesD reser.e 'rouD
reser.e owner Asuer;user on%:BD and reser.e de.ice +i%es Asuer;
user on%:B and secia% +i%esB
(e%ete chec)=o5
de%ete +i%es in destination director: that don't e5ist in sendin'
director:
?uiet chec)=o5 suresses in+ormationa% messa'es +rom the remote ser.er
>reser.e
ermissions
chec)=o5 reser.es ori'ina% +i%e ermissionsR use+u% i+ !ser is set to root
>reser.e
e5tended
attri=utes
chec)=o5 =oth s:stems must suort e5tended attri=utes
45tra otions strin' rs:ncA1B otions not co.ered =: the 2!I
4na=%ed chec)=o5 unchec) i+ :ou wou%d %i)e to disa=%e the rs:nc tas) without de%etin' it
I+ the r:snc ser.er reEuires assword authenticationD inut --*ass:ord-file>21A?=?@2F8;.NA<. in
the O45tra otionsP =o5D re%acin' 21A?=?@2F8;.NA<. with the aroriate ath to the +i%e
containin' the .a%ue o+ the assword.
$.$.2 'onfiguring 2s+nc 4odule 4ode 5et0een *0o FreeNAS S+ste3s
<his con+i'uration e5am%e wi%% con+i'ure rs:nc modu%e mode =etween the two +o%%owin' $reeNA"1
s:stemsK
142.156.2.2 has e5istin' data in 2mnt2lo'al2images. It wi%% =e the rs:nc c%ientD meanin' that an
rs:nc tas) needs to =e de+ined. It wi%% =e re+erred to as 19S=.
142.156.2.5 has an e5istin' .o%ume named 2mnt2remote. It wi%% =e the rs:nc ser.erD meanin' that
it wi%% recei.e the contents o+ 2mnt2lo'al2images. An rs:nc modu%e needs to =e de+ined on this
s:stem and the rs:ncd ser.ice needs to =e started. It wi%% =e re+erred to as 19;;.
-n 19S=D an rs:nc tas) is de+ined in ":stem N Rs:nc <as)s N Add Rs:nc <as) as shown in $i'ure
&.*=. In this e5am%eK
the >ath oints to 2!sr2lo'al2imagesD the director: to =e coied
the Remote Host oints to 142.156.2.5D the I> address o+ the rs:nc ser.er
the Rs:nc Mode is &syn' mod!le
the Remote Modu%e Name is $a'k!*sR this wi%% need to =e de+ined on the rs:nc ser.er
the (irection is 1!sh
the rs:nc is schedu%ed to occur e.er: 1* minutes
the !ser is set to root so it has ermission to write an:where
the >reser.e >ermissions chec)=o5 is chec)ed so that the ori'ina% ermissions are not
o.erwritten =: the root user
-n 19;;D an rs:nc modu%e is de+ined in "er.ices N Rs:nc Modu%es N Add Rs:nc Modu%eD shown in
$i'ure &.&c. In this e5am%eK
the Modu%e Name is $a'k!*sR this needs to match the settin' on the rs:nc c%ient
the >ath is 2mnt2remoteR a director: ca%%ed images wi%% =e created to ho%d the contents o+
2!sr2lo'al2images
the !ser is set to root so it has ermission to write an:where
Hosts a%%ow is set to 142.156.2.2D the I> address o+ the rs:nc c%ient
(escritions o+ the con+i'ura=%e otions can =e +ound in Rs:nc Modu%es.
<o +inish the con+i'urationD start the rs:nc ser.ice on 19;; in "er.ices N Contro% "er.ices. I+ the
rs:nc is success+u%D the contents o+ 2mnt2lo'al2images2 wi%% =e mirrored to 2mnt2remote2images2.
Figure $.$(: 'onfiguring te 2s+nc 'lient
Figure $.$c: 'onfiguring te 2s+nc Ser,er
FreeNAS 9.2.1 Users Guide Page )0 of 280
$.$.# 'onfiguring 2s+nc o,er SS& 4ode 5et0een *0o FreeNAS S+ste3s
""H re%ication mode does not reEuire the creation o+ an rs:nc modu%e or +or the rs:nc ser.ice to =e
runnin' on the rs:nc ser.er. It does reEuire ""H to =e con+i'ured =e+ore creatin' the rs:nc tas)K
a u=%ic@ri.ate )e: air +or the rs:nc user account At:ica%%: rootB must =e 'enerated on 19S=
and the u=%ic )e: coied to the same user account on 19;;
to miti'ate the ris) o+ man;in;the;midd%e attac)sD the u=%ic host )e: o+ 19;; must =e coied to
19S=
the ""H ser.ice must =e runnin' on 19;;
<o create the u=%ic@ri.ate )e: air +or the rs:nc user accountD oen "he%% on 19S=. <he @ +i%es:stem
must +irst =e mounted as read;write. <he +o%%owin' e5am%e 'enerates an R"A t:e u=%ic@ri.ate )e:
air +or the root user. When creatin' the )e: airD do not enter the asshrase as the )e: is meant to =e
used +or an automated tas).
mount -o rw /
ssh-keygen -t rsa
Generating public/private rsa key pair.
Enter file in which to save the key (/root/.ssh/id_rsa):
Created directory '/root/.ssh'.
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /root/.ssh/id_rsa.
Your public key has been saved in /root/.ssh/id_rsa.pub.
The key fingerprint is:
f5:b0:06:d1:33:e4:95:cf:04:aa:bb:6e:a4:b7:2b:df root@freenas.local
The key's randomart image is:
+--[ RSA 2048]----+
| .o. oo |
| o+o. . |
| . =o + |
| + + o |
| S o . |
| .o |
| o. |
| o oo |
| **oE |
$reeNA"1 suorts the +o%%owin' t:es o+ ""H )e:sK ("AD and R"A. When creatin' the )e:D seci+:
the t:e :ou wish to use orD i+ :ou are 'eneratin' the )e: on another oeratin' s:stemD se%ect a t:e o+
)e: the )e: 'eneration so+tware suorts.
N6*7: i+ a di++erent user account is used +or the rs:nc tas)D use the su ; command a+ter mountin' the
+i%es:stem =ut =e+ore 'eneratin' the )e:. $or e5am%eD i+ the rs:nc tas) is con+i'ured to use the !ser1
user accountD use this command to =ecome that userK
su - user1
Ne5tD .iew and co: the contents o+ the 'enerated u=%ic )e:K
more .ssh/id_rsa.pub
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC1lBEXRgw1W8y8k+lXPlVR3xsmVSjtsoyIzV/PlQPo
SrWotUQzqILq0SmUpViAAv4Ik3T8NtxXyohKmFNbBczU6tEsVGHo/2BLjvKiSHRPHc/1DX9hofcFti4h
dcD7Y5mvU3MAEeDClt02/xoi5xS/RLxgP0R5dNrakw958Yn001sJS9VMf528fknUmasti00qmDDcp/kO
xT+S6DFNDBy6IYQN4heqmhTPRXqPhXqcD1G+rWr/nZK4H8Ckzy+l9RaEXMRuTyQgqJB/rsRcmJX5fApd
DmNfwrRSxLjDvUzfywnjFHlKk/+TQIT1gg1QQaj21PJD9pnDVF0AiJrWyWnR root@freenas.local
2o to 19;; and aste Aor aendB the coied )e: into the ""H >u=%ic Ke: +ie%d o+ Account N !sers
N 3iew !sers N root Aor the seci+ied rs:nc user accountB N Modi+: !ser. <he aste +or the a=o.e
e5am%e is shown in $i'ure &.&d. When astin' the )e:D ensure that it is asted as one %on' %ine andD i+
necessar:D remo.e an: e5tra saces reresentin' %ine =rea)s.
Figure $.$d: Pasting te User/s SS& Pu(lic 1e+
Whi%e on 19;;D .eri+: that the ""H ser.ice is runnin' in "er.ices N Contro% "er.ices and start it i+ it
is not.
Ne5tD co: the host )e: o+ 19;; usin' "he%% on 19S=. <he +o%%owin' command coies the R"A host
)e: o+ the 19;; ser.er used in our re.ious e5am%e. #e sure to inc%ude the dou=%e =rac)et AA to
re.ent o.erwritin' an: e5istin' entries in the kno:n,hosts +i%e.
ssh-keyscan -t rsa 192.168.2.6 >> /root/.ssh/known_hosts
N6*7: I+ 19S= is a 9inu5 s:stemD use the +o%%owin' command to co: the R"A )e: to the 9inu5
s:stemK
cat ~/.ssh/id_rsa.pub | ssh user@192.168.2.6 'cat >> .ssh/authorized_keys'
Fou are now read: to create the rs:nc tas) on 19;;. <o con+i'ure rs:nc ""H mode usin' the s:stems
in our re.ious e5am%eD the con+i'uration wou%d =e as +o%%owsK
the >ath oints to 2mnt2lo'al2imagesD the director: to =e coied
the Remote Host oints to 142.156.2.5D the I> address o+ the rs:nc ser.er
the Rs:nc Mode is &syn' o#er SS=
the rs:nc is schedu%ed to occur e.er: 1* minutes
the !ser is set to root so it has ermission to write an:whereR the u=%ic )e: +or this user must
=e 'enerated on 19S= and coied to 19;;
the 1reser#e 1ermissions chec)=o5 is chec)ed so that the ori'ina% ermissions are not
o.erwritten =: the root user
-nce :ou sa.e the rs:nc tas)D the rs:nc wi%% automatica%%: occur accordin' to :our schedu%e. In this
e5am%eD the contents o+ 2mnt2lo'al2images2 wi%% automatica%%: aear in 2mnt2remote2images2 a+ter 1*
minutes. I+ the content does not aearD use "he%% on 19;; to read 2#ar2log2messages. I+ the messa'e
indicates a 0n Anew%ine characterB in the )e:D remo.e the sace in :our asted )e:;;it wi%% =e a+ter the
character that aears Iust =e+ore the 0n in the error messa'e.
$." S.4.A.2.*. *ests
".M.A.R.<. A"e%+;Monitorin'D Ana%:sis and Reortin' <echno%o':B is a monitorin' s:stem +or
comuter hard dis) dri.es to detect and reort on .arious indicators o+ re%ia=i%it:. When a +ai%ure is
anticiated =: ".M.A.R.<.D the dri.e shou%d =e re%aced. Most modern A<AD I(4 and "C"I;3 hard
dri.es suort ".M.A.R.<.;;re+er to :our dri.e's documentation i+ :ou are unsure.
$i'ure &.*a shows the con+i'uration screen that aears when :ou c%ic) ":stem N ".M.A.R.<. <ests N
Add ".M.A.R.<. <est. <he tests that :ou create wi%% =e %isted under 3iew ".M.A.R.<. <ests. A+ter
creatin' :our testsD chec) the con+i'uration in "er.ices N ".M.A.R.<.D then c%ic) the s%ider to -N +or
the ".M.A.R.<. ser.ice in "er.ices N Contro% "er.ices. <he ".M.A.R.<. ser.ice wi%% not start i+ :ou
ha.e not created an: .o%umes.
N6*7: to re.ent ro=%emsD do not ena=%e the ".M.A.R.<. ser.ice i+ :our dis)s are contro%%ed =: a
RAI( contro%%er as it is the Io= o+ the contro%%er to monitor ".M.A.R.<. and mar) dri.es as >redicti.e
$ai%ure when the: tri.
FreeNAS 9.2.1 Users Guide Page )# of 280
Figure $."a: Adding a S.4.A.2.*. *est
<a=%e &.*a summari8es the con+i'ura=%e otions when creatin' a ".M.A.R.<. test.
*a(le $."a: S.4.A.2.*. *est 6!tions
(is) %ist hi'h%i'ht dis)AsB to monitor
<:e dro;down menu
se%ect t:e o+ test to runR see smartct%A6B +or a descrition o+ each
t:e o+ test Anote that some test t:es wi%% de'rade er+ormance or
ta)e dis)AsB o++%ineB
"hort
descrition
strin' otiona%
Hour
s%ider or hour
se%ections
i+ use the s%iderD test occurs e.er: N hoursR i+ use hour se%ectionsD
test occurs at the hi'h%i'hted hours
(a: o+ month
s%ider or da:
se%ections
i+ use the s%iderD test occurs e.er: N da:sR i+ use da: se%ectionsD test
occurs on the hi'h%i'hted da:s
Month chec)=o5es se%ect the months when :ou wish the test to occur
(a: o+ wee) chec)=o5es se%ect the da:s o+ the wee) when :ou wish the test to occur
Fou can .eri+: which tests wi%% run and when =: t:in' s3artd >B so0tests within "he%%.
FreeNAS 9.2.1 Users Guide Page )$ of 280
$.% Settings
<he "ettin's ta=D shown in $i'ure &.,aD contains & ta=sK 2enera%D Ad.ancedD 4mai%D and ""9.
Figure $.%a: General *a( of Settings
$.%.1 General *a(
<a=%e &.,a summari8es the settin's that can =e con+i'ured usin' the 2enera% ta=K
*a(le $.%a: General *a(/s 'onfiguration Settings
>rotoco%
dro;down
menu
rotoco% to use when connectin' to the administrati.e 2!I +rom a =rowserR i+
:ou chan'e the de+au%t o+ =??1 to =??1SD an unsi'ned certi+icate and R"A
)e: wi%% =e 'enerated and :ou wi%% =e %o''ed out in order to accet the
certi+icate
We=2!I
I>.&
Address
dro;down
menu
choose +rom a %ist o+ recent I> addresses to %imit the one to use when
accessin' the administrati.e 2!IR the =ui%t;in H<<> ser.er wi%% automatica%%:
=ind to the wi%dcard address o+ 0.0.0.0 Aan: addressB and wi%% issue an a%ert i+
FreeNAS 9.2.1 Users Guide Page )" of 280
the seci+ied address =ecomes una.ai%a=%e
We=2!I
I>.,
Address
dro;down
menu
choose +rom a %ist o+ recent I>., addresses to %imit the one to use when
accessin' the administrati.e 2!IR the =ui%t;in H<<> ser.er wi%% automatica%%:
=ind to the wi%dcard address o+ )) Aan: addressB and wi%% issue an a%ert i+ the
seci+ied address =ecomes una.ai%a=%e
We=2!I
H<<> >ort
inte'er
a%%ows :ou to con+i'ure a non;standard ort +or accessin' the administrati.e
2!I o.er H<<>R chan'in' this settin' ma: reEuire :ou to chan'e a +ire+o5
con+i'uration settin'
We=2!I
H<<>"
>ort
inte'er
a%%ows :ou to con+i'ure a non;standard ort +or accessin' the administrati.e
2!I o.er H<<>"
9an'ua'e
dro;down
menu
se%ect the %oca%i8ation +rom the dro;down menu and re%oad the =rowserR :ou
can .iew the status o+ %oca%i8ation at oot%e.+reenas.or'
Conso%e
Ke:=oard
Ma
dro;down
menu
se%ect the )e:=oard %a:out
<ime8one
dro;down
menu
se%ect the time8one +rom the dro;down menu
":s%o'
ser.er
strin'
I> address or hostname o+ remote s:s%o' ser.er to send $reeNA"1 %o's toR
once setD %o' entries wi%% =e written to =oth the $reeNA"1 conso%e and the
remote ser.er
(irector:
"er.ice
dro;down
menu
can se%ect one o+ A'ti#e ire'tory3 omain "ontroller3 ;A13 N8SD or N?4R i+
a ser.ice is se%ectedD an entr: named ire'tory Ser#i'es wi%% =e added to
"er.ices N Contro% "er.ices +or mana'in' that se%ected ser.ice
N6*7: =: de+au%tD %o's are stored in RAM as there is no sace on the em=edded de.ice to store %o's.
<his means that %o's are de%eted whene.er the s:stem re=oots. I+ :ou wish to sa.e the s:stem %o'sD
eitherK
con+i'ure a remote s:s%o' ser.er on another !ni5;%i)e oeratin' s:stemD or
create a 0$" dataset ca%%ed syslog and re=oot the s:stemR $reeNA"1 wi%% automatica%%: create a
log2 director: in this dataset which contains the %o's
I+ :ou ma)e an: chan'esD c%ic) the "a.e =utton.
<his ta= a%so contains the +o%%owin' =uttonsK
Factor+ 2estore: resets the con+i'uration data=ase to the de+au%t =ase .ersion. Howe.erD it does not
de%ete user ""H )e:s or an: other data stored in a user's home director:. "ince an: con+i'uration
chan'es stored in the con+i'uration data=ase wi%% =e erasedD this otion is hand: i+ :ou mess u :our
s:stem or wish to return a test s:stem to the ori'ina% con+i'uration.
Sa,e 'onfig: used to create a =ac)u co: o+ the current con+i'uration data=ase in the +ormat
hostname-#ersion-ar'hite't!re. Al-a)$ $a'e the co%*i#!ratio% a*ter (a0i%# cha%#e$ a%d 'eri*) that
)o! ha'e a $a'ed co%*i#!ratio% be*ore "er*or(i%# a% !"#rade. <his +orum ost contains a scrit to
FreeNAS 9.2.1 Users Guide Page )% of 280
=ac)u the con+i'uration which cou%d =e customi8ed and added as a cron Io=. <his +orum ost contains
an a%ternate scrit which on%: sa.es a co: o+ the con+i'uration when it chan'es. And this +orum ost
contains a scrit +or =ac)in' u the con+i'uration +rom another s:stem.
U!load 'onfig: a%%ows :ou to =rowse to %ocation o+ sa.ed con+i'uration +i%e in order to restore that
con+i'uration.
$.%.2 Ad,anced *a(
<he Ad.anced ta=D shown in $i'ure &.,=D a%%ows :ou to set some misce%%aneous settin's on the
$reeNA"1 s:stem. <he con+i'ura=%e settin's are summari8ed in <a=%e &.,=.
Figure $.%(: Ad,anced *a(
*a(le $.%(: Ad,anced *a(/s 'onfiguration Settings
4na=%e Conso%e Menu chec)=o5
unchec)in' this =o5 remo.es the conso%e menu
shown in $i'ure 2.*a
!se "eria% Conso%e chec)=o5 do %ot chec) this =o5 i+ :our seria% ort is disa=%ed
"eria% >ort Address strin' seria% ort address written in he5
"eria% >ort "eed dro;down menu se%ect the seed used =: the seria% ort
4na=%e screen sa.er chec)=o5 ena=%es@disa=%es the conso%e screen sa.er
4na=%e owerd A>ower
"a.in' (aemonB
chec)=o5
owerdA6B monitors the s:stem state and sets the C>!
+reEuenc: accordin'%:
"wa si8e
non;8ero inte'er
reresentin' 2#
=: de+au%tD a%% data dis)s are created with this amount
o+ swaR this settin' does not a++ect %o' or cache
de.ices as the: are created without swa
"how conso%e messa'es in
the +ooter
chec)=o5 wi%% dis%a: conso%e messa'es in rea% time at =ottom
o+ =rowserR c%ic) the conso%e to =rin' u a scro%%a=%e
FreeNAS 9.2.1 Users Guide Page )) of 280
screenR chec) the O"to re+reshP =o5 in the scro%%a=%e
screen to ause udatin' and unchec) the =o5 to
continue to watch the messa'es as the: occur
"how trace=ac)s in case o+
+ata% errors
chec)=o5
ro.ides a o;u o+ dia'nostic in+ormation when a
+ata% error occurs
"how ad.anced +ie%ds =:
de+au%t
chec)=o5
se.era% 2!I menus ro.ide an Ad.anced Mode
=utton to access additiona% +eaturesR ena=%in' this
shows these +eatures =: de+au%t
4na=%e autotune chec)=o5
ena=%es the autotune scrit which attemts to otimi8e
the s:stem deendin' uon the hardware which is
insta%%ed
4na=%e de=u' )erne% chec)=o5
i+ chec)edD ne5t =oot wi%% =oot into a de=u' .ersion o+
the )erne%
4na=%e automatic u%oad o+
)erne% crash dums
chec)=o5
i+ chec)edD )erne% crash dums are automatica%%: sent
to the $reeNA"1 de.e%oment team +or dia'nosis
M-<( =anner strin'
inut the messa'e to =e seen when a user %o's in .ia
""H
I+ :ou ma)e an: chan'esD c%ic) the "a.e =utton.
<his ta= a%so contains the +o%%owin' =uttonsK
2e(uild <8APEA8 'ace: c%ic) i+ :ou add a user to Acti.e (irector: who needs immediate access to
$reeNA"1R otherwise this occurs automatica%%: once a da: as a cron Io=.
Sa,e 8e(ug: used to 'enerate a te5t +i%e o+ dia'nostic in+ormation. t wi%% romt +or the %ocation to
sa.e the A"CII te5t +i%e.
Fir30are U!date: used to !'rade $reeNA"1.
!.(.2.1 Autotune
$reeNA"1 ro.ides an autotune scrit which attemts to otimi8e the s:stem deendin' uon the
hardware which is insta%%ed. $or e5am%eD i+ a 0$" .o%ume e5ists on a s:stem with %imited RAMD the
autotune scrit wi%% automatica%%: adIust some 0$" s:sct% .a%ues in an attemt to minimi8e 0$"
memor: star.ation issues. It shou%d on%: =e used as a temorar: measure on a s:stem that han's unti%
the under%:in' hardware issue is addressed =: addin' more RAM. Autotune wi%% a%wa:s s%ow the
s:stem down as it cas the ARC.
<he O4na=%e autotuneP chec)=o5 in ":stem N "ettin's N Ad.anced is unchec)ed =: de+au%tR chec) it
i+ :ou wou%d %i)e the autotuner to run at =oot time. I+ :ou wou%d %i)e the scrit to run immediate%:D
re=oot the s:stem.
I+ autotuner +inds an: settin's that need adIustin'D the chan'ed .a%ues wi%% aear in ":stem N ":sct%s
A+or sys'tl.'onf .a%uesB and in ":stem N <una=%es A+or loader.'onf .a%uesB. I+ :ou do not %i)e the
chan'esD :ou can modi+: the .a%ues that are dis%a:ed in the 2!I and :our chan'es wi%% o.erride the
.a%ues that were created =: the autotune scrit. Howe.erD i+ :ou de%ete a s:sct% or tuna=%e that was
created =: autotuneD it wi%% =e recreated at ne5t =oot. <his is =ecause autotune on%: creates .a%ues that
do not a%read: e5ist.
I+ :ou are tr:in' to increase the er+ormance o+ :our $reeNA"1 s:stem and susect that the current
hardware ma: =e %imitin' er+ormanceD tr: ena=%in' autotune.
I+ :ou wish to read the scrit to see which chec)s are er+ormedD the scrit is %ocated in
2!sr2lo'al2$in2a!tot!ne.
$.%.# 73ail *a(
<he 4mai% ta=D shown in $i'ure &.,cD is used to con+i'ure the emai% settin's on the $reeNA"1 s:stem.
<a=%e &.,c summari8es the settin's that can =e con+i'ured usin' the 4mai% ta=.
N6*7: it is imortant to con+i'ure the s:stem so that it can success+u%%: send emai%s. An automatic
scrit send a ni'ht%: emai% to the root user account containin' imortant in+ormation such as the hea%th
o+ the dis)s. A%ert e.ents are a%so emai%ed to the root user account.
Figure $.%c: 73ail *a(
*a(le $.%c: 73ail *a(/s 'onfiguration Settings
$rom emai% strin'
the Fro( emai% address to =e used when sendin' emai%
noti+ications
-ut'oin' mai%
ser.er
strin' or I> address hostname or I> address o+ "M<> ser.er
>ort to connect
to
inte'er
"M<> ort num=erD t:ica%%: 2*D &,* Asecure "M<>BD or *6/
Asu=missionB
<9"@""9 dro;down menu encr:tion t:eR choices are 1lainD SS;D or ?;S
!se "M<>
Authentication
chec)=o5 ena=%es@disa=%es "M<> A!<H usin' >9AIN "A"9
!sername strin' used to authenticate with "M<> ser.er
>assword strin' used to authenticate with "M<> ser.er
"end <est Mai% =utton
c%ic) to chec) that con+i'ured emai% settin's are wor)in'R this
wi%% +ai% i+ :ou do not set the To emai% address =: c%ic)in' the
Chan'e 4;mai% =utton +or the root account in Accounts N !sers
N 3iew !sers
$.%.$ SS< *a(
When :ou chan'e the >rotoco% .a%ue to H<<>" in ":stem N "ettin's N 2enera%D an unsi'ned R"A
certi+icate and )e: are auto;'enerated. -nce 'eneratedD the certi+icate and )e: wi%% =e dis%a:ed in the
""9 Certi+icate +ie%d in ":stem N "ettin's N ""9D shown in $i'ure &.,d. I+ :ou a%read: ha.e :our
own si'ned certi+icate that :ou wish to use +or ""9@<9" connectionsD re%ace the .a%ues in the ""9
certi+icate +ie%d with a co:@aste o+ :our own )e: and certi+icate. <he certi+icate can =e used to secure
the H<<> connection Aena=%ed in the "ettin's N 2enera% <a=B to the $reeNA"1 s:stem.
<a=%e &.,d summari8es the settin's that can =e con+i'ured usin' the ""9 ta=. <his howto shows how to
manua%%: 'enerate :our own certi+icate usin' -en""9 and ro.ides some e5am%es +or the .a%ues
shown in <a=%e &.,d.
Figure $.%d: SS< *a(
*a(le $.%d: SS< *a(/s 'onfiguration Settings
-r'ani8ation strin' otiona%
-r'ani8ationa% !nit strin' otiona%
4mai% Address strin' otiona%
9oca%it: strin' otiona%
"tate strin' otiona%
Countr: strin' otiona%
Common Name strin' otiona%
>asshrase strin'
i+ the certi+icate was created with a asshraseD inut and con+irm itR
the .a%ue wi%% aear as dots in the 2!I
""9 Certi+icate strin' aste the ri.ate )e: and certi+icate into the =o5
N6*7: $reeNA"1 wi%% chec) the .a%idit: o+ the certi+icate and )e: and wi%% +a%%=ac) to H<<> i+ the:
aear to =e in.a%id.
$.) S+sctls
s:sct%A6B is an inter+ace that is used to ma)e chan'es to the $ree#"( )erne% runnin' on a $reeNA"1
s:stem. It can =e used to tune the s:stem in order to meet the seci+ic needs o+ a networ). -.er +i.e
hundred s:stem .aria=%es can =e set usin' s:sct%A6B. 4ach .aria=%e is )nown as a MI# as it is comrised
o+ a dotted set o+ comonents. "ince these MI#s are seci+ic to the )erne% +eature that is =ein' tunedD
descritions can =e +ound in man: $ree#"( man a'es Ae.'. s:sct%A3BD tcA&B and tunin'A/BB and in
man: sections o+ the $ree#"( Hand=oo).
8ANG72C chan'in' the .a%ue o+ a s:sct% MI# is an ad.anced +eature that immediate%: a++ects the
)erne% o+ the $reeNA"1 s:stem. Do %ot cha%#e a M1, o% a "rod!ctio% $)$te( !%le$$ )o!
!%der$ta%d the ra(i*icatio%$ o* that cha%#e. A =ad%: con+i'ured MI# cou%d cause the s:stem to
=ecome un=oota=%eD unreacha=%e .ia the networ)D or can cause the s:stem to anic under %oad. Certain
chan'es ma: =rea) assumtions made =: the $reeNA"1 so+tware. <his means that :ou shou%d a%wa:s
test the imact o+ an: chan'es on a test s:stem +irst.
$reeNA"1 ro.ides a 'rahica% inter+ace +or mana'in' s:sct% MI#s. <o add a s:sct%D 'o to ":stem N
":sct%s N Add ":sct%D shown in $i'ure &./a.
Figure $.)a: Adding a S+sctl
<a=%e &./a summari8es the otions when addin' a s:sct%.
*a(le $.)a: Adding a S+sctl
3aria=%e strin' must =e in dotted +ormat e.'. kern.i*'.shmma(
3a%ue
inte'er or
strin'
.a%ue to associate with the MI#R do %ot (a0e thi$ !"D re+er to the su''ested
.a%ues in a man a'eD $ree#"( Hand=oo) a'eD or tutoria%
Comment strin' otiona%D =ut a use+u% reminder +or the reason =ehind usin' this MI#@.a%ue
4na=%ed chec)=o5 unchec) i+ :ou wou%d %i)e to disa=%e the s:sct% without de%etin' it
As soon as :ou add or edit a s:sct%D the runnin' )erne% wi%% chan'e that .aria=%e to the .a%ue :ou
seci+:. As %on' as the s:sct% e5istsD that .a%ue wi%% ersist across re=oots and u'rades.
Note that an: s:sct% that is read;on%: wi%% reEuire a re=oot to ena=%e the settin' chan'e. Fou can .eri+:
i+ a s:sct% is read;on%: =: attemtin' to chan'e it +rom "he%%. $or e5am%eD to chan'e the .a%ue o+
net.inet.t'*.delay,a'k to 1D use the command s+sctl net.inet.tc!.dela+:ac9D1. I+ the s:sct% .a%ue is
read;on%:D an error messa'e wi%% indicate that the settin' is read;on%:. I+ :ou do not 'et an errorD the
settin' is now a%ied. Howe.erD +or the settin' to =e ersistent across re=ootsD the s:sct% must =e added
in ":stem N ":sct%s.
An: MI#s that :ou add wi%% =e %isted in ":stem N ":sct%s N 3iew ":sct%s. <o chan'e the .a%ue o+ a
MI#D c%ic) its 4dit =utton. <o remo.e a MI#D c%ic) its (e%ete =utton.
At this timeD the 2!I does not dis%a: the s:sct% MI#s that are re;set in the insta%%ation ima'e. 9.2.1
shis with the +o%%owin' MI#s setK
kern.metadelay=3
kern.dirdelay=4
kern.filedelay=5
kern.coredump=0
net.inet.tcp.delayed_ack=0

Do %ot add or edit the de*a!lt M1,S a$ $)$ctl$ as doin' so wi%% o.erwrite the de+au%t .a%ues which ma:
render the s:stem unusa=%e.
$.8 S+ste3 Infor3ation
":stem N ":stem In+ormation dis%a:s 'enera% in+ormation a=out the $reeNA"1 s:stem. An e5am%e
is seen in $i'ure &.6a.
<he in+ormation inc%udes the hostnameD the =ui%d .ersionD t:e o+ C>! A%at+ormBD the amount o+
memor:D the current s:stem timeD the s:stem's utimeD and the current %oad a.era'e.
<o chan'e the s:stem's hostnameD c%ic) its O4ditP =uttonD t:e in the new hostnameD and c%ic) O-KP.
<he hostname must inc%ude the domain name. I+ the networ) does not use a domain name add .lo'al to
the end o+ the hostname.
Figure $.8a: S+ste3 Infor3ation *a(
$.9 *una(les
When a $ree#"(;=ased s:stem =ootsD %oader.con+A*B is read to determine i+ an: arameters shou%d =e
assed to the )erne% or i+ an: additiona% )erne% modu%es Asuch as dri.ersB shou%d =e %oaded. "ince %oader
.a%ues are seci+ic to the )erne% arameter or dri.er to =e %oadedD descritions can =e +ound in the man
a'e +or the seci+ied dri.er and in man: sections o+ the $ree#"( Hand=oo).
$reeNA"1 ro.ides a 'rahica% inter+ace +or mana'in' %oader .a%ues. <his ad.anced +unctiona%it: is
intended to ma)e it easier to %oad additiona% )erne% modu%es at =oot time. A t:ica% usa'e wou%d =e to
%oad a $ree#"( hardware dri.er that does not automatica%%: %oad a+ter a $reeNA"1 insta%%ation. <he
de+au%t $reeNA"1 ima'e does not %oad e.er: ossi=%e hardware dri.er. <his is a necessar: e.i% as
some dri.ers con+%ict with one another or cause sta=i%it: issuesD some are rare%: usedD and some dri.ers
Iust don't =e%on' on a standard NA" s:stem. I+ :ou need a dri.er that is not automatica%%: %oadedD :ou
need to add a tuna=%e.
8ANG72C addin' a tuna=%e is an ad.anced +eature that cou%d ad.erse%: e++ect the a=i%it: o+ the
$reeNA"1 s:stem to success+u%%: =oot. It is 'er) i("orta%t that :ou do not ha.e a t:o when addin' a
tuna=%e as this cou%d ha%t the =oot rocess. $i5in' this ro=%em reEuires h:sica% access to the
$reeNA"1 s:stem and )now%ed'e o+ how to use the =oot %oader romt as descri=ed in Reco.erin'
$rom Incorrect <una=%es. <his means that :ou shou%d a%wa:s test the imact o+ an: chan'es on a test
s:stem +irst.
<o add a tuna=%eD 'o to ":stem N <una=%es N Add <una=%eD as seen in $i'ure &.9a.
Figure $.9a: Adding a *una(le
<a=%e &.9a summari8es the otions when addin' a tuna=%e. <he chan'es :ou ma)e wi%% not ta)e e++ect
unti% the s:stem is re=ooted as %oader settin's are on%: read when the )erne% is %oaded at =oot time. As
%on' as the tuna=%e e5istsD :our chan'es wi%% ersist at each =oot and across u'rades. An: tuna=%es that
:ou add wi%% =e %isted a%ha=etica%%: in ":stem N <una=%es N 3iew <una=%es. <o chan'e the .a%ue o+ a
tuna=%eD c%ic) its 4dit =utton. <o remo.e a tuna=%eD c%ic) its (e%ete =utton.
*a(le $.9a: Adding a *una(le
3aria=%e strin' t:ica%%: the name o+ the dri.er to %oadD as indicated =: its man a'e
3a%ue
inte'er or
strin'
.a%ue to associate with .aria=%eR t:ica%%: this is set to -.S to ena=%e the
dri.er seci+ied =: the .aria=%e
Comment strin' otiona%D =ut a use+u% reminder +or the reason =ehind addin' this tuna=%e
4na=%ed chec)=o5 unchec) i+ :ou wou%d %i)e to disa=%e the tuna=%e without de%etin' it
At this timeD the 2!I does not dis%a: the tuna=%es that are re;set in the insta%%ation ima'e. 9.2.1 shis
with the +o%%owin' tuna=%es setK
autoboot_delay="2"
loader_logo="freenas-logo"
loader_menu_title="Welcome to FreeNAS"
loader_brand="freenas-brand"
loader_version=" "
debug.debugger_on_panic=1
debug.ddb.textdump.pending=1
hw.hptrr.attach_generic=0
kern.ipc.nmbclusters="262144"
vfs.mountroot.timeout="30"
hint.isp.0.role=2
hint.isp.1.role=2
hint.isp.2.role=2
hint.isp.3.role=2
module_path="/boot/modules;/usr/local/modules"
net.inet6.ip6.auto_linklocal="0"
Do %ot add or edit the de*a!lt t!%able$ as doin' so wi%% o.erwrite the de+au%t .a%ues which ma: render
the s:stem unusa=%e.
<he 0$" .ersion used in 9.2.1 derecates the +o%%owin' tuna=%esK
vfs.zfs.write_limit_override
vfs.zfs.write_limit_inflated
vfs.zfs.write_limit_max
vfs.zfs.write_limit_min
vfs.zfs.write_limit_shift
vfs.zfs.no_write_throttle
I+ :ou u'rade +rom an ear%ier .ersion o+ $reeNA"1 where these tuna=%es are setD the: wi%%
automatica%%: =e de%eted +or :ou. Fou shou%d not tr: to add these tuna=%es =ac).
$.9.1 2eco,ering Fro3 Incorrect *una(les
I+ a tuna=%e is re.entin' the s:stem +rom =ootin'D :ou wi%% need h:sica% access to the $reeNA"1
s:stem. Watch the =oot messa'es and ress the num=er 3 )e: or the 4sc )e: to se%ect O3. 7scae to
%oader romtP when :ou see the $reeNA"1 =oot menu shown in $i'ure &.9=.
Figure $.9(: FreeNAS 5oot 4enu
<he =oot %oader romt ro.ides a minima% set o+ commands descri=ed in %oaderA6B. -nce at the
romtD use the unset command to disa=%e a ro=%ematic .a%ueD the set command to modi+: the
ro=%ematic .a%ueD or the unload command to re.ent the ro=%ematic dri.er +rom %oadin'.
45am%e &.9a demonstrates se.era% e5am%es usin' these commands at the =oot %oader romt. <he
+irst command disa=%es the current .a%ue associated with the kern.i*'.nm$'l!sters MI# and wi%% +ai%
with a Ono such +i%e or director:P error messa'e i+ a current tuna=%e does not e5ist to set this .a%ue. <he
second command disa=%es AC>I. <he third command instructs the s:stem not to %oad the +use dri.er.
When +inishedD t:e (oot to continue the =oot rocess.
7-a3!le $.9a: Sa3!le 'o33ands at te 5oot <oader Pro3!t
Type '?' for a list of commands, 'help' for more detailed help.
OK unset kern.ipc.nmbclusters
OK set hint.acpi.0.disabled=1
OK unload fuse
OK boot
An: chan'es made at the =oot %oader romt on%: e++ect the current =oot. <his means that :ou need to
edit or remo.e the ro=%ematic tuna=%e in ":stem N <una=%es N 3iew <una=%es to ma)e :our chan'e
ermanent and to re.ent +uture =oot errors.
" Net0or9 'onfiguration
<he Networ) section o+ the administrati.e 2!I contains the +o%%owin' comonents +or .iewin' and
con+i'urin' the $reeNA"1 s:stem's networ) settin'sK
2%o=a% Con+i'uration K used to to set non;inter+ace seci+ic networ) settin's.
Inter+aces K used to con+i'ure a seci+ied inter+ace's networ) settin's.
I>MI K ro.ides side;=and mana'ement shou%d the a%iance =ecome una.ai%a=%e throu'h the
'rahica% administrati.e inter+ace.
9in) A''re'ations K used to con+i'ure %in) a''re'ation and %in) +ai%o.er.
Networ) "ummar: K ro.ides an o.er.iew o+ the current networ) settin's.
"tatic Routes K used to add static routes.
39ANs K used to con+i'ure I444 602.1E ta''in'.
4ach o+ these is descri=ed in more detai% in this section.
".1 Glo(al 'onfiguration
Networ) N 2%o=a% Con+i'urationD shown in $i'ure *.1aD a%%ows :ou to set non;inter+ace seci+ic
networ) settin's.
<a=%e *.1a summari8es the settin's that can =e con+i'ured usin' the 2%o=a% Con+i'uration ta=. <he
hostname and domain wi%% =e re;+i%%ed +or :ouD as seen in $i'ure *.1aD =ut can =e chan'ed to meet the
%oca% networ)'s reEuirements.
I+ :ou wi%% =e usin' Acti.e (irector:D set the I> address o+ the (N" ser.er used in the rea%m.
I+ :our networ) does not ha.e a (N" ser.er or N$"D ""HD or $<> users are recei.in' Ore.erse (N"P or
timeout errorsD add an entr: +or the I> address o+ the $reeNA"1 s:stem in the OHost name data=aseP
+ie%d.
N6*7: i+ :ou add a 'atewa: to the InternetD ma)e sure that the $reeNA"1 s:stem is rotected =: a
roer%: con+i'ured +irewa%%.
Figure ".1a: Glo(al 'onfiguration Screen
*a(le ".1a: Glo(al 'onfiguration Settings
Hostname strin' s:stem host name
(omain strin' s:stem domain name
I>.& (e+au%t 2atewa: I> address t:ica%%: not set Asee N-<4 =e%owB
I>., (e+au%t 2atewa: I> address t:ica%%: not set Asee N-<4 =e%owB
Nameser.er 1 I> address rimar: (N" ser.er At:ica%%: in Windows domainB
Nameser.er 2 I> address secondar: (N" ser.er
Nameser.er 3 I> address tertiar: (N" ser.er
4na=%e netwait +eature chec)=o5
i+ ena=%edD networ) ser.ices wi%% not =e started at =oot time unti%
the inter+ace is a=%e to in' the addresses %isted in Net:ait 81 list
Netwait I> %ist strin'
i+ .na$le net:ait feat!re is chec)edD %ist o+ I> addresses to in'R
otherwiseD in' the de+au%t 'atewa:
Host name data=ase strin'
used to add one entr: er %ine which wi%% =e aended to
2et'2hostsR use the +ormat 81,address s*a'e hostname where
mu%ti%e hostnames can =e used i+ searated =: a sace
N6*7: In man: casesD a $reeNA"1 con+i'uration wi%% de%i=erate%: e5c%ude de+au%t 'atewa:
in+ormation as a wa: to ma)e it more di++icu%t +or a remote attac)er to communicate with the ser.er.
Whi%e this is a reasona=%e recautionD such a con+i'uration does %ot restrict in=ound tra++ic +rom
sources within the %oca% networ). Howe.erD omittin' a de+au%t 'atewa: wi%% re.ent the $reeNA"1
s:stem +rom communicatin' with (N" ser.ersD time ser.ersD and mai% ser.ers that are %ocated outside
o+ the %oca% networ). In this caseD it is recommended that "tatic Routes =e added in order to reach
e5terna% (N"D N<>D and mai% ser.ers which are con+i'ured with static I> addresses.
".2 Interfaces
Networ) N Inter+aces is used to .iew which inter+aces ha.e =een manua%%: con+i'uredD to add a
manua%%: con+i'ured inter+aceD and to edit an inter+ace's manua% con+i'uration.
N6*7: t:ica%%: the inter+ace used to access the $reeNA"1 administrati.e 2!I is con+i'ured =:
(HC>. <his inter+ace wi%% not aear in this screenD e.en thou'h it is a%read: d:namica%%: con+i'ured
and in use.
$i'ure *.2a shows the screen that oens when :ou c%ic) Inter+aces N Add Inter+ace. <a=%e *.2a
summari8es the con+i'uration otions when :ou Add an inter+ace or 4dit an a%read: con+i'ured
inter+ace.
Figure ".2a: Adding or 7diting an Interface
*a(le ".2a: Interface 'onfiguration Settings
NIC dro;down menu
se%ect the $ree#"( de.ice nameR wi%% =e a read;on%: +ie%d when
editin' an inter+ace
Inter+ace Name strin' descrition o+ inter+ace
(HC> chec)=o5
reEuires static I>.& or I>., con+i'uration i+ unchec)edR note that
on%: one inter+ace can =e con+i'ured +or (HC>
I>.& Address I> address set i+ (HC> unchec)ed
I>.& Netmas) dro;down menu set i+ (HC> unchec)ed
Auto con+i'ure
I>.,
chec)=o5
on%: one inter+ace can =e con+i'ured +or this otionR reEuires
manua% con+i'uration i+ unchec)ed and wish to use I>.,
I>., Address I>., address must =e uniEue on networ)
I>., >re+i5
9en'th
dro;down menu match the re+i5 used on networ)
-tions strin'
additiona% arameters +rom i+con+i'A6BD one er %ineR +or e5am%eK
mt! 4000 wi%% increase the M<! +or inter+aces that suort Ium=o
+rames
<his screen a%so a%%ows :ou to con+i'ure an a%ias +or the inter+ace. I+ :ou wish to set mu%ti%e a%iasesD
c%ic) the OAdd e5tra a%iasP %in) +or each a%ias :ou wish to con+i'ure. <o de%ete an a%iasD hi'h%i'ht the
inter+ace in the tree to access its M4ditM screen. #e sure to chec) the M(e%eteM chec)=o5 associated with
the a%ias. I+ :ou instead c%ic) the M(e%eteM =utton at the =ottom o+ this screenD :ou wi%% de%ete the who%e
inter+aceD not Iust the a%ias.
When con+i'urin' mu%ti%e inter+acesD the: can not =e mem=ers o+ the same su=net. Chec) the su=net
mas) i+ :ou recei.e an error when settin' the I> addresses on mu%ti%e inter+aces.
When con+i'urin' an inter+ace +or =oth I>.& and I>.,D this screen wi%% not %et :ou set =oth addresses as
rimar:. In other wordsD :ou wi%% 'et an error i+ :ou +i%% in =oth the 81#4 address and 81#5 address
+ie%ds. InsteadD set one o+ these address +ie%ds and create an a%ias +or the other address.
".# IP4I
#e'innin' with .ersion 9.2.1D $reeNA"1 ro.ides a 'rahica% screen +or con+i'urin' an I>MI
inter+ace. <his screen wi%% on%: aear i+ the s:stem hardware inc%udes a #ase=oard Mana'ement
Contro%%er A#MCB and the I>MI )erne% modu%e is %oaded.
I>MI ro.ides side;=and mana'ement shou%d the s:stem =ecome una.ai%a=%e throu'h the 'rahica%
administrati.e inter+ace. <his a%%ows +or a +ew .ita% +unctionsD such as chec)in' the %o'D accessin' the
#I-" setuD and owerin' on the s:stem without reEuirin' h:sica% access to the s:stem. I>MI can
a%so =e used to a%%ow another erson remote access to the s:stem in order to assist with a con+i'uration
or trou=%eshootin' issue. #e+ore con+i'urin' I>MID ensure that the mana'ement inter+ace is h:sica%%:
connected to the networ). (eendin' uon the hardwareD the I>MI de.ice ma: share the rimar:
4thernet inter+ace or it ma: =e a dedicated I>MI inter+ace.
#e+ore con+i'urin' I>MID add a tuna=%e with a M3aria=%eM o+ i*mi,load and a M3a%ueM o+ -.S. <his wi%%
con+i'ure the s:stem to %oad the dri.er at =ootu. <henD to %oad the i*mi )erne% modu%e nowD without
re=ootin'D t:e this +rom "he%%K
kldload ipmi
-nce the modu%e is %oadedD I>MI shou%d =e con+i'ured +rom Networ) N I>MI. $i'ure *.3a shows the
con+i'uration screen and <a=%e *.3a summari8es the otions when con+i'urin' I>MI.
Figure ".#a: IP4I 'onfiguration
*a(le ".#a: IP4I 6!tions
>assword strin'
inut the assword used to connect to the I>MI inter+ace +rom a
we= =rowser
(HC> chec)=o5 i+ %e+t unchec)edD the +o%%owin' three +ie%ds must =e set
I>.& Address strin' I> address used to connect to the I>MI we= 2!I
I>.& Netmas)
dro;down
menu
su=net mas) associated with the I> address
I>.& (e+au%t
2atewa:
strin' de+au%t 'atewa: associated with the I> address
-nce con+i'uredD :ou can access the I>MI inter+ace usin' a we= =rowser and the I> address :ou
seci+ied in the con+i'uration. <he mana'ement inter+ace wi%% romt +or a username and the assword
that :ou con+i'ured. Re+er to the documentation +or the I>MI de.ice to determine the de+au%t
administrati.e username.
<he de+au%t username is A<8N Ain a%% casB. -nce :ou ha.e %o''ed into the mana'ement inter+aceD
:ou can chan'e the administrati.e username as we%% as create additiona% users. <he aearance o+ the
uti%it: and the +unctions that are a.ai%a=%e within the I>MI mana'ement uti%it: wi%% .ar: deendin'
uon the hardware.
".$ <in9 Aggregations
$reeNA"1 uses $ree#"('s %a''A&B inter+ace to ro.ide %in) a''re'ation and %in) +ai%o.er. <he %a''
inter+ace a%%ows a''re'ation o+ mu%ti%e networ) inter+aces into a sin'%e .irtua% %a'' inter+aceD
ro.idin' +au%t;to%erance and hi'h;seed mu%ti;%in) throu'hut. <he a''re'ation rotoco%s suorted
=: %a'' determine which orts are used +or out'oin' tra++ic and whether a seci+ic ort accets
incomin' tra++ic. <he %in) state o+ the %a'' inter+ace is used to .a%idate i+ the ort is acti.e or not.
A''re'ation wor)s =est on switches suortin' 9AC>D which distri=utes tra++ic =i;directiona%%: whi%e
resondin' to +ai%ure o+ indi.idua% %in)s. $reeNA"1 a%so suorts acti.e@assi.e +ai%o.er =etween airs
o+ %in)s. <he 9AC>D $4C and %oad;=a%ance modes se%ect the outut inter+ace usin' a hash that inc%udes
the 4thernet source and destination addressD 39AN ta' Ai+ a.ai%a=%eBD I> source and destination addressD
and +%ow %a=e% AI>., on%:B. <he =ene+it can on%: =e o=ser.ed when mu%ti%e c%ients are trans+errin'
+i%es *ro( :our NA". <he +%ow enterin' i%to :our NA" deends on the 4thernet switch %oad;=a%ance
a%'orithm.
<he %a'' dri.er current%: suorts the +o%%owin' a''re'ation rotoco%sK
Failo,er: the de+au%t rotoco%. "ends tra++ic on%: throu'h the acti.e ort. I+ the master ort =ecomes
una.ai%a=%eD the ne5t acti.e ort is used. <he +irst inter+ace added is the master ortR an: inter+aces
added a+ter that are used as +ai%o.er de.ices. #: de+au%tD recei.ed tra++ic is on%: acceted when recei.ed
throu'h the acti.e ort. <his constraint can =e re%a5edD which is use+u% +or certain =rid'ed networ)
setusD =: settin' net.link.lagg.failo#er,r(,all to a non;8ero .a%ue in ":stem N ":sct%s N Add ":sct%.
F7': suorts Cisco 4therChanne% on o%der Cisco switches. <his is a static setu and does not
ne'otiate a''re'ation with the eer or e5chan'e +rames to monitor the %in).
<A'P: suorts the I444 602.3ad 9in) A''re'ation Contro% >rotoco% A9AC>B and the Mar)er
>rotoco%. 9AC> wi%% ne'otiate a set o+ a''re'a=%e %in)s with the eer into one or more %in) a''re'ated
'rous A9A2sB. 4ach 9A2 is comosed o+ orts o+ the same seedD set to +u%%;du%e5 oeration. <he
tra++ic wi%% =e =a%anced across the orts in the 9A2 with the 'reatest tota% seedR in most cases there
wi%% on%: =e one 9A2 which contains a%% orts. In the e.ent o+ chan'es in h:sica% connecti.it:D %in)
a''re'ation wi%% Euic)%: con.er'e to a new con+i'uration. 9AC> must =e con+i'ured on the switch as
we%%.
<oad 5alance: =a%ances out'oin' tra++ic across the acti.e orts =ased on hashed rotoco% header
in+ormation and accets incomin' tra++ic +rom an: acti.e ort. <his is a static setu and does not
ne'otiate a''re'ation with the eer or e5chan'e +rames to monitor the %in). <he hash inc%udes the
4thernet source and destination addressD 39AN ta' Ai+ a.ai%a=%eBD and I> source and destination
address. ReEuires a switch which suorts I444 602.3ad static %in) a''re'ation.
2ound 2o(in: distri=utes out'oin' tra++ic usin' a round;ro=in schedu%er throu'h a%% acti.e orts and
accets incomin' tra++ic +rom an: acti.e ort. <his mode can cause unordered ac)et arri.a% at the
c%ient. <his has a side e++ect o+ %imitin' throu'hut as reorderin' ac)ets can =e C>! intensi.e on the
c%ient. ReEuires a switch which suorts I444 602.3ad static %in) a''re'ation.
None: this rotoco% disa=%es an: tra++ic without disa=%in' the %a'' inter+ace itse%+.
N6*7: the $reeNA"1 s:stem must =e re=ooted a+ter con+i'urin' the %a'' de.ice and <C> access wi%%
=e %ost durin' re=oot. Do %ot con+i'ure the inter+aces used in the %a'' de.ice =e+ore creatin' the %a''
de.ice.
".$.1 'onsiderations .en Using <A'PJ 4PI6J NFSJ or 7SAi
9AC> =onds 4thernet connections in order to imro.e =andwidth. $or e5am%eD +our h:sica%
inter+aces can =e used to create one me'a inter+ace. Howe.erD it cannot increase the =andwidth +or a
sin'%e con.ersation. It is desi'ned to increase =andwidth when mu%ti%e c%ients are simu%taneous%:
accessin' the same s:stem. It a%so assumes that Eua%it: 4thernet hardware is used and it wi%% not ma)e
much di++erence when usin' in+erior 4thernet chisets such as a Rea%te).
9AC> reads the sender and recei.er I> addresses andD i+ the: are deemed to =e%on' to the same <C>
connectionD a%wa:s sends the ac)et o.er the same inter+ace to ensure that <C> does not need to
reorder ac)ets. <his ma)es 9AC> idea% +or %oad =a%ancin' man: simu%taneous <C> connectionsD =ut
does nothin' +or increasin' the seed o.er one <C> connection.
M>I- oerates at the i"C"I rotoco% %e.e%. $or e5am%eD i+ :ou create +our I> addresses and there are
+our simu%taneous <C> connectionsD M>I- wi%% send the data o.er a%% a.ai%a=%e %in)s. When
con+i'urin' M>I-D ma)e sure that the I> addresses on the inter+aces are con+i'ured to =e on searate
su=nets with non;o.er%ain' netmas)s or con+i'ure static routes to do oint;to;oint communication.
-therwiseD a%% ac)ets wi%% ass throu'h one inter+ace.
9AC> and other +orms o+ %in) a''re'ation 'enera%%: do not wor) we%% with .irtua%i8ation so%utions. In a
.irtua%i8ed en.ironmentD consider the use o+ i"C"I M>I- throu'h the creation o+ an i"C"I >orta%. <his
a%%ows an i"C"I initiator to reco'ni8e mu%ti%e %in)s to a tar'etD uti%i8in' them +or increased =andwidth
or redundanc:. <his how;to contains instructions +or con+i'urin' M>I- on 4"7i.
N$" does not understand M>I-. <here+oreD :ou wi%% need one +ast inter+ace since creatin' an i"C"I
orta% wi%% not imro.e =andwidth when usin' N$". 9AC> does not wor) we%% to increase the
=andwidth +or oint;to;oint N$" Aone ser.er and one c%ientB. 9AC> is a 'ood so%ution +or %in)
redundanc: or +or one ser.er and man: c%ients.
".$.2 'reating a <in9 Aggregation
#e+ore creatin' a %in) a''re'ationD dou=%e;chec) that no inter+aces ha.e =een manua%%: con+i'ured in
Networ) N Inter+aces N 3iew Inter+aces. I+ an: con+i'ured inter+aces e5istD de%ete them as %a''
creation wi%% +ai% i+ an: inter+aces are manua%%: con+i'ured.
$i'ure *.&a shows the con+i'uration otions when addin' a %a'' inter+ace usin' Networ) N 9in)
A''re'ations N Create 9in) A''re'ation.
Figure ".$a: 'reating a lagg Interface
N6*7: i+ inter+aces are insta%%ed =ut do not aear in the >h:sica% NICs in the 9A22 %istD chec) that a
$ree#"( dri.er +or the inter+ace e5ists here.
"e%ect the desired a''re'ation rotoco%D hi'h%i'ht the inter+aceAsB to associate with the %a'' de.iceD and
c%ic) the -K =utton.
-nce the %a'' de.ice has =een createdD it wi%% =e %isted in the tree under an entr: which indicates the
t:e o+ rotoco%. As seen in $i'ure *.&=D it wi%% a%so aear in 3iew 9in) A''re'ations.
Figure ".$(: ?ie0ing <in9 Aggregations
C%ic) a %in) a''re'ation entr: to see the =uttons to edit that %a'' inter+aceD de%ete the %in) a''re'ationD
or edit the %a'''s mem=er inter+aces.
I+ :ou c%ic) the 4dit =utton +or a %a''D :ou wi%% see the con+i'uration screen shown in $i'ure *.&c. <a=%e
*.&a descri=es the otions in this screen.
A+ter creatin' the %a'' inter+aceD set the I> address manua%%: or with (HC> and sa.e. <he connection
to the we= inter+ace ma: =e %ost at this ointD and i+ soD the s:stem must =e re=ooted +rom the conso%e
setu menu. Fou ma: a%so ha.e to chan'e :our switch settin's to communicate throu'h the new %a''
inter+ace. A+ter re=ootD i+ the I> address was set manua%%:D :ou ma: a%so ha.e to manua%%: enter a
de+au%t 'atewa: +rom the conso%e setu menu otion in order to 'et access into the 2!I throu'h the
new %a'' inter+ace.
Figure ".$c: 7diting a lagg
*a(le ".$a: 'onfigura(le 6!tions for a lagg
NIC strin' read;on%: as automatica%%: assi'ned ne5t a.ai%a=%e numeric I(
Inter+ace Name strin'
=: de+au%t same as de.ice ANICB nameD can =e chan'ed to a more
descriti.e .a%ue
(HC> chec)=o5 chec) i+ the %a'' de.ice 'ets its I> address in+o +rom (HC> ser.er
I>.& Address strin' mandator: i+ (HC> is %e+t unchec)ed
I>.& Netmas)
dro;down
menu
mandator: i+ (HC> is %e+t unchec)ed
Auto con+i'ure
I>.,
chec)=o5 chec) on%: i+ (HC> ser.er a.ai%a=%e to ro.ide I>., address in+o
I>., Address strin' otiona%
I>., >re+i5
9en'th
dro;down
menu
reEuired i+ inut I>., address
-tions strin' additiona% i+con+i'A6B otions
<his screen a%so a%%ows :ou to con+i'ure an a%ias +or the %a'' inter+ace. I+ :ou wish to set mu%ti%e
a%iasesD c%ic) the OAdd e5tra A%iasP %in) +or each a%ias :ou wish to con+i'ure.
I+ :ou c%ic) the 4dit Mem=ers =uttonD c%ic) the entr: +or a mem=erD then c%ic) its 4dit =uttonD :ou wi%%
see the con+i'uration screen shown in $i'ure *.&d. <he con+i'ura=%e otions are summari8ed in <a=%e
*.&=.
Figure ".$d: 7diting a 4e3(er Interface
*a(le ".$(: 'onfiguring a 4e3(er Interface
9A22 Inter+ace 'rou dro;down menu se%ect the mem=er inter+ace to con+i'ure
9A22 >riorit: Num=er inte'er
order o+ se%ected inter+ace within the %a''R con+i'ure
a +ai%o.er to set the master inter+ace to 0 and the
other inter+aces to 1D 2D etc.
9A22 >h:sica% NIC dro;down menu h:sica% inter+ace o+ the se%ected mem=er
-tions strin' additiona% arameters +rom i+con+i'A6B
N6*7: otions can =e set at either the %a'' %e.e% Ausin' the 4dit =uttonB or the indi.idua% arent
inter+ace %e.e% Ausin' the 4dit Mem=ers =uttonB. <:ica%%:D chan'es are made at the %a'' %e.e% A$i'ure
*.&cB as each inter+ace mem=er wi%% inherit +rom the %a''. I+ :ou instead con+i'ure the inter+ace %e.e%
A$i'ure *.&dBD :ou wi%% ha.e to reeat the con+i'uration +or each inter+ace within the %a''. Howe.erD
some %a'' otions can on%: =e set =: editin' the inter+ace. $or instanceD the M<! o+ a %a'' is inherited
+rom the inter+ace. <o set an M<! on a %a''D set a%% the inter+aces to the same M<!.
<o see i+ the %in) a''re'ation is %oad =a%ancin' roer%:D run the +o%%owin' command +rom "he%%K
systat -ifstat
More in+ormation a=out this command can =e +ound at s:statA1B.
"." Net0or9 Su33ar+
Networ) N Networ) "ummar: a%%ows :ou to Euic)%: .iew the addressin' in+ormation o+ e.er:
con+i'ured inter+ace. $or each inter+ace nameD the con+i'ured I> addressAesBD (N" ser.erAsBD and
de+au%t 'atewa: wi%% =e dis%a:ed.
".% Static 2outes
#: de+au%tD no static routes are de+ined on the $reeNA"1 s:stem. "hou%d :ou need a static route to
reach ortions o+ :our networ)D add the route usin' Networ) N "tatic Routes N Add "tatic RouteD
shown in $i'ure *.,a.
Figure ".%a: Adding a Static 2oute
<he a.ai%a=%e otions are summari8ed in <a=%e *.,a.
*a(le ".%a: Static 2oute 6!tions
(estination networ) inte'er use the +ormat A.B.".2. where . is the CI(R mas)
2atewa: inte'er inut the I> address o+ the 'atewa:
(escrition strin' otiona%
I+ :ou add an: static routesD the: wi%% show in O3iew "tatic RoutesP. C%ic) a route's entr: to access its
4dit and (e%ete =uttons.
".) ?<ANs
$reeNA"1 uses $ree#"('s .%anA&B inter+ace to demu%ti%e5 +rames with I444 602.1E ta's. <his a%%ows
nodes on di++erent 39ANs to communicate throu'h a %a:er 3 switch or router. A .%an inter+ace must =e
assi'ned a arent inter+ace and a numeric 39AN ta'. A sin'%e arent can =e assi'ned to mu%ti%e .%an
inter+aces ro.ided the: ha.e di++erent ta's. I+ :ou c%ic) Networ) N 39ANs N Add 39AND :ou wi%%
see the screen shown in $i'ure *./a.
N6*7: 39AN ta''in' is the on%: 602.1E +eature that is im%emented. Additiona%%:D not a%% 4thernet
inter+aces suort +u%% 39AN rocessin'Wsee the HAR(WAR4 section o+ .%anA&B +or detai%s.
Figure ".)a: Adding a ?<AN
<a=%e *./a summari8es the con+i'ura=%e +ie%ds.
*a(le ".)a: Adding a ?<AN
3irtua%
Inter+ace
strin'
use the +ormat #lanX where X is a num=er reresentin' the .%an
inter+ace
>arent Inter+ace dro;down menu
usua%%: an 4thernet card connected to a roer%: con+i'ured switch
ortR i+ usin' a new%: created %a'' de.iceD it wi%% not aear in the
dro;down unti% the $reeNA"1 s:stem is re=ooted
39AN <a' inte'er shou%d match a numeric ta' set u in the switched networ)
<he arent inter+ace o+ a .%an has to =e uD =ut it can ha.e an I> address or it can =e uncon+i'uredD
deendin' uon the reEuirements o+ the 39AN con+i'uration. <his ma)es it di++icu%t +or the 2!I to do
the ri'ht thin' without tram%in' the con+i'uration. <o remed: thisD a+ter addin' the 39AND 'o to
Networ) N Inter+aces N Add Inter+ace. "e%ect the arent inter+ace +rom the NIC dro;down menu and
in the -tions +ie%dD t:e !*. <his wi%% =rin' u the arent inter+ace. I+ an I> address is reEuiredD it can
=e con+i'ured usin' the rest o+ the otions in the Add Inter+ace screen.
% Storage 'onfiguration
<he "tora'e section o+ the 'rahica% inter+ace a%%ows :ou to con+i'ure the +o%%owin'K
>eriodic "nashot <as)s K used to schedu%e the automatic creation o+ 0$" snashots.
Re%ication <as)s K used to schedu%e the re%ication o+ snashots o.er an encr:ted connection.
3o%umes K used to create and mana'e stora'e .o%umes.
0$" "cru=s K used to schedu%e 0$" scru=s as art o+ on'oin' dis) maintenance.
<hese con+i'urations are descri=ed in more detai% in this section.
%.1 Periodic Sna!sot *as9s
A eriodic snashot tas) a%%ows :ou to schedu%e the creation o+ read;on%: .ersions o+ 0$" .o%umes and
datasets at a 'i.en oint in time. "nashots can =e created Euic)%: andD i+ %itt%e data chan'esD new
snashots ta)e u .er: %itt%e sace. $or e5am%eD a snashot where no +i%es ha.e chan'ed ta)es 0 M# o+
stora'eD =ut as :ou ma)e chan'es to +i%esD the snashot si8e chan'es to re+%ect the si8e o+ the chan'es.
"nashots ro.ide a c%e.er wa: o+ )eein' a histor: o+ +i%esD shou%d :ou need to reco.er an o%der co:
or e.en a de%eted +i%e. $or this reasonD man: administrators ta)e snashots o+ten Ae.'. e.er: 1*
minutesBD store them +or a eriod o+ time Ae.'. +or a monthBD and store them on another s:stem Ae.'.
usin' Re%ication <as)sB. "uch a strate': a%%ows the administrator to ro%% the s:stem =ac) to a seci+ic
time orD i+ there is a catastrohic %ossD an o++;site snashot can restore the s:stem u to the %ast snashot
inter.a%.
#e+ore :ou can create a snashotD :ou need to ha.e an e5istin' 0$" .o%ume. How to create a .o%ume is
descri=ed in 0$" 3o%ume Mana'er.
%.1.1 'reating a Periodic Sna!sot *as9
<o create a eriodic snashot tas)D c%ic) "tora'e N >eriodic "nashot <as)s N Add >eriodic "nashot
which wi%% oen the screen shown in $i'ure ,.1a. <a=%e ,.1a summari8es the +ie%ds in this screen.
N6*7: i+ :ou Iust need a one;time snashotD instead use "tora'e N 3o%umes N 3iew 3o%umes and
c%ic) the Create "nashot =utton +or the .o%ume or dataset that :ou wish to snashot.
Figure %.1a: 'reating a ;FS Periodic Sna!sot
*a(le %.1a: 6!tions .en 'reating a Periodic Sna!sot
4na=%ed chec)=o5
unchec) to disa=%e the schedu%ed re%ication tas) without
de%etin' it
3o%ume@(ataset dro;down menu
se%ect an e5istin' 0$" .o%umeD datasetD or 8.o%R i+ :ou
se%ect a .o%umeD searate snashots wi%% a%so =e created +or
each o+ its datasets
Recursi.e chec)=o5
se%ect this =o5 to ta)e searate snashots o+ the
.o%ume@dataset and each o+ its chi%d datasetsR i+ unchec)edD
on%: one snashot is ta)en o+ the .o%ume@dataset seci+ied
in Filesystem 2 Bol!me
9i+etime
inte'er and dro;down
menu
how %on' to )ee the snashot on this s:stemR i+ the
snashot is re%icatedD it is not remo.ed +rom the recei.in'
s:stem when the %i+etime e5ires
#e'in dro;down menu do not create snashots =e+ore this time o+ da:
4nd dro;down menu do not create snashots a+ter this time o+ da:
Inter.a% dro;down menu how o+ten to ta)e snashot =etween Begin and .nd times
Wee)da: chec)=o5es which da:s o+ the wee) to ta)e snashots
I+ the Recursi.e =o5 is chec)edD :ou do not need to create snashots +or e.er: dataset indi.idua%%: as
the: are inc%uded in the snashot. <he downside is that there is no wa: to e5c%ude certain datasets +rom
=ein' inc%uded in a recursi.e snashot.
-nce :ou c%ic) the -K =uttonD a snashot wi%% =e ta)en and this tas) wi%% =e reeated accordin' to :our
settin's.
%.1.2 4anaging Periodic Sna!sot *as9s
A+ter creatin' a eriodic snashot tas)D an entr: +or the snashot tas) wi%% =e added to 3iew >eriodic
"nashot <as)sD as seen in the e5am%e in $i'ure ,.1=. C%ic) an entr: to access its Modi+: and (e%ete
=uttons.
Figure %.1(: ?ie0 Periodic Sna!sot *as9s
I+ :ou c%ic) the 0$" "nashots ta= Aa=o.e the Add >eriodic "nashot =uttonBD :ou can re.iew the
%istin' o+ a.ai%a=%e snashots. An e5am%e is shown in $i'ure ,.1c.
N6*7: i+ snashots do not aearD chec) that the current time does not con+%ict with the =e'inD endD
and inter.a% settin's. I+ the snashot was attemted =ut +ai%edD an entr: wi%% =e added to
2#ar2log2messages. <his %o' +i%e can =e .iewed in "he%%.
Figure %.1c: ?ie0ing A,aila(le Sna!sots
<he most recent snashot +or a .o%ume or dataset wi%% =e %isted %ast and wi%% ha.e 3 icons. <he icons
associated with a snashot a%%ow :ou toK
'lone Sna!sot: wi%% romt +or the name o+ the c%one to create. <he c%one wi%% =e a writa=%e co: o+
the snashot. "ince a c%one is rea%%: a dataset which can =e mountedD the c%one wi%% aear in the Acti.e
3o%umes ta=D instead o+ the >eriodic "nashots ta=D and wi%% ha.e the word 'lone in its name.
8estro+ Sna!sot: a o;u messa'e wi%% as) :ou to con+irm this action. Chi%d c%ones must =e
destro:ed =e+ore their arent snashot can =e destro:ed. Whi%e creatin' a snashot is instantaneousD
de%etin' a snashot can =e I@- intensi.e and can ta)e a %on' timeD esecia%%: when dedu%ication is
ena=%ed. In order to de%ete a =%oc) in a snashotD 0$" has to wa%) a%% the a%%ocated =%oc)s to see i+ that
=%oc) is used an:where e%seR i+ it is notD it can =e +reed.
2oll(ac9 Sna!sot: a o;u messa'e wi%% as) i+ :ou are sure that :ou want to ro%%=ac) to this
snashot state. I+ :ou c%ic) FesD an: +i%es that ha.e chan'ed since the snashot was ta)en wi%% =e
re.erted =ac) to their state at the time o+ the snashot.
N6*7: ro%%=ac) is a otentia%%: dan'erous oeration and wi%% cause an: con+i'ured re%ication tas)s to
+ai% as the re%ication s:stem uses the e5istin' snashot when doin' an incrementa% =ac)u. I+ :ou do
need to restore the data within a snashotD the recommended stes areK
1. C%one the desired snashot.
2. "hare the c%one with the share t:e or ser.ice runnin' on the $reeNA"1 s:stem.
3. -nce users ha.e reco.ered the needed dataD destro: the c%one in the Acti.e 3o%umes ta=.
<his aroach wi%% ne.er destro: an: on;dis) data and has no imact on re%ication.
>eriodic snashots can =e con+i'ured to aear as shadow coies in newer .ersions o+ Windows
45%orer. !sers can access the +i%es in the shadow co: usin' 45%orer without reEuirin' an:
interaction with the $reeNA"1 'rahica% administrati.e inter+ace.
<he 0$" "nashots screen a%%ows :ou to create +i%ters to .iew snashots =: se%ected criteria. <o create a
+i%terD c%ic) the (e+ine +i%ter icon Anear the te5t ONo +i%ter a%iedPB. When creatin' a +i%terK
se%ect the co%umn or %ea.e the de+au%t o+ An: Co%umn.
se%ect the condition. >ossi=%e conditions areK 'ontains Ade+au%tBD is3 starts :ith3 ends :ith3 does
not 'ontain3 is not3 does not start :ith3 does not end :ithD and is em*ty.
inut a .a%ue that meets :our .iew criteria.
c%ic) the $i%ter =utton to sa.e :our +i%ter and e5it the de+ine +i%ter screen. A%ternate%:D c%ic) the X
=utton to add another +i%ter.
I+ :ou create mu%ti%e +i%tersD se%ect the +i%ter :ou wish to use =e+ore %ea.in' the de+ine +i%ter screen.
-nce a +i%ter is se%ectedD the ONo +i%ter a%iedP te5t wi%% chan'e to OC%ear +i%terP. I+ :ou c%ic) OC%ear
+i%terPD a o;u messa'e wi%% indicate that this wi%% remo.e the +i%ter and a%% a.ai%a=%e snashots wi%% =e
%isted.
%.2 2e!lication *as9s
A re%ication tas) a%%ows :ou to automate the co: o+ 0$" snashots to another s:stem o.er an
encr:ted connection. <his a%%ows :ou to create an o++;site =ac)u o+ a 0$" dataset or oo%.
<his section wi%% re+er to the s:stem 'eneratin' the 0$" snashots as 19S= and the s:stem to recei.e a
co: o+ the 0$" snashots as 19;;.
#e+ore :ou can con+i'ure a re%ication tas)D the +o%%owin' re;reEuisites must =e metK
a 0$" .o%ume must e5ist on =oth 19S= and 19;;.
a eriodic snashot tas) must =e created on 19S=. Fou wi%% not =e a=%e to create a re%ication
tas) =e+ore the +irst snashot e5ists.
the ""H ser.ice must =e ena=%ed on 19;;. <he +irst time the ser.ice is ena=%edD it wi%% 'enerate
the reEuired ""H )e:s.
A re%ication tas) uses the +o%%owin' )e:sK
EdataEssEre!lication.!u(: the R"A u=%ic )e: used +or authenticatin' the 19S= re%ication
user. <his )e: needs to =e coied to the re%ication user account on 19;;.
EetcEssEss:ost:rsa:9e+.!u(: the R"A host u=%ic )e: o+ 19;; used to authenticate the
recei.in' side in order to re.ent a man;in;the;midd%e attac). <his )e: needs to =e coied to the
re%ication tas) on 19S=.
<his section wi%% demonstrate how to con+i'ure a re%ication tas) =etween the +o%%owin' two
$reeNA"1 s:stemsK
142.156.2.2 wi%% =e re+erred to as 19S=. <his s:stem has a eriodic snashot tas) +or the 0$"
dataset 2mnt2lo'al2data.
142.156.2.5 wi%% =e re+erred to as 19;;. <his s:stem has an e5istin' 0$" .o%ume named
2mnt2remote which wi%% store the ushed snashots.
%.2.1 'onfigure PU22
A co: o+ the u=%ic )e: +or the re%ication user on 19S= needs to =e asted to the u=%ic )e: o+ the
re%ication user on the 19;; s:stem.
<o o=tain a co: o+ the re%ication )e:K on 19S= 'o to "tora'e N 3iew Re%ication <as)s. C%ic) the
3iew >u=%ic Ke: =utton and co: its contents. An e5am%e is shown in $i'ure ,.2a.
Figure %.2a: 'o!+ te 2e!lication 1e+
2o to 19;; and c%ic) Account N !sers N 3iew !sers. C%ic) the Modi+: !ser =utton +or the user
account :ou wi%% =e usin' +or re%ication A=: de+au%t this is the root userB. >aste the coied )e: into the
O""H >u=%ic Ke:P +ie%d and c%ic) -K. I+ a )e: a%read: e5istsD aend the new te5t a+ter the e5istin'
)e:.
-n 19;;D ensure that the ""H ser.ice is ena=%ed in "er.ices N Contro% "er.ices. "tart it i+ it is not
a%read: runnin'.
%.2.2 'onfigure PUS7
-n 19S=D .eri+: that a eriodic snashot tas) has =een created and that at %east one snashot is %isted
in "tora'e N >eriodic "nashot <as)s N 3iew >eriodic "nashot <as)s N 0$" "nashots.
<o create the re%ication tas)D c%ic) "tora'e N Re%ication <as)s N Add Re%ication <as). $i'ure ,.2=
shows the reEuired con+i'uration +or our e5am%eK
the 3o%ume@(ataset is lo'al2data
the Remote 0$" 3o%ume@(ataset is remote
the Remote hostname is 142.156.2.5
the #e'in and 4nd times are at their de+au%t .a%uesD meanin' that re%ication wi%% occur
whene.er a snashot is created
once the Remote hostname is inutD c%ic) the ""H Ke: "can =uttonR assumin' the address is
reacha=%e and the ""H ser.ice is runnin' on 19;;D its )e: wi%% automatica%%: =e ou%ated to
the Remote host)e: =o5
<a=%e ,.2a summari8es the a.ai%a=%e otions in the Add Re%ication <as) screen.
Figure %.2(: Adding a 2e!lication *as9
*a(le %.2a: Adding a 2e!lication *as9
4na=%ed chec)=o5 unchec) to disa=%e the schedu%ed re%ication tas) without de%etin' it
3o%ume@(ataset
dro;down
menu
the 0$" .o%ume or dataset on 19S= containin' the snashots to =e
re%icatedR the dro;down menu wi%% =e emt: i+ a snashot does
not a%read: e5ist
Remote 0$"
3o%ume@(ataset
strin'
the 0$" .o%ume on 19;; that wi%% store the snashotsR 2mnt2 is
assumed and shou%d not =e inc%uded in the ath
Recursi.e%:
re%icate
chec)=o5
i+ chec)ed wi%% re%icate chi%d datasets and re%ace re.ious
snashot stored on 19;;
Initia%i8e remote
side
chec)=o5
does a reset once oeration which destro:s the re%ication data on
19;; =e+ore re.ertin' to norma% oerationR use this otion i+
re%ication 'ets stuc)
9imit A)#@sB inte'er
%imits re%ication seed to seci+ied .a%ue in )i%o=:tes@secondR
de+au%t o+ 0 is un%imited
#e'in
dro;down
menu
the re%ication can not start =e+ore this timeR the times se%ected in
the Begin and .nd +ie%ds set the re%ication window +or when
re%ication can occur
4nd
dro;down
menu
the re%ication must start =: this timeR once startedD re%ication wi%%
occur unti% it is +inished Asee N-<4 =e%owB
Remote hostname strin' I> address or (N" name o+ 19;;
Remote ort strin' must match ort =ein' used =: ""H ser.ice on 19;;
(edicated !ser
4na=%ed
chec)=o5 a%%ows a user account other than root to =e used +or re%ication
(edicated !ser
dro;down
menu
on%: a.ai%a=%e i+ edi'ated 9ser .na$led is chec)edR se%ect the user
account to =e used +or re%ication
4na=%e Hi'h "eed
Cihers
chec)=o5 note that the ciher is Euic)er =ecause it has a %ower stren'th
Remote host)e: strin' use the ""H Ke: "can =utton to retrie.e the u=%ic )e: o+ 19;;
#: de+au%tD re%ication occurs when snashots occur. $or e5am%eD i+ snashots are schedu%ed +or e.er:
2 hoursD re%ication occurs e.er: 2 hours. <he #e'in and 4nd times can =e used to create a window o+
time where re%ication occurs. Chan'e the de+au%t times Awhich a%%ow re%ication to occur at an: time
o+ the da: a snashot occursB i+ snashot tas)s are schedu%ed durin' o++ice hours =ut the re%ication
itse%+ shou%d occur a+ter o++ice hours. $or the 4nd timeD consider how %on' re%ication wi%% ta)e so that
it +inishes =e+ore the ne5t da:'s o++ice hours =e'in.
-nce the re%ication tas) is createdD it wi%% aear in the 3iew Re%ication <as)s o+ 19S=.
19S= wi%% immediate%: attemt to re%icate its %atest snashot to 19;;. I+ the re%ication is success+u%D
the snashot wi%% aear in the "tora'e N >eriodic "nashot <as)s N 3iew >eriodic "nashot <as)s
N 0$" "nashots ta= o+ 19;;D as seen in $i'ure ,.2c. I+ the snashot is not re%icatedD see the ne5t
section +or trou=%eshootin' tis.
Figure %.2c: ?erif+ing te Sna!sot 0as 2e!licated
%.2.# *rou(lesooting 2e!lication
I+ :ou ha.e +o%%owed a%% o+ the stes a=o.e and ha.e 19S= snashots that are not re%icatin' to 19;;D
chec) to see i+ ""H is wor)in' roer%:. -n 19S=D oen "he%% and tr: to ss into 19;;. Re%ace
hostname,or,i* with the .a%ue +or 19;;K
ssh -vv -i /data/ssh/replication hostname_or_ip
<his command shou%d not as) +or a assword. I+ it as)s +or a asswordD ""H authentication is not
wor)in'. 2o to "tora'e N Re%ication <as)s N 3iew Re%ication <as)s and c%ic) the O3iew >u=%ic
Ke:P =utton. Ma)e sure that it matches one o+ the .a%ues in 2C2.ssh2a!thori/ed,keys on 19;;3 where Y
reresents the home director: o+ the re%ication user.
A%so chec) 2#ar2log2a!th.log on 19;; and 2#ar2log2messages on 19S= to see i+ either %o' 'i.es an
indication o+ the error.
I+ the )e: is correct and re%ication is sti%% not wor)in'D tr: de%etin' a%% snashots on 19;; e5cet +or
the most recent one. In "tora'e N >eriodic "nashot <as)s N 3iew >eriodic "nashot <as)s N 0$"
"nashots chec) the =o5 ne5t to e.er: snashot e5cet +or the %ast one Athe one with 3 icons instead o+
2BD then c%ic) the '%o=a% (estro: =utton at the =ottom o+ the screen.
-nce :ou ha.e on%: one snashotD oen "he%% on 19S= and use the =fs send command. <o continue
our e5am%eD the 0$" snashot on the lo'al2data dataset o+ 19S= is named a!to-20110422.17D+-2hD
the I> address o+ 19;; is 142.156.2.5D and the 0$" .o%ume on 19;; is remote. Note that the K is
used to searate the .o%ume@dataset name +rom the snashot name.
zfs send local/data@auto-20110922.1753-2h | ssh -i /data/ssh/replication \
192.168.2.6 zfs receive local/data@auto-20110922.1753-2h
N6*7: i+ this command +ai%s with the error Ocannot recei.e new +i%es:stem streamK destination has
snashotsPD chec) the =o5 Oinitia%i8e remote side +or onceP in the re%ication tas) and tr: a'ain. I+ the
=fs send command sti%% +ai%sD :ou wi%% need to oen "he%% on 19;; and use the =fs destro+ >2
,olu3e:na3eKsna!sot:na3e command to de%ete the stuc) snashot. Fou can then use the =fs list >t
sna!sot on 19;; to con+irm i+ the snashot success+u%%: re%icated.
A+ter success+u%%: transmittin' the snashotD rechec) a'ain a+ter the time eriod =etween snashots
%ases to see i+ the ne5t snashot success+u%%: transmitted. I+ it is sti%% not wor)in'D :ou can manua%%:
send an incrementa% =ac)u o+ the %ast snashot that is on =oth s:stems to the current one with this
commandK
zfs send local/data@auto-20110922.1753-2h | ssh -i /data/ssh/replication \
192.168.2.6 zfs receive local/data@auto-20110922.1753-2h
%.# ?olu3es
"ince the stora'e dis)s are searate +rom the $reeNA"1 oeratin' s:stemD :ou do not actua%%: ha.e a
NA" Anetwor);attached stora'eB s:stem unti% :ou con+i'ure :our dis)s into at %east one .o%ume. <he
$reeNA"1 'rahica% inter+ace suorts the creation o+ =oth !$" and 0$" .o%umes. 0$" .o%umes are
recommended to 'et the most out o+ :our $reeNA"1 s:stem.
N6*7: in 0$" termino%o':D the stora'e that is mana'ed =: 0$" is re+erred to as a oo%. When
con+i'urin' the 0$" oo% usin' the $reeNA"1 'rahica% inter+aceD the term .o%ume is used to re+er to
either a !$" .o%ume or a 0$" oo%.
>roer stora'e desi'n is imortant +or an: NA". 1t i$ reco((e%ded that )o! read thro!#h thi$ e%tire
cha"ter *ir$t/ be*ore co%*i#!ri%# )o!r $tora#e di$0$/ $o that )o! are a-are o* all o* the "o$$ible
*eat!re$/ 0%o- -hich o%e$ -ill be%e*it )o!r $et!" (o$t/ a%d are a-are o* a%) ca'eat$ or hard-are
re$trictio%$.
%.#.1 Auto I3!orting ?olu3es
I+ :ou c%ic) "tora'e N 3o%umes N Auto Imort 3o%umeD :ou can con+i'ure $reeNA"1 to use an
exi$ti%# so+tware !$" or 0$" RAI( .o%ume. <his action is t:ica%%: er+ormed when an e5istin'
$reeNA"1 s:stem is re;insta%%ed Arather than u'radedB. "ince the oeratin' s:stem is searate +rom
the dis)sD a new insta%%ation does not a++ect the data on the dis)sR howe.erD the new oeratin' s:stem
needs to =e con+i'ured to use the e5istin' .o%ume.
"uorted .o%umes are !$" 24-M stries ARAI(0BD !$" 24-M mirrors ARAI(1BD !$" 24-M
RAI(3D as we%% as e5istin' 0$" oo%s. !$" RAI(* is not suorted as it is an unmaintained summer
o+ code roIect which was ne.er inte'rated into $ree#"(.
#e'innin' with .ersion 6.3.1D the imort o+ e5istin' 249I;encr:ted 0$" oo%s is a%so suorted.
Howe.erD the oo% must =e decr:ted =e+ore it can =e imorted.
$i'ure ,.3a shows the initia% o;u window that aears when :ou se%ect to auto imort a .o%ume.
I+ :ou are imortin' a !$" RAI( or an e5istin'D unencr:ted 0$" oo%D se%ect ONoK ")i to imortP to
access the screen shown in $i'ure ,.3=.
Figure %.#a: Initial Auto I3!ort ?olu3e Screen
Figure %.#(: Auto I3!orting a Non>7ncr+!ted ?olu3e
45istin' so+tware RAI( .o%umes shou%d =e a.ai%a=%e +or se%ection +rom the dro;down menu. In the
e5am%e shown in $i'ure ,.3=D the $reeNA"1 s:stem has an e5istin'D unencr:ted 0$" oo%. -nce the
.o%ume is se%ectedD c%ic) the O-KP =utton to imort the .o%ume.
$reeNA"1 wi%% not imort a dirt: .o%ume. I+ an e5istin' !$" RAI( does not show in the dro;down
menuD :ou wi%% need to fsc9 the .o%ume.
I+ an e5istin' 0$" oo% does not show in the dro;down menuD run =!ool i3!ort +rom "he%% to imort
the oo%.
I+ :ou %an to h:sica%%: insta%% 0$" +ormatted dis)s +rom another s:stemD =e sure to e5ort the dri.es
on that s:stem to re.ent an Oin use =: another machineP error durin' the imort.
I+ :ou susect that :our hardware is not =ein' detectedD run ca3control de,list +rom "he%%. I+ the dis)
does not aear in the oututD chec) to see i+ the contro%%er dri.er is suorted or i+ it needs to =e
%oaded =: creatin' a tuna=%e.
(.3.1.1 Auto I&orting a )*+I,*ncr-ted .#S /ool
I+ :ou are imortin' an e5istin' 249I;encr:ted 0$" oo%D :ou must decr:t the dis)s =e+ore
imortin' the oo%. In $i'ure ,.3aD se%ect OFesK (ecr:t dis)sP to access the screen shown in $i'ure
,.3c.
Figure %.#c: 8ecr+!ting te 8is9s 5efore I3!orting te ;FS Pool
"e%ect the dis)s in the encr:ted oo%D =rowse to the %ocation o+ the sa.ed encr:tion )e:D inut the
asshrase associated with the )e:D then c%ic) -K to decr:t the dis)s.
N6*7: the encr:tion )e: is reEuired to decr:t the oo%. I+ the oo% can not =e decr:tedD it can not
=e re;imorted a+ter a +ai%ed u'rade or %ost con+i'uration. <his means that it is 'er) i("orta%t to sa.e
a co: o+ the )e: and to remem=er the asshrase that was con+i'ured +or the )e:. <he 3iew 3o%umes
screen is used to mana'e the )e:s +or encr:ted .o%umes.
-nce the oo% is decr:tedD it shou%d aear in the dro;down menu o+ $i'ure ,.3=. C%ic) the -K
=utton to +inish the .o%ume imort.
%.#.2 I3!orting ?olu3es
<he 3o%ume N Imort 3o%ume screenD shown in $i'ure ,.3dD is used to imort a sin'%e dis) or artition
that has =een +ormatted with a suorted +i%es:stem. $reeNA"1 suorts the imort o+ dis)s that ha.e
=een +ormatted with !$"D N<$"D M"(-"D or 47<2. <he imort is meant to =e a temorar: measure in
order to co: the data +rom a dis) to a .o%ume. -n%: one dis) can =e imorted at a time.
Figure %.#d: I3!orting a ?olu3e
Inut a name +or the .o%umeD use the dro;down menu to se%ect the dis) or artition that :ou wish to
imortD and se%ect the t:e o+ +i%es:stem on the dis).
#e+ore imortin' a dis)D =e aware o+ the +o%%owin' ca.eatsK
$reeNA"1 wi%% not imort a dirt: +i%es:stem. I+ a suorted +i%es:stem does not show in the
dro;down menuD :ou wi%% need to fsc9 or run a dis) chec) on the +i%es:stem.
$reeNA"1 can not imort d:namic N<$" .o%umes at this time. A +uture .ersion o+ $ree#"(
ma: address this issue.
i+ an N<$" .o%ume wi%% not imortD tr: eIectin' the .o%ume sa+e%: +rom a Windows s:stem. <his
wi%% +i5 some Iourna% +i%es that are reEuired to mount the dri.e.
%.#.# UFS ?olu3e 4anager
Whi%e the !$" +i%es:stem is suortedD it is not recommended as it does not ro.ide an: 0$" +eatures
such as comressionD encr:tionD dedu%icationD co:;on;writeD %i'htwei'ht snashotsD or the a=i%it: to
ro.ide ear%: detection and correction o+ corrut data. I+ :ou are usin' !$" as a temorar: so%ution
unti% :ou can a++ord =etter hardwareD note that :ou wi%% ha.e to destro: :our e5istin' !$" .o%ume in
order to create a 0$" oo%D then restore :our data +rom =ac)u.
N6*7: it is not recommended to create a !$" .o%ume %ar'er than *<# as it wi%% =e ine++icient to fsc9D
causin' %on' de%a:s at s:stem =oot i+ the s:stem was not shutdown c%ean%:.
<o +ormat :our dis)s with !$"D 'o to "tora'e N 3o%umes N !$" 3o%ume Mana'er A%e'ac:B which
wi%% oen the screen shown in $i'ure ,.3e.
Figure %.#e: 'reating a UFS ?olu3e
<a=%e ,.3a summari8es the a.ai%a=%e otions.
*a(le %.#a: 6!tions .en 'reating a UFS ?olu3e
3o%ume name strin'
mandator:R it is recommended to choose a name that wi%% stic) out in the
%o's Ae.'. not data or freenasB
Mem=er dis)s se%ection
use the mouse to se%ect the dis)AsB to =e usedR to se%ect mu%ti%e dis)sD
hi'h%i'ht the +irst dis)D then ho%d the shi+t )e: as :ou hi'h%i'ht the %ast dis).
"eci+:
custom ath
chec)=o5 otiona%R use+u% +or creatin' a 2#ar +or ersistent %o' stora'e
>ath strin'
on%: a.ai%a=%e when S*e'ify '!stom *ath is chec)edR must =e +u%% name o+
.o%ume Ae.'. 2mnt2#arB and i+ no ath is ro.idedD it wi%% aend the Bol!me
name to 2mnt
<he Add 3o%ume =utton warns that creati%# a 'ol!(e de$tro)$ all exi$ti%# data o% $elected di$0A$B. In
other wordsD creatin' stora'e usin' !$" 3o%ume Mana'er is a destructi.e action that re+ormats the
se%ected dis)s. I+ :our intent is to not o.erwrite the data on an e5istin' .o%umeD see i+ the .o%ume
+ormat is suorted =: the auto;imort or imort actions. I+ soD er+orm the suorted action instead. I+
the current stora'e +ormat is not suortedD :ou wi%% need to =ac)u the data to an e5terna% mediaD
+ormat the dis)sD then restore the data to the new .o%ume.
%.#.$ ;FS ?olu3e 4anager
I+ :ou ha.e un+ormatted dis)s or wish to o.erwrite the +i%es:stem Aand dataB on :our dis)sD use the 0$"
3o%ume Mana'er to +ormat the desired dis)s into a 0$" oo%.
I+ :ou are new to RAI( concets or wou%d %i)e an o.er.iew o+ the di++erences =etween hardware RAI(
and 0$" RAI(0ZD s)im throu'h the section on Hardware Recommendations =e+ore usin' 0$" 3o%ume
Mana'er.
I+ :ou c%ic) on "tora'e N 3o%umes N 0$" 3o%ume Mana'erD :ou wi%% see a screen simi%ar to the
e5am%e shown in $i'ure ,.3+.
Figure %.#f: 'reating a ;FS Pool Using ?olu3e 4anager
,.3= summari8es the con+i'uration otions o+ this screen.
*a(le %.#(: 6!tions .en 'reating a ;FS ?olu3e
3o%ume name strin'
0$" .o%umes must con+orm to these namin' con.entionsR it is
recommended to choose a name that wi%% stic) out in the %o's Ae.'. %ot
data or freenasB
3o%ume to
e5tend
dro;down
menu
reEuires an e5istin' 0$" oo% to e5tendR see 45tendin' a 0$" 3o%ume
+or instructions
4ncr:tion chec)=o5 read the section on 4ncr:tion =e+ore choosin' to use encr:tion
A.ai%a=%e
dis)s
dis%a:
dis%a:s the si8e o+ a.ai%a=%e dis)sR ho.er o.er sho: to %ist the a.ai%a=%e
de.ice names
3o%ume
%a:out
dra' and dro c%ic) and dra' the icon to se%ect the desired num=er o+ dis)s
Add 45tra
(e.ice
=utton
se%ect to con+i'ure mu%ti%e oo%s or to add %o' or cache de.ices durin'
oo% creation
<o con+i'ure the oo%D dra' the s%ider to se%ect the desired num=er o+ dis)s. <he 0$" 3o%ume Mana'er
wi%% automatica%%: se%ect the otima% con+i'uration and the resu%tin' stora'e caacit:D which ta)es swa
into accountD wi%% =e dis%a:ed. I+ :ou wish to chan'e the %a:out or the num=er o+ dis)sD use the mouse
to dra' the s%ider to the desired .o%ume %a:out. <he dro;down menu showin' the otima%
con+i'uration can a%so =e c%ic)ed to chan'e the con+i'urationD thou'h the 2!I wi%% turn red i+ the
se%ected con+i'uration is not recommended.
N6*7: +or er+ormance and caacit: reasonsD this screen wi%% not a%%ow :ou to create a .o%ume +rom
dis)s o+ di++erin' si8es. Whi%e it is not recommendedD it is ossi=%e to create a .o%ume in this situation
=: usin' the OManua% setuP =utton and +o%%owin' the instructions in Manua% 3o%ume Creation.
0$" 3o%ume Mana'er wi%% a%%ow :ou to sa.e sa.e a non;otima% con+i'uration. It wi%% sti%% wor)D =ut
wi%% er+orm %ess e++icient%: than an otima% con+i'uration. Howe.erD the 2!I wi%% not a%%ow :ou to
se%ect a con+i'uration i+ the num=er o+ dis)s se%ected is not enou'h to create that con+i'uration. C%ic)
the too% ti icon to access a %in) to this documentation.
<he Add 3o%ume =utton warns that creati%# a 'ol!(e -ill de$tro)$ a%) exi$ti%# data o% the $elected
di$0A$B. In other wordsD creatin' a new .o%ume re+ormats the se%ected dis)s. I+ :our intent is to not
o.erwrite the data on an e5istin' .o%umeD see i+ the .o%ume +ormat is suorted =: the auto;imort or
imort actions. I+ soD er+orm the suorted action instead. I+ the current stora'e +ormat is not
suortedD :ou wi%% need to =ac)u the data to an e5terna% mediaD +ormat the dis)sD then restore the data
to the new .o%ume.
<he 0$" 3o%ume Mana'er wi%% automatica%%: se%ect the otima% %a:out +or the new oo%D deendin'
uon the num=er o+ dis)s se%ected. <he +o%%owin' +ormats are suortedK
Stri!e: reEuires at %east one dis)
4irror: reEuires at %east two dis)s
2AI8;1: reEuires at %east three dis)s
2AI8;2: reEuires at %east +our dis)s
2AI8;#: reEuires at %east +i.e dis)s
log de,ice: add a dedicated %o' de.ice As%o'B
cace de,ice: add a dedicated cache de.ice
I+ :ou ha.e more than +i.e dis)s and are usin' 0$"D consider the num=er o+ dis)s to use +or =est
er+ormance and sca%a=i%it:. An o.er.iew o+ the .arious RAI( %e.e%s and recommended dis) 'rou
si8es can =e +ound in the RAI( -.er.iew section. More in+ormation a=out %o' and cache de.ices can
=e +ound in the 0$" -.er.iew section.
(eendin' uon the si8e and num=er o+ dis)sD the t:e o+ contro%%erD and whether or not encr:tion is
se%ectedD creatin' the .o%ume ma: ta)e some time. -nce the .o%ume is createdD the screen wi%% re+resh
and the new .o%ume wi%% =e %isted under "tora'e N 3o%umes.
(.3.!.1 *ncr-tion
#e'innin' with 6.3.1D $reeNA"1 suorts 249I +u%% dis) encr:tion when creatin' 0$" .o%umes. It is
imortant to understand the +o%%owin' when considerin' whether or not encr:tion is ri'ht +or :our
$reeNA"1 s:stemK
<his is %ot the encr:tion method used =: -rac%e 0$".30. <hat .ersion o+ 0$" has not =een
oen sourced and is the roert: o+ -rac%e.
<his is +u%% dis) encr:tion and %ot er;+i%es:stem encr:tion. <he under%:in' dri.es are +irst
encr:tedD then the oo% is created on to o+ the encr:ted de.ices.
<his t:e o+ encr:tion is rimari%: tar'eted at users who store sensiti.e data and want to retain
the a=i%it: to remo.e dis)s +rom the oo% without ha.in' to +irst wie the dis)'s contents.
<his desi'n is on%: suita=%e +or sa+e disosa% o+ dis)s indeendent o+ the encr:tion )e:. As
%on' as the )e: and the dis)s are intactD the s:stem is .u%nera=%e to =ein' decr:ted. <he )e:
shou%d =e rotected =: a stron' asshrase and an: =ac)us o+ the )e: shou%d =e secure%:
stored.
-n the other handD i+ the )e: is %ostD the data on the dis)s is inaccessi=%e. A%wa:s =ac)u the
)e:S
I4P62*AN* N6*7: the er;dri.e 249I master )e:s are not =ac)ed u a%on' with with the user
)e:s. I+ a =it error occurs in the %ast sector o+ an encr:ted dis)D this ma: mean the data on that dis) is
com%ete%: %ost. !nti% this issue is reso%.edD it is imortant to read this +orum ost which e5%ains how
to =ac) u :our master )e:s manua%%:. <his +orum ost 'i.es an in;deth e5%anation o+ how the
.arious )e: t:es are used =: 249I. <o trac) +uture ro'ress on this issueD re+er to this =u' reort.
<he encr:tion )e: is er 0$" .o%ume Aoo%B. I+ :ou create mu%ti%e oo%sD each oo% has its
own encr:tion )e:.
I+ the s:stem has a %ot o+ dis)sD there wi%% =e a er+ormance hit i+ the C>! does not suort
A4";NI or i+ no cr:to hardware is insta%%ed. Without hardware acce%erationD there wi%% =e a=out
a 20L er+ormance hit +or a sin'%e dis). >er+ormance de'radation wi%% continue to increase with
more dis)s. As data is writtenD it is automatica%%: encr:ted and as data is readD it is decr:ted
on the +%:. I+ the rocessor does suort the A4";NI instruction setD there shou%d =e .er: %itt%eD i+
an:D de'radation in er+ormance when usin' encr:tion. <his +orum ost comares the
er+ormance o+ .arious C>!s.
(ata in the ARC cache and the contents o+ RAM are unencr:ted.
"wa is a%wa:s encr:tedD e.en on unencr:ted .o%umes.
<here is no wa: to con.ert an e5istin'D unencr:ted .o%ume. InsteadD the data must =e =ac)ed
uD the e5istin' oo% must =e destro:edD a new encr:ted .o%ume must =e createdD and the
=ac)u restored to the new .o%ume.
H:=rid oo%s are not suorted. In other wordsD new%: created .de.s must match the e5istin'
encr:tion scheme. When e5tendin' a .o%umeD 3o%ume Mana'er wi%% automatica%%: encr:t the
new .de. =ein' added to the e5istin' encr:ted oo%.
N6*7: the encr:tion +aci%it: used =: $reeNA"1 is desi'ned to rotect a'ainst h:sica% the+t o+ the
dis)s. It is not desi'ned to rotect a'ainst unauthori8ed so+tware access. 4nsure that on%: authori8ed
users ha.e access to the administrati.e 2!I and that roer ermissions are set on shares i+ sensiti.e
data stored on the s:stem.
Creating an *ncr-ted Volu&e
<o create an encr:ted .o%umeD chec) the O4ncr:tionP =o5 shown in $i'ure ,.3+. Inut the .o%ume
nameD se%ect the dis)s to add to the .o%umeD and c%ic) the Add 3o%ume =utton to ma)e the encr:ted
.o%ume.
-nce the .o%ume is createdD it i$ extre(el) i("orta%t to set a asshrase on the )e:D ma)e a =ac)u o+
the )e:D and create a reco.er: )e:. Without theseD it is imossi=%e to re;imort the dis)s at a %ater time.
<o er+orm these tas)sD 'o to "tora'e N 3o%umes ;V 3iew 3o%umes. <his screen is shown in $i'ure
,.3o.
<o set a asshrase on the )e:D c%ic) the .o%ume name and then the MCreate >asshraseM =utton Athe )e:
shaed icon in $i'ure ,.3oB. Fou wi%% =e romted to inut the assword used to access the $reeNA"1
administrati.e 2!ID and then to inut and reeat the desired asshrase. !n%i)e a asswordD a
asshrase can contain saces and is t:ica%%: a series o+ words. A 'ood asshrase is eas: to
remem=er A%i)e the %ine to a son' or iece o+ %iteratureB =ut hard to 'uess Aeo%e who )now :ou shou%d
not =e a=%e to 'uess the asshraseB.
When :ou set the asshraseD a warnin' messa'e wi%% remind :ou to create a new reco.er: )e: as a
new asshrase needs a new reco.er: )e:. <his wa:D i+ the asshrase is +or'ottenD the associated
reco.er: )e: can =e used instead. <o create the reco.er: )e:D c%ic) the MAdd reco.er: )e:M =utton
Asecond %ast )e: icon in $i'ure ,.3oB. <his screen wi%% romt :ou to inut the assword used to access
the $reeNA"1 administrati.e 2!I and then to se%ect the director: in which to sa.e the )e:. Note that
the reco.er: )e: is sa.ed to the c%ient s:stemD not on the $reeNA"1 s:stem.
$ina%%:D down%oad a co: o+ the encr:tion )e:D usin' the M(own%oad )e:M =utton Athe )e: icon with a
down arrow in $i'ure ,.3oB. A'ainD the encr:tion )e: is sa.ed to the c%ient s:stemD not on the
$reeNA"1 s:stem. Fou wi%% =e romted to inut the assword used to access the $reeNA"1
administrati.e 2!I =e+ore the se%ectin' the director: in which to store the )e:.
<he asshraseD reco.er: )e:D and encr:tion )e: need to =e rotected. (o not re.ea% the asshrase to
others. -n the s:stem containin' the down%oaded )e:sD ta)e care that that s:stem and its =ac)us are
rotected. An:one who has the )e:s has the a=i%it: to re;imort the dis)s shou%d the: =e discarded or
sto%en.
(.3.!.2 Manual Volu&e Creation
<he MManua% "etuM =utton shown in $i'ure ,.3+ can =e used to create a non;otima% 0$" .o%ume.
Whi%e this is %ot recommendedD it canD +or e5am%eD =e used to create a .o%ume containin' dis)s o+
di++erent si8es or to ut more than the recommended num=er o+ dis)s into a .de..
N6*7: when usin' dis)s o+ di++erin' si8esD the .o%ume is %imited =: the si8e o+ the sma%%est dis).
When usin' more dis)s than are recommended +or a .de.D :ou increase resi%.erin' time and the ris)
that more than the a%%owa=%e num=er o+ dis)s wi%% +ai% =e+ore a resi%.er com%etes. $or these reasonsD it
is recommended to instead %et the 0$" 3o%ume Mana'er create an otima% oo% +or :ouD as descri=ed in
0$" 3o%ume Mana'erD usin' same;si8e dis)s.
$i'ure ,.3' shows the MManua% "etuM screen and <a=%e ,.3c summari8es the a.ai%a=%e otions.
Figure %.#g: 'reating a Non>6!ti3al ;FS ?olu3e
*a(le %.#c: 4anual Setu! 6!tions
3o%ume name strin'
0$" .o%umes must con+orm to these namin' con.entionsR it is
recommended to choose a name that wi%% stic) out in the %o's Ae.'. %ot
data or freenasB
4ncr:tion chec)=o5 read the section on 4ncr:tion =e+ore choosin' to use encr:tion
Mem=er dis)s %ist hi'h%i'ht desired num=er o+ dis)s +rom %ist o+ a.ai%a=%e dis)s
(edu%ication
dro;down
menu
choices are @ffD BerifyD and @nR care+u%%: consider the section on
(edu%ication =e+ore chan'in' this settin'
0$" 45tra
=u%%et
se%ection
used to seci+: i+ dis) is used +or stora'e AMNoneMBD a %o' de.iceD a cache
de.iceD or a sare
%.#." 7-tending a ;FS ?olu3e
<he O3o%ume to e5tendP dro;down menu in "tora'e N 3o%umes N 0$" 3o%ume Mana'erD shown in
$i'ure ,.3hD can =e used to add additiona% dis)s to an e5istin' 0$" .o%ume. <his dro;down emt: wi%%
=e emt: i+ an e5istin' 0$" .o%ume does not e5ist.
Figure %.#: ?olu3e to 7-tend Field
N6*7: i+ the e5istin' .o%ume is encr:tedD a warnin' messa'e wi%% remind :ou that the oeration o+
e5tendin' a .o%ume wi%% reset the asshrase and reco.er: )e:. A+ter e5tendin' the .o%umeD :ou shou%d
immediate%: recreate =oth.
-nce an e5istin' .o%ume has =een se%ected +rom the dro;down menuD dra' and dro the desired
dis)AsB and se%ect the desired .o%ume %a:out. $or e5am%e :ou canK
se%ect an ""( or dis) with a .o%ume %a:out o+ ;og EF8;G to add a %o' de.ice to the 0$" oo%.
"e%ectin' 2 ""(s or dis)s wi%% mirror the %o' de.ice.
se%ect an ""( or dis) with a .o%ume %a:out o+ "a'he E;2A&"G to add a cache de.ice to the 0$"
oo%.
add additiona% dis)s to increase the caacit: o+ the 0$" oo%. <he ca.eats to doin' this are
descri=ed =e%ow.
When addin' dis)s to increase the caacit: o+ a .o%umeD 0$" suorts the addition o+ .irtua% de.icesD
)nown as .de.sD to an e5istin' 0$" oo%. A .de. can =e a sin'%e dis)D a strieD a mirrorD a RAI(01D
RAI(02D or a RAI(03. O%ce a 'de' i$ created/ )o! ca% %ot add (ore dri'e$ to that 'de' R howe.erD
:ou can strie a new .de. Aand its dis)sB with the $a(e t)"e o* exi$ti%# 'de' in order to increase the
o.era%% si8e o+ 0$" the oo%. In other wordsD when :ou e5tend a 0$" .o%umeD :ou are rea%%: striin'
simi%ar .de.s. Here are some e5am%esK
to e5tend a 0$" strieD add one or more dis)s. "ince there is no redundanc:D :ou do not ha.e to
add the same amount o+ dis)s as the e5istin' strie.
to e5tend a 0$" mirrorD add the same num=er o+ dri.es. <he resu%tin' stried mirror is a RAI(
10. $or e5am%eD i+ :ou ha.e 10 dri.esD :ou cou%d start =: creatin' a mirror o+ two dri.esD
e5tendin' this mirror =: creatin' another mirror o+ two dri.esD and reeatin' three more times
unti% a%% 10 dri.es ha.e =een added.
to e5tend a three dri.e RAI(01D add three additiona% dri.es. <he resu%t is a RAI(0X0D simi%ar
to RAI( *0 on a hardware contro%%er.
to e5tend a RAI(02 reEuires a minimum o+ +our additiona% dri.es. <he resu%t is a RAI(02X0D
simi%ar to RAI( ,0 on a hardware contro%%er.
I+ :ou tr: to add an incorrect num=er o+ dis)s to the e5istin' .de.D an error messa'e wi%% aearD
indicatin' the num=er o+ dis)s that are needed. Fou wi%% need to se%ect the correct num=er o+ dis)s in
order to continue.
%.#.% 'reating ;FS 8atasets
An e5istin' 0$" .o%ume can =e di.ided into datasets. >ermissionsD comressionD dedu%icationD and
Euotas can =e set on a er dataset =asisD a%%owin' more 'ranu%ar contro% o.er access to stora'e data. A
dataset is simi%ar to a +o%der in that :ou can set ermissionsR it is a%so simi%ar to a +i%es:stem in that :ou
can set roerties such as Euotas and comression as we%% as create snashots.
N6*7: 0$" ro.ides thic) ro.isionin' usin' Euotas and thin ro.isionin' usin' reser.ed sace.
I+ :ou se%ect an e5istin' 0$" .o%ume N Create 0$" (atasetD :ou wi%% see the screen shown in $i'ure
,.3i.
-nce a dataset is createdD :ou can c%ic) on that dataset and se%ect Create 0$" (atasetD thus creatin' a
nested datasetD or a dataset within a dataset. Fou can a%so create a 8.o% within a dataset. When creatin'
datasetsD dou=%e;chec) that :ou are usin' the Create 0$" (ataset otion +or the intended .o%ume or
dataset. I+ :ou 'et con+used when creatin' a dataset on a .o%umeD c%ic) a%% e5istin' datasets to c%ose
them;;the remainin' Create 0$" (ataset wi%% =e +or the .o%ume.
Figure %.#i: 'reating a ;FS 8ataset
<a=%e ,.3d summari8es the otions a.ai%a=%e when creatin' a 0$" dataset. "ome settin's are on%:
a.ai%a=%e in Ad.anced Mode. <o see these settin'sD either c%ic) the Ad.anced Mode =utton or con+i'ure
the s:stem to a%wa:s dis%a: these settin's =: chec)in' the =o5 O"how ad.anced +ie%ds =: de+au%tP in
":stem N "ettin's N Ad.anced. <hese attri=utes can a%so =e chan'ed a+ter dataset creation in "tora'e
N 3o%umes N 3iew 3o%umes.
*a(le %.#d: ;FS 8ataset 6!tions
(ataset Name strin' mandator:
Comression 9e.e%
dro;down
menu
see Comression +or a comarison o+ the a.ai%a=%e a%'orithms
4na=%e atime
InheritD -nD
or -++
contro%s whether the access time +or +i%es is udated when the: are
readR settin' this roert: to @ff a.oids roducin' %o' tra++ic when
readin' +i%es and can resu%t in si'ni+icant er+ormance 'ains
?uota +or this
dataset
inte'er
on%: a.ai%a=%e in Ad.anced ModeR de+au%t o+ 0 is o++R can seci+: M
Ame'a=:teBD 2 A'i'a=:teBD or < Atera=:teB as in 20H +or 20 2#D can
a%so inc%ude a decima% oint Ae.'. 2.6HB
?uota +or this
dataset and a%%
chi%dren
inte'er
on%: a.ai%a=%e in Ad.anced ModeR de+au%t o+ 0 is o++R can seci+: M
Ame'a=:teBD 2 A'i'a=:teBD or < Atera=:teB as in 20H +or 20 2#
Reser.ed sace +or
this dataset
inte'er
on%: a.ai%a=%e in Ad.anced ModeR de+au%t o+ 0 is un%imited A=esides
hardwareBR can seci+: M Ame'a=:teBD 2 A'i'a=:teBD or < Atera=:teB
as in 20H +or 20 2#
Reser.ed sace +or
this dataset and a%%
chi%dren
inte'er
on%: a.ai%a=%e in Ad.anced ModeR de+au%t o+ 0 is un%imited A=esides
hardwareBR can seci+: M Ame'a=:teBD 2 A'i'a=:teBD or < Atera=:teB
as in 20H +or 20 2#
0$" (edu%ication
dro;down
menu
read the section on dedu%ication =e+ore ma)in' a chan'e to this
settin'
Record "i8e
dro;down
menu
on%: a.ai%a=%e in Ad.anced ModeR whi%e 0$" automatica%%: adats
the record si8e d:namica%%: to adat to dataD i+ the data has a +i5ed
si8e Ae.'. a data=aseBD settin' the &e'ord Si/e ma: resu%t in =etter
er+ormance
(.3.(.1 Dedulication
<he FFS ed!*li'ation otion warns that ena=%in' dedu ma: ha.e drastic er+ormance im%ications
and that comression shou%d =e used instead. #e+ore chec)in' the dedu%ication =o5D read the section
on dedu%ication in the 0$" -.er.iew +irst. <his artic%e ro.ides a 'ood descrition o+ the .a%ue ..s.
cost considerations +or dedu%ication.
U%le$$ )o! ha'e a lot o* RAM a%d a lot o* d!"licate data/ do %ot cha%#e the de*a!lt ded!"licatio%
$etti%# o* CO**D. <he dedu ta=%es used durin' dedu%ication need Y6 2# o+ RAM er 1<# o+ data to
=e dedu%icated. $or er+ormance reasonsD consider usin' comression rather than turnin' this otion
on.
I+ dedu%ication is chan'ed to @nD du%icate data =%oc)s are remo.ed s:nchronous%:. <he resu%t is that
on%: uniEue data is stored and common comonents are shared amon' +i%es. I+ dedu%ication is chan'ed
to BerifyD 0$" wi%% do a =:te;to;=:te comarison when two =%oc)s ha.e the same si'nature to ma)e
sure that the =%oc) contents are identica%. "ince hash co%%isions are e5treme%: rareD .eri+: is usua%%: not
worth the er+ormance hit.
N6*7: once dedu%ication is ena=%edD the on%: wa: to disa=%e it is to use the =fs set dedu!Doff
dataset:na3e command +rom "he%%. Howe.erD an: data that is a%read: stored as dedu%icated wi%% not
=e un;dedu%icated as on%: new%: stored data a+ter the roert: chan'e wi%% not =e dedu%icated. <he
on%: wa: to remo.e e5istin' dedu%icated data is to co: a%% o+ the data o++ o+ the datasetD set the
roert: to o++D then co: the data =ac) in a'ain. A%ternate%:D create a new dataset with the FFS
ed!*li'ation %e+t as disa=%edD co: the data to the new datasetD and destro: the ori'ina% dataset.
(.3.(.2 Co&ression
Most media Ae.'. .m*+D .m*4D .a#iB is a%read: comressedD meanin' that :ou wi%% increase C>!
uti%i8ation +or no 'ain i+ :ou store these +i%es on a comressed dataset. Howe.erD i+ :ou ha.e raw .:a#
ris o+ C(s or .#o$ ris o+ (3(sD :ou wi%% see a er+ormance 'ain usin' a comressed dataset. When
se%ectin' a comression t:eD :ou need to =a%ance er+ormance with the amount o+ comression. <he
+o%%owin' comression a%'orithms are suortedK
l=$: recommended comression method as it a%%ows comressed datasets to oerate at near rea%;
time seed.
g=i!: .aries +rom %e.e%s 1 to 9 where g/i* fastest A%e.e% 1B 'i.es the %east comression and g/i*
ma(im!m A%e.e% 9B ro.ides the =est comression =ut is discoura'ed due to its er+ormance
imact.
=le: +ast and sim%e a%'orithm to e%iminate runs o+ 8eroes.
l=@(: ro.ides decent data comressionD =ut is considered derecated as %8& ro.ides much
=etter er+ormance.
I+ :ou %ea.e the de+au%t o+ 8nheritD the dataset wi%% inherit +rom the arent. !n%ess the arent dataset has
=een modi+iedD its de+au%t comression %e.e% is l/4.
I+ :ou se%ect @ffD comression wi%% not =e used on the dataset.
%.#.) 'reating a =,ol
A 8.o% is a +eature o+ 0$" that creates a =%oc) de.ice o.er 0$". <his a%%ows :ou to use a 8.o% as an
i"C"I de.ice e5tent.
<o create a 8.o%D se%ect an e5istin' 0$" .o%ume or dataset N Create 8.o% which wi%% oen the screen
shown in $i'ure ,.3I.
<he con+i'uration otions are descri=ed in <a=%e ,.3e. "ome settin's are on%: a.ai%a=%e in Ad.anced
Mode. <o see these settin'sD either c%ic) the Ad.anced Mode =utton or con+i'ure the s:stem to a%wa:s
dis%a: these settin's =: chec)in' the =o5 O"how ad.anced +ie%ds =: de+au%tP in ":stem N "ettin's N
Ad.anced.
Figure %.#@: 'reating a =,ol
*a(le %.#e: =,ol 'onfiguration 6!tions
8.o% Name strin' inut a name +or the 8.o%
"i8e +or this 8.o% inte'er seci+: si8e and .a%ue such as 10H
Comression
%e.e%
dro;down
menu
de+au%t o+ 8nherit means it wi%% use the same comression %e.e% as
the e5istin' 8oo% used to create the 8.o%
"arse .o%ume chec)=o5
used to ro.ide thin ro.isionin'R i+ this otion is se%ectedD writes
wi%% +ai% when the oo% is %ow on sace
#%oc) si8e inte'er
on%: a.ai%a=%e in Ad.anced ModeR .a%id si8e is an: ower o+ 2
+rom *12= to 126)= with a de+au%t si8e o+ 6)=R can =e set to match
the =%oc) si8e o+ the +i%es:stem which wi%% =e +ormatted onto the
i"C"I tar'et
%.#.8 ?ie0ing 8is9s
"tora'e N 3o%umes N 3iew (is)s a%%ows :ou to .iew a%% o+ the dis)s reco'ni8ed =: the $reeNA"1
s:stem. An e5am%e is shown in $i'ure ,.3).
Figure %.#9: ?ie0ing 8is9s
$or each de.iceD the current con+i'uration o+ the otions descri=ed in <a=%e ,.3e is dis%a:ed. C%ic) a
dis)'s entr: and then its 4dit =utton to chan'e its con+i'uration.
C%ic)in' a dis)'s entr: wi%% a%so dis%a: its Wie =utton which can =e used to =%an) a dis) whi%e
ro.idin' a ro'ress =ar o+ the wie's status. !se this otion =e+ore discardin' a dis).
N6*7: shou%d a dis)'s seria% num=er not =e dis%a:ed in this screenD use the s3artctl command within
"he%%. $or e5am%eD to determine the seria% num=er o+ dis) ada0D t:e s3artctl >a Ede,Eada0 L gre!
Serial.
%.#.9 ?ie0ing ?olu3es
I+ :ou c%ic) "tora'e N 3o%umes N 3iew 3o%umesD :ou can .iew and +urther con+i'ure e5istin'
.o%umesD 0$" datasetsD and 8.o%s. <he e5am%e shown in $i'ure ,.3% demonstrates one 0$" .o%ume
with two datasets and one 8.o%.
#uttons are ro.ided to ro.ide Euic) access to 0$" 3o%ume Mana'erD !$" 3o%ume Mana'erD Imort
3o%umeD Auto Imort 3o%umeD and 3iew (is)s. I+ the s:stem has mu%tiath;caa=%e hardwareD an e5tra
=utton wi%% =e added to 3iew Mu%tiaths.
Figure %.#l: ?ie0ing ?olu3es
I+ :ou c%ic) the entr: +or a 0$" .o%umeD ei'ht icons wi%% aear at the =ottom o+ the screen. In order
+rom %e+t to ri'htD these icons a%%ow :ou toK
1. 8etac ?olu3e: a%%ows :ou to either detach a dis) =e+ore remo.in' it +rom the s:stem Aa%so
)nown as a 0$" e5ortB or to de%ete the contents o+ the .o%umeD deendin' uon the choice :ou
ma)e in the screen that os u when :ou c%ic) this =utton. <he o;u messa'eD seen in $i'ure
,.3mD wi%% show the current used saceD ro.ide the chec) =o5 OMar) the dis)s as new Adestro:
dataBPD romt :ou to ma)e sure that :ou want to do thisD warn :ou i+ the .o%ume has an:
associated shares and as) i+ :ou wish to de%ete themD and the =rowser wi%% turn red to a%ert :ou
that :ou are a=out to do somethin' that wi%% ma)e the data inaccessi=%e. 1* )o! do %ot chec0 the
box to (ar0 the di$0$ a$ %e-/ the 'ol!(e -ill be ex"orted AFS 'ol!(e$ o%l)B. <his means
that the data is not destro:ed and the .o%ume can =e re;imorted at a %ater time. I+ :ou wi%% =e
mo.in' a 0$" dri.e +rom one s:stem to anotherD er+orm this e5ort action +irst. <his oeration
+%ushes an: unwritten data to dis)D writes data to the dis) indicatin' that the e5ort was doneD
and remo.es a%% )now%ed'e o+ the oo% +rom the s:stem. 1* )o! do chec0 the box to (ar0 the
di$0$ a$ %e-/ the 'ol!(e a%d all o* it$ data/ data$et$/ a%d .'ol$ -ill be de$tro)ed a%d the
!%derl)i%# di$0$ -ill be ret!r%ed to their ra- $tate.
2. Scru( ?olu3e: 0$" scru=s and how to schedu%e them are descri=ed in more detai% in 0$"
"cru=s. <his =utton a%%ows :ou to manua%%: initiate a scru=. A scru= is I@- intensi.e and can
ne'ati.e%: imact er+ormanceD meanin' that :ou shou%d not initiate one whi%e the s:stem is
=us:. A cance% =utton is ro.ided shou%d :ou need to cance% a scru=.
N6*7: i+ :ou do cance% a scru=D the ne5t scru= wi%% start o.er +rom the =e'innin'D not where the
cance%%ed scru= %e+t o++.
Figure %.#3: 8etacing or 8eleting a ?olu3e
3. 7dit ;FS 6!tions: a%%ows :ou to edit the .o%ume's comression %e.e%D atime settin'D dataset
EuotaD and reser.ed sace +or Euota. I+ comression is new%: ena=%ed on a .o%ume or dataset
that a%read: contains dataD e5istin' +i%es wi%% not =e comressed unti% the: are modi+ied as
comression is on%: a%ied when a +i%e is written.
$. 'reate ;FS 8ataset: a%%ows :ou to create a dataset.
". 'reate =,ol: a%%ows :ou to create a 8.o% to use as an i"C"I de.ice e5tent.
,. 'ange Per3issions: a%%ows :ou to edit the .o%ume's userD 'rouD !ni5 rw5 ermissionsD t:e
o+ AC9D and to ena=%e recursi.e ermissions on the .o%ume's su=directories.
/. 'reate Sna!sot: a%%ows :ou to con+i'ure the snashot's name and whether or not it is
recursi.e =e+ore manua%%: creatin' a one;time snashot. I+ :ou wish to schedu%e the re'u%ar
creation o+ snashotsD instead create a eriodic snashot tas).
6. ?olu3e Status: as seen in the e5am%e in $i'ure ,.3nD this screen shows the de.ice name and
status o+ each dis) in the 0$" oo% as we%% as an: readD writeD or chec)sum errors. It a%so
indicates the status o+ the %atest 0$" scru=. I+ :ou c%ic) the entr: +or a de.iceD =uttons wi%%
aear to edit the de.ice's otions Ashown in $i'ure ,.3oBD o++%ine the de.iceD or re%ace the
de.ice Aas descri=ed in Re%acin' a $ai%ed (ri.eB.
Figure %.#n: ?olu3e Status
I+ :ou c%ic) a dis) in 3o%ume "tatus and c%ic) its O4dit (is)P =uttonD :ou wi%% see the screen shown in
$i'ure ,.3o. <a=%e ,.3+ summari8es the con+i'ura=%e otions.
Figure %.#o: 7diting a 8is9
*a(le %.#f: 8is9 6!tions
Name strin' read;on%: .a%ue showin' $ree#"( de.ice name +or dis)
"eria% strin' read;on%: .a%ue showin' the dis)'s seria% num=er
H(( "tand=:
dro;down
menu
indicates the time o+ inacti.it: Ain minutesB =e+ore the
dri.e enters stand=: mode in order to conser.e ener':R
this +orum ost demonstrates how to determine i+ a dri.e
has sun down
Ad.anced >ower
Mana'ement
dro;down
menu
de+au%t is isa$ledD can se%ect a ower mana'ement
ro+i%e +rom the menu
Acoustic 9e.e%
dro;down
menu
de+au%t is isa$ledD can =e modi+ied +or dis)s that
understand AAM
4na=%e ".M.A.R.< chec)=o5
ena=%ed =: de+au%t i+ the dis) suorts ".M.A.R.<.R
unchec)in' this =o5 wi%% disa=%e an: con+i'ured
".M.A.R.<. <ests +or the dis)
".M.A.R.<. e5tra otions strin' smartct%A6B otions
N6*7: .ersions o+ $reeNA"1 rior to 6.3.1 reEuired a re=oot in order to a%: chan'es to the H((
"tand=:D Ad.anced >ower Mana'ementD and Acoustic 9e.e% settin's. As o+ 6.3.1D chan'es to these
settin's are a%ied immediate%:.
A 0$" dataset on%: has +i.e icons as the scru= .o%umeD create 0$" .o%umeD and .o%ume status =uttons
on%: a%: to .o%umes. In a datasetD the (etach 3o%ume =utton is re%aced with the (estro: (ataset
=utton. I+ :ou c%ic) the (estro: (ataset =uttonD the =rowser wi%% turn red to indicate that this is a
destructi.e action. <he o;u warnin' messa'e wi%% warn that destro:in' the dataset wi%% de%ete a%% o+
the +i%es and snashots o+ that dataset.
(.3.0.1 1e- Manage&ent for *ncr-ted Volu&es
I+ :ou chec) the O4na=%e +u%% dis) encr:tionP =o5 durin' the creation o+ a 0$" .o%umeD +i.e
encr:tion icons wi%% =e added to the icons that are t:ica%%: seen when .iewin' a .o%ume. An e5am%e
is seen in $i'ure ,.3.
Figure %.#!: 7ncr+!tion Icons Associated 0it an 7ncr+!ted ;FS ?olu3e
<hese icons are used toK
'reateE'ange Pass!rase: c%ic) this icon to set and con+irm the asshrase associated with the
249I encr:tion )e:. Re(e(ber thi$ "a$$"hra$e a$ )o! ca% %ot re&i("ort a% e%cr)"ted 'ol!(e
-itho!t it. In other wordsD i+ :ou +or'et the asshraseD it is ossi=%e +or the data on the .o%ume to
=ecome inaccessi=%e. An e5am%e wou%d =e a +ai%ed !"# stic) that reEuires a new insta%%ation on a new
!"# stic) and a re;imort o+ the e5istin' oo%D or the h:sica% remo.a% o+ dis)s when mo.in' +rom an
o%der hardware s:stem to a new s:stem. >rotect this asshrase as an:one who )nows it cou%d re;
imort :our encr:ted .o%umeD thus thwartin' the reason +or encr:tin' the dis)s in the +irst %ace.
When :ou c%ic) this iconD a red warnin' is dis%a:edK &emem$er to add a ne: re'o#ery key as this
FreeNAS 9.2.1 Users Guide Page 1#0 of 280
a'tion in#alidates the *re#io!s re'o#ery key. "ettin' a asshrase in.a%idates the e5istin' )e:. -nce
:ou set the asshraseD immediate%: c%ic) the Add re'o#ery key =utton to create a new reco.er: )e:.
-nce the asshrase is setD the name o+ this icon wi%% chan'e to Chan'e >asshrase.
8o0nload 1e+: c%ic) this icon to down%oad a =ac)u co: o+ the 249I encr:tion )e:. "ince the
249I encr:tion )e: is searate +rom the $reeNA"1 con+i'uration data=aseD it i$ hi#hl)
reco((e%ded to (a0e a bac0!" o* the 0e). 1* the 0e) i$ e'er) lo$t or de$tro)ed a%d there i$ %o
bac0!" 0e)/ the data o% the di$0$ i$ i%acce$$ible.
7ncr+!tion 2e>9e+: 'enerates a new 249I encr:tion )e:. <:ica%%: this is on%: er+ormed when the
administrator susects that the current )e: ma: =e comromised. <his action a%so remo.es the current
asshrase.
Add reco,er+ 9e+: 'enerates a new reco.er: )e: and romts +or a %ocation to down%oad a =ac)u
co: o+ the reco.er: )e:. <his reco.er: )e: can =e used i+ the asshrase is +or'otten. Al-a)$
i((ediatel) add a reco.er: )e: whene.er the asshrase is chan'ed.
2e3o,e reco,er 9e+: <:ica%%: this is on%: er+ormed when the administrator susects that the current
reco.er: )e: ma: =e comromised. 1((ediatel) create a new asshrase and reco.er: )e:.
4ach o+ these icons wi%% romt +or the assword used to access the $reeNA"1 administrati.e 2!I.
%.#.10 Setting Per3issions
"ettin' ermissions is an imortant asect o+ con+i'urin' .o%umes. <he 'rahica% administrati.e
inter+ace is meant to set the i%itial ermissions +or a .o%ume or dataset in order to ma)e it a.ai%a=%e as a
share. -nce a share is a.ai%a=%eD the c%ient oeratin' s:stem shou%d =e used to +ine;tune the ermissions
o+ the +i%es and directories that are created =: the c%ient.
"harin' contains con+i'uration e5am%es +or se.era% t:es o+ ermission scenarios. <his section
ro.ides an o.er.iew o+ the screen that is used to set ermissions.
-nce a .o%ume or dataset is createdD it wi%% =e %isted =: its mount oint name in "tora'e N 3o%umes N
3iew 3o%umes. I+ :ou c%ic) the Chan'e >ermissions icon +or a seci+ic .o%ume@datasetD :ou wi%% see the
screen shown in $i'ure ,.3E. <a=%e ,.3' summari8es the otions in this screen.
Figure %.#B: 'anging Per3issions on a ?olu3e or 8ataset
*a(le %.#g: 6!tions .en 'anging Per3issions
-wner AuserB
dro;down
menu
user to contro% the .o%ume@datasetR users which were manua%%: created or
imorted +rom Acti.e (irector: or 9(A> wi%% aear in dro;down menu
-wner A'rouB
dro;down
menu
'rou to contro% the .o%ume@datasetR 'rous which were manua%%: created
or imorted +rom Acti.e (irector: or 9(A> wi%% aear in dro;down
Mode chec)=o5es chec) the desired U%ix ermissions +or userD 'rouD and other
<:e o+ AC9
=u%%et
se%ection
!ni5 and Windows AC9s are mutua%%: e5c%usi.eD this means that +ou
3ust select te correct t+!e of A'< to 3atc te sareR see the
ara'rahs =e%ow this <a=%e +or more detai%s
"et ermission
recursi.e%:
chec)=o5
i+ chec)edD ermissions wi%% a%so a%: to su=directories o+ the .o%ume or
datasetR i+ data a%read: e5ists on the .o%ume@datasetD it i$ reco((e%ded
to i%$tead cha%#e the "er(i$$io%$ rec!r$i'el) o% the clie%t $ide to
"re'e%t a "er*or(a%ce la# o% the FreeNAS $)$te(
When in dou=tD or i+ :ou ha.e a mi5 o+ oeratin' s:stems in :our networ)D se%ect !ni5 AC9s as a%%
c%ients understand them. Windows AC9s are aroriate when the networ) contains on%: Windows
c%ients and are the re+erred otion within an Acti.e (irector: domain. Windows AC9s add a suerset
o+ ermissions that au'ment those ro.ided =: !ni5 AC9s. Whi%e Windows c%ients a%so understand
!ni5 AC9sD the: won't =ene+it +rom the e5tra ermissions ro.ided =: Acti.e (irector: and Windows
AC9s when !ni5 AC9s are used.
I+ :ou chan'e :our mind a=out the t:e o+ AC9D :ou do not ha.e to recreate the .o%ume. <hat isD
e5istin' data is not %ost i+ the t:e o+ AC9 is chan'ed. Howe.erD i+ :ou chan'e +rom Windows AC9s to
!ni5 AC9sD the e5tended ermissions ro.ided =: Windows AC9s wi%% =e remo.ed +rom the e5istin'
+i%es.
When :ou se%ect Windows AC9sD the <ode wi%% =ecome 're:ed out as it on%: a%ies to !ni5
ermissions. <he de+au%t Windows AC9s are a%wa:s set to what Windows sets on new +i%es and
directories =: de+au%t. <he Windows c%ient shou%d then =e used to +ine;tune the ermissions as reEuired.
%.#.11 ?ie0ing 4ulti!ats
$reeNA"1 uses 'mu%tiathA6B to ro.ide mu%tiath I@- suort on s:stems containin' hardware that is
caa=%e o+ mu%tiath. An e5am%e wou%d =e a dua% "A" e5ander =ac)%ane in the chassis or an
e5terna% C#-(.
Mu%tiath hardware adds +au%t to%erance to a NA" as the data is sti%% a.ai%a=%e e.en i+ one dis) I@- ath
has a +ai%ure.
$reeNA"1 automatica%%: detects acti.e@acti.e and acti.e@assi.e mu%tiath;caa=%e hardware. An:
mu%tiath;caa=%e de.ices that are detected wi%% =e %aced in mu%tiath units with the arent de.ices
hidden. <he con+i'uration wi%% =e dis%a:ed in "tora'e N 3o%umes N 3iew Mu%tiathsD as seen in the
e5am%e in $i'ure ,.3r. Note that this otion wi%% not =e dis%a:ed in the "tora'e N 3o%umes tree on
s:stems that do not contain mu%tiath;caa=%e hardware.
Figure %.#r: ?ie0ing 4ulti!ats
$i'ure ,.3E ro.ides an e5am%e o+ a s:stem with a "A" 0I9 and a "A" hard dri.e. <he 0I9 de.ice is
caa=%e o+ acti.e@acti.e writesD whereas the hard dri.e is caa=%e o+ acti.e@read.
%.#.12 2e!lacing a Failed 8ri,e
I+ :ou are usin' an: +orm o+ redundant RAI(D :ou shou%d re%ace a +ai%ed dri.e as soon as ossi=%e to
reair the de'raded state o+ the RAI(. (eendin' uon the caa=i%it: o+ :our hardwareD :ou ma: or
ma: not need to re=oot in order to re%ace the +ai%ed dri.e. AHCI caa=%e hardware does not reEuire a
re=oot.
FreeNAS 9.2.1 Users Guide Page 1## of 280
N6*7: a strie ARAI(0B does not ro.ide redundanc:. I+ :ou %ose a dis) in a strieD :ou wi%% need to
recreate the .o%ume and restore the data +rom =ac)u.
#e+ore h:sica%%: remo.in' the +ai%ed de.iceD 'o to "tora'e N 3o%umes N 3iew 3o%umes N 3o%ume
"tatus and %ocate the +ai%ed dis). -nce :ou ha.e %ocated the +ai%ed de.ice in the 2!ID er+orm the
+o%%owin' stesK
1. I+ the dis) is +ormatted with 0$"D c%ic) the dis)'s entr: then its O-++%ineP =utton in order to
chan'e that dis)'s status to -$$9IN4. <his ste is needed to roer%: remo.e the de.ice +rom
the 0$" oo% and to re.ent swa issues. I+ :our hardware suorts hot;%u''a=%e dis)sD c%ic)
the dis)'s O-++%ineP =uttonD u%% the dis)D then s)i to ste 3. I+ there is no O-++%ineP =utton =ut
on%: a ORe%aceP =uttonD then the dis) is a%read: o++%ined and :ou can sa+e%: s)i this ste.
N6*7: i+ the rocess o+ chan'in' the dis)'s status to -$$9IN4 +ai%s with a Odis) o++%ine +ai%ed ; no
.a%id re%icasP messa'eD :ou wi%% need to scru= the 0$" .o%ume +irst usin' its "cru= 3o%ume =utton in
"tora'e N 3o%umes N 3iew 3o%umes. -nce the scru= com%etesD tr: to -++%ine the dis) a'ain =e+ore
roceedin'.
2. I+ the hardware is not AHCI caa=%eD shutdown the s:stem in order to h:sica%%: re%ace the
dis). When +inishedD return to the 2!I and %ocate the -$$9IN4 dis).
3. -nce the dis) is showin' as -$$9IN4D c%ic) the dis) a'ain and then c%ic) its ORe%aceP =utton.
"e%ect the re%acement dis) +rom the dro;down menu and c%ic) the ORe%ace (is)P =utton. I+
the dis) is a mem=er o+ an encr:ted 0$" oo%D :ou wi%% =e romted to inut the asshrase
+or the oo%. -nce :ou c%ic) the ORe%ace (is)P =uttonD the 0$" oo% wi%% start to resi%.er. Fou
can use the =!ool status command in "he%% to monitor the status o+ the resi%.erin'.
&. I+ the re%aced dis) continues to =e %isted a+ter resi%.erin' is com%eteD c%ic) its entr: and use the
O(etachP =utton to remo.e the dis) +rom the %ist.
In the e5am%e shown in $i'ure ,.3sD a +ai%ed dis) is =ein' re%aced =: dis) ada2 in the .o%ume named
#ol!me1.
FreeNAS 9.2.1 Users Guide Page 1#$ of 280
Figure %.#s: 2e!lacing a Failed 8is9
(.3.12.1 "elacing a #ailed Drive in an *ncr-ted /ool
I+ the 0$" oo% is encr:tedD additiona% stes are needed when re%acin' a +ai%ed dri.e.
$irstD ma)e sure that a asshrase has =een set be*ore attemtin' to re%ace the +ai%ed dri.e. <henD
+o%%ow the stes 1 and 2 as descri=ed a=o.e. (urin' ste 3D :ou wi%% =e romted to inut the
asshrase +or the oo%. Wait unti% the resi%.erin' is com%ete.
Ne5tD restore the encr:tion )e:s to the oo%. 1* the *ollo-i%# additio%al $te"$ are %ot "er*or(ed
be*ore the %ext reboot/ )o! (a) lo$e acce$$ to the "ool "er(a%e%tl).
1. Hi'h%i'ht the oo% that contains the dis) :ou Iust re%aced and c%ic) the O4ncr:tion Re;)e:P
=utton in the 2!I. Fou wi%% need to enter the root assword.
2. Hi'h%i'ht the oo% that contains the dis) :ou Iust re%aced and c%ic) the OCreate >asshraseP
=utton and enter the new asshrase. Fou can reuse the o%d asshrase i+ desired.
3. Hi'h%i'ht the oo% that contains the dis) :ou Iust re%aced and c%ic) the O(own%oad Ke:P =utton
FreeNAS 9.2.1 Users Guide Page 1#" of 280
in order to sa.e the new encr:tion )e:. "ince the o%d )e: wi%% no %on'er +unctionD an: o%d )e:s
can =e sa+e%: discarded.
&. Hi'h%i'ht the oo% that contains the dis) :ou Iust re%aced and c%ic) the OAdd Reco.er: Ke:P
=utton in order to sa.e the new reco.er: )e:. <he o%d reco.er: )e: wi%% no %on'er +unctionD so it
can =e sa+e%: discarded.
(.3.12.2 "e&oving a +og or Cache Device
I+ :ou ha.e added an: %o' or cache de.icesD these de.ices wi%% a%so aear in "tora'e N 3o%umes N
3iew 3o%umes N 3o%ume "tatus. I+ :ou c%ic) the de.iceD :ou can either use its MRe%aceM =utton to
re%ace the de.ice as descri=ed a=o.eD or c%ic) its MRemo.eM =utton to remo.e the de.ice.
#e+ore er+ormin' either o+ these oerationsD .eri+: the .ersion o+ 0$" runnin' on the s:stem =:
runnin' =!ool u!grade >,L3ore +rom "he%%.
I+ the oo% is runnin' 0$".1*D and a non;mirrored %o' de.ice +ai%sD is re%acedD or remo.edD the oo% is
unreco.era=%e and the oo% must =e recreated and the data restored +rom a =ac)u. $or other 0$"
.ersionsD remo.in' or re%acin' the %o' de.ice wi%% %ose an: data in the de.ice which had not :et =een
written. <his is t:ica%%: the %ast +ew seconds o+ writes.
Remo.in' or re%acin' a cache de.ice wi%% not resu%t in an: data %ossD =ut ma: ha.e an imact on read
er+ormance unti% the de.ice is re%aced.
%.#.1# 2e!lacing 8ri,es to Gro0 a ;FS Pool
<he recommended method +or e5andin' the si8e o+ a 0$" oo% is to re;%an the num=er o+ dis)s in a
.de. and to strie additiona% .de.s usin' the 0$" 3o%ume Mana'er as additiona% caacit: is needed.
Howe.erD this is not an otion i+ :ou do not ha.e oen dri.e orts or the a=i%it: to add a "A"@"A<A
H#A card. In this caseD :ou can re%ace one dis) at a time with a %ar'er dis)D wait +or the resi%.erin'
rocess to incororate the new dis) into the oo% com%etesD then reeat with another dis) unti% a%% o+
the dis)s ha.e =een re%aced. <his rocess is s%ow and %aces the s:stem in a de'raded state. "ince a
+ai%ure at this oint cou%d =e disastrousD do %ot atte("t thi$ (ethod !%le$$ the $)$te( ha$ a reliable
bac0!".
N6*7: this method reEuires the 0$" roert: autoe5and. <his roert: =ecame a.ai%a=%e startin'
with $reeNA"1 .ersion 6.3.0. I+ :ou are runnin' an ear%ier .ersion o+ $reeNA"1D u'rade =e+ore
attemtin' this method.
Chec) and .eri+: that the autoe5and roert: is ena=%ed be*ore attemtin' to 'row the oo%. I+ it is
notD the oo% wi%% not reco'ni8e that the dis) caacit: has increased. #: de+au%tD this roert: is ena=%ed
in $reeNA"1 .ersions 6.3.1 and hi'her. <o .eri+: the roert:D use "he%%. <his e5am%e chec)s the 0$"
.o%ume named Bol1K
zpool get all Vol1
NAME PROPERTY VALUE SOURCE
Vol1 size 4.53T -
Vol1 capacity 31% -
Vol1 altroot /mnt local
Vol1 health ONLINE -
Vol1 guid 8068631824452460057 default
FreeNAS 9.2.1 Users Guide Page 1#% of 280
Vol1 version 28 default
Vol1 bootfs - default
Vol1 delegation on default
Vol1 autoreplace off default
Vol1 cachefile /data/zfs/zpool.cache local
Vol1 failmode wait default
Vol1 listsnapshots off default
Vol1 autoexpand on local
Vol1 dedupditto 0 default
Vol1 dedupratio 1.00x -
Vol1 free 3.12T -
Vol1 allocated 1.41T -
Vol1 readonly off -
Vol1 comment - default
I+ autoe5ansion is not ena=%edD ena=%e it =: seci+:in' the name o+ the 0$" .o%umeK
zpool set autoexpand=on Vol1
3eri+: that autoe5and is now ena=%ed =: reeatin' =!ool get all ?ol1.
Fou are now read: to re%ace one dri.e with a %ar'er dri.e usin' the instructions in Re%acin' a $ai%ed
(ri.e.
Re%ace one dri.e at a time and wait +or the resi%.er rocess to com%ete on the re%aced dri.e =e+ore
re%acin' the ne5t dri.e. -nce a%% the dri.es are re%aced and the resi%.er com%etesD :ou shou%d see the
added sace in the oo%.
Fou can .iew the status o+ the resi%.er rocess =: runnin' =!ool status ?ol1.
(.3.13.1 *nabling .#S /ool *2ansion After Drive "elace&ent
It is recommended to ena=%e the autoe5and roert: =e+ore :ou start re%acin' dri.es. I+ the roert:
is not ena=%ed =e+ore re%acin' some or a%% o+ the dri.esD e5tra con+i'uration is needed to in+orm 0$" o+
the e5anded caacit:.
3eri+: that autoe5and is set as descri=ed in the re.ious section. <henD =rin' each o+ the dri.es =ac)
on%ine with the +o%%owin' commandD re%acin' the .o%ume name and 2>< I( +or each dis) in the 0$"
oo%K
zpool online -e Vol1 gptid/xxx
-n%ine one dri.e at a time and chec) the status usin' the +o%%owin' e5am%e. I+ a dri.e starts to resi%.erD
:ou need to wait +or the resi%.er to com%ete =e+ore roceedin' to on%ine the ne5t dri.e.
<o +ind the 2>< I( in+ormation +or the dri.esD use =!ool status MPool:Na3eN which wi%% a%so show
:ou i+ an: dri.es are +ai%ed or in the rocess o+ =ein' resi%.eredK
zpool status Vol1
pool: Vol1
state: ONLINE
scan: scrub repaired 0 in 16h24m with 0 errors on Sun Mar 10 17:24:20 2013
config:
Vol1 ONLINE 0 0 0
raidz1-0 ONLINE 0 0 0
FreeNAS 9.2.1 Users Guide Page 1#) of 280
gptid/d5ed48a4-634a-11e2-963c-00e081740bfe ONLINE 0 0 0
gptid/03121538-62d9-11e2-99bd-00e081740bfe ONLINE 0 0 0
gptid/252754e1-6266-11e2-8088-00e081740bfe ONLINE 0 0 0
gptid/9092045a-601d-11e2-892e-00e081740bfe ONLINE 0 0 0
gptid/670e35bc-5f9a-11e2-92ca-00e081740bfe ONLINE 0 0 0

A+ter on%inin' a%% o+ the dis)sD t:e =!ool status to see i+ the dri.es start to resi%.er. I+ this haensD
wait +or the resi%.erin' rocess to com%ete.
Ne5tD e5ort and then imort the oo%K
zpool export Vol1
zpool import -R /mnt Vol1
-nce the imort com%etesD a%% o+ the dri.e sace shou%d =e a.ai%a=%e. 3eri+: that the increased si8e is
reco'ni8edK
zpool list Vol1
NAME SIZE ALLOC FREE CAP DEDUP HEALTH ALTROOT
Vol1 9.06T 1.41T 7.24T 31% 1.00x ONLINE /mnt
I+ :ou cannot see the e5tra saceD :ou ma: need to run =!ool online >e O!oolP Ode,iceP +or e.er:
de.ice %isted in =!ool status.
%.#.1$ S!litting a 4irrored ;FS Storage Pool
0$".26 ro.ides the a=i%it: to to s%it a (irrored stora'e oo%D which detaches a dis) or dis)s in the
ori'ina% 0$" .o%ume in order to create another identica% 0$" .o%ume on another s:stem.
N6*7: 8oo% s%it on%: wor)s on mirrored 0$" .o%umes.
In this e5am%eD a 0$" mirror named test contains three dri.esK
zpool status
pool: test
state: ONLINE
scan: resilvered 568K in 0h0m with 0 errors on Wed Jul 6 16:10:58 2011
config:
test ONLINE 0 0 0
mirror-0 ONLINE 0 0 0
da1 ONLINE 0 0 0
da0 ONLINE 0 0 0
da4 ONLINE 0 0 0
<he +o%%owin' command s%its +rom the e5istin' three dis) mirror test a new 0$" .o%ume named
migrant containin' one dis)D da4. (is)s da0 and da1 remain in test.
zpool split test migrant da4
At this ointD da4 can =e h:sica%%: remo.ed and insta%%ed to a new s:stem as the new oo% is e5orted
as it is created. -nce h:sica%%: insta%%edD imort the identica% oo% on the new s:stemK
zpool import migrant
<his ma)es the 0$" .o%ume migrant a.ai%a=%e with a sin'%e dis). #e aware that roerties come a%on'
with the c%oneD so the new oo% wi%% =e mounted where the o%d oo% was mounted i+ the mountoint
roert: was set on the ori'ina% oo%.
3eri+: the status o+ the new oo%K
zpool status
pool: migrant
state: ONLINE
config:
migrant ONLINE 0 0 0
da4 ONLINE 0 0 0
-n the ori'ina% s:stemD the status now %oo)s %i)e thisK
zpool status
pool: test
state: ONLINE
config:
test ONLINE 0 0 0
da1 ONLINE 0 0 0
da0 ONLINE 0 0 0
At this ointD it is recommended to add dis)s to create a +u%% mirror set. <his e5am%e adds two dis)s
named da2 and da+K
zpool attach migrant da4 da2
zpool attach migrant da4 da3
<he migrant .o%ume now %oo)s %i)e thisK
zpool status
pool: migrant
state: ONLINE
config:
migrant ONLINE 0 0 0
da4 ONLINE 0 0 0
da2 ONLINE 0 0 0
da3 ONLINE 0 0 0
Now that the new s:stem has =een c%onedD :ou can detach da4 and insta%% it =ac) to the ori'ina% s:stem.
#e+ore h:sica%%: remo.in' the dis)D run this command on the new s:stemK
zpool detach migrant da4
-nce the dis) is h:sica%%: re;insta%%edD run this command on the ori'ina% s:stemK
zpool attach orig da0 da4
"hou%d :ou e.er need to create a new c%oneD remem=er to remo.e the o%d c%one +irstK
zpool destroy migrant
%.$ ;FS Scru(s
"tora'e N 0$" "cru=s a%%ows :ou to schedu%e and mana'e scru=s on a 0$" .o%ume. >er+ormin' a 0$"
scru= on a re'u%ar =asis he%s to identi+: data inte'rit: ro=%emsD detects si%ent data corrutions caused
=: transient hardware issuesD and ro.ides ear%: a%erts to dis) +ai%ures. I+ :ou ha.e consumer;Eua%it:
dri.esD consider a wee)%: scru==in' schedu%e. I+ :ou ha.e datacenter;Eua%it: dri.esD consider a month%:
scru==in' schedu%e.
(eendin' uon the amount o+ dataD a scru= can ta)e a %on' time. "cru=s are I@- intensi.e and can
ne'ati.e%: imact er+ormance. <he: shou%d =e schedu%ed +or e.enin's or wee)ends to minimi8e the
imact to users.
A 0$" scru= on%: chec)s used dis) sace. <o chec) unused dis) saceD schedu%e a ".M.A.R.<. <est
?y*e o+ ;ong Self-?est to run once or twice a month.
When :ou create a .o%ume that is +ormatted with 0$"D a 0$" scru= is automatica%%: schedu%ed +or :ou.
An entr: o+ the same .o%ume name is added to "tora'e N 0$" "cru=s and a summar: o+ this entr: can
=e .iewed in "tora'e N 0$" "cru=s N 3iew 0$" "cru=s. $i'ure ,.&a dis%a:s the de+au%t settin's +or
the .o%ume named #ol!me1. <a=%e ,.&a summari8es the otions in this screen.
Figure %.$a: ?ie0ing a ?olu3e/s 8efault Scru( Settings
FreeNAS 9.2.1 Users Guide Page 1$0 of 280
*a(le %.$a: ;FS Scru( 6!tions
3o%ume dro;down menu se%ect 0$" .o%ume to scru=
<hresho%d
da:s
inte'er
num=er o+ da:s since the %ast scru= com%eted =e+ore the ne5t scru=
can occurD re'ard%ess o+ the ca%endar schedu%eR the de+au%t is a
mu%ti%e o+ / which shou%d ensure that the scru= a%wa:s occurs on the
same da: o+ the wee)
Minute
s%ider or minute
se%ections
i+ use the s%iderD scru= occurs e.er: N minutesR i+ use minute
se%ectionsD scru= starts at the hi'h%i'hted minutes
Hour
s%ider or hour
se%ections
i+ use the s%iderD scru= occurs e.er: N hoursR i+ use hour se%ectionsD
scru= occurs at the hi'h%i'hted hours
(a: o+ Month
s%ider or month
se%ections
i+ use the s%iderD scru= occurs e.er: N da:sR i+ use month se%ectionsD
scru= occurs on the hi'h%i'hted da:s o+ the se%ected months
Month chec)=o5es scru= occurs on the se%ected months
(a: o+ wee) chec)=o5es
scru= occurs on the se%ected da:sR de+au%t is S!nday to %east imact
users
4na=%ed chec)=o5 unchec) to disa=%e the schedu%ed scru= without de%etin' it
Fou shou%d re.iew the de+au%t se%ections andD i+ necessar:D modi+: them to meet the needs o+ :our
en.ironment.
Whi%e a de%ete =utton is ro.idedD deleti%# a $cr!b i$ %ot reco((e%ded a$ a $cr!b "ro'ide$ a% earl)
i%dicatio% o* di$0 i$$!e$ that co!ld lead to a di$0 *ail!re. I+ :ou +ind that a scru= is too intensi.e +or
:our hardwareD consider disa=%in' the scru= as a temorar: measure unti% the hardware can =e
u'raded.
I+ :ou do de%ete a scru=D :ou can create a new scru= tas) =: c%ic)in' "tora'e N 3o%umes N 0$"
"cru=s N Add 0$" "cru=.
) Saring 'onfiguration
-nce :ou ha.e a .o%umeD create at %east one share so that the stora'e is accessi=%e =: the other
comuters in :our networ). <he t:e o+ share :ou create deends uon the oeratin' s:stemAsB runnin'
in :our networ)D :our securit: reEuirementsD and e5ectations +or networ) trans+er seeds.
N6*7: shares are created to ro.ide and contro% access to an area o+ stora'e. #e+ore creatin' :our
sharesD it is recommended to ma)e a %ist o+ the users that wi%% need access to stora'e dataD which
oeratin' s:stems these users are usin'D whether or not a%% users shou%d ha.e the same ermissions to
the stored dataD and whether or not these users shou%d authenticate =e+ore accessin' the data. <his
in+ormation can he% :ou determine which t:e o+ shareAsB :ou need to createD whether or not :ou need
to create mu%ti%e datasets in order to di.ide u the stora'e into areas with di++erin' access and
ermission reEuirementsD and how com%e5 it wi%% =e to setu :our ermission reEuirements. It shou%d
=e noted that a share is used to ro.ide access to data. I+ :ou de%ete a shareD it remo.es access to data
=ut does not de%ete the data itse%+.
<he +o%%owin' t:es o+ shares and ser.ices are a.ai%a=%eK
A!!le HAFPF SaresK the A%e $i%e >rotoco% AA$>B t:e o+ share is a 'ood choice i+ a%% o+ :our
comuters run Mac -" 7.
Uni- HNFSF SaresK the Networ) $i%e ":stem AN$"B t:e o+ share is accessi=%e =: Mac -" 7D 9inu5D
#"(D and the ro+essiona%@enterrise .ersions Anot the home editionsB o+ Windows. It is a 'ood choice
i+ there are man: di++erent oeratin' s:stems in :our networ). (eendin' uon the oeratin' s:stemD it
ma: reEuire the insta%%ation or con+i'uration o+ c%ient so+tware on the des)to.
.indo0s H'IFSF SaresK the Common Internet $i%e ":stem ACI$"B t:e o+ share is accessi=%e =:
WindowsD Mac -" 7D 9inu5D and #"( comutersD =ut it is s%ower than an N$" share due to the sin'%e;
threaded desi'n o+ "am=a. It ro.ides more con+i'uration otions than N$" and is a 'ood choice on a
networ) containin' on%: Windows s:stems. Howe.erD it is a oor choice i+ the C>! on the $reeNA"1
s:stem is %imitedR i+ :our C>! is ma5ed outD :ou need to u'rade the C>! or consider another t:e o+
share.
I+ :ou are %oo)in' +or a so%ution that a%%ows +ast access +rom an: oeratin' s:stemD consider
con+i'urin' the $<> ser.ice instead o+ a share and use a cross;%at+orm $<> and +i%e mana'er c%ient
a%ication such as $i%e8i%%a. "ecure $<> can =e con+i'ured i+ the data needs to =e encr:ted.
I+ data securit: is a concern and :our networ)'s users are +ami%iar with ""H command %ine uti%ities or
Win"C>D consider con+i'urin' the ""H ser.ice instead o+ a share. It wi%% =e s%ower than unencr:ted
$<> due to the o.erhead o+ encr:tionD =ut the data assin' throu'h the networ) wi%% =e encr:ted.
N6*7: whi%e the 2!I wi%% %et :ou do itD it is a =ad idea to share the same .o%ume or dataset usin'
mu%ti%e t:es o+ access methods. (i++erent t:es o+ shares and ser.ices use di++erent +i%e %oc)in'
methods. $or e5am%eD i+ the same .o%ume is con+i'ured to use =oth N$" and $<>D N$" wi%% %oc) a +i%e
+or editin' =: an N$" userD =ut a $<> user can simu%taneous%: edit or de%ete that +i%e. <his wi%% resu%t in
%ost edits and con+used users. Another e5am%eK i+ a .o%ume is con+i'ured +or =oth A$> and CI$"D
Windows users ma: =e con+used =: the e5tra +i%enames used =: Mac +i%es and de%ete the ones the:
don't understandR this wi%% corrut the +i%es on the A$> share. >ic) the one t:e o+ share or ser.ice that
ma)es the most sense +or the t:es o+ c%ients that wi%% access that .o%umeD and con+i'ure that .o%ume
+or that one t:e o+ share or ser.ice. I+ :ou need to suort mu%ti%e t:es o+ sharesD di.ide the .o%ume
into datasets and use one dataset er share.
<his section wi%% demonstrate how to create A$>D N$"D and CI$" shares. $<> and ""H con+i'urations
are descri=ed in "er.ices Con+i'uration.
).1 A!!le HAFPF Sares
$reeNA"1 uses the Netata%) A$> ser.er to share data with A%e s:stems. Con+i'urin' A$> shares is
a mu%ti;ste rocess that reEuires :ou to create or imort users and 'rousD set .o%ume@dataset
ermissionsD create the A$> shareAsBD con+i'ure the A$> ser.iceD then ena=%e the A$> ser.ice in
"er.ices N Contro% "er.ices.
<his section descri=es the con+i'uration screen +or creatin' the A$> share. It then ro.ides
con+i'uration e5am%es +or creatin' a 'uest shareD con+i'urin' <ime Machine to =ac)u to a dataset on
the $reeNA"1 s:stemD and +or connectin' to the share +rom a Mac -" 7 c%ient.
).1.1 'reating AFP Sares
I+ :ou c%ic) "harin' N A%e AA$>B "hares N Add A%e AA$>B "hareD :ou wi%% see the screen shown
in $i'ure /.1a. "ome settin's are on%: a.ai%a=%e in Ad.anced Mode. <o see these settin'sD either c%ic)
the Ad.anced Mode =utton or con+i'ure the s:stem to a%wa:s dis%a: these settin's =: chec)in' the
=o5 O"how ad.anced +ie%ds =: de+au%tP in ":stem N "ettin's N Ad.anced.
<a=%e /.1a summari8es the a.ai%a=%e otions when creatin' an A$> share. Re+er to "ettin' u Netata%)
+or a more detai%ed e5%anation o+ the a.ai%a=%e otions. -nce :ou ress the -K =utton when creatin'
the A$> shareD a o;u menu wi%% as) OWou%d :ou %i)e to ena=%e this ser.iceUP C%ic) Fes and "er.ices
N Contro% "er.ices wi%% oen and indicate whether or not the A$> ser.ice success+u%%: started.
Figure ).1a: 'reating an AFP Sare
*a(le ).1a: AFP Sare 'onfiguration 6!tions
Name strin'
.o%ume name that wi%% aear in the Mac comuter's Oconnect to
ser.erP dia%o'ueR %imited to 2/ characters and can not contain a
eriod
"hare Comment strin' otiona%
>ath =rowse =utton =rowse to the .o%ume@dataset to share
A%%ow 9ist strin'
comma de%imited %ist o+ a%%owed users and@or 'rous where
'rouname =e'ins with a T
FreeNAS 9.2.1 Users Guide Page 1$# of 280
(en: 9ist strin'
comma de%imited %ist o+ denied users and@or 'rous where
'rouname =e'ins with a T
Read;on%:
Access
strin'
comma de%imited %ist o+ users and@or 'rous who on%: ha.e read
access where 'rouname =e'ins with a T
Read;write
Access
strin'
comma de%imited %ist o+ users and@or 'rous who ha.e read and write
access where 'rouname =e'ins with a T
<ime Machine chec)=o5
due to a %imitation in how Mac dea%s with %ow;dis)sace issues when
mu%ti%e Mac's share the same .o%umeD chec)in' ?ime <a'hine on
mu%ti%e shares is discoura'ed as it ma: resu%t in intermittent +ai%ed
=ac)us
(ata=ase >ath strin'
seci+: the ath to store the CNI( data=ases used =: A$> Ade+au%t is
the root o+ the .o%umeBR the ath must =e writa=%e
0ero (e.ice
Num=ers
chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR ena=%e when the de.ice num=er is
not constant across a re=oot
No "tat chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD A$> won't stat the
.o%ume ath when enumeratin' the .o%umes %istR use+u% +or
automountin' or .o%umes created =: a ree5ec scrit
A$>3 !NI7
>ri.s
chec)=o5
ena=%es !ni5 ri.i%e'es suorted =: -"7 10.* and hi'herR do not
ena=%e i+ the networ) contains Mac -" 7 10.& c%ients or %ower as
the: do not suort these
(e+au%t +i%e
ermission
chec)=o5es
on%: wor)s with !ni5 AC9sR new +i%es created on the share are set
with the se%ected ermissions
(e+au%t director:
ermission
chec)=o5es
on%: wor)s with !ni5 AC9sR new directories created on the share are
set with the se%ected ermissions
(e+au%t umas) inte'er
umas) +or new%: created +i%esD de+au%t is 000 Aan:one can readD writeD
and e5ecuteB
).1.2 'onnecting to AFP Sares As Guest
A$> suorts 'uest %o'insD meanin' that a%% o+ :our Mac -" 7 users can access the A$> share without
reEuirin' their user accounts to +irst =e created on or imorted into the the $reeNA"1 s:stem.
N6*7: i+ :ou create a 'uest share as we%% a share that reEuires authenticationD A$> wi%% on%: ma users
who %o'in as 'uest to the 'uest share. <his means that i+ a user %o's in to the share that reEuires
authenticationD the ermissions on the 'uest share ma: re.ent that user +rom writin' to the 'uest share.
<he on%: wa: to a%%ow =oth 'uest and authenticated users to write to a 'uest share is to set the
ermissions on the 'uest share to /// or to add the authenticated users to a 'uest 'rou and set the
ermissions to //5.
FreeNAS 9.2.1 Users Guide Page 1$$ of 280
In this con+i'uration e5am%eD the A$> share has =een con+i'ured +or 'uest access as +o%%owsK
1. A 0$" .o%ume named 2mnt2data has its ermissions set to the =ui%t;in no$ody user account and
no$ody 'rou.
2. An A$> share has =een created with the +o%%owin' attri=utesK
NameK freenas Athis is the name that wi%% aear to Mac -" 7 c%ientsB
>athK 2mnt2data
A%%ow 9istK set to no$ody
Read;write AccessK set to no$ody
3. "er.ices N A$> has =een con+i'ured as +o%%owsK
"er.er NameK freenas
2uest AccessK chec)=o5 is chec)ed
no$ody is se%ected in the 2uest account dro;down menu
-nce the A$> ser.ice has =een started in "er.ices N Contro% "er.icesD Mac -" 7 users can connect
to the A$> share =: c%ic)in' 2o N Connect to "er.er. In the e5am%e shown in $i'ure /.1=D the user
has inut af*)22 +o%%owed =: the I> address o+ the $reeNA"1 s:stem.
C%ic) the Connect =utton. -nce connectedD $inder wi%% automatica%%: oen. <he name o+ the A$> share
wi%% =e dis%a:ed in the "HAR4( section in the %e+t +rame and the contents o+ the share wi%% =e
dis%a:ed in the ri'ht +rame. In the e5am%e shown in $i'ure /.1cD 2mnt2data has one +o%der named
ima'es. <he user can now co: +i%es to and +rom the share.
Figure ).1(: 'onnect to Ser,er 8ialogue
FreeNAS 9.2.1 Users Guide Page 1$" of 280
Figure ).1c: ?ie0ing te 'ontents of te Sare Fro3 a 4ac S+ste3
<o disconnect +rom the .o%umeD c%ic) the eIect =utton in the "hared side=ar.
).1.# Using *i3e 4acine
Mac -" 7 inc%udes the <ime Machine a%ication which can =e used to schedu%e automatic =ac)us. In
this con+i'uration e5am%eD <ime Machine wi%% =e con+i'ured to =ac)u to an A$> share on a
$reeNA"1 s:stem. <o con+i'ure the A$> share on the $reeNA"1 s:stemK
1. A 0$" dataset named 2mnt2data2$a'k!*,!ser1 with a Euota o+ 50H was created in "tora'e N
3o%umes N Create 0$" (ataset.
2. A user account was created as +o%%owsK
!sernameK !ser1
Home (irector:K 2mnt2data2$a'k!*,!ser1
the $u%% NameD 4;mai%D and >assword +ie%ds were set where the !sername and >assword
match the .a%ues +or the user on the Mac -" 7 s:stem
3. An A$> share with a Name o+ $a'k!*,!ser1 has =een created with the +o%%owin' attri=utesK
>athK 2mnt2data2$a'k!*,!ser1
A%%ow 9istK set to !ser1
Read;write AccessK set to !ser1
<ime MachineK chec)=o5 is chec)ed
&. "er.ices N A$> has =een con+i'ured as +o%%owsK
FreeNAS 9.2.1 Users Guide Page 1$% of 280
"er.er NameK freenas
2uest AccessK chec)=o5 is unchec)ed
*. <he A$> ser.ice has =een started in "er.ices N Contro% "er.ices.
<o con+i'ure <ime Machine on the Mac -" 7 c%ientD 'o to ":stem >re+erences N <ime Machine which
wi%% oen the screen shown in $i'ure /.1e. C%ic) -N and a o;u menu shou%d show the $reeNA"1
s:stem as a =ac)u otion. In our e5am%eD it is %isted as $a'k!*,!ser1 on IfreenasI. Hi'h%i'ht the
entr: reresentin' the $reeNA"1 s:stem and c%ic) the O!se #ac)u (is)P =utton. A connection =ar
wi%% oen and wi%% romt +or the user account's assword;;in this e5am%eD the assword +or the !ser1
account.
<ime Machine wi%% create a +u%% =ac)u a+ter waitin' two minutes. It wi%% then create a one hour
incrementa% =ac)u +or the ne5t 2& hoursD and then one =ac)u each da:D each wee) and each month.
Si%ce the olde$t bac0!"$ are deleted -he% the FS data$et beco(e$ *!ll/ (a0e $!re that the E!ota
$i.e )o! $et i$ $!**icie%t to hold the bac0!"$. Note that a de+au%t insta%%ation o+ Mac -" 7 is Y21 2# in
si8e.
I+ :ou recei.e a O<ime Machine cou%d not com%ete the =ac)u. <he =ac)u dis) ima'e cou%d not =e
created Aerror &*BP error when =ac)in' u to the $reeNA"1 s:stemD :ou wi%% need to create a
sarse=und%e ima'e usin' these instructions.
I+ :ou recei.e the messa'e O<ime Machine com%eted a .eri+ication o+ :our =ac)us. <o imro.e
re%ia=i%it:D <ime Machine must create a new =ac)u +or :ou.P and :ou do not want to er+orm another
com%ete =ac)u or %ose ast =ac)usD +o%%ow the instructions in this ost. Note that this can occur a+ter
er+ormin' a scru= as <ime Machine ma: mista)en%: =e%ie.e that the sarse=und%e =ac)u is corrut.
FreeNAS 9.2.1 Users Guide Page 1$) of 280
Figure ).1e: 'onfiguring *i3e 4acine on 4ac 6S A <ion
).2 Uni- HNFSF Sares
$reeNA"1 suorts the Networ) $i%e ":stem AN$"B +or sharin' .o%umes o.er a networ). -nce the
N$" share is con+i'uredD c%ients use the 3ount command to mount the share. -nce mountedD the share
aears as Iust another director: on the c%ient s:stem. "ome 9inu5 distros reEuire the insta%%ation o+
additiona% so+tware in order to mount an N$" share. -n Windows s:stemsD ena=%e "er.ices +or N$" in
the !%timate or 4nterrise editions or insta%% an N$" c%ient a%ication.
N6*7: +or er+ormance reasonsD i"C"I is re+erred to N$" shares when $reeNA" is insta%%ed on
4"7i.
Con+i'urin' N$" is a mu%ti;ste rocess that reEuires :ou to create N$" shareAsBD con+i'ure N$" in
"er.ices N N$"D then start N$" in "er.ices N "er.ices. It does not reEuire :ou to create users or
'rous as N$" uses I> addresses to determine which s:stems are a%%owed to access the N$" share.
<his section demonstrates how to create an N$" shareD ro.ides a con+i'uration e5am%eD demonstrates
how to connect to the share +rom .arious oeratin' s:stemsD and ro.ides some trou=%eshootin' tis.
).2.1 'reating NFS Sares
<o create an N$" shareD c%ic) "harin' N !ni5 AN$"B "hares N Add !ni5 AN$"B "hareD shown in
$i'ure /.2a. <a=%e /.2a summari8es the otions in this screen.
Figure ).2a: 'reating an NFS Sare
-nce :ou ress the -K =utton when creatin' the N$" shareD a o;u menu wi%% as) OWou%d :ou %i)e
to ena=%e this ser.iceUP C%ic) Fes and "er.ices N Contro% "er.ices wi%% oen and indicate whether or
not the N$" ser.ice success+u%%: started.
*a(le ).2a: NFS Sare 6!tions
Comment strin'
used to set the share nameR i+ %e+t emt:D share name wi%% =e the %ist
o+ se%ected >aths
Authori8ed
networ)s
strin'
sace de%imited %ist o+ a%%owed networ) addresses in the +orm
1.2.3.0@2& where the num=er a+ter the s%ash is a CI(R mas)
Authori8ed I>
addresses or
hosts
strin' sace de%imited %ist o+ a%%owed I> addresses or hostnames
A%% directories chec)=o5 i+ chec)edD the c%ient can mount an: su=director: within the 1ath
Read on%: chec)=o5 rohi=its writin' to the share
?uiet chec)=o5
inhi=its some s:s%o' dia'nostics which can =e use+u% to a.oid some
anno:in' error messa'esR see e5ortsA*B +or e5am%es
Maroot !ser dro;down menu i+ a user is se%ectedD the root user is %imited to that user's ermissions
Maroot 2rou dro;down menu
i+ a 'rou is se%ectedD the root user wi%% a%so =e %imited to that
'rou's ermissions
Maa%% !ser dro;down menu the seci+ied user's ermissions are used =: a%% c%ients
Maa%% 2rou dro;down menu the seci+ied 'rou's ermission are used =: a%% c%ients
>ath =rowse =utton
=rowse to the .o%ume@dataset@director: to shareR c%ic) Add e(tra
*ath to se%ect mu%ti%e aths
When creatin' the N$" shareD )ee the +o%%owin' oints in mindK
1. <he Maroot and Maa%% otions are e5c%usi.eD meanin' :ou can on%: use one or the other;;the
2!I wi%% not %et :ou use =oth. <he Maa%% otions suersede the Maroot otions. I+ :ou on%:
wish to restrict the root user's ermissionsD set the Maroot otion. I+ :ou wish to restrict the
ermissions o+ a%% usersD set the Maa%% otion.
2. 4ach .o%ume or dataset is considered to =e its own +i%es:stem and N$" is not a=%e to cross
+i%es:stem =oundaries.
3. <he networ) or host must =e uniEue er share and er +i%es:stem or director:.
&. <he OA%% directoriesP otion can on%: =e used once er share er +i%es:stem.
<o =etter understand these restrictionsD consider the +o%%owin' scenario where there areK
2 networ)s named 10.0.0.026 and 20.0.0.026
a 0$" .o%ume named #ol!me1 with 2 datasets named dataset1 and dataset2
dataset1 has a director: named dire'tory1
#ecause o+ restriction J3D :ou wi%% recei.e an error i+ :ou tr: to create one N$" share as +o%%owsK
Autori=ed net0or9s: 10.0.0.026 20.0.0.026
Pat: 2mnt2#ol!me12dataset1 and @mnt2#ol!me12dataset12dire'tory1
InsteadD :ou shou%d se%ect the >ath o+ 2mnt2#ol!me12dataset1 and chec) the OA%% directoriesP =o5.
Howe.erD :ou cou%d restrict that director: to one o+ the networ)s =: creatin' two shares as +o%%ows.
$irst N$" shareK
Autori=ed net0or9s: 10.0.0.026
Pat: 2mnt2#ol!me12dataset1
"econd N$" shareK
Autori=ed net0or9s: 20.0.0.026
Pat: 2mnt2#ol!me12dataset12dire'tory1
Note that this reEuires the creation o+ two shares as it can not =e accom%ished in one share.
FreeNAS 9.2.1 Users Guide Page 1"0 of 280
).2.2 Sa3!le NFS Sare 'onfiguration
#: de+au%t the Maa%% otions shown in $i'ure /.2a show as N2A. <his means that when a user connects
to the N$" shareD the: connect with the ermissions associated with their user account. <his is a
securit: ris) i+ a user is a=%e to connect as root as the: wi%% ha.e com%ete access to the share.
A =etter scenario is to do the +o%%owin'K
1. "eci+: the =ui%t;in no$ody account to =e used +or N$" access.
2. In the ermissions o+ the .o%ume@dataset that is =ein' sharedD chan'e the owner and 'rou to
no$ody and set the ermissions accordin' to :our seci+ications.
3. "e%ect no$ody in the Maa%% !ser and Maa%% 2rou dro;down menus +or the share in "harin'
N !ni5 AN$"B "hares.
With this con+i'urationD it does not matter which user account connects to the N$" shareD as it wi%% =e
maed to the no$ody user account and wi%% on%: ha.e the ermissions that :ou seci+ied on the
.o%ume@dataset. $or e5am%eD e.en i+ the root user is a=%e to connectD it wi%% not 'ain root access to the
share.
).2.# 'onnecting to te NFS Sare
In the +o%%owin' e5am%esD an N$" share on a $reeNA"1 s:stem with the I> address o+ 142.156.2.2
has =een con+i'ured as +o%%owsK
1. A 0$" .o%ume named 2mnt2data has its ermissions set to the no$ody user account and the
no$ody 'rou.
2. A N$" share has =een created with the +o%%owin' attri=utesK
>athK 2mnt2data
Authori8ed Networ)K 142.156.2.0224
MaA%% !ser and MaA%% 2rou are =oth set to no$ody
the A%% (irectories chec)=o5 has =een chec)ed
3.2.3.1 #ro& BSD or +inu2 Clients
<o ma)e this share accessi=%e on a #"( or a 9inu5 s:stemD run the +o%%owin' command as the
sueruser Aor with sudoB +rom the c%ient s:stem. Reeat on each c%ient that needs access to the N$"
shareK
mount -t nfs 192.168.2.2:/mnt/data /mnt
<he 3ount command uses the +o%%owin' otionsK
>t nfs: seci+ies the t:e o+ share.
192.1%8.2.2: re%ace with the I> address o+ the $reeNA"1 s:stem
E3ntEdata: re%ace with the name o+ the N$" share
E3nt: a mount oint on the c%ient s:stem. <his must =e an e5istin'D e("t) director:. <he data in
the N$" share wi%% =e made a.ai%a=%e to the c%ient in this director:.
<he 3ount command shou%d return to the command romt without an: error messa'esD indicatin'
that the share was success+u%%: mounted.
-nce mountedD this con+i'uration a%%ows users on the c%ient s:stem to co: +i%es to and +rom 2mnt Athe
mount ointB and a%% +i%es wi%% =e owned =: no$ody)no$ody. An: chan'es to 2mnt wi%% =e sa.ed to the
$reeNA"1 s:stem's 2mnt2data .o%ume.
"hou%d :ou wish to ma)e an: chan'es to the N$" share's settin's or wish to ma)e the share
inaccessi=%eD +irst unmount the share on the c%ient as the sueruserK
umount /mnt
3.2.3.2 #ro& Microsoft Clients
Windows s:stems can connect to N$" shares usin' "er.ices +or N$" Are+er to the documentation +or
:our .ersion o+ Windows +or instructions on how to +indD acti.ateD and use this ser.iceB or a third;art:
N$" c%ient. Connectin' to N$" shares is o+ten +aster than connectin' to CI$" shares due to the sin'%e;
threaded %imitation o+ "am=a.
Instructions +or connectin' +rom an 4nterrise .ersion o+ Windows / can =e +ound at Mount 9inu5
N$" "hare on Windows /.
Ne)odri.e ro.ides an oen source 'rahica% N$" c%ient. <o use this c%ientD :ou wi%% need to insta%% the
+o%%owin' on the Windows s:stemK
/8i to e5tract the Ne)odri.e down%oad +i%es
N$"C%ient and N$"9i=rar: +rom the Ne)odri.e down%oad a'eR once down%oadedD e5tract these
+i%es usin' /8i
.N4< $ramewor) &.0
-nce e.er:thin' is insta%%edD run the N$"C%ient e5ecuta=%e to start the 2!I c%ient. In the e5am%e
shown in $i'ure /.2=D the user has connected to the e5am%e 2mnt2data share o+ the $reeNA"1 s:stem
at 142.156.2.2.
N6*7: Ne)odri.e does not suort 45%orer dri.e main' .ia N$". I+ :ou need this +unctiona%it:D tr:
this uti%it: instead.
Figure ).2(: Using te Ne9odri,e NFS'lient fro3 .indo0s ) &o3e 7dition
3.2.3.3 #ro& Mac 4S 5 Clients
<o mount the N$" .o%ume +rom a Mac -" 7 c%ientD c%ic) on 2o N Connect to "er.er. In the "er.er
Address +ie%dD inut nfs)22 +o%%owed =: the I> address o+ the $reeNA"1 s:stem and the name o+ the
.o%ume@dataset =ein' shared =: N$". <he e5am%e shown in $i'ure /.2c continues with our e5am%e o+
142.156.2.2)2mnt2data.
-nce connectedD $inder wi%% automatica%%: oen. <he I> address o+ the $reeNA"1 s:stem wi%% =e
dis%a:ed in the "HAR4( section in the %e+t +rame and the contents o+ the share wi%% =e dis%a:ed in
the ri'ht +rame. In the e5am%e shown in $i'ure /.2dD 2mnt2data has one +o%der named images. <he user
can now co: +i%es to and +rom the share.
FreeNAS 9.2.1 Users Guide Page 1"# of 280
Figure ).2c: 4ounting te NFS Sare fro3 4ac 6S A
Figure ).2d: ?ie0ing te NFS Sare in Finder
FreeNAS 9.2.1 Users Guide Page 1"$ of 280
).2.$ *rou(lesooting
"ome N$" c%ients do not suort the N9M ANetwor) 9oc) Mana'erB rotoco% used =: N$". Fou wi%%
)now that this is the case i+ the c%ient recei.es an error that a%% or art o+ the +i%e ma: =e %oc)ed when a
+i%e trans+er is attemted. <o reso%.e this errorD add the otion >o noloc9 when runnin' the 3ount
command on the c%ient in order to a%%ow write access to the N$" share.
I+ :ou recei.e an error a=out a Otime out 'i.in' uP when tr:in' to mount the share +rom a 9inu5
s:stemD ma)e sure that the ortmaer ser.ice is runnin' on the 9inu5 c%ient and start it i+ it is not. I+
ortmaer is runnin' and :ou sti%% recei.e timeoutsD +orce it to use <C> =: inc%udin' >o tc! in :our
3ount command.
I+ :ou recei.e an error OR>CK >ro'ram not re'isteredPD u'rade to the %atest .ersion o+ $reeNA"1 and
restart the N$" ser.ice a+ter the u'rade in order to c%ear the N$" cache.
I+ :our c%ients are recei.in' Ore.erse (N"P or errorsD add an entr: +or the I> address o+ the $reeNA"1
s:stem in the OHost name data=aseP +ie%d o+ Networ) N 2%o=a% Con+i'uration.
I+ the c%ient recei.es timeout errors when tr:in' to mount the shareD add the I> address and hostname o+
the c%ient to the MHost name data =aseM +ie%d o+ Networ) N 2%o=a% Con+i'uration.
).# .indo0s H'IFSF Sares
$reeNA"1 uses "am=a to share .o%umes usin' Microso+t's CI$" rotoco%. CI$" is =ui%t into the
Windows and Mac -" 7 oeratin' s:stems and most 9inu5 and #"( s:stems re;insta%% the "am=a
c%ient which ro.ides suort +or CI$". I+ :our distro did notD insta%% the "am=a c%ient usin' :our
distro's so+tware reositor:.
Con+i'urin' CI$" shares is a mu%ti;ste rocess that reEuires :ou to set ermissionsD create CI$"
shareAsBD con+i'ure the CI$" ser.ice in "er.ices N CI$"D then ena=%e the CI$" ser.ice in "er.ices N
Contro% "er.ices. I+ :our Windows networ) has a Windows ser.er runnin' Acti.e (irector:D :ou wi%%
a%so need to con+i'ure the Acti.e (irector: ser.ice in "er.ices N (irector: "er.ices N Acti.e
(irector:. (eendin' uon :our authentication reEuirementsD :ou ma: need to create or imort users
and 'rous.
<his section wi%% demonstrate some common con+i'uration scenariosK
I+ :ou wou%d %i)e an o.er.iew o+ the con+i'ura=%e arametersD see Creatin' CI$" "hares.
I+ :ou wou%d %i)e an e5am%e o+ how to con+i'ure access that does not reEuire authenticationD
see Con+i'urin' Anon:mous Access.
I+ :ou wou%d %i)e each user to authenticate =e+ore accessin' the shareD see Con+i'urin' 9oca%
!ser Access.
I+ :ou wou%d %i)e to use "hadow CoiesD see Con+i'urin' "hadow Coies.
I+ :ou are ha.in' ro=%ems accessin' :our CI$" shareD see <rou=%eshootin' <i s .
).#.1 'reating 'IFS Sares
$i'ure /.3a shows the con+i'uration screen that aears when :ou c%ic) "harin' N Windows ACI$"
"haresB N Add Windows ACI$"B "hare. "ome settin's are on%: a.ai%a=%e in Ad.anced Mode. <o see
FreeNAS 9.2.1 Users Guide Page 1"" of 280
these settin'sD either c%ic) the Ad.anced Mode =utton or con+i'ure the s:stem to a%wa:s dis%a: these
settin's =: chec)in' the =o5 O"how ad.anced +ie%ds =: de+au%tP in ":stem N "ettin's N Ad.anced.
<a=%e /.3a summari8es the otions when creatin' a CI$" share. sm=.con+A*B ro.ides more detai%s +or
each con+i'ura=%e otion. -nce :ou ress the -K =utton when creatin' the CI$" shareD a o;u menu
wi%% as) OWou%d :ou %i)e to ena=%e this ser.iceUP C%ic) Fes and "er.ices N Contro% "er.ices wi%% oen
and indicate whether or not the CI$" ser.ice success+u%%: started.
Figure ).#a: Adding a 'IFS Sare
*a(le ).#a: 6!tions for a 'IFS Sare
Name strin' mandator:R name o+ share
Comment strin' otiona% descrition
>ath =rowse =utton se%ect .o%ume@dataset@director: to share
45ort Read -n%: chec)=o5 rohi=its write access to the share
#rowsa=%e to
Networ) C%ients
chec)=o5
ena=%es Windows c%ients to =rowse the shared director: usin'
Windows 45%orer
Inherit -wner chec)=o5
i+ chec)edD ownershi +or new +i%es and directories is inherited
+rom arent director: rather than +rom the user
Inherit
>ermissions
chec)=o5 i+ chec)edD the UN1F ermissions on new +i%es and directories are
inherited +rom arent director:R this can =e use+u% on %ar'e s:stems
FreeNAS 9.2.1 Users Guide Page 1"% of 280
with man: users as it a%%ows a sin'%e homes share to =e used
+%e5i=%: =: each userR do %ot chec0 i* T)"e o* A42 i$ $et to
8i%do-$ i% the 3ol!(eG$ "er(i$$io%$
45ort Rec:c%e
#in
chec)=o5
de%eted +i%es are instead mo.ed to a hidden .re'y'le director: in the
root +o%der o+ the share
"how Hidden $i%es chec)=o5
i+ ena=%edD wi%% dis%a: +i%enames that =e'in with a dot A!ni5
hidden +i%esB
A%%ow 2uest
Access
chec)=o5
i+ chec)edD no assword is reEuired to connect to the share and a%%
users share the ermissions o+ the 'uest user de+ined in "er.ices N
CI$"
-n%: A%%ow 2uest
Access
chec)=o5
reEuires Allo: g!est a''ess to a%so =e chec)edR +orces 'uest access
+or a%% connections
Hosts A%%ow strin'
on%: a.ai%a=%e in Ad.anced ModeR commaD saceD or ta= de%imited
%ist o+ a%%owed hostnames or I> addressesR see N-<4 =e%ow
Hosts (en: strin'
on%: a.ai%a=%e in Ad.anced ModeR commaD saceD or ta= de%imited
%ist o+ denied hostnames or I> addressesR a%%owed hosts ta)e
recedence so can use A;; in this +ie%d and seci+: a%%owed hosts
in =osts Allo:R see N-<4 =e%ow
Au5i%iar:
>arameters
strin'
on%: a.ai%a=%e in Ad.anced ModeR add additiona% [share\ sm=.con+
arameters not co.ered =: other otion +ie%ds
N6*7: hostname %oo)us add some time to accessin' the CI$" share. I+ :ou on%: use I> addressesD
unchec) the OHostnames %oo)usP =o5 in "er.ices N CI$".
I+ :ou wish some +i%es on a shared .o%ume to =e hidden and inaccessi=%e to usersD ut a #eto files> %ine
in the Au5i%iar: >arameters +ie%d. <he s:nta5 +or this %ine and some e5am%es can =e +ound here.
).#.2 'onfiguring Anon+3ous Access
<o share a .o%ume without reEuirin' users to inut a asswordD con+i'ure anon:mous CI$" sharin'.
<his t:e o+ share can =e con+i'ured as +o%%owsK
1. 'reate a #!e$t user account to (e used for anon+3ous access in Account N !sers N Add
!ser with the +o%%owin' attri=utesK
!sernameK g!est
Home (irector:K =rowse to the .o%ume to =e shared
chec) the (isa=%e %o'ins =o5
2. Associate te guest account 0it te ,olu3e in "tora'e N 3o%umes. 45and the .o%ume's
name then c%ic) Chan'e >ermissions. "e%ect g!est as the -wnerAuserB and -wnerA'rouB and
chec) that the ermissions are aroriate +or the share. I+ non;Windows s:stems wi%% =e
accessin' the CI$" shareD %ea.e the t:e o+ ermissions as !ni5. -n%: chan'e the t:e o+
ermissions to Windows i+ the share is o%l) accessed =: Windows s:stems.
FreeNAS 9.2.1 Users Guide Page 1") of 280
3. 'reate a 'IFS sare in "harin' N Windows ACI$"B "hares N Add Windows ACI$"B "hare
with the +o%%owin' attri=utesK
NameK freenas
>athK =rowse to the .o%ume to =e shared
chec) the =o5es Allo: H!est A''ess and @nly Allo: H!est A''ess
Hosts A%%owK add the addresses which are a%%owed to connect to the shareR acceta=%e
+ormats are the networ) or su=net address with CI(R mas) Ae.'. 142.156.2.0224 or
142.156.2.+2227B or seci+ic host I> addressesD one address er %ine
&. 'onfigure te 'IFS ser,ice in "er.ices N CI$" with the +o%%owin' attri=utesK
Authentication Mode%K Anonymo!s
2uest AccountK g!est
chec) the =o5es =o5es Allo: .m*ty 1ass:ord and .na$le =ome ire'tories
Home (irectoriesK =rowse to the .o%ume to =e shared
*. Start te 'IFS ser,ice in "er.ices N Contro% "er.ices. C%ic) the c%ic) the red -$$ =utton ne5t
to CI$". A+ter a second or soD it wi%% chan'e to a =%ue -ND indicatin' that the ser.ice has =een
ena=%ed.
%. *est te sare.
<o test the share +rom a Windows s:stemD oen 45%orerD c%ic) on Networ) and :ou shou%d see an icon
named F&..NAS. "ince anon:mous access has =een con+i'uredD :ou shou%d not =e romted +or a
username or assword in order to see the share. An e5am%e is seen in $i'ure /.3=.
I+ :ou c%ic) on the F&..NAS iconD :ou can .iew the contents o+ the CI$" share.
<o re.ent Windows 45%orer +rom han'in' when accessin' the shareD ma the share as a networ)
dri.e. <o do thisD ri'ht;c%ic) the share and se%ect OMa networ) dri.e...P as seen in $i'ure /.3c.
Figure ).#(: Accessing te 'IFS Sare fro3 a .indo0s 'o3!uter
Figure ).#c: 4a!!ing te Sare as a Net0or9 8ri,e
Choose a dri.e %etter +rom the dro;down menu and c%ic) the $inish =utton as shown in $i'ure /.3d.
Figure ).#d: Selecting te Net0or9 8ri,e <etter
).#.# 'onfiguring <ocal User Access
I+ :ou wou%d %i)e each user to authenticate =e+ore accessin' the CI$" shareD con+i'ure %oca% user access
as +o%%owsK
1. If +ou are not using Acti,e 8irector+ or <8APJ create a user account for eac user in
Account N !sers N Add !ser with the +o%%owin' attri=utesK
!sername and >asswordK matches the username and assword on the c%ient s:stem
Home (irector:K =rowse to the .o%ume to =e shared
Reeat this rocess to create a user account +or e.er: user that wi%% need access to the
CI$" share
FreeNAS 9.2.1 Users Guide Page 1%0 of 280
2. If +ou are not using Acti,e 8irector+ or <8APJ create a grou! in Account N 2rous N
Add 2rou. -nce the 'rou is createdD c%ic) its Mem=ers =utton and add the user accounts that
:ou created in ste 1.
3. Gi,e te grou! !er3ission to te ,olu3e in "tora'e N 3iew 3o%umes. When settin' the
ermissionsK
set -wnerAuserB to no$ody
set the -wnerA'rouB to the one :ou created in "te 2
ModeK chec) the write chec)=o5 +or the 2rou as it is unchec)ed =: de+au%t
&. 'reate a 'IFS sare in "harin' N CI$" "hares N Add CI$" "hare with the +o%%owin'
attri=utesK
NameK inut the name o+ the share
>athK =rowse to the .o%ume to =e shared
)ee the #rowsa=%e to Networ) C%ients =o5 chec)ed
N6*7: =e care+u% a=out unchec)in' the #rowsa=%e to Networ) C%ients =o5. When this =o5 is chec)ed
Athe de+au%tBD other users wi%% see the names o+ e.er: share that e5ists usin' Windows 45%orerD =ut the:
wi%% recei.e a ermissions denied error messa'e i+ the: tr: to access someone e%se's share. I+ this =o5 is
unchec)edD e.en the owner o+ the share won't see it or =e a=%e to create a dri.e main' +or the share in
Windows 45%orer. Howe.erD the: can sti%% access the share +rom the command %ine. !nchec)in' this
otion ro.ides %imited securit: and is not a su=stitute +or roer ermissions and assword contro%.
". 'onfigure te 'IFS ser,ice in Ser,ices Q 'IFS as +o%%owsK
Authentication Mode%K i+ :ou are not usin' Acti.e (irector: or 9(A>D se%ect ;o'al 9ser
Wor)'rouK i+ :ou are not usin' Acti.e (irector: or 9(A>D set to the name =ein' used on the
Windows networ)R un%ess it has =een chan'edD the de+au%t Windows wor)'rou name is
J@&KH&@91
,. Start te 'IFS ser,ice in "er.ices N Contro% "er.ices. C%ic) the c%ic) the red -$$ =utton ne5t
to CI$". A+ter a second or soD it wi%% chan'e to a =%ue -ND indicatin' that the ser.ice has =een
ena=%ed.
/. *est te sare.
<o test the share +rom a Windows s:stemD oen 45%orer and c%ic) on Networ). $or this con+i'uration
e5am%eD a s:stem named F&..NAS shou%d aear with a share named $a'k!*s. I+ :ou c%ic) on
$a'k!*sD a Windows "ecurit: o;u screen shou%d romt +or the user's username and assword.
-nce authenticatedD the user can co: data to and +rom the CI$" share.
N6*7: since the share is 'rou writa=%eD an: authenticated user can chan'e the data in the share. I+
:ou wish to setu shares where a 'rou o+ users ha.e access to some +o%ders =ut on%: indi.idua%s ha.e
access to other +o%ders Awhere a%% these +o%ders reside on the same .o%umeBD create these directories and
set their ermissions usin' "he%%. Instructions +or doin' so can =e +ound at the +orum ost "et
>ermission to a%%ow users to share a common +o%der ] ha.e ri.ate ersona% +o%der.
).#.$ 'onfiguring Sado0 'o!ies
"hadow CoiesD a%so )nown as the 3o%ume "hadow Co: "er.ice A3""B or >re.ious 3ersionsD is a
Microso+t ser.ice +or creatin' .o%ume snashots. "hadow coies a%%ow :ou to easi%: restore re.ious
.ersions o+ +i%es +rom within Windows 45%orer. "hadow Co: suort is =ui%t into 3ista and Windows
/. Windows 7> or 2000 users need to insta%% the "hadow Co: c%ient.
When :ou create a eriodic snashot tas) on a 0$" .o%ume that is con+i'ured as a CI$" share in
$reeNA"1D it is automatica%%: con+i'ured to suort shadow coies.
3.3.!.1 /rere6uisites
#e+ore usin' shadow coies with $reeNA"1D =e aware o+ the +o%%owin' ca.eatsK
i+ the Windows s:stem is not +u%%: atched to the %atest ser.ice ac)D "hadow Coies ma: not
wor). I+ :ou are una=%e to see an: re.ious .ersions o+ +i%es to restoreD use Windows !date to
ma)e sure that the s:stem is +u%%: u;to;date.
at this timeD shadow co: suort on%: wor)s +or 0$" oo%s or datasets. <his means that the
CI$" share must =e con+i'ured on a .o%ume or datasetD not on a director:. (irector: suort
wi%% =e added in a +uture .ersion o+ $reeNA"1.
since directories can not =e shadow coied at this timeD i+ :ou con+i'ure O4na=%e home
directoriesP on the CI$" ser.iceD an: data stored in the user's home director: wi%% not =e shadow
coied.
shadow coies wi%% not wor) with a manua% snashotD :ou must create a eriodic snashot tas)
+or the oo% or dataset =ein' shared =: CI$" or a recursi.e tas) +or a arent dataset. At this
timeD i+ mu%ti%e snashot tas)s are created +or the same oo%@dataset =ein' shared =: CI$"D
shadow coies wi%% on%: wor) on the %ast e5ecuted tas) at the time the CI$" ser.ice started. A
+uture .ersion o+ $reeNA"1 wi%% address this %imitation.
the eriodic snashot tas) shou%d =e created and at %east one snashot shou%d e5ist be*ore
creatin' the CI$" share. I+ :ou created the CI$" share +irstD restart the CI$" ser.ice in "er.ices
N Contro% "er.ices.
aroriate ermissions must =e con+i'ured on the .o%ume@dataset =ein' shared =: CI$".
users can not de%ete shadow coies on the Windows s:stem due to the wa: "am=a wor)s.
InsteadD the administrator can remo.e snashots +rom the $reeNA"1 administrati.e 2!I. <he
on%: wa: to disa=%e shadow coies com%ete%: is to remo.e the eriodic snashot tas) and
de%ete a%% snashots associated with the CI$" share.
3.3.!.2 Configuration *2a&le
In this e5am%eD a Windows / comuter has two usersK !ser1 and !ser2. <o con+i'ure $reeNA"1 to
ro.ide shadow co: suortK
1. $or the 0$" .o%ume named 2mnt2dataD create two 0$" datasets in "tora'e N 3o%umes N
@mnt@data N Create 0$" (ataset. <he +irst dataset is named 2mnt2data2!ser1 and the second
dataset is named 2mnt2data2!ser2.
2. I+ :ou are not usin' Acti.e (irector: or 9(A>D create two usersD !ser1 and !ser2 in Account N
!sers N Add !ser. 4ach user has the +o%%owin' attri=utesK
!sername and >asswordK matches that user's username and assword on the Windows
s:stem
Home (irector:K =rowse to the dataset created +or that user
3. "et the ermissions on 2mnt2data2!ser1 so that the -wnerAuserB and -wnerA'rouB is !ser1. "et
the ermissions on 2mnt2data2!ser2 so that the -wnerAuserB and -wnerA'rouB is !ser2. $or
each dataset's ermissionsD ti'hten the Mode so that -ther can not read or e5ecute the
in+ormation on the dataset.
&. Create two eriodic snashot tas)s in "tora'e N >eriodic "nashot <as)s N Add >eriodic
"nashotD one +or each dataset. A%ternati.e%:D :ou can create one eriodic snashot tas) +or the
entire data .o%ume. ,e*ore co%ti%!i%# to the %ext $te"/ con+irm that at %east one snashot +or
each dataset is dis%a:ed in the 0$" "nashots ta=. When creatin' :our snashotsD )ee in mind
how o+ten :our users need to access modi+ied +i%es and durin' which da:s and time o+ da: the:
are %i)e%: to ma)e chan'es.
*. Create two CI$" shares in "harin' N Windows ACI$"B "hares N Add Windows ACI$"B "hare.
<he +irst CI$" share is named !ser1 and has a >ath o+ 2mnt2data2!ser1R the second CI$" share is
named !ser2 and has a >ath o+ 2mnt2data2!ser2. When creatin' the +irst shareD c%ic) the No
=utton when the o;u =utton as)s i+ the CI$" ser.ice shou%d =e started. When the %ast share is
createdD c%ic) the Fes =utton when the o;u =utton romts to start the CI$" ser.ice. 3eri+:
that the CI$" ser.ice is set to -N in "er.ices N Contro% "er.ices.
,. $rom a Windows s:stemD %o'in as !ser1 and oen Windows 45%orer N Networ) N
$R44NA". <wo shares shou%d aearD named !ser1 and !ser2. (ue to the ermissions on the
datasetsD !ser1 shou%d recei.e an error i+ the: c%ic) on the !ser2 share. (ue to the ermissions
on the datasetsD !ser1 shou%d =e a=%e to createD addD and de%ete +i%es and +o%ders +rom the !ser1
share.
$i'ure /.3e ro.ides an e5am%e o+ usin' shadow coies whi%e %o''ed in as !ser1. In this e5am%eD the
user ri'ht;c%ic)ed modified file and se%ected ORestore re.ious .ersionsP +rom the menu. <his articu%ar
+i%e has three .ersionsK the current .ersionD %us two re.ious .ersions stored on the $reeNA"1 s:stem.
<he user can choose to oen one o+ the re.ious .ersionsD co: a re.ious .ersion to the current +o%derD
or restore one o+ the re.ious .ersionsD which wi%% o.erwrite the e5istin' +i%e on the Windows s:stem.
FreeNAS 9.2.1 Users Guide Page 1%# of 280
Figure ).#e: ?ie0ing Pre,ious ?ersions 0itin 7-!lorer
8 Ser,ices 'onfiguration
<he "er.ices section o+ the 2!I a%%ows :ou to con+i'ureD startD and sto the .arious ser.ices that shi
with the $reeNA"1 s:stem. $reeNA"1 suorts the +o%%owin' =ui%t;in ser.icesK
A$>
CI$"
(irector: "er.ices
(:namic (N"
$<>
FreeNAS 9.2.1 Users Guide Page 1%$ of 280
i"C"I
N$"
Rs:nc
".M.A.R.<.
"NM>
""H
<$<>
!>"
<his section demonstrates how to start a $reeNA"1 ser.ice then descri=es the a.ai%a=%e con+i'uration
otions +or each $reeNA"1 ser.ice.
8.1 'ontrol Ser,ices
"er.ices N Contro% "er.icesD shown in $i'ure 6.1aD a%%ows :ou to Euic)%: determine which ser.ices are
current%: runnin'D to start and sto ser.icesD and to con+i'ure ser.ices. #: de+au%tD a%% ser.ices Ae5cet
+or the ".M.A.R.<. ser.iceB are o++ unti% :ou start them.
Figure 8.1a: 'ontrol Ser,ices
FreeNAS 9.2.1 Users Guide Page 1%" of 280
A ser.ice is stoed i+ its icon is a red -$$. A ser.ice is runnin' i+ its icon is a =%ue -N. <o start or sto
a ser.iceD c%ic) its -N@-$$ icon.
<o con+i'ure a ser.iceD c%ic) the wrench icon associated with the ser.ice or c%ic) the name o+ the
ser.ice in the "er.ices section o+ the tree menu.
I+ a ser.ice does not startD 'o to ":stem N "ettin's N Ad.anced and chec) the =o5 O"how conso%e
messa'es in the +ooterP. Conso%e messa'es wi%% now show at the =ottom o+ :our =rowser. I+ :ou c%ic)
the conso%e messa'es areaD it wi%% o;u as a windowD a%%owin' :ou to scro%% throu'h the outut and to
co: messa'es. Watch these messa'es +or errors when :ou sto and start the ro=%ematic ser.ice.
I+ :ou wou%d %i)e to read the s:stem %o's to 'et more in+ormation a=out a ser.ice +ai%ureD oen "he%%
and t:e 3ore E,arElogE3essages.
8.2 AFP
<he A%e $i%in' >rotoco% AA$>B is a networ) rotoco% that o++ers +i%e ser.ices +or Mac comuters.
#e+ore con+i'urin' this ser.iceD :ou shou%d +irst create :our A$> "hares in "harin' N A%e AA$>B
"hares N Add A%e AA$>B "hare. A+ter con+i'urin' this ser.iceD 'o to "er.ices N Contro% "er.ices to
start the ser.ice. <he A$> shares wi%% not =e a.ai%a=%e on the networ) i+ this ser.ice is not runnin'.
"tartin' this ser.ice wi%% oen the +o%%owin' orts on the $reeNA"1 s:stemK
<C> *&6 Aa+dB
<C> &/99 AcnidGmetadataB
!(> *3*3 and a random !(> ort Aa.ahiB
$i'ure 6.2a shows the con+i'uration otions which are descri=ed in <a=%e 6.2a.
Figure 8.2a: AFP 'onfiguration
FreeNAS 9.2.1 Users Guide Page 1%% of 280
*a(le 8.2a: AFP 'onfiguration 6!tions
2uest Access chec)=o5
i+ chec)edD c%ients wi%% not =e romted to authenticate =e+ore
accessin' the A$> share
2uest Account dro;down menu
se%ect account to use +or 'uest accessR the se%ected account must
ha.e ermissions to the .o%ume@dataset =ein' shared
Ma5 Connections inte'er ma5imum num=er o+ simu%taneous connections
4na=%e home
directories
chec)=o5
i+ chec)edD an: user home directories %ocated under =ome
dire'tories wi%% =e a.ai%a=%e o.er the share
Home directories #rowse =utton
se%ect the .o%ume or dataset which contains user home
directories
When con+i'urin' home directoriesD it is recommended to create a dataset to ho%d the home directories
which contains a chi%d dataset +or each user. As an e5am%eD create a dataset named #ol!me12homedirs
and =rowse to this dataset when con+i'urin' the OHome directoriesP +ie%d o+ the A$> ser.ice. <henD as
:ou create each userD +irst create a chi%d dataset +or that user. $or e5am%eD create a dataset named
#ol!me12homedirs2!ser1. When :ou create the !ser1 userD =rowse to the #ol!me12homedirs2!ser1
dataset in the OHome (irector:P +ie%d o+ the OAdd New !serP screen.
8.2.1 *rou(lesooting
I+ :ou recei.e a O"omethin' wron' with the .o%ume's CNI( (#P error messa'eD run the +o%%owin'
command +rom "he%%D re%acin' the ath to the ro=%ematic A$> shareK
dbd -rf /path/to/share
<his command ma: ta)e a whi%eD deendin' uon the si8e o+ the .o%ume or dataset =ein' shared. <his
command wi%% wie the CNI( data=ase and re=ui%d it +rom the CNII(s stored in the A%e(ou=%e +i%es.
8.# 'IFS
<he Common Internet $i%e ":stem ACI$"B is a networ) rotoco% that o++ers +i%e ser.ices +or At:ica%%:B
Windows comuters. !ni5;%i)e s:stems that ro.ide a CI$" c%ient can a%so connect to CI$" shares.
#e+ore con+i'urin' this ser.iceD :ou shou%d +irst create :our CI$" shares in "harin' N Windows
ACI$"B "hares N Add Windows ACI$"B "hare. A+ter con+i'urin' this ser.iceD 'o to "er.ices N Contro%
"er.ices to start the ser.ice. <he CI$" shares wi%% not =e a.ai%a=%e on the networ) i+ this ser.ice is not
runnin'.
N6*7: a+ter startin' the CI$" ser.iceD it ma: ta)e se.era% minutes +or the master =rowser e%ection to
occur and +or the $reeNA"1 s:stem to =ecome a.ai%a=%e in Windows 45%orer.
<C> 139 Asm=dB
<C> &&* Asm=dB
!(> 13/ Anm=dB
FreeNAS 9.2.1 Users Guide Page 1%) of 280
!(> 136 Anm=dB
$i'ure 6.3a shows the con+i'uration otions which are descri=ed in <a=%e 6.3a. <his con+i'uration
screen is rea%%: a +ront;end to sm=.con+A*B.
Figure 8.#a: 'onfiguring 'IFS
*a(le 8.#a: 'IFS 'onfiguration 6!tions
Authentication
Mode%
dro;down
menu
choices are Anonymo!s or ;o'al 9serL this settin' is i'nored i+ the
Acti.e (irector: or 9(A> ser.ice is runnin'
Net#I-" Name strin'
must =e %owercase and and is automatica%%: ou%ated with the
hostname o+ the $reeNA"1 s:stemR it (!$t =e di++erent +rom the
Jorkgro!* name
Wor)'rou strin'
must match Windows wor)'rou nameR this settin' is i'nored i+
the Acti.e (irector: or 9(A> ser.ice is runnin'
(-" Charset
dro;down
menu
the character set "am=a uses when communicatin' with (-" and
Windows 95@M4 c%ientsR de+au%t is "14+7
!NI7 Charset
dro;down
menu
de+au%t is 9?F-6 which suorts a%% characters in a%% %an'ua'es
9o' 9e.e%
dro;down
menu
choices are <inim!mD NormalD F!llD or e$!g
9oca% Master chec)=o5 determines whether or not the $reeNA"1 s:stem articiates in a
=rowser e%ectionR shou%d =e disa=%ed when networ) contains an A(
or 9(A> ser.er and is not necessar: i+ 3ista or Windows /
machines are resent
<ime "er.er +or
(omain
chec)=o5
determines whether or not the $reeNA"1 s:stem ad.ertises itse%+
as a time ser.er to Windows c%ientsR shou%d =e disa=%ed when
networ) contains an A( or 9(A> ser.er
2uest Account
dro;down
menu
account to =e used +or 'uest accessR that account must ha.e
ermission to access the shared .o%ume@dataset
$i%e mas) inte'er
o.errides de+au%t +i%e creation mas) o+ 0,,, which creates +i%es
with read and write access +or e.er:=od:
(irector: mas) inte'er
o.errides de+au%t director: creation mas) o+ 0/// which 'rants
director: readD write and e5ecute access +or e.er:=od:
4A "uort chec)=o5 ena=%es e5tended attri=utes
"uort (-" $i%e
Attri=utes
chec)=o5
a%%ows a user who has write access to a +i%e to modi+: the
ermissionsD e.en i+ not the owner o+ the +i%e
A%%ow 4mt:
>assword
chec)=o5
i+ chec)edD users can Iust ress enter when romted +or a
asswordR reEuires that the username@assword =e the same +or the
$reeNA"1 user account and the Windows user account
Au5i%iar:
arameters
strin'
sm$.'onf otions not co.ered e%sewhere in this screenR see the
"am=a 2uide +or additiona% settin's
4na=%e home
directories
chec)=o5
i+ chec)edD a +o%der with the same name as the user account wi%% =e
created +or each user
4na=%e home
directories =rowsin'
chec)=o5 users can =rowse A=ut not write toB other users' home directories
Home directories
=rowse
=utton
se%ect .o%ume@dataset where the home directories wi%% =e created
Homes au5i%iar:
arameters
strin'
otions seci+ic to the [homes\ section o+ sm$.'onfR +or e5am%eD
ide dot files D +es hides +i%es =e'innin' with a dot in home
directories
!ni5 45tensions chec)=o5
a%%ows non;Windows CI$" c%ients to access s:m=o%ic %in)s and
hard %in)sD has no a++ect on Windows c%ients
0erocon+ share
disco.er:
chec)=o5 ena=%e i+ Mac c%ients wi%% =e connectin' to the CI$" share
Hostnames %oo)us chec)=o5
a%%ows :ou to seci+: hostnames rather than I> addresses in the
Hosts A%%ow or Hosts (en: +ie%ds o+ a CI$" shareR unchec) i+ :ou
on%: use I> addresses as it sa.es the time o+ a host %oo)u
#e'innin' with $reeNA"1 6.0.3;R494A"4D chan'es to CI$" settin's and CI$" shares ta)e e++ect
immediate%:. $or re.ious .ersionsD chan'es wi%% not ta)e e++ect unti% :ou manua%%: sto and start the
CI$" ser.ice.
N6*7: do not set the dire'tory name 'a'he si/e as an au5i%iar: arameter. (ue to di++erences in how
9inu5 and #"( hand%e +i%e descritorsD director: name cachin' is disa=%ed on #"( s:stems in order to
imro.e er+ormance.
8.#.1 *rou(lesooting *i!s
"am=a is sin'%e threadedD so C>! seed ma)es a =i' di++erence in CI$" er+ormance. Four t:ica%
2.*2h8 Inte% Euad core or 'reater shou%d =e caa=%e to hand%e seeds in e5cess o+ 2= 9AN whi%e %ow
ower C>!s such as Inte% Atoms and AM( C;30s^4;3*0^4;&*0 wi%% not =e a=%e to achie.e more than
a=out 30;&0M#@sec t:ica%%:. Remem=er that other %oadin' such as 0$" %oadin' wi%% a%so reEuire C>!
resources and ma: cause "am=a er+ormance to =e %ess than otima%.
"am=a's Owrite cacheP arameter has =een reorted to imro.e write er+ormance in some
con+i'urations and can =e added to the Au5i%iar: >arameters +ie%d. !se an inte'er .a%ue which is a
mu%ti%e o+ G"CG>A24"I04 At:ica%%: &09,B to a.oid memor: +ra'mentation. <his wi%% increase
"am=a's memor: reEuirements and shou%d not =e used on s:stems with %imited RAM.
I+ :ou wish to increase networ) er+ormanceD read the "am=a section on soc)et otions. It indicates
which otions are a.ai%a=%e and recommends that :ou e5eriment to see which are suorted =: :our
c%ients and imro.e :our networ)'s er+ormance.
Windows automatica%%: caches +i%e sharin' in+ormation. I+ :ou ma)e chan'es to a CI$" share or to the
ermissions o+ a .o%ume@dataset =ein' shared =: CI$" and are no %on'er a=%e to access the shareD tr:
%o''in' out and =ac) into the Windows s:stem. A%ternate%:D users can t:e net use Edelete R +rom the
command %ine to c%ear their "M# sessions.
Windows a%so automatica%%: caches %o'in in+ormation. I+ :ou wish users to =e romted to %o'in e.er:
time access is reEuiredD reduce the cache settin's on the c%ient comuters.
Where ossi=%eD a.oid usin' a mi5 o+ case in +i%enames as this ma: cause con+usion +or Windows users.
Reresentin' and reso%.in' +i%enames with "am=a e5%ains this in more detai%.
I+ ermissions wor) +or Windows users =ut not +or -" 7 usersD tr: disa=%in' 9ni( .(tensions and
restartin' the CI$" ser.ice.
I+ the CI$" ser.ice wi%% not startD run this command +rom "he%% to see i+ there is an error in the
con+i'urationK
testparm /usr/local/etc/smb.conf
<he Common 4rrors section o+ the "am=a documentation contains additiona% trou=%eshootin' tis.
8.$ 8irector+ Ser,ices
$reeNA"1 suorts the +o%%owin' director: ser.icesK
Acti.e (irector: A+or Windows 2000 and hi'her networ)sB
(omain Contro%%er A+or con+i'urin' $reeNA"1 as a domain contro%%erB
9(A>
NI"
FreeNAS 9.2.1 Users Guide Page 1)0 of 280
N<& A+or Windows networ)s o%der than Windows 2000B
<his section summari8es each o+ these ser.ices and their a.ai%a=%e con+i'urations within the $reeNA"1
2!I.
N6*7: at this timeD o%l) o%e director) $er'ice ca% be co%*i#!red. <hat ser.ice must +irst =e se%ected
in the ":stem N "ettin's N 2enera% N (irector: "er.ice dro;down menu. -nce se%ectedD a
(irector: "er.ice entr: wi%% =e added to "er.ices N Contro% "er.ices so that the ser.ice can =e startedD
stoedD and con+i'ured.
8.$.1 Acti,e 8irector+
Acti.e (irector: AA(B is a ser.ice +or sharin' resources in a Windows networ). A( can =e con+i'ured
on a Windows ser.er that is runnin' Windows "er.er 2000 or hi'her or on a !ni5;%i)e oeratin'
s:stem that is runnin' "am=a .ersion &. "ince A( ro.ides authentication and authori8ation ser.ices
+or the users in a networ)D :ou do not ha.e to recreate these user accounts on the $reeNA"1 s:stem.
InsteadD con+i'ure the Acti.e (irector: ser.ice so that it can imort the account in+ormation and
imorted users can =e authori8ed to access the CI$" shares on the $reeNA"1 s:stem.
N6*7: i+ :our networ) contains an N<& domain contro%%erD or an: domain contro%%er containin' a
.ersion which is ear%ier than Windows 2000D con+i'ure N<& instead.
Man: chan'es and imro.ements ha.e =een made to Acti.e (irector: suort within $reeNA"1. I+
:ou are not runnin' $reeNA"1 9.2.1;R494A"4D it is stron'%: recommended that :ou u'rade =e+ore
attemtin' Acti.e (irector: inte'ration.
,e*ore co%*i#!ri%# the Acti'e Director) $er'iceD ensure name reso%ution is roer%: con+i'ured =:
!ingin' the domain name o+ the Acti.e (irector: domain contro%%er +rom "he%% on the $reeNA"1
s:stem. I+ the !ing +ai%sD chec) the (N" ser.er and de+au%t 'atewa: settin's in Networ) N 2%o=a%
Con+i'uration on the $reeNA"1 s:stem.
Ne5tD add a (N" record +or the $reeNA"1 s:stem on the Windows ser.er and .eri+: that :ou can !ing
the hostname o+ the $reeNA"1 s:stem +rom the domain contro%%er.
Acti.e (irector: re%ies on Ker=erosD which is a time sensiti.e rotoco%. <his means that the time on
=oth the $reeNA"1 s:stem and the Acti.e (irector: (omain Contro%%er can not =e out o+ s:nc =:
more than a +ew minutes. <he =est wa: to ensure that the same time is runnin' on =oth s:stems is to
con+i'ure =oth s:stems toK
use the same N<> ser.er Aset in ":stem N N<> "er.ers on the $reeNA"1 s:stemB
ha.e the same time8one
=e set to either %oca%time or uni.ersa% time at the #I-" %e.e%
$i'ure 6.&a shows the screen that aears when :ou c%ic) "er.ices N (irector: "er.ices N Acti.e
(irector:. <a=%e 6.&a descri=es the con+i'ura=%e otions. "ome settin's are on%: a.ai%a=%e in Ad.anced
Ad.anced.
Figure 8.$a: 'onfiguring Acti,e 8irector+
*a(le 8.$a: Acti,e 8irector+ 'onfiguration 6!tions
(omain Name strin'
name o+ Acti.e (irector: domain Ae.'. e(am*le.'omB or chi%d
domain Ae.'. sales.e(am*le.'omB
Net#I-" Name strin'
automatica%%: ou%ated with the hostname o+ the $reeNA"1
s:stemR !$e ca!tio% -he% cha%#i%# thi$ $etti%# as settin' an
incorrect .a%ue can corrut an A( insta%%ation
Wor)'rou Name strin' name o+ Windows ser.er's wor)'rou A+or o%der Microso+t c%ientsB
(omain Account Name strin' name o+ the Acti.e (irector: administrator account
(omain Account
>assword
strin'
assword +or the Acti.e (irector: administrator account
!se )e:ta= chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ se%ectedD =rowse to the
Ker$eros keyta$
Ker=eros )e:ta=
=rowse
=utton
on%: a.ai%a=%e in Ad.anced ModeR =rowse to the %ocation o+ the
)e:ta= created usin' the instructions in !sin' a Ke:ta=
3er=ose %o''in' chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD %o's attemts to
Ioin the domain to 2#ar2log2messages
!NI7 e5tensions chec)=o5 on%: a.ai%a=%e in Ad.anced ModeR o%l) chec) this =o5 i+ the A(
ser.er has =een e5%icit%: con+i'ured to ma ermissions +or
!NI7 usersR chec)in' this =o5 ro.ides ersistent !I(s and
2!I(sD otherwiseD users@'rous 'et maed to the !I(@2!I(
ran'e con+i'ured in "am=a
A%%ow <rusted (omains chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR shou%d on%: =e ena=%ed i+
networ) has acti.e domain@+orest trusts and :ou need to mana'e
+i%es on mu%ti%e domainsR use with caution as it wi%% 'enerate
more win=indd tra++icD s%owin' down the a=i%it: to +i%ter throu'h
user@'rou in+ormation
!se de+au%t domain chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR when unchec)edD the domain
name is reended to the usernameR i+ Allo: ?r!sted omains is
chec)ed and mu%ti%e domains use the same usernamesD unchec)
this =o5 to re.ent name co%%isions
(omain Contro%%er strin'
on%: a.ai%a=%e in Ad.anced ModeR can =e used to seci+:
hostname o+ domain contro%%er to use
2%o=a% Cata%o' "er.er strin'
hostname o+ '%o=a% cata%o' ser.er to use
Ker=eros "er.er strin'
hostname o+ )er=eros ser.er to use
Ker=eros >assword
"er.er
strin'
hostname o+ )er=eros assword ser.er to use
A( timeout inte'er
on%: a.ai%a=%e in Ad.anced ModeR in secondsD increase i+ the A(
ser.ice does not start a+ter connectin' to the domain
(N" timeout inte'er
on%: a.ai%a=%e in Ad.anced ModeR in secondsD increase i+ A(
(N" Eueries timeout
N6*7: Acti.e (irector: %aces restrictions on which characters are a%%owed in (omain and Net#I-"
names. I+ :ou are ha.in' ro=%ems connectin' to the rea%mD .eri+: that :our settin's do not inc%ude an:
disa%%owed characters. A%soD the Administrator >assword cannot contain the M character. I+ a M e5ists in
the domain administrator's asswordD )init wi%% reort a O>assword IncorrectP error and %daG=ind wi%%
reort an OIn.a%id credentia%s A&9BP error.
-nce :ou ha.e con+i'ured the Acti.e (irector: ser.iceD start it in "er.ices N Contro% "er.ices N
(irector: "er.ices. It ma: ta)e a +ew minutes +or the Acti.e (irector: in+ormation to =e ou%ated to
the $reeNA"1 s:stem. -nce ou%atedD the A( users and 'rous wi%% =e a.ai%a=%e in the dro;down
menus o+ the ermissions screen o+ a .o%ume@dataset. $or er+ormance reasonsD e.er: a.ai%a=%e user
ma: not show in the %istin'. Howe.erD it wi%% autocom%ete a%% a%ica=%e users i+ :ou start t:in' in a
username.
Fou can .eri+: which Acti.e (irector: users and 'rous ha.e =een imorted to the $reeNA"1 s:stem
=: usin' these commands within the $reeNA"1 "he%%K
wbinfo -u Ato .iew usersB
wbinfo -g Ato .iew 'rousB
FreeNAS 9.2.1 Users Guide Page 1)# of 280
In additionD 0(info >t wi%% test the connection andD i+ success+u%D wi%% 'i.e a messa'e simi%ar toK
checking the trust secret for domain YOURDOMAIN via RPC calls succeeded
<o manua%%: chec) that a seci+ied user can authenticateK
net ads join -S dcname -U username
I+ no users or 'rous are %isted in the outut o+ those commandsD these commands wi%% ro.ide more
trou=%eshootin' in+ormationK
getent passwd
getent group
7.!.1.1 'sing a 1e-tab
Ker=eros )e:ta=s are used to do Acti.e (irector: Ioins without a assword. <his means that the
assword +or the Acti.e (irector: administrator account does not need to =e sa.ed into the $reeNA"1
con+i'uration data=aseD which is a securit: ris) in some en.ironments.
When usin' a )e:ta=D it is recommended to create and use a %ess ri.i%e'ed account +or er+ormin' the
reEuired 9(A> Eueries as the assword +or that account wi%% =e stored in the $reeNA"1 con+i'uration
data=ase. Create this account on the domain contro%%erD then inut that account name and its associated
assword into the omain A''o!nt Name and omain A''o!nt 1ass:ord +ie%ds in the screen shown in
$i'ure 6.&a.
<he )e:ta= itse%+ can =e created on a Windows s:stem usin' these commands. <he te5t in red needs to
=e modi+ied to the actua% .a%ues used in the domain.
ktpass.exe -out hostname.keytab host/hostname@DOMAINNAME -ptype KRB5_NT_PRINCIPAL
-mapuser DOMAIN\username -pass userpass
setspn -A host/hostname@DOMAINNAME DOMAIN\username
whereK
ostna3e is the +u%%: Eua%i+ied hostname o+ the domain contro%%er
864AINNA47 is the domain name in a%% cas
864AIN is the re;Windows 2000 short name +or the domain
userna3e is the ri.i%e'ed account name
user!ass is the assword associated with username
<his wi%% create a )e:ta= with su++icient ri.i%e'es to 'rant tic)ets +or CI$" and 9(A>.
-nce the )e:ta= is 'eneratedD trans+er it to the $reeNA"1 s:stemD chec) the 9se keyta$ =o5 and
=rowse to the %ocation o+ the )e:ta=.
FreeNAS 9.2.1 Users Guide Page 1)$ of 280
7.!.1.2 Troubleshooting Tis
I+ :ou are runnin' A( in a 2003@2006 mi5ed domainD see this +orum ost +or instructions on how to
re.ent the secure channe% )e: +rom =ecomin' corrut.
Acti.e (irector: uses (N" to determine the %ocation o+ the domain contro%%ers and '%o=a% cata%o'
ser.ers in the networ). !se the ost >t sr, :lda!.:tc!.do3ainna3e.co3 command to determine the
networ)'s "R3 records andD i+ necessar:D chan'e the wei'ht and@or riorit: o+ the "R3 record to re+%ect
the +astest ser.er. More in+ormation a=out "R3 records can =e +ound in the <echnet artic%e How (N"
"uort +or Acti.e (irector: Wor)s.
<he rea%m that is used deends uon the riorit: in the "R3 (N" recordD meanin' that (N" can
o.erride :our Acti.e (irector: settin's. I+ :ou are una=%e to connect to the correct rea%mD chec) the
"R3 records on the (N" ser.er. <his artic%e descri=es how to con+i'ure K(C disco.er: o.er (N" and
ro.ides some e5am%es o+ records with di++erin' riorities.
I+ the cache =ecomes out o+ s:nc due to an A( ser.er =ein' ta)en o++ and =ac) on%ineD res:nc the cache
usin' ":stem N "ettin's N Ad.anced N Re=ui%d 9(A>@A( Cache.
An e5ired assword +or the administrator account wi%% cause )init to +ai% so ensure that the assword is
sti%% .a%id.
<r: creatin' a Comuter entr: on the Windows ser.er's -!. When creatin' this entr:D enter the
$reeNA"1 hostname in the name +ie%d. Ma)e sure it is the same name as the one set in the =ostname
+ie%d in Networ) N 2%o=a% Con+i'uration and the NetB8@S Name in "er.ices N (irector: "er.ices N
Acti.e (irector: settin's. Ma)e sure the hostname o+ the domain contro%%er is set in the omain
"ontroller +ie%d o+ "er.ices N (irector: "er.ices N Acti.e (irector:.
8.$.2 8o3ain 'ontroller
#e'innin' with $reeNA"1 9.2.1D $reeNA"1 uses "am=a&D meanin' that it can =e con+i'ured to act as
the domain contro%%er +or a networ). Re+er to the "am=a $A? +or +urther in+ormation.
N6*7: creatin' a domain contro%%er is a com%e5 rocess that reEuires a 'ood understandin' o+ how
Acti.e (irector: wor)s. Whi%e $reeNA"1 ma)es it eas: to inut the needed settin's into the
administrati.e 'rahica% inter+aceD it can't te%% :ou what those settin's shou%d =e. Re+er to the "am=a
A( (C H-W<- +or more in+ormation a=out creatin' a new domain. <he current im%ementation does
not suort a con+i'uration that a%%ows $reeNA"1 to Ioin an e5istin' domain as a domain contro%%er.
<his %imitation wi%% =e addressed in a +uture .ersion o+ $reeNA"1.
$i'ure 6.&= shows the con+i'uration screen +or creatin' a domain contro%%er and <a=%e 6.&= summari8es
the a.ai%a=%e otions.
FreeNAS 9.2.1 Users Guide Page 1)" of 280
Figure 8.$(: 8o3ain 'ontroller Settings
*a(le 8.$(: 8o3ain 'ontroller 'onfiguration 6!tions
Rea%m strin' caita%i8ed (N" rea%m name
(omain strin' caita%i8ed domain name
"er.er Ro%e
dro;down
menu
at this timeD the on%: suorted ro%e is as the domain contro%%er
+or a new domain
(N" #ac)end
dro;down
menu
choices are SA<BA,8N?.&NA;D B8N4,F;A?F8;.D
B8N4,;FD or N@N. R re+er to Which (N" =ac)end shou%d
I chooseU +or detai%s
(N" $orwarder strin'
I> address o+ (N" +orwarderR reEuired +or recursi.e Eueries
when SA<BA,8N?.&NA; is se%ected
(omain $orest 9e.e%
dro;down
menu
choices are 2000D 200+D 2006D or 2006,&2L re+er to
!nderstandin' Acti.e (irector: (omain "er.ices AA( ("B
$unctiona% 9e.e%s +or detai%s
Administrator
assword
strin'
assword to =e used +or the Acti.e (irector: administrator
account
FreeNAS 9.2.1 Users Guide Page 1)% of 280
8.$.# <8AP
$reeNA"1 inc%udes an -en9(A> c%ient +or accessin' in+ormation +rom an 9(A> ser.er. An 9(A>
ser.er ro.ides director: ser.ices +or +indin' networ) resources such as users and their associated
ermissions. 45am%es o+ 9(A> ser.ers inc%ude Microso+t "er.er A2000 and newerBD Mac -" 7
"er.erD No.e%% e(irector:D and -en9(A> runnin' on a #"( or 9inu5 s:stem. I+ an 9(A> ser.er is
runnin' on :our networ)D :ou shou%d con+i'ure the $reeNA"1 9(A> ser.ice so that the networ)'s
users can authenticate to the 9(A> ser.er and thus =e ro.ided authori8ed access to the data stored on
N6*7: 9(A> wi%% not wor) with CI$" shares unti% the 9(A> director: has =een con+i'ured +or and
ou%ated with "am=a attri=utes. <he most ou%ar scrit +or er+ormin' this tas) is sm=%da;too%s and
instructions +or usin' it can =e +ound at <he 9inu5 "am=a;-en9(A> Howto.
$i'ure 6.&c shows the 9(A> Con+i'uration screen that is seen when :ou c%ic) "er.ices N (irector:
"er.ices N 9(A>.
Figure 8.$c: 'onfiguring <8AP
<a=%e 6.&c summari8es the a.ai%a=%e con+i'uration otions. I+ :ou are new to 9(A> termino%o':D s)im
throu'h the -en9(A> "o+tware 2.& Administrator's 2uide.
*a(le 8.$c: <8AP 'onfiguration 6!tions
Hostname strin' hostname or I> address o+ 9(A> ser.er
#ase (N strin'
to %e.e% o+ the 9(A> director: tree to =e used when searchin' +or
resources Ae.'. d'>test3d'>orgB
FreeNAS 9.2.1 Users Guide Page 1)) of 280
A%%ow
Anon:mous
#indin'
chec)=o5
instructs 9(A> ser.er to not ro.ide authentication and to a%%ow
read@write access to an: c%ient
Root =ind (N strin'
name o+ administrati.e account on 9(A> ser.er Ae.'.
'n><anager3d'>test3d'>orgG
Root =ind
assword
strin' assword +or &oot $ind N
>assword
4ncr:tion
dro;down
menu
se%ect a t:e suorted =: the 9(A> ser.erD choices areK 'lear
Aunencr:tedBD 'ry*tD mdDD ndsD ra'fD adD e(o*
!ser "u++i5 strin'
otiona%D can =e added to name when user account added to 9(A>
director: Ae.'. det. or coman: nameB
2rou "u++i5 strin'
otiona%D can =e added to name when 'rou added to 9(A>
director: Ae.'. det. or coman: nameB
>assword "u++i5 strin'
otiona%D can =e added to assword when assword added to 9(A>
director:
Machine "u++i5 strin'
otiona%D can =e added to name when s:stem added to 9(A>
director: Ae.'. ser.erD accountin'B
4ncr:tion Mode
dro;down
menu
choices are @ffD SS;D or ?;S
"e%+ si'ned
certi+icate
strin'
used to .eri+: the certi+icate o+ the 9(A> ser.er i+ ""9
connections are usedR aste the outut o+ the command o!enssl
s:client >connect ser,er:!ort >so0certs
Au5i%iar:
>arameters
strin'
%da.con+A*B otionsD one er %ineD not co.ered =: other otions in
this screen
N6*7: $reeNA"1 automatica%%: aends the root (N. <his means that :ou shou%d not inc%ude the
scoe and root (N when con+i'urin' the userD 'rouD asswordD and machine su++i5es.
A+ter con+i'urin' the 9(A> ser.iceD start it in "er.ices N Contro% "er.ices N (irector: "er.ices. I+
the ser.ice wi%% not startD re+er to the Common errors encountered when usin' -en9(A> "o+tware +or
common errors and how to +i5 them. When trou=%eshootin' 9(A>D oen "he%% and %oo) +or error
messa'es in 2#ar2log2a!th.log.
<o .eri+: that the users ha.e =een imortedD t:e getent !ass0d +rom "he%%. <o .eri+: that the 'rous
ha.e =een imortedD t:e getent grou!.
8.$.$ NIS
Networ) In+ormation "er.ice ANI"B is a ser.ice which maintains and distri=utes a centra% director: o+
!ni5 user and 'rou in+ormationD hostnamesD emai% a%iases and other te5t;=ased ta=%es o+ in+ormation.
I+ a NI" ser.er is runnin' on :our networ)D the $reeNA"1 s:stem can =e con+i'ured to imort the
users and 'rous +rom the NI" director:.
A+ter con+i'urin' this ser.iceD start it in "er.ices N Contro% "er.ices N (irector: "er.ices.
$i'ure 6.&d shows the con+i'uration screen which oens when :ou c%ic) "er.ices N (irector: "er.ices
N NI". <a=%e 6.&d summari8es the con+i'uration otions.
Figure 8.$d: NIS 'onfiguration
*a(le 8.$d: NIS 'onfiguration 6!tions
NI" domain strin' name o+ NI" domain
NI" ser.ers strin' comma de%imited %ist o+ hostnames or I> addresses
"ecure
mode
chec)=o5
i+ chec)edD :=indA6B wi%% re+use to =ind to an: NI" ser.er that is not runnin'
as root on a <C> ort num=er o.er 102&
Man:cast chec)=o5
i+ chec)edD :=ind wi%% =ind to the ser.er that resonds the +astestR this is
use+u% when no %oca% NI" ser.er is a.ai%a=%e on the same su=net
8.$." N*$
<his ser.ice shou%d on%: =e con+i'ured i+ the Windows networ)'s domain contro%%er is runnin' N<&. I+
it is notD :ou shou%d con+i'ure Acti.e (irector: instead.
$i'ure 6.&e shows the con+i'uration screen that aears when :ou c%ic) "er.ices N (irector: "er.ices
N N<&. <hese otions are summari8ed in <a=%e 6.&e.
A+ter con+i'urin' the N<& ser.iceD start it in "er.ices N Contro% "er.ices N (irector: "er.ices.
Figure 8.$e: N*$ 'onfiguration 6!tions
*a(le 8.$e: N*$ 'onfiguration 6!tions
(omain Contro%%er strin' hostname o+ domain contro%%er
Net#I-" Name strin' hostname o+ $reeNA"1 s:stem
Wor)'rou Name strin' name o+ Windows ser.er's wor)'rou
Administrator Name strin' name o+ the domain administrator account
Administrator >assword strin' inut and con+irm the assword +or the domain administrator account

8." 8+na3ic 8NS
(:namic (N" A((N"B is use+u% i+ :our $reeNA"1 s:stem is connected to an I"> that eriodica%%:
chan'es the I> address o+ the s:stem. With d:namic (N"D the s:stem can automatica%%: associate its
current I> address with a domain nameD a%%owin' :ou to access the $reeNA"1 s:stem e.en i+ the I>
address chan'es. ((N" reEuires :ou to re'ister with a ((N" ser.ice such as (:n(N".
$i'ure 6.*a shows the ((N" con+i'uration screen and <a=%e 6.*a summari8es the con+i'uration
otions. <he .a%ues :ou need to inut wi%% =e 'i.en to :ou =: the ((N" ro.ider. A+ter con+i'urin'
((N"D don't +or'et to start the ((N" ser.ice in "er.ices N Contro% "er.ices.
Figure 8."a: 'onfiguring 88NS
*a(le 8."a: 88NS 'onfiguration 6!tions
>ro.ider
dro;down
menu
se.era% ro.iders are suortedR i+ :our ro.ider is not %istedD %ea.e this
+ie%d =%an) and seci+: the custom ro.ider in the A!(iliary *arameters
+ie%d
(omain name strin' +u%%: Eua%i+ied domain name Ae.'. yo!rname.dyndns.orgB
!sername strin' username used to %o'on to the ro.ider and udate the record
>assword strin' assword used to %o'on to the ro.ider and udate the record
!date eriod inte'er
in secondsR =e care+u% with this settin' as the ro.ider ma: =%oc) :ou +or
a=use i+ this settin' occurs more o+ten than the I> address chan'es
$orced udate
eriod
inte'er
in seconds so =e care+u% with this settin' as the ro.ider ma: =%oc) :ou
+or a=useR issues a ((N" udate reEuest e.en when the address has not
chan'ed so that the ser.ice ro.ider )nows that the account is sti%% acti.e
Au5i%iar:
arameters
strin'
additiona% arameters assed to the ro.ider durin' record udateR an
e5am%e o+ seci+:in' a custom ro.ider is dyndns,system
defa!ltN*ro#ider.'om

8.% F*P
$reeNA"1 uses the ro+td $<> ser.er to ro.ide $<> ser.ices. -nce the $<> ser.ice is con+i'ured
and startedD c%ients can =rowse and down%oad data usin' a we= =rowser or $<> c%ient so+tware. <he
ad.anta'e o+ $<> is that eas:;to;use cross;%at+orm uti%ities are a.ai%a=%e to mana'e u%oads to and
down%oads +rom the $reeNA"1 s:stem. <he disad.anta'e o+ $<> is that it is considered to =e an
insecure rotoco%D meanin' that it shou%d not =e used to trans+er sensiti.e +i%es. I+ :ou are concerned
a=out sensiti.e dataD see 4ncr:tin' $<>.
<his section ro.ides an o.er.iew o+ the $<> con+i'uration otions. It then ro.ides e5am%es +or
con+i'urin' anon:mous $<>D seci+ied user access within a chroot en.ironmentD encr:tin' $<>
connectionsD and trou=%eshootin' tis.
8.%.1 F*P 'onfiguration 6!tions
$i'ure 6.,a shows the con+i'uration screen +or "er.ices N $<>. "ome settin's are on%: a.ai%a=%e in
Ad.anced Mode. <o see these settin'sD either c%ic) the Ad.anced Mode =utton or con+i'ure the s:stem
to a%wa:s dis%a: these settin's =: chec)in' the =o5 O"how ad.anced +ie%ds =: de+au%tP in ":stem N
"ettin's N Ad.anced.
Figure 8.%a: 'onfiguring F*P
<a=%e 6.,a summari8es the a.ai%a=%e otions when con+i'urin' the $<> ser.erK
*a(le 8.%a: F*P 'onfiguration 6!tions
>ort inte'er ort the $<> ser.ice %istens on
C%ients inte'er ma5imum num=er o+ simu%taneous c%ients
Connections inte'er
ma5imum num=er o+ connections er I> address where 0
means un%imited
9o'in Attemts inte'er
ma5imum num=er o+ attemts =e+ore c%ient is disconnectedR
increase this i+ users are rone to t:os
<imeout inte'er
ma5imum c%ient id%e time in seconds =e+ore c%ient is
disconnected
A%%ow Root 9o'in chec)=o5 discoura'ed as increases securit: ris)
A%%ow Anon:mous 9o'in chec)=o5
ena=%es anon:mous $<> %o'ins with access to the director:
seci+ied in 1ath
>ath
=rowse
=utton
root director: +or anon:mous $<> connections
A%%ow 9oca% !ser 9o'in chec)=o5 reEuired i+ Anonymo!s ;ogin is disa=%ed
(is%a: 9o'in strin'
messa'e dis%a:ed to %oca% %o'in users a+ter authenticationR
not dis%a:ed to anon:mous %o'in users
$i%e >ermission chec)=o5es
on%: a.ai%a=%e in Ad.anced ModeR sets de+au%t ermissions
+or new%: created +i%es
(irector: >ermission chec)=o5es
on%: a.ai%a=%e in Ad.anced ModeR sets de+au%t ermissions
+or new%: created directories
4na=%e $7> chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR ena=%es $i%e e7chan'e
>rotoco% which is discoura'ed as it ma)es the ser.er
.u%nera=%e to $<> =ounce attac)s
A%%ow <rans+er Resumtion chec)=o5 a%%ows $<> c%ients to resume interruted trans+ers
A%wa:s Chroot chec)=o5
a %oca% user is on%: a%%owed access to their home director:
un%ess the user is a mem=er o+ 'rou :heel
ReEuire I(4N<
Authentication
chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR wi%% resu%t in timeouts i+
identd is not runnin' on the c%ient
>er+orm Re.erse (N"
9oo)us
chec)=o5
er+orm re.erse (N" %oo)us on c%ient I>sR can cause %on'
de%a:s i+ re.erse (N" is not con+i'ured
MasEuerade address strin'
u=%ic I> address or hostnameR set i+ $<> c%ients can not
connect throu'h a NA< de.ice
Minimum assi.e ort inte'er
on%: a.ai%a=%e in Ad.anced ModeR used =: c%ients in >A"3
modeD de+au%t o+ 0 means an: ort a=o.e 1023
Ma5imum assi.e ort inte'er
on%: a.ai%a=%e in Ad.anced ModeR used =: c%ients in >A"3
modeD de+au%t o+ 0 means an: ort a=o.e 1023
9oca% user u%oad
=andwidth
inte'er
on%: a.ai%a=%e in Ad.anced ModeR in K#@sD de+au%t o+ 0
means un%imited
9oca% user down%oad
=andwidth
inte'er
means un%imited
Anon:mous user u%oad
=andwidth
inte'er
means un%imited
Anon:mous user down%oad
=andwidth
inte'er
means un%imited
4na=%e <9" chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR ena=%es encr:ted
connectionsR i+ not ro.idedD a certi+icate wi%% automatica%%:
=e 'enerated and wi%% aear in the "ertifi'ate and *ri#ate
key =o5 once :ou c%ic) -K
<9" o%ic:
dro;down
menu
on%: a.ai%a=%e in Ad.anced ModeR the se%ected o%ic:
de+ines whether the contro% channe%D data channe%D =oth
channe%sD or neither channe%D o+ an $<> session must occur
o.er ""9@<9"R the o%icies are descri=ed here
<9" a%%ow c%ient
rene'otiations
chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR chec)in' this =o5 is %ot
recommended as it =rea)s se.era% securit: measuresR +or this
and the rest o+ the <9" +ie%dsD re+er to modGt%s +or more
detai%s
<9" a%%ow dot %o'in chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD the user's
home director: is chec)ed +or a .tlslogin +i%e which contains
one or more >4M;encoded certi+icatesR i+ not +oundD the user
wi%% =e romted +or assword authentication
<9" a%%ow er user chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD the user's
assword ma: =e sent unencr:ted
<9" common name
reEuired
chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD the common
name in the certi+icate must match the $?(N o+ the host
<9" ena=%e dia'nostics chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)ed when
trou=%eshootin' a connectionD wi%% %o' more .er=ose%:
<9" e5ort certi+icate data chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD e5orts the
certi+icate en.ironment .aria=%es
<9" no certi+icate reEuest chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR tr: chec)in' this =o5 i+
the c%ient can not connect and :ou susect that the c%ient
so+tware is not roer%: hand%in' the ser.er's certi+icate
reEuest
<9" no emt: +ra'ments chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR chec)in' this =o5 is %ot
recommended as it =:asses a securit: mechanism
<9" no session reuse
reEuired
chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR chec)in' this =o5
reduces the securit: o+ the connection so on%: do so i+ the
c%ient does not understand reused ""9 sessions
<9" e5ort standard .ars chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD sets se.era%
en.ironment .aria=%es
<9" use im%icit ""9 chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD wi%% =rea)
c%ients that e5ect e5%icit connections
<9" (N" name reEuired chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD the c%ient's
(N" name must reso%.e to its I> address and the cert must
contain the same (N" name
<9" I> address reEuired chec)=o5
on%: a.ai%a=%e in Ad.anced ModeR i+ chec)edD the c%ient's
certi+icate must contain the I> address that matches the I>
address o+ the c%ient
Certi+icate and ri.ate )e: strin'
on%: a.ai%a=%e in Ad.anced ModeR the ""9 certi+icate and
ri.ate )e: to =e used +or <9" $<> connections
Au5i%iar: arameters strin'
on%: a.ai%a=%e in Ad.anced ModeR on%: a.ai%a=%e in
Ad.anced ModeR inc%ude ro+tdA6B arameters not co.ered
e%sewhere in this screen
<he +o%%owin' e5am%e demonstrates the au5i%iar: arameters that wi%% re.ent a%% users +rom
er+ormin' the $<> (494<4 commandK
<Limit DELE>
DenyAll
</Limit>
8.%.2 Anon+3ous F*P
Anon:mous $<> ma: =e aroriate +or a sma%% networ) where the $reeNA"1 s:stem is not
accessi=%e +rom the Internet and e.er:one in :our interna% networ) needs eas: access to the stored data.
Anon:mous $<> does not reEuire :ou to create a user account +or e.er: user. In additionD asswords
are not reEuired so :ou don't ha.e to mana'e chan'ed asswords on the $reeNA"1 s:stem.
<o con+i'ure anon:mous $<>K
1. Gi,e te (uilt>in ft! user account !er3issions to the .o%ume@dataset to =e shared in "tora'e
N 3o%umes as +o%%owsK
-wnerAuserBK se%ect the =ui%t;in ft* user +rom the dro;down menu
-wnerA'rouBK se%ect the =ui%t;in ft* 'rou +rom the dro;down menu
ModeK re.iew that the ermissions are aroriate +or the share
N6*7: +or $<>D the t:e o+ c%ient does not matter when it comes to the t:e o+ AC9. <his means that
:ou a%wa:s use !ni5 AC9sD e.en i+ Windows c%ients wi%% =e accessin' $reeNA"1 .ia $<>.
2. 'onfigure anon+3ous F*P in "er.ices N $<> =: settin' the +o%%owin' attri=utesK
chec) the =o5 Allo: Anonymo!s ;ogin
>athK =rowse to the .o%ume@dataset@director: to =e shared
3. Start te F*P ser,ice in Contro% "er.ices. C%ic) the red -$$ =utton ne5t to $<>. A+ter a
second or soD it wi%% chan'e to a =%ue -N D indicatin' that the ser.ice has =een ena=%ed.
&. *est te connection +rom a c%ient usin' a uti%it: such as $i%e8i%%a.
In the e5am%e shown in $i'ure 6.,=D a user has inut the +o%%owin' in+ormation into the $i%e8i%%a
c%ientK
I> address o+ the $reeNA"1 ser.erK 142.156.1.11+
!sernameK anonymo!s
>asswordK the emai% address o+ the user
Figure 8.%(: 'onnecting Using File=illa
<he messa'es within the c%ient indicate that the $<> connection is success+u%. <he user can now
na.i'ate the contents o+ the root +o%der on the remote site_this is the .o%ume@dataset that was seci+ied
in the $<> ser.ice con+i'uration. <he user can a%so trans+er +i%es =etween the %oca% site Atheir s:stemB
and the remote site Athe $reeNA"1 s:stemB.
8.%.# S!ecified User Access in croot
I+ :ou reEuire :our users to authenticate =e+ore accessin' the data on the $reeNA"1 s:stemD :ou wi%%
need to either create a user account +or each user or imort e5istin' user accounts usin' Acti.e
(irector: or 9(A>. I+ :ou then create a 0$" dataset +or each userD :ou can chroot each user so that
the: are %imited to the contents o+ their own home director:. (atasets ro.ide the added =ene+it o+
con+i'urin' a Euota so that the si8e o+ the user's home director: is %imited to the si8e o+ the Euota.
<o con+i'ure this scenarioK
1. 'reate a ;FS dataset for eac user in "tora'e N 3o%umes. C%ic) an e5istin' 0$" .o%ume N
Create 0$" (ataset and set an aroriate Euota +or each dataset. Reeat this rocess to create a
dataset +or e.er: user that wi%% need access to the $<> ser.ice.
2. If +ou are not using A8 or <8APJ create a user account for eac user in Account N !sers
N Add !ser. $or each userD =rowse to the dataset created +or that user in the =ome ire'tory
+ie%d. Reeat this rocess to create a user account +or e.er: user that wi%% need access to the $<>
ser.iceD ma)in' sure to assi'n each user their own dataset.
3. Set te !er3issions for eac dataset in "tora'e N 3o%umes. C%ic) the Chan'e >ermissions
=utton +or a dataset to assi'n a user account as -wner o+ that dataset and to set the desired
ermissions +or that user. Reeat +or each dataset.
N6*7: +or $<>D the t:e o+ c%ient does not matter when it comes to the t:e o+ AC9. <his means that
:ou a%wa:s use !ni5 AC9sD e.en i+ Windows c%ients wi%% =e accessin' $reeNA"1 .ia $<>.
&. 'onfigure F*P in "er.ices N $<> with the +o%%owin' attri=utesK
>athK =rowse to the arent .o%ume containin' the datasets
ma)e sure the =o5es +or Allo: Anonymo!s ;ogin and Allo: &oot ;ogin are !%chec0ed
chec) the =o5 Allo: ;o'al 9ser ;ogin
chec) the =o5 Al:ays "hroot
*. Start te F*P ser,ice in Contro% "er.ices. C%ic) the red -$$ =utton ne5t to $<>. A+ter a
second or soD it wi%% chan'e to a =%ue -N D indicatin' that the ser.ice has =een ena=%ed.
,. *est te connection fro3 a client usin' a uti%it: such as $i%e8i%%a.
<o test this con+i'uration in $i%e8i%%aD use the I> address o+ the $reeNA"1 s:stemD the !sername o+ a
user that has =een associated with a datasetD and the >assword +or that user. <he messa'es shou%d
indicate that the authori8ation and the $<> connection are success+u%. <he user can now na.i'ate the
contents o+ the root +o%der on the remote site_this time it is not the entire .o%ume =ut the dataset that
was created +or that user. <he user shou%d =e a=%e to trans+er +i%es =etween the %oca% site Atheir s:stemB
and the remote site Atheir dataset on the $reeNA"1 s:stemB.
8.%.$ 7ncr+!ting F*P
<o con+i'ure an: $<> scenario to use encr:ted connectionsK
1. 7na(le *<S in "er.ices N $<>. Chec) the =o5 .na$le ?;S. -nce :ou ress -KD a certi+icate
and )e: wi%% automatica%%: =e 'enerated +or :ou and ro+td wi%% restart and =e con+i'ured to
use that certi+icate. I+ :ou re+er to use :our own certi+icateD de%ete the automatica%%: 'enerated
one that aears in the "ertifi'ate and *ri#ate key field and aste in :our own certi+icate and
)e:.
2. S!ecif+ secure F*P 0en accessing te FreeNAS s+ste3. $or e5am%eD in $i%e8i%%a inut
ft*s)2281,address A+or an im%icit connectionB or ft*es)2281,address A+or an e5%icit connectionB
as the Host when connectin'. <he +irst time a user connectsD the: shou%d =e resented with the
certi+icate o+ the $reeNA"1 s:stem. C%ic) -K to accet the certi+icate and ne'otiate an
encr:ted connection.
<o +orce encr:ted connectionsD add the +o%%owin' %ine to Au5i%iar: >arametersK
TLS Required on
8.%." *rou(lesooting
<he $<> ser.ice wi%% not start i+ it can not reso%.e the s:stem's hostname to an I> address usin' (N".
<o see i+ the $<> ser.ice is runnin'D oen "he%% and issue the commandK
sockstat -4p 21
I+ there is nothin' %istenin' on ort 21D ro+td isn't runnin'. <o see the error messa'e that occurs when
$reeNA"1 tries to start the $<> ser.iceD 'o to ":stem N "ettin's N Ad.ancedD chec) the =o5 O"how
conso%e messa'es in the +ooterP and c%ic) "a.e. Ne5tD 'o to "er.ices N Contro% "er.ices and switch
the $<> ser.ice o++ then =ac) on in the 2!I. Watch the conso%e messa'es at the =ottom o+ the =rowser
+or errors.
I+ the error re+ers to (N"D either create an entr: in :our %oca% (N" ser.er with the $reeNA"1 s:stem's
hostname and I> address or add an entr: +or the I> address o+ the $reeNA"1 s:stem in the OHost name
data=aseP +ie%d o+ Networ) N 2%o=a% Con+i'uration.
8.) iS'SI
i"C"I is a rotoco% standard +or the conso%idation o+ stora'e data. i"C"I a%%ows $reeNA"1 to act %i)e a
stora'e area networ) A"ANB o.er an e5istin' 4thernet networ). "eci+ica%%:D it e5orts dis) de.ices
o.er an 4thernet networ) that i"C"I c%ients Aca%%ed initiatorsB can attach to and mount. <raditiona%
"ANs oerate o.er +i=re channe% networ)s which reEuire a +i=re channe% in+rastructure such as +i=re
channe% H#AsD +i=re channe% switchesD and discrete ca=%in'. i"C"I can =e used o.er an e5istin'
4thernet networ)D a%thou'h dedicated networ)s can =e =ui%t +or i"C"I tra++ic in an e++ort to =oost
er+ormance. i"C"I a%so ro.ides an ad.anta'e in an en.ironment that uses Windows she%% ro'ramsR
these ro'rams tend to +i%ter ONetwor) 9ocationP =ut i"C"I mounts are not +i%tered. $reeNA"1 uses
ist't to ro.ide i"C"I.
#e+ore con+i'urin' the i"C"I ser.iceD :ou shou%d =e +ami%iar with the +o%%owin' i"C"I termino%o':K
'&AP: an authentication method which uses a shared secret and three;wa: authentication to determine
i+ a s:stem is authori8ed to access the stora'e de.ice and to eriodica%%: con+irm that the session has
not =een hiIac)ed =: another s:stem. In i"C"ID the initiator Ac%ientB er+orms the CHA> authentication.
4utual '&AP: a suerset o+ CHA> in that =oth ends o+ the communication authenticate to each other.
Initiator: a c%ient which has authori8ed access to the stora'e data on the $reeNA"1 s:stem. <he c%ient
reEuires initiator so+tware to connect to the i"C"I share.
*arget: a stora'e resource on the $reeNA"1 s:stem.
7-tent: the stora'e unit to =e shared. It can either =e a +i%e or a de.ice.
<UN: stands +or 9o'ica% !nit Num=er and reresents a %o'ica% "C"I de.ice. An initiator ne'otiates
with a tar'et to esta=%ish connecti.it: to a 9!NR the resu%t is an i"C"I connection that emu%ates a
connection to a "C"I hard dis). Initiators treat i"C"I 9!Ns the same wa: as the: wou%d a raw "C"I or
I(4 hard dri.eR rather than mountin' remote directoriesD initiators +ormat and direct%: mana'e
+i%es:stems on i"C"I 9!Ns.
$reeNA"1 suorts mu%ti%e i"C"I dri.es. When con+i'urin' mu%ti%e i"C"I 9!NsD create a new
tar'et +or each 9!N. >orta% 'rous and initiator 'rous can =e reused without an: issue. "ince ist't
mu%ti%e5es a tar'et with mu%ti%e 9!Ns o.er the same <C> connectionD :ou wi%% e5erience contention
+rom <C> i+ there is more than one tar'et er 9!N.
In order to con+i'ure i"C"IK
1. (ecide i+ :ou wi%% use authenticationD and i+ soD whether it wi%% =e CHA> or mutua% CHA>. I+
usin' authenticationD create an authori8ed access.
2. Create either a de.ice e5tent or a +i%e e5tent to =e used as stora'e.
3. (etermine which hosts are a%%owed to connect usin' i"C"I and create an initiator.
&. Create at %east one orta%.
*. Re.iew the tar'et '%o=a% con+i'uration arameters.
,. Create a tar'et.
/. Associate a tar'et with an e5tent.
6. "tart the i"C"I ser.ice in "er.ices N Contro% "er.ices.
<he rest o+ this section descri=es these stes in more detai%.
8.).1 Autori=ed Accesses
I+ :ou wi%% =e usin' CHA> or mutua% CHA> to ro.ide authenticationD :ou must create an authori8ed
access in "er.ices N I"C"I N Authori8ed Accesses N Add Authori8ed Access. <his screen is shown
in $i'ure 6./a.
N6*7: this screen sets %o'in authentication. <his is di++erent +rom disco.er: authentication which is
set in <ar'et 2%o=a% Con+i'uration.
Figure 8.)a: Adding an iS'SI Autori=ed Access
<a=%e 6./a summari8es the settin's that can =e con+i'ured when addin' an authori8ed accessK
*a(le 8.)a: Autori=ed Access 'onfiguration Settings
2rou I( inte'er
a%%ows di++erent 'rous to =e con+i'ured with di++erent authentication
ro+i%esR +or instanceD a%% users with a 2rou I( o+ 1 wi%% inherit the
authentication ro+i%e associated with 2rou 1
!ser strin'
name o+ user account that wi%% =e created on the $reeNA"1 de.ice +or
CHA> authentication with the user on the remote s:stemR man: initiators
de+au%t to usin' the initiator name as the user
"ecret strin'
assword to =e associated with 9serR the i"C"I standard reEuires that this
=e at %east 12 characters %on'
>eer !ser strin'
on%: inut when con+i'urin' mutua% CHA>R in most cases it wi%% need to =e
the same .a%ue as 9ser
>eer "ecret strin'
the mutua% secret assword which (!$t be di**ere%t tha% the SecretR
reEuired i+ the 1eer 9ser is set
N6*7: CHA> does not wor) with 2%o=a%"AN initiators on Mac -" 7.
As authori8ed accesses are addedD the: wi%% =e %isted under 3iew Authori8ed Accesses. In the e5am%e
shown in $i'ure 6./=D three users Atest1D test2D and test+B and two 'rous A1 and 2B ha.e =een createdD
with 'rou 1 consistin' o+ one CHA> user and 'rou 2 consistin' o+ one mutua% CHA> user and one
CHA> user. C%ic) an authori8ed access entr: to dis%a: its 4dit and (e%ete =uttons.
Figure 8.)(: ?ie0ing Autori=ed Accesses
8.).2 7-tents
In i"C"ID the tar'et .irtua%i8es somethin' and resents it as a de.ice to the i"C"I c%ient. <hat somethin'
can =e a de.ice e5tent or a +i%e e5tentK
8e,ice e-tent: .irtua%i8es an un+ormatted h:sica% dis)D RAI( contro%%erD 8.o%D 8.o% snashotD or an
e5istin' HA"< de.ice.
3irtua%i8in' a sin'%e dis) is s%ow as there is no cachin' =ut .irtua%i8in' a hardware RAI( contro%%er has
hi'her er+ormance due to its cache. <his t:e o+ .irtua%i8ation does a ass;throu'h to the dis) or
hardware RAI( contro%%er. None o+ the =ene+its o+ 0$" are ro.ided and er+ormance is %imited to the
caa=i%ities o+ the dis) or contro%%er.
3irtua%i8in' a 8.o% adds the =ene+its o+ 0$" such as its read cache and write cache. 4.en i+ the c%ient
+ormats the de.ice e5tent with a di++erent +i%es:stemD as +ar as $reeNA"1 is concernedD the data
=ene+its +rom 0$" +eatures such as =%oc) chec)sums and snashots.
File e-tent: a%%ows :ou to e5ort a ortion o+ a 0$" .o%ume. <he ad.anta'e o+ a +i%e e5tent is that :ou
can create mu%ti%e e5orts er .o%ume.
In theor:D a 8.o% and a +i%e e5tent shou%d ha.e identica% er+ormance. In racticeD a +i%e e5tent
outer+orms in reads@writes =ut this is on%: noticea=%e at 10 2# 4thernet seeds or hi'her. $or hi'h
er+ormanceD +i%e e5tents are recommended at this time. $uture chan'es to $ree#"('s 8.o% code wi%%
increase its er+ormance.
7.3.2.1 Adding an *2tent
<o add an e5tentD 'o to "er.ices N I"C"I N 45tents N Add 45tent. In the e5am%e shown in $i'ure
6./cD the de.ice e5tent is usin' the e(*ort 8.o% that was re.ious%: created +rom the 2mnt2#ol!me1
.o%ume.
N6*7: in $reeNA"1 .ersions rior to 6.3.1D i+ a h:sica% dis) was used instead o+ a 8.o% to create a
de.ice e5tentD a =u' wied the artition ta=%e on the dis)D resu%tin' in data %oss. <his =u' was +i5ed in
6.3.1.
<a=%e 6./= summari8es the settin's that can =e con+i'ured when creatin' an e5tent. Note that *ile
exte%t creatio% -ill *ail i* )o! do %ot a""e%d the %a(e o* the *ile to be created to the 'ol!(eHdata$et
%a(e.
Figure 8.)c: Adding an iS'SI 7-tent
*a(le 8.)(: 7-tent 'onfiguration Settings
45tent Name strin'
name o+ e5tentR i+ the .(tent si/e is not 0D it can not =e an e5istin' +i%e
within the .o%ume@dataset
45tent <:e
dro;down
menu
se%ect +rom File or e#i'e
>ath to the
e5tent
=rowse
=utton
on%: aears i+ File is se%ectedR either =rowse to an e5istin' +i%e and use 0
as the .(tent si/eD or =rowse to the .o%ume or datasetD c%ic) the C%ose
=uttonD aend the .(tent Name to the athD and seci+: a .a%ue in .(tent
si/e
(e.ice
dro;down
menu
on%: aears i+ e#i'e is se%ectedR se%ect the un+ormatted dis)D contro%%erD
8.o%D 8.o% snashotD or HA"< de.ice
45tent si8e inte'er
on%: aears i+ File is se%ectedR i+ the si8e is seci+ied as 0D the +i%e must
a%read: e5ist and the actua% +i%e si8e wi%% =e usedR otherwise seci+ies the
si8e o+ the +i%e to create
Comment strin' otiona%
8.).# Initiators
<he ne5t ste is to con+i'ure authori8ed initiatorsD or the s:stems which are a%%owed to connect to the
i"C"I tar'ets on the $reeNA"1 s:stem. <o con+i'ure which s:stems can connectD use "er.ices N
I"C"I N Initiators N Add InitiatorD shown in $i'ure 6./d.
Figure 8.)d: Adding an iS'SI Initiator
N6*7: =e'innin' with 6.2.0D $reeNA"1 contains iscontro%A6B. <his uti%it: a%%ows the $reeNA"1
s:stem to act as an initiator Arather than a tar'etB and must =e run +rom the command %ine. I+ :ou create
a custom con+i'uration +or iscontrolD =ac) it u as it wi%% not sur.i.e a re=oot o+ the s:stem.
<a=%e 6./c summari8es the settin's that can =e con+i'ured when addin' an initiator.
*a(le 8.)c: Initiator 'onfiguration Settings
Initiators strin'
use A;; )e:word or a %ist o+ initiator hostnames searated =: commas with
no sace
Authori8ed
networ)
strin'
use A;; )e:word or a networ) address with CI(R mas) such as
142.156.2.0224
In the e5am%e shown in $i'ure 6./eD two 'rous ha.e =een created. 2rou 1 a%%ows connections +rom
an: initiator on an: networ)R 2rou 2 a%%ows connections +rom an: initiator on the 10.10.1.0224
networ). C%ic) an initiator's entr: to dis%a: its 4dit and (e%ete =uttons.
N6*7: i+ :ou de%ete an initiatorD a warnin' wi%% indicate i+ an: tar'ets or tar'et@e5tent main's
deend uon the initiator. I+ :ou con+irm the de%eteD these wi%% =e de%eted as we%%.
Figure 8.)e: Sa3!le iS'SI Initiator 'onfiguration
8.).$ Portals
A orta% seci+ies the I> address and ort num=er to =e used +or i"C"I connections. "er.ices N I"C"I
N >orta%s N Add >orta% wi%% =rin' u the screen shown in $i'ure 6./+.
<a=%e 6./d summari8es the settin's that can =e con+i'ured when addin' a orta%. I+ :ou need to assi'n
additiona% I> addresses to the orta%D c%ic) the %in) OAdd e5tra >orta% I>P.
Figure 8.)f: Adding an iS'SI Portal
*a(le 8.)d: Portal 'onfiguration Settings
Comment strin'
otiona% descritionR orta%s are automatica%%: assi'ned a numeric 'rou
I(
I> address
dro;down
menu
se%ect the I> address associated with an inter+ace or the wi%dcard address
o+ 0.0.0.0 Aan: inter+aceB
>ort inte'er <C> ort used to access the i"C"I tar'etR de+au%t is +250
$reeNA"1 s:stems with mu%ti%e I> addresses or inter+aces can use a orta% to ro.ide ser.ices on
di++erent inter+aces or su=nets. <his can =e used to con+i'ure mu%ti;ath I@- AM>I-B. M>I- is more
e++icient than a %in) a''re'ation.
I+ the $reeNA"1 s:stem has mu%ti%e con+i'ured inter+acesD orta%s can a%so =e used to ro.ide
networ) access contro%. $or e5am%eD consider a s:stem with +our inter+aces con+i'ured with the
+o%%owin' addressesK
192.1,6.1.1@2&
192.1,6.2.1@2&
192.1,6.3.1@2&
192.1,6.&.1@2&
Fou cou%d create a orta% containin' the +irst two I> addresses A'rou I( 1B and a orta% containin' the
remainin' two I> addresses A'rou I( 2B. Fou cou%d then create a tar'et named A with a >orta% 2rou
I( o+ 1 and a second tar'et named # with a >orta% 2rou I( o+ 2. In this scenarioD ist't wou%d %isten on
a%% +our inter+acesD =ut connections to tar'et A wou%d =e %imited to the +irst two networ)s and
connections to tar'et # wou%d =e %imited to the %ast two networ)s.
Another scenario wou%d =e to create a orta% which inc%udes e.er: I> address exce"t +or the one used
=: a mana'ement inter+ace. <his wou%d re.ent i"C"I connections to the mana'ement inter+ace.
8.)." *arget Glo(al 'onfiguration
"er.ices N i"C"I N <ar'et 2%o=a% Con+i'urationD shown in $i'ures 6./'D contains settin's that a%:
to a%% i"C"I shares. <a=%e 6./e summari8es the settin's that can =e con+i'ured in the <ar'et 2%o=a%
Con+i'uration screen. <he inte'er .a%ues in the ta=%e are used to tune networ) er+ormanceR most o+
these .a%ues are descri=ed in R$C 3/20.
9!C A9o'ica% !nit Contro%%erB is an A>I ro.ided =: ist't to contro% remo.a=%e media =: ro.idin'
+unctions to %ist tar'etsD %oad or un%oad a media to a unitD chan'e media +i%eD or reset a 9!N.
In order to d:namica%%: add or remo.e tar#et$ without restartin' the i"C"I ser.iceD which can disrut
i"C"I initiatorsD set the +o%%owin' otionsK
chec) the .na$le ;9" =o5
%ea.e the "ontroller 81 address and "ontrol A!thori/ed Net:ork at their de+au%t .a%ues
chan'e the "ontroller A!th <ethod to None
N6*7: the +o%%owin' oerations do reEuire that the i"C"I ser.ice =e restartedK editin' a tar'etD addin'
or de%etin' 9!NsD or chan'in' the si8e o+ an e5istin' e5tent.
Figure 8.)g: iS'SI *arget Glo(al 'onfiguration ?aria(les
*a(le 8.)f: *arget Glo(al 'onfiguration Settings
#ase Name strin'
see the OConstructin' i"C"I names usin' the iEn. +ormatP section
o+ R$C 3/21 i+ :ou are un+ami%iar with this +ormat
(isco.er: Auth
Method
dro;down
menu
con+i'ures the authentication %e.e% reEuired =: the tar'et +or
disco.er: o+ .a%id de.icesD where None wi%% a%%ow anon:mous
disco.er:D "=A1 and <!t!al "=A1 reEuire authenticationD and
A!to %ets the initiator decide the authentication scheme
(isco.er: Auth 2rou
dro;down
menu
deends on (isco.er: Auth Method settin'K reEuired i+ set to
"=A1 or <!t!al "=A1D otiona% i+ set to A!toD and not needed
i+ set to None
I@- <imeout
inte'er
reresentin'
seconds
sets the %imit on how %on' an I@- can =e outstandin' =e+ore an
error condition is returnedR .a%ues ran'e +rom 0;300 with a
de+au%t o+ +0
N->IN Inter.a%
inte'er
reresentin'
seconds
how o+ten the tar'et sends a N->;IN ac)et to )ee a disco.ered
session a%i.eR .a%ues ran'e +rom 0;300 with a de+au%t o+ 20
Ma5. "essions inte'er
%imits the num=er o+ sessions the tar'et orta% wi%% create@accet
+rom initiator orta%sR .a%ues ran'e +rom 1;,**3, with a de+au%t
o+ 15
Ma5. Connections inte'er
the num=er o+ connections a sin'%e initiator can ma)e to a sin'%e
tar'etR .a%ues ran'e +rom 1;,**3, with a de+au%t o+ 6
Ma5. re;send R2< inte'er .a%ues ran'e +rom 1;2** with a de+au%t o+ +2
Ma5-utstandin'R2< inte'er
the ma5imum num=er o+ read: to recei.e ac)ets AR2<sB the
tar'et can ha.e outstandin' +or a sin'%e i"C"I commandD where
%ar'er .a%ues shou%d :ie%d er+ormance increases unti%
Ma5-utstandin'R2< e5ceeds the si8e o+ the %ar'est Write I@-
di.ided =: Ma5#urst9en'thR .a%ues ran'e +rom 1;2** with a
de+au%t o+ 15
$irst =urst %en'th inte'er
ma5imum amount in =:tes o+ unso%icited data an i"C"I initiator
ma: send to the tar'et durin' the e5ecution o+ a sin'%e "C"I
commandR .a%ues ran'e +rom 1; 2`32 with a de+au%t o+ 5D3D+5
Ma5 =urst %en'th inte'er
ma5imum write si8e in =:tes the tar'et is wi%%in' to recei.e
=etween R2<sR .a%ues ran'e +rom 1;2`32 with a de+au%t o+
2523144
Ma5 recei.e data
se'ment %en'th
inte'er in =:tesR .a%ues ran'e +rom 1;2`32 with a de+au%t o+ 2523144
(e+au%t<ime2Wait inte'er
minimum time in seconds to wait =e+ore attemtin' a %o'out or
an acti.e tas) reassi'nment a+ter an une5ected connection
termination or resetR .a%ues ran'e +rom 1;300 with a de+au%t o+ 2
(e+au%t<ime2Retain inte'er
ma5imum time in seconds a+ter <ime2Wait =e+ore which an
acti.e tas) reassi'nment is sti%% ossi=%e a+ter an une5ected
connection termination or resetR .a%ues ran'e +rom 1;300 with a
de+au%t o+ 50
4na=%e 9!C chec)=o5
chec) i+ :ou need to d:namica%%: add and remo.e tar'etsR i+
chec)edD the ne5t three +ie%ds are acti.ated and reEuired
Contro%%er I> address I> address )ee the de+au%t .a%ue o+ 127.0.0.1
Contro%%er <C> ort inte'er
ossi=%e .a%ues ran'e +rom 102&;,**3* with a de+au%t .a%ue o+
+251
Contro%%er Authori8ed
netmas)
su=net mas) )ee the de+au%t .a%ue o+ 127.0.0.026
Contro%%er Auth
Method
dro;down
menu
choices are NoneD A!toD "=A1D or <!t!al "=A1
Contro%%er Auth 2rou
dro;down
menu
reEuired i+ Contro%%er Auth Method is set to "=A1 or <!t!al
"=A1D otiona% i+ set to A!toD and not needed i+ set to None
I+ the settin's in this screen di++er +rom the settin's on the initiatorD set them to =e the same. When
ma)in' chan'esD a%wa:s match the %ar'er settin'.
I+ :ou are chan'in' inte'er .a%ues to otimi8e the connectionD re+er to the i"C"I initiator's
documentation. $or e5am%eD the +o%%owin' modi+ications are recommended i+ the i"C"I initiator is
runnin' on 7enser.erK
Ma5. re;send R2<K 2DD
Ma5-utstandin'R2<K 54
$irst =urst %en'thK 2523144
Ma5 =urst %en'thK 2304731D2
8.).% *argets
Ne5tD create a <ar'et usin' "er.ices N I"C"I N <ar'ets N Add <ar'etD as shown in $i'ure 6./h. A
tar'et com=ines a orta% I(D a%%owed initiator I(D and an authentication method. <a=%e 6./+ summari8es
the settin's that can =e con+i'ured when creatin' a <ar'et.
N6*7: an i"C"I tar'et creates a =%oc) de.ice that ma: =e accessi=%e to mu%ti%e initiators. A c%ustered
+i%es:stem is reEuired on the =%oc) de.iceD such as 3M$" used =: 3MWare 4"7@4"7iD in order +or
mu%ti%e initiators to mount the =%oc) de.ice read@write. I+ a traditiona% +i%es:stem such as 47<D 7$"D
$A<D N<$"D !$"D or 0$" is %aced on the =%oc) de.iceD care must =e ta)en that on%: one initiator at a
time has read@write access or the resu%t wi%% =e +i%es:stem corrution. I+ :ou need to suort mu%ti%e
c%ients to the same data on a non;c%ustered +i%es:stemD use CI$" or N$" instead o+ i"C"I or create
mu%ti%e i"C"I tar'ets Aone er c%ientB.
Figure 8.): Adding an iS'SI *arget
*a(le 8.)f: *arget Settings
<ar'et Name strin'
reEuired .a%ueR =ase name wi%% =e aended automatica%%: i+ it does
not start with iOn
<ar'et A%ias strin' otiona% user;+riend%: name
"eria% strin'
uniEue I( +or tar'et to a%%ow +or mu%ti%e 9!NsR the de+au%t is
'enerated +rom the s:stem's MAC address
<ar'et $%a's
dro;down
menu
choices are read-:rite or read-only
>orta% 2rou I(
dro;down
menu
%ea.e emt: or se%ect num=er o+ e5istin' orta% to use
Initiator 2rou I(
dro;down
menu
se%ect which e5istin' initiator 'rou has access to the tar'et
Auth Method
dro;down
menu
choices are NoneD A!toD "=A1D or <!t!al "=A1
Authentication
2rou num=er
dro;down
menu
None or inte'er reresentin' num=er o+ e5istin' authori8ed access
?ueue (eth inte'er
see this ost +or an e5%anation o+ the math in.o%.edR .a%ues are 0;
2** where 0 is disa=%ed and de+au%t is +2
9o'ica% #%oc) "i8e inte'er
shou%d on%: =e chan'ed to emu%ate a h:sica% dis)'s si8e or to
increase the =%oc) si8e to a%%ow +or %ar'er +i%es:stems on an oeratin'
s:stem %imited =: =%oc) countR de+au%t is D12
8.).) *argetE7-tents
<he %ast ste is associatin' an e5tent to a tar'et within "er.ices N I"C"I N <ar'et@45tents N Add
<ar'et@45tent. <his screen is shown in $i'ure 6./i. !se the dro;down menus to se%ect the e5istin'
tar'et and e5tent.
Figure 8.)i: Associating iS'SI *argetsE7-tents
<a=%e 6./' summari8es the settin's that can =e con+i'ured when associatin' tar'ets and e5tents.
*a(le 8.)g: *argetE7-tents 'onfiguration Settings
<ar'et dro;down menu se%ect the re;created tar'et
45tent dro;down menu se%ect the re;created e5tent
It is recommended to a%wa:s associate e5tents to tar'ets in a 1K1 mannerD e.en thou'h the 2!I wi%%
a%%ow mu%ti%e e5tents to =e associated with the same tar'et.
-nce i"C"I has =een con+i'uredD don't +or'et to start it in "er.ices N Contro% "er.ices. C%ic) the red
-$$ =utton ne5t to i"C"I. A+ter a second or soD it wi%% chan'e to a =%ue -ND indicatin' that the ser.ice
has started.
8.).8 'onnecting to iS'SI Sare
In order to access the i"C"I tar'etD c%ients wi%% need to use i"C"I initiator so+tware.
An i"C"I Initiator c%ient is re;insta%%ed with Windows /. A detai%ed how;to +or this c%ient can =e +ound
here. A c%ient +or Windows 2000D 7>D and 2003 can =e +ound here. <his how;to shows how to create an
i"C"I tar'et +or a Windows / s:stem.
Mac -" 7 does not inc%ude an initiator. '%o=a%"AN is a commercia%D eas:;to;use Mac initiator.
#"( s:stems ro.ide command %ine initiatorsK iscontro%A6B comes with $ree#"(D iscsi;initiatorA6B
comes with Net#"(D and iscsidA6B comes with -en#"(.
"ome 9inu5 distros ro.ide the command %ine uti%it: iscsiad3 +rom -en;i"C"I. !se a we= search to
see i+ a ac)a'e e5ists +or :our distri=ution shou%d the command not e5ist on :our 9inu5 s:stem.
I+ :ou add a 9!N whi%e iscsiad3 is a%read: connectedD it wi%% not see the new 9!N unti% :ou rescan
usin' iscsiad3 >3 node >2. A%ternate%:D use iscsiad3 >3 disco,er+ >t st >! O!ortal:IPP to +ind the
new 9!N and iscsiad3 >3 node >* O<UN:Na3eP >l to %o' into the 9!N.
Instructions +or connectin' +rom a 3Mware 4"7i "er.er can =e +ound at How to con+i'ure $reeNA" 6
+or i"C"I and connect to 4"7AiB. Note that the reEuirements +or =ootin' ."here &.5 o++ i"C"I di++er
=etween 4"7 and 4"7i. 4"7 reEuires a hardware i"C"I adater whi%e 4"7i reEuires seci+ic i"C"I
=oot +irmware suort. <he ma'ic is on the =ootin' host sideD meanin' that there is no di++erence to the
$reeNA"1 con+i'uration. "ee the i"C"I "AN Con+i'uration 2uide +or detai%s.
I+ :ou can see the tar'et =ut not connect to itD chec) the disco.er: authentication settin's in <ar'et
2%o=a% Con+i'uration.
I+ the 9!N is not disco.ered =: 4"7iD ma)e sure that romiscuous mode is set to Accet in the
.switch.
<o determine which initiators are connectedD t:e istgtcontrol info within "he%%.
8.).9 Gro0ing <UNs
<he method used to 'row the si8e o+ an e5istin' i"C"I 9!N deends on whether the 9!N is =ac)ed =:
a +i%e e5tent or a 8.o%. #oth methods are descri=ed in this section.
A+ter the 9!N is e5anded usin' one o+ the methods =e%owD use the too%s +rom the initiator so+tware to
'row the artitions and the +i%es:stems it contains.
7.3.0.1 .vol Based +'$
#e+ore 'rowin' a 8.o% =ased 9!ND ma)e sure that a%% initiators are disconnected. "to the i"C"I
ser.ice in Contro% "er.ices.
-en "he%% and identi+: the 8.o% to =e 'rownK
zfs list -t volume
NAME USED AVAIL REFER MOUNTPOINT
tank/iscsi_zvol 4G 17.5G 33.9M -
<henD 'row the 8.o%. <his e5am%e 'rows tank2is'si,/#ol +rom &2 to ,2K
zfs set volsize=6G tank/iscsi_zvol
zfs set refreservation=6G tank/iscsi_zvol
3eri+: that the chan'es ha.e ta)en e++ectK
zfs list -t volume
NAME USED AVAIL REFER MOUNTPOINT
tank/iscsi_zvol 6G 17.5G 33.9M -
Fou can now start the i"C"I ser.ice and a%%ow initiators to connect.
7.3.0.2 #ile *2tent Based +'$
#e+ore 'rowin' a +i%e e5tent =ased 9!ND ma)e sure that a%% initiators are disconnected. "to the i"C"I
ser.ice in Contro% "er.ices.
<henD 'o to "er.ices N i"C"I N $i%e 45tents N 3iew $i%e 45tents to determine the ath o+ the +i%e
e5tent to 'row. -en "he%% to 'row the e5tent. <his e5am%e 'rows 2mnt2#ol!me12data =: 22K
truncate -s +2g /mnt/volume1/data
2o =ac) to "er.ices N i"C"I N $i%e 45tents N 3iew $i%e 45tents and c%ic) the 4dit =utton +or the +i%e
e5tent. "et the si8e to 0 as this causes the i"C"I tar'et to use the new si8e o+ the +i%e.
Fou can now start the i"C"I ser.ice and a%%ow initiators to connect.
8.8 NFS
Networ) $i%e ":stem AN$"B is a rotoco% +or sharin' +i%es on a networ). #e+ore con+i'urin' this
ser.iceD :ou shou%d +irst create :our N$" "hares in "harin' N !ni5 AN$"B "hares N Add !ni5 AN$"B
"hare. A+ter con+i'urin' this ser.iceD 'o to "er.ices N Contro% >ane% to start the ser.ice.
<C> and !(> 111 Aused =: r!c(indB
<C> 20&9 Aused =: nfsdB
Additiona%%:D 3ountd and r!c(ind wi%% each =ind to a random%: a.ai%a=%e !(> ort.
$i'ure 6.6a shows the con+i'uration screen and <a=%e 6.6a summari8es the con+i'uration otions +or the
N$" ser.ice.
Figure 8.8a: 'onfiguring NFS
*a(le 8.8a: NFS 'onfiguration 6!tions
Num=er o+ ser.ers inte'er
run s+sctl >n 9ern.s3!.c!us +rom "he%% to determine the num=erR
do not e5ceed the num=er %isted in the outut o+ that command
"er.e !(> N$"
c%ients
chec)=o5 chec) i+ N$" c%ient needs to use !(>
#ind I> Addresses chec)=o5es
se%ect the I> addressAesB to %isten +or N$" reEuestsR i+ %e+t
unchec)edD N$" wi%% %isten on a%% a.ai%a=%e addresses
A%%ow non;root mount chec)=o5 chec) this =o5 on%: i+ the N$" c%ient reEuires it
mountdA6B =ind ort inte'er otiona%R seci+: ort +or mountdA6B to =ind to
rc.statdA6B =ind ort inte'er otiona%R seci+: ort +or rc.statdA6B to =ind to
rc.%oc)dA6B =ind ort inte'er otiona%R seci+: ort +or rc.%oc)dA6B to =ind to
8.9 2s+nc
"er.ices N Rs:nc is used to con+i'ure an rs:nc ser.er when usin' rs:nc modu%e mode. "ee
Con+i'urin' Rs:nc Modu%e Mode +or a con+i'uration e5am%e.
<his section descri=es the con+i'ura=%e otions +or the rs+ncd ser.ice and rs:nc modu%es.
$i'ure 6.9a shows the rs:ncd con+i'uration screen which is accessed +rom "er.ices N Rs:nc N
Con+i'ure Rs:ncd.
Figure 8.9a: 2s+ncd 'onfiguration
<a=%e 6.9a summari8es the otions that can =e con+i'ured +or the rs:nc daemonK
*a(le 8.9a: 2s+nc 'onfiguration 6!tions
<C> >ort inte'er ort +or rs+ncd to %isten onD de+au%t is 67+
Au5i%iar: arameters strin' additiona% arameters +rom rs:ncd.con+A*B
8.9.1 2s+nc 4odules
$i'ure 6.9= shows the con+i'uration screen that aears when :ou c%ic) "er.ices N Rs:nc N Rs:nc
Modu%es N Add Rs:nc Modu%e.
<a=%e 6.9= summari8es the otions that can =e con+i'ured when creatin' a rs:nc modu%e.
Figure 8.9(: Adding an 2s+nc 4odule
*a(le 8.9(: 2s+nc 4odule 'onfiguration 6!tions
Modu%e name strin' mandator:R needs to match the settin' on the rs:nc c%ient
>ath =rowse =utton .o%ume@dataset to ho%d recei.ed data
Access Mode
dro;down
menu
choices are &ead and JriteD &ead-onlyD or Jrite-only
Ma5imum
connections
inte'er 0 is un%imited
!ser
dro;down
menu
se%ect user that +i%e trans+ers to and +rom that modu%e shou%d
ta)e %ace as
2rou
dro;down
menu
se%ect 'rou that +i%e trans+ers to and +rom that modu%e shou%d
ta)e %ace as
Hosts a%%ow strin' see rs:ncd.con+A*B +or a%%owed +ormats
Hosts den: strin' see rs:ncd.con+A*B +or a%%owed +ormats
Au5i%iar: arameters strin' additiona% arameters +rom rs:ncd.con+A*B
8.10 S.4.A.2.*.
$reeNA"1 uses the smartdA6B ser.ice to monitor dis) ".M.A.R.<. data +or dis) hea%th. <o +u%%:
con+i'ure ".M.A.R.<. :ou need toK
1. "chedu%e when to run the ".M.A.R.<. tests in ":stem N ".M.A.R.<. <ests N Add ".M.A.R.<.
<est.
2. 4na=%e or disa=%e ".M.A.R.<. +or each dis) mem=er o+ a .o%ume in 3o%umes N 3iew 3o%umes.
#: de+au%tD this is a%read: ena=%ed on a%% dis)s that suort ".M.A.R.<.
3. Chec) the con+i'uration o+ the ".M.A.R.<. ser.ice as descri=ed in this section.
&. "tart the ".M.A.R.<. ser.ice in "er.ices N Contro% "er.ices
$i'ure 6.10a shows the con+i'uration screen that aears when :ou c%ic) "er.ices N ".M.A.R.<.
Figure 8.10a: S.4.A.2.* 'onfiguration 6!tions
N6*7: s3artd wi%% wa)e u at e.er: "he'k 8nter#al con+i'ured in $i'ure 6.10a. It wi%% chec) the
times :ou con+i'ured in :our tests Adescri=ed in $i'ure &.*aB to see i+ an: tests shou%d =e run. "ince the
sma%%est time increment +or a test is an hour A,0 minutesBD it does not ma)e sense to set a chec) inter.a%
.a%ue hi'her than ,0 minutes. $or e5am%eD i+ :ou set the chec) inter.a% +or 120 minutes and the smart
test to e.er: hourD the test wi%% on%: =e run e.er: 2 hours since the daemon on%: wa)es u e.er: 2
hours.
<a=%e 6.10a summari8es the otions in the ".M.A.R.< con+i'uration screen.
*a(le 8.10a: S.4.A.2.* 'onfiguration 6!tions
Chec) inter.a% inte'er
in minutesD how o+ten to wa)e u s3artd to chec) to see i+ an:
tests ha.e =een con+i'ured to run
>ower mode dro;down menu
the con+i'ured test is not er+ormed i+ the s:stem enters the
seci+ied ower modeR choices areK Ne#erD Slee*D Stand$yD or 8dle
(i++erence
inte'er in de'rees
Ce%sius
de+au%t o+ 0 disa=%es this chec)D otherwise reorts i+ the
temerature o+ a dri.e has chan'ed =: N de'rees Ce%sius since
%ast reort
In+ormationa%
inte'er in de'rees
Ce%sius
de+au%t o+ 0 disa=%es this chec)D otherwise wi%% messa'e with a %o'
%e.e% o+ 9-2GIN$- i+ the temerature is hi'her than seci+ied
de'rees in Ce%sius
Critica%
inte'er in de'rees
Ce%sius
de+au%t o+ 0 disa=%es this chec)D otherwise wi%% messa'e with a %o'
%e.e% o+ 9-2GCRI< and send an emai% i+ the temerature is
hi'her than seci+ied de'rees in Ce%sius
4mai% to reort strin'
emai% address o+ erson to recei.e ".M.A.R.<. a%ertR searate
mu%ti%e emai% reciients with a comma and no sace
8.11 SN4P
"NM> A"im%e Networ) Mana'ement >rotoco%B is used to monitor networ);attached de.ices +or
conditions that warrant administrati.e attention. $reeNA"1 can =e con+i'ured as a =snmdA6B ser.er
usin' $ree#"('s sim%e and e5tensi=%e "NM> daemon. When :ou start the "NM> ser.iceD the
+o%%owin' ort wi%% =e ena=%ed on the $reeNA"1 s:stemK
!(> 1,1 A(sn3!d %istens here +or "NM> reEuestsB
A.ai%a=%e MI#" are %ocated in 2!sr2share2SN<12mi$s and 2!sr2lo'al2share2SN<12mi$s.
$i'ure 6.11a shows the "NM> con+i'uration screen. <a=%e 6.11a summari8es the con+i'uration otions.
Figure 8.11a: 'onfiguring SN4P
*a(le 8.11a: SN4P 'onfiguration 6!tions
9ocation strin' otiona% descrition o+ $reeNA"1 s:stem's %ocation
Contact strin' otiona% emai% address o+ $reeNA"1 administrator
Communit: strin'
assword used on the "NM> networ)D de+au%t is *!$li' and $ho!ld
be cha%#ed *or $ec!rit) rea$o%$
Au5i%iar: >arameters strin' additiona% =snmdA6B otions not co.ered in this screenD one er %ine
8.12 SS&
"ecure "he%% A""HB a%%ows +or +i%es to =e trans+erred secure%: o.er an encr:ted networ). I+ :ou
con+i'ure :our $reeNA"1 s:stem as an ""H ser.erD the users in :our networ) wi%% need to use ""H
c%ient so+tware in order to trans+er +i%es usin' ""H.
<his section shows the $reeNA"1 ""H con+i'uration otionsD demonstrates an e5am%e con+i'uration
that restricts users to their home director:D and ro.ides some trou=%eshootin' tis.
8.12.1 SS& 'onfiguration Screen
$i'ure 6.12a shows the "er.ices N ""H con+i'uration screen. -nce :ou ha.e con+i'ured ""HD don't
+or'et to start it in "er.ices N Contro% "er.ices.
Figure 8.12a: SS& 'onfiguration
<a=%e 6.12a summari8es the con+i'uration otions. "ome settin's are on%: a.ai%a=%e in Ad.anced
Ad.anced.
*a(le 8.12a: SS& 'onfiguration 6!tions
<C> >ort inte'er ort to oen +or ""H connection reEuestsR 22 =: de+au%t
9o'in as Root with
assword
chec)=o5
*or $ec!rit) rea$o%$/ root lo#i%$ are di$co!ra#ed a%d di$abled b)
de*a!ltI i+ ena=%edD assword must =e set +or root user in Account
N !sers N 3iew !sers
A%%ow >assword
Authentication
chec)=o5
i+ unchec)edD )e: =ased authentication +or a%% users is reEuiredR
reEuires additiona% setu on =oth the ""H c%ient and ser.er
A%%ow <C> >ort
$orwardin'
chec)=o5
a%%ows users to =:ass +irewa%% restrictions usin' ""H's ort
+orwardin' +eature
Comress
Connections
chec)=o5 ma: reduce %atenc: o.er s%ow networ)s
Host >ri.ate Ke: strin'
on%: a.ai%a=%e in Ad.anced ModeR a%%ows :ou to aste a seci+ic
host )e: as the de+au%t )e: is chan'ed with e.er: insta%%ation
"$<> 9o' 9e.e%
dro;down
menu
on%: a.ai%a=%e in Ad.anced ModeR se%ect the s:s%o'A3B %e.e% o+ the
"$<> ser.er
"$<> 9o' $aci%it:
dro;down
menu
on%: a.ai%a=%e in Ad.anced ModeR se%ect the s:s%o'A3B +aci%it: o+
the "$<> ser.er
45tra -tions strin'
on%: a.ai%a=%e in Ad.anced ModeR additiona% sshdGcon+i'A*B
otions not co.ered in this screenD one er %ineR these otions are
case;sensiti.e and mis;se%%in's ma: re.ent the ""H ser.ice +rom
startin'
A +ew sshdGcon+i'A*B otions that are use+u% to inut in the .(tra @*tions +ie%d inc%udeK
'lientAli,eInter,alK increase this num=er i+ ssh connections tend to dro
'lient4a-Startu!K de+au%ts to 10R increase i+ :ou ha.e more users
8.12.2 'rooting 'o33and <ine SF*P Users
#: de+au%t when :ou con+i'ure ""HD users can use the ss command to %o'in to the $reeNA"1 s:stem.
A user's home director: wi%% =e the .o%ume@dataset seci+ied in the =ome ire'tory +ie%d o+ their user
account on the $reeNA"1 s:stem. !sers can a%so use the sc! and sft! commands to trans+er +i%es
=etween their %oca% comuter and their home director: on the $reeNA"1 s:stem.
Whi%e these commands wi%% de+au%t to the user's home director:D users are a=%e to na.i'ate outside o+
their home director: which can ose a securit: ris). ""H suorts usin' a chroot to con+ine users to
on%: the sft! command and to =e %imited to the contents o+ their own home director:. <o con+i'ure this
scenario on $reeNA"1D er+orm the +o%%owin' stes.
N6*7: some uti%ities such as Win"C> can =:ass the chroot. <his section assumes that users are
accessin' the chroot usin' the command %ine sft!.
1. 'reate a ;FS dataset for eac user reBuiring sft! access in "tora'e N 3o%umes.
2. If +ou are not using Acti,e 8irector+ or <8APJ create a user account +or each user in
Account N !sers N Add !ser. In the =ome ire'tory +ie%dD =rowse to the %ocation o+ the
dataset :ou created +or that user. Reeat this rocess to create a user account +or e.er: user that
wi%% need access to the ""H ser.ice.
3. 'reate a grou! named sft* in Account N 2rous N Add 2rou. <henD c%ic) on the sft* 'rou
in 3iew 2rous and add the users who are to =e restricted to their home directories when usin'
sft!.
&. Set !er3issions for eac dataset in "tora'e N 3o%ume N 3iew 3o%umes. ""H chroot is 'er)
$"eci*ic with re'ards to the reEuired ermissions Asee the Chroot(irector: )e:word in
sshdGcon+i'A*B +or detai%sB. 6o!r co%*i#!ratio% -ill %ot -or0 i* the "er(i$$io%$ o% the
data$et$ !$ed b) SS7 chroot !$er$ di**er *ro( tho$e $ho-% i% Fi#!re >.:<b.
*. Create a home director: within each dataset usin' "he%%. (ue to the ermissions reEuired =:
""H chrootD the user wi%% not ha.e ermissions to write to the root o+ their own dataset unti% :ou
do this. "ince :our intention is to %imit them to the contents o+ their home director:D manua%%:
create a home director: +or each user -ithi% their o-% data$et and chan'e the ownershi o+ the
director: to the user. 45am%e 6.12a demonstrates the commands used to create a home
director: ca%%ed !ser1 +or the user account !ser1 on dataset 2mnt2#ol!me12!ser1K
Figure 8.12(: Per3issions 2eBuired (+ SS& 'root
7-a3!le 8.12a: 'reating a User/s &o3e 8irector+
mkdir /mnt/volume1/user1/user1
chown user1:user1 /mnt/volume1/user1/user1
,. 'onfigure SS& in "er.ices N ""H. Add these %ines to the 45tra -tions sectionK
Match Group sftp
ChrootDirectory %h
ForceCommand internal-sftp
AllowTcpForwarding no
/. Start te SS& ser,ice in Contro% "er.ices. C%ic) the red -$$ =utton ne5t to ""H. A+ter a
second or soD it wi%% chan'e to a =%ue -ND indicatin' that the ser.ice has =een ena=%ed.
6. *est te connection +rom a c%ient =: runnin' sft!D ssD and sc! as the user. <he sft! command
shou%d wor) =ut =e %imited to the user's home director: and the ss and sc! commands shou%d
+ai%.
8.12.# *rou(lesooting SS& 'onnections
I+ :ou add an: .(tra @*tions in the ""H con+i'uration screenD =e aware that the )e:words %isted in
sshdGcon+i'A*B are case sensiti.e. <his means that :our con+i'uration wi%% +ai% to do what :ou intended
i+ :ou do not match the uer and %owercase %etters o+ the )e:word.
I+ :our c%ients are recei.in' Ore.erse (N"P or timeout errorsD add an entr: +or the I> address o+ the
$reeNA"1 s:stem in the =ost name data$ase +ie%d o+ Networ) N 2%o=a% Con+i'uration.
When con+i'urin' ""HD a%wa:s test :our con+i'uration as an ""H user account to ensure that the user
is %imited to what :ou ha.e con+i'ured and that the: ha.e ermission to trans+er +i%es within the
intended directories. I+ the user account is e5eriencin' ro=%emsD the ""H error messa'es are usua%%:
rett: seci+ic to what the ro=%em is. <:e the +o%%owin' command within "he%% to read these
messa'es as the: occurK
tail -f /var/log/messages
Additiona% messa'es re'ardin' authentication errors ma: =e +ound in 2#ar2log2a!th.log.
8.1# *F*P
<ri.ia% $i%e <rans+er >rotoco% A<$<>B is a %i'ht;wei'ht .ersion o+ $<> usua%%: used to trans+er
con+i'uration or =oot +i%es =etween machinesD such as routersD in a %oca% en.ironment. <$<> ro.ides
an e5treme%: %imited set o+ commands and ro.ides no authentication.
I+ the $reeNA"1 s:stem wi%% =e used to store ima'es and con+i'uration +i%es +or the networ)'s de.icesD
con+i'ure and start the <$<> ser.ice. "tartin' the <$<> ser.ice wi%% oen !(> ort ,9.
N6*7: in .ersions o+ $reeNA"1 rior to 6.3.0D <$<> is %imited to a ma5imum +i%e si8e o+ 32M#.
$i'ure 6.13a shows the <$<> con+i'uration screen and <a=%e 6.13a summari8es the a.ai%a=%e otionsK
Figure 8.1#a: *F*P 'onfiguration
*a(le 8.1#a: *F*P 'onfiguration 6!tions
(irector: =rowse =utton
=rowse to the director: to =e used +or stora'eR some de.ices reEuire a
seci+ic director: nameD re+er to the de.ice's documentation +or detai%s
A%%ow New
$i%es
chec)=o5
ena=%e i+ networ) de.ices need to send +i%es to the $reeNA"1 s:stem
Ae.'. =ac)u their con+i'B
>ort inte'er !(> ort to %isten +or <$<> reEuestsD 54 =: de+au%t
!sername
dro;down
menu
account used +or t+t reEuestsR must ha.e ermission to the ire'tory
!mas) inte'er
umas) +or new%: created +i%esD de+au%t is 022 Ae.er:one can readD
no=od: can writeBR some de.ices reEuire a %ess strict umas)
45tra otions strin' additiona% t+tdA6B otions not shown in this screenD one er %ine
8.1$ UPS
$reeNA"1 uses N!< ANetwor) !>" <oo%sB to ro.ide !>" suort. I+ the $reeNA"1 s:stem is
connected to a !>" de.iceD con+i'ure the !>" ser.ice then start it in "er.ices N Contro% "er.ices.
$i'ure 6.1&a shows the !>" con+i'uration screenK
Figure 8.1$a: UPS 'onfiguration Screen
<a=%e 6.1&a summari8es the otions in the !>" Con+i'uration screen.
*a(le 8.1$a: UPS 'onfiguration 6!tions
!>" Mode
dro;down
menu
se%ect +rom <aster or Sla#e
Identi+ier strin'
can contain a%hanumericD eriodD commaD h:henD and
underscore characters
(ri.er
dro;down
menu
suorted !>" de.ices are %isted at
httK@@www.networ)ustoo%s.or'@sta=%e;hc%.htm%
>ort
dro;down
menu
se%ect the seria% or !"# ort the !>" is %u''ed into Asee
N-<4 =e%owB
Au5i%iar: >arameters strin' additiona% otions +rom us.con+A*B
"hutdown mode
dro;down
menu
choices are 91S goes on $attery and 91S rea'hes lo:
$attery
"hutdown timer inte'er
in secondsR wi%% initiate shutdown a+ter this man: seconds
a+ter !>" enters 91S goes on $atteryD un%ess ower is
restored
Monitor !ser strin' de+au%t is !*smon
Monitor >assword strin'
de+au%t is )nown .a%ue fi(me*ass and shou%d =e chan'edR
can not contain a sace or J
45tra users strin'
de+ines the accounts that ha.e administrati.e accessR see
usd.usersA*B +or e5am%es
Remote monitor chec)=o5
i+ ena=%edD =e aware that the de+au%t is to %isten on a%%
inter+aces and to use the )nown .a%ues user !*smon and
assword fi(me*ass
"end 4mai% "tatus !dates chec)=o5 i+ chec)edD acti.ates the ?o email +ie%d
<o emai% emai% address
i+ Send .mail =o5 chec)edD emai% address o+ erson to
recei.e status udates
4mai% su=Iect strin' i+ Send .mail =o5 chec)edD su=Iect o+ emai% udates
N6*7: +or !"# de.icesD the easiest wa: to determine the correct de.ice name is to chec) the =o5
O"how conso%e messa'esP in ":stem N "ettin's N Ad.anced. >%u' in the !"# de.ice and the conso%e
messa'es wi%% 'i.e the name o+ the 2de#2!genX.X de.iceR where the 7's are the num=ers that show on
the conso%e.
uscA6B can =e used to 'et status .aria=%es +rom the !>" daemon such as the current char'e and inut
.o%ta'e. It can =e run +rom "he%% usin' the +o%%owin' s:nta5. <he man a'e 'i.es some other usa'e
e5am%es.
upsc ups@localhost
uscmdA6B can =e used to send commands direct%: to the !>"D assumin' that the hardware suorts the
command =ein' sent. -n%: users with administrati.e ri'hts can use this command. <hese users are
created in the .(tra !sers +ie%d.
9 Plugins
$reeNA"1 6.2.0 introduced the a=i%it: to e5tend the =ui%t;in NA" ser.ices =: ro.idin' a mechanism
+or insta%%in' additiona% so+tware. <his mechanism was )nown as the >%u'ins architecture and is =ased
on $ree#"( Iai%s and >C;#"( >#Is. <his a%%owed users to insta%% and con+i'ure additiona% a%ications
once the: had created and con+i'ured a %u'ins Iai%.
$reeNA"1 9.5 sim%i+ies this rocedure =: ro.idin' two methods +or so+tware insta%%ation. <he
>%u'ins methodD descri=ed in this sectionD is meant +or users who re+er to =rowse +orD insta%%D and
con+i'ure a.ai%a=%e so+tware usin' the 2!I. <his method is .er: eas: to useD =ut is %imited in the
amount o+ so+tware that is a.ai%a=%e. 4ach a%ication wi%% automatica%%: =e insta%%ed into its own Iai%D
meanin' that this method ma: not =e suita=%e +or users who wish to run mu%ti%e a%ications within
the same Iai%.
<he Cai%s method ro.ides much more contro% o.er so+tware insta%%ation =ut assumes that the user is
com+orta=%e wor)in' +rom the command %ine can and has a 'ood understandin' o+ networ)in' =asics
and so+tware insta%%ation on $ree#"(;=ased s:stems.
It is recommended that users s)im throu'h =oth the >%u'ins and Cai%s sections in order to =ecome
+ami%iar with the +eatures and %imitations o+ each and to choose the method that =est meets their
so+tware needs.
(ue to A#I Aa%ication =inar: inter+aceB chan'esD $reeNA"1 6.5 >#Is can not =e insta%%ed on a 9.5
s:stem.
9.1 Installing a FreeNAS P5I Using Plugins
A $reeNA"1 >#I is a se%+;contained a%ication insta%%er which has =een desi'ned to inte'rate into the
$reeNA"1 2!I. A $reeNA"1 >#I o++ers se.era% ad.anta'esK
the $reeNA"1 2!I ro.ides a =rowser +or .iewin' the %ist o+ a.ai%a=%e $reeNA"1 >#Is. <his
%ist is a%so a.ai%a=%e at A.ai%a=%e $reeNA"1 >#Is.
the $reeNA"1 2!I ro.ides =uttons +or insta%%in'D startin'D u'radin'D and de%etin' $reeNA"1
>#Is.
i+ the $reeNA"1 >#Is has con+i'uration otionsD a screen wi%% =e added to the $reeNA"1 2!I
so that these otions can =e con+i'ured +rom the 2!I.
$reeNA"1 >#Is can =e insta%%ed usin' either the >%u'ins or the Cai%s method.
<o insta%% a $reeNA"1 >#I usin' the %u'ins methodD c%ic) >%u'ins. As seen in $i'ure 9.1aD the %ist o+
a.ai%a=%e $reeNA"1 >#Is wi%% =e dis%a:ed.
Figure 9.1a: Using Plugins to Install a P5I
N6*7: i+ the %ist o+ a.ai%a=%e >#Is is not dis%a:edD oen "he%% and .eri+: that the $reeNA"1 s:stem
can !ing an address on the Internet. I+ it cannotD :ou ma: ha.e to add a de+au%t 'atewa: address and@or
(N" ser.er address in Networ) N 2%o=a% Con+i'uration.
Hi'h%i'ht the entr: o+ the >#I :ou wou%d %i)e to insta%%D then c%ic) its Insta%% =utton. In the e5am%e
shown in $i'ure 9.1=D the transmission >#I is se%ected +or insta%%ation.
Figure 9.1(: Selecting a P5I to Install
C%ic) O-KP to start the insta%%ation. It wi%% ta)e a +ew minutes as the s:stem wi%% +irst down%oad and
con+i'ure a Iai% to contain the insta%%ed so+tware. It wi%% then insta%% the >#I and add it to the OInsta%%edP
ta= as shown in $i'ure 9.1c. #e atient as it ma: ta)e a +ew minutes +or the insta%%ation to +inish.
Figure 9.1c: ?ie0ing Installed P5Is
9.1.1 4anaging an Installed FreeNAS P5I
As seen in the e5am%e shown in $i'ure 9.1cD entries +or the insta%%ed >#I wi%% aear in the +o%%owin'
%ocationsK
the Insta%%ed ta= o+ >%u'ins
the >%u'ins section o+ the tree
the Cai%s section o+ the tree
<he entr: in the Insta%%ed ta= o+ >%u'ins wi%% dis%a: the %u'in name and .ersionD the name o+ the >#I
that was insta%%edD the name o+ the Iai% that was createdD whether the a%ication status is -N or -$$D
and a =utton to de%ete the a%ication and its associated Iai%. I+ a newer .ersion o+ the a%ication is
a.ai%a=%eD a =utton to udate the a%ication wi%% a%so aear.
<he M"er.ice statusM o+ a >#I must =e turned to M-NM =e+ore the insta%%ed a%ication is a.ai%a=%e.
#e+ore startin' the ser.iceD chec) to see i+ it has an: con+i'uration otions =: c%ic)in' its entr: in the
>%u'ins section o+ the tree. I+ the a%ication is con+i'ura=%eD this wi%% oen a 'rahica% screen that
contains its a.ai%a=%e con+i'uration otions. <he otions that are a.ai%a=%e wi%% .ar: =: >#I. >#Is
which are not con+i'ura=%e wi%% instead dis%a: a messa'e with a h:er%in) +or accessin' the so+tware.
<hat h:er%in) wi%% not wor) unti% the >#I is started.
Fou shou%d a%wa:s re.iew a >#I's con+i'uration otions =e+ore attemtin' to start it as some >#Is ha.e
otions that need to =e set =e+ore their ser.ice wi%% success+u%%: start. I+ :ou ha.e ne.er con+i'ured this
a%ication =e+oreD chec) the a%ication's we=site to see what documentation is a.ai%a=%e. A %in) to the
we=site +or each a.ai%a=%e >#I can =e +ound in A.ai%a=%e $reeNA"1 >#Is.
I+ the a%ication reEuires access to the data stored on the $reeNA"1 s:stemD c%ic) the entr: +or the
associated Iai% in the Cai%s section o+ the tree and add a stora'e as descri=ed here.
I+ :ou need to access the she%% o+ the Iai% containin' the a%ication to com%ete or test :our
con+i'urationD c%ic) the entr: +or the associated Iai% in the Cai%s section o+ the tree. Fou can then c%ic) its
she%% icon as descri=ed in Mana'in' Cai%s.
-nce the con+i'uration is com%eteD c%ic) the red -$$ =utton in the entr: +or the >#I. I+ the ser.ice
success+u%%: startsD it wi%% chan'e to a =%ue -N. I+ it +ai%s to startD c%ic) the Iai%'s she%% icon and t:e
tail E,arElogE3essages to see i+ an: errors were %o''ed.
9.1.2 U!dating an Installed FreeNAS P5I
I+ a newer .ersion o+ a $reeNA"1 >#I =ecomes a.ai%a=%e in the o++icia% reositor:D an M!dateM =utton
wi%% =e added to the entr: o+ the >#I in the MInsta%%edM ta=. In the e5am%e shown in $i'ure 9.1dD a
newer .ersion o+ Minid%na is a.ai%a=%e.
Figure 9.1d: U!dating an Installed P5I
C%ic) the M-KM =utton and the %atest .ersion o+ the >#I wi%% automatica%%: =e down%oaded and insta%%ed.
-nce the udate is com%eteD the entr: +or the >#I wi%% =e re+reshed to show the new .ersion num=er
and the M!dateM =utton wi%% disaear.
9.1.# Installing Additional P5Is
<he MA.ai%a=%eM ta= o+ >%u'ins contains an M!%oadM =utton. <his =utton a%%ows :ou to insta%% >#Is that
are not :et a.ai%a=%e in the o++icia% reositor:. <hese >#Is inc%ude $reeNA"1 >#Is which are sti%%
=ein' tested as we%% as >C;#"( >#Is. <hese >#Is must =e manua%%: down%oaded +irst and shou%d end
in a .*$i e5tension. When down%oadin' a >#ID ma)e sure that it matches the architecture A32; or ,&;=itB
o+ the $reeNA"1 s:stem and that it was de.e%oed +or 9.5 as 6.5 and 10.5 >#Is wi%% not wor) on a 9.5
$reeNA"1 s:stem.
-nce :ou ha.e down%oaded the >#ID c%ic) the M!%oadM =utton. As seen in the e5am%e in $i'ure 9.1eD
this wi%% romt :ou to =rowse to the %ocation o+ the down%oaded >#I. -nce the >#I is se%ectedD c%ic)
the M!%oadM =utton to insta%% the >#I. In this e5am%eD the user is insta%%in' the >C;#"( >#I +or
we=min.
Figure 9.1e: Installing a Pre,iousl+ 8o0nloaded P5I
When the insta%%ation is com%eteD an entr: +or the >#I wi%% =e added to the MInsta%%edM ta= and its
associated Iai% wi%% =e %isted under MCai%sM. Howe.erD i+ it is not a $reeNA"1 >#ID it wi%% not =e added to
M>%u'insM. In other wordsD i+ the a%ication reEuires an: con+i'urationD :ou wi%% ha.e to er+orm it
+rom the command %ine o+ the Iai%'s she%% instead o+ the 2!I.
9.1.$ 8eleting a P5I
When :ou insta%% a >#I usin' the >%u'ins methodD an associated Iai% is created. I+ :ou decide to de%ete a
>#ID the associated Iai% is a%so de%eted as it is no %on'er reEuired. ,e*ore deleti%# a P,1/ ma)e sure that
:ou don't ha.e an: data or con+i'uration in the Iai% that :ou do not want to %ose. I+ :ou doD =ac) it u
+irstD =e+ore de%etin' the >#I.
In the e5am%e shown in $i'ure 9.1+D the Couch>otato >#I has =een insta%%ed and the user has c%ic)ed
its M(e%eteM =utton. As descri=ed in the re.ious sectionsD this >#I aears in the >%u'ins ortion o+ the
treeD its associated Iai%D 'o!'h*otato,1D aears in the Cai%s ortion o+ the treeD and the >#I shows as
insta%%ed in the Insta%%ed ta= o+ >%u'ins. A o;u messa'e as)s the user i+ the: are sure that the: want
to de%ete. Thi$ i$ the o%e a%d o%l) -ar%i%#. I+ the user c%ic)s MFesMD this >#I wi%% =e remo.ed +rom the
>%u'ins ortion o+ the treeD its associated Iai%D 'o!'h*otato,1D wi%% =e de%etedD and the >#I wi%% no
%on'er show as insta%%ed in the Insta%%ed ta= o+ >%u'ins.
Figure 9.1f: 8eleting an Installed P5I
9.2 A,aila(le FreeNAS P5Is
Current%:D the +o%%owin' $reeNA"1 >#Is are a.ai%a=%eK
#acu%a Astora'e daemonB
=ts:nc
Couch>otato
Crash>%an
$ire+%:
2ame8
H<>C Mana'er
Maraschino
Mini(9NA
m:%ar
ownC%oud
>%e5 Media "er.er
"A#n8=d
"ic) #eard
<ransmission
N6*7: on%: a sma%% su=;set o+ these >#Is are a.ai%a=%e +or 32;=it s:stems as most a%ications are ,&;
=it.
Whi%e the $reeNA"1 >%u'ins s:stem ma)es it eas: to insta%% a >#ID it is sti%% u to :ou to )now how to
con+i'ure and use the insta%%ed a%ication. When in dou=tD re+er to the documentation +or that
a%ication.
9.2.1 P5I 2eBuests
I+ :ou wou%d %i)e to reEuest a 9.5 >C;#"( or $reeNA"1 >#I +or an a%ication %ease add an entr: to
the >#I ReEuests ta=%e. When addin' an entr:D insert the a%ication name in a%ha=etica% order.
I+ :ou are wor)in' on a >C;#"( or $reeNA"1 >#I modu%eD indicate this in the O9.5 >#I +or <estin'P
co%umn +or that entr:.
#e+ore reEuestin' a >#ID chec) that a $ree#"( ort a%read: e5ists +or the a%ication at $resh>orts. I+
the so+tware has =een ortedD $resh>orts wi%% indicate the name and cate'or: o+ the ort. $or e5am%eD
the 2!I +or the #acu%a ser.er is %ocated in s:suti%s@=acu%a;=at.
I+ the so+tware has not =een orted to $ree#"( :etD issue a ort reEuest at the >C;#"( >ort ReEuests
+orum usin' these instructions. A%ternate%:D i+ :ou ha.e orted so+tware =e+oreD the >orters Hand=oo)
contains detai%ed instructions +or ortin' so+tware to $ree#"(.
10 Iails
<he re.ious section descri=ed how to +indD insta%%D and con+i'ure so+tware usin' the >%u'ins method.
<his section descri=es how to use the Cai%s methodD which a%%ows users who are com+orta=%e usin' the
command %ine to ha.e more contro% o.er so+tware insta%%ation and mana'ement.
Whi%e the >%u'ins method automatica%%: created a $ree#"( Iai% +or each insta%%ed >#ID the Cai%s method
a%%ows the user to create as man: Iai%s as needed and to seci+: the t:e o+ Iai%. !n%i)e the >%u'ins
methodD one is not %imited to insta%%in' on%: one a%ication er Iai%.
4ssentia%%:D a $ree#"( Iai% ro.ides a .er: %i'ht;wei'htD oeratin' s:stem;%e.e% .irtua%i8ation.
Consider it as an indeendent $ree#"( oeratin' s:stem runnin' on the same hardwareD without a%% o+
the o.erhead usua%%: associated with .irtua%i8ation. <his means that an: so+tware and con+i'urations
within a Iai% are iso%ated +rom =oth the $reeNA"1 oeratin' s:stem and an: other Iai%s runnin' on that
s:stem. (urin' creationD some Iai% t:es ro.ide a B8<AH. otion which ro.ides that Iai% with its
ownD indeendent networ)in' stac). <his a%%ows the Iai% to do its own I> =roadcastin'D which is
reEuired =: some a%ications.
<he +o%%owin' t:es o+ Iai%s can =e createdK
1. Plugin @ail: this t:e o+ Iai% ro.ides the most +%e5i=i%it: +or so+tware insta%%ation. "imi%ar to the
>%u'ins methodD this t:e o+ Iai% suorts the insta%%ation o+ $reeNA"1 >#IsD which inte'rate
into the $reeNA"1 2!I. In addition to $reeNA"1 >#IsD :ou can a%so insta%% the +o%%owin'
t:es o+ so+tware within a %u'in Iai%K $ree#"( orts and $ree#"( )'n' ac)a'es. Howe.erD
on%: $reeNA"1 >#Is can =e mana'ed +rom the 2!I as the other t:es o+ so+tware are mana'ed
+rom the command %ine o+ the Iai%. $urtherD the other t:es o+ Iai%s do not suort the a=i%it: to
insta%% $reeNA"1 >#Is. I+ :ou %an to insta%% $reeNA"1 >#IsD insta%% a %u'in Iai%.
2. Port @ail: this t:e o+ Iai% suorts the insta%%ation o+ $ree#"( orts and $ree#"( )'n'
ac)a'es. It does %ot suort the insta%%ation o+ $reeNA"1 >#IsD meanin' that an: so+tware
insta%%ed in this t:e o+ Iai% must =e mana'ed +rom the command %ine o+ the Iai%.
3. Standard @ail: this t:e o+ Iai% is +unctiona%%: the same as a ort Iai%. A distinction is made +or
those users who re+er to searate networ) ser.ersD such as (HC> or (N" ser.icesD +rom other
insta%%ed so+tware.
&. <inu- @ail: due to the $ree#"( %inu5 =inar: comati=i%it: %a:erD 9inu5 can =e insta%%ed into a
Iai% and so+tware can =e insta%%ed usin' the ac)a'e mana'ement s:stem ro.ided =: the
insta%%ed 9inu5 distro. At this timeD the 9inu5 distro must =e a 32;=it .ersion and an:
a%ications insta%%ed into the Iai% must =e a.ai%a=%e as a 32;=it =inar:.
<a=%e 10a summari8es the t:e o+ so+tware which can =e insta%%ed into each t:e o+ Iai%. C%ic) the name
o+ the t:e o+ so+tware +or instructions on how to insta%% that t:e o+ so+tware.
N6*7: the so+tware which can =e insta%%ed into a 9inu5 Iai% is %imited to the command %ine ac)a'e
mana'ement too% ro.ided =: that 9inu5 distri=ution. I+ :ou insta%% so+tware into a 9inu5 Iai%D insta%%
the 32;=it .ersion o+ the so+tware.
*a(le 10a: .at *+!e of Soft0are can (e Installed Into a IailS
*+!e of
Iail
FreeNAS P5I Free5S8 !9gng !ac9age Free5S8 !ort
>%u'in :es :es :es
>ort no noD un%ess #anilla is unchec)ed durin' Iai% creation :es
"tandard no noD un%ess #anilla is unchec)ed durin' Iai% creation :es
9inu5 no no no
<he a=i%it: to create mu%ti%e Iai%s and mu%ti%e t:es o+ Iai%s o++ers 'reat +%e5i=i%it: and a%ication
searation to the administrator. $or e5am%eD one cou%d create a searate %u'in Iai% +or each $reeNA"1
%u'inD a searate ort Iai% +or each a%ication that is not a.ai%a=%e as a $reeNA"1 %u'inD and a
searate standard Iai% +or each insta%%ed networ) ser.er. A%ternate%:D one has the a=i%it: to create one Iai%
and to mi5 and match how the so+tware is insta%%ed into that Iai%.
<he rest o+ this section descri=es the +o%%owin'K
Cai%s Con+i'uration
Addin' Cai%s
Cai% <em%ates
Insta%%in' $reeNA"1 >#Is
Insta%%in' non;>#I "o+tware
10.1 Iails 'onfiguration
#e+ore :ou can create an: Iai%sD :ou must +irst con+i'ure which .o%ume or dataset wi%% =e used to ho%d
the Iai%s. <o do soD c%ic) Cai%s N Con+i'uration to access the screen shown in $i'ure 10.1a.
Figure 10.1a: Glo(al Iail 'onfiguration
N6*7: i+ :ou ha.e a%read: used the >%u'ins methodD a%% o+ the +ie%ds in this screen wi%% automatica%%:
=e +i%%ed in. Fou shou%d sti%% dou=%e;chec) that the re;con+i'ured .a%ues are aroriate +or :our Iai%s.
Whi%e a Iai% can =e insta%%ed on a !$" .o%umeD it is recommended to use 0$" and to create a dataset to
use +or the %ail &oot. As Iai%s are created on a 0$" s:stemD the: wi%% automatica%%: =e insta%%ed into
their own dataset under the seci+ied ath. $or e5am%eD i+ :ou con+i'ure a %ail &oot o+
2mnt2#ol!me12dataset1 and create a Iai% named Pail1D it wi%% =e insta%%ed into its own dataset named
2mnt2#ol!me12dataset12Pail1.
<a=%e 10.1a summari8es the +ie%ds in this con+i'uration screen.
*a(le 10.1a: Iail 'onfiguration 6!tions
Cai% Root
=rowse
=utton
mandator: as :ou cannot add a Iai% unti% this is set
I>.& Networ) strin'
see e5%anation =e%ow ta=%eR +ormat is I> address o+ networ) @
CI(R mas)
I>.& Networ) "tart
Address
strin'
see e5%anation =e%ow ta=%eR +ormat is I> address o+ host @
CI(R mas)
I>.& Networ) 4nd
Address
strin'
see e5%anation =e%ow ta=%eR +ormat is I> address o+ host @
CI(R mas)
When se%ectin' the OCai% RootPD ensure that the si8e o+ the se%ected .o%ume or dataset is su++icient to
ho%d the num=er o+ Iai%s to =e insta%%ed as we%% as an: so+twareD %o' +i%esD and data to =e stored within
each Iai%. At a =are minimumD =ud'et at %east 22# er Iai% and do not se%ect a dataset that is %ess than
22# in si8e.
N6*7: i+ :ou %an to add stora'e to a Iai%D =e aware that ath si8e is %imited to 66 characters. Ma)e
sure that the %en'th o+ :our .o%ume name %us the dataset name %us the Iai% name does not e5ceed this
%imit.
$reeNA"1 wi%% automatica%%: detect and dis%a: the OI>.& Networ)P that the administrati.e inter+ace
is connected to. <his settin' is imortant as the I>.& networ) must =e !inga=%e +rom the $reeNA"1
s:stem in order +or :our Iai%s and an: insta%%ed so+tware to =e accessi=%e . I+ :our networ) too%o':
reEuires :ou to chan'e the de+au%t .a%ueD :ou wi%% a%so need to con+i'ure a de+au%t 'atewa:D and
ossi=%: a static routeD to the seci+ied networ). I+ :ou chan'e this .a%ueD ensure that the su=net mas)
.a%ue is correct as an incorrect mas) can ma)e the I> networ) unreacha=%e. When in dou=tD )ee the
de+au%t settin' +or OI>.& Networ)P. I+ :ou are usin' 3MwareD ma)e sure that the .switch is set to
romiscuous mode.
Re.iew the de+au%t .a%ues o+ the OI>.& Networ) "tart AddressP and OI>.& Networ) 4nd AddressP to
determine i+ that ran'e is aroriate +or the num=er o+ Iai%s that :ou wi%% create. I+ there is a (HC>
ser.er on the networ)D ma)e sure that this ran'e o+ addresses is e5c%uded +rom the scoe o+ the (HC>
ser.er. As Iai%s are createdD the: wi%% automatica%%: =e assi'ned the ne5t +ree I> address within the ran'e
seci+ied =: these two .a%ues.
N6*7: these & +ie%ds are necessar: +or the roer oeration o+ Cai%s. I+ :ou are una=%e to addD startD or
access the so+tware insta%%ed into Iai%sD dou=%e;chec) the .a%ues in these +ie%ds. In articu%arD ma)e sure
that the seci+ied I>.& settin's are reacha=%e =: c%ients and that the seci+ied addresses are not in use
=: an: other c%ients in the networ).
10.2 Adding Iails
<o create a Iai%D c%ic) Cai%s N Add Cai%s to access the screen shown in $i'ure 10.2a. <a=%e 10.2a
summari8es the a.ai%a=%e otions.
N6*7: the OAdd Cai%sP menu item wi%% not aear unti% a+ter :ou con+i'ure Cai%s N Con+i'uration.
Figure 10.2a: 'reating a Iail

*a(le 10.2a: Iail 'onfiguration 6!tions
Cai% Name strin' mandator:R can on%: contain %etters and num=ers
t:e
dro;down
menu
de+au%t choices are *l!ginPailD *ortPailD standardD de$ianD gentooD !$!nt!D
s!seD and 'entosR on a ,&;=it s:stemD otions are a%so a.ai%a=%e +or
creatin' the 32;=it .ersions o+ a %u'inD ortD or standard Iai%
I>.& address inte'er
wi%% =e automatica%%: assi'ned the ne5t +ree address +rom the ran'e
seci+ied in Cai%s Con+i'urationR i+ :ou chan'e the de+au%t addressD ma)e
sure it is reacha=%e within the $reeNA"1 s:stem's networ) and is not in
use =: an: other host on the networ)
I>.& netmas)
dro;down
menu
se%ect the su=net mas) associated with 81#4 address
I>.& =rid'e
address
inte'er
see N-<4 =e%owR wi%% =e 're:ed out +or 9inu5 Iai%s or i+ B8<AH. is
unchec)ed
I>.& =rid'e
netmas)
dro;down
menu
se%ect the su=net mas) associated with 81#4 $ridge addressR wi%% =e
're:ed out +or 9inu5 Iai%s or i+ B8<AH. is unchec)ed
I>.& de+au%t
'atewa:
strin'
used to set the Iai%'s de+au%t 'atewa: I>.& addressR wi%% =e 're:ed out +or
9inu5 Iai%s or i+ B8<AH. is unchec)ed
I>., address inte'er
i+ I>., has =een con+i'uredD wi%% =e automatica%%: assi'ned the ne5t +ree
address +rom the ran'e seci+ied in Cai%s Con+i'uration
I>., re+i5
%en'th
dro;down
menu
se%ect the re+i5 %en'th associated with 81#5 address
I>., =rid'e
address
inte'er
see N-<4 =e%owR wi%% =e 're:ed out +or 9inu5 Iai%s or i+ B8<AH. is
unchec)ed
I>., =rid'e
re+i5 %en'th
dro;down
menu
se%ect the re+i5 %en'th associated with 81#5 addressR wi%% =e 're:ed out
+or 9inu5 Iai%s or i+ B8<AH. is unchec)ed
I>., de+au%t
'atewa:
strin'
used to set the Iai%'s de+au%t 'atewa: I>., addressR wi%% =e 're:ed out +or
MAC strin'
i+ a static MAC address is neededD inut it hereR reEuires B8<AH. to =e
chec)ed
":sct%s strin'
comma;de%imited %ist o+ s:sct%s to set inside Iai% Ae.'.
allo:.sys#i*'>13allo:.ra:,so'kets>1B
Autostart chec)=o5 unchec) i+ :ou want to start the Iai% manua%%:
3IMA24 chec)=o5
'i.es a Iai% its own .irtua%i8ed networ) stac)R reEuires romiscuous mode
to =e ena=%ed on the inter+aceR does not a%: to 9inu5 Iai%s
NA< chec)=o5
ena=%es Networ) Address <rans%ation +or the Iai%R wi%% =e 're:ed out +or
.ani%%a chec)=o5
unchec) this =o5 i+ :ou %an to insta%% $ree#"( ac)a'es into a *ortPail
or standard Iai%
N6*7: <he I>.& and I>., =rid'e inter+ace is used to =rid'e the eairA&B de.iceD which is
automatica%%: created +or each started Iai%D to a h:sica% networ) de.ice. <he de+au%t networ) de.ice is
the one that is con+i'ured with a de+au%t 'atewa:. "oD i+ em0 is the $ree#"( name o+ the h:sica%
inter+ace and three Iai%s are runnin'D the +o%%owin' .irtua% inter+aces wi%% =e automatica%%: createdK
$ridge0D e*air0aD e*air1aD and e*air2a. <he h:sica% inter+ace em0 wi%% =e added to the =rid'eD as we%%
as each eair de.ice. <he other ha%+ o+ the eair wi%% =e %aced inside the Iai% and wi%% =e assi'ned the I>
address seci+ied +or that Iai%. <he =rid'e inter+ace wi%% =e assi'ned an a%ias o+ the de+au%t 'atewa: +or
that Iai%D i+ con+i'uredD or the =rid'e I>D i+ con+i'uredR either is correct.
A Otraditiona%P $ree#"( Iai% does not use 3IMA24 or NA<. I+ :ou unchec) =oth o+ these =o5esD :ou
need to con+i'ure the Iai% with an I> address within the same networ) as the inter+ace it is =ound toD and
that address wi%% =e assi'ned as an a%ias on that inter+ace. <o use a 3IMA24 Iai% on the same su=netD
disa=%e NA<D and con+i'ure an I> address within the same networ). In =oth o+ these casesD :ou on%:
con+i'ure an I> address and do not con+i'ure a =rid'e or a 'atewa: address.
A+ter ma)in' :our se%ectionsD c%ic) the -K =utton. <he Iai% wi%% =e created and wi%% =e added to the tree
under Cai%s. #: de+au%tD a %u'in Iai% wi%% =e created and automatica%%: startedD un%ess :ou seci+:
otherwise.
<he +irst time :ou add a t:e o+ Iai%D the 2!I wi%% automatica%%: down%oad the necessar: comonents
+rom the Internet. I+ it is una=%e to connect to the InternetD the Iai% creation wi%% +ai%. -therwiseD a
ro'ress =ar wi%% indicate the status o+ the down%oad and ro.ide an estimated time +or the rocess to
com%ete. -nce the +irst Iai% is createdD su=seEuent Iai%s o+ that t:e wi%% =e added instantaneous%: as the
down%oaded =ase +or creatin' that t:e o+ Iai% is sa.ed to the %ail &oot.
10.2.1 4anaging Iails
<o .iew and con+i'ure the added Iai%sD c%ic) Cai%s N 3iew a%% Cai%s. In the e5am%e shown in $i'ure
10.2=D +our Iai%s ha.e =een created and the %ist entr: +or the Iai% named *l!ginPail has =een c%ic)ed.
Figure 10.2(: 'reated Iails Added to te GUI
C%ic) a Iai%'s entr: to access its con+i'uration icons. In orderD +rom %e+t to ri'htD these icons are used toK
7dit Iail: edit the Iai%'s settin's as descri=ed in the ne5t section.
Add Storage: con+i'ure the Iai% to access an area o+ stora'e as descri=ed in Addin' "tora'e.
U!load Plugin: on%: a.ai%a=%e in a %u'in Iai%. !sed to insta%% %u'ins as descri=ed in Insta%%in'
$reeNA"1 >#Is.
StartESto!: this icon wi%% .ar:D deendin' uon the current runnin' status o+ the Iai%. I+ the Iai% is
current%: stoedD the icon wi%% =e 'reen and can =e used to start the Iai%. I+ the Iai% is current%: runnin'D
the icon wi%% =e red and can =e used to sto the Iai%. A stoed Iai% and its a%ications are inaccessi=%e
unti% it is restarted.
Sell: used to access a root command romt in order to con+i'ure the se%ected Iai% +rom the command
%ine.
8elete: de%etin' the seci+ied Iai% a%so de%etes an: so+tware that was insta%%ed in that Iai%. <he 2!I wi%%
dis%a: a warnin' which reEuires :ou to c%ic) the Fes =uttonD indicatin' that :ou are sure that :ou want
to de%ete the Iai%D =e+ore this oeration is er+ormed.
10.2.2 Accessing a Iail Using SS& Instead of its Sell Icon
I+ :ou re+er to use ss to access a Iai% :ou wi%% need to +irst start the ss ser.ice and create a user
account +or ss access. "ince this con+i'uration occurs on a Iai%;=:;Iai% =asisD c%ic) the O"he%%P icon +or
the Iai% :ou wish to con+i'ure ss access to.
<o start the ""H ser.ice on a non;9inu5 Iai%D %oo) +or the +o%%owin' %ine in that Iai%'s 2et'2r'.'onfK
sshd_enable="NO"
Chan'e the N@ to -.S and sa.e the +i%e. <henD start the ""H daemonK
service sshd start
<he host R"A )e: air shou%d =e 'enerated and the )e:'s +in'errint and random art ima'e dis%a:ed.
$or a 9inu5 Iai%D re+er to the documentation +or that 9inu5 distri=ution +or instructions on how to start
the ""H ser.ice. (eendin' uon the distri=utionD :ou ma: ha.e to +irst insta%% a ""H ser.er.
Ne5tD add a user account. I+ :ou want the user to ha.e sueruser ri.i%e'es to a non;9inu5 Iai%D ma)e
sure the user is %aced in the :heel 'rou when it is created. <:e adduser and +o%%ow the romts.
When :ou 'et to this romtD do not ress enter =ut instead t:e :heelK
Login group is user1. Invite user1 into other groups? []: wheel
-nce the user is createdD set the root assword so that the new user wi%% =e a=%e to use the su command
to 'ain sueruser ri.i%e'e. <o set the asswordD t:e !ass0d then inut and con+irm the desired
assword.
$or a 9inu5 Iai%D :ou wi%% need to create a user account usin' the so+tware that comes with the 9inu5
distri=ution. "ince 9inu5 does not use the :heel 'rouD i+ :ou wish to 'i.e this user sueruser
ri.i%e'esD instead insta%% and con+i'ure the sudo a%ication.
$ina%%:D test +rom another s:stem that the user can success+u%%: ss in and =ecome the sueruser. In this
e5am%eD a user named !ser1 uses ss to access the non;9inu5 Iai% at 192.1,6.2.3. <he +irst time the
user %o's inD the: wi%% =e as)ed to .eri+: the +in'errint o+ the hostK
ssh user1@192.168.2.3
The authenticity of host '192.168.2.3 (192.168.2.3)' can't be established.
RSA key fingerprint is 6f:93:e5:36:4f:54:ed:4b:9c:c8:c2:71:89:c1:58:f0.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added '192.168.2.3' (RSA) to the list of known hosts.
Password: type_password_here
N6*7: each Iai% has its own user accounts and ser.ice con+i'uration. <his means that :ou wi%% need to
reeat these stes +or each Iai% that reEuires ""H access.
18.2.2.1 *dit a 9ail:s Settings
$i'ure 10.2c shows the con+i'uration screen that aears when :ou c%ic) the O4dit Cai%P =utton +or a
hi'h%i'hted Iai%'s entr:. <his screen can a%so =e accessed =: e5andin' the Iai%'s name in the tree .iew
and c%ic)in' 4dit.
Figure 10.2c: Iail/s 7dit Settings
Most o+ these settin's were re.ious%: descri=ed in <a=%e 10.2a and can =e chan'ed usin' this screen
a+ter Iai% creation. <he +o%%owin' settin's di++er =etween the OAdd Cai%P and O4dit Cai%P screensK
Iail Na3e: this settin' is read;on%: once the Iai% has =een created.
IP,$ aliases: once a Iai% has =een createdD this +ie%d can =e used to add additiona% I>.&
addressesD which are )nown as a%iases. When addin' mu%ti%e a%iasesD use a comma de%imited
%ist.
IP,% aliases: once a Iai% has =een createdD this +ie%d can =e used to add additiona% I>.,
addresses. When addin' mu%ti%e a%iasesD use a comma de%imited %ist.
N6*7: i+ :ou need to modi+: the I> address in+ormation +or a Iai%D use it's M4dit Cai%M =utton instead o+
the associated networ)in' commands +rom the command %ine o+ the Iai%.
18.2.2.2 Adding Storage
It is ossi=%e to 'i.e a Iai% access to an area o+ stora'e on the $reeNA"1 s:stem. <his is use+u% i+ :ou
insta%% an a%ication that stores a %ar'e amount o+ data or i+ an insta%%ed a%ication needs access to the
data stored on the $reeNA"1 s:stem. An e5am%e wou%d =e transmissionD which stores torrents. <he
stora'e is added usin' the mountGnu%%+sA6B mechanism which %in)s data that resides outside o+ the Iai%
as a stora'e area within the Iai%.
<o add stora'eD c%ic) the OAdd "tora'eP =utton +or a hi'h%i'hted Iai%'s entr:. <his screen can a%so =e
accessed =: e5andin' the Iai%'s name in the tree .iew and c%ic)in' "tora'e N Add "tora'eD shown in
$i'ure 10.2d.
#rowse to the O"ourceP and O(estinationPD whereK
Source: is the director: or dataset on the $reeNA"1 s:stem :ou wou%d %i)e to 'ain access to
+rom the Iai%. <his director: (!$t reside outside o+ the .o%ume or dataset =ein' used =: the Iai%.
<his is wh: it is recommended to create a searate dataset to store Iai%sD as the dataset ho%din'
the Iai%s wi%% a%wa:s =e searate +rom an: datasets used +or stora'e on the $reeNA"1 s:stem.
8estination: se%ect the director: within the Iai% which wi%% =e %in)ed to the O"ourceP stora'e
area.
Figure 10.2d: Adding Storage to a Iail
When :ou are addin' stora'eD it is t:ica%%: =ecause the user and 'rou account associated with an
a%ication insta%%ed inside o+ a Iai% needs to access data stored on the $reeNA"1 s:stem. #e+ore
se%ectin' the M"ourceMD it is imortant to +irst ensure that the ermissions o+ the se%ected director: or
dataset 'rant ermission to the user@'rou account inside o+ the Iai%. <his is t:ica%%: not the de+au%tD as
the users and 'rous created inside o+ a Iai% are tota%%: searate +rom the users and 'rous o+ the
$reeNA"1 s:stem.
<his means that the wor)+%ow +or addin' stora'e is usua%%: as +o%%owsK
1. (etermine the name o+ the user and 'rou account used =: the a%ication. $or e5am%eD the
insta%%ation o+ the transmission a%ication automatica%%: creates a user account named
transmission and a 'rou account named transmission. When in dou=tD chec) the +i%es
2et'2*ass:d Ato +ind the user accountB and 2et'2gro!* Ato +ind the 'rou accountB inside o+ the
Iai%. <:ica%%:D the user and 'rou names are simi%ar to the a%ication name. A%soD the !I( and
2I( are usua%%: the same as the ort num=er used =: the ser.ice.
2. -n the $reeNA"1 s:stemD create a user account and 'rou account to match the name o+ the
user and 'rou used =: the a%ication in the Iai%.
3. -n the $reeNA"1 s:stemD determine i+ :ou want the Iai% to ha.e access to e5istin' data or i+
:ou want to set aside an area o+ stora'e +or the Iai% to use.
&. I+ the Iai% shou%d access e5istin' dataD edit the ermissions o+ the .o%ume or dataset so that the
user and 'rou account has the desired read and write access. I+ mu%ti%e a%ications or Iai%s
are to ha.e access to the same dataD :ou wi%% need to create a searate 'rou and add each
needed user account to that 'rou.
*. I+ :ou are instead settin' aside an area o+ stora'e +or that Iai% Aor indi.idua% a%icationBD create a
dataset. <henD edit the ermissions o+ that dataset so that the user and 'rou account has the
desired read and write access.
,. !se the MAdd "tora'eM =utton o+ the Iai% and se%ect the con+i'ured .o%ume@dataset as the
M"ourceM.
I+ :ou wish to re.ent writes to the stora'eD chec) the =o5 ORead;-n%:P.
#: de+au%tD the OCreate director:P =o5 is chec)ed. <his means that the director: wi%% automatica%%: =e
created +or :ou under the seci+ied O(estinationP ath i+ the director: does not a%read: e5ist.
-nce a stora'e has =een addedD it wi%% =e added to the tree under the seci+ied Iai%. In the e5am%e
shown in $i'ure 10.2eD a dataset named #ol!me12data has =een chosen as the O"ourceP as it contains
the +i%es stored on the $reeNA"1 s:stem. When the stora'e was createdD the user =rowsed to
#ol!me12Pails2*l!ginPail2!sr2lo'al in the O(estinationP +ie%dD then t:ed in test as the director:. "ince
this director: did not a%read: e5istD it was created as the OCreate director:P =o5 was %e+t as chec)ed.
<he resu%tin' stora'e was added to the *l!ginPail entr: in the tree as 2!sr2lo'al2test. <he user has
c%ic)ed this 2!sr2lo'al2test entr: in order to access its edit screen.
#: de+au%tD the stora'e is mounted as it is created. <o unmount the stora'eD unchec) its OMountedUP
=o5.
N6*7: a mounted dataset wi%% not automatica%%: mount an: o+ its chi%d datasets. Whi%e the chi%d
datasets ma: aear =rowsa=%e inside the Iai%D an: chan'es wi%% not =e .isi=%e. "ince each dataset is
considered to =e its own +i%es:stemD each chi%d dataset must ha.e its own mount ointD meanin' that
:ou need to create a searate stora'e +or an: chi%d datasets which need to =e mounted.
<o de%ete the stora'eD c%ic) its O(e%eteP =utton.
8ANG72C it is imortant to rea%i8e that an added stora'e is rea%%: Iust a ointer to the se%ected stora'e
director: on the $reeNA"1 s:stem. It does %ot create a co: o+ that data within the Iai%. Thi$ (ea%$
that i* )o! delete a%) *ile$ *ro( the CDe$ti%atio%D director) located i% the Jail/ )o! are reall) deleti%#
tho$e *ile$ *ro( the CSo!rceD director) located o% the FreeNAS $)$te( . Howe.erD i+ :ou de%ete the
stora'eD :ou are on%: de%etin' the ointerD not the data itse%+.
FreeNAS 9.2.1 Users Guide Page 2## of 280
Figure 10.2e: 7-a3!le Storage
10.# Iail *e3!lates
#e'innin' with 9.2.0D $reeNA"1 uses the warden tem%atin' s:stem to ro.ision Iai%s. When :ou
se%ect the t:e o+ Iai% when creatin' a Iai%D as seen in $i'ure 10.2aD :ou are rea%%: choosin' which
e5istin' tem%ate to use.
<o .iew the de+au%t tem%atesD c%ic) Cai%s N 3iew Cai% <em%ates. A %istin' o+ the de+au%t tem%ates used
=: a 9.2.1 s:stem are seen in $i'ure 10.3a.
FreeNAS 9.2.1 Users Guide Page 2#$ of 280
Figure 10.#a: <isting of 8efault Iail *e3!lates
<he %istin' contains the +o%%owin' co%umnsK
Na3e: wi%% aear in the Mt:eM dro;down menu when addin' a new Iai%.
U2<: when addin' a new Iai%D the tem%ate wi%% =e down%oaded +rom this %ocation.
Instances: indicates i+ the tem%ate has =een used to create a Iai%. In this e5am%eD no tem%ates
ha.e =een used to create a Iai%D so a%% o+ the instances are set to 0.
10.#.1 'reating Tour 60n *e3!lates
Creatin' :our own custom tem%ates a%%ows :ou to de%o: di++erent .ersions and architectures o+
$ree#"( or di++erent 32;=it 9inu5 distri=utions into a $reeNA"1 Iai%. Additiona%%:D the tem%ate can
=e re;con+i'ured to inc%ude the a%icationsD con+i'urationsD and user accounts that :ou need in order
to Euic)%: de%o: :our Iai%s.
<o create a tem%ateD +irst insta%% the desired $ree#"( or 9inu5 oeratin' s:stem and con+i'ure it the
wa: :ou want. <he insta%%ation can =e either to an e5istin' Iai% or on another s:stem.
N6*7: i+ :ou are insta%%in' 9inu5D ma)e sure to insta%% the 32;=it .ersion o+ the oeratin' s:stem as
,&;=it 9inu5 .ersions are not suorted at this time.
-nce :our con+i'uration is com%eteD :ou need to create a tar=a%% o+ the entire oeratin' s:stem that
:ou wish to use as a tem%ate. <his tar=a%% needs to =e comressed with g=i! and end in a .tg/
e5tension. #e care+u% when creatin' the tar=a%% as :ou don't want to end u in a recursi.e %oo. In other
wordsD the resu%tin' tar=a%% needs to =e sa.ed outside o+ the oeratin' s:stem =ein' tar=a%%edD such as to
an e5terna% !"# dri.e or networ) share. A%ternate%:D :ou can create a temorar: director: within the
oeratin' s:stem and use the --e('l!de switch to tar to e5c%ude this director: +rom the tar=a%%. <he
e5act tar command to use wi%% .ar:D deendin' uon the oeratin' s:stem =ein' used to create the
tar=a%%.
FreeNAS 9.2.1 Users Guide Page 2#" of 280
-nce :ou ha.e the .tg/ +i%e +or the oeratin' s:stemD sa.e it to either an $<> share or an H<<> ser.er.
Fou wi%% need the associated $<> or H<<> !R9 in order to add the tem%ate to the %ist o+ a.ai%a=%e
tem%ates.
<o add the tem%ateD c%ic) Cai%s N Add Cai% <em%ates which wi%% oen the screen seen in $i'ure 10.3=.
Figure 10.#(: Adding A 'usto3 Iail *e3!late
<a=%e 10.3a summari8es the +ie%ds in this screen.
*a(le 10.#a: Iail *e3!late 6!tions
Name strin' .a%ue wi%% aear in the Name co%umn o+ 3iew Cai% <em%ates
-" dro;down menu choices are FreeBS or ;in!(
Architecture dro;down menu choices are (65 or (54R (65 is reEuired i+ ;in!( is se%ected
!R9 strin'
inut the +u%% !R9 to the .tg/ +i%eD inc%udin' the rotoco% Aft*)22 or
htt*)22B
10.$ Installing FreeNAS P5Is
<:ica%%:D $reeNA"1 >#Is are insta%%ed usin' >%u'ins as this section o+ the 2!I ro.ides a method +or
=rowsin' +or a.ai%a=%e >#Is.
FreeNAS 9.2.1 Users Guide Page 2#% of 280
Howe.erD i+ a user has created their own %u'ins Iai%D $reeNA"1 >#Is can =e insta%%ed into it. Insta%%in'
a >#I this wa: reEuires the user to +irst down%oad the >#I +or their architecture and .ersion.
N6*7: $reeNA"1 >#Is can not =e insta%%ed inside a standard or orts Iai%.
<o insta%% a $reeNA"1 >#ID 'o to Cai%s N 3iew Cai%s and c%ic) the %u'in Iai% :ou wish to insta%% into.
An e5am%e is seen in $i'ure 10.&a.
Figure 10.$a: Select Plugin Iail to Install Into
C%ic) the O!%oad >%u'inP =utton. When romtedD O#rowseP to the %ocation o+ the down%oaded >#I
then c%ic) the O!%oadP =utton to insta%% the >#I. A status =ar wi%% indicate the ro'ress o+ the
insta%%ation. -nce insta%%edD the a%ication wi%% aear under the >%u'ins entr: o+ the tree. In the
e5am%e shown in $i'ure 10.&=D the Mini(9NA %u'in has =een insta%%ed.
Fou can now con+i'ure and mana'e the insta%%ed so+tware as descri=ed in >%u'ins.
FreeNAS 9.2.1 Users Guide Page 2#) of 280
Figure 10.$(: FreeNAS P5I Successfull+ Installed
10." Installing non>P5I Soft0are
I+ a >#I is not a.ai%a=%e +or the so+tware that :ou wish to insta%%D :ou can sti%% insta%% and con+i'ure the
a%ication +rom the command %ine o+ a %u'inD ortD or standard Iai% usin' $ree#"( orts or )'n'
ac)a'es. <his section descri=es these methods o+ so+tware insta%%ation. Fou shou%d s)im throu'h the
entire section +irst to determine which method o+ so+tware insta%%ation =est meets :our needs.
N6*7: the commands demonstrated in this section need to =e e5ecuted +rom the she%% icon o+ the Iai%
the so+tware is to =e insta%%ed into.
10.".1 Installing Free5S8 Pac9ages 0it !9gng
<he Euic)est and easiest wa: to insta%% so+tware inside the Iai% is to insta%% a $ree#"( ac)a'e. A
$ree#"( ac)a'e is re;comi%edD meanin' that it contains a%% the =inaries and deendencies reEuired
+or the so+tware to run on a $ree#"( s:stem.
A %ot o+ so+tware has =een orted to $ree#"( Acurrent%: o.er 2&D000 a%icationsB and most o+ that
so+tware is a.ai%a=%e as a ac)a'e. -ne wa: to +ind $ree#"( so+tware is to use the search=ar at
$resh>orts.or'.
-nce :ou ha.e %ocated the name o+ the ac)a'e :ou wou%d %i)e to insta%%D use the !9g install command
to insta%% it. $or e5am%eD to insta%% the audiota' ac)a'eD use this commandK
pkg install audiotag
When romtedD t:e + to com%ete the insta%%ation. <he insta%%ation messa'es wi%% indicate i+ the
ac)a'e and its deendencies success+u%%: down%oad and insta%%.
8ANG72C do %ot use the !9g:add command in a $reeNA"1 Iai% as it wi%% cause inconsistencies in
:our ac)a'e mana'ement data=ase.
Fou can con+irm that the insta%%ation was success+u% =: Euer:in' the ac)a'e data=aseK
pkg info -f audiotag
audiotag-0.19_1
Name : audiotag
Version : 0.19_1
Origin : audio/audiotag
Architecture : freebsd:9:x86:64
Prefix : /usr/local
Categories : multimedia audio
Licenses : GPLv2
Maintainer : ports@FreeBSD.org
WWW : http://github.com/Daenyth/audiotag
Comment : Command-line tool for mass tagging/renaming of audio files
Options :
DOCS : on
FLAC : on
ID3 : on
MP4 : on
VORBIS : on
Flat size : 62.8KiB
Description :
Audiotag is a command-line tool for mass tagging/renaming of audio files
it supports the vorbis comment, id3 tags, and MP4 tags.
WWW: http://github.com/Daenyth/audiotag
<o see what was insta%%ed with the ac)a'eK
pkg info -l audiotag
audiotag-0.19_1:
/usr/local/bin/audiotag
/usr/local/share/doc/audiotag/COPYING
/usr/local/share/doc/audiotag/ChangeLog
/usr/local/share/doc/audiotag/README
/usr/local/share/licenses/audiotag-0.19_1/GPLv2
/usr/local/share/licenses/audiotag-0.19_1/LICENSE
/usr/local/share/licenses/audiotag-0.19_1/catalog.mk
In $ree#"(D third;art: so+tware is a%wa:s stored in 2!sr2lo'al to di++erentiate it +rom the so+tware that
came with the oeratin' s:stem. #inaries are a%most a%wa:s %ocated in a su=director: ca%%ed $in or s$in
and con+i'uration +i%es in a su=director: ca%%ed et'.
10.".2 'o3!iling Free5S8 Ports 0it 3a9e
<:ica%%:D so+tware is insta%%ed usin' ac)a'es. -ccasiona%%: :ou ma: re+er to comi%e the ort
:ourse%+. Comi%in' the ort o++ers the +o%%owin' ad.anta'esK
not e.er: ort has an a.ai%a=%e ac)a'e. <his is usua%%: due to %icensin' restrictions or )nownD
unaddressed securit: .u%nera=i%ities.
sometimes the ac)a'e is out;o+;date and :ou need a +eature that =ecame a.ai%a=%e in the newer
.ersion.
some orts ro.ide comi%e otions that are not a.ai%a=%e in the re;comi%ed ac)a'e. <hese
otions are used to add additiona% +eatures or to stri out the +eatures :ou do not need.
Comi%in' the ort :ourse%+ has the +o%%owin' dis;ad.anta'esK
it ta)es time. (eendin' uon the si8e o+ the a%icationD the amount o+ deendenciesD the
amount o+ C>! and RAM on the s:stemD and the current %oad on the $reeNA"1 s:stemD the
amount o+ time can ran'e +rom a +ew minutes to a +ew hours or e.en to a +ew da:s.
N6*7: i+ the ort doesn't ro.ide an: comi%e otionsD :ou are =etter o++ sa.in' :our time and the
$reeNA"1 s:stem's resources =: usin' the !9g install command instead.
Fou can determine i+ the ort has an: con+i'ura=%e comi%e otions =: c%ic)in' its $resh>orts %istin'.
$i'ure 10.*a shows the OCon+i'uration -tionsP +or audiota'.
Figure 10."a: 'onfiguration 6!tions for Audiotag
In $ree#"(D a <akefile is used to ro.ide the comi%in' instructions to the 3a9e command. <he
<akefile is in ascii te5tD +air%: eas: to understandD and documented in =sd.ort.m).
I+ the ort has an: con+i'ura=%e comi%e otionsD the: wi%% =e %isted at $resh>orts in the ort's
OCon+i'uration -tionsP. <his ort contains +i.e con+i'ura=%e otions A(-C"D $9ACD I(3D M>&D and
3-R#I"B and each otion is ena=%ed AonB =: de+au%t.
$ree#"( ac)a'es are a%wa:s =ui%t usin' the de+au%t otions. When :ou comi%e the ort :ourse%+D
those otions wi%% =e resented to :ou in a menuD a%%owin' :ou to chan'e their de+au%t settin's.
#e+ore :ou can comi%e a ortD the orts co%%ection must =e insta%%ed within the Iai%. $rom within the
Iai%D use the !ortsna! uti%it:K
portsnap fetch extract
<his command wi%% down%oad the orts co%%ection and e5tract it to the Iai%'s 2!sr2*orts2 director:.
N6*7: i+ :ou insta%% additiona% so+tware at a %ater dateD :ou shou%d ma)e sure that the orts co%%ection
is u;to;date usin' this commandK
portsnap fetch update
<o comi%e a ortD :ou wi%% cd into a su=director: o+ 2!sr2*orts2. $resh>orts ro.ides the %ocation to cd
into and the 3a9e command to run. <his e5am%e wi%% comi%e the audiota' ortK
cd /usr/ports/audio/audiotag
make install clean
"ince this ort has con+i'ura=%e otionsD the +irst time this command is run the con+i'ure screen shown
in $i'ure 10.*= wi%% =e dis%a:edK
Figure 10."(: 'onfiguration 6!tions for Audiotag Port
<o chan'e an otion's settin'D use the arrow )e:s to hi'h%i'ht the otionD then ress the $"acebar to
to''%e the se%ection. -nce :ou are +inishedD ta= o.er to -K and ress enter. <he ort wi%% =e'in to
comi%e and insta%%.
N6*7: i+ :ou chan'e :our mindD the con+i'uration screen wi%% not =e dis%a:ed a'ain shou%d :ou sto
and restart the =ui%d. <:e 3a9e config UU 3a9e install clean i+ :ou need to chan'e :our se%ected
otions.
I+ the ort has an: deendencies with otionsD their con+i'uration screens wi%% =e dis%a:ed and the
comi%e wi%% ause unti% it recei.es :our inut. It is a 'ood idea to )ee an e:e on the comi%e unti% it
+inishes and :ou are returned to the command romt.
-nce the ort is insta%%edD it is re'istered in the same ac)a'e data=ase that mana'es ac)a'es. <his
means that :ou can use !9g info to determine what was insta%%edD as descri=ed in the re.ious section.
10.".# 'onfiguring and Starting Installed Free5S8 Soft0are
-nce the ac)a'e or ort is insta%%edD :ou wi%% need to con+i'ure and start it. I+ :ou are +ami%iar with
how to con+i'ure the so+twareD %oo) +or its con+i'uration +i%e in 2!sr2lo'al2et' or a su=director: thereo+.
Man: $ree#"( ac)a'es contain a sam%e con+i'uration +i%e to 'et :ou started. I+ :ou are un+ami%iar
with the so+twareD :ou wi%% need to send some time at the so+tware's we=site to %earn which
con+i'uration otions are a.ai%a=%e and which con+i'uration +i%eAsB need to =e edited.
Most $ree#"( ac)a'es that contain a starta=%e ser.ice inc%ude a startu scrit which is automatica%%:
insta%%ed to 2!sr2lo'al2et'2r'.d2. -nce :our con+i'uration is com%eteD :ou can test that the ser.ice starts
=: runnin' the scrit with the onestart otion. As an e5am%eD i+ oen.n is insta%%ed into the Iai%D these
commands wi%% run its startu scrit and .eri+: that the ser.ice startedK
/usr/local/etc/rc.d/openvpn onestart
Starting openvpn.
/usr/local/etc/rc.d/openvpn onestatus
openvpn is running as pid 45560.
sockstat -4
USER COMMAND PID FD PROTO LOCAL ADDRESS FOREIGN ADDRESS
root openvpn 48386 4 udp4 *:54789 *:*
I+ :ou instead recei.e an errorK
/usr/local/etc/rc.d/openvpn onestart
Starting openvpn.
/usr/local/etc/rc.d/openvpn: WARNING: failed to start openvpn
Run tail E,arElogE3essages to see i+ an: error messa'es hint at the ro=%em. Most startu +ai%ures are
re%ated to a mis;con+i'urationK either a t:o or a missin' otion in a con+i'uration +i%e.
-nce :ou ha.e .eri+ied that the ser.ice starts and is wor)in' as intendedD add a %ine to 2et'2r'.'onf to
ensure that the ser.ice automatica%%: starts whene.er the Iai% is started. <he %ine to start a ser.ice a%wa:s
ends in ,ena$le>I-.SI and t:ica%%: starts with the name o+ the so+tware. $or e5am%eD this is the
entr: +or the oen.n ser.iceK
openvpn_enable="YES"
When in dou=tD the startu scrit wi%% te%% :ou which %ine to ut in 2et'2r'.'onf. <his is the descrition in
2!sr2lo'al2et'2r'.d2o*en#*n)
# This script supports running multiple instances of openvpn.
# To run additional instances link this script to something like
# % ln -s openvpn openvpn_foo
# and define additional openvpn_foo_* variables in one of
# /etc/rc.conf, /etc/rc.conf.local or /etc/rc.conf.d /openvpn_foo
#
# Below NAME should be substituted with the name of this script. By default
# it is openvpn, so read as openvpn_enable. If you linked the script to
# openvpn_foo, then read as openvpn_foo_enable etc.
#
# The following variables are supported (defaults are shown).
# You can place them in any of
# /etc/rc.conf, /etc/rc.conf.local or /etc/rc.conf.d/NAME
#
# NAME_enable="NO" # set to YES to enable openvpn
<he startu scrit wi%% a%so indicate i+ an: additiona% arameters are a.ai%a=%eK
# NAME_if= # driver(s) to load, set to "tun", "tap" or "tun tap"
# # it is OK to specify the if_ prefix.
#
# # optional:
# NAME_flags= # additional command line arguments
# NAME_configfile="/usr/local/etc/openvpn/NAME.conf" # --config file
# NAME_dir="/usr/local/etc/openvpn" # --cd directory
11 2e!orting
Reortin' dis%a:s se.era% 'rahsD as seen in the e5am%e in $i'ure 11a. C%ic) the ta= +or a de.ice t:e
to see its 'rahs.
Figure 11a: 2e!orting Gra!s
$reeNA"1 uses co%%ectd to ro.ide reortin' statistics. <he +o%%owin' co%%ectd %u'ins are ena=%ed in
2'onf2$ase2et'2lo'al2'olle'td.'onfD and thus ro.ide reortin' 'rahsK
C>! usa'e K co%%ects the amount o+ time sent =: the C>! in .arious states such as e5ecutin'
user codeD e5ecutin' s:stem codeD and =ein' id%e.
FreeNAS 9.2.1 Users Guide Page 2$# of 280
s:stem %oad K ro.ides a rou'h o.er.iew o+ s:stem uti%i8ation o.er a oneD +i.eD and +i+teen
minute a.era'e.
dis) K shows the a.era'e time a dis) I@- oeration too) to com%ete.
h:sica% memor: K dis%a:s h:sica% memor: usa'e.
swa uti%i8ation K dis%a:s the amount o+ +ree and used swa sace.
inter+ace K shows recei.ed and transmitted tra++ic in =its er second +or each con+i'ured
inter+ace.
dis) sace K dis%a:s +ree and used sace +or each .o%ume and dataset. Howe.erD the dis) sace
used =: an indi.idua% 8.o% is not dis%a:ed as it is a =%oc) de.ice.
rocesses K dis%a:s the num=er o+ rocessesD 'roued =: state.
utime K )ees trac) o+ the s:stem utimeD the a.era'e runnin' timeD and the ma5imum reached
utime.
Reortin' data is sa.edD a%%owin' :ou to .iew and monitor usa'e trends o.er time. Reortin' data is
sa.ed to 2data2rrd,dir.tar.$/2 and shou%d =e reser.ed across s:stem u'rades and at shutdown.
!se the ma'ni+ier =uttons ne5t to each 'rah to increase or decrease the dis%a:ed time increment +rom
10 minutesD hour%:D dai%:D wee)%:D or month%:. Fou can a%so use the aa and VV =uttons to scro%% throu'h
the outut.
12 Additional 6!tions
<his section co.ers the remainin' misce%%aneous otions a.ai%a=%e +rom the $reeNA"1 'rahica%
administrati.e inter+ace.
12.1 8is!la+ S+ste3 Processes
I+ :ou c%ic) (is%a: ":stem >rocessesD a screen wi%% oen showin' the outut o+ toA1B. An e5am%e is
shown in $i'ure 12.1a.
FreeNAS 9.2.1 Users Guide Page 2$$ of 280
Figure 12.1a: S+ste3 Processes 2unning on FreeNAS
<he dis%a: wi%% automatica%%: re+resh itse%+. "im%: c%ic) the 7 in the uer ri'ht corner to c%ose the
dis%a: when :ou are +inished. Note that the dis%a: is read;on%:D meanin' that :ou won't =e a=%e to
issue a 9ill command within it.
12.2 Sell
#e'innin' with .ersion 6.2.0D the $reeNA"1 2!I ro.ides a we= she%%D ma)in' it con.enient to run
command %ine too%s +rom the we= =rowser as the root user. <he %in) to "he%% is the third entr: +rom the
=ottom o+ the menu tree. In $i'ure 12.2aD the %in) has =een c%ic)ed and "he%% is oen.
<he romt indicates that the current user is rootD the hostname is freenasD and the current wor)in'
director: is C Aroot's home director:B.
<o chan'e the si8e o+ the she%%D c%ic) the 60(2D dro;down menu and se%ect a di++erent si8e.
<o co: te5t +rom she%%D hi'h%i'ht the te5tD ri'ht;c%ic)D and se%ect Co: +rom the ri'ht;c%ic) menu. <o
aste into the she%%D c%ic) the >aste =uttonD aste the te5t into the =o5 that oensD and c%ic) the -K
=utton to com%ete the aste oeration.
FreeNAS 9.2.1 Users Guide Page 2$" of 280
Figure 12.2a: .e( Sell
Whi%e :ou are in "he%%D :ou wi%% not ha.e access to an: o+ the other 2!I menus. I+ :ou are usin' "he%%
+or trou=%eshootin' uroses and need to %ea.e the "he%% in order to modi+: a con+i'urationD c%ic) the 5
in the window's uer ri'ht corner. <he ne5t time :ou enter "he%%D :ou wi%% return to :our %ast session.
When :ou are +inished usin' "he%%D t:e e-it to %ea.e the session com%ete%:.
"he%% ro.ides histor: Ause :our u arrow to see re.ious%: entered commands and ress enter to reeat
the current%: dis%a:ed commandB and ta= com%etion At:e a +ew %etters and ress ta= to com%ete a
command name or +i%ename in the current director:B.
N6*7: not a%% o+ "he%%'s +eatures render correct%: in Chrome. $ire+o5 is the recommended =rowser +or
usin' "he%%.
(ue to the em=edded nature o+ $reeNA"1D some $ree#"( comonents are missin' and noticea=%e in
"he%%. $or e5am%eD man a'es are not inc%udedR howe.erD a %in) to the on%ine $ree#"( man a'es is
a.ai%a=%e +rom He%. Most $ree#"( command %ine uti%ities shou%d =e a.ai%a=%e in "he%%. Additiona%
trou=%eshootin' uti%ities that are ro.ided =: $reeNA"1 are descri=ed in !se+u% Command 9ine
!ti%ities.
FreeNAS 9.2.1 Users Guide Page 2$% of 280
12.# 2e(oot
I+ :ou c%ic) Re=ootD :ou wi%% recei.e the warnin' messa'e shown in $i'ure 12.3a and :our =rowser
co%or wi%% chan'e to red to indicate that :ou ha.e se%ected an otion that wi%% ne'ati.e%: imact users o+
N6*7: i+ an: .o%umes are encr:tedD ma)e sure that :ou ha.e set the asshrase and ha.e coies o+
the encr:tion )e: and the %atest reco.er: )e: =e+ore er+ormin' a re=oot. 8itho!t the$e/ )o! -ill %ot
be able to !%loc0 the e%cr)"ted 'ol!(e a*ter the reboot.
Figure 12.#a: 2e(oot .arning 4essage
I+ a scru= or resi%.er is in ro'ress when a re=oot is reEuestedD an additiona% warnin' wi%% as) :ou to
ma)e sure that :ou wish to roceed. In this caseD it is recommended to MCance%M the re=oot reEuest and
to eriodica%%: run =!ool status +rom "he%% unti% it is .eri+ied that the scru= or resi%.er rocess is
com%ete. -nce com%eteD the re=oot reEuest can =e re;issued.
C%ic) the Cance% =utton i+ :ou wish to cance% the re=oot reEuest. -therwiseD c%ic) the Re=oot =utton to
re=oot the s:stem. Re=ootin' the s:stem wi%% disconnect a%% c%ientsD inc%udin' the we= administration
2!I. <he !R9 in :our we= =rowser wi%% chan'e to add 2system2re$oot2 to the end o+ the I> address.
Wait a +ew minutes +or the s:stem to =ootD then use :our =rowser's =ac) =utton to return to the
$reeNA"1 s:stem's I> address. I+ a%% went we%%D :ou shou%d recei.e the 2!I %o'in screen. I+ the %o'in
screen does not aearD :ou wi%% need h:sica% access to the $reeNA"1 s:stem's monitor and )e:=oard
so that :ou can determine what ro=%em is re.entin' the s:stem +rom resumin' norma% oeration.
FreeNAS 9.2.1 Users Guide Page 2$) of 280
12.$ Sutdo0n
I+ :ou c%ic) "hutdownD :ou wi%% recei.e the warnin' messa'e shown in $i'ure 12.&a and :our =rowser
co%or wi%% chan'e to red to indicate that :ou ha.e se%ected an otion that wi%% ne'ati.e%: imact users o+
N6*7: if an+ ,olu3es are encr+!tedJ 3a9e sure tat +ou a,e set te !ass!rase and a,e
co!ies of te encr+!tion 9e+ and te latest reco,er+ 9e+ (efore !erfor3ing a sutdo0n. 8itho!t
the$e/ )o! -ill %ot be able to !%loc0 the e%cr)"ted 'ol!(e -he% the $)$te( i$ re$tarted.
Figure 12.$a: Sutdo0n .arning 4essage
I+ a scru= or resi%.er is in ro'ress when a shutdown is reEuestedD an additiona% warnin' wi%% as) :ou to
ma)e sure that :ou wish to roceed. In this caseD it is recommended to OCance%P the shutdown reEuest
and to eriodica%%: run =!ool status +rom "he%% unti% it is .eri+ied that the scru= or resi%.er rocess is
com%ete. -nce com%eteD the shutdown reEuest can =e re;issued.
C%ic) the OCance%P =utton i+ :ou wish to cance% the shutdown reEuest. -therwiseD c%ic) the O"hutdownP
=utton to ha%t the s:stem. "huttin' down the s:stem wi%% disconnect a%% c%ientsD inc%udin' the we=
administration 2!ID and wi%% ower o++ the $reeNA"1 s:stem. Fou wi%% need h:sica% access to the
$reeNA"1 s:stem in order to turn it =ac) on.
12." &el!
<he He% =utton in the uer ri'ht corner ro.ides a o;u menu containin' h:er%in)s to the .arious
$reeNA"1 on%ine resourcesD inc%udin'K
the Communit: $orum
each mai%in' %ist
the we= inter+ace to the IRC channe%
the #u' <rac)er a'e which %in)s to the =u' data=aseD .ideo wa%)throu'hsD +orumsD and the
documentation wi)i
the on%ine $ree#"( manua% a'es
a %in) to ro+essiona% suort
<hese resources are discussed in more detai% in the ne5t section.
12.% <og 6ut
<o %o' out o+ the $reeNA"1 2!ID sim%: c%ic) the 9o' -ut =utton in the uer ri'ht corner. Fou wi%%
immediate%: =e %o''ed out. An in+ormationa% messa'e wi%% indicate that :ou are %o''ed out and wi%%
ro.ide a h:er%in) which :ou can c%ic) on to %o' =ac) in. When %o''in' =ac) inD :ou wi%% =e romted
+or the root assword.
12.) Alert
$reeNA"1 ro.ides an a%ert s:stem to ro.ide a .isua% warnin' o+ an: conditions that reEuire
administrati.e attention. <he A%ert =utton in the +ar ri'ht corner wi%% +%ash red when there is an
outstandin' a%ert. In the e5am%e a%ert shown in $i'ure 12./a. one o+ the dis)s in a 0$" oo% is o++%ine
which has de'raded the state o+ the oo%.
Figure 12.)a: 7-a3!le Alert 4essage
In+ormationa% messa'es wi%% ha.e a 'reen -K whi%e messa'es reEuirin' attention wi%% =e %isted as a red
CRI<ICA9. CRI<ICA9 messa'es wi%% a%so =e emai%ed to the root user account. I+ :ou are aware o+ a
critica% condition =ut wish to remo.e the +%ashin' a%ert unti% :ou dea% with itD unchec) the =o5 ne5t to
that messa'e.
#ehind the scenesD an a%ert scrit chec)s +or .arious a%ert conditionsD such as .o%ume and dis) statusD
and writes the current conditions to 2#ar2tm*2alert. A Ia.ascrit retrie.es the current a%ert status e.er: *
minutes and wi%% chan'e the so%id 'reen a%ert icon to +%ashin' red i+ a new a%ert is detected. "ome o+ the
conditions that tri''er an a%ert inc%udeK
non;otima% mu%tiath states
!>" -N#A<<@9-W#A<< e.ent
0$" oo% status chan'es +rom H4A9<HF
the s:stem is una=%e to =ind to the We=2!I Address set in ":stem N "ettin's N 2enera%
the s:stem can not +ind an I> address con+i'ured on an i"C"I orta%
the status o+ a 9"I Me'aRAI( "A" contro%%er has chan'edR m+iuti%A6B is inc%uded +or mana'in'
these de.ices
Section 3: Getting Help
1# FreeNAS Su!!ort 2esources
$reeNA"1 has a %ar'e insta%%ation =ase and an acti.e user communit:. <his means that man: usa'e
Euestions ha.e a%read: =een answered and the detai%s are a.ai%a=%e on the Internet. I+ :ou 'et stuc)
usin' $reeNA"1D send a +ew moments searchin' the Internet +or the word FreeNAS with some )e:
words that descri=e :our error messa'e or the +unction that :ou are tr:in' to im%ement.
<he rest o+ this section discusses the +o%%owin' resources which are a.ai%a=%e to $reeNA"1 usersK
We=site and "ocia% Media
$orums
"uort (ata=ase
IRC
Mai%in' 9ists
>ro+essiona% "uort
1#.1 .e(site and Social 4edia
<he $reeNA"1 we=site contains %in)s to a%% o+ the a.ai%a=%e documentationD suortD and socia% media
resources. MaIor announcements are a%so osted to the main a'e.
!sers are we%come to networ) on the $reeNA"1 socia% media sitesK
9in)edIn
2oo'%eX
$ace=oo)
<witter
1#.2 Foru3s
Another in+ormation source +or $reeNA"1 is the $orums. $orums contain user;contri=uted tis and
'uides which ha.e =een cate'ori8edD ma)in' it an idea% resource i+ :ou wish to %earn more a=out a
certain asect o+ $reeNA"1. A search=ar is inc%uded shou%d :ou wish to search =: )e:wordR
a%ternate%:D :ou can c%ic) a cate'or: to =rowse throu'h the threads that e5ist +or that toic.
<he +o%%owin' cate'ories are a.ai%a=%e under Foru3 Infor3ation:
$orum 2uide%ines K read this +irst =e+ore creatin' a +orum ost.
Announcements K su=scri=e to this +orum i+ :ou wish to recei.e announcements a=out new
$reeNA"1 .ersions and +eatures.
<he +o%%owin' cate'ories are a.ai%a=%e under &el! and Su!!ort:
$reeNA" & N00=s K ost here i+ :ou are new to $reeNA"1 and are unsure which cate'or: =est
matches :our Euestion.
$eature ReEuests K +or the discussion o+ ucomin' +eatures.
#u' Reortin' K use this +orum i+ :ou thin) :ou ha.e +ound a =u' in $reeNA"1 and want to
discuss it =e+ore creatin' a suort tic)et.
Hardware K +or the discussion o+ hardware and tis +or 'ettin' the most out o+ :our hardware.
!ser Authentication K 9(A> and Acti.e (irector:.
"harin' K A$>D CI$"D N$"D and i"C"I.
"tora'e K re%icationD snashotsD .o%umesD and 0$".
Networ)in' K networ)in' hardwareD er+ormanceD %in) a''re'ationD 39ANsD ((N"D $<>D
"NM>D ""HD and <$<>.
Insta%%ation K insta%%in' he% or ad.ice =e+ore er+ormin' the insta%%ation.
>%u'ins K ro.ides a discussion area +or creatin' and trou=%eshootin' >#Is.
<he +o%%owin' cate'ories are a.ai%a=%e under 8e,elo!3ent:
$reeNA" K 'enera% de.e%oment discussion.
nano=sd K the em=edded oeratin' s:stem $reeNA"1 is =ased uon.
(Ian'o K the we= +ramewor) used =: the $reeNA"1 'rahica% administrati.e inter+ace.
(oIo <oo%)it K the Ia.ascrit too%)it used to create wid'ets and hand%e c%ient side rocessin'.
<he +o%%owin' cate'ories are a.ai%a=%e under &o0>*o Guides:
Hac)in' K undocumented tric)s +or 'ettin' the most out o+ :our $reeNA"1 s:stem.
Insta%%ation K seci+ic insta%%ation scenarios Ahardware and@or so+twareB.
Con+i'uration K seci+ic con+i'uration scenarios Ae.'. so+tware or c%ient con+i'urationB.
Hardware K instructions +or settin' u seci+ic hardware.
I+ :ou are %oo)in' +or tis on how to test and increase the er+ormance o+ :our s:stemD chec) out the
>er+ormance +orum.
<he +o%%owin' cate'ories are a.ai%a=%e under 'o33unit+ Foru3:
-++;toic K want to discuss somethin' o+ interest to $reeNA"1 users =ut which is not necessari%:
re%ated to $reeNA"1U <his is :our %ace.
Resources K =%o'sD re.iewsD and other sources o+ $reeNA"1 in+ormation not %isted at
+reenas.or'.
Introductions K $reeNA"1 Communit: meet 'n 'reet ; introduce :ourse%+ and %et us )now who
we are chattin' with.
<he +o%%owin' %an'ua'e;seci+ic cate'ories are a.ai%a=%e under InternationalD a%%owin' $reeNA"1
users to interact with each other in their nati.e %an'ua'eK
(utch ; Neder%ands
$rench ; $rancais
2erman ; (eutsch
Ita%ian ; Ita%iano
>ortu'uese ; >ortu'ubs
Russian ; cdeefgh
"anish W 4sano%
<ur)ish ; <ir)je
I+ :ou wish to as) a Euestion on the +orumD :ou wi%% need to c%ic) the O"i'n ! NowSP %in) to create an
account and %o'in usin' that account.
When as)in' a Euestion on the +orumD it is imortant that :ouK
$irst chec) to see i+ the Euestion has a%read: =een as)ed. I+ :ou +ind a simi%ar EuestionD do not
create a new thread. Instead use the ORe%:P %in) at the =ottom o+ the ost to add :our
comments to the e5istin' thread.
Re.iew the a.ai%a=%e cate'ories to see which one is most c%ose%: re%ated to :our Euestion. C%ic)
on that cate'or: and use the O>ost New <hreadP =utton to oen the editor. A+ter t:in' :our
ost and =e+ore :ou c%ic) the OCreate <hreadP =uttonD ma)e sure the OWatch this thread...P =o5
is chec)ed. I+ :ou want to =e noti+ied =: emai%D a%so chec) the Oand recei.e emai% noti+icationsP
=o5. <hat wa: :ou wi%% =e noti+ied whene.er an:one answers :our Euestion.
1#.# Su!!ort 8ata(ase
I+ :ou encounter a trace=ac) error when usin' $reeNA"1 or susect that :ou ha.e +ound a so+tware or
documentation =u'D 'o to httsK@@=u's.+reenas.or'@roIects@+reenas to see i+ :our issue has a%read: =een
reorted. Fou do not need to re'ister in order to search +or e5istin' issues. Howe.erD :ou wi%% need to
re'ister i+ :ou wish to comment on an e5istin' issue or create a new suort issue.
#e+ore creatin' a new issueD ta)e the time to research :our =u' or +eature reEuest +irst. <his is to
re.ent du%icatin' an e5istin' issue and to ensure that :our reort contains the in+ormation that the
de.e%oers need in order to im%ement the +i5 or the +eature.
As art o+ :our researchD er+orm the +o%%owin' stesK
(etermine i+ :ou are runnin' the %atest re%ease o+ $reeNA"1. $reeNA"1 de.e%oers tend to +i5
=u's raid%: and new +eatures are =ein' im%emented as $reeNA"1 matures. I+ :ou are not
runnin' the %atest .ersionD it is Euite %i)e%: that the =u' has a%read: =een +i5ed or the missin'
+eature has =een im%emented. I+ this is the caseD :our =est course o+ action is to =ac)u :our
data and con+i'uration and er+orm an u'rade to the %atest .ersion.
I+ :ou are runnin' the %atest .ersionD use the search +eature to see i+ a simi%ar issue a%read:
e5ists. I+ one doesD do not create a new issue. InsteadD add a comment to the e5istin' issue i+ :ou
ha.e additiona% in+ormation to add.
I+ a simi%ar issue does not a%read: e5istD )ee the +o%%owin' oints in mind as :ou create a new issueK
1. Fou wi%% need to re'ister +or an accountD con+irm :ou re'istration emai% addressD and =e %o''ed
in =e+ore :ou can create a new issue.
2. In the <rac)er dro;down menuD se%ect B!g i+ :ou are reortin' a =u' or Feat!re i+ :ou are
ma)in' a +eature reEuest.
3. In the "u=Iect +ie%dD inc%ude descriti.e )e:words that descri=e the issue. <his is use+u% +or other
users who search +or a simi%ar ro=%em.
&. In the (escrition sectionD descri=e the ro=%emD how to recreate itD and inc%ude the te5t o+ an:
error messa'es. I+ :ou are reEuestin' a +eatureD descri=e the =ene+it ro.ided =: the +eature andD
i+ a%ica=%eD ro.ide e5am%es o+ other roducts that use that +eature or the !R9 o+ the
homea'e +or the so+tware.
*. I+ :ou wou%d %i)e to inc%ude a screenshot or %o' o+ :our con+i'uration or errorD use the #rowse
=utton ne5t to the $i%es +ie%d to u%oad the +i%e.
,. 9ea.e a%% o+ the other +ie%ds at their de+au%t .a%ues as these are used =: de.e%oers as the: ta)e
action on the issue.
/. >ress the >re.iew %in) to read throu'h :our tic)et =e+ore su=mittin' it. Ma)e sure it inc%udes a%%
o+ the in+ormation that someone e%se wou%d need to understand :our ro=%em or reEuest. -nce
:ou are satis+ied with :our tic)etD c%ic) the Create <ic)et =utton to su=mit it.
An emai% wi%% automatica%%: =e sent to the address :ou used when re'isterin' whene.er a comment or
action occurs on :our issue.
1#.$ I2'
I+ :ou wish to as) a Euestion in Orea% timePD :ou can tr: the Qfreenas channe% on IRC $reenode.
(eendin' uon the time o+ da: and :our time 8oneD a $reeNA"1 de.e%oer or other $reeNA"1 users
ma: =e a.ai%a=%e to assist :ou. I+ :ou do not 'et an answer ri'ht awa:D remain on the channe% as other
users tend to read the channe% histor: in order to answer Euestions as the: are a=%e to.
<:ica%%:D an IRC c%ient is used to access the Qfreenas IRC channe%. A%ternate%:D :ou can access the
we=chat .ersion o+ the channe% +rom a we= =rowser.
<o 'et the most out o+ the IRC channe%D )ee the +o%%owin' oints in mindK
(o not as) Ocan an:one he% meUPR insteadD Iust as) :our Euestion. I+ someone )nows the
FreeNAS 9.2.1 Users Guide Page 2"# of 280
answerD the: wi%% tr: to assist :ou.
(o not as) a Euestion and then %ea.e. !sers who )now the answer can not he% :ou i+ :ou
disaear.
(o not ta)e it ersona%%: i+ no one answers or demand that someone answers :our Euestion.
Ma:=e no one who )nows the answer is a.ai%a=%eD ma:=e :our Euestion is rea%%: hardD or ma:=e
it is a Euestion that has a%read: =een answered man: times in the other suort resources. <r:
as)in' a'ain in a +ew hours or research the other resources to see i+ :ou ha.e missed an:thin'.
(o not ost error messa'es in the channe% as the IRC so+tware wi%% ro=a=%: )ic) :ou out.
InsteadD use a astin' ser.ice such as aste=in and aste the resu%tin' !R9 into the IRC
discussion.
1#." 4ailing <ists
"e.era% $reeNA"1 mai%in' %ists are a.ai%a=%e which a%%ow users and de.e%oers to as) and answer
Euestions re%ated to the toic o+ the mai%in' %ist. <o ost an emai% to a %istD :ou wi%% need to su=scri=e to
it +irst. 4ach mai%in' %ist is archi.edD a%%owin' :ou to =rowse +or in+ormation =: dateD thread nameD or
author.
<he +o%%owin' mai%in' %ists are a.ai%a=%eK
$reenas;announce K this is a %ow;.o%umeD read;on%: %ist where maIor mi%estonesD such as new
re%easesD are announced.
$reenas;commit K this is a read;on%: %ist. As code chan'es in the $reeNA"1 reositor:D the
commit messa'e is automatica%%: sent to this %ist.
$reenas;de.e% K $reeNA"1 de.e%oers are su=scri=ed to this %ist. <echnica% Euestions a=out the
current $reeNA"1 re%ease can =e osted here.
$reenas;docs K this %ist is +or discussion re'ardin' $reeNA"1 documentation.
$reenas;testin' K $reeNA"1 de.e%oers are su=scri=ed to this %ist. <echnica% Euestions a=out the
ucomin' $reeNA" re%ease and +eed=ac) on testin' snashots can =e osted here.
$reenas;trans%ations K this %ist is +or discussion re'ardin' $reeNA"1 %oca%i8ation and trans%atin'
$reeNA"1 documentation.
N6*7: the mai%in' %ists were mi'rated +rom "ource$or'e to Mai%man in (ecem=erD 2013. Archi.es o+
the "ource$or'e mai%in' %ists are a.ai%a=%e at 2mane.
1#.% Professional Su!!ort
In addition to the +ree%: a.ai%a=%e communit: resourcesD i7s:stems o++ers ro+essiona% suort
ac)a'es. i7s:stems' de.e%oment team wor)s hard to imro.e new and current .ersions o+
$reeNA"1D ro.idin' them with the insi'ht to ro.ide e5ert $reeNA"1 suort and consu%tation
ser.ices. <heir >ro+essiona% "er.ices team can a%so con+i'ure :our $reeNA"1 hardware and so+tware
to de%i.er the hi'hest %e.e%s o+ er+ormanceD sta=i%it:D and securit:. "ee the i7s:stems suort a'e to
reEuest a Euote.
FreeNAS 9.2.1 Users Guide Page 2"$ of 280
1$ Useful 'o33and <ine Utilities
"e.era% command %ine uti%ities which are ro.ided with $reeNA"1 are demonstrated in this section.
<he +o%%owin' uti%ities can =e used +or =enchmar)in' and er+ormance testin'K
I!erf : used +or measurin' ma5imum <C> and !(> =andwidth er+ormance
Net!erf : a too% +or measurin' networ) er+ormance
I6=one : +i%es:stem =enchmar) uti%it: used to er+orm a =road +i%es:stem ana%:sis
arcstat.!+ and arc:su33ar+.!+ : used to 'ather 0$" ARC statistics
A88 : a too% +or measurin' and characteri8in' dis) su=s:stem I@-
<he +o%%owin' uti%ities are seci+ic to RAI( contro%%ersK
t0:cli : used to monitor and maintain 3ware RAI( contro%%ers
4ega'li : used to con+i'ure and mana'e 9"I Me'aRAI( "A" +ami%: o+ RAI( contro%%ers
<his section a%so descri=es the +o%%owin' uti%itiesK
freenas>de(ug : the =ac)end used to dum $reeNA"1 de=u''in' in+ormation
t3u- : a termina% mu%ti%e5er simi%ar to 2N! screen
83idecode : reorts in+ormation a=out s:stem hardware as descri=ed in the s:stem's #I-"
1$.1 I!erf
Ier+ is a uti%it: +or measurin' ma5imum <C> and !(> =andwidth er+ormance. It can =e used to chart
networ) throu'hut o.er time. $or e5am%eD :ou can use it to test the seed o+ di++erent t:es o+ shares
to determine which t:e =est er+orms on :our networ).
$reeNA"1 inc%udes the Ier+ ser.er. <o er+orm networ) testin'D :ou wi%% need to insta%% an Ier+ c%ient
on a des)to s:stem that has networ) access to the $reeNA"1 s:stem. <his section wi%% demonstrate
how to use the 5Ier+ 2!I c%ient as it wor)s on WindowsD Mac -" 7D 9inu5D and #"( s:stems.
"ince this c%ient is Ia.a =asedD :ou wi%% a%so need to insta%% the aroriate CR4 +or the c%ient oeratin'
s:stem.
9inu5 and #"( users wi%% need to insta%% the ier+ ac)a'e usin' their oeratin' s:stem's ac)a'e
mana'ement s:stem.
<o start 5Ier+ on WindowsK un8i the down%oaded +i%eD start Command >romt in Run as administrator
modeD cd to the un8ied +o%derD and run @!erf.(at.
<o start 5Ier+ on Mac -" 7D 9inu5D or #"(D un8i the down%oaded +i%eD cd to the un8ied director:D
t:e c3od uV- @!erf.sD and run .E@!erf.s.
-nce the c%ient is read:D :ou need to start the Ier+ ser.er on $reeNA"1. <o see the a.ai%a=%e ser.er
otionsD oen "he%% and t:eK
iperf --help | more
Usage: iperf [-s|-c host] [options]
iperf [-h|--help] [-v|--version]
FreeNAS 9.2.1 Users Guide Page 2"" of 280
Client/Server:
-f, --format [kmKM] format to report: Kbits, Mbits, KBytes, MBytes
-i, --interval # seconds between periodic bandwidth reports
-l, --len #[KM] length of buffer to read or write (default 8 KB)
-m, --print_mss print TCP maximum segment size (MTU - TCP/IP header)
-o, --output <filename> output the report or error message to this specified
file
-p, --port # server port to listen on/connect to
-u, --udp use UDP rather than TCP
-w, --window #[KM] TCP window size (socket buffer size)
-B, --bind <host> bind to <host>, an interface or multicast address
-C, --compatibility for use with older versions does not sent extra msgs
-M, --mss # set TCP maximum segment size (MTU - 40 bytes)
-N, --nodelay set TCP no delay, disabling Nagle's Algorithm
-V, --IPv6Version Set the domain to IPv6
Server specific:
-s, --server run in server mode
-U, --single_udp run in single threaded UDP mode
-D, --daemon run the server as a daemon
Client specific:
-b, --bandwidth #[KM] for UDP, bandwidth to send at in bits/sec
(default 1 Mbit/sec, implies -u)
-c, --client <host> run in client mode, connecting to <host>
-d, --dualtest Do a bidirectional test simultaneously
-n, --num #[KM] number of bytes to transmit (instead of -t)
-r, --tradeoff Do a bidirectional test individually
-t, --time # time in seconds to transmit for (default 10 secs)
-F, --fileinput <name> input the data to be transmitted from a file
-I, --stdin input the data to be transmitted from stdin
-L, --listenport # port to receive bidirectional tests back on
-P, --parallel # number of parallel client threads to run
-T, --ttl # time-to-live, for multicast (default 1)
-Z, --linux-congestion <algo> set TCP congestion control algorithm (Linux only)
Miscellaneous:
-x, --reportexclude [CDMSV] exclude C(connection) D(data) M(multicast)
S(settings) V(server) reports
-y, --reportstyle C report as a Comma-Separated Values
-h, --help print this message and quit
-v, --version print version information and quit
[KM] Indicates options that support a K or M suffix for kilo- or mega-
The TCP window size option can be set by the environment variable
TCP_WINDOW_SIZE. Most other options can be set by an environment variable
IPERF_<long option name>, such as IPERF_BANDWIDTH.
$or e5am%eD to er+orm a <C> test and start the ser.er in daemon mode Aso that :ou 'et :our romt
=ac)BD t:eK
iperf -sD
------------------------------------------------------------
Server listening on TCP port 5001
TCP window size: 64.0 KByte (default)
FreeNAS 9.2.1 Users Guide Page 2"% of 280
------------------------------------------------------------
Running Iperf Server as a daemon
The Iperf daemon process ID: 4842

N6*7: i+ :ou c%ose "he%%D the daemon rocess wi%% sto. Ha.e :our en.ironment setu Ae.'. shares
con+i'ured and startedB be*ore startin' the ier+ rocess.
$rom :our des)toD oen the c%ient. Inut the I> o+ address o+ the $reeNA"1 s:stemD seci+: the
runnin' time +or the test under A%ication %a:er otions N <ransmit Athe de+au%t test time is 10
secondsBD and c%ic) the Run Ier+S =utton. $i'ure 1&.1a shown an e5am%e o+ the c%ient runnin' on a
Windows s:stem whi%e an "$<> trans+er is occurrin' on the networ).
Figure 1$.1a: ?ie0ing 5and0idt Statistics Using -@!erf
(eendin' uon the tra++ic =ein' tested Ae.'. the t:e o+ share runnin' on :our networ)BD :ou ma: need
to test !(> instead o+ <C>. <o start the ier+ ser.er in !(> modeD use i!erf >s8u as the u seci+ies
!(>R the startu messa'e shou%d indicate that the ser.er is %istenin' +or !(> data'rams. I+ :ou are not
sure i+ the tra++ic that :ou wish to test is !(> or <C>D run this command to determine which ser.ices
are runnin' on the $reeNA"1 s:stemK
FreeNAS 9.2.1 Users Guide Page 2") of 280
sockstat -4 | more
USER COMMAND PID FD PROTO LOCAL ADDRESS FOREIGN ADDRESS
root iperf 4870 6 udp4 *:5001 *:*
root iperf 4842 6 tcp4 *:5001 *:*
www nginx 4827 3 tcp4 127.0.0.1:15956 127.0.0.1:9042
www nginx 4827 5 tcp4 192.168.2.11:80 192.168.2.26:56964
www nginx 4827 7 tcp4 *:80 *:*
root sshd 3852 5 tcp4 *:22 *:*
root python 2503 5 udp4 *:* *:*
root mountd 2363 7 udp4 *:812 *:*
root mountd 2363 8 tcp4 *:812 *:*
root rpcbind 2359 9 udp4 *:111 *:*
root rpcbind 2359 10 udp4 *:886 *:*
root rpcbind 2359 11 tcp4 *:111 *:*
root nginx 2044 7 tcp4 *:80 *:*
root python 2029 3 udp4 *:* *:*
root python 2029 4 tcp4 127.0.0.1:9042 *:*
root python 2029 7 tcp4 127.0.0.1:9042 127.0.0.1:15956
root ntpd 1548 20 udp4 *:123 *:*
root ntpd 1548 22 udp4 192.168.2.11:123 *:*
root ntpd 1548 25 udp4 127.0.0.1:123 *:*
root syslogd 1089 6 udp4 127.0.0.1:514 *:*
When :ou are +inished testin'D either t:e 9illall i!erf or c%ose "he%% to terminate the ier+ ser.er
rocess.
1$.2 Net!erf
Neter+ is a =enchmar)in' uti%it: that can =e used to measure the er+ormance o+ unidirectiona%
throu'hut and end;to;end %atenc:.
#e+ore :ou can use the net!erf commandD :ou must start its ser.er rocess usin' this commandK
netserver
Starting netserver with host 'IN(6)ADDR_ANY' port '12865' and family AF_UNSPEC
<he +o%%owin' command wi%% dis%a: the a.ai%a=%e otions +or er+ormin' tests with the net!erf
command. <he Neter+ Manua% descri=es each otion in more detai% and e5%ains how to er+orm man:
t:es o+ tests. It is the =est re+erence +or understandin' how each test wor)s and how to interret :our
resu%ts. When :ou are +inished with :our testsD t:e 9illall netser,er to sto the ser.er rocess.
netperf -h |more
Usage: netperf [global options] -- [test options]
Global options:
-a send,recv Set the local send,recv buffer alignment
-A send,recv Set the remote send,recv buffer alignment
-B brandstr Specify a string to be emitted with brief output
-c [cpu_rate] Report local CPU usage
-C [cpu_rate] Report remote CPU usage
-d Increase debugging output
-D [secs,units] * Display interim results at least every secs seconds
using units as the initial guess for units per second
-f G|M|K|g|m|k Set the output units
-F fill_file Pre-fill buffers with data from fill_file
-h Display this text
-H name|ip,fam * Specify the target machine and/or local ip and family
-i max,min Specify the max and min number of iterations (15,1)
-I lvl[,intvl] Specify confidence level (95 or 99) (99)
and confidence interval in percentage (10)
-j Keep additional timing statistics
-l testlen Specify test duration (>0 secs) (<0 bytes|trans)
-L name|ip,fam * Specify the local ip|name and address family
-o send,recv Set the local send,recv buffer offsets
-O send,recv Set the remote send,recv buffer offset
-n numcpu Set the number of processors for CPU util
-N Establish no control connection, do 'send' side only
-p port,lport* Specify netserver port number and/or local port
-P 0|1 Don't/Do display test headers
-r Allow confidence to be hit on result only
-s seconds Wait seconds between test setup and test start
-S Set SO_KEEPALIVE on the data connection
-t testname Specify test to perform
-T lcpu,rcpu Request netperf/netserver be bound to local/remote cpu
-v verbosity Specify the verbosity level
-W send,recv Set the number of send,recv buffers
-v level Set the verbosity level (default 1, min 0)
-V Display the netperf version and exit
For those options taking two parms, at least one must be specified; specifying one
value without a comma will set both parms to that value, specifying a value with a
leading comma will set just the second parm, a value with a trailing comma will set
just the first. To set each parm to unique values, specify both and separate them
with a comma.
* For these options taking two parms, specifying one value with no comma will only
set the first parms and will leave the second at the default value. To set the
second value it must be preceded with a comma or be a comma-separated pair. This is
to retain previous netperf behaviour.
1$.# I6=one
I-8one is a dis) and +i%es:stem =enchmar)in' too%. It can =e used to test +i%e I@- er+ormance +or the
+o%%owin' oerationsK readD writeD re;readD re;writeD read =ac)wardsD read stridedD +readD +writeD random
readD readD mmaD aioGreadD and aioGwrite.
$reeNA"1 shis with I-8oneD meanin' that it can =e run +rom "he%%. When usin' I-8one on
$reeNA"1D cd to a director: in a .o%ume that :ou ha.e ermission to write toD otherwise :ou wi%% 'et
an error a=out =ein' una=%e to write the temorar: +i%e.
#e+ore usin' I-8oneD read throu'h the I-8one documentation >($ as it descri=es the testsD the man:
command %ine switchesD and how to interret :our resu%ts.
I+ :ou ha.e ne.er used this too% =e+oreD these resources ro.ide 'ood startin' oints on which tests to
runD when to run themD and how to interret the resu%tsK
How <o Measure 9inu5 $i%es:stem I@- >er+ormance With io8one
Ana%:8in' N$" C%ient >er+ormance with I-8one
10 io8one 45am%es +or (is) I@- >er+ormance Measurement on 9inu5
Fou can recei.e a summar: o+ the a.ai%a=%e switches =: t:in' the +o%%owin' command.
iozone -h | more
iozone: help mode
Usage: iozone[-s filesize_Kb] [-r record_size_Kb] [-f [path]filename] [-h]
[-i test] [-E] [-p] [-a] [-A] [-z] [-Z] [-m] [-M] [-t children]
[-l min_number_procs] [-u max_number_procs] [-v] [-R] [-x] [-o]
[-d microseconds] [-F path1 path2...] [-V pattern] [-j stride]
[-T] [-C] [-B] [-D] [-G] [-I] [-H depth] [-k depth] [-U mount_point]
[-S cache_size] [-O] [-L cacheline_size] [-K] [-g maxfilesize_Kb]
[-n minfilesize_Kb] [-N] [-Q] [-P start_cpu] [-e] [-c] [-b Excel.xls]
[-J milliseconds] [-X write_telemetry_filename] [-w] [-W]
[-Y read_telemetry_filename] [-y minrecsize_Kb] [-q maxrecsize_Kb]
[-+u] [-+m cluster_filename] [-+d] [-+x multiplier] [-+p # ]
[-+r] [-+t] [-+X] [-+Z] [-+w percent dedupable] [-+y
percent_interior_dedup]
[-+C percent_dedup_within]
-a Auto mode
-A Auto2 mode
-b Filename Create Excel worksheet file
-B Use mmap() files
-c Include close in the timing calculations
-C Show bytes transferred by each child in throughput testing
-d # Microsecond delay out of barrier
-D Use msync(MS_ASYNC) on mmap files
-e Include flush (fsync,fflush) in the timing calculations
-E Run extension tests
-f filename to use
-F filenames for each process/thread in throughput test
-g # Set maximum file size (in Kbytes) for auto mode (or #m or #g)
-G Use msync(MS_SYNC) on mmap files
-h help
-H # Use POSIX async I/O with # async operations
-i # Test to run (0=write/rewrite, 1=read/re-read, 2=random-read/write
3=Read-backwards, 4=Re-write-record, 5=stride-read, 6=fwrite/re-fwrite
7=fread/Re-fread, 8=random_mix, 9=pwrite/Re-pwrite, 10=pread/Re-pread
11=pwritev/Re-pwritev, 12=preadv/Re-preadv)
-I Use VxFS VX_DIRECT, O_DIRECT,or O_DIRECTIO for all file operations
-j # Set stride of file accesses to (# * record size)
-J # milliseconds of compute cycle before each I/O operation
-k # Use POSIX async I/O (no bcopy) with # async operations
-K Create jitter in the access pattern for readers
-l # Lower limit on number of processes to run
-L # Set processor cache line size to value (in bytes)
-m Use multiple buffers
-M Report uname -a output
-n # Set minimum file size (in Kbytes) for auto mode (or #m or #g)
-N Report results in microseconds per operation
-o Writes are synch (O_SYNC)
-O Give results in ops/sec.
-p Purge on
-P # Bind processes/threads to processors, starting with this cpu
-q # Set maximum record size (in Kbytes) for auto mode (or #m or #g)
-Q Create offset/latency files
-r # record size in Kb
or -r #k .. size in Kb
or -r #m .. size in Mb
or -r #g .. size in Gb
-R Generate Excel report
-s # file size in Kb
or -s #k .. size in Kb
or -s #m .. size in Mb
or -s #g .. size in Gb
-S # Set processor cache size to value (in Kbytes)
-t # Number of threads or processes to use in throughput test
-T Use POSIX pthreads for throughput tests
-u # Upper limit on number of processes to run
-U Mount point to remount between tests
-v version information
-V # Verify data pattern write/read
-w Do not unlink temporary file
-W Lock file when reading or writing
-x Turn off stone-walling
-X filename Write telemetry file. Contains lines with (offset reclen
compute_time) in ascii
-y # Set minimum record size (in Kbytes) for auto mode (or #m or #g)
-Y filename Read telemetry file. Contains lines with (offset reclen
compute_time) in ascii
-z Used in conjunction with -a to test all possible record sizes
-Z Enable mixing of mmap I/O and file I/O
-+E Use existing non-Iozone file for read-only testing
-+K Sony special. Manual control of test 8.
-+m Cluster_filename Enable Cluster testing
-+d File I/O diagnostic mode. (To troubleshoot a broken file I/O
subsystem)
-+u Enable CPU utilization output (Experimental)
-+x # Multiplier to use for incrementing file and record sizes
-+p # Percentage of mix to be reads
-+r Enable O_RSYNC|O_SYNC for all testing.
-+t Enable network performance test. Requires -+m
-+n No retests selected.
-+k Use constant aggregate data set size.
-+q Delay in seconds between tests.
-+l Enable record locking mode.
-+L Enable record locking mode, with shared file.
-+B Sequential mixed workload.
-+A # Enable madvise. 0 = normal, 1=random, 2=sequential
3=dontneed, 4=willneed
-+N Do not truncate existing files on sequential writes.
-+S # Dedup-able data is limited to sharing within each numerically
identified file set
-+V Enable shared file. No locking.
-+X Enable short circuit mode for filesystem testing ONLY
ALL Results are NOT valid in this mode.
-+Z Enable old data set compatibility mode. WARNING.. Published
hacks may invalidate these results and generate bogus, high
values for results.
-+w ## Percent of dedup-able data in buffers.
-+y ## Percent of dedup-able within & across files in buffers.
-+C ## Percent of dedup-able within & not across files in buffers.
-+H Hostname Hostname of the PIT server.
-+P Service Service of the PIT server.
-+z Enable latency histogram logging.
As :ou can see +rom the num=er o+ otionsD I-8one is comrehensi.e and it ma: ta)e some time to
%earn how to use the tests e++ecti.e%:.
N6*7: i+ :ou re+er to .isua%i8e the co%%ected dataD scrits are a.ai%a=%e to render I-8one's outut in
2nu%ot.
1$.$ arcstat
Arcstat is a scrit that rints out 0$" ARC statistics. -ri'ina%%: it was a er% scrit created =: "un. <hat
er% scrit was orted to $ree#"( and was then orted as a >:thon scrit +or use on $reeNA"1.
Watchin' ARC hits@misses and ercenta'es wi%% ro.ide an indication o+ how we%% :our 0$" oo% is
+etchin' +rom the ARC rather than usin' dis) I@-. Idea%%:D :ou want as man: thin's +etchin' +rom
cache as ossi=%e. Kee :our %oad in mind as :ou re.iew the stats. $or random readsD e5ect a miss and
ha.in' to 'o to dis) to +etch the data. $or cached readsD e5ect it to u%% out o+ the cache and ha.e a hit.
9i)e a%% cache s:stemsD the ARC ta)es time to +i%% with data. <his means that it wi%% ha.e a %ot o+ misses
unti% the oo% has =een in use +or a whi%e. I+ there continues to =e %ots o+ misses and hi'h dis) I@- on
cached readsD there is cause to in.esti'ate +urther and tune the s:stem.
<he $ree#"( 0$" <unin' 2uide ro.ides some su''estions +or common%: tuned s+sctl .a%ues. It
shou%d =e noted that er+ormance tunin' is more o+ an art than a science and that an: chan'es :ou
ma)e wi%% ro=a=%: reEuire se.era% iterations o+ tune and test. #e aware that what needs to =e tuned wi%%
.ar: deendin' uon the t:e o+ wor)%oad and that what wor)s +or one erson's networ) ma: not
=ene+it :ours.
In articu%arD the .a%ue o+ re;+etchin' deends uon the amount o+ memor: and the t:e o+ wor)%oadD
as seen in these two e5am%esK
!nderstandin' 0$"K >re+etch
0$" re+etch a%'orithm can cause er+ormance draw=ac)s
1$.$.1 Using te Scri!ts
$reeNA"1 ro.ides two command %ine scrits which an =e manua%%: run +rom "he%%K
arc:su33ar+.!+: ro.ides a summar: o+ the statistics
arcstat.!+: used to watch the statistics in rea% time
<he ad.anta'e o+ these scrits is that the: can =e used to ro.ide rea% time Ari'ht nowB in+ormationD
whereas the current 2!I reortin' mechanism is desi'ned to on%: ro.ide 'rahs charted o.er time.
<his +orum ost demonstrates some e5am%es o+ usin' these scrits with hints on how to interret the
resu%ts.
<o .iew the he% +or arcstat.:K
arcstat.py -h
Usage: arcstat [-hvx] [-f fields] [-o file] [-s string] [interval [count]]
-h: Print this help message
-v: List all possible field headers and definitions
-x: Print extended stats
-f: Specify specific fields to print (see -v)
-o: Redirect output to the specified file
-s: Override default field separator with custom character or string
Examples:
arcstat -o /tmp/a.log 2 10
arcstat -s "," -o /tmp/a.log 2 10
arcstat -v
arcstat -f time,hit%,dh%,ph%,mh% 1
<o .iew ARC statistics in rea% timeD seci+: an inter.a% and a count. <his command wi%% dis%a: e.er: 1
second +or a count o+ +i.e.
arcstat.py 1 5
time read miss miss% dmis dm% pmis pm% mmis mm% arcsz c
06:19:03 0 0 0 0 0 0 0 0 0 425K 6.6G
06:19:04 0 0 0 0 0 0 0 0 0 425K 6.6G
06:19:05 0 0 0 0 0 0 0 0 0 425K 6.6G
06:19:06 0 0 0 0 0 0 0 0 0 425K 6.6G
06:19:07 0 0 0 0 0 0 0 0 0 425K 6.6G
<his command ro.ides a =rie+ descrition o+ the +ie%ds in the oututK
arcstat.py -v
System Memory:
2.00% 156.36 MiB Active, 1.49% 116.70 MiB Inact
39.49% 3.02 GiB Wired, 0.03% 2.53 MiB Cache
56.97% 4.35 GiB Free, 0.02% 1.23 MiB Gap
Real Installed: 8.00 GiB
Real Available: 98.65% 7.89 GiB
Real Managed: 96.83% 7.64 GiB
Logical Total: 8.00 GiB
Logical Used: 44.12% 3.53 GiB
Logical Free: 55.88% 4.47 GiB
Kernel Memory: 226.69 MiB
Data: 90.16% 204.39 MiB
Text: 9.84% 22.31 MiB
Kernel Memory Map: 7.64 GiB
Size: 22.56% 1.72 GiB
Free: 77.44% 5.92 GiB
ARC Summary: (HEALTHY)
Storage pool Version: 5000
Filesystem Version: 5
Memory Throttle Count: 0
ARC Misc:
Deleted: 0
Recycle Misses: 0
Mutex Misses: 0
Evict Skips: 0
ARC Size: 28.39% 1.89 GiB
Target Size: (Adaptive) 100.00% 6.64 GiB
Min Size (Hard Limit): 12.50% 850.23MiB
Max Size (High Water): 8:1 6.64 GiB
ARC Size Breakdown:
Recently Used Cache Size: 50.30% 3.34 GiB
Frequently Used Cache Size: 49.70% 3.30GiB
ARC Hash Breakdown:
Elements Max: 258.19k
FreeNAS 9.2.1 Users Guide Page 2%# of 280
Elements Current: 100.00% 258.19k
Collisions: 157.63k
Chain Max: 8
Chains: 79.46k
ARC Total accesses: 2.25m
Cache Hit Ratio: 99.94% 2.25m
Cache Miss Ratio: 0.06% 1.38k
Actual Hit Ratio: 99.86% 2.25m
Data Demand Efficiency: 100.00% 1.99m
Data Prefetch Efficiency: 100.00% 6.11k
CACHE HITS BY CACHE LIST:
Anonymously Used: 0.02% 353
Most Recently Used: 2.70% 60.83k
Most Frequently Used: 97.22% 2.19m
Most Recently Used Ghost: 0.06% 1.34k
Most Frequently Used Ghost: 0.00% 13
CACHE HITS BY DATA TYPE:
Demand Data: 88.26% 1.99m
Prefetch Data: 0.27% 6.11k
Demand Metadata: 11.47% 258.29k
Prefetch Metadata: 0.00% 0
CACHE MISSES BY DATA TYPE:
Demand Data: 0.00% 0
Prefetch Data: 0.00% 0
Demand Metadata: 9.76% 135
Prefetch Metadata: 90.24% 1.25k
File-Level Prefetch: (HEALTHY)DMU Efficiency: 10.16m
Hit Ratio: 80.03% 8.13m
Miss Ratio: 19.97% 2.03m
Colinear: 2.03m
Hit Ratio: 0.00% 91
Miss Ratio: 100.00% 2.03m
Stride: 8.06m
Hit Ratio: 100.00% 8.06m
Miss Ratio: 0.00% 0
DMU Misc:
Reclaim: 2.03m
Successes: 0.08% 1.65k
Failures: 99.92% 2.03m
Streams: 72.11k
+Resets: 0.00% 0
-Resets: 100.00% 72.11k
Bogus: 0
ZFS Tunable (sysctl):
kern.maxusers 384
vm.kmem_size 8205963264
vm.kmem_size_scale 1
vm.kmem_size_min 0
vm.kmem_size_max 329853485875
vfs.zfs.l2c_only_size 0
vfs.zfs.mfu_ghost_data_lsize 623119872
vfs.zfs.mfu_ghost_metadata_lsize 348672
vfs.zfs.mfu_ghost_size 623468544
vfs.zfs.mfu_data_lsize 302145536
vfs.zfs.mfu_metadata_lsize 8972288
vfs.zfs.mfu_size 326883328
vfs.zfs.mru_ghost_data_lsize 769186304
FreeNAS 9.2.1 Users Guide Page 2%$ of 280
vfs.zfs.mru_ghost_metadata_lsize 8935424
vfs.zfs.mru_ghost_size 778121728
vfs.zfs.mru_data_lsize 1127638016
vfs.zfs.mru_metadata_lsize 30442496
vfs.zfs.mru_size 1274765312
vfs.zfs.anon_data_lsize 0
vfs.zfs.anon_metadata_lsize 0
vfs.zfs.anon_size 279040
vfs.zfs.l2arc_norw 1
vfs.zfs.l2arc_feed_again 1
vfs.zfs.l2arc_noprefetch 1
vfs.zfs.l2arc_feed_min_ms 200
vfs.zfs.l2arc_feed_secs 1
vfs.zfs.l2arc_headroom 2
vfs.zfs.l2arc_write_boost 8388608
vfs.zfs.l2arc_write_max 8388608
vfs.zfs.arc_meta_limit 1783055360
vfs.zfs.arc_meta_used 594834472
vfs.zfs.arc_min 891527680
vfs.zfs.arc_max 7132221440
vfs.zfs.dedup.prefetch 1
vfs.zfs.mdcomp_disable 0
vfs.zfs.nopwrite_enabled 1
vfs.zfs.zfetch.array_rd_sz 1048576
vfs.zfs.zfetch.block_cap 256
vfs.zfs.zfetch.min_sec_reap 2
vfs.zfs.zfetch.max_streams 8
vfs.zfs.prefetch_disable 0
vfs.zfs.no_scrub_prefetch 0
vfs.zfs.no_scrub_io 0
vfs.zfs.resilver_min_time_ms 3000
vfs.zfs.free_min_time_ms 1000
vfs.zfs.scan_min_time_ms 1000
vfs.zfs.scan_idle 50
vfs.zfs.scrub_delay 4
vfs.zfs.resilver_delay 2
vfs.zfs.top_maxinflight 32
vfs.zfs.write_to_degraded 0
vfs.zfs.mg_noalloc_threshold 0
vfs.zfs.mg_alloc_failures 8
vfs.zfs.condense_pct 200
vfs.zfs.metaslab.weight_factor_enable 0
vfs.zfs.metaslab.preload_enabled 1
vfs.zfs.metaslab.preload_limit 3
vfs.zfs.metaslab.unload_delay 8
vfs.zfs.metaslab.load_pct 50
vfs.zfs.metaslab.min_alloc_size 10485760
vfs.zfs.metaslab.df_free_pct 4
vfs.zfs.metaslab.df_alloc_threshold 131072
vfs.zfs.metaslab.debug_unload 0
vfs.zfs.metaslab.debug_load 0
vfs.zfs.metaslab.gang_bang 131073
vfs.zfs.ccw_retry_interval 300
vfs.zfs.check_hostid 1
vfs.zfs.deadman_enabled 1
vfs.zfs.deadman_checktime_ms 5000
vfs.zfs.deadman_synctime_ms 1000000
FreeNAS 9.2.1 Users Guide Page 2%" of 280
vfs.zfs.recover 0
vfs.zfs.txg.timeout 5
vfs.zfs.max_auto_ashift 13
vfs.zfs.vdev.cache.bshift 16
vfs.zfs.vdev.cache.size 0
vfs.zfs.vdev.cache.max 16384
vfs.zfs.vdev.trim_on_init 1
vfs.zfs.vdev.write_gap_limit 4096
vfs.zfs.vdev.read_gap_limit 32768
vfs.zfs.vdev.aggregation_limit 131072
vfs.zfs.vdev.scrub_max_active 2
vfs.zfs.vdev.scrub_min_active 1
vfs.zfs.vdev.async_write_max_active 10
vfs.zfs.vdev.async_write_min_active 1
vfs.zfs.vdev.async_read_max_active 3
vfs.zfs.vdev.async_read_min_active 1
vfs.zfs.vdev.sync_write_max_active 10
vfs.zfs.vdev.sync_write_min_active 10
vfs.zfs.vdev.sync_read_max_active 10
vfs.zfs.vdev.sync_read_min_active 10
vfs.zfs.vdev.max_active 1000
vfs.zfs.vdev.larger_ashift_minimal 1
vfs.zfs.vdev.bio_delete_disable 0
vfs.zfs.vdev.bio_flush_disable 0
vfs.zfs.vdev.trim_max_pending 64
vfs.zfs.vdev.trim_max_bytes 2147483648
vfs.zfs.cache_flush_disable 0
vfs.zfs.zil_replay_disable 0
vfs.zfs.sync_pass_rewrite 2
vfs.zfs.sync_pass_dont_compress 5
vfs.zfs.sync_pass_deferred_free 2
vfs.zfs.zio.use_uma 1
vfs.zfs.snapshot_list_prefetch 0
vfs.zfs.version.ioctl 3
vfs.zfs.version.zpl 5
vfs.zfs.version.spa 5000
vfs.zfs.version.acl 1
vfs.zfs.debug 0
vfs.zfs.super_owner 0
vfs.zfs.trim.enabled 1
vfs.zfs.trim.max_interval 1
vfs.zfs.trim.timeout 30
vfs.zfs.trim.txg_delay 32
When readin' the tuna=%e .a%uesD 0 means noD 1 t:ica%%: means :esD and an: other num=er reresents a
.a%ue. <o recei.e a =rie+ descrition o+ a s+sctl .a%ueD use s+sctl >d. $or e5am%eK
sysctl -d vfs.zfs.zio.use_uma
vfs.zfs.zio.use_uma: Use uma(9) for ZIO allocations
<he 0$" tuna=%es reEuire a +air understandin' o+ how 0$" wor)sD meanin' that :ou wi%% =e readin'
man a'es and searchin' +or the meanin' o+ acron:ms :ou are un+ami%iar with. Do %ot cha%#e a
t!%ableG$ 'al!e -itho!t re$earchi%# it *ir$t. I+ the tuna=%e ta)es a numeric .a%ue Arather than 0 +or no
or 1 +or :esBD do not ma)e one u. InsteadD research e5am%es o+ =ene+icia% .a%ues that match :our
wor)%oad.
FreeNAS 9.2.1 Users Guide Page 2%% of 280
I+ :ou decide to chan'e an: o+ the 0$" tuna=%esD continue to monitor the s:stem to determine the e++ect
o+ the chan'e. It is recommended that :ou test :our chan'es +irst at the command %ine usin' s+sctl. $or
e5am%eD to disa=%e re;+etch Ai.e. chan'e disa=%e to 1 or :esBK
sysctl vfs.zfs.prefetch_disable=1
vfs.zfs.prefetch_disable: 0 -> 1
<he outut wi%% indicate the o%d .a%ue +o%%owed =: the new .a%ue. I+ the chan'e is not =ene+icia%D chan'e
it =ac) to the ori'ina% .a%ue. I+ the chan'e turns out to =e =ene+icia%D :ou can ma)e it ermanent =:
creatin' a tuna=%e.
1$." A88
7(( is a uti%it: which ro.ides accurate and detai%ed measurements o+ dis) I@- er+ormance. <his
section ro.ides some usa'e e5am%es.
<:e the name o+ the command without an: otions to see its usa'eK
xdd
Usage: xdd command-line-options
-align [target <target#>] <#bytes>
-blocksize [target <target#>] <#bytes/block>
-combinedout <filename>
-createnewfiles [target <target#>]
-csvout <filename>
-datapattern [target <target#>] <c> |random|sequenced|ascii <asciistring>|hex
<hexdigits>|replicate
-delay #seconds
-deletefile [target <target#>]
-deskew
-devicefile
-dio [target <target#>]
-errout <filename>
-fullhelp
-heartbeat #
-id "string" | commandline
-kbytes [target <target#>] <#>
-lockstep <mastertarget#> <slavetarget#> <time|op|percent|mbytes|kbytes> # <time|
op|percent|mbytes|kbytes># <wait|run> <complete|stop>
-lockstepoverlapped
-maxall
-maxerrors #
-maxpri
-mbytes [target <target#>] <#>
-minall
-nobarrier
-nomemlock
-noproclock
-numreqs [target <target#>] <#>
-operation [target <target#>] read|write
-output <filename>
-passes #
-passoffset [target <target#>] <#blocks>
-preallocate [target <target#>] <#blocks>
-processlock
-processor target# processor#
FreeNAS 9.2.1 Users Guide Page 2%) of 280
-queuedepth #cmds
-qthreadinfo
-randomize [target <target#>]
-readafterwrite [target #] trigger <stat|mp> |lag <#> | reader <hostname>|port <#>
-reallyverbose
-recreatefiles [target <target#>]
-reopen [target <target#>]
-reportthreshold [target #] <#.#>
-reqsize [target <target#>] <#blocks>
-roundrobin # or 'all'
-runtime #seconds
-rwratio [target <target#>] <ratio>
-seek [target <target#>] save <filename> |load <filename> |disthist #buckets |
seekhist #buckets|sequential|random|range #blocks|stagger|interleave #blocks|seed #
| none
-setup filename
-sgio
-sharedmemory [target <target#>]
-singleproc #
-startdelay [target <target#>]#.#seconds
-startoffset [target <target#>] #
-starttime #seconds
-starttrigger <target#> <target#> <<time|op|percent|mbytes|kbytes> #>
-stoptrigger <target#> <target#> <<time|op|percent|mbytes|kbytes> #>
-syncio #
-syncwrite [target <target#>]
-target filename
-targetdir [target <target#>] <directory_name>
-targetoffset # -targets # filename filename filename... -or- -targets -# filename
-targetstartdelay #.#seconds
-throttle [target <target#>] <ops|bw|var> <#.#ops | #.#MB/sec | #.#var>
-timelimit [target <target#>] <#seconds>
-timerinfo
-timeserver <host hostname | port # | bounce #>
-ts [target <target#>] summary|detailed|wrap|oneshot|size #|append|output
<filename>|dump <filename>|triggertime <seconds>|triggerop <op#>
-verbose
-verify [target <target#>] location|contents
-version
Here is an e5am%e o+ a 0$" write testK
xdd op write targets 2 /mnt/tank/BIGFILE1 /mnt/tank/BIGFILE2 -blocksize 512 \
-reqsize 128 -mbytes 2048 verbose passes 3
<his test wi%% write seEuentia%%: +rom two e5istin' tar'et +i%esD 2mnt2tank2B8HF8;.1 and
2mnt2tank2B8HF8;.2. It starts at the =e'innin' o+ each +i%e usin' a +i5ed reEuest si8e o+ 126 =%oc)s with
*12 =:tes er =%oc) unti% it has read 20&6 M#D at which time it wi%% end the current ass and roceed to
the ne5t ass. It wi%% do this 3 times and dis%a: er+ormance in+ormation +or each ass. <he com=ined
er+ormance o+ =oth de.ices is ca%cu%ated and dis%a:ed at the end o+ the run. -nce the test is +inishedD
:ou can test the read er+ormance =: chan'in' the >o! to read.
Fou can a%so test read or write oerations on a seci+ied dis). Re%ace 2de#2ada0 with the de.ice name
+or the dis) :ou wish to test.
xdd op read targets 1 /dev/ada0 reqsize 128 -mbytes 64 passes 3 verbose
I+ :ou use the same switches o+tenD create a setu +i%e and re+er to it with the >setu! switch. $or
e5am%eD in a writa=%e %ocation Ae.'. .o%ume or datasetB create a (dd.set!* +i%e containin' this %ineK
reqsize 128 -mbytes 64 passes 3 verbose
Now :our command wou%d =eK
xdd op read targets 1 /dev/ada0 -setup xdd.setup
<o er+orm a random I@- test on the seci+ied dis)K
xdd op read targets 1 /dev/ada0 reqsize 8 -mbytes 16 passes 3 verbose seek \
random seek range 4000000
<his random I@- test wi%% read +rom the tar'et de.ice at some random %ocation usin' a +i5ed reEuest
si8e o+ 6 =%oc)s unti% it has read 1, M#. It wi%% do this 3 times and dis%a: er+ormance in+ormation +or
each ass. "ince this is a random I@- atternD the read reEuests are distri=uted o.er a ran'e o+ &D000D000
=%oc)s. <his is use+u% in constrainin' the area o.er which the random %ocations are chosen +rom. <he
same see) %ocations are used +or each ass in order to 'enerate reroduci=%e resu%ts. In +actD uon each
in.ocation o+ -dd usin' the same arametersD the same random %ocations are 'enerated each time. <his
a%%ows the user to chan'e the dis) or startin' o++set and o=ser.e the e++ects. <he random %ocations ma:
=e chan'ed +rom ass to ass within an -dd run =: usin' the >rando3i=e otion which 'enerates a new
set o+ %ocations +or each ass. <he random %ocations ma: =e chan'ed +rom run to run usin' the K$ee0
seed otion to seci+: a di++erent random num=er 'eneration seed .a%ue +or each in.ocation o+ -dd.
1$.% t0:cli
$reeNA"1 inc%udes the t0:cli command %ine uti%it: +or ro.idin' contro%%erD %o'ica% unitD and dri.e
mana'ement +or AMCC@3ware A<A RAI( Contro%%ers. <he suorted mode%s are %isted in the man
a'es +or the tweA&B and twaA&B dri.ers.
#e+ore usin' this commandD read its man a'e as it descri=es the termino%o': and ro.ides some usa'e
e5am%es.
I+ :ou t:e t0:cli in "he%%D the romt wi%% chan'eD indicatin' that :ou ha.e entered interacti.e mode
where :ou can run a%% sorts o+ maintenance commands on the contro%%er and its arra:s.
A%ternate%:D :ou can seci+: one command to run. $or e5am%eD to .iew the dis)s in the arra:K
tw_cli /c0 show
Unit UnitType Status %RCmpl %V/I/M Stripe Size(GB) Cache AVrfy
------------------------------------------------------------------------------
u0 RAID-6 OK - - 256K 5587.88 RiW ON
u1 SPARE OK - - - 931.505 - OFF
u2 RAID-10 OK - - 256K 1862.62 RiW ON
VPort Status Unit Size Type Phy Encl-Slot Model
------------------------------------------------------------------------------
p8 OK u0 931.51 GB SAS - /c0/e0/slt0 SEAGATE ST31000640SS
p17 OK u2 931.51 GB SATA - /c0/e0/slt9 ST31000340NS
Name OnlineState BBUReady Status Volt Temp Hours LastCapTest
---------------------------------------------------------------------------
bbu On Yes OK OK OK 212 03-Jan-2012
-rD to re.iew the e.ent %o'K
tw_cli /c0 show events
Ctl Date Severity AEN Message
------------------------------------------------------------------------------
c0 [Thu Feb 23 2012 14:01:15] INFO Battery charging started
c0 [Thu Feb 23 2012 14:03:02] INFO Battery charging completed
c0 [Sat Feb 25 2012 00:02:18] INFO Verify started: unit=0
c0 [Sat Feb 25 2012 00:02:18] INFO Verify started: unit=2,subunit=0
c0 [Sat Feb 25 2012 00:02:18] INFO Verify started: unit=2,subunit=1
c0 [Sat Feb 25 2012 03:49:35] INFO Verify completed: unit=2,subunit=0
c0 [Sat Feb 25 2012 03:51:39] INFO Verify completed: unit=2,subunit=1
c0 [Sat Feb 25 2012 21:55:59] INFO Verify completed: unit=0
c0 [Thu Mar 01 2012 13:51:09] INFO Battery health check started
c0 [Thu Mar 01 2012 13:51:09] INFO Battery health check completed
c0 [Thu Mar 01 2012 13:51:09] INFO Battery charging started
c0 [Thu Mar 01 2012 13:53:03] INFO Battery charging completed
c0 [Sat Mar 03 2012 00:01:24] INFO Verify started: unit=0
c0 [Sat Mar 03 2012 00:01:24] INFO Verify started: unit=2,subunit=0
c0 [Sat Mar 03 2012 04:04:27] INFO Verify completed: unit=2,subunit=0
c0 [Sat Mar 03 2012 16:22:05] INFO Verify completed: unit=0
c0 [Thu Mar 08 2012 13:41:39] INFO Battery charging started
c0 [Thu Mar 08 2012 13:43:42] INFO Battery charging completed
c0 [Sat Mar 10 2012 00:01:30] INFO Verify started: unit=0
c0 [Sat Mar 10 2012 15:58:15] INFO Verify completed: unit=0
I+ :ou add some dis)s to the arra: and the: are not showin' u in the 2!ID tr: runnin' the +o%%owin'
commandK
tw_cli /c0 rescan
!se the dri.es to create units and e5ort them to the oeratin' s:stem. When +inishedD run ca3control
rescan all and the: shou%d now =e a.ai%a=%e in the $reeNA"1 2!I.
<his +orum ost contains a hand: wraer scrit that wi%% noti+: :ou o+ errors.
1$.) 4ega'li
4ega'li is the command %ine inter+ace +or the 9"I Me'aRAI( "A" +ami%: o+ RAI( contro%%ers.
$reeNA"1 a%so inc%udes the m+iuti%A6B uti%it: which can =e used to con+i'ure and mana'e connected
stora'e de.ices.
<he 4ega'li command is Euite com%e5 with se.era% do8en otions. Whi%e it is +u%%: documented in
this &&2 a'e >($D the commands demonstrated in the 4mer'enc: Cheat "heet can 'et :ou started.
1$.8 freenas>de(ug
<he $reeNA"1 2!I ro.ides an otion to sa.e de=u''in' in+ormation to a te5t +i%e usin' ":stem N
"ettin's N Ad.anced N "a.e (e=u'. <his de=u''in' in+ormation is created =: the freenas>de(ug
command %ine uti%it: and a co: o+ the in+ormation is sa.ed to 2#ar2tm*2fnde$!g.
!sin' "he%%D :ou can run this command manua%%: to 'ather the seci+ic de=u''in' in+ormation that :ou
need. <o see the a.ai%a=%e otionsD t:eK
freenas-debug
usage: /usr/local/bin/freenas-debug <options>
Where options is:
-e A list of comma delimited list of email addresses to email the debug
log to.
-a Dump Active Directory Configuration
-c Dump (AD|LDAP) Cache
-g Dump GEOM configuration
-h Dump Hardware Configuration
-I Dump IPMI Configuration
-i Dump iSCSI Configuration
-l Dump LDAP Configuration
-T Loader Configuration Information
-n Dump Network Configuration
-N Dump NFS Configuration
-s Dump SSL Configuration
-y Dump Sysctl Configuration
-t Dump System Information
-z Dump ZFS configuration
Output will be saved to /var/tmp/fndebug
$or e5am%eD i+ :ou are trou=%eshootin' :our Acti.e (irector: con+i'urationD tr: the +o%%owin'
commands to 'enerate and .iew the de=u' +i%eK
freenas-debug -a
more /var/tmp/fndebug
1$.9 t3u-
tmu5 is a termina% mu%ti%e5er which ena=%es a num=er o+ termina%s to =e createdD accessedD and
contro%%ed +rom a sin'%e screen. tmu5 is an a%ternati.e to 2N! screen. "imi%ar to screenD tmu5 can =e
detached +rom a screen and continue runnin' in the =ac)'roundD then %ater reattached.
<o start a sessionD sim%: t:e t3u-. As seen in $i'ure 1&.9aD a new session with a sin'%e window wi%%
oen with a status %ine at the =ottom o+ the screen. <his %ine shows in+ormation on the current session
and is used to enter interacti.e commands.
Figure 1$.9a: t3u- Session
<o create a second windowD ress 'trl $ then I. <o c%ose a windowD t:e e-it within the window.
tmu5A1B %ists a%% o+ the )e: =indin's and commands +or interactin' with t3u- windows and sessions.
I+ :ou c%ose "he%% whi%e t3u- is runnin'D it wi%% detach its session. <he ne5t time :ou oen "he%%D run
t3u- attac to return to the re.ious session. <o %ea.e the t3u- session entire%:D t:e e-itR i+ :ou ha.e
mu%ti%e windows runnin'D :ou wi%% need to e-it out o+ each +irst.
1$.10 83idecode
(midecode reorts hardware in+ormation as reorted =: the s:stem #I-". (midecode does not scan
the hardwareD it on%: reorts what the #I-" to%d it to. A sam%e outut can =e seen here.
<o .iew the #I-" reortD t:e the command with no ar'umentsK
dmidecode | more
dmidecodeA6B descri=es the suorted strin's and t:es.
Section 4: Contributing to Free!S"
1" &o0 to Get In,ol,ed
As an oen source communit:D $reeNA"1 re%ies on the inut and e5ertise o+ its users to he% imro.e
$reeNA"1. When :ou ta)e some time to assist the communit:D :our contri=utions =ene+it e.er:one
who uses $reeNA"1.
<his section descri=es some areas o+ articiation to 'et :ou started. It is =: no means an e5hausti.e
%ist. I+ :ou ha.e an idea that :ou thin) wou%d =ene+it the $reeNA"1 communit:D =rin' it u on one o+
the resources mentioned in $reeNA"1 "uort Resources.
<his section demonstrates how :ou canK
Assist with 9oca%i8ation
<est !comin' 3ersions
1".1 Assist 0it <ocali=ation
$reeNA"1 uses >oot%eD an oen source a%icationD +or mana'in' the %oca%i8ation o+ the menu screens
used =: the $reeNA"1 'rahica% administrati.e inter+ace. >oot%e ma)es it eas: to +ind out the
%oca%i8ation status o+ :our nati.e %an'ua'e and to trans%ate the te5t +or an: menus that ha.e not =een
%oca%i8ed :et. #: ro.idin' a we= editor and commentin' s:stemD >oot%e a%%ows trans%ators to send
their time ma)in' and re.iewin' trans%ations rather than %earnin' how to use a trans%ation su=mission
too%.
<o see the status o+ a %oca%i8ationD oen oot%e.+reenas.or' in :our =rowserD as seen in $i'ure 1*.1aK
Figure 1".1a: FreeNAS <ocali=ation S+ste3
FreeNAS 9.2.1 Users Guide Page 2)# of 280
<he %oca%i8ations $reeNA"1 users ha.e reEuested are %isted a%ha=etica%%: on the %e+t. I+ :our %an'ua'e
is missin' and :ou wou%d %i)e to he% in its trans%ationD send an emai% to the trans%ations mai%in' %ist so
it can =e added.
<he 'reen =ar in the -.era%% Com%etion co%umn indicates the ercenta'e o+ $reeNA"1 menus that
ha.e =een %oca%i8ed. I+ a %an'ua'e is not at 100LD it means that the menus that current%: are not
trans%ated wi%% aear in 4n'%ish instead o+ in that %an'ua'e.
I+ :ou wish to he% %oca%i8e :our %an'ua'eD :ou shou%d +irst Ioin the trans%ations mai%in' %ist and
introduce :ourse%+ and which %an'ua'eAsB :ou can assist with. <his wi%% a%%ow :ou to meet other
.o%unteers as we%% as )ee a=reast o+ an: notices or udates that ma: e++ect the trans%ations. Fou wi%%
a%so need to c%ic) on the Re'ister %in) in order to create a >oot%e %o'in account.
<he +irst time :ou %o' into the $reeNA"1 >oot%e inter+aceD :ou wi%% =e romted to se%ect :our
%an'ua'e so that :ou can access that %an'ua'e's trans%ation whene.er :ou %o'in. A%ternate%:D :ou can
c%ic) the Home %in) to see the status o+ a%% o+ the %an'ua'es. <o wor) on a trans%ationD c%ic) the %in) +or
the %an'ua'e N c%ic) the $reeNA"1 %in) +or the roIect N c%ic) the %in) +or 9CGM4""A24" N and
c%ic) the %in) +or dIan'o.o. 4.er: te5t %ine a.ai%a=%e in the 2!I menu screens has =een assi'ned a
strin' num=er. I+ :ou c%ic) the num=erD an editor wi%% oen where :ou can trans%ate the te5t. In the
e5am%e shown in $i'ure 1*.1=D a user has se%ected strin' num=er &, in the 2erman trans%ationR the
other strin's in the screenshot ha.e a%read: =een trans%atedK
Figure 1".1(: Using te Pootle Interface to 7dit a *ranslation String
"im%: t:e in the trans%ated te5t and c%ic) the "u=mit =utton to sa.e :our chan'e.
FreeNAS 9.2.1 Users Guide Page 2)$ of 280
1".2 *est an U!co3ing ?ersion
>rior to an: re%easeD there is a =eta eriod where testin' snashots wi%% =e announced on the $reeNA"1
we=site and socia% media sites. <his =eta eriod is meant to ro.ide users an oortunit: to test the
ucomin' re%ease and to ro.ide +eed=ac) on =u's and errors so that the: can =e +i5ed rior to re%ease.
$eed=ac) can =e sent to the $reenas;testin' mai%in' %ist or a =u' reort can =e su=mitted.
1".2.1 2olling Tour 60n *esting Sna!sot
!sers who wish to create their own custom I"- +or testin' uroses can down%oad and comi%e the
%atest $reeNA"1 source +rom the 'ithu= reositor:.
In order to =ui%d :our own testin' snashotD :ou wi%% need to insta%% $ree#"( 9.2 in a .irtua%
en.ironment or on a test s:stem. I+ :ou are usin' a .irtua% en.ironmentD a ,&;=it s:stem with at %east &
2# o+ RAM is recommended. (own%oad and insta%% the $ree#"( .ersion Ai36, or amd,&B that matches
the architecture that :ou wish to =ui%d.
A+ter =ootin' into the new%: insta%%ed $ree#"( s:stemD =ecome the sueruser At:e su and enter the
root user's asswordB and run the +o%%owin' commands. $irstD insta%% the so+tware :ou'%% need and
re+resh :our ath so it is aware o+ the new =inariesK
pkg_add -r git-subversion
pkg_add -r cdrtools
pkg_add -r python27
pkg_add -r pbi-manager
rehash
Chan'e to the director: where :ou wou%d %i)e to store the $reeNA"1 sourceD down%oad the sourceD
then chan'e to the director: containin' the down%oaded sourceK
cd /usr/local
git clone --depth 1 git://github.com/freenas/freenas.git
cd freenas
Fou are now read: to =ui%d the ima'e usin' the instructions in this R4A(M4.
1% Using te FreeNAS API
$reeNA"1 ro.ides a re"< A>I which can =e used as an a%ternate mechanism +or remote%: contro%%in'
a $reeNA"1 s:stem.
re"tructured<e5t is an eas:;to;readD %i'htwei'ht mar)u %an'ua'e that ro.ides an H<<>
im%ementation o+ +unctionsD )nown as resourcesD which are a.ai%a=%e =eneath a seci+ied =ase !R9.
4ach resource is maniu%ated usin' H<<> methods such as 24<D >!<D >-"<D or (494<4.
<his section demonstrates how to insta%% the necessar: so+tware to =ui%d a %oca% co: o+ the re+erence
documentation +or the $reeNA"1 A>Is. It then wa%)s throu'h some code e5am%es to 'et :ou started
usin' the A>Is.
FreeNAS 9.2.1 Users Guide Page 2)" of 280
1%.1 5uilding a <ocal 'o!+ of te APIs
I+ :ou %an to use the A>IsD it is recommended that :ou =ui%d a %oca% H<M9 co: o+ the A>I
documentation so that :ou can easi%: determine which resources are a.ai%a=%e and %earn more a=out
how each resource wor)s. <his section demonstrates how to insta%% the so+tware and source needed to
=ui%d the documentation usin' a $ree#"( 9.2 s:stem. !sers o+ other oeratin' s:stems wi%% need to
+ind and insta%% the eEui.a%ent ac)a'es +or their oeratin' s:stem.
-n a $ree#"( s:stemD %o'in as root and insta%% the necessar: so+twareK
pkg_add -r git
pkg_add -r py-oauth2
pkg_add -r py-sphinxcontrib-httpdomain
rehash
<hose commands insta%% the =inar: ac)a'es and add the new =inaries to the user's ath. I+ a ac)a'e is
not a.ai%a=%eD comi%e the ort instead.
Ne5tD down%oad a %oca% co: o+ the $reeNA"1 source code +rom 'ithu=. Run this command in the
director: which wi%% store the %oca% co:K
cd /usr/local
git clone --depth 1 git://github.com/freenas/freenas.git
<his wi%% create a su=director: ca%%ed freenas which contains the c%oned source. -nce the s:stem has a
%oca% co:D it can =e udated as needed =: runnin' this command within freenasK
git pull
<o =ui%d a %oca% co: o+ the A>I re+erence documentationK
cd freenas/docs/api
make html
>oint a we= =rowser to 2!sr2lo'al2freenas2do's2a*i2,$!ild2html2inde(.html to .iew the documentation.
As seen in the e5am%e in $i'ure 1,.1aD the resources are %aid out in an order that is simi%ar to the tree
menu o+ the $reeNA"1 2!I.
FreeNAS 9.2.1 Users Guide Page 2)% of 280
Figure 1%.1a: FreeNAS API 8ocu3entation
1%.2 A Si3!le API 7-a3!le
<he freenas2e(am*les2a*i2 director: contains some A>I usa'e e5am%es. <his section ro.ides a wa%);
throu'h o+ the freenas2e(am*les2a*i2ne:!ser.*y scritD shown =e%owD as it ro.ides a sim%e e5am%e
that creates a user.
In order to create a customi8ed scrit =ased on this e5am%eD :ou wi%% need a runnin' $reeNA"1 9.2.0
s:stem. I+ :ou wou%d %i)e to test the scrits direct%: on the $reeNA"1 s:stemD create a user account.
When creatin' this user accountD se%ect an e5istin' .o%ume or dataset +or the user's MHome (irector:M.
-nce the user is createdD start the ""H ser.ice usin' "er.ices N Contro% "er.ices. <hat user wi%% now
=e a=%e to ss to the I> address o+ the $reeNA"1 s:stem in order to create and run scrits. A%ternate%:D
:ou can test :our scrits on an: s:stem that has the so+tware mentioned in the re.ious section
insta%%ed.
<o customi8e this scritD co: the contents o+ this e5am%e into a +i%ename that ends in .*y. <he te5t that
is hi'h%i'hted in red =e%ow shou%d =e modi+ied in :our co: in order to match the needs o+ the user
FreeNAS 9.2.1 Users Guide Page 2)) of 280
=ein' created. <he te5t in =%ac) shou%d remain as;is. A+ter sa.in' :our chan'esD run the scrit =: t:in'
!+ton scri!tna3e.!+. I+ a%% 'oes we%%D the new user account wi%% aear in Account N !sers N 3iew
!sers in the $reeNA"1 2!I.
Here is the e5am%e scrit with %ine num=ers. (o %ot inc%ude the %ine num=ers in :our scrit. InsteadD
re+er to the %ine num=ers in the e5%anation =e%ow.
1: import json
2: import requests
3: r = requests.post(
4: 'https://freenas.mydomain/api/v1.0/account/users/',
5: auth=('root', 'freenas'),
6: headers={'Content-Type': 'application/json'},
7: verify=False,
8: data=json.dumps({
9: 'bsdusr_uid': '1100',
10: 'bsdusr_username': 'myuser',
11: 'bsdusr_mode': '755',
12: 'bsdusr_creategroup': 'True',
13: 'bsdusr_password': '12345',
14: 'bsdusr_shell': '/usr/local/bin/bash',
15: 'bsdusr_full_name': 'Full Name',
16: 'bsdusr_email': 'name@provider.com',
17: })
18: )
19: print r.text
WhereK
<ines 1>2: imort the >:thon modu%es used to ma)e H<<> reEuests and hand%e data in C"-N +ormat.
<ine $: re%ace freenas.mydomain with the MHostnameM .a%ue in ":stem N ":stem In+ormation. Note
that :our scrit wi%% +ai% i+ the machine runnin' the scrit is not a=%e to reso%.e that hostname. I+ :ou are
not usin' H<<>" to access the $reeNA"1 s:stemD chan'e htt*s to htt*.
<ine ": re%ace freenas with the assword that :ou use to access the $reeNA"1 s:stem.
<ine ): i+ :ou are usin' H<<>" and want to +orce .a%idation o+ the ""9 certi+icateD chan'e False to
?r!e.
<ines 8>1%: sets the .a%ues +or the user =ein' created. <he M!sersM resourceD +ound in
freenas2do's2a*i2,$!ild2html2reso!r'es2a''o!nt.htmlQ!sersD descri=es this resource in more detai%. <he
a%%owed arameters are %isted in the MCson >arametersM section o+ that resource. "ince this resource
creates a $ree#"( userD the .a%ues that :ou inut must =e .a%id +or a $ree#"( user account. <a=%e
1,.2a summari8es the .a%id .a%ues. "ince this resource is usin' C"-ND the ossi=%e =oo%ean .a%ues are
?r!e or False.
*a(le 1%.2a: ?alid IS6N Para3eters for Users 'reate 2esource
IS6N Para3eter *+!e 8escri!tion
=sdusrGusername strin'
ma5imum 32 charactersD thou'h a ma5imum o+ 6 is recommended +or
interoera=i%it:R can inc%ude numera%s =ut can not inc%ude a sace
=sdusrG+u%%Gname strin' ma: contain saces and uercase characters
=sdusrGassword strin' can inc%ude a mi5 o+ uer and %owercase %ettersD charactersD and
IS6N Para3eter *+!e 8escri!tion
num=ers
=sdusrGuid inte'er
=: con.entionD user accounts ha.e an I( 'reater than 1000 with a
ma5imum a%%owa=%e .a%ue o+ ,*D*3*
=sdusrG'rou inte'er
i+ $sd!sr,'reategro!* is set to FalseD seci+: the numeric I( o+ the
'rou to create
=sdusrGcreate'rou =oo%ean
i+ set to ?r!eD a rimar: 'rou with the same numeric I( as $sd!sr,!id
wi%% =e automatica%%: created
=sdusrGmode strin' sets de+au%t numeric !NI7 ermissions o+ user's home director:
=sdusrGshe%% strin' seci+: +u%% ath to a !NI7 she%% that is insta%%ed on the s:stem
=sdusrGasswordGd
isa=%ed
=oo%ean i+ set to ?r!eD user is not a%%owed to %o'in
=sdusrG%oc)ed =oo%ean i+ set to ?r!eD user is not a%%owed to %o'in
=sdusrGsudo =oo%ean i+ set to ?r!eD sudo is ena=%ed +or the user
N6*7: when usin' =oo%ean .a%uesD C"-N returns raw %owercase .a%ues whereas >:thon uses
uercase .a%ues. <his means that :ou shou%d use ?r!e or False in :our >:thon scrits e.en thou'h the
e5am%e C"-N resonses in the A>I documentation are dis%a:ed as tr!e or false.
1%.# A 4ore 'o3!le- 7-a3!le
<his section ro.ides a wa%);throu'h o+ a more com%e5 e5am%e +ound in the
freenas2e(am*les2a*i2start!*.*y scrit. !se the search=ar within the A>I documentation to Euic)%:
%ocate the C"-N arameters used in this e5am%e. <his e5am%e de+ines a c%ass and se.era% methods
which are used to create a 0$" .o%umeD create a 0$" datasetD share this dataset o.er CI$"D and ena=%e
the CI$" ser.ice. <he resonses +rom some methods are used as arameters in other methods. In
addition to the imort %ines seen in the re.ious e5am%eD this e5am%e imorts two additiona% >:thon
modu%es to ro.ide arsin' +unctions +or command %ine ar'umentsK
import argparse
import sys
It then creates a Start!* c%ass which is started with the hostnameD usernameD and assword ro.ided =:
the user .ia the command %ineK
class Startup(object):
def __init__(self, hostname, user, secret):
self._hostname = hostname
self._user = user
self._secret = secret
self._ep = 'http://%s/api/v1.0' % hostname
def request(self, resource, method='GET', data=None):
if data is None:
data =
r = requests.request(
method,
'%s/%s/' % (self._ep, resource),
data=json.dumps(data),
headers={'Content-Type': "application/json"},
auth=(self._user, self._secret),
)
if r.ok:
try:
return r.json()
except:
return r.text
raise ValueError(r)
A ,get,disks method is de+ined to 'et a%% the dis)s in the s:stem as a disk,name resonse. <he
'reate,*ool method wi%% then use this in+ormation to create a 0$" oo% named tank which wi%% =e
created as a strie. <he #ol!me,name and layo!t C"-N arameters are descri=ed in the "tora'e 3o%ume
resource o+ the A>I documentation.
def _get_disks(self):
disks = self.request('storage/disk')
return [disk['disk_name'] for disk in disks]
def create_pool(self):
disks = self._get_disks()
self.request('storage/volume', method='POST', data={
'volume_name': 'tank',
'layout': [
{'vdevtype': 'stripe', 'disks': disks},
],
})
<he 'reate,dataset method is de+ined which creates a dataset named <yShareK
def create_dataset(self):
self.request('storage/volume/tank/datasets', method='POST', data={
'name': 'MyShare',
})
<he 'reate,'ifs,share method is used to share 2mnt2tank2<yShare with 'uest;on%: access ena=%ed. <he
'ifs,nameD 'ifs,*athD 'ifs,g!estonly C"-N arametersD as we%% as the other a%%owa=%e arametersD are
descri=ed in the "harin' CI$" resource o+ the A>I documentation.
def create_cifs_share(self):
self.request('sharing/cifs', method='POST', data={
'cifs_name': 'My Test Share',
'cifs_path': '/mnt/tank/MyShare',
'cifs_guestonly': True
})
$ina%%:D the ser#i'e,start method issues a command to ena=%e the CI$" ser.ice. <he sr#,ena$le C"-N
arameter is descri=ed in the "er.ices "er.ices resource.
def service_start(self, name):
self.request('services/services/%s' % name, method='PUT', data={
'srv_enable': True,
})

Freenas 9.2.1 Setup Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Freenas 9.2.1 Setup Guide

Uploaded by

Copyright:

Available Formats

FreeNAS is 2011-2014 iXsystems

FreeNAS and the FreeNAS logo are registered trademarks of iXsystems.

You might also like