Freenas9.1.1 Guide

FreeNAS is 2011-2013 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.1.1 Users Guide
Page 2 of 276
Table of Contents
Section 1: Introduction and Installation
1 Introduction........................................................................................................................................9 1.1 What's New in 9.1.1..................................................................................................................10 1.2 Known Issues............................................................................................................................10 1.3 Hardware Recommendations....................................................................................................11 1.3.1 Architecture.......................................................................................................................11 1.3.2 RAM..................................................................................................................................11 1.3.3 Com act or !"# $%ash.....................................................................................................12 1.3.& "tora'e (is)s and Contro%%ers..........................................................................................12 1.3.* Networ) Inter+aces............................................................................................................13 1.3., RAI( -.er.iew................................................................................................................1& 1.3./ 0$" -.er.iew...................................................................................................................1, 2 Insta%%in' and ! 'radin' $reeNA"1...............................................................................................12 2.1 3ettin' $reeNA"1...................................................................................................................12 2.2 $reeNA"1 in a 4irtua% 5n.ironment.......................................................................................19 2.2.1 4irtua%#o6.........................................................................................................................19 2.2.1.1 Creatin' the 4irtua% Machine......................................................................................19 2.2.1.2 Creatin' (e.ices +or "tora'e and Insta%%ation Media.................................................2& 2.2.1.3 Con+i'urin' the #rid'ed Ada ter............................................................................... 2, 2.2.1.& Runnin' $reeNA"1 +rom a !"# Ima'e....................................................................2/ 2.2.2 4MWare 5"7i..................................................................................................................22 2.3 Insta%%in' +rom C(R-M...........................................................................................................33 2.& #urnin' an IM3 $i%e................................................................................................................3, 2.&.1 !sin' 68cat and dd on a $ree#"( or 9inu6 ":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.............................................................3/ 2.&.& <rou=%eshootin'................................................................................................................32 2.* Initia% "etu ...............................................................................................................................39 2., ! 'radin' $reeNA"1 ............................................................................................................&1 2.,.1 >re arin' +or the ! 'rade.................................................................................................&2 2.,.2 !sin' the I"- to ! 'rade.................................................................................................&2 2.,.3 !sin' the 3!I to ! 'rade ...............................................................................................&& 2.,.& !n%oc)in' an 5ncr: ted 4o%ume......................................................................................&, 2.,.* I+ "omethin' 3oes Wron'................................................................................................&, 2.,., ! 'radin' a 0$" >oo%......................................................................................................&/
Section 2: Using t e Gra! ical Interface

3 ?uic) "tart 3uide and Account Con+i'uration................................................................................&9 3.1 ?uic) "tart 3uide.....................................................................................................................&9 3.1.1 "et Administrati.e Access.................................................................................................&9 3.1.2 "et the Administrati.e 5mai% Address..............................................................................&9 3.1.3 5na=%e Conso%e 9o''in'...................................................................................................&9 3.1.& Con+i'ure "tora'e.............................................................................................................*0 3.1.* Create !sers@3rou s or Inte'rate with A(@9(A>...........................................................*0 3.1., Con+i'ure >ermissions......................................................................................................*1 3.1./ Con+i'ure "harin'.............................................................................................................*1 FreeNAS 9.1.1 Users Guide Page " of 276
3.1.2 "tart A %ica=%e "er.iceAsB...............................................................................................*1 3.1.9 <est Con+i'uration +rom C%ient.........................................................................................*2 3.1.10 #ac)u the Con+i'uration...............................................................................................*2 3.2 Account Con+i'uration .............................................................................................................*2 3.2.1 Admin Account.................................................................................................................*2 3.2.2 3rou s...............................................................................................................................*3 3.2.3 !sers.................................................................................................................................*, & ":stem Con+i'uration.......................................................................................................................*9 &.1 Cron Co=s..................................................................................................................................,0 &.2 Init@"hutdown "cri ts...............................................................................................................,1 &.3 N<> "er.ers..............................................................................................................................,2 &.& Re ortin'..................................................................................................................................,& &.* Rs:nc <as)s..............................................................................................................................,* &.*.1 Creatin' an Rs:nc <as).....................................................................................................,* &.*.2 Con+i'urin' Rs:nc Modu%e Mode #etween <wo $reeNA"1 ":stems............................,/ &.*.3 Con+i'urin' Rs:nc o.er ""H Mode #etween <wo $reeNA"1 ":stems........................./0 &., ".M.A.R.<. <ests......................................................................................................................./2 &./ "ettin's...................................................................................................................................../& &./.1 3enera% <a=......................................................................................................................./& &./.2 Ad.anced <a=.................................................................................................................../, &./.2.1 Autotune....................................................................................................................../2 &./.3 5mai% <a=........................................................................................................................../9 &./.& ""9 <a=.............................................................................................................................20 &.2 ":sct%s.......................................................................................................................................21 &.9 ":stem In+ormation..................................................................................................................22 &.10 <una=%es..................................................................................................................................23 &.10.1 Reco.erin' $rom Incorrect <una=%es..............................................................................2* * Networ) Con+i'uration.....................................................................................................................2, *.1 3%o=a% Con+i'uration................................................................................................................2, *.2 Inter+aces...................................................................................................................................2/ *.3 9in) A''re'ations....................................................................................................................29 *.3.1 Considerations When !sin' 9AC>D M>I-D N$"D or 5"7i .............................................90 *.3.2 Creatin' a 9in) A''re'ation ............................................................................................90 *.& Networ) "ummar:....................................................................................................................9& *.* "tatic Routes.............................................................................................................................9& *., 49ANs......................................................................................................................................9& , "tora'e Con+i'uration......................................................................................................................9, ,.1 >eriodic "na shot <as)s...........................................................................................................9, ,.1.1 Creatin' a >eriodic "na shot <as)....................................................................................9, ,.1.2 Mana'in' >eriodic "na shot <as)s..................................................................................92 ,.2 Re %ication <as)s....................................................................................................................100 ,.2.1 Con+i'ure >!99.............................................................................................................101 ,.2.2 Con+i'ure >!"H.............................................................................................................101 ,.2.3 <rou=%eshootin' Re %ication...........................................................................................10& ,.3 4o%umes..................................................................................................................................10* ,.3.1 Auto Im ortin' 4o%umes.................................................................................................10* ,.3.1.1 Auto Im ortin' a 359I;5ncr: ted 0$" >oo%...........................................................10/ FreeNAS 9.1.1 Users Guide Page # of 276
,.3.2 Im ortin' 4o%umes..........................................................................................................10/ ,.3.3 !$" 4o%ume Mana'er.....................................................................................................102 ,.3.& 0$" 4o%ume Mana'er.....................................................................................................110 ,.3.&.1 5ncr: tion.................................................................................................................111 ,.3.&.2 Creatin' an 5ncr: ted 4o%ume................................................................................. 112 ,.3.* 56tendin' a 0$" 4o%ume................................................................................................113 ,.3., Creatin' 0$" (atasets....................................................................................................11& ,.3.,.1 (edu %ication............................................................................................................11, ,.3.,.2 Com ression............................................................................................................. 11, ,.3./ Creatin' a 8.o%................................................................................................................11/ ,.3.2 4iewin' (is)s.................................................................................................................112 ,.3.9 4iewin' 4o%umes............................................................................................................112 ,.3.9.1 Ke: Mana'ement +or 5ncr: ted 4o%umes................................................................122 ,.3.10 "ettin' >ermissions.......................................................................................................12& ,.3.11 4iewin' Mu%ti aths.......................................................................................................12* ,.3.12 Re %acin' a $ai%ed (ri.e or ""(..................................................................................12, ,.3.13 Re %acin' (ri.es to 3row a 0$" >oo%.........................................................................12/ ,.3.13.1 5na=%in' 0$" >oo% 56 ansion A+ter (ri.e Re %acement.......................................122 ,.3.1& " %ittin' a Mirrored 0$" "tora'e >oo%.........................................................................129 ,.& 0$" "cru=s.............................................................................................................................131 / "harin' Con+i'uration....................................................................................................................132 /.1 A %e AA$>B "hares................................................................................................................133 /.1.1 Creatin' A$> "hares.......................................................................................................133 /.1.2 Connectin' to A$> "hares As 3uest...............................................................................13, /.1.3 !sin' <ime Machine.......................................................................................................132 /.2 !ni6 AN$"B "hares..................................................................................................................1&0 /.2.1 Creatin' N$" "hares.......................................................................................................1&1 /.2.2 "am %e N$" "hare Con+i'uration...................................................................................1&3 /.2.3 Connectin' to the N$" "hare..........................................................................................1&3 /.2.3.1 $rom #"( or 9inu6 C%ients......................................................................................1&3 /.2.3.2 $rom Microso+t C%ients.............................................................................................1&& /.2.3.3 $rom Mac -" 7 C%ients...........................................................................................1&* /.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&9 /.3.3 Con+i'urin' 9oca% !ser Access......................................................................................1*2 /.3.& Con+i'urin' "hadow Co ies...........................................................................................1*& /.3.&.1 >rereEuisites..............................................................................................................1*& /.3.&.2 Con+i'uration 56am %e.............................................................................................1*& 2 "er.ices Con+i'uration...................................................................................................................1*, 2.1 Contro% "er.ices......................................................................................................................1*/ 2.2 A$>.........................................................................................................................................1*2 2.2.1 <rou=%eshootin'..............................................................................................................1*9 2.3 CI$"........................................................................................................................................1*9 2.3.1 <rou=%eshootin' <i s......................................................................................................1,2 2.& (irector: "er.ices..................................................................................................................1,3 FreeNAS 9.1.1 Users Guide Page $ of 276
2.&.1 Acti.e (irector:..............................................................................................................1,3 2.&.1.1 <rou=%eshootin' <i s................................................................................................ 1,, 2.&.2 9(A>..............................................................................................................................1,, 2.&.3 NI"..................................................................................................................................1,2 2.&.& N<&.................................................................................................................................1,9 2.* (:namic (N".........................................................................................................................1/0 2., $<>.........................................................................................................................................1/2 2.,.1 $<> Con+i'uration - tions.............................................................................................1/2 2.,.2 Anon:mous $<>.............................................................................................................1/& 2.,.3 " eci+ied !ser Access in chroot.....................................................................................1/* 2.,.& 5ncr: tin' $<>...............................................................................................................1/, 2.,.* <rou=%eshootin'..............................................................................................................1/, 2./ i"C"I.......................................................................................................................................1// 2./.1 Authori8ed Accesses.......................................................................................................1/2 2./.2 56tents.............................................................................................................................120 2./.2.1Addin' an 56tent...............................................................................................................120 2./.3 Initiators..........................................................................................................................122 2./.& >orta%s.............................................................................................................................123 2./.* <ar'et 3%o=a% Con+i'uration..........................................................................................12* 2./., <ar'ets.............................................................................................................................122 2././ <ar'et@56tents.................................................................................................................129 2./.2 Connectin' to i"C"I "hare.............................................................................................190 2./.9 3rowin' 9!Ns................................................................................................................190 2./.9.1 0.o% #ased 9!N.......................................................................................................191 2./.9.2 $i%e 56tent #ased 9!N.............................................................................................191 2.2 N$".........................................................................................................................................191 2.9 Rs:nc......................................................................................................................................192 2.9.1 Rs:nc Modu%es................................................................................................................193 2.10 ".M.A.R.<.............................................................................................................................19* 2.11 "NM>....................................................................................................................................19, 2.12 ""H.......................................................................................................................................19/ 2.12.1 ""H Con+i'uration "creen............................................................................................19/ 2.12.2 Chrootin' Command 9ine "$<> !sers .......................................................................199 2.12.3 <rou=%eshootin' ""H Connections...............................................................................201 2.13 <$<>.....................................................................................................................................201 2.1& !>".......................................................................................................................................202 9 >%u'ins............................................................................................................................................20& 9.1 Insta%%in' a $reeNA"1 >#I !sin' >%u'ins............................................................................20& 9.2 -++icia% $reeNA"1 >#Is........................................................................................................20, 9.2.1 $ire+%:..............................................................................................................................20/ 9.2.2 Mini(9NA......................................................................................................................209 9.2.3 <ransmission...................................................................................................................211 10 Cai%s...............................................................................................................................................213 10.1 Mi'ratin' an 2.6 Cai%.............................................................................................................21& 10.2 Cai%s Con+i'uration................................................................................................................21* 10.3 Addin' Cai%s..........................................................................................................................21, 10.3.1 Con+i'urin' Cai%s...........................................................................................................212 FreeNAS 9.1.1 Users Guide Page 6 of 276
10.3.1.1 5dit a Cai%'s "ettin's.............................................................................................. 219 10.3.1.2 Addin' "tora'e..................................................................................................... 221 10.3.2 Accessin' the Command 9ine o+ a Cai%.........................................................................222 10.& Insta%%in' $reeNA"1 >#Is ..................................................................................................223 10.* Insta%%in' a >C;#"( >#I .....................................................................................................22* 10.*.1 $indin' >C;#"( >#Is..................................................................................................22, 10.*.2 Insta%%in' a >C;#"( >#I..............................................................................................22/ 10., Insta%%in' non;>#I "o+tware ................................................................................................22/ 10.,.1 Insta%%in' $ree#"( >ac)a'es with )'n'.....................................................................222 10.,.2 Com i%in' $ree#"( >orts with ma)e...........................................................................230 10.,.3 Con+i'urin' and "tartin' Insta%%ed $ree#"( "o+tware................................................232 10./ Creatin' Four own >#Is ......................................................................................................23& 10./.1 Introduction to the >#I Architecture.............................................................................23& 10./.2 !sin' 5as:>#I to Create a >C;#"( >#I.....................................................................23* 10./.3 -.er.iew o+ the >%u'ins Architecture...........................................................................23, 10./.& !sin' 5as:>#I to Create a $reeNA"1 >#I.................................................................239 10./.&.1 5dit =i.con+......................................................................................................... 239 10./.&.2 Add twea);rccon+..................................................................................................2&1 10./.&.3 Create contro%........................................................................................................2&2 10./.&.& #ui%d and <est the >#I..........................................................................................2&3 11 Additiona% - tions.......................................................................................................................2&* 11.1 (is %a: ":stem >rocesses.....................................................................................................2&* 11.2 "he%%......................................................................................................................................2&* 11.3 Re=oot...................................................................................................................................2&/ 11.& "hutdown..............................................................................................................................2&/ 11.* He% .......................................................................................................................................2&2 11., 9o' -ut.................................................................................................................................2&2 11./ A%ert......................................................................................................................................2&9
Section ": Getting %el!

12 $reeNA"1 "u ort Resources.....................................................................................................2&9 12.1 We=site and "ocia% Media.....................................................................................................2*0 12.2 $orums..................................................................................................................................2*0 12.3 "u ort (ata=ase..................................................................................................................2*2 12.& IRC........................................................................................................................................2*3 12.* Mai%in' 9ists.........................................................................................................................2*3 12., >ro+essiona% "u ort.............................................................................................................2*& 13 !se+u% Command 9ine !ti%ities...................................................................................................2*& 13.1 I er+......................................................................................................................................2** 13.2 Net er+..................................................................................................................................2*2 13.3 I-8one...................................................................................................................................2*9 13.& arcstat....................................................................................................................................2,1 13.&.1 !sin' the "cri ts...........................................................................................................2,2 13.* 7((......................................................................................................................................2,/ 13., twGc%i....................................................................................................................................2,9 13./ Me'aC%i................................................................................................................................2/0 13.2 I>MItoo%................................................................................................................................2/1 FreeNAS 9.1.1 Users Guide Page 7 of 276
13.9 +reenas;de=u'........................................................................................................................2/1 13.10 tmu6....................................................................................................................................2/2 13.11 (midecode..........................................................................................................................2/2
Section #: &ontri'uting to FreeNAS

1& How to 3et In.o%.ed....................................................................................................................2/3 1&.1 Assist with 9oca%i8ation .......................................................................................................2/3 1&.2 <est an ! comin' 4ersion....................................................................................................2/* 1&.2.1 <estin' a Ni'ht%: "na shot...........................................................................................2/* 1&.2.2 Ro%%in' Four -wn <estin' "na shot.............................................................................2/*
Section 1: Introduction and Installation

Preface
Written =: users o+ the $reeNA"1 networ);attached stora'e o eratin' s:stem. 4ersion 9.1.1 >u=%ished Au'ust 2,D 2013 Co :ri'ht H 2011;2013 i7s:stems. <his 3uide co.ers the insta%%ation and use o+ $reeNA"1 9.1.1. I+ :ou are runnin' a .ersion o+ $reeNA"1 that is ear%ier than $reeNA"1 9.1.1D it is recommended that :ou u 'rade to or insta%% $reeNA"1 9.1.1. <his .ersion +i6es man: =u's +rom re.ious .ersions and se.era% +eatures mentioned in this 3uide were not a.ai%a=%e in ear%ier .ersions o+ $reeNA"1. <he $reeNA"1 !sers 3uide 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 im ro.e the 3uideD .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 3uide 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 ada t the wor) as %on' as :ou attri=ute i7s:stems as the ori'ina% source o+ the 3uide. $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 Cor oration. Acti.e (irector:1 is a re'istered trademar) or trademar) o+ Microso+t Cor oration 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.
Page ( of 276
$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% Cor oration in the !.". and@or other countries. 9in)edIn1 is a re'istered trademar) o+ 9in)edIn Cor oration. 9inu61 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 3rou . 4irtua%#o61 is a re'istered trademar) o+ -rac%e. 4MWare1 is a re'istered trademar) o+ 4MWareD Inc. Wi)i edia1 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 Cor oration in the !nited "tates and other countries.
)*!ogra! ic &on+entions
<he $reeNA"1 9.1.1 !sers 3uide uses the +o%%owin' t: o'ra hic con.entionsK 'old te,t: re resents a command written at the command %ine. In usa'e e6am %esD the +ont is chan'ed to Courier 10 with an: command out ut dis %a:ed in un=o%ded te6t. itali' te(t) used to re resent de.ice namesD +i%e name athsD or te6t that is in ut into a 3!I +ie%d. bold italic text: used to em hasi8e an im ortant oint.
Introduction
$reeNA"1 is an em=edded o en source networ);attached stora'e ANA"B s:stem =ased on $ree#"( and re%eased under a #"( %icense. A NA" ro.ides an o eratin' s:stem that has =een o timi8ed +or +i%e stora'e and sharin'. Nota=%e +eatures in $reeNA"1 inc%udeK su su orts A$>D CI$"D $<>D N$"D ""H Ainc%udin' "$<>BD and <$<> as +i%e sharin' mechanisms orts e6 ortin' +i%e or de.ice e6tents .ia i"C"I
su orts Acti.e (irector: or 9(A> +or user authentication as we%% as manua% user and 'rou creation su orts the creation and im ort o+ !$"2 =ased .o%umesD inc%udin' 'mirrorD 'stri eD and 'raid3 su orts the creation and im ort o+ 0$" oo%sD ena=%in' man: +eatures not a.ai%a=%e in !$"2 such as EuotasD sna shotsD com ressionD re %icationD and datasets +or sharin' su=sets o+ .o%umes u 'rade rocedure sa.es the current o eratin' s:stem to an inacti.e artitionD a%%owin' +or an FreeNAS 9.1.1 Users Guide Page 9 of 276
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 'ra hica% user inter+ace a.ai%a=%e throu'h a we= =rowser secure re %icationD automatic 0$" sna shotsD schedu%in' o+ 0$" scru=sD and cron mana'ement are a%% con+i'ura=%e throu'h the 'ra hica% inter+ace su ort +or menu %oca%i8ation and )e:=oard %a:outs ort "MAR< monitorin' and !>" mana'ement in 3!I !"# 3.0 su su ort +or Windows AC9s and !NI7 +i%es:stem ermissions
eriodic 0$" sna shots are .isi=%e in Windows as shadow co ies
inc%udes tmu6D a #"(;%icensed uti%it: simi%ar to 3N! screen
1.1
- at.s Ne/ in 9.1.1
$reeNA"1 9.1.1 is most%: a =u' +i6 re%ease and this %ist o+ =u's was +i6ed +or this re%ease. 9.1.1 a%so introduces the +o%%owin' +eaturesK "u ort +or Che%sio <& series NICs usin' c6'=eA&B. i,diagnose scri t added. In the e.ent o+ a s:stem crashD it is used to send dia'nostic in+ormation re'ardin' the )erne% anic and a =asic crash %o' to i7s:stems in order to +aci%itate de=u''in' and tria'e o+ the issue.
1.2
0no/n Issues
UPGRADES FROM FreeNAS 0.7x ARE UNSUPPORTED. <he s:stem has no wa: to im ort con+i'uration settin's +rom 0./6 .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 im ort su orted $reeNA"1 0./6 .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 s ace re orted in the arent 8 oo% ma: not re+%ect rea%it: and can =e con+usin' =ecause the a.ai%a=%e s ace re resented =: datasets or 8.o%s can e6ceed that o+ the arent 8 oo%. (is)s with certain con+i'urations can 'et ro=ed =: 35-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 e6istin' 'mirror is sto ed and destro:ed. !"# 3.0 su ort is now ena=%ed =: de+au%t. I+ the s:stem anics a+ter an u 'rade or insta%%ationD Page 11 of 276
#e+ore insta%%in' $reeNA"1 :ou shou%d =e aware o+ the +o%%owin' )nown issuesK
tr: disa=%in' this su
ort =: creatin' a tuna=%e with a .aria=%e o+ (h'i*load and a .a%ue o+ N+.
<he m s dri.er +or ,'= s 9"I "A" H#As is .ersion 13D which reEuires hase 13 +irmware on the contro%%er. <his is a hard reEuirement and 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."
%ard/are 2eco33endations
"ince $reeNA"1 9.1.1 is =ased on $ree#"( 9.1D it su orts the same hardware +ound in the amd,& and i32, sections o+ the $ree#"( 9.1 Hardware Com ati=i%it: 9ist. Actua% hardware reEuirements wi%% .ar: de endin' u on 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 ti s +rom other $reeNA"1 users or to ost Euestions re'ardin' the hardware =est suited to meet :our reEuirements. 1.".1 Arc itecture
Whi%e $reeNA"1 is a.ai%a=%e +or =oth 32;=it and ,&;=it architecturesD ,&;=it hardware is recommended +or s eed and er+ormance. A 32;=it s:stem can on%: address u to & 3# 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+ 2 3# 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) ca acit: A'reater than 2 <#BD a 'enera% ru%e o+ thum= is 1 3# 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 i'nore the thum=ru%e o+ 1 3# o+ RAM +or e.er: 1 <# o+ stora'e. I+ er+ormance is inadeEuate :ou shou%d consider addin' more RAM as a +irst remed:. <he sweet s ot +or most users in home@sma%% =usiness is 1,3# o+ RAM. It is ossi=%e to use 0$" on s:stems with %ess than 2 3# 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 & 3# o+ memor: Iust +or 0$" cache and data structures. <his ost descri=es man: o+ the re%e.ant tuna=%es. I+ :ou %an to use 0$" dedu %icationD a 'enera% ru%e o+ thum= is * 3# RAM er <# o+ stora'e to =e dedu %icated. I+ :ou use Acti.e (irector: with $reeNA"1D add an additiona% 2 3# o+ RAM +or win=ind's interna% cache. FreeNAS 9.1.1 Users Guide Page 11 of 276
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-". 1."." &o3!act or US5 Flas
<he $reeNA"1 o eratin' 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 com act +%ash de.ice that is at %east 2 3# in si8e. I+ :ou don't ha.e com act +%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 ca acit: o+ the dri.e. In other wordsD the o eratin' 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 o eratin' s:stem dri.e into two artitions. -ne artition ho%ds the current o eratin' 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. 1.".# Storage 6is7s and &ontrollers
<he (is) section o+ the $ree#"( Hardware 9ist %ists the su orted dis) contro%%ers. In additionD su ort +or 3ware ,'= s RAI( contro%%ers has =een added a%on' with the C9I uti%it: t/8cli +or mana'in' 3ware RAI( contro%%ers. $reeNA"1 su orts 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 hot swa in'. I+ :ou need re%ia=%e dis) a%ertin'D immediate re ortin' o+ a +ai%ed dri.eD and or swa in'D use a +u%%: mana'ea=%e hardware RAI( contro%%er such as a 9"I Me'aRAI( contro%%er or a 3Ware twa;com ati=%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 s end and wish to o timi8e :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. 56am %es are 10K or 1*K "A" dri.es which cost a=out L1@3#. An e6am %e con+i'uration wou%d =e si6 ,00 3# 1*K "A" dri.es in a RAI( 10 which wou%d :ie%d 1.2 <# o+ usa=%e s ace or ei'ht ,00 3# 1*K "A" dri.es in a RAI( 10 which wou%d :ie%d 2.& <# o+ usa=%e s ace. /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 o timi8ed +or massi.e random access. <hese cards are e6 ensi.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'eM 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 FreeNAS 9.1.1 Users Guide Page 12 of 276
increased throu'h utD s:stems runnin' these cards t: ica%%: use mu%ti %e 10 3i'5 networ) inter+aces. I+ :ou wi%% =e usin' 0$"D (is) " ace ReEuirements +or 0$" "tora'e >oo%s recommends a minimum o+ 1, 3# o+ dis) s ace. (ue to the wa: that 0$" creates swa D )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 s ace to swa K +or e6am %eD on a & 3# dri.eD 2 3# wi%% =e reser.ed +or swa . I+ :ou are new to 0$" and are Recommendations +irst. urchasin' hardwareD read throu'h 0$" "tora'e >oo%s
0$" uses d:namic =%oc) si8in'D meanin' that it is ca a=%e o+ stri in' 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.".$ Net/or7 Interfaces
<he 5thernet section o+ the $ree#"( Hardware Notes indicates which inter+aces are su orted =: each dri.er. Whi%e man: inter+aces are su ortedD $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 wi%% er+orm oor%: under C>! %oad as inter+aces with these chi sets do not ro.ide their own rocessors. At a minimum :ou wi%% want to use a 3i'5 inter+ace. Whi%e 3i'5 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'h utD :ou can N=ondN mu%ti %e 3i'5 cards to'ether usin' the 9AC> t: e o+ 9in) A''re'ation. Howe.erD an: switches wi%% need to su ort 9AC> which means :ou wi%% need a more e6 ensi.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 s endD use 10 3i'5 inter+aces and a mana'ed switch. I+ :ou are urchasin' a mana'ed switchD consider one that su orts 9AC> and Ium=o +rames as =oth can =e used to increase networ) throu'h ut. N9):: at this time the +o%%owin' are %ot su wire%ess inter+aces. ortedK In+ini#andD $i=reChanne% o.er 5thernetD or
I+ networ) s eed 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 su ort is de endent u on the $ree#"( dri.er +or the inter+ace. I+ the dri.er su orts W-9D it can =e ena=%ed usin' i+con+i'A2B. <o determine i+ W-9 is su orted on a articu%ar inter+aceD s eci+: the inter+ace name to the +o%%owin' command. In this e6am %eD the ca a=i%ities %ine indicates that W-9 is su orted +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>
Page 1" of 276
I+ :ou +ind that W-9 su re ort. 1.".6 2AI6 9+er+ie/
ort is indicated =ut not wor)in' +or a articu%ar inter+aceD su=mit a =u'
(ata redundanc: and s eed are im ortant 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. 2AI6 1: ro.ides o tima% 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. 2AI6 1: ro.ides redundanc: as data is co ied AmirroredB to two or more dri.es. >ro.ides 'ood read er+ormance =ut ma: ha.e s%ower write er+ormanceD de endin' u on how the mirrors are setu and the num=er o+ 0I9s and 92ARCs. 2AI6 $: 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 s eed can =e reduced =: as much as *0O. I+ a dis) +ai%sD it is mar)ed as de'raded =ut the s:stem wi%% continue to o erate unti% the dri.e is re %aced and the RAI( is re=ui%t. Howe.erD shou%d another dis) +ai% =e+ore the RAI( is re=ui%tD a%% data wi%% =e %ost. I+ :our $reeNA"1 s:stem wi%% =e used +or stead: writesD RAI( * is a oor choice due to the s%ow write s eed. 2AI6 6: 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%% im ro.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( *. 2AI6 11: 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 stri ed 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 o erate in a de'raded state. RAI( 10 si'ni+icant%: out er+orms RAI(02D es ecia%%: on writes. 2AI6 61: reEuires a minimum o+ ei'ht dis)s. Com=ines RAI( 0 stri in' with the distri=uted dou=%e arit: o+ RAI( , =: stri in' 2 &;dis) RAI( , arra:s. RAI( ,0 re=ui%d times are ha%+ that o+ RAI( ,. 2AI6;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: s ecia% 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 s eed. 2AI6;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: s ecia% 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. 2AI6;": tri %e; arit: 0$" so+tware so%ution. RAI(03 o++ers three arit: dri.es and can o erate in de'raded mode i+ u to three dri.es +ai% with no restrictions on which dri.es can +ai%.
Page 1# of 276
N9):: instead o+ mi6in' 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)i ediaK P0$" 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 e6c%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 res ond in timeM and as such ma: reEuire <95R@CC<9@5RC; ena=%ed dis)s to re.ent dri.e dro outs. <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$".Q When determinin' the t: e o+ RAI(0 to useD consider whether :our 'oa% is to ma6imum dis) s ace or ma6imum er+ormanceK RAI(01 ma6imi8es dis) s ace and 'enera%%: er+orms we%% when data is written and read in %ar'e chun)s A122K 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) s ace =ut 'enera%%: er+orms =etter with sma%% random reads. $or =etter er+ormanceD a mirror is stron'%: +a.ored o.er an: RAI(0D uncachea=%eD random read %oads. articu%ar%: +or %ar'eD
When determinin' how man: dis)s to use in a RAI(0D the +o%%owin' con+i'urations ro.ide o tima% 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 'rou s. <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 3ettin' the Most out o+ 0$" >oo%s RAI(0 Con+i'uration ReEuirements and Recommendations A C%oser 9oo) at 0$"D 4de.s and >er+ormance N9):: 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 "na shot <as)s and Re %ication <as)s i+ :ou wou%d %i)e to use 0$" sna shots and rs:nc as art o+ :our =ac)u strate':.
Page 1$ of 276
1.".7
;FS 9+er+ie/
Whi%e 0$" isn't hardwareD an o.er.iew is inc%uded in this section as the decision to use 0$" ma: im act on :our hardware choices and whether or not to use hardware RAI(. I+ :ou are new to 0$"D the Wi)i edia entr: on 0$" ro.ides an e6ce%%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 0$" 5.i% <unin' 3uide $ree#"( 0$" <unin' 3uide 0$" #est >ractices 3uide 0$" Administration 3uide #ecomin' a 0$" NinIa A.ideoB 0$" <rou=%eshootin' 3uide "%ideshow e6 %ainin' 4(e.D 8 oo%D 0I9 and 92ARC and other new=ie mista)esR <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 conce t o+ .o%umes and the associated ro=%ems o+ artitionsD ro.isionin'D wasted =andwidth and stranded stora'e. <he "tora'e >oo%s Recommendations o+ the 0$" #est >ractices 3uide ro.ides detai%ed recommendations +or creatin' the stora'e oo%. In $reeNA"1D 0$" 4o%ume Mana'er is used to create 0$" oo%s. 6ataset: once a oo% is createdD it can =e di.ided into datasets. A dataset is simi%ar to a +o%der in that it su orts ermissions. A dataset is a%so simi%ar to a +i%es:stem in that :ou can set ro erties such as Euotas and com ression. ;+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 e6tents. In other wordsD a 8.o% is a .irtua% =%oc) de.ice in a 0$" stora'e oo%. Sna!s ot: a read;on%: oint;in;time co : o+ a +i%es:stem. "na shots can =e created Euic)%: andD i+ %itt%e data chan'esD new sna shots ta)e u .er: %itt%e s ace. $or e6am %eD a sna shot where no +i%es ha.e chan'ed ta)es 0 M# o+ stora'eD =ut i+ :ou chan'e a 10 3# +i%e it wi%% )ee a co : o+ =oth the o%d and the new 10 3# .ersion. "na shots ro.ide a c%e.er wa: o+ )ee in' 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 sna shots 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 s eci+ic time orD i+ there is a catastro hic %ossD an o++;site sna shot can restore the s:stem u to the %ast sna shot inter.a% Ae.'. within 1* minutes o+ the data %ossB. "na shots can =e c%oned or ro%%ed =ac)D =ut the +i%es on the sna shot cannot =e accessed inde endent%:. &lone: a writa=%e co : o+ a sna shot which can on%: =e created on the same 0$" .o%ume. C%ones ro.ide an e6treme%: s ace;e++icient wa: to store man: co ies o+ most%:;shared data such as wor)s acesD so+tware insta%%ationsD and dis)%ess c%ients. C%ones do not inherit the ro erties o+ the arent datasetD =ut rather inherit the ro erties =ased on where the c%one is created in the 0$" oo%. #ecause a c%one initia%%: shares a%% its dis) s ace with the ori'ina% sna shotD its used ro ert: is initia%%: 8ero. As chan'es are made to the c%oneD it uses more s ace. FreeNAS 9.1.1 Users Guide Page 16 of 276
6edu!lication: the rocess o+ e%iminatin' du %icate co ies o+ data in order to sa.e s ace. -nce dedu %icaton occursD it can im ro.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 * 3# 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 e6istin' data. <he more data :ou write to a dedu %icated datasetD the more RAM it reEuiresD and there is no u er =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 im ortin' an unc%ean oo% can reEuire =etween 3;* 3# o+ RAM er <# o+ dedu ed 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 tem orar: 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$" 4o%ume Mana'er. I+ the s:stem has +ew s:nc writesD a s%o' wi%% not s eed u writes to the oo%. A more detai%ed e6 %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 es ecia%%: +or 5"7i. When creatin' a dedicated %o' de.iceD it is recommended to use a +ast ""( with a su erca acitor or a =an) o+ ca acitors 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+sA2B 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 s eed u N$" writesD the ""( can =e ha%+ the si8e o+ s:stem RAM as an:thin' %ar'er than that is unused ca acit:. <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$".22 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 4iew 4o%umes S 4o%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 im ro.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 readD 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$" 4o%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 e6istin' 92ARCD :ou FreeNAS 9.1.1 Users Guide Page 17 of 276
can stri e another cache de.ice =: addin' another de.ice. <he 3!I wi%% a%wa:s stri e 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 im act on read er+ormanceD de endin' u on 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 5CC 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 re airs it i+ necessar:.
Installing and U!grading FreeNAS
#e+ore insta%%in'D it is im ortant to remem=er that the $reeNA"1 o eratin' s:stem must =e insta%%ed on a se arate 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 'ra hica% 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 e6 erimentin' with $reeNA"1D :ou can insta%% $reeNA"1 on an ine6 ensi.e !"# thum= dri.e and use the com uter's dis)AsB +or stora'e. <his section descri=es the +o%%owin'K 3ettin' $reeNA"1 $reeNA"1 in a 4irtua% 5n.ironment Insta%%in' +rom C(R-M #urnin' an IM3 $i%e Initia% "etu ! 'radin' $reeNA"1
2.1
Getting FreeNAS
$reeNA"1 9.1.1 can =e down%oaded +rom the $reeNA" down%oad a'e. $reeNA"1 is a.ai%a=%e +or 32;=it A632,B and ,&;=it A6,&B architectures. Fou shou%d down%oad the architecture t: e that matches :our C>!'s ca a=i%ities. <he down%oad a'e contains the +o%%owin' t: es o+ +i%es. (own%oad one +i%e that meets :our needsK GUI8u!grade.t,= or (818,8<:GA&>8GUI8U!grade.,=: this is a com ressed +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. !se ,*0*(*-./A"0*/12*13grade.(4 i+ :ou are u 'radin' +rom .ersion 2.0.1#5<A3 throu'h 2.2.0;#5<A2. !se /12*!3grade.t(4 i+ :ou are u 'radin' +rom .ersion 2.2.0;#5<A3 throu'h 9.1.0. .i3g.,=: this is a com ressed ima'e o+ the o eratin' s:stem that needs to =e written to a !"# or com act +%ash de.ice. #urnin' an IM3 $i%e descri=es how to write the ima'e. .iso: this is a =oota=%e insta%%er that can =e written to C(R-M. <his is descri=ed in more detai% Page 1( of 276
in Insta%%in' +rom C(R-M. 5ach +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 =: o eratin' s:stemK on a #"( s:stem use the command s a2$6 na3e8of8file on a 9inu6 s:stem use the command s a2$6su3 na3e8of8file on a Mac s:stem use the command s asu3 ?a 2$6 na3e8of8file 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 :n+iron3ent
$reeNA" can =e run inside a .irtua% en.ironment +or de.e%o mentD e6 erimentationD and educationa% ur oses. >%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 *12 M# =ase memor: si8e A!$" on%:BD &09, M# or more A0$"B a .irtua% dis) at lea$t < G, i% $i.e to ho%d the o eratin' 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 ada ter <his section demonstrates how to create and access a .irtua% machine within the 4irtua%#o6 and 4MWare 5"7i en.ironments.
2.2.1
@irtual5o,
4irtua%#o6 is an o en source .irtua%i8ation ro'ram ori'ina%%: created =: "un Micros:stems. 4irtua%#o6 runs on WindowsD #"(D 9inu6D MacintoshD and - en"o%aris. It can =e con+i'ured to use a down%oaded $reeNA"1 .iso or .img.(4 +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 4irtua%#o6 and c%ic) the PNewQ =uttonD seen in $i'ure 2.2aD to start the new .irtua% machine wi8ard. C%ic) the PNe6tQ =utton to see the screen in $i'ure 2.2=. 5nter a name +or the .irtua% machineD then c%ic) the P- eratin' ":stemQ dro ;down menu and se%ect #"( which wi%% automatica%%: chan'e the P4ersionQ to $ree#"(. C%ic) PNe6tQ to see the screen in $i'ure 2.2c.
Page 19 of 276
Figure 2.2a: Initial @irtual5o, Screen
Figure 2.2': )*!e in a Na3e and Select t e 9!erating S*ste3 for t e Ne/ @irtual 4ac ine
Page 21 of 276
Figure 2.2c: Select t e A3ount of 4e3or* 2eser+ed for t e @irtual 4ac ine
Figure 2.2d: Select - et er to Use an :,isting or &reate a Ne/ @irtual 6is7
Page 21 of 276
<he =ase memor: si8e must =e chan'ed to at lea$t ;:< 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) PNe6tQ to see the screen in $i'ure 2.2d. <his screen is used to create the .irtua% hard dis) to insta%% $reeNA"1 into. C%ic) PNe6tQ to %aunch the NCreate New 4irtua% (is) Wi8ardN. C%ic) the PNe6tQ =utton a'ain to see the screen in $i'ure 2.2e. <he wi8ard can =e used to create the +o%%owin' t: es o+ .irtua% dis) +ormatsK @6I: 4irtua% (is) Ima'e is the +ormat used =: 4irtua%#o6. "e%ect this o tion i+ :ou down%oaded the I"-. @460: 4irtua% Machine (is) is the +ormat used =: 4MWare. "e%ect this o tion i+ :ou con.erted the .img +i%e to 4M(K +ormat usin' the instructions in Runnin' $reeNA"1 +rom a !"# Ima'e. @%6: 4irtua% Hard (is) is the +ormat used =: Windows 4irtua% >C. %66: is the +ormat used =: >ara%%e%s. -nce :ou ma)e a se%ectionD c%ic) the PNe6tQ =utton to see the screen in $i'ure 2.2+. Fou can now choose whether :ou want N(:namica%%: e6 andin' stora'eN or N$i6ed;si8e stora'eN. <he +irst o tion uses dis) s ace as needed unti% it reaches the ma6imum si8e that :ou wi%% set in the ne6t screen. <he second o tion creates a dis) the same si8e as that s eci+ied amount o+ dis) s aceD whether it is used or not. Choose the +irst o tion i+ :ou are worried a=out dis) s aceM otherwiseD choose the second o tion as it a%%ows 4irtua%#o6 to run s%i'ht%: +aster. -nce :ou se%ect PNe6tQD :ou wi%% see the screen in $i'ure 2.2'. Figure 2.2e: &reate Ne/ @irtual 6is7 -i=ard
Page 22 of 276
Figure 2.2f: Select t e Storage )*!e for t e @irtual 6is7
Figure 2.2g: Select t e File Na3e and Si=e of t e @irtual 6is7
Page 2" of 276
<his screen is used to set the si8e Aor u er %imitB o+ the .irtua% machine. 1%crea$e the de*a!lt $i.e to < G,. !se the +o%der icon to =rowse to a director: on dis) with su++icient s ace to ho%d the .irtua% machine. -nce :ou ma)e :our se%ection and ress PNe6tQD :ou wi%% see a summar: o+ :our choices. !se the P#ac)Q =utton to return to a re.ious screen i+ :ou need to chan'e an: .a%ues. -therwiseD c%ic) P$inishQ to +inish usin' the wi8ard. <he .irtua% machine wi%% =e %isted in the %e+t +rameD as seen in the e6am %e in $i'ure 2.2h. Figure 2.2 : ) e Ne/ @irtual 4ac ine
2.2.1.2
Creating Devices for Storage and Installation Media
Ne6tD create the .irtua% dis)AsB to =e used +or stora'e. C%ic) the P"tora'eQ h: er%in) in the ri'ht +rame to access the stora'e screen seen in $i'ure 2.2i. C%ic) the PAdd AttachmentQ =uttonD se%ect PAdd Hard (is)Q +rom the o ;u menuD then c%ic) the PCreate New (is)Q =utton. <his wi%% %aunch the Create New 4irtua% (is) Wi8ard Aseen in $i'ures 2.2e and 2.2+B. "ince this dis) wi%% =e used +or stora'eD create a si8e a ro riate 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(5 contro%%er. I+ :ou need additiona% dis)sD c%ic) the PAdd Contro%%erQ =utton to create another contro%%er to attach dis)s to. Ne6tD create the de.ice +or the insta%%ation media.
Page 2# of 276
I+ :ou wi%% =e insta%%in' +rom an I"-D hi'h%i'ht the word P5m t:QD then c%ic) the C( icon as seen in $i'ure 2.2I. C%ic) PChoose a .irtua% C(@(4( dis) +i%e...Q 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 PHost (ri.eQ. (e endin' u on the e6tensions a.ai%a=%e in :our C>!D :ou ma: or ma: not =e a=%e to use a ,&;=it I"on a ,&;=it s:stem. I+ :ou recei.e the error N:our C>! does not su ort %on' modeN when :ou tr: to =oot a ,&;=it I"-D :our C>! either does not ha.e the reEuired e6tension or AM(;4@4<;6 is disa=%ed in the s:stem #I-". Fou can sti%% use the 32;=it .ersion o+ the I"-D =ut 0$" er+ormance wi%% =e reduced. N9):: i+ :ou recei.e a )erne% anic when =ootin' into the I"-D sto the .irtua% machine. <henD 'o to ":stem and chec) the =o6 P5na=%e I- A>ICQ. Figure 2.2i: ) e Storage Settings of t e @irtual 4ac ine
Page 2$ of 276
Figure 2.2A: &onfiguring t e IS9 Installation 4edia
2.2.1.3
Configuring the Bridged Ada ter
<o con+i'ure the networ) ada terD 'o to "ettin's S Networ). In the PAttached toQ dro ;down menu se%ect P#rid'ed Ada terQD then se%ect the name o+ the h:sica% inter+ace +rom the PNameQ dro ;down menu. In the e6am %e shown in $i'ure 2.2)D the Inte% >ro@1000 5thernet 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 P"tartQ 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 o tion. Fou can ermanent%: =oot +rom dis) =: remo.in' the C(@(4( de.ice in P"tora'eQ or =: unchec)in' C(@(4(;R-M in the P#oot -rderQ section o+ P":stemQ. I+ :ou con+i'ured the 4M(KD the .irtua% machine wi%% =oot direct%: into $reeNA"1.
Page 26 of 276
Figure 2.27: &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.(4 +i%e instead o+ insta%%in' it +rom the I"-D :ou must +irst down%oad and insta%% the -rac%e 4M 4irtua%#o6 56tension >ac) that matches :our .ersion o+ 4irtua%#o6. <he e6tension ac) ena=%es !"# su ort. Ne6tD uncom ress and =urn the $reeNA"1 .img.(4 +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 4irtua%#o6 3!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 o en a command rom t 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 S ri'ht;c%ic) Com uter S Mana'e S "tora'e S (is) Mana'ement. I+ the !"# dri.e is di++erent than (is) 1D chan'e the num=er in 55.56hysi'al ri#e1 to match the dis) num=er. Fou can a%so s eci+: where to sa.e the .#mdk +i%e. Ma)e sure that the securit: ta= o+ the sa.ed +i%e 'i.es P$u%% contro%Q ermissions to !sers so that the +i%e can =e accessed =: 4irtua%#o6. FreeNAS 9.1.1 Users Guide Page 27 of 276
Figure 2.2l: &reating t e +3d7 File in -indo/s
-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 P!se e6istin' hard dis)Q and =rowse to :our .#mdk +i%e. C%ic) PNe6tQD then PCreateQ. <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 ada ter as usua%. When +inishedD start the .irtua% machine and it wi%% =oot direct%: into $reeNA"1. 2.2.2 @4-are :SBi
I+ :ou are considerin' usin' 5"7iD read this ost +or an e6 %anation o+ wh: i"C"I wi%% =e +aster than N$". 5"7i is is a N=are;meta%N h: er.isor architecture created =: 4Mware Inc. Commercia% and +ree .ersions o+ the 4MWare ." here H: er.isor o eratin' s:stem A5"7iB are a.ai%a=%e +rom the 4MWare we=site. -nce the o eratin' s:stem is insta%%ed on su orted hardwareD use a we= =rowser to connect to its I> address. <he we%come screen wi%% ro.ide a %in) to down%oad the 4Mware ." here c%ient which is used to create and mana'e .irtua% machines. -nce the 4Mware ." here c%ient is insta%%edD use it to connect to the 5"7i ser.er. <o create a new .irtua% machineD c%ic) $i%e S New S 4irtua% Machine. <he New 4irtua% Machine Wi8ard wi%% %aunch as seen in $i'ure 2.2m. C%ic) PNe6tQ and in ut a name +or the .irtua% machine. C%ic) PNe6tQ and hi'h%i'ht a datastore. An e6am %e is shown in $i'ure 2.2n. C%ic) PNe6tQ. In the screen shown in $i'ure 2.2oD c%ic) P-therQ then se%ect a $ree#"( architecture that matches the $reeNA"1 architecture.
Page 2( of 276
Figure 2.23: Ne/ @irtual 4ac ine -i=ard
Figure 2.2n: Select a 6atastore
Page 29 of 276
Figure 2.2o: Select t e 9!erating S*ste3
C%ic) PNe6tQ and create a .irtua% dis) +i%e o+ 2 G, to ho%d the $reeNA"1 o eratin' s:stemD as shown in $i'ure 2.2 . C%ic) PNe6tQ then P$inishQ. Four .irtua% machine wi%% =e %isted in the %e+t +rame. Ri'ht;c%ic) the .irtua% machine and se%ect P5dit "ettin'sQ to access the screen shown in $i'ure 2.2E. Increase the PMemor: Con+i'urationQ to at lea$t ;:< M, . !nder PC>!sQD 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) NHard dis) 1N S Add. In the P(e.ice <: eQ menuD hi'h%i'ht PHard (is)Q and c%ic)Q Ne6tQ. "e%ect NCreate a new .irtua% dis)N and c%ic) PNe6tQ. 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 =o6 NA%%ocate and commit s ace on demand A<hin >ro.isionin'BN. C%ic) PNe6tQD then PNe6tQD then P$inishQ to create the dis). Re eat to create the amount o+ stora'e dis)s needed to meet :our reEuirements.
Page "1 of 276
Figure 2.2!: &reate a 6is7 for t e 9!erating S*ste3
Page "1 of 276
Figure 2.2C: @irtual 4ac ine.s Settings
Page "2 of 276
Figure 2.2r: &reating a Storage 6is7
2."
Installing fro3 &6294
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. N9):: 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. N9):: 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 NotesM 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 s eed. FreeNAS 9.1.1 Users Guide Page "" of 276
Figure 2."a: FreeNAS &onsole Setu!
>ress enter to se%ect the de+au%t o tion o+ P1 Insta%%@! 'rade to hard dri.e@+%ash de.iceD etc.Q. <he ne6t 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 e6am %eD the user is insta%%in' into 4irtua%#o6 and has created a & 3# .irtua% dis) to ho%d the o eratin' s:stem. N9):: at this timeD the insta%%er does not chec) the si8e o+ the insta%% media =e+ore attem tin' an insta%%ation. A 2 3# de.ice is reEuiredD =ut the insta%% wi%% a ear to com %ete success+u%%: on sma%%er de.icesD on%: to +ai% at =oot. I+ usin' a !"# thum= dri.eD an & 3# dri.e is recommended as man: 2 3# thum= dri.es ha.e a sma%%er ca acit: 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 com act +%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%% e6tract 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 P3 Re=oot ":stemQ 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 .
Page "# of 276
Figure 2."': Selecting - ic 6ri+e to Install Into
Figure 2."c: FreeNAS Installation -arning
Figure 2."d: FreeNAS Installation &o3!lete
Page "$ of 276
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 o eratin' s:stem direct%: to a com act +%ash card or !"# thum=dri.e. (own%oad the img.(4 +i%eD uncom ress the +i%eD and write it to a com act +%ash card or !"# thum=dri.e that is 2 3# or %ar'er. Fou then =oot into that de.ice to %oad the $reeNA"1 o eratin' s:stem. <his section demonstrates how to write the ima'e usin' se.era% di++erent o eratin' s:stems. <he !net=ootin too% is not su orted at this time. 6ANG:2D <he dd command demonstrated in this section is .er: ower+u% and can destro: an: e6istin' data on the s eci+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' ddR 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 Free5S6 or <inu, S*ste3
-n a $ree#"( or 9inu6 s:stemD the ,=cat and dd commands can =e used to uncom ress and write the .(4 ima'e to an inserted !"# thum= dri.e or com act +%ash de.ice. 56am %e 2.&a demonstrates writin' the ima'e to the +irst !"# de.ice A 7de#7da0B on a $ree#"( s:stem. "u=stitute the +i%ename o+ :our .(4 +i%e and the de.ice name re resentin' the de.ice to write to on :our s:stem. :,a3!le 2.#a: -riting t e I3age to a US5 ) u3' 6ri+e
xzcat FreeNAS-9.1.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 ofE re+ers to the out ut +i%eM 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 9inu6D use 7de#7sdX8 where X re+ers to the %etter o+ the !"# de.ice. 'sE re+ers to the =%oc) si8e 2.#.2 Using 0e7a and dd on an 9S B S*ste3
-n an -" 7 s:stemD :ou can down%oad and insta%% Ke)a to uncom ress the ima'e. In $IN(5RD na.i'ate to the %ocation where :ou sa.ed the down%oaded .(4 +i%e. Ri'ht;c%ic) the .(4 +i%e and se%ect P- en With Ke)aQ. A+ter a +ew minutes :ou wi%% ha.e a %ar'e +i%e with the same nameD =ut no .(4 e6tension. Insert the !"# thum= dri.e and 'o to 9aunch ad S !ti%ities S (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.eM se%ectin' N+ree s aceN when creatin' the artition wor)s +ine. Ne6tD determine the de.ice name o+ the inserted !"# thum= dri.e. $rom <5RMINA9D na.i'ate to :our (es)to then t: e this commandK FreeNAS 9.1.1 Users Guide Page "6 of 276
diskutil list /dev/disk0 #: TYPE NAME 0: GUID_partition_scheme 1: EFI 2: Apple_HFS Macintosh HD 3: Apple_Boot Recovery HD /dev/disk1 #: TYPE NAME 0: FDisk_partition_scheme 1: DOS_FAT_32 UNTITLED
SIZE *500.1 209.7 499.2 650.0
GB MB GB MB
IDENTIFIER disk0 disk0s1 disk0s2 disk0s3 IDENTIFIER disk1 disk1s1
SIZE *8.0 GB 8.0 GB
<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 com are the di++erence. -nce :ou are sure o+ the de.ice nameD na.i'ate to the (es)to +rom <5RMINA9D unmount the !"# stic)D and use the dd command to write the ima'e to the !"# stic). In 56am %e 2.&=D the !"# thum= dri.e is 7de#7disk1. "u=stitute the name o+ :our uncom ressed +i%e and the correct ath to :our !"# thum= dri.e. :,a3!le 2.#': Using dd on an 9S B S*ste3
diskutil unmountDisk /dev/disk1 Unmount of all volumes on disk1 was successful dd if=FreeNAS-9.1.1-RELEASE-x64.img of=/dev/disk1 bs=64k
N9):: i+ :ou 'et the error PResource =us:Q when :ou run the dd commandD 'o to A %ications S !ti%ities S (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 NddK @de.@dis)1K >ermission deniedND run the dd command =: t: in' sudo dd ifEFreeNAS?9.1.1?2:<:AS:?,6#.i3g ofEFde+Fdis71 'sE6#7D which wi%% rom t +or the root user's assword. <he dd command wi%% ta)e some minutes to com %ete. Wait unti% :ou 'et a rom t =ac) and a messa'e that dis %a:s how %on' it too) to write the ima'e to the !"# dri.e. 2.#." Using 7?;i! and -in"26is7I3ager on -indo/s
Windows users wi%% need to down%oad a uti%it: that can uncom ress .(4 +i%es and a uti%it: that can create a !"# =oota=%e ima'e +rom the uncom ressed .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.4i3 and use /;0i to un8i its e6ecuta=%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.(4 +i%eD as seen in $i'ure 2.&a. C%ic) the 56tract =uttonD =rowse to the ath to e6tract toD and c%ic) -K. <he e6tracted ima'e wi%% end in .img and is now read: to =e written to a !"# de.ice usin' Win32(is)Ima'er. Ne6tD %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.
Page "7 of 276
Figure 2.#a: Using 7?;i! to :,tract I3age File
Figure 2.#': Using -in"26is7I3ager to -rite t e I3age
2.#.#
)rou'les ooting
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 o tion to chan'e the !"# emu%ation +rom C(@(4(@+%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 3# !"# stic)s do not wor) as the: are not rea%%: 2 3# in si8eD =ut chan'in' to a & 3# stic) +i6es the ro=%em. I+ :ou are writin' the ima'e to a com act +%ash cardD ma)e sure that it is M"(-" +ormatted. I+ the s:stem starts to =oot =ut han's with this re eated 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 FreeNAS 9.1.1 Users Guide Page "( of 276
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 wi e the !"# stic) =e+ore tr:in' a second =urn usin' a uti%it: such as Acti.eT Ki%%(is). -therwiseD the second =urn attem t wi%% +ai% as Windows does not understand the artition which was written +rom the ima'e +i%e. #e .er: care+u% that :ou s eci+: the !"# stic) when usin' a wi e uti%it:R
2.$
Initial Setu!
When :ou =oot into $reeNA"1D the Conso%e "etu D shown in $i'ure 2.*aD wi%% a ear 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 3!I =ecome inaccessi=%e. N9):: :ou can access the Conso%e "etu menu +rom within the $reeNA"1 3!I =: t: in' FetcFnetcli +rom "he%%. Figure 2.$a: FreeNAS &onsole Setu! 4enu
<his menu ro.ides the +o%%owin' o tionsK 1G &onfigure Net/or7 Interfaces: ro.ides a con+i'uration wi8ard to con+i'ure the s:stem's networ) inter+aces. 2G &onfigure <in7 Aggregation: a%%ows :ou to either create a new %in) a''re'ation or to de%ete an e6istin' %in) a''re'ation. "G &onfigure @<AN Interface: used to create or de%ete a 49AN inter+ace. #G &onfigure 6efault 2oute: used to set the I>.& or I>., de+au%t 'atewa:. When rom tedD in ut the I> address o+ the de+au%t 'atewa:. $G &onfigure Static 2outes: wi%% rom t +or the destination networ) and the 'atewa: I> address. Re; enter this o tion +or each route :ou need to add. 6G &onfigure 6NS: wi%% rom t +or the name o+ the (N" domain then the I> address o+ the +irst (N" FreeNAS 9.1.1 Users Guide Page "9 of 276
ser.er. <o in ut mu%ti %e (N" ser.ersD ress enter to in ut the ne6t one. When +inishedD ress enter twice to %ea.e this o tion. 7G 2eset -e'GUI login credentials: i+ :ou are una=%e to %o'in to the 'ra hica% administrati.e inter+aceD se%ect this o tion. It wi%% reset the s:stem to not reEuire a username and assword to %o'in. (on't +or'et to immediate%: set the administrati.e username and assword once :ou enter the 3!I. (G 2eset to factor* defaults: i+ :ou wish to de%ete all o+ the con+i'uration chan'es made in the administrati.e 3!ID se%ect this o tion. -nce the con+i'uration is resetD the s:stem wi%% re=oot. Fou wi%% need to 'o to "tora'e S 4o%umes S Auto Im ort 4o%ume to re;im ort :our .o%ume. 9G S ell: enters a she%% in order to run $ree#"( commands. <o %ea.e the she%%D t: e e,it. 11G 2e'oot: re=oots the s:stem. 11 S utdo/n: 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 'ra hica% conso%e. In the e6am %e seen in $i'ure 2.*aD the $reeNA"1 s:stem is accessi=%e +rom htt3)77192.1:,.1.;0. 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 56am %e 2.*a. In this e6am %eD the $reeNA"1 s:stem has one networ) inter+ace Aem0B. :,a3!le 2.$a: 4anuall* Setting an IP Address fro3 t e &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
Page #1 of 276
-nce the s:stem has an I> addressD in ut that address into a 'ra hica% we= =rowser +rom a com uter ca a=%e o+ accessin' the networ) containin' the $reeNA"1 s:stem. <he administrati.e 3!ID shown in $i'ure 2.*=D shou%d =e dis %a:ed. I+ it does not a earD chec) the +o%%owin'K Are ro6: 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 unres onsi.e or seems to =e missin' menu itemsD tr: usin' a di++erent we= =rowser. I59 has )nown issues and wi%% not dis %a: the 'ra hica% administrati.e inter+ace correct%: i+ com ati=i%it: mode is turned on. I+ :ou can't access the 3!I usin' Internet 56 %orerD use $ire+o6 instead. I+ :ou recei.e NAn error occurredRN messa'es when attem tin' to con+i'ure an item in the 3!ID ma)e sure that the =rowser is set to a%%ow coo)ies +rom the $reeNA"1 s:stem. Figure 2.$': FreeNAS Gra! ical &onfiguration 4enu
<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.6
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 'ra hica% 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./6. InsteadD insta%% $reeNA"1 and either auto;im ort su orted so+tware RAI( or im ort su orted +i%es:stems. Fou wi%% need Page #1 of 276
to recreate :our con+i'uration as the insta%%ation rocess wi%% not im ort 0./ con+i'uration settin's. 2.6.1 Pre!aring for t e U!grade
#e+ore u 'radin' the s:stem to 9.1.1D er+orm the +o%%owin' ste sK 1. (own%oad the .iso or .t(4 +i%e that matches the s:stem's architecture to the com uter that :ou use to access the $reeNA"1 s:stem. N9):: i+ :ou wish to u 'rade usin' the 3!ID the +i%e :ou use de ends u on the current .ersion o+ $reeNA". I+ :ou're runnin' .ersion 2.0.1#5<A3 throu'h 2.2.0;#5<A2D use ,*0*(*-./A"0*/12*13grade.(4. I+ :ou're runnin' .ersion 2.2.0;#5<A3 to 9.1.0D use /12*!3grade.t(4. 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 S "ettin's S 3enera% S "a.e Con+i'. &. I+ an: .o%umes are encr: tedD ma)e sure that :ou ha.e set the ass hrase and ha.e co ies 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 'radeM :ou shou%d schedu%e the u 'rade +or a time that wi%% %east im act users. ,. "to a%% ser.ices in "er.ices S Contro% "er.ices. 2.6.2 Using t e IS9 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 o tion o+ N1 Insta%%@! 'rade to hard dri.e@+%ash de.iceD etc.N As with a +resh insta%%D the insta%%er wi%% resent a screen showin' a%% a.ai%a=%e dri.esM 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. N9):: i+ :ou se%ect to con+i'uration. er+orm a Fresh 2nstallD :ou wi%% ha.e to restore the =ac)u o+ :our
<o er+orm an u 'radeD ress enter to acce t the de+au%t o+ 13grade 2nstall. A'ainD the insta%%er wi%% remind :ou that the o eratin' 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 un ac)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.
Page #2 of 276
Figure 2.6a: U!grading a FreeNAS Installation
Figure 2.6': FreeNAS /ill 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 ha ens durin' the NA %:in' data=ase schema chan'esN %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 'ra hica% administrati.e inter+ace is accessi=%eD FreeNAS 9.1.1 Users Guide Page #" of 276
'o to "ettin's S 3enera% 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.6c: U!grade is &o3!lete
2.6."
Using t e GUI to U!grade
<o er+orm an u 'rade usin' this methodD down%oad the %atest .ersion o+ the .t(4 +i%e that matches the architecture o+ the s:stem A32; or ,&;=itB. N9):: i+ :ou are u 'radin' +rom a .ersion that starts with 2.0D instead down%oad the ,*0*(*-./A"0*/12*13grade.(4 +i%e. <henD 'o to ":stem S "ettin's S Ad.anced S $irmware ! date as shown in $i'ure 2.,d. Figure 2.6d: U!grading FreeNAS Fro3 t e GUI
Page ## of 276
!se the dro ;down menu to se%ect an e6istin' .o%ume to tem orari%: %ace the +irmware +i%e durin' the u 'rade. A%ternate%:D se%ect NMemor: de.iceN to a%%ow the s:stem to create a tem orar: RAM dis) to =e used durin' the u 'rade. A+ter ma)in' :our se%ectionD c%ic) the A Figure 2.6e: Ste! 2 of 2 %: ! date =utton to see the screen shown in $i'ure 2.,e.
<his screen reminds :ou to =ac)u :our con+i'uration =e+ore roceedin'. I+ :ou ha.e not :etD c%ic) the Nc%ic) hereN %in). #rowse to the %ocation o+ the down%oaded .t(4 +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' ste s are occurrin'K the "HA2*, hash is con+irmed and an error wi%% dis %a: i+ it does not matchM 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 uncom ressed and written to the !"# com act or +%ash dri.eM 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 o eratin' s:stem $reeNA"1 wi%% actua%%: re=oot twiceK once the new o eratin' 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.erM re+resh :our =rowser a+ter a moment to see i+ :ou can access the s:stem
Page #$ of 276
2.6.#
Unloc7ing an :ncr*!ted @olu3e
I+ :our dis)s are encr: ted and :ou ha.e created a ass hrase 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 ass hrase and reco.er: )e:. <o un%oc) the .o%umeD 'o to "tora'e S 4o%umes S 4iew 4o%umes and hi'h%i'ht the %oc)ed .o%ume. As seen in $i'ure 2.,+D c%ic)in' the N!n%oc)N icon wi%% rom t +or the ass hrase 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.6f: Unloc7ing an :ncr*!ted @olu3e
2.6.$
If So3et ing 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 o tion N1B Con+i'ure Networ) Inter+acesN i+ it did not. I+ this does not +i6 the ro=%emD 'o into o tion N9B "he%%N 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 7data7!3grade-failed shou%d =e created with the detai%s. I+ the ro=%em is not o=.ious or :ou are unsure how to +i6 itD see $reeNA"1 "u ort Resources. $reeNA"1 su orts two o eratin' s:stems on the o eratin' s:stem de.iceK the current o eratin' s:stem andD i+ :ou ha.e er+ormed an u 'radeD the re.ious%: insta%%ed .ersion o+ the o eratin' s:stem. <his a%%ows :ou to re=oot into the re.ious .ersion shou%d :ou e6 erience a ro=%em with the u 'raded .ersion.
Page #6 of 276
<he u 'rade rocess automatica%%: con+i'ures the s:stem to =oot +rom the new o eratin' 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 N10B Re=ootN +rom the conso%e menu. Watch the =oot screens and ress the other =oot o tion At: ica%%: F2B +rom the $reeNA"1 conso%e when :ou see the +o%%owin' o tions at the .er: =e'innin' o+ the =oot rocess. In this e6am %eD Boot) F1 re+ers to the de+au%t o tion Athe new%: u 'raded .ersionBD so ressin' F2 wi%% =oot into the re.ious .ersion.
F1 FreeBSD F2 FreeBSD Boot: F1
N9):: 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: +i6 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. Im ort :our .o%umes in "tora'e S Im ort 4o%ume. 3. Restore the con+i'uration in ":stem S "ettin's S ! %oad Con+i'. 2.6.6 U!grading a ;FS Pool
0$" oo%s that are created usin' 0$" 4o%ume Mana'er on $reeNA"1 9.1.1 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 2.3.1 Aan: atch %e.e%B use 0$".22. An: 0$" oo%s that were created in an: re.ious 2.6 .ersions o+ $reeNA"1 use 0$".1*. I+ :ou auto;im ort a 0$" oo% +rom an: 2.6 .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& com ressionD unti% the oo% is u 'raded. I+ :ou wish to u 'rade an e6istin' 0$".1* or 0$".22 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 3!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 su ort +eature +%a's. =e+ore er+ormin' an: o eration 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 o en "he%%. <he +o%%owin' commands wi%% determine the oo% state and .ersion. In this e6am %eD the oo% name is #ol!me1 and the 0$" .ersion is 22.
zpool status pool: volume1 state: ONLINE status: The pool is formatted using a legacy on-disk format.
The pool can
Page #7 of 276
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 volume1 gptid/ea16925b-e96e-11e2-9ed5-e06995777a82 gptid/ea8f3a7b-e96e-11e2-9ed5-e06995777a82 gptid/eb064d06-e96e-11e2-9ed5-e06995777a82 gptid/eb7ba402-e96e-11e2-9ed5-e06995777a82 errors: No known data errors zpool get version volume1 NAME PROPERTY VALUE SOURCE volume1 version 28 local STATE ONLINE ONLINE ONLINE ONLINE ONLINE READ WRITE CKSUM 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Ne6tD .eri+: that the status o+ the oo% is hea%th:K

zpool status -x all pools are healthy
N9):: 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;disru ti.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%% sus end 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 3uide descri=es a%% o+ the con+i'uration screens a.ai%a=%e within the $reeNA"1 'ra hica% administrati.e inter+ace. It =e'ins with a ?uic) "tart 3uide 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: a ear within the $reeNA"1 con+i'uration tree +ound in the %e+t +rame o+ the 'ra hica% administrati.e inter+ace. N9):: it is im ortant to use the 3!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 FreeNAS 9.1.1 Users Guide Page #( of 276
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.
"
Huic7 Start Guide and Account &onfiguration
<his section contains a ?uic) "tart 3uide to 'et :ou started with :our $reeNA"1 con+i'uration. It is +o%%owed =: the account section o+ the 3!I which a%%ows :ou to chan'e the administrati.e assword and mana'e users and 'rou s.
".1
Huic7 Start Guide
<his section demonstrates the initia% re aration 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.1.1 !sers 3uide that contains the detai%s and con+i'uration e6am %es +or each ste in the con+i'uration wor)+%ow. ".1.1 Set Ad3inistrati+e Access
#: de+au%tD no assword is reEuired to access the $reeNA"1 administrati.e inter+ace usin' the =ui%t;in admin account. $or securit: reasonsD :ou shou%d immediate%: chan'e the de+au%t administrati.e account name and set a assword +or that account usin' the instructions in Admin Account. A +%ashin' red a%ert wi%% a ear in the u er ri'ht corner o+ the administrati.e 3!I unti% :ou set this account in+ormation. N9):: at this timeD $reeNA"1 on%: su ".1.2 orts one user account +or accessin' the administrati.e 3!I.
Set t e Ad3inistrati+e :3ail Address
$reeNA"1 ro.ides an A%ert icon in the u er 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 S !sers S 4iew !sers. C%ic) the Chan'e 5;mai% =utton associated with the root user account and in ut the emai% address o+ the erson to recei.e the administrati.e emai%s. ".1." :na'le &onsole <ogging
<o .iew s:stem messa'es within the 'ra hica% administrati.e inter+aceD 'o to ":stem S "ettin's S Ad.anced. Chec) the =o6 P"how conso%e messa'es in the +ooterQ and c%ic) "a.e. <he out ut o+ tail ?f F+arFlogF3essages 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 out ut 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' ste s in their %isted order.
Page #9 of 276
".1.#
&onfigure Storage
$reeNA"1 su orts the creation o+ =oth !$" and 0$" .o%umesM 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 de endin' u on :our stora'e reEuirements and whether or not data a%read: e6ists on the dis)AsB. <he +o%%owin' o tions are a.ai%a=%eK 1. Auto;im ort an e6istin' !$" dis)D 'stri e ARAI(0BD 'mirror ARAI(1BD or 'raid3 ARAI(3B in "tora'e S 4o%umes S Auto Im ort 4o%ume. 2. Auto;im ort an e6istin' 0$" dis)D stri eD mirrorD RAI(01D RAI(02D or RAI(03 in "tora'e S 4o%umes S Auto Im ort 4o%ume. Auto;im ortin' is descri=ed in more detai% in Auto Im ortin' 4o%umes. 3. Im ort a dis) that is +ormatted with !$"D N<$"D M"(-"D or 57<2 in "tora'e S 4o%umes S Im ort 4o%ume. <his is descri=ed in more detai% in Im ortin' 4o%umes. &. $ormat dis)AsB with !$" and o tiona%%: create a 'stri e ARAI(0BD 'mirror ARAI(1BD or 'raid3 ARAI(3B in "tora'e S 4o%umes S !$" 4o%ume Mana'er. *. $ormat dis)AsB with 0$" and o tiona%%: create a stri eD mirrorD RAI(01D RAI(02D or RAI(03 in "tora'e S 4o%umes S 0$" 4o%ume Mana'er. I+ :ou +ormat :our dis)AsB with 0$"D additiona% o tions are a.ai%a=%eK 1. (i.ide the 0$" oo% into datasets to ro.ide more +%e6i=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 e6tent. 0.o% creation is descri=ed in Creatin' a 8.o%. ".1.$ &reate UsersFGrou!s or Integrate /it A6F<6AP orts a .ariet: o+ user access scenariosK
$reeNA"1 su
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 'rou s where each 'rou has access to their own .o%ume or 0$" dataset the im ort o+ e6istin' 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%#/ de endin' u on whether or not the networ) has an e6istin' - en9(A> or Acti.e (irector: domain. - en9(A> and Acti.e (irector: are mutua%%: e6c%usi.eD meanin' that :ou can not use =oth =ut must choose one or the other. 1. Manua%%: create users and 'rou s. !ser mana'ement is descri=ed in !sers and 'rou mana'ement is descri=ed in 3rou s. 2. Im ort e6istin' Acti.e (irector: account in+ormation usin' the instructions in Acti.e (irector:. 3. Im ort e6istin' - en9(A> account in+ormation usin' the instructions in 9(A>.
Page $1 of 276
".1.6
&onfigure Per3issions
"ettin' ermissions is an im ortant as ect o+ con+i'urin' access to stora'e data. <he 'ra hica% 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 o eratin' 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%% a ear in "tora'e S 4o%umes. 5ach .o%ume and dataset wi%% ha.e its own Chan'e >ermissions o tionD a%%owin' +or 'reater +%e6i=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.7 &onfigure S aring
-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 su orts 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 de ends u on the o eratin' s:stemAsB runnin' in :our networ)D :our securit: reEuirementsD and e6 ectations +or networ) trans+er s eeds. <he +o%%owin' t: es o+ shares and ser.ices are a.ai%a=%eK A!!le IAFPG: $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 com uters run Mac -" 7. Con+i'uration e6am %es can =e +ound in section /.1. Uni, INFSG: this t: e o+ share is accessi=%e =: Mac -" 7D 9inu6D #"(D and ro+essiona%@enter rise .ersions o+ Windows. It is a 'ood choice i+ there are man: di++erent o eratin' s:stems in :our networ). Con+i'uration e6am %es can =e +ound in section /.2. -indo/s I&IFSG: $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 9inu6D and #"( com utersD =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 e6am %es can =e +ound in section /.3. F)P: this ser.ice ro.ides +ast access +rom an: o eratin' s:stemD usin' a cross; %at+orm $<> and +i%e mana'er c%ient a %ication such as $i%e8i%%a. $reeNA"1 su orts encr: tion and chroot +or $<>. Con+i'uration e6am %es can =e +ound in section 2.,. SS%: this ser.ice ro.ides encr: ted connections +rom an: o eratin' s:stem usin' ""H command %ine uti%ities or the 'ra hica% Win"C> a %ication +or Windows c%ients. Con+i'uration e6am %es can =e +ound in section 2.12. iS&SI: $reeNA"1 uses ist't to e6 ort .irtua% dis) dri.es that are accessi=%e to c%ients runnin' i"C"I initiator so+tware. Con+i'uration e6am %es can =e +ound in section 2./. ".1.( Start A!!lica'le Ser+iceIsG
-nce :ou ha.e con+i'ured :our share or ser.iceD :ou wi%% need to start its associated ser.iceAsB in order FreeNAS 9.1.1 Users Guide Page $1 of 276
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 S 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 e6am %eD use Windows 56 %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.11 5ac7u! t e &onfiguration
-nce :ou ha.e tested :our con+i'urationD =e sure to =ac) it u . 3o to ":stem S "ettin's and c%ic) the "a.e Con+i' =utton. Four =rowser wi%% ro.ide an o tion 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 mana'e the account used to %o' into the 3!I administrati.e inter+ace and how to manua%%: create users and 'rou s usin' the $reeNA"1 3!I. ".2.1 Ad3in Account
#: de+au%tD no assword is reEuired to access the $reeNA"1 administrati.e inter+ace usin' the =ui%t;in admin account. $or securit: reasonsD :ou shou%d immediate%: chan'e the de+au%t administrati.e account name and set a assword +or that account. <o chan'e the administrati.e account nameD 'o to Account S Admin Account S Chan'e Admin !ser. <his wi%% o en the screen shown in $i'ure 3.2a. Re %ace admin with the name o+ the account that wi%% =e used to %o'in to the $reeNA"1 'ra hica% administrati.e inter+ace. <he P$irstQ and P9astQ name +ie%ds are o tiona%. C%ic) the PChan'e Admin !serQ =utton to sa.e :our chan'es. N9):: in $reeNA"1 the administrati.e account is %ot the $a(e as the root user account. <he administrati.e account is used to access the 'ra hica% administrati.e inter+ace. <his se aration ma)es it ossi=%e to disa=%e root %o'ins whi%e maintainin' the a=i%it: o+ %o''in' into the 'ra hica% administrati.e inter+ace. <o chan'e the assword o+ the administrati.e accountD c%ic) on Account S Admin Account S Chan'e >assword. <his wi%% o en the screen shown in $i'ure 3.2=. <: e in and con+irm the assword which wi%% =e used when accessin' the 'ra hica% administrati.e inter+ace. I+ :ou wish to a%%ow root %o'ins usin' the same asswordD %ea.e the NChan'e root assword as we%%N =o6 chec)ed. !nchec) this =o6 to )ee the root user account disa=%ed.
Page $2 of 276
Figure ".2a: & anging t e FreeNAS Ad3inistrati+e Account
Figure ".2': Setting t e FreeNAS Ad3inistrati+e Pass/ord
N9):: +or securit: reasonsD the root asswordD the ""H ser.iceD and root ""H %o'ins are a%% 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 3!I. <his means that the $reeNA"1 s:stem shou%d =e )e t h:sica%%: secure and that the administrati.e 3!I shou%d =e =ehind a ro er%: con+i'ured +irewa%% and rotected =: a secure username and assword.
Page $" of 276
".2.2
Grou!s
<he 3rou s inter+ace a%%ows :ou to mana'e !NI7;st:%e 'rou s on the $reeNA"1 s:stem. N9):: i+ Acti.e (irector: or - en9(A> is runnin' on :our networ)D :ou do not need to recreate the networ)'s users or 'rou s. InsteadD im ort the e6istin' account in+ormation into $reeNA"1 usin' "er.ices S (irector: "er.ices S Acti.e (irector: or "er.ices S (irector: "er.ices S 9(A>. <his section descri=es how to create a 'rou and assi'n it user accounts. <he ne6t section wi%% descri=e how to create user accounts. I+ :ou c%ic) 3rou s S 4iew 3rou sD :ou wi%% see a screen simi%ar to $i'ure 3.2c. Figure ".2c: FreeNAS Grou!s 4anage3ent
A%% 'rou s that came with the o eratin' s:stem wi%% =e %isted. 5ach 'rou has an entr: indicatin' the 'rou I(D 'rou nameD and whether or not it is a =ui%t;in 'rou which was insta%%ed with $reeNA"1. I+ :ou c%ic) a 'rou entr:D a Mem=ers =utton wi%% a ear. C%ic) this =utton to .iew and modi+: that 'rou 's mem=ershi . + :ou c%ic) the Add 3rou =uttonD :ou wi%% see the screen shown in $i'ure 3.2d. <a=%e 3.2a summari8es the a.ai%a=%e o tions when creatin' a 'rou .
Page $# of 276
Figure ".2d: &reating a Ne/ Grou!
)a'le ".2a: 9!tions - en &reating a Grou! Setting 3rou I( 3rou Name A%%ow re eated 3I(s @alue strin' 6escri!tion the ne6t a.ai%a=%e 'rou I( wi%% =e su''ested +or :ouM =: con.entionD !NI7 'rou s containin' user accounts ha.e an I( 'reater than 1000 and 'rou s 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 mandator: a%%ows mu%ti %e 'rou s to share the same 'rou idM this is use+u% when a 3I( is a%read: associated with the !NI7 ermissions +or e6istin' data
strin' chec)=o6
-nce the 'rou and users are createdD :ou can assi'n users as mem=ers o+ a 'rou . C%ic) on 4iew 3rou s 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 a ear in the ri'ht +rame wi%% =e added as mem=ers o+ that 'rou . In the e6am %e shown in $i'ure 3.2eD 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 . <o de%ete a 'rou D c%ic) its (e%ete 3rou =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 'rou s do not ro.ide a (e%ete 3rou =utton. FreeNAS 9.1.1 Users Guide Page $$ of 276
Figure ".2e: Assigning a User as a 4e3'er of a Grou!
".2."
Users
$reeNA"1 su orts usersD 'rou sD and ermissionsD a%%owin' 'reat +%e6i=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 com uter. $or e6am %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 'rou s o+ users di++erent ermissions to sharesD :ou wi%% need to a%so create 'rou s and assi'n users to the 'rou s. 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 'rou s to mana'e ermissionsD :ou shou%d create the user accounts +irstD then assi'n the accounts as mem=ers o+ the 'rou s. <his section demonstrates how to create a user account. N9):: i+ Acti.e (irector: or - en9(A> is runnin' on :our networ)D :ou do not need to recreate the networ)'s users or 'rou s. InsteadD im ort the e6istin' account in+ormation into $reeNA"1 usin' "er.ices S Acti.e (irector: or "er.ices S 9(A>. Account S !sers S 4iew !sers ro.ides a %istin' o+ a%% o+ the s:stem accounts that were insta%%ed with the $reeNA"1 o eratin' s:stemD as shown in $i'ure 3.2+.
Page $6 of 276
Figure ".2f: 4anaging User Accounts
5ach account entr: indicates the user I(D usernameD 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 and whether or not the user account is %oc)ed. <o reorder the %istD c%ic) the desired co%umn. I+ :ou c%ic) a user accountD the +o%%owin' =uttons wi%% a ear +or that accountK & ange Pass/ord: 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% 'rou s. & ange :?3ail: used to chan'e the emai% address associated with the account. N9):: it is im ortant to set the emai% address +or the =ui%t;in root user account as im ortant 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. 5.er: account that came with the $reeNA"1 o eratin' s:stemD e6ce t +or the root userD is a s:stem account. 5ach 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'inA2B. $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 o en the screen shown in $i'ure 3.2'. "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 =o6 P"how ad.anced +ie%ds =: de+au%tQ in ":stem S "ettin's S Ad.anced. <a=%e 3.2= summari8es the o tions which are a.ai%a=%e when :ou create or modi+: a user account.
Page $7 of 276
Figure ".2g: Adding or :diting a User Account
)a'le ".2': User Account &onfiguration Setting !ser I( @alue 6escri!tion 're:ed out i+ user a%read: createdM when creatin' an accountD the ne6t numeric I( wi%% =e su''estedM =: con.entionD user accounts inte'er 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 're:ed out i+ user a%read: createdM ma6imum 32 characters to a%%ow strin' +or %on'er A( names thou'h a ma6imum o+ 2 is recommended +or intero era=i%it:M can inc%ude numera%s =ut can not inc%ude a s ace =: de+au%tD a rimar: 'rou with the same name as the user wi%% =e createdM unchec) this =o6 to se%ect a di++erent rimar: 'rou name chec)=o6 AN9):K in !ni6D a rimar: 'rou is not the same as a secondar:@au6i%iar: 'rou B must unchec) NCreate a new rimar: 'rou N in order to access this menuM +or securit: reasonsD $ree#"( wi%% not 'i.e a user su dro ;down ermissions i+ <heel is their rimar: 'rou ;;i+ :our intent is to menu 'i.e a user su accessD add them to the <heel 'rou in the Au6i%iar: 'rou s section %ea.e as 7none(istent +or s:stem accountsD otherwise =rowse to the =rowse =utton name o+ an exi$ti%# .o%ume or dataset that the user wi%% =e assi'ned ermission to access Page $( of 276
!sername
Create a new rimar: 'rou
>rimar: 3rou
Home (irector:
Setting Home (irector: Mode "he%% $u%% Name 5;mai% >assword >assword con+irmation
@alue chec)=o6es dro ;down menu strin' strin' strin' strin'
6escri!tion on%: a.ai%a=%e in Ad.anced Mode and wi%% =e read;on%: +or =ui%t;in usersM sets de+au%t ermissions o+ user's home director: i+ creatin' a s:stem accountD choose nologinM i+ creatin' a user accountD se%ect she%% o+ choice mandator:D ma: contain s aces emai% address associated with the account mandator: un%ess chec) =o6 to disa=%e assword %o'ins must match 6ass<ord chec) this =o6 +or s:stem accounts and +or user accounts who are not a%%owed to %o'in to the $reeNA"1 s:stem usin' assword authenticationM to undo this settin'D set a assword +or the user usin' the PChan'e >asswordQ =utton +or the user in P4iew !sersQ aste the user's "!blic )e: to =e used +or ""H )e: authentication Ado %ot "a$te the "ri'ate 0e)9B a chec)ed =o6 re.ents user +rom %o''in' in unti% the account is un%oc)ed A=o6 is unchec)edB hi'h%i'ht the 'rou AsB :ou wish to add the user to and use the VV =utton to add the user to the hi'h%i'hted 'rou s
(isa=%e assword chec)=o6 %o'ins ""H >u=%ic Ke: 9oc) user Au6i%iar: 'rou s strin' chec)=o6 mouse se%ection
S*ste3 &onfiguration
&ron Jo's: ro.ides a 'ra hica% +ront;end to cronta=A*B InitFS utdo/n Scri!ts: used to con+i'ure a command or scri t to automatica%%: e6ecute durin' s:stem startu or shutdown N)P Ser+ers: used to con+i'ure N<> ser.er settin's 2e!orting: ro.ides re orts and 'ra hs monitorin' the s:stem's C>!D dis) ca acit: and other metrics 2s*nc )as7s: 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% setu D 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 o eratin' s:stem .ersionD %at+ormD and u time
<he ":stem section o+ the administrati.e 3!I contains the +o%%owin' entriesK
Page $9 of 276
)una'les: ro.ides a +ront;end to %oad additiona% )erne% modu%es at =oot time 5ach o+ these is descri=ed in more detai% in this section.
#.1
&ron Jo's
cronA2B is a daemon that runs a command or scri t on a re'u%ar schedu%e as a s eci+ied user. <: ica%%:D the user who wishes to schedu%e a tas) manua%%: creates a cronta=A*B usin' s:nta6 that can =e er %e6in' to new !ni6 users. <he $reeNA"1 3!I ma)es it eas: to schedu%e when :ou wou%d %i)e the tas) to occur. N9):: due to a %imitation in $ree#"(D users with account names that contain s aces or e6ceed 1/ characters are una=%e to create cron Io=s. $i'ure &.1a shows the screen that o ens when :ou c%ic) ":stem S Cron Co=s S Add Cron Co=. Figure #.1a: &reating a &ron Jo'
<a=%e &.1a summari8es the con+i'ura=%e o tions when creatin' a cron Io=. )a'le #.1a: &ron Jo' 9!tions Setting !ser Command @alue dro ;down menu strin' 6escri!tion ma)e sure the se%ected user has ermission to run the s eci+ied command or scri t the *!ll "ath to the command or scri t to =e runM i+ it is a scri tD test it at the command %ine +irst to ma)e sure that it wor)s as e6 ected Page 61 of 276
Setting "hort descri tion
@alue strin'
6escri!tion o tiona%
s%ider or i+ use the s%iderD cron Io= occurs e.er: N minutesM i+ use minute Minute minute se%ectionsD cron Io= occurs at the hi'h%i'hted minutes se%ections s%ider or hour i+ use the s%iderD cron Io= occurs e.er: N hoursM i+ use hour se%ectionsD Hour se%ections cron Io= occurs at the hi'h%i'hted hours s%ider or i+ use the s%iderD cron Io= occurs e.er: N da:sM i+ use da: se%ectionsD (a: o+ month month cron Io= occurs on the hi'h%i'hted da:s each month se%ections Month chec)=o6es cron Io= occurs on the se%ected months (a: o+ wee) chec)=o6es cron Io= occurs on the se%ected da:s Redirect "tdout chec)=o6 disa=%es emai%in' standard out ut to the root user account Redirect "tderr chec)=o6 disa=%es emai%in' errors to the root user account 5na=%ed chec)=o6 unchec) i+ :ou wou%d %i)e to disa=%e the cron Io= without de%etin' it
#.2
InitFS utdo/n Scri!ts

or
$reeNA"1 9.1.0 added the a=i%it: to schedu%e commands or scri ts to run at s:stem startu shutdown.
$i'ure &.2a shows the screen that o ens when :ou c%ic) ":stem S Init@"hutdown "cri ts S Add Init@"hutdown "cri t. <a=%e &.2a summari8es the a.ai%a=%e o tions. 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 / ic co33and8na3e. I+ the command is not +oundD it is not in :our ath. When schedu%in' a scri tD ma)e sure that the scri t is e6ecuta=%e and has =een +u%%: tested to ensure that it achie.es the desired resu%ts.
Page 61 of 276
Figure #.2a: Add an InitFS utdo/n Scri!t
)a'le #.2a: 9!tions - en Adding an InitFS utdo/n Scri!t Setting 6escri!tion se%ect +rom "ommand A+or an e6ecuta=%eB or S'ri3t A+or an e6ecuta=%e <: e dro ;down menu she%% scri tB i+ "ommand is se%ectedD in ut the command %us an: desired o tionsM i+ Command strin' S'ri3t is se%ectedD =rowse to the %ocation o+ the scri t se%ect when the command@scri t wi%% runM choices are 6re 2nit A.er: ear%: <: e dro ;down menu in =oot rocess =e+ore +i%es:stems are mountedBD 6ost 2nit Atowards end o+ =oot rocess =e+ore $reeNA" ser.ices are startedBD or Sh!tdo<n @alue
#."
N)P Ser+ers
<he networ) time rotoco% AN<>B is used to s:nchroni8e the time on the com uters in a networ). Accurate time is necessar: +or the success+u% o eration 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 P5ditQ =utton. A%ternate%:D :ou can de%ete the de+au%t N<> ser.ers and c%ic) PAdd N<> "er.erQ to create :our own. $i'ure &.3= shows the PAdd N<> "er.erQ screen and <a=%e &.3a summari8es the o tions when addin' or editin' an N<> ser.er. nt .con+A*B e6 %ains these o tions in more detai%.
Page 62 of 276
Figure #."a: 6efault N)P &onfiguration
Figure #."': Add or :dit a N)P Ser+er
)a'le #."a: N)P Ser+er 9!tions Setting Address #urst I#urst @alue strin' 6escri!tion name o+ N<> ser.er recommended when =a(. 6oll is 'reater than 10M on%: use on :our own ser.ers chec)=o6 i.e. do %ot use with a u=%ic N<> ser.er chec)=o6 s eeds the initia% s:nchroni8ation Aseconds instead o+ minutesB Page 6" of 276
Setting
6escri!tion shou%d on%: =e used +or N<> ser.ers that are )nown to =e hi'h%: accurateD such >re+er chec)=o6 as those with time monitorin' hardware Min. >o%% inte'er ower o+ 2 in secondsM can not =e %ower than > or hi'her than =a(. 6oll Ma6. >o%% inte'er ower o+ 2 in secondsM can not =e hi'her than 1; or %ower than =in. 6oll $orce chec)=o6 +orces the addition o+ the N<> ser.erD e.en i+ it is current%: unreacha=%e
@alue
#.#
2e!orting
":stem S Re ortin' dis %a:s se.era% 'ra hsD as seen in the e6am %e in $i'ure &.&a. Figure #.#a: 2e!orting Gra! s
$reeNA"1 uses co%%ectd to ro.ide re ortin' statistics. <he +o%%owin' co%%ectd %u'ins are ena=%ed in 7'onf7$ase7et'7lo'al7'olle'td.'onfD and thus ro.ide re ortin' 'ra hsK s:stem %oadK 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. rocessesK dis %a:s the num=er o+ rocessesD 'rou ed =: state. dis) s aceK dis %a:s +ree and used s ace +or each .o%ume and dataset. Howe.erD the dis) s ace used =: an indi.idua% 8.o% is not dis %a:ed as it is a =%oc) de.ice. u timeK )ee s trac) o+ the s:stem u timeD the a.era'e runnin' timeD and the ma6imum reached u time. C>! usa'eK co%%ects the amount o+ time s ent =: the C>! in .arious states such as e6ecutin' user codeD e6ecutin' s:stem codeD and =ein' id%e. swa uti%i8ationK dis %a:s the amount o+ +ree and used swa s ace. FreeNAS 9.1.1 Users Guide Page 6# of 276
h:sica% memor:K dis %a:s h:sica% memor: usa'e. er second +or each con+i'ured
inter+aceK shows recei.ed and transmitted tra++ic in =its inter+ace.
Re ortin' data is sa.edD a%%owin' :ou to .iew and monitor usa'e trends o.er time. Re ortin' data is sa.ed to 7data7rrd*dir.tar.$42 and shou%d =e reser.ed across s:stem u 'rades and at shutdown. !se the ma'ni+ier =uttons ne6t to each 'ra h 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 WW and VV =uttons to scro%% throu'h the out ut.
#.$
2s*nc )as7s
Rs:nc is a uti%it: that automatica%%: co ies s eci+ied data +rom one s:stem to another o.er a networ). -nce the initia% data is co iedD 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)u sD 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 t e rs*nc ser+er: this s:stem u%%s Arecei.esB the data. <his s:stem is re+erred to as 61-- in the con+i'uration e6am %es. t e rs*nc client: this s:stem ushes AsendsB the data. <his s:stem is re+erred to as 61S? in the con+i'uration e6am %es. $reeNA"1 can =e con+i'ured as either an rs:nc c%ient or an rs:nc ser.er. <he o osite 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 su orts two modes o+ rs:nc o erationK rs*nc 3odule 3ode: e6 orts 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 3!I under "er.ices S Rs:nc S Rs:nc Modu%es. In other o eratin' 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 o tions when creatin' an Rs:nc <as). It then ro.ides a con+i'uration e6am %e =etween two $reeNA"1 s:stems +or each mode o+ rs:nc o eration. #.$.1 &reating an 2s*nc )as7
$i'ure &.*a shows the screen that a ears when :ou c%ic) ":stem S Rs:nc <as)s S Add Rs:nc <as). <a=%e &.*a summari8es the o tions that can =e con+i'ured when creatin' an rs:nc tas).
Page 6$ of 276
Figure #.$a: Adding an 2s*nc )as7
)a'le #.$a: 2s*nc &onfiguration 9!tions Setting 6escri!tion =rowse to the .o%ume@dataset@director: that :ou wish to co :M note >ath =rowse =utton 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 on%: a.ai%a=%e in &syn' mod!le modeM a%%ows :ou to s eci+: an inte'er >ort a%ternate ""H ort other than the de+au%t o+ 22 dro ;down Rs:nc mode choices are &syn' mod!le or &syn' o#er SS? menu when usin' &syn' mod!le modeD at %east one modu%e must =e de+ined Remote Modu%e in rs:ncd.con+A*B o+ rs:nc ser.er or in "er.ices S Rs:nc S Rs:nc Name @ Remote strin' Modu%es o+ another $reeNA"1 s:stemM when usin' &syn' o#er SS? >ath modeD in ut the ath on the remote host to ush or u%% Ae.'. 7mnt7#ol!meB dro ;down choices are 6!sh or 6!llM de+au%t is to ush +rom the $reeNA"1 (irection menu s:stem to a remote host "hort strin' o tiona% (escri tion FreeNAS 9.1.1 Users Guide Page 66 of 276 @alue
Setting Minute Hour (a: o+ month Month (a: o+ wee) !ser Recursi.e <imes Com ress
@alue s%ider or minute se%ections s%ider or hour se%ections s%ider or da: se%ections chec)=o6es chec)=o6es dro ;down menu chec)=o6 chec)=o6 chec)=o6
6escri!tion i+ use the s%iderD s:nc occurs e.er: N minutesM i+ use minute se%ectionsD s:nc occurs at the hi'h%i'hted minutes i+ use the s%iderD s:nc occurs e.er: N hoursM i+ use hour se%ectionsD s:nc occurs at the hi'h%i'hted hours i+ use the s%iderD s:nc occurs e.er: N da:sM i+ use da: se%ectionsD s:nc occurs on the hi'h%i'hted da:s tas) occurs on the se%ected months tas) occurs on the se%ected da:s o+ the wee) s eci+ied user must ha.e ermission to write to the s eci+ied director: on the remote s:stemM due to a %imitation in $ree#"(D the user name can not contain s aces or e6ceed 1/ characters i+ chec)edD co : wi%% inc%ude a%% su=directories o+ the s eci+ied .o%ume reser.e modi+ication times o+ +i%es recommended on s%ow connections as reduces si8e o+ data to =e transmitted eEui.a%ent to ?rl!tgo6 Arecursi.eD co : s:m%in)s as s:m%in)sD reser.e ermissionsD reser.e modi+ication timesD reser.e 'rou D reser.e owner Asu er;user on%:BD and reser.e de.ice +i%es Asu er; user on%:B and s ecia% +i%esB de%ete +i%es in destination director: that don't e6ist in sendin' director: su resses in+ormationa% messa'es +rom the remote ser.er reser.es ori'ina% +i%e ermissionsM use+u% i+ !ser is set to root =oth s:stems must su ort e6tended attri=utes
Archi.e
chec)=o6
(e%ete ?uiet >reser.e ermissions >reser.e e6tended attri=utes 56tra o tions 5na=%ed
chec)=o6 chec)=o6 chec)=o6 chec)=o6 strin' chec)=o6
rs:ncA1B o tions not co.ered =: the 3!I 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 in ut --3ass<ord-file@76AA?A+7F2-.NA=. in the N56tra o tionsN =o6D re %acin' 76AA?A+7F2-.NA=. with the a ro riate ath to the +i%e containin' the .a%ue o+ the assword. #.$.2 &onfiguring 2s*nc 4odule 4ode 5et/een )/o FreeNAS S*ste3s
<his con+i'uration e6am %e wi%% con+i'ure rs:nc modu%e mode =etween the two +o%%owin' $reeNA"1 s:stemsK FreeNAS 9.1.1 Users Guide Page 67 of 276
192.1:,.2.2 has e6istin' data in 7mnt7lo'al7images. 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 61S?. 192.1:,.2.: has an e6istin' .o%ume named 7mnt7remote. It wi%% =e the rs:nc ser.erD meanin' that it wi%% recei.e the contents o+ 7mnt7lo'al7images. 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 61--. -n 61S?D an rs:nc tas) is de+ined in ":stem S Rs:nc <as)s S Add Rs:nc <as) as shown in $i'ure &.*=. In this e6am %eK the >ath oints to 7!sr7lo'al7imagesD the director: to =e co ied the Remote Host oints to 192.1:,.2.:D 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!3sM this wi%% need to =e de+ined on the rs:nc ser.er the (irection is 6!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)=o6 is chec)ed so that the ori'ina% o.erwritten =: the root user ermissions are not
-n 61--D an rs:nc modu%e is de+ined in "er.ices S Rs:nc Modu%es S Add Rs:nc Modu%eD shown in $i'ure &.*c. In this e6am %eK the Modu%e Name is $a'k!3sM this needs to match the settin' on the rs:nc c%ient the >ath is 7mnt7remoteM a director: ca%%ed images wi%% =e created to ho%d the contents o+ 7!sr7lo'al7images the !ser is set to root so it has ermission to write an:where Hosts a%%ow is set to 192.1:,.2.2D the I> address o+ the rs:nc c%ient (escri tions o+ the con+i'ura=%e o tions can =e +ound in Rs:nc Modu%es. <o +inish the con+i'urationD start the rs:nc ser.ice on 61-- in "er.ices S Contro% "er.ices. I+ the rs:nc is success+u%D the contents o+ 7mnt7lo'al7images7 wi%% =e mirrored to 7mnt7remote7images7.
Page 6( of 276
Figure #.$': &onfiguring t e 2s*nc &lient
Figure #.$c: &onfiguring t e 2s*nc Ser+er
Page 69 of 276
#.$."
&onfiguring 2s*nc o+er SS% 4ode 5et/een )/o 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 61S? and the u=%ic )e: co ied to the same user account on 61- to miti'ate the ris) o+ man;in;the;midd%e attac)sD the u=%ic host )e: o+ 61-- must =e co ied to 61S? the ""H ser.ice must =e runnin' on 61-<o create the u=%ic@ ri.ate )e: air +or the rs:nc user accountD o en "he%% on 61S?. <he @ +i%es:stem must +irst =e mounted as read;write. <he +o%%owin' e6am %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 ass hrase 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 su orts the +o%%owin' t: es o+ ""H )e:sK ("AD and R"A. When creatin' the )e:D s eci+: the t: e :ou wish to use orD i+ :ou are 'eneratin' the )e: on another o eratin' s:stemD se%ect a t: e o+ )e: the )e: 'eneration so+tware su orts. N9):: 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 e6am %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
Page 71 of 276
Ne6tD .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
3o to 61-- and aste Aor a endB the co ied )e: into the ""H >u=%ic Ke: +ie%d o+ Account S !sers S 4iew !sers S root Aor the s eci+ied rs:nc user accountB S Modi+: !ser. <he aste +or the a=o.e e6am %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: e6tra s aces re resentin' %ine =rea)s. Figure #.$d: Pasting t e User.s SS% Pu'lic 0e*
Whi%e on 61--D .eri+: that the ""H ser.ice is runnin' in "er.ices S Contro% "er.ices and start it i+ it is not. Ne6tD co : the host )e: o+ 61-- usin' "he%% on 61S?. <he +o%%owin' command co ies the R"A host )e: o+ the 61-- ser.er used in our re.ious e6am %e. #e sure to inc%ude the dou=%e =rac)et BB to re.ent o.erwritin' an: e6istin' entries in the kno<n*hosts +i%e.
ssh-keyscan -t rsa 192.168.2.6 >> /root/.ssh/known_hosts
Fou are now read: to create the rs:nc tas) on 61--. <o con+i'ure rs:nc ""H mode usin' the s:stems in our re.ious e6am %eD the con+i'uration wou%d =e as +o%%owsK the >ath oints to 7mnt7lo'al7imagesD the director: to =e co ied the Remote Host oints to 192.1:,.2.:D 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:whereM the u=%ic )e: +or this user must FreeNAS 9.1.1 Users Guide Page 71 of 276
=e 'enerated on 61S? and co ied to 61- the 6reser#e 6ermissions chec)=o6 is chec)ed so that the ori'ina% o.erwritten =: the root user ermissions are not
-nce :ou sa.e the rs:nc tas)D the rs:nc wi%% automatica%%: occur accordin' to :our schedu%e. In this e6am %eD the contents o+ 7mnt7lo'al7images7 wi%% automatica%%: a ear in 7mnt7remote7images7 a+ter 1* minutes. I+ the content does not a earD use "he%% on 61-- to read 7#ar7log7messages. I+ the messa'e indicates a 5n Anew%ine characterB in the )e:D remo.e the s ace in :our asted )e:;;it wi%% =e a+ter the character that a ears Iust =e+ore the 5n in the error messa'e.
#.6
S.4.A.2.). )ests
".M.A.R.<. A"e%+;Monitorin'D Ana%:sis and Re ortin' <echno%o':B is a monitorin' s:stem +or com uter hard dis) dri.es to detect and re ort on .arious indicators o+ re%ia=i%it:. When a +ai%ure is antici ated =: ".M.A.R.<.D the dri.e shou%d =e re %aced. Most modern A<AD I(5 and "C"I;3 hard dri.es su ort ".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 a ears when :ou c%ic) ":stem S ".M.A.R.<. <ests S Add ".M.A.R.<. <est. <he tests that :ou create wi%% =e %isted under 4iew ".M.A.R.<. <ests. A+ter creatin' :our testsD chec) the con+i'uration in "er.ices S ".M.A.R.<.D then c%ic) the s%ider to -N +or the ".M.A.R.<. ser.ice in "er.ices S Contro% "er.ices. )he ".M.A.R.<. ser.ice wi%% not start i+ :ou ha.e not created an: .o%umes. N9):: 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 .
Page 72 of 276
Figure #.6a: Adding a S.4.A.2.). )est
<a=%e &.,a summari8es the con+i'ura=%e o tions when creatin' a ".M.A.R.<. test. )a'le #.6a: S.4.A.2.). )est 9!tions Setting (is) <: e "hort descri tion Hour (a: o+ month Month (a: o+ wee) @alue %ist 6escri!tion hi'h%i'ht dis)AsB to monitor se%ect t: e o+ test to runM see smartct%A2B +or a descri tion o+ each dro ;down menu t: e o+ test Anote that some test t: es wi%% de'rade er+ormance or ta)e dis)AsB o++%ineB strin' s%ider or hour se%ections s%ider or da: se%ections chec)=o6es chec)=o6es o tiona% i+ use the s%iderD test occurs e.er: N hoursM i+ use hour se%ectionsD test occurs at the hi'h%i'hted hours i+ use the s%iderD test occurs e.er: N da:sM i+ use da: se%ectionsD test occurs on the hi'h%i'hted da:s se%ect the months when :ou wish the test to occur 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 ?C s o/tests within "he%%. FreeNAS 9.1.1 Users Guide Page 7" of 276
#.7
Settings
<he "ettin's ta=D shown in $i'ure &./aD contains & ta=sK 3enera%D Ad.ancedD 5mai%D and ""9. Figure #.7a: General )a' of Settings
#.7.1
General )a'
<a=%e &./a summari8es the settin's that can =e con+i'ured usin' the 3enera% ta=K )a'le #.7a: General )a'.s &onfiguration Settings Setting >rotoco% @alue 6escri!tion rotoco% to use when connectin' to the administrati.e 3!I +rom a =rowserM i+ dro ;down :ou chan'e the de+au%t o+ ?AA6 to ?AA6SD an unsi'ned certi+icate and R"A menu )e: wi%% =e 'enerated and :ou wi%% =e %o''ed out in order to acce t the certi+icate choose +rom a %ist o+ recent I> addresses to %imit the one to use when dro ;down accessin' the administrati.e 3!IM the =ui%t;in H<<> ser.er wi%% automatica%%: menu =ind to the wi%dcard address o+ 0.0.0.0 Aan: addressB and wi%% issue an a%ert i+ the s eci+ied address =ecomes una.ai%a=%e Page 7# of 276
We=3!I I>.& Address
Setting We=3!I I>., Address We=3!I >ort 9an'ua'e Conso%e Ke:=oard Ma <ime8one ":s%o' ser.er (irector: "er.ice
@alue
6escri!tion choose +rom a %ist o+ recent I>., addresses to %imit the one to use when dro ;down accessin' the administrati.e 3!IM the =ui%t;in H<<> ser.er wi%% automatica%%: menu =ind to the wi%dcard address o+ )) Aan: addressB and wi%% issue an a%ert i+ the s eci+ied address =ecomes una.ai%a=%e a%%ows :ou to con+i'ure a non;standard ort +or accessin' the administrati.e inte'er 3!I M chan'in' this settin' ma: reEuire :ou to chan'e a +ire+o6 con+i'uration settin' dro ;down se%ect the %oca%i8ation +rom the dro ;down menu and re%oad the =rowserM :ou menu can .iew the status o+ %oca%i8ation at oot%e.+reenas.or' dro ;down se%ect the )e:=oard %a:out menu dro ;down se%ect the time8one +rom the dro ;down menu menu I> address or hostname o+ remote s:s%o' ser.er to send $reeNA"1 %o's toM strin' once setD %o' entries wi%% =e written to =oth the $reeNA"1 conso%e and the remote ser.er can se%ect one o+ A'ti#e ire'tory8 - A68 N2SD or NA>M i+ a ser.ice is dro ;down se%ectedD an entr: named ire'tory Ser#i'es wi%% =e added to "er.ices S menu Contro% "er.ices +or mana'in' that se%ected ser.ice
N9):: =: de+au%tD %o's are stored in RAM as there is no s ace 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 either con+i'ure a remote s:s%o' ser.erD create a scri t to store the %o's on a .o%ume and add the scri t as a cron Io=D or use the $reeNA";Chan'e;9o''in' scri t. 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 o tion 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 scri t to =ac)u the con+i'uration which cou%d =e customi8ed and added as a cron Io=. <his +orum ost contains an a%ternate scri t which on%: sa.es a co : o+ the con+i'uration when it chan'es. And this +orum ost contains a scri t +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.
Page 7$ of 276
#.7.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 #.7': Ad+anced )a'
)a'le #.7': Ad+anced )a'.s &onfiguration Settings Setting 5na=%e Conso%e Menu !se "eria% Conso%e "eria% >ort " eed 5na=%e screen sa.er 5na=%e owerd A>ower "a.in' (aemonB "wa si8e @alue chec)=o6 chec)=o6 dro ;down menu chec)=o6 chec)=o6 non;8ero inte'er re resentin' 3# 6escri!tion unchec)in' this =o6 remo.es the conso%e menu shown in $i'ure 2.*a do %ot chec) this =o6 i+ :our seria% ort is disa=%ed se%ect the s eed used =: the seria% ort ena=%es@disa=%es the conso%e screen sa.er owerdA2B is used to monitor AC>I ower contro% settin'sM this +orum ost demonstrates how to determine i+ a dri.e has s un down a++ects new dis)s on%: wi%% dis %a: conso%e messa'es in rea% time at =ottom o+ =rowserM c%ic) the conso%e to =rin' u a scro%%a=%e screenM chec) the N"to re+reshN =o6 in the scro%%a=%e screen to ause u datin' and unchec) the =o6 to continue to watch the messa'es as the: occur Page 76 of 276
"how conso%e messa'es in chec)=o6 the +ooter
Setting @alue "how trace=ac)s in case o+ chec)=o6 +ata% errors "how ad.anced +ie%ds =: de+au%t 5na=%e autotune 5na=%e de=u' )erne% M-<( =anner chec)=o6
chec)=o6 chec)=o6 strin'
6escri!tion ro.ides a o ;u o+ dia'nostic in+ormation when a +ata% error occurs se.era% 3!I menus ro.ide an Ad.anced Mode =utton to access additiona% +eaturesM ena=%in' this shows these +eatures =: de+au%t ena=%es the autotune scri t which attem ts to o timi8e the s:stem de endin' u on the hardware which is insta%%ed i+ chec)edD ne6t =oot wi%% =oot into a de=u' .ersion o+ the )erne% in ut 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 <6APFA6 &ac e: c%ic) i+ :ou add a user to Acti.e (irector: who needs immediate access to $reeNA"1M otherwise this occurs automatica%%: once a da: as a cron Io=. Sa+e 6e'ug: used to 'enerate a te6t +i%e o+ dia'nostic in+ormation. In the screen shown in $i'ure &./cD chec) the =o6AesB +or the in+ormation that :ou wish to 'enerate then c%ic) the "a.e =utton to =e rom ted +or the %ocation to sa.e the 'enerated A"CII te6t +i%e. Fir3/are U!date: used to ! 'rade $reeNA"1.
Page 77 of 276
Figure #.7c: Sa+e 6e'ug Screen
!.(.2.1
Autotune
$reeNA"1 ro.ides an autotune scri t which attem ts to o timi8e the s:stem de endin' u on the hardware which is insta%%ed. $or e6am %eD i+ a 0$" .o%ume e6ists on a s:stem with %imited RAMD the autotune scri t wi%% automatica%%: adIust some 0$" s:sct% .a%ues in an attem t to minimi8e 0$" memor: star.ation issues. <he N5na=%e autotuneN chec)=o6 in ":stem S "ettin's S Ad.anced is unchec)ed =: de+au%tM chec) it i+ :ou wou%d %i)e the autotuner to run at =oot time. I+ :ou wou%d %i)e the scri t 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%% a ear in ":stem S ":sct%s A+or sys'tl.'onf .a%uesB and in ":stem S <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 3!I and :our chan'es wi%% o.erride the .a%ues that were created =: the autotune scri t. Howe.erD i+ :ou de%ete a s:sct% or tuna=%e that was created =: autotuneD it wi%% =e recreated at ne6t =oot. <his is =ecause autotune on%: creates .a%ues that do not a%read: e6ist. I+ :ou are tr:in' to increase the er+ormance o+ :our $reeNA"1 s:stem and sus ect that the current hardware ma: =e %imitin' er+ormanceD tr: ena=%in' autotune. I+ :ou wish to read the scri t to see which chec)s are 7!sr7lo'al7$in7a!tot!ne. er+ormedD the scri t is %ocated in
Page 7( of 276
#.7."
:3ail )a'
<he 5mai% ta=D shown in $i'ure &./dD 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 5mai% ta=. N9):: it is im ortant to con+i'ure the s:stem so that it can success+u%%: send emai%s. An automatic scri t send a ni'ht%: emai% to the root user account containin' im ortant 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 #.7d: :3ail )a'
)a'le #.7c: :3ail )a'.s &onfiguration Settings Setting $rom emai% -ut'oin' mai% ser.er >ort to connect to <9"@""9 !se "M<> Authentication !sername >assword @alue strin' 6escri!tion the Fro( emai% address to =e used when sendin' emai% noti+ications
strin' or I> address hostname or I> address o+ "M<> ser.er inte'er dro ;down menu chec)=o6 strin' strin' "M<> ort num=erD t: ica%%: 2*D &,* Asecure "M<>BD or *2/ Asu=missionB encr: tion t: eM choices are 6lainD SS-D or A-S ena=%es@disa=%es "M<> A!<H usin' >9AIN "A"9 used to authenticate with "M<> ser.er used to authenticate with "M<> ser.er Page 79 of 276
Setting "end <est Mai%
@alue =utton
6escri!tion c%ic) to chec) that con+i'ured emai% settin's are wor)in'M this wi%% +ai% i+ :ou do not set the To emai% address =: c%ic)in' the Chan'e 5;mai% =utton +or the root account in Accounts S !sers S 4iew !sers
#.7.#
SS< )a'
When :ou chan'e the >rotoco% .a%ue to H<<>" in ":stem S "ettin's S 3enera%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 S "ettin's S ""9D shown in $i'ure &./e. 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 S 3enera% <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 e6am %es +or the .a%ues shown in <a=%e &./d. Figure #.7e: SS< )a'
Page (1 of 276
)a'le #.7d: SS< )a'.s &onfiguration Settings Setting -r'ani8ation -r'ani8ationa% !nit 5mai% Address 9oca%it: "tate Countr: Common Name >ass hrase ""9 Certi+icate @alue strin' strin' strin' strin' strin' strin' strin' 6escri!tion o tiona% o tiona% o tiona% o tiona% o tiona% o tiona% o tiona% i+ the certi+icate was created with a ass hraseD in ut and con+irm itM strin' the .a%ue wi%% a ear as dots in the 3!I strin' aste the ri.ate )e: and certi+icate into the =o6
N9):: $reeNA"1 wi%% chec) the .a%idit: o+ the certi+icate and )e: and wi%% +a%%=ac) to H<<> i+ the: a ear to =e in.a%id.
#.(
S*sctls
s:sct%A2B 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 s eci+ic needs o+ a networ). -.er +i.e hundred s:stem .aria=%es can =e set usin' s:sct%A2B. 5ach .aria=%e is )nown as a MI# as it is com rised o+ a dotted set o+ com onents. "ince these MI#s are s eci+ic to the )erne% +eature that is =ein' tunedD descri tions can =e +ound in man: $ree#"( man a'es Ae.'. s:sct%A3BD tc A&B and tunin'A/BB and in man: sections o+ the $ree#"( Hand=oo). 6ANG:2D 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) assum tions made =: the $reeNA"1 so+tware. <his means that :ou shou%d a%wa:s test the im act o+ an: chan'es on a test s:stem +irst. $reeNA"1 ro.ides a 'ra hica% inter+ace +or mana'in' s:sct% MI#s. <o add a s:sct%D 'o to ":stem S ":sct%s S Add ":sct%D shown in $i'ure &.2a.
Page (1 of 276
Figure #.(a: Adding a S*sctl
<a=%e &.2a summari8es the o tions when addin' a s:sct%. )a'le #.(a: Adding a S*sctl Setting 4aria=%e @alue strin' inte'er or 4a%ue strin' Comment strin' 5na=%ed chec)=o6 6escri!tion must =e in dotted +ormat e.'. kern.i3'.shmma( .a%ue to associate with the MI#M 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% o tiona%D =ut a use+u% reminder +or the reason =ehind usin' this MI#@.a%ue 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 s eci+:. As %on' as the s:sct% e6istsD that .a%ue wi%% ersist across re=oots and u 'rades. An: MI#s that :ou add wi%% =e %isted in ":stem S ":sct%s S 4iew ":sct%s. <o chan'e the .a%ue o+ a MI#D c%ic) its 5dit =utton. <o remo.e a MI#D c%ic) its (e%ete =utton. At this timeD the 3!I does not dis %a: the s:sct% MI#s that are re;set in the insta%%ation ima'e. 9.1.1 shi s 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.
#.9
S*ste3 Infor3ation
":stem S ":stem In+ormation dis %a:s 'enera% in+ormation a=out the $reeNA"1 s:stem. <he in+ormation inc%udes the hostnameD the =ui%d .ersionD t: e o+ C>! A %at+ormBD the amount o+ memor:D FreeNAS 9.1.1 Users Guide Page (2 of 276
the current s:stem timeD the s:stem's u timeD the current %oad a.era'eD and the I> address =ein' used +or the connection to the administrati.e 3!I. An e6am %e is seen in $i'ure &.9a. Figure #.9a: S*ste3 Infor3ation )a'
#.11 )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 s eci+ic to the )erne% arameter or dri.er to =e %oadedD descri tions can =e +ound in the man a'e +or the s eci+ied dri.er and in man: sections o+ the $ree#"( Hand=oo). $reeNA"1 ro.ides a 'ra hica% 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. 6ANG:2D 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. $i6in' this ro=%em reEuires h:sica% access to the $reeNA"1 s:stem and )now%ed'e o+ how to use the =oot %oader rom t as descri=ed in Reco.erin' FreeNAS 9.1.1 Users Guide Page (" of 276
$rom Incorrect <una=%es. <his means that :ou shou%d a%wa:s test the im act o+ an: chan'es on a test s:stem +irst. <o add a tuna=%eD 'o to ":stem S <una=%es S Add <una=%eD as seen in $i'ure &.10a. Figure #.11a: Adding a )una'le
<a=%e &.10a summari8es the o tions 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 e6istsD :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 S <una=%es S 4iew <una=%es. <o chan'e the .a%ue o+ a tuna=%eD c%ic) its 5dit =utton. <o remo.e a tuna=%eD c%ic) its (e%ete =utton. )a'le #.11a: Adding a )una'le Setting 4aria=%e @alue strin' inte'er or 4a%ue strin' Comment strin' 5na=%ed chec)=o6 6escri!tion t: ica%%: the name o+ the dri.er to %oadD as indicated =: its man a'e .a%ue to associate with .aria=%eM t: ica%%: this is set to 0.S to ena=%e the dri.er s eci+ied =: the .aria=%e o tiona%D =ut a use+u% reminder +or the reason =ehind addin' this tuna=%e unchec) i+ :ou wou%d %i)e to disa=%e the tuna=%e without de%etin' it
At this timeD the 3!I does not dis %a: the tuna=%es that are re;set in the insta%%ation ima'e. 9.1.1 shi s with the +o%%owin' tuna=%es setK
autoboot_delay="2" loader_logo="freenas" kern.cam.boot_delay=30000 xhci_load="YES" debug.debugger_on_panic=1 debug.ddb.textdump.pending=1 hw.hptrr.attach_generic=0 kern.ipc.nmbclusters="262144"
Page (# of 276
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. #.11.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 2 )e: or the 5sc )e: to se%ect N2. X5scYa e to %oader rom tN when :ou see the $reeNA"1 =oot menu shown in $i'ure &.10=. Figure #.11': FreeNAS 5oot 4enu
<he =oot %oader rom t ro.ides a minima% set o+ commands descri=ed in %oaderA2B. -nce at the rom tD 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'. 56am %e &.10a demonstrates se.era% e6am %es usin' these commands at the =oot %oader rom t. <he +irst command disa=%es the current .a%ue associated with the kern.i3'.nm$'l!sters MI# and wi%% +ai% with a Nno such +i%e or director:N error messa'e i+ a current tuna=%e does not e6ist 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. :,a3!le #.11a: Sa3!le &o33ands at t e 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 rom t on%: e++ect the current =oot. <his means that :ou need to edit or remo.e the ro=%ematic tuna=%e in ":stem S <una=%es S 4iew <una=%es to ma)e :our chan'e ermanent and to re.ent +uture =oot errors. FreeNAS 9.1.1 Users Guide Page ($ of 276
Net/or7 &onfiguration
3%o=a% Con+i'urationK used to to set non;inter+ace s eci+ic networ) settin's. Inter+acesK used to con+i'ure a s eci+ied inter+ace's networ) settin's. 9in) A''re'ationsK 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 RoutesK used to add static routes. 49ANsK used to con+i'ure I555 202.1E ta''in'.
<he Networ) section o+ the administrati.e 3!I contains the +o%%owin' com onents +or .iewin' and con+i'urin' the $reeNA"1 s:stem's networ) settin'sK
5ach o+ these is descri=ed in more detai% in this section.
$.1
Glo'al &onfiguration
Networ) S 3%o=a% Con+i'urationD shown in $i'ure *.1aD a%%ows :ou to set non;inter+ace s eci+ic networ) settin's. Figure $.1a: Glo'al &onfiguration "creen
<a=%e *.1a summari8es the settin's that can =e con+i'ured usin' the 3%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' Nre.erse (N"N or FreeNAS 9.1.1 Users Guide Page (6 of 276
timeout errorsD add an entr: +or the I> address o+ the $reeNA"1 s:stem in the NHost name data=aseN +ie%d. N9):: i+ :ou add a 'atewa: to the InternetD ma)e sure that the $reeNA"1 s:stem is rotected =: a ro er%: con+i'ured +irewa%%. )a'le $.1a: Glo'al &onfiguration Settings Setting Hostname (omain I>.& (e+au%t 3atewa: I>., (e+au%t 3atewa: Nameser.er 1 Nameser.er 2 Nameser.er 3 6escri!tion s:stem host name s:stem domain name t: ica%%: not set Asee N-<5 =e%owB t: ica%%: not set Asee N-<5 =e%owB rimar: (N" ser.er At: ica%%: in Windows domainB secondar: (N" ser.er tertiar: (N" ser.er i+ ena=%edD networ) ser.ices wi%% not =e started at =oot time unti% 5na=%e netwait +eature chec)=o6 the inter+ace is a=%e to in' the addresses %isted in Net<ait 26 list i+ .na$le net<ait feat!re is chec)edD %ist o+ I> addresses to in'M Netwait I> %ist strin' otherwiseD in' the de+au%t 'atewa: used to add one entr: er %ine which wi%% =e a ended to Host name data=ase strin' 7et'7hostsM use the +ormat 26*address s3a'e hostname where mu%ti %e hostnames can =e used i+ se arated =: a s ace N9):: In man: casesD a $reeNA"1 con+i'uration wi%% de%i=erate%: e6c%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 e6terna% (N"D N<>D and mai% ser.ers which are con+i'ured with static I> addresses. @alue strin' strin' I> address I> address I> address I> address I> address
$.2
Interfaces
Networ) S 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. N9):: t: ica%%: the inter+ace used to access the $reeNA"1 administrati.e 3!I is con+i'ured =: (HC>. <his inter+ace wi%% not a ear 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 o ens when :ou c%ic) Inter+aces S Add Inter+ace. <a=%e *.2a summari8es the con+i'uration o tions when :ou Add an inter+ace or 5dit an a%read: con+i'ured inter+ace. N9):: 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. FreeNAS 9.1.1 Users Guide Page (7 of 276
Figure $.2a: Adding or :diting an Interface
)a'le $.2a: Interface &onfiguration Settings Setting 6escri!tion se%ect the $ree#"( de.ice nameM wi%% =e a read;on%: +ie%d when NIC dro ;down menu editin' an inter+ace Inter+ace Name strin' descri tion o+ inter+ace reEuires static I>.& or I>., con+i'uration i+ unchec)edM note that (HC> chec)=o6 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)edD use rtso%dA2B to con+i'ure the inter+aceM reEuires manua% chec)=o6 I>., con+i'uration i+ unchec)ed and wish to use I>., I>., Address I>., address must =e uniEue on networ) I>., >re+i6 dro ;down menu match the re+i6 used on networ) 9en'th additiona% arameters +rom i+con+i'A2BD one er %ineM +or e6am %eK - tions strin' mt! 9000 wi%% increase the M<! +or inter+aces that su ort Ium=o +rames @alue
Page (( of 276
<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 NAdd e6tra a%iasN %in) +or each a%ias :ou wish to con+i'ure.
$."
<in7 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;s eed mu%ti;%in) throu'h ut. <he a''re'ation rotoco%s su orted =: %a'' determine which orts are used +or out'oin' tra++ic and whether a s eci+ic ort acce ts 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 su ortin' 9AC>D which distri=utes tra++ic =i;directiona%%: whi%e res ondin' to +ai%ure o+ indi.idua% %in)s. $reeNA"1 a%so su orts acti.e@ assi.e +ai%o.er =etween airs o+ %in)s. <he 9AC>D $5C and %oad;=a%ance modes se%ect the out ut inter+ace usin' a hash that inc%udes the 5thernet source and destination addressD 49AN 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" de ends on the 5thernet switch %oad;=a%ance a%'orithm. <he %a'' dri.er current%: su orts 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 ne6t acti.e ort is used. <he +irst inter+ace added is the master ortM an: inter+aces added a+ter that are used as +ai%o.er de.ices. #: de+au%tD recei.ed tra++ic is on%: acce ted when recei.ed throu'h the acti.e ort. <his constraint can =e re%a6edD which is use+u% +or certain =rid'ed networ) setu sD =: settin' net.link.lagg.failo#er*r(*all to a non;8ero .a%ue in ":stem S ":sct%s S Add ":sct%. F:&: su orts Cisco 5therChanne% on o%der Cisco switches. <his is a static setu and does not ne'otiate a''re'ation with the eer or e6chan'e +rames to monitor the %in). <A&P: su orts the I555 202.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 'rou s A9A3sB. 5ach 9A3 is com osed o+ orts o+ the same s eedD set to +u%%;du %e6 o eration. <he tra++ic wi%% =e =a%anced across the orts in the 9A3 with the 'reatest tota% s eedM in most cases there wi%% on%: =e one 9A3 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 acce ts 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 e6chan'e +rames to monitor the %in). <he hash inc%udes the 5thernet source and destination addressD 49AN ta' Ai+ a.ai%a=%eBD and I> source and destination address. ReEuires a switch which su orts I555 202.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 acce ts 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'h ut as reorderin' ac)ets can =e C>! intensi.e on the c%ient. ReEuires a switch which su orts I555 202.3ad static %in) a''re'ation. None: this rotoco% disa=%es an: tra++ic without disa=%in' the %a'' inter+ace itse%+. FreeNAS 9.1.1 Users Guide Page (9 of 276
N9):: 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&PK 4PI9K NFSK or :SBi
9AC> =onds 5thernet connections in order to im ro.e =andwidth. $or e6am %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: 5thernet hardware is used and it wi%% not ma)e much di++erence when usin' in+erior 5thernet chi sets 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 s eed o.er one <C> connection. M>I- o erates at the i"C"I rotoco% %e.e%. $or e6am %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 se arate su=nets with non;o.er%a in' 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 5"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 im ro.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 <in7 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) S Inter+aces S 4iew Inter+aces. I+ an: con+i'ured inter+aces e6istD de%ete them as %a'' creation wi%% +ai% i+ an: inter+aces are manua%%: con+i'ured. $i'ure *.3a shows the con+i'uration o tions when addin' a %a'' inter+ace usin' Networ) S 9in) A''re'ations S Create 9in) A''re'ation. N9):: i+ inter+aces are insta%%ed =ut do not a ear in the >h:sica% NICs in the 9A33 %istD chec) that a $ree#"( dri.er +or the inter+ace e6ists 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 *.3=D it wi%% a%so a ear in 4iew 9in) A''re'ations.
Page 91 of 276
Figure $."a: &reating a lagg Interface
Figure $."': @ie/ing <in7 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 5dit =utton +or an inter+aceD :ou wi%% see the con+i'uration screen shown in $i'ure *.3c. <a=%e *.3a descri=es the o tions in this screen. FreeNAS 9.1.1 Users Guide Page 91 of 276
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 o tion in order to 'et access into the 3!I throu'h the new %a'' inter+ace. Figure $."c: :diting a 4e3'er of a lagg
)a'le $."a: &onfigura'le 9!tions for a lagg 4e3'er Setting NIC @alue strin' 6escri!tion read;on%: as automatica%%: assi'ned ne6t a.ai%a=%e numeric I( =: de+au%t same as de.ice ANICB nameD can =e chan'ed to a more descri ti.e .a%ue chec) i+ the %a'' de.ice 'ets its I> address in+o +rom (HC> ser.er mandator: i+ (HC> is %e+t unchec)ed mandator: i+ (HC> is %e+t unchec)ed chec) on%: i+ (HC> ser.er a.ai%a=%e to ro.ide I>., address in+o o tiona% reEuired i+ in ut I>., address
Inter+ace Name strin' (HC> I>.& Address I>.& Netmas) Auto con+i'ure I>., I>., Address I>., >re+i6 9en'th chec)=o6 strin' dro ;down menu chec)=o6 strin' dro ;down menu
Page 92 of 276
Setting - tions
@alue strin'
6escri!tion additiona% i+con+i'A2B o tions
<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 NAdd e6tra A%iasN %in) +or each a%ias :ou wish to con+i'ure. I+ :ou c%ic) the 5dit Mem=ers =uttonD c%ic) the entr: +or a mem=erD then c%ic) its 5dit =uttonD :ou wi%% see the con+i'uration screen shown in $i'ure *.3d. <he con+i'ura=%e o tions are summari8ed in <a=%e *.3=. Figure $."d: :diting a 4e3'er Interface
)a'le $."': &onfiguring a 4e3'er Interface Setting 9A33 Inter+ace 'rou @alue 6escri!tion dro ;down menu se%ect the mem=er inter+ace to con+i'ure order o+ se%ected inter+ace within the %a''M con+i'ure 9A33 >riorit: Num=er inte'er a +ai%o.er to set the master inter+ace to 0 and the other inter+aces to 1D 2D etc. 9A33 >h:sica% NIC dro ;down menu h:sica% inter+ace o+ the se%ected mem=er - tions strin' additiona% arameters +rom i+con+i'A2B N9):: o tions can =e set at either the %a'' %e.e% Ausin' the 5dit =uttonB or the indi.idua% arent inter+ace %e.e% Ausin' the 5dit Mem=ers =uttonB. . <: ica%%:D chan'es are made at the %a'' %e.e% A$i'ure *.3=B 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 *.3cBD :ou wi%% ha.e to re eat the con+i'uration +or each inter+ace within the %a''. Howe.erD some %a'' o tions 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<!. FreeNAS 9.1.1 Users Guide Page 9" of 276
<o see i+ the %in) a''re'ation is %oad =a%ancin' ro er%:D run the +o%%owin' command +rom "he%%K
systat -ifstat
More in+ormation a=out this command can =e +ound at s:statA1B.
$.#
Net/or7 Su33ar*
Networ) S 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) S "tatic Routes S Add "tatic RouteD shown in $i'ure *.*a. Figure $.$a: Adding a Static 2oute
<he a.ai%a=%e o tions are summari8ed in <a=%e *.*a. )a'le $.$a: Static 2oute 9!tions Setting (estination networ) 3atewa: (escri tion @alue inte'er inte'er strin' 6escri!tion use the +ormat A.B.". 7. where . is the CI(R mas) in ut the I> address o+ the 'atewa: o tiona%
I+ :ou add an: static routesD the: wi%% show in N4iew "tatic RoutesN. C%ic) a route's entr: to access its 5dit and (e%ete =uttons.
Page 9# of 276
$.6
@<ANs
$reeNA"1 uses $ree#"('s .%anA&B inter+ace to demu%ti %e6 +rames with I555 202.1E ta's. <his a%%ows nodes on di++erent 49ANs 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 49AN 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) S 49ANs S Add 49AND :ou wi%% see the screen shown in $i'ure *.,a. N9):: 49AN ta''in' is the on%: 202.1E +eature that is im %emented. Additiona%%:D not a%% 5thernet inter+aces su ort +u%% 49AN rocessin'Zsee the HAR(WAR5 section o+ .%anA&B +or detai%s. Figure $.6a: Adding a @<AN
<a=%e *.,a summari8es the con+i'ura=%e +ie%ds. )a'le $.6a: Adding a @<AN Setting 4irtua% Inter+ace 6escri!tion use the +ormat #lanX where X is a num=er re resentin' the .%an strin' inter+ace usua%%: an 5thernet card connected to a ro er%: con+i'ured switch >arent Inter+ace dro ;down menu ortM i+ usin' a new%: created %a'' de.iceD it wi%% not a ear in the dro ;down unti% the $reeNA"1 s:stem is re=ooted 49AN <a' inte'er shou%d match a numeric ta' set u in the switched networ) (escri tion strin' o tiona% <he arent inter+ace o+ a .%an has to =e u D =ut it can ha.e an I> address or it can =e uncon+i'uredD de endin' u on the reEuirements o+ the 49AN con+i'uration. <his ma)es it di++icu%t +or the 3!I to do the ri'ht thin' without tram %in' the con+i'uration. <o remed: thisD a+ter addin' the 49AND 'o to Networ) S Inter+aces S Add Inter+ace. "e%ect the arent inter+ace +rom the NIC dro ;down menu and in the - tions +ie%dD t: e !3. <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 o tions in the Add Inter+ace screen. @alue
Page 9$ of 276
Storage &onfiguration
>eriodic "na shot <as)sK used to schedu%e the automatic creation o+ 0$" sna shots. Re %ication <as)sK used to schedu%e the re %ication o+ sna shots o.er an encr: ted connection. 4o%umesK used to create and mana'e stora'e .o%umes. 0$" "cru=sK used to schedu%e 0$" scru=s as art o+ on'oin' dis) maintenance.
<he "tora'e section o+ the 'ra hica% inter+ace a%%ows :ou to con+i'ure the +o%%owin'K
<hese con+i'urations are descri=ed in more detai% in this section.
6.1
Periodic Sna!s ot )as7s
A eriodic sna shot 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. "na shots can =e created Euic)%: andD i+ %itt%e data chan'esD new sna shots ta)e u .er: %itt%e s ace. $or e6am %eD a sna shot where no +i%es ha.e chan'ed ta)es 0 M# o+ stora'eD =ut i+ :ou chan'e a 10 3# +i%e it wi%% )ee a co : o+ =oth the o%d and the new 10 3# .ersion. "na shots ro.ide a c%e.er wa: o+ )ee in' 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 sna shots 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 s eci+ic time orD i+ there is a catastro hic %ossD an o++;site sna shot can restore the s:stem u to the %ast sna shot inter.a%. #e+ore :ou can create a sna shotD :ou need to ha.e an e6istin' 0$" .o%ume. How to create a .o%ume is descri=ed in 0$" 4o%ume Mana'er.
6.1.1
&reating a Periodic Sna!s ot )as7
<o create a eriodic sna shot tas)D c%ic) "tora'e S >eriodic "na shot <as)s S Add >eriodic "na shot which wi%% o en the screen shown in $i'ure ,.1a. N9):: i+ :ou Iust need a one;time sna shotD instead use "tora'e S 4o%umes S 4iew 4o%umes and c%ic) the Create "na shot =utton +or the .o%ume or dataset that :ou wish to sna shot.
Page 96 of 276
Figure 6.1a: &reating a ;FS Periodic Sna!s ot
<a=%e ,.1a summari8es the +ie%ds in this screenK )a'le 6.1a: 9!tions - en &reating a Periodic Sna!s ot Setting 6escri!tion unchec) to disa=%e the schedu%ed re %ication tas) without 5na=%ed chec)=o6 de%etin' it se%ect an e6istin' 0$" .o%umeD datasetD or 8.o%M i+ :ou $i%es:stem@ dro ;down menu se%ect a .o%umeD se arate sna shots wi%% a%so =e created +or 4o%ume each o+ its datasets se%ect this =o6 to ta)e se arate sna shots o+ the .o%ume@dataset and each o+ its chi%d datasetsM i+ unchec)edD Recursi.e chec)=o6 on%: one sna shot is ta)en o+ the .o%ume@dataset s eci+ied in Filesystem 7 Col!me how %on' to )ee the sna shot on this s:stemM i+ the 9i+etime inte'er and dro ;down menu sna shot is re %icatedD it is not remo.ed +rom the recei.in' s:stem when the %i+etime e6 ires #e'in dro ;down menu do not create sna shots =e+ore this time o+ da: 5nd dro ;down menu do not create sna shots a+ter this time o+ da: Inter.a% dro ;down menu how o+ten to ta)e sna shot =etween Begin and .nd times FreeNAS 9.1.1 Users Guide Page 97 of 276 @alue
Setting Wee)da:
@alue chec)=o6es
6escri!tion which da:s o+ the wee) to ta)e sna shots
I+ the Recursi.e =o6 is chec)edD :ou do not need to create sna shots +or e.er: dataset indi.idua%%: as the: are inc%uded in the sna shot. <he downside is that there is no wa: to e6c%ude certain datasets +rom =ein' inc%uded in a recursi.e sna shot. -nce :ou c%ic) the -K =uttonD a sna shot wi%% =e ta)en and this tas) wi%% =e re eated accordin' to :our settin's. 6.1.2 4anaging Periodic Sna!s ot )as7s
A+ter creatin' a eriodic sna shot tas)D an entr: +or the sna shot tas) wi%% =e added to 4iew >eriodic "na shot <as)sD as seen in the e6am %e in $i'ure ,.1=. C%ic) an entr: to access its Modi+: and (e%ete =uttons. Figure 6.1': @ie/ Periodic Sna!s ot )as7s
I+ :ou c%ic) the 0$" "na shots ta= Aa=o.e the Add >eriodic "na shot =uttonBD :ou can re.iew the %istin' o+ a.ai%a=%e sna shots. In the e6am %e shown in $i'ure ,.1cD a recursi.e eriodic sna shot tas) was created +or #ol!me1 and this .o%ume contains a dataset named Dails. N9):: i+ sna shots do not a earD chec) that the current time does not con+%ict with the =e'inD endD and inter.a% settin's. I+ the sna shot was attem ted =ut +ai%edD an entr: wi%% =e added to 7#ar7log7messages. <his %o' +i%e can =e .iewed in "he%%.
Page 9( of 276
Figure 6.1c: @ie/ing A+aila'le Sna!s ots
<he most recent sna shot +or a .o%ume or dataset wi%% =e %isted %ast and wi%% ha.e 3 icons. <he icons associated with a sna shot a%%ow :ou toK &lone Sna!s ot: wi%% rom t +or the name o+ the c%one to create. <he c%one wi%% =e a writa=%e co : o+ the sna shot. "ince a c%one is rea%%: a dataset which can =e mountedD the c%one wi%% a ear in the Acti.e 4o%umes ta=D instead o+ the >eriodic "na shots ta=D and wi%% ha.e the word 'lone in its name. 6estro* Sna!s ot: 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 sna shot can =e destro:ed. Whi%e creatin' a sna shot is instantaneousD de%etin' a sna shot can =e I@- intensi.e and can ta)e a %on' timeD es ecia%%: when dedu %ication is ena=%ed. In order to de%ete a =%oc) in a sna shotD 0$" has to wa%) a%% the a%%ocated =%oc)s to see i+ that =%oc) is used an:where e%seM i+ it is notD it can =e +reed. 2oll'ac7 Sna!s ot: a o ;u messa'e wi%% as) i+ :ou are sure that :ou want to ro%%=ac) to this sna shot state. I+ :ou c%ic) FesD an: +i%es that ha.e chan'ed since the sna shot was ta)en wi%% =e re.erted =ac) to their state at the time o+ the sna shot. N9):: ro%%=ac) is a otentia%%: dan'erous o eration and wi%% cause an: con+i'ured re %ication tas)s to +ai% as the re %ication s:stem uses the e6istin' sna shot when doin' an incrementa% =ac)u . I+ :ou do need to restore the data within a sna shotD the recommended ste s areK 1. C%one the desired sna shot. 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 4o%umes ta=. <his a roach wi%% ne.er destro: an: on;dis) data and has no im act on re %ication. >eriodic sna shots can =e con+i'ured to a ear as shadow co ies in newer .ersions o+ Windows 56 %orer. !sers can access the +i%es in the shadow co : usin' 56 %orer without reEuirin' an: interaction with the $reeNA"1 'ra hica% administrati.e inter+ace.
Page 99 of 276
<he 0$" "na shots screen a%%ows :ou to create +i%ters to .iew sna shots =: se%ected criteria. <o create a +i%terD c%ic) the (e+ine +i%ter icon Anear the te6t PNo +i%ter a %iedQB. 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 is8 starts <ith8 ends <ith8 does not 'ontain8 is not8 does not start <ith8 does not end <ithD and is em3ty. in ut a .a%ue that meets :our .iew criteria. c%ic) the $i%ter =utton to sa.e :our +i%ter and e6it the de+ine +i%ter screen. A%ternate%:D c%ic) the [ =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 PNo +i%ter a %iedQ te6t wi%% chan'e to PC%ear +i%terQ. I+ :ou c%ic) PC%ear +i%terQD a o ;u messa'e wi%% indicate that this wi%% remo.e the +i%ter and a%% a.ai%a=%e sna shots wi%% =e %isted.
6.2
2e!lication )as7s
A re %ication tas) a%%ows :ou to automate the co : o+ 0$" sna shots 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$" sna shots as 61S? and the s:stem to recei.e a co : o+ the 0$" sna shots as 61--. #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 e6ist on =oth 61S? and 61--. a eriodic sna shot tas) must =e created on 61S?. Fou wi%% not =e a=%e to create a re %ication tas) =e+ore the +irst sna shot e6ists. the ""H ser.ice must =e ena=%ed on 61--. <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 FdataFss Fre!lication.!u': the R"A u=%ic )e: used +or authenticatin' the 61S? re %ication user. <his )e: needs to =e co ied to the re %ication user account on 61--. FetcFss Fss 8 ost8rsa87e*.!u': the R"A host u=%ic )e: o+ 61-- used to authenticate the recei.in' side in order to re.ent a man;in;the;midd%e attac). <his )e: needs to =e co ied to the re %ication tas) on 61S?.
<his section wi%% demonstrate how to con+i'ure a re %ication tas) =etween the +o%%owin' two $reeNA"1 s:stemsK 192.1:,.2.2 wi%% =e re+erred to as 61S?. <his s:stem has a eriodic sna shot tas) +or the 0$" dataset 7mnt7lo'al7data. 192.1:,.2.: wi%% =e re+erred to as 61--. <his s:stem has an e6istin' 0$" .o%ume named 7mnt7remote which wi%% store the ushed sna shots.
Page 111 of 276
6.2.1
&onfigure PU22
A co : o+ the u=%ic )e: +or the re %ication user on 61S? needs to =e asted to the u=%ic )e: o+ the re %ication user on the 61-- s:stem. <o o=tain a co : o+ the re %ication )e:K on 61S? 'o to "tora'e S 4iew Re %ication <as)s. C%ic) the 4iew >u=%ic Ke: =utton and co : its contents. An e6am %e is shown in $i'ure ,.2a. Figure 6.2a: &o!* t e 2e!lication 0e*
3o to 61-- and c%ic) Account S !sers S 4iew !sers. C%ic) the Modi+: !ser =utton +or the re %ication user account. >aste the co ied )e: into the N""H >u=%ic Ke:N +ie%d and c%ic) -K. I+ a )e: a%read: e6istsD a end the new te6t a+ter the e6istin' )e:. -n 61--D ensure that the ""H ser.ice is ena=%ed in "er.ices S Contro% "er.ices. "tart it i+ it is not a%read: runnin'. 6.2.2 &onfigure PUS7
-n 61S?D .eri+: that a eriodic sna shot tas) has =een created and that at %east one sna shot is %isted in "tora'e S >eriodic "na shot <as)s S 4iew >eriodic "na shot <as)s S 0$" "na shots. <o create the re %ication tas)D c%ic) "tora'e S Re %ication <as)s S Add Re %ication <as). $i'ure ,.2= shows the reEuired con+i'uration +or our e6am %eK the $i%es:stem@4o%ume is lo'al7data the Remote 0$" +i%es:stem is remote the Remote hostname is 192.1:,.2.: the #e'in and 5nd times are at their de+au%t .a%uesD meanin' that re %ication wi%% occur whene.er a sna shot is created once the Remote hostname is in utD c%ic) the ""H Ke: "can =uttonM assumin' the address is reacha=%e and the ""H ser.ice is runnin' on 61--D its )e: wi%% automatica%%: =e o u%ated to the Remote host)e: =o6
Page 111 of 276
<a=%e ,.2a summari8es the a.ai%a=%e o tions in the Add Re %ication <as) screen. Figure 6.2': Adding a 2e!lication )as7
)a'le 6.2a: Adding a 2e!lication )as7 Setting 5na=%ed $i%es:stem@4o%ume Remote 0$" +i%es:stem name Recursi.e%: re %icate Initia%i8e remote side 9imit A)#@sB #e'in 5nd Remote hostname Remote ort (edicated !ser 5na=%ed @alue chec)=o6 dro ;down menu strin' chec)=o6 chec)=o6 inte'er dro ;down menu dro ;down menu strin' strin' chec)=o6 6escri!tion unchec) to disa=%e the schedu%ed re %ication tas) without de%etin' it the 0$" .o%ume on 61S? containin' the sna shots to =e re %icatedM the dro ;down menu wi%% =e em t: i+ a sna shot does not a%read: e6ist the 0$" .o%ume on 61-- that wi%% store the sna shotsM 7mnt7 is assumed and shou%d not =e inc%uded in the ath i+ chec)ed wi%% re %icate chi%d datasets and re %ace re.ious sna shot stored on 61-does a reset once o eration which destro:s the re %ication data on 61-- =e+ore re.ertin' to norma% o erationM use this o tion i+ re %ication 'ets stuc) %imits re %ication s eed to s eci+ied .a%ue in )i%o=:tes@secondM de+au%t o+ 0 is un%imited the re %ication can not start =e+ore this timeM the times se%ected in the Begin and .nd +ie%ds set the re %ication window +or when re %ication can occur the re %ication must start =: this timeM once startedD re %ication wi%% occur unti% it is +inished Asee N-<5 =e%owB I> address or (N" name o+ 61-must match ort =ein' used =: ""H ser.ice on 61-a%%ows a user account other than root to =e used +or re %ication
Page 112 of 276
Setting (edicated !ser
@alue dro ;down menu
6escri!tion on%: a.ai%a=%e i+ edi'ated 1ser .na$led is chec)edM se%ect the user account to =e used +or re %ication note that the ci her is Euic)er =ecause it has a %ower stren'th use the ""H Ke: "can =utton to retrie.e the u=%ic )e: o+ 61--
5na=%e Hi'h " eed chec)=o6 Ci hers Remote host)e: strin'
#: de+au%tD re %ication occurs when sna shots occur. $or e6am %eD i+ sna shots are schedu%ed +or e.er: 2 hoursD re %ication occurs e.er: 2 hours. <he #e'in and 5nd 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 sna shot occursB i+ sna shot tas)s are schedu%ed durin' o++ice hours =ut the re %ication itse%+ shou%d occur a+ter o++ice hours. $or the 5nd timeD consider how %on' re %ication wi%% ta)e so that it +inishes =e+ore the ne6t da:'s o++ice hours =e'in. -nce the re %ication tas) is createdD it wi%% a ear in the 4iew Re %ication <as)s o+ 61S?D as seen in $i'ure ,.2c. #uttons are ro.ided to de%ete and to edit the re %ication tas). Figure 6.2c: @ie/ing t e 2e!lication )as7
61S? wi%% immediate%: attem t to re %icate its %atest sna shot to 61--. I+ the re %ication is success+u%D the sna shot wi%% a ear in the "tora'e S >eriodic "na shot <as)s S 4iew >eriodic "na shot <as)s S 0$" "na shots ta= o+ 61--D as seen in $i'ure ,.2d. I+ the sna shot is not re %icatedD see the ne6t section +or trou=%eshootin' ti s.
Page 11" of 276
Figure 6.2d: @erif*ing t e Sna!s ot /as 2e!licated
6.2."
)rou'les ooting 2e!lication
I+ :ou ha.e +o%%owed a%% o+ the ste s a=o.e and ha.e 61S? sna shots that are not re %icatin' to 61--D chec) to see i+ ""H is wor)in' ro er%:. -n 61S?D o en "he%% and tr: to ss into 61--. Re %ace hostname*or*i3 with the .a%ue +or 61--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'. 3o to "tora'e S Re %ication <as)s S 4iew Re %ication <as)s and c%ic) the N4iew >u=%ic Ke:N =utton. Ma)e sure that it matches the .a%ue o+ 7et'7ssh7ssh*host*rsa*key.3!$ on 61--. A%so chec) 7#ar7log7a!th.log on 61-- to see i+ it '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%% sna shots on 61-- e6ce t +or the most recent one. In "tora'e S >eriodic "na shot <as)s S 4iew >eriodic "na shot <as)s S 0$" "na shots chec) the =o6 ne6t to e.er: sna shot e6ce t +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 sna shotD o en "he%% on 61S? and use the =fs send command. <o continue our e6am %eD the 0$" sna shot on the lo'al7data dataset o+ 61S? is named a!to-20110922.1;E3-2hD the I> address o+ 61-- is 192.1:,.2.:D and the 0$" .o%ume on 61-- is remote. Note that the L is used to se arate the .o%ume@dataset name +rom the sna shot name.
zfs send local/data@auto-20110922.1753-2h | ssh -i 192.168.2.6 zfs receive local/data@auto-20110922.1753-2h /data/ssh/replication \
N9):: i+ this command +ai%s with the error Ncannot recei.e new +i%es:stem streamK destination has sna shotsND chec) the =o6 Ninitia%i8e remote side +or onceN in the re %ication tas) and tr: a'ain. I+ the =fs send command sti%% +ai%sD :ou wi%% need to o en "he%% on 61-- and use the =fs destro* ?2 +olu3e8na3eLsna!s ot8na3e command to de%ete the stuc) sna shot. Fou can then use the =fs list ?t sna!s ot on 61-- to con+irm i+ the sna shot success+u%%: re %icated.
Page 11# of 276
A+ter success+u%%: transmittin' the sna shotD rechec) a'ain a+ter the time eriod =etween sna shots %a ses to see i+ the ne6t sna shot success+u%%: transmitted. I+ it is sti%% not wor)in'D :ou can manua%%: send an incrementa% =ac)u o+ the %ast sna shot that is on =oth s:stems to the current one with this commandK
zfs send local/data@auto-20110922.1753-2h | ssh -i 192.168.2.6 zfs receive local/data@auto-20110922.1753-2h /data/ssh/replication \
6."
@olu3es
"ince the stora'e dis)s are se arate +rom the $reeNA"1 o eratin' 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 'ra hica% inter+ace su orts the creation o+ =oth !$" and 0$" .o%umes. 0$" .o%umes are recommended to 'et the most out o+ :our $reeNA"1 s:stem. N9):: 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 'ra hica% inter+aceD the term .o%ume is used to re+er to either a !$" .o%ume or a 0$" oo%. >ro er stora'e desi'n is im ortant +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%$. I+ :ou are new to RAI( conce ts or wou%d %i)e an o.er.iew o+ the di++erences =etween hardware RAI( and 0$" RAI(0\D s)im throu'h the section on Hardware Recommendations as we%%.
6.".1
Auto I3!orting @olu3es
I+ :ou c%ic) "tora'e S 4o%umes S Auto Im ort 4o%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 e6istin' $reeNA"1 s:stem is re;insta%%ed Arather than u 'radedB. "ince the o eratin' s:stem is se arate +rom the dis)sD a new insta%%ation does not a++ect the data on the dis)sM howe.erD the new o eratin' s:stem needs to =e con+i'ured to use the e6istin' .o%ume. "u orted .o%umes are !$" 35-M stri es ARAI(0BD !$" 35-M mirrors ARAI(1BD !$" 35-M RAI(3D as we%% as e6istin' 0$" oo%s. !$" RAI(* is not su orted as it is an unmaintained summer o+ code roIect which was ne.er inte'rated into $ree#"(. #e'innin' with .ersion 2.3.1D the im ort o+ e6istin' 359I;encr: ted 0$" oo%s is a%so su Howe.erD the oo% must =e decr: ted =e+ore it can =e im orted. orted.
$i'ure ,.3a shows the initia% o ;u window that a ears when :ou se%ect to auto im ort a .o%ume. I+ :ou are im ortin' a !$" RAI( or an e6istin'D unencr: ted 0$" oo%D se%ect NNoK ")i to im ortN to access the screen shown in $i'ure ,.3=.
Page 11$ of 276
Figure 6."a: Initial Auto I3!ort @olu3e Screen
Figure 6."': Auto I3!orting a Non?:ncr*!ted @olu3e
56istin' so+tware RAI( .o%umes shou%d =e a.ai%a=%e +or se%ection +rom the dro ;down menu. In the e6am %e shown in $i'ure ,.3=D the $reeNA"1 s:stem has an e6istin'D unencr: ted 0$" oo%. -nce the .o%ume is se%ectedD c%ic) the N-KN =utton to im ort the .o%ume. $reeNA"1 wi%% not im ort a dirt: .o%ume. I+ an e6istin' !$" RAI( does not show in the dro ;down menuD :ou wi%% need to fsc7 the .o%ume. I+ an e6istin' 0$" oo% does not show in the dro ;down menuD run =!ool i3!ort +rom "he%% to im ort the oo%. FreeNAS 9.1.1 Users Guide Page 116 of 276
I+ :ou %an to h:sica%%: insta%% 0$" +ormatted dis)s +rom another s:stemD =e sure to e6 ort the dri.es on that s:stem to re.ent an Nin use =: another machineN error durin' the im ort. I+ :ou sus ect that :our hardware is not =ein' detectedD run ca3control de+list +rom "he%%. I+ the dis) does not a ear in the out utD chec) to see i+ the contro%%er dri.er is su orted or i+ it needs to =e %oaded =: creatin' a tuna=%e.
).3.1.1 Auto I& orting a *+,I-+ncr. ted /#S 0ool
I+ :ou are im ortin' an e6istin' 359I;encr: ted 0$" oo%D :ou must decr: t the dis)s =e+ore im ortin' the oo%. In $i'ure ,.3aD se%ect PFesK (ecr: t dis)sQ to access the screen shown in $i'ure ,.3c. Figure 6."c: 6ecr*!ting t e 6is7s 5efore I3!orting t e ;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 in ut the ass hrase associated with the )e:D then c%ic) -K to decr: t the dis)s. N9):: the encr: tion )e: is reEuired to decr: t the oo%. I+ the oo% can not =e decr: tedD it can not =e re;im orted 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 ass hrase that was con+i'ured +or the )e:. <he 4iew 4o%umes screen is used to mana'e the )e:s +or encr: ted .o%umes. -nce the oo% is decr: tedD it shou%d a ear in the dro ;down menu o+ $i'ure ,.3=. C%ic) the -K =utton to +inish the .o%ume im ort.
6.".2
I3!orting @olu3es
<he 4o%ume S Im ort 4o%ume screenD shown in $i'ure ,.3dD is used to im ort a sin'%e dis) or artition that has =een +ormatted with a su orted +i%es:stem. $reeNA"1 su orts the im ort o+ dis)s that ha.e =een +ormatted with !$"D N<$"D M"(-"D or 57<2.
Page 117 of 276
Figure 6."d: I3!orting a @olu3e
In ut a name +or the .o%umeD use the dro ;down menu to se%ect the dis) or artition that :ou wish to im ortD and se%ect the t: e o+ +i%es:stem on the dis). #e+ore im ortin' a dis)D =e aware o+ the +o%%owin' ca.eatsK $reeNA"1 wi%% not im ort a dirt: +i%es:stem. I+ a su orted +i%es:stem does not show in the dro ;down menuD :ou wi%% need to fsc7 or run a dis) chec) on the +i%es:stem. ear%ier .ersions o+ $reeNA"1 2 had a =u' that re.ented the success+u% im ort o+ N<$" dri.es. Do%@t tr) to i("ort NTFS i* )o! are r!%%i%# a 'er$io% earlier tha% FreeNAS A.0.:&R4:. $reeNA"1 can not im ort d:namic N<$" .o%umes at this time. A +uture .ersion o+ $ree#"( ma: address this issue. i+ an N<$" .o%ume wi%% not im ortD tr: eIectin' the .o%ume sa+e%: +rom a Windows s:stem. <his wi%% +i6 some Iourna% +i%es that are reEuired to mount the dri.e. 6."." UFS @olu3e 4anager
Whi%e the !$" +i%es:stem is su ortedD it is not recommended as it does not ro.ide an: 0$" +eatures such as com ressionD encr: tionD dedu %icationD co :;on;writeD %i'htwei'ht sna shotsD or the a=i%it: to ro.ide ear%: detection and correction o+ corru t data. I+ :ou are usin' !$" as a tem orar: so%ution unti% :ou can a++ord =etter hardwareD note that :ou wi%% ha.e to destro: :our e6istin' !$" .o%ume in order to create a 0$" oo%D then restore :our data +rom =ac)u . N9):: it is not recommended to create a !$" .o%ume %ar'er than *<# as it wi%% =e ine++icient to fsc7D 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 S 4o%umes S !$" 4o%ume Mana'er which wi%% o en the screen shown in $i'ure ,.3e. FreeNAS 9.1.1 Users Guide Page 11( of 276
Figure 6."e: &reating a UFS @olu3e
<a=%e ,.3a summari8es the a.ai%a=%e o tions. )a'le 6."a: 9!tions - en &reating a UFS @olu3e Setting 6escri!tion mandator:M it is recommended to choose a name that wi%% stic) out in the 4o%ume name strin' %o's Ae.'. not data or freenasB use the mouse to se%ect the dis)AsB to =e usedM to se%ect mu%ti %e dis)sD Mem=er dis)s se%ection 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+: chec)=o6 o tiona%M use+u% +or creatin' a 7#ar +or ersistent %o' stora'e custom ath on%: a.ai%a=%e when S3e'ify '!stom 3ath is chec)edM must =e +u%% name o+ >ath strin' .o%ume Ae.'. 7mnt7#arB and i+ no ath is ro.idedD it wi%% a end the Col!me name to 7mnt @alue
<he Add 4o%ume =utton warns that creati%# a 'ol!(e de$tro)$ all exi$ti%# data o% $elected di$0B$C. In other wordsD creatin' stora'e usin' !$" 4o%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 e6istin' .o%umeD see i+ the .o%ume +ormat is su orted =: the auto;im ort or im ort actions. I+ soD er+orm the su orted action instead. I+ the current stora'e +ormat is not su ortedD :ou wi%% need to =ac)u the data to an e6terna% mediaD +ormat the dis)sD then restore the data to the new .o%ume.
Page 119 of 276
6.".#
;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$" 4o%ume Mana'er to +ormat the desired dis)s into a 0$" oo%. I+ :ou c%ic) on "tora'e S 4o%umes S 0$" 4o%ume Mana'erD :ou wi%% see a screen simi%ar to the e6am %e shown in $i'ure ,.3+. Figure 6."f: &reating a ;FS Pool Using @olu3e 4anager
<a=%e ,.3= summari8es the con+i'uration o tions o+ this screen. )a'le 6."': 9!tions - en &reating a ;FS @olu3e Setting @alue 6escri!tion 0$" .o%umes must con+orm to these namin' con.entionsM it is recommended to choose a name that wi%% stic) out in the %o's Ae.'. %ot data or freenasB reEuires an e6istin' 0$" oo% to e6tendM see 56tendin' a 0$" 4o%ume +or instructions read the section on 5ncr: tion =e+ore choosin' to use encr: tion on%: a ears i+ .na$le f!ll disk en'ry3tion is chec)edM recommended as it writes the dis)s with random data =e+ore ena=%in' encr: tionD howe.er it wi%% ta)e a %on'er time to create the .o%ume dis %a:s the si8e o+ a.ai%a=%e dis)sM ho.er o.er sho< to %ist the a.ai%a=%e de.ice names c%ic) and dra' the icon to se%ect the desired num=er o+ dis)s se%ect to con+i'ure mu%ti %e oo%s or to add %o' or cache de.ices durin' oo% creation Page 111 of 276
4o%ume name strin' 4o%ume to e6tend 5ncr: tion Initia%i8e "a+e%: A.ai%a=%e dis)s 4o%ume %a:out Add 56tra Row dro ;down menu chec)=o6 chec)=o6 dis %a: dra' and dro =utton
<o con+i'ure which dis)s wi%% =e a.ai%a=%e as stora'eD use the mouse to dra' the s%ider order to se%ect the num=er o+ dis)AsB to add to the oo%. <he o tima% con+i'uration wi%% automatica%%: =e se%ected and the resu%tin' stora'e ca acit:D which ta)es swa into accountD wi%% =e dis %a:ed. <he dro ;down menu showin' the o tima% con+i'uration can =e c%ic)ed to chan'e the con+i'urationD thou'h the 3!I wi%% turn red i+ the se%ected con+i'uration is not recommended. <he 3!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 4o%ume =utton warns that creati%# a 'ol!(e -ill de$tro)$ a%) exi$ti%# data o% the $elected di$0B$C. 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 e6istin' .o%umeD see i+ the .o%ume +ormat is su orted =: the auto;im ort or im ort actions. I+ soD er+orm the su orted action instead. I+ the current stora'e +ormat is not su ortedD :ou wi%% need to =ac)u the data to an e6terna% mediaD +ormat the dis)sD then restore the data to the new .o%ume. <he 0$" 4o%ume Mana'er wi%% automatica%%: se%ect the o tima% %a:out +or the new oo%D de endin' u on the num=er o+ dis)s se%ected. <he +o%%owin' +ormats are su ortedK Stri!e: reEuires at %east one dis) 4irror: reEuires at %east two dis)s 2AI6;1: reEuires at %east three dis)s 2AI6;2: reEuires at %east +our dis)s 2AI6;": reEuires at %east +i.e dis)s log de+ice: re+er to the the "e arate 9o' (e.ices section o+ the 0$" #est >ractices 3uide +or si8e recommendations. cac e de+ice: re+er to the "e arate Cache (e.ices section o+ the 0$" #est >ractices 3uide +or si8e recommendations. 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. (e endin' u on 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 S 4o%umes.
).3.!.1 +ncr. tion
#e'innin' with 2.3.1D $reeNA"1 su orts 359I +u%% dis) encr: tion when creatin' 0$" .o%umes. It is im ortant 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 o en sourced and is the ro ert: o+ -rac%e. <his is +u%% dis) encr: tion and %ot er;+i%es:stem encr: tion. <he under%:in' dri.es are +irst FreeNAS 9.1.1 Users Guide Page 111 of 276
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 wi e the dis)'s contents. <his desi'n is on%: suita=%e +or sa+e dis osa% o+ dis)s inde endent 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' ass hrase and an: =ac)u s 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:R <he encr: tion )e: is er 0$" .o%ume A oo%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 su ort A5";NI or i+ no cr: to hardware is insta%%ed. Without hardware acce%erationD there wi%% =e a=out a 20O 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 su ort the A5";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 com ares 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 e6istin'D unencr: ted .o%ume. InsteadD the data must =e =ac)ed u D the e6istin' 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 su orted. In other wordsD new%: created .de.s must match the e6istin' encr: tion scheme. When e6tendin' a .o%umeD 4o%ume Mana'er wi%% automatica%%: encr: t the new .de. =ein' added to the e6istin' encr: ted oo%. N9):: 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. 5nsure that on%: authori8ed users ha.e access to the administrati.e 3!I and that ro er ermissions are set on shares i+ sensiti.e data stored on the s:stem.
).3.!.2 Creating an +ncr. ted Volu&e
<o create an encr: ted .o%umeD chec) the N5ncr: tionN =o6 shown in $i'ure ,.3+. I+ :ou a%so chec) the NInitia%i8e "a+e%:N chec)=o6D random data wi%% =e written to the dis) =e+ore encr: tin' itD which can increase its cr: to'ra hic stren'th. Howe.erD doin' so si'ni+icant%: adds to the time it ta)es to create the .o%umeD es ecia%%: i+ it contains se.era% dis)s. A+ter ma)in' :our encr: tion se%ectionsD in ut the .o%ume nameD se%ect the dis)s to add to the .o%umeD and c%ic) the Add 4o%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 ass hrase on the )e:D ma)e a =ac)u o+ the )e:D and create a reco.er: )e:. Without theseD it is im ossi=%e to re;im ort the dis)s at a %ater time. FreeNAS 9.1.1 Users Guide Page 112 of 276
<o er+orm these tas)sD 'o to "tora'e S 4o%umes ;V 4iew 4o%umes. <his screen is shown in $i'ure ,.3o. <o set a ass hrase on the )e:D c%ic) the .o%ume name and then the NCreate >ass hraseN =utton Athe )e: sha ed icon in $i'ure ,.3oB which wi%% rom t to in ut and re eat the ass hrase. !n%i)e a asswordD a ass hrase can contain s aces and is t: ica%%: a series o+ words. A 'ood ass hrase is eas: to remem=er A%i)e the %ine to a son' or iece o+ %iteratureB =ut hard to 'uess A eo %e who )now :ou shou%d not =e a=%e to 'uess the ass hraseB. When :ou set the ass hraseD a warnin' messa'e wi%% remind :ou to create a new reco.er: )e: as a new ass hrase needs a new reco.er: )e:. <his wa:D i+ the ass hrase is +or'ottenD the associated reco.er: )e: can =e used instead. <o create the reco.er: )e:D c%ic) the NAdd reco.er: )e:N =utton Asecond %ast )e: icon in $i'ure ,.3oB. <his screen wi%% rom t :ou to the %ocation 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 N(own%oad )e:N =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. <he ass hraseD reco.er: )e:D and encr: tion )e: need to =e rotected. (o not re.ea% the ass hrase to others. -n the s:stem containin' the down%oaded )e:sD ta)e care that that s:stem and its =ac)u s are rotected. An:one who has the )e:s has the a=i%it: to re;im ort the dis)s shou%d the: =e discarded or sto%en. 6.".$ :,tending a ;FS @olu3e
<he P4o%ume to e6tendQ dro ;down menu in "tora'e S 4o%umes S 0$" 4o%ume Mana'erD shown in $i'ure ,.3'D can =e used to add additiona% dis)s to an e6istin' 0$" .o%ume. <his dro ;down em t: wi%% =e em t: i+ an e6istin' 0$" .o%ume does not e6ist. Figure 6."g: @olu3e to :,tend Field
Page 11" of 276
N9):: i+ the e6istin' .o%ume is encr: tedD a warnin' messa'e wi%% remind :ou that the o eration o+ e6tendin' a .o%ume wi%% reset the ass hrase and reco.er: )e:. A+ter e6tendin' the .o%umeD :ou shou%d immediate%: recreate =oth. -nce an e6istin' .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 e6am %e :ou canK se%ect an ""( or dis) with a .o%ume %a:out o+ -og FG2-H 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 F-2A&"H to add a cache de.ice to the 0$" oo%. add additiona% dis)s to increase the ca acit: o+ the 0$" oo%. <he ca.eats to doin' this are descri=ed =e%ow. When addin' dis)s to increase the ca acit: o+ a .o%umeD 0$" su orts the addition o+ .irtua% de.icesD )nown as .de.sD to an e6istin' 0$" oo%. A .de. can =e a sin'%e dis)D a stri eD 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' M howe.erD :ou can stri e 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 e6tend a 0$" .o%umeD :ou are rea%%: stri in' simi%ar .de.s. Here are some e6am %esK to e6tend a 0$" stri eD 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 e6istin' stri e. to e6tend a 0$" mirrorD add the same num=er o+ dri.es. <he resu%tin' stri ed mirror is a RAI( 10. to e6tend a three dri.e RAI(01D add three additiona% dri.es. <he resu%t is a RAI(0[0D simi%ar to RAI( *0 on a hardware contro%%er. to e6tend a RAI(02 reEuires a minimum o+ +our additiona% dri.es. <he resu%t is a RAI(02[0D simi%ar to RAI( ,0 on a hardware contro%%er. I+ :ou tr: to add an incorrect num=er o+ dis)s to the e6istin' .de.D an error messa'e wi%% a earD 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. 6.".6 &reating ;FS 6atasets
An e6istin' 0$" .o%ume can =e di.ided into datasets. >ermissionsD com ressionD 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 ermissionsM it is a%so simi%ar to a +i%es:stem in that :ou can set ro erties such as Euotas and com ression as we%% as create sna shots. N9):: 0$" ro.ides thic) ro.isionin' usin' Euotas and thin ro.isionin' usin' reser.ed s ace. I+ :ou se%ect an e6istin' 0$" .o%ume S Create 0$" (atasetD :ou wi%% see the screen shown in $i'ure ,.3h. -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 o tion +or the intended .o%ume or FreeNAS 9.1.1 Users Guide Page 11# of 276
dataset. I+ :ou 'et con+used when creatin' a dataset on a .o%umeD c%ic) a%% e6istin' datasets to c%ose them;;the remainin' Create 0$" (ataset wi%% =e +or the .o%ume. Figure 6." : &reating a ;FS 6ataset
<a=%e ,.3c summari8es the o tions 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 =o6 P"how ad.anced +ie%ds =: de+au%tQ in ":stem S "ettin's S Ad.anced. )a'le 6."c: ;FS 6ataset 9!tions Setting (ataset Name @alue strin' dro ;down Com ression 9e.e% menu 5na=%e atime ?uota +or this dataset ?uota +or this dataset and a%% chi%dren 6escri!tion mandator: see Com ression +or a com arison o+ the a.ai%a=%e a%'orithms
contro%s whether the access time +or +i%es is u dated when the: are InheritD -nD readM settin' this ro ert: to +ff a.oids roducin' %o' tra++ic when or -++ readin' +i%es and can resu%t in si'ni+icant er+ormance 'ains on%: a.ai%a=%e in Ad.anced ModeM de+au%t o+ 0 is o++M can s eci+: M inte'er Ame'a=:teBD 3 A'i'a=:teBD or < Atera=:teB as in 20/ +or 20 3#D can a%so inc%ude a decima% oint Ae.'. 2.,/B inte'er on%: a.ai%a=%e in Ad.anced ModeM de+au%t o+ 0 is o++M can s eci+: M Ame'a=:teBD 3 A'i'a=:teBD or < Atera=:teB as in 20/ +or 20 3# on%: a.ai%a=%e in Ad.anced ModeM de+au%t o+ 0 is un%imited A=esides hardwareBM can s eci+: M Ame'a=:teBD 3 A'i'a=:teBD or < Atera=:teB as in 20/ +or 20 3# Page 11$ of 276
Reser.ed s ace +or inte'er this dataset
Setting @alue Reser.ed s ace +or this dataset and a%% inte'er chi%dren dro ;down 0$" (edu %ication menu Record "i8e inte'er
6escri!tion on%: a.ai%a=%e in Ad.anced ModeM de+au%t o+ 0 is un%imited A=esides hardwareBM can s eci+: M Ame'a=:teBD 3 A'i'a=:teBD or < Atera=:teB as in 20/ +or 20 3# read the section on dedu %ication =e+ore ma)in' a chan'e to this settin' on%: a.ai%a=%e in Ad.anced ModeM whi%e 0$" automatica%%: ada ts the record si8e d:namica%%: to ada t to dataD i+ the data has a +i6ed si8e Ae.'. a data=aseBD settin' the &e'ord Si4e ma: resu%t in =etter er+ormance
).3.).1
Dedu lication
<he GFS ed!3li'ation o tion warns that ena=%in' dedu ma: ha.e drastic er+ormance im %ications and that com ression shou%d =e used instead. #e+ore chec)in' the dedu %ication =o6D read the section on dedu %ication in the 0$" -.er.iew +irst. <his artic%e ro.ides a 'ood descri tion 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* DO**D. <he dedu ta=%es used durin' dedu %ication need ]2 3# o+ RAM er 1<# o+ data to =e dedu %icated. $or er+ormance reasonsD consider usin' com ression rather than turnin' this o tion 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 com onents are shared amon' +i%es. I+ dedu %ication is chan'ed to CerifyD 0$" wi%% do a =:te;to;=:te com arison 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 e6treme%: rareD .eri+: is usua%%: not worth the er+ormance hit. N9):: once dedu %ication is ena=%edD the on%: wa: to disa=%e it is to use the =fs set dedu!Eoff dataset8na3e 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 ro ert: chan'e wi%% not =e dedu %icated. <he on%: wa: to remo.e e6istin' dedu %icated data is to co : a%% o+ the data o++ o+ the datasetD set the ro ert: to o++D then co : the data =ac) in a'ain. A%ternate%:D create a new dataset with the GFS ed!3li'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.'. .m33D .m3>D .a#iB is a%read: com ressedD meanin' that :ou wi%% increase C>! uti%i8ation +or no 'ain i+ :ou store these +i%es on a com ressed dataset. Howe.erD i+ :ou ha.e raw .<a# ri s o+ C(s or .#o$ ri s o+ (4(sD :ou wi%% see a er+ormance 'ain usin' a com ressed dataset. When se%ectin' a com ression t: eD :ou need to =a%ance er+ormance with the amount o+ com ression. <he +o%%owin' com ression a%'orithms are su ortedK l=#: recommended com ression method as it a%%ows com ressed datasets to o erate at near rea%; time s eed. g=i!: .aries +rom %e.e%s 1 to 9 where g4i3 fastest A%e.e% 1B 'i.es the %east com ression and g4i3 Page 116 of 276
ma(im!m A%e.e% 9B ro.ides the =est com ression =ut is discoura'ed due to its er+ormance im act. =le: +ast and sim %e a%'orithm to e%iminate runs o+ 8eroes. l=A': ro.ides decent data com ressionD =ut is considered de recated as %8& ro.ides much =etter er+ormance. &reating a =+ol
6.".7
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 e6tent. <o create a 8.o%D se%ect an e6istin' 0$" .o%ume or dataset S Create 8.o% which wi%% o en the screen shown in $i'ure ,.3i. <he con+i'uration o tions are descri=ed in <a=%e ,.3d. "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 =o6 P"how ad.anced +ie%ds =: de+au%tQ in ":stem S "ettin's S Ad.anced. Figure 6."i: &reating a =+ol
)a'le 6."d: =+ol &onfiguration 9!tions Setting 8.o% Name @alue strin' 6escri!tion in ut a name +or the 8.o%
Page 117 of 276
Setting "i8e +or this 8.o% Com ression %e.e% " arse .o%ume
@alue inte'er dro ;down menu chec)=o6
#%oc) si8e
inte'er
6escri!tion s eci+: si8e and .a%ue such as 10/ de+au%t o+ 2nherit means it wi%% use the same com ression %e.e% as the e6istin' 8 oo% used to create the 8.o% used to ro.ide thin ro.isionin'M i+ this o tion is se%ectedD writes wi%% +ai% when the oo% is %ow on s ace on%: a.ai%a=%e in Ad.anced ModeM .a%id si8e is an: ower o+ 2 +rom *12= to 122)= with a de+au%t si8e o+ 2)=M can =e set to match the =%oc) si8e o+ the +i%es:stem which wi%% =e +ormatted onto the i"C"I tar'et
6.".(
@ie/ing 6is7s
"tora'e S 4o%umes S 4iew (is)s a%%ows :ou to .iew a%% o+ the dis)s reco'ni8ed =: the $reeNA"1 s:stem. An e6am %e is shown in $i'ure ,.3I. Figure 6."A: @ie/ing 6is7s
$or each de.iceD the current con+i'uration o+ the o tions descri=ed in <a=%e ,.3e is dis %a:ed. C%ic) a dis)'s entr: and then its 5dit =utton to chan'e its con+i'uration. C%ic)in' a dis)'s entr: wi%% a%so dis %a: its Wi e =utton which can =e used to =%an) a dis) whi%e ro.idin' a ro'ress =ar o+ the wi e's status. !se this o tion =e+ore discardin' a dis). N9):: shou%d a dis)'s seria% num=er not =e dis %a:ed in this screenD use the s3artctl command within "he%%. $or e6am %eD to determine the seria% num=er o+ dis) ada0D t: e s3artctl ?a Fde+Fada1 M gre! Serial. 6.".9 @ie/ing @olu3es
I+ :ou c%ic) "tora'e S 4o%umes S 4iew 4o%umesD :ou can .iew and +urther con+i'ure e6istin' .o%umesD 0$" datasetsD and 8.o%s. <he e6am %e shown in $i'ure ,.3) demonstrates one 0$" .o%ume with two datasets and one 8.o%. FreeNAS 9.1.1 Users Guide Page 11( of 276
Figure 6."7: @ie/ing @olu3es
#uttons are ro.ided to ro.ide Euic) access to 0$" 4o%ume Mana'erD !$" 4o%ume Mana'erD Im ort 4o%umeD Auto Im ort 4o%umeD and 4iew (is)s. I+ the s:stem has mu%ti ath;ca a=%e hardwareD an e6tra =utton wi%% =e added to 4iew Mu%ti aths. I+ :ou c%ic) the entr: +or a 0$" .o%umeD ei'ht icons wi%% a ear at the =ottom o+ the screen. In order +rom %e+t to ri'htD these icons a%%ow :ou toK 1. 6etac @olu3e: a%%ows :ou to either detach a dis) =e+ore remo.in' it +rom the s:stem Aa%so )nown as a 0$" e6 ortB or to de%ete the contents o+ the .o%umeD de endin' u on the choice :ou ma)e in the screen that o s u when :ou c%ic) this =utton. <he o ;u messa'eD seen in $i'ure ,.3%D wi%% show the current used s aceD ro.ide the chec) =o6 NMar) the dis)s as new Adestro: dataBD rom t :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 B FS 'ol!(e$ o%l)C. <his means that the data is not destro:ed and the .o%ume can =e re;im orted at a %ater time. I+ :ou wi%% =e mo.in' a 0$" dri.e +rom one s:stem to anotherD er+orm this e6 ort action +irst. <his o eration +%ushes an: unwritten data to dis)D writes data to the dis) indicatin' that the e6 ort 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%: im act 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=. N9):: i+ :ou do cance% a scru=D the ne6t scru= wi%% start o.er +rom the =e'innin'D not where the cance%%ed scru= %e+t o++.
Page 119 of 276
Figure 6."l: 6etac ing or 6eleting a @olu3e
3. :dit ;FS 9!tions: a%%ows :ou to edit the .o%ume's com ression %e.e%D atime settin'D dataset EuotaD and reser.ed s ace +or Euota. I+ com ression is new%: ena=%ed on a .o%ume or dataset that a%read: contains dataD e6istin' +i%es wi%% not =e com ressed unti% the: are modi+ied as com ression is on%: a %ied when a +i%e is written. #. &reate ;FS 6ataset: 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 e6tent. ,. & ange Per3issions: a%%ows :ou to edit the .o%ume's userD 'rou D !ni6 rw6 ermissionsD t: e o+ AC9D and to ena=%e recursi.e ermissions on the .o%ume's su=directories. /. &reate Sna!s ot: a%%ows :ou to con+i'ure the sna shot's name and whether or not it is recursi.e =e+ore manua%%: creatin' a one;time sna shot. I+ :ou wish to schedu%e the re'u%ar creation o+ sna shotsD instead create a eriodic sna shot tas). 2. @olu3e Status: as seen in the e6am %e in $i'ure ,.3mD 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. I+ :ou c%ic) the entr: +or a de.iceD =uttons wi%% a ear to edit the de.ice's o tions Ashown in $i'ure ,.3nBD o++%ine the de.iceD or re %ace the de.ice Aas descri=ed in Re %acin' a $ai%ed (ri.e or ""(B.
Page 121 of 276
Figure 6."3: @olu3e Status
I+ :ou c%ic) a dis) in 4o%ume "tatus and c%ic) its P5dit (is)Q =uttonD :ou wi%% see the screen shown in $i'ure ,.3n. Figure 6."n: :diting a 6is7
Page 121 of 276
<a=%e ,.3e summari8es the con+i'ura=%e o tions. )a'le 6."e: 6is7 9!tions Setting Name "eria% (escri tion H(( "tand=: Ad.anced >ower Mana'ement Acoustic 9e.e% 5na=%e ".M.A.R.< ".M.A.R.<. e6tra o tions @alue strin' strin' strin' dro ;down menu dro ;down menu dro ;down menu chec)=o6 strin' 6escri!tion read;on%: .a%ue showin' $ree#"( de.ice name +or dis) read;on%: .a%ue showin' the dis)'s seria% num=er o tiona% indicates the time o+ inacti.it: Ain minutesB =e+ore the dri.e enters stand=: mode in order to conser.e ener': de+au%t is isa$ledD can se%ect a ower mana'ement ro+i%e +rom the menu de+au%t is isa$ledD can =e modi+ied +or dis)s that understand AAM ena=%ed =: de+au%t i+ the dis) su orts ".M.A.R.<.M unchec)in' this =o6 wi%% disa=%e an: con+i'ured ".M.A.R.<. <ests +or the dis) smartct%A2B o tions
N9):: .ersions o+ $reeNA"1 rior to 2.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+ 2.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 4o%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 sna shots o+ that dataset.
).3.1.1
2e. Manage&ent for +ncr. ted Volu&es
I+ :ou chec) the N5na=%e +u%% dis) encr: tionN =o6 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 e6am %e is seen in $i'ure ,.3o.
Page 122 of 276
Figure 6."o: :ncr*!tion Icons Associated /it an :ncr*!ted ;FS @olu3e
<hese icons are used toK &reate Pass! rase: c%ic) this icon to set and con+irm the ass hrase associated with the 359I 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 do not create a ass hrase or :ou +or'et the ass hraseD it is ossi=%e +or the data on the .o%ume to =ecome inaccessi=%e. An e6am %e wou%d =e a +ai%ed !"# stic) that reEuires a new insta%%ation on a new !"# stic) and a re;im ort o+ the e6istin' 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 ass hrase as an:one who )nows it cou%d re;im ort :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 a'tion in#alidates the 3re#io!s re'o#ery key. "ettin' a ass hrase in.a%idates the e6istin' )e:. -nce :ou set the ass hraseD immediate%: c%ic) the Add re'o#ery key =utton to create a new reco.er: )e:. -nce the ass hrase is setD the name o+ this icon wi%% chan'e to Chan'e >ass hrase. 6o/nload 0e*: c%ic) this icon to down%oad a =ac)u co : o+ the 359I encr: tion )e:. "ince the 359I encr: tion )e: is se arate +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. :ncr*!tion 2e?7e*: 'enerates a new 359I encr: tion )e:. <his reEuires the ass hrase +or the current )e:. <: ica%%: this is on%: er+ormed when the administrator sus ects that the current )e: ma: =e com romised. Add reco+er* 7e*: 'enerates a new reco.er: )e: and rom ts +or a %ocation to down%oad a =ac)u co : o+ the reco.er: )e:. <his reco.er: )e: can =e used i+ the ass hrase is +or'otten. Al-a)$ i((ediatel) add a reco.er: )e: whene.er the ass hrase is chan'ed. 2e3o+e reco+er 7e*: <: ica%%: this is on%: er+ormed when the administrator sus ects that the current reco.er: )e: ma: =e com romised. 1((ediatel) create a new ass hrase and reco.er: )e:. FreeNAS 9.1.1 Users Guide Page 12" of 276
6.".11
Setting Per3issions
"ettin' ermissions is an im ortant as ect o+ con+i'urin' .o%umes. <he 'ra hica% 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 o eratin' 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 e6am %es +or se.era% t: es o+ ro.ides an o.er.iew o+ the screen that is used to set ermissions. ermission scenarios. <his section
-nce a .o%ume or dataset is createdD it wi%% =e %isted =: its mount oint name in "tora'e S 4o%umes S 4iew 4o%umes. I+ :ou c%ic) the Chan'e >ermissions icon +or a s eci+ic .o%ume@datasetD :ou wi%% see the screen shown in $i'ure ,.3 . <a=%e ,.3+ summari8es the o tions in this screen. Figure 6."!: & anging Per3issions on a @olu3e or 6ataset
)a'le 6."f: 9!tions - en & anging Per3issions Setting @alue 6escri!tion dro ;down user to contro% the .o%ume@datasetM users which were manua%%: created or -wner AuserB menu im orted +rom Acti.e (irector: or 9(A> wi%% a ear in dro ;down menu dro ;down 'rou to contro% the .o%ume@datasetM 'rou s which were manua%%: created -wner A'rou B menu or im orted +rom Acti.e (irector: or 9(A> wi%% a ear in dro ;down Mode chec)=o6es chec) the desired !ni6 ermissions +or userD 'rou D and other FreeNAS 9.1.1 Users Guide Page 12# of 276
Setting <: e o+ AC9
@alue =u%%et se%ection
"et ermission chec)=o6 recursi.e%:
6escri!tion !ni6 and Windows AC9s are mutua%%: e6c%usi.eD this means that *ou 3ust select t e correct t*!e of A&< to 3atc t e s are M see the ara'ra h =e%ow the <a=%e +or more detai%s i+ chec)edD ermissions wi%% a%so a %: to su=directories o+ the .o%ume or datasetM i+ data a%read: e6ists 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 mi6 o+ o eratin' s:stems in :our networ)D se%ect !ni6 AC9s as a%% c%ients understand them. Windows AC9s are a ro riate when the networ) contains on%: Windows c%ients and are the re+erred o tion within an Acti.e (irector: domain. Windows AC9s add a su erset o+ ermissions that au'ment those ro.ided =: !ni6 AC9s. Whi%e Windows c%ients a%so understand !ni6 AC9sD the: won't =ene+it +rom the e6tra ermissions ro.ided =: Acti.e (irector: and Windows AC9s when !ni6 AC9s are used. N9):: 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 e6istin' data is not %ost i+ the t: e o+ AC9 is chan'ed. Howe.erD i+ :ou chan'e +rom Windows AC9s to !ni6 AC9sD the e6tended ermissions ro.ided =: Windows AC9s wi%% =e remo.ed +rom the e6istin' +i%es. 6.".11 @ie/ing 4ulti!at s
$reeNA"1 uses 'mu%ti athA2B to ro.ide mu%ti ath I@- su ort on s:stems containin' hardware that is ca a=%e o+ mu%ti ath. An e6am %e wou%d =e a dua% "A" e6 ander =ac) %ane in the chassis or an e6terna% C#-(. Mu%ti ath 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%ti ath;ca a=%e hardware. An: mu%ti ath;ca a=%e de.ices that are detected wi%% =e %aced in mu%ti ath units with the arent de.ices hidden. <he con+i'uration wi%% =e dis %a:ed in "tora'e S 4o%umes S 4iew Mu%ti athsD as seen in the e6am %e in $i'ure ,.3E. Note that this o tion wi%% not =e dis %a:ed in the "tora'e S 4o%umes tree on s:stems that do not contain mu%ti ath;ca a=%e hardware. Figure 6."C: @ie/ing 4ulti!at s
Page 12$ of 276
$i'ure ,.3E ro.ides an e6am %e o+ a s:stem with a "A" 0I9 and a "A" hard dri.e. <he 0I9 de.ice is ca a=%e o+ acti.e@acti.e writesD whereas the hard dri.e is ca a=%e o+ acti.e@read. 6.".12 2e!lacing a Failed 6ri+e or SS6
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 re air the de'raded state o+ the RAI(. (e endin' u on the ca a=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 ca a=%e hardware does not reEuire a re=oot. N9):: a stri e ARAI(0B does not ro.ide redundanc:. I+ :ou %ose a dis) in a stri eD :ou wi%% need to recreate the .o%ume and restore the data +rom =ac)u . <he ste s in this section can a%so =e used to re %ace a +ai%ed cache or %o' de.ice. N9):: i+ the dis) is a mem=er o+ an encr: ted 0$" oo%D ma)e sure that a ass hrase has =een set =e+ore attem tin' to re %ace the +ai%ed dri.e. #e+ore h:sica%%: remo.in' the +ai%ed de.iceD 'o to "tora'e S 4o%umes S 4iew 4o%umes S 4o%ume "tatus and %ocate the +ai%ed de.ice. -nce :ou ha.e %ocated the +ai%ed de.ice in the 3!ID er+orm the +o%%owin' ste sK 1. I+ the dis) is +ormatted with 0$"D c%ic) the dis)'s entr: then its -++%ine =utton in order to chan'e that dis)'s status to -$$9IN5. <his ste is needed to ro er%: remo.e the de.ice +rom the 0$" oo% and to re.ent swa issues. I+ :our hardware su orts hot; %u''a=%e dis)sD c%ic) the dis)'s -++%ine =uttonD u%% the dis)D then s)i to ste 3. N9):: i+ the rocess o+ chan'in' the dis)'s status to -$$9IN5 +ai%s with a Ndis) o++%ine +ai%ed ; no .a%id re %icasN messa'eD :ou wi%% need to scru= the 0$" .o%ume +irst usin' its "cru= 4o%ume =utton in "tora'e S 4o%umes S 4iew 4o%umes. -nce the scru= com %etesD tr: to -++%ine the dis) a'ain =e+ore roceedin'. 2. I+ the hardware is not AHCI ca a=%eD shutdown the s:stem in order to h:sica%%: re %ace the dis). When +inishedD return to the 3!I and %ocate the -$$9IN5 dis). 3. -nce the dis) is showin' as -$$9IN5D c%ic) the dis) a'ain and then c%ic) its PRe %aceQ =utton. "e%ect the re %acement dis) +rom the dro ;down menu and c%ic) the PRe %ace (is)Q =utton. I+ the dis) is a mem=er o+ an encr: ted 0$" oo%D :ou wi%% =e rom ted to in ut the ass hrase +or the oo%. -nce :ou c%ic) the PRe %ace (is)Q =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 P(etachQ =utton to remo.e the dis) +rom the %ist. In the e6am %e shown in $i'ure ,.3rD a +ai%ed dis) is =ein' re %aced =: dis) ada2 in the encr: ted .o%ume named #ol!me1. A warnin' messa'e reminds :ou that :ou need to create a new reco.er: )e: a+ter the dis) is re %aced.
Page 126 of 276
Figure 6."r: 2e!lacing a Failed 6is7
6.".1"
2e!lacing 6ri+es to Gro/ a ;FS Pool
<he recommended method +or e6 andin' the si8e o+ a 0$" oo% is to re; %an the num=er o+ dis)s in a .de. and to stri e additiona% .de.s usin' the 0$" 4o%ume Mana'er as additiona% ca acit: is needed. Howe.erD this is not an o tion i+ :ou do not ha.e o en 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 incor orate the new dis) into the oo% com %etesD then re eat 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!". N9):: this method reEuires the 0$" ro ert: autoe6 and. <his ro ert: =ecame a.ai%a=%e startin' with $reeNA"1 .ersion 2.3.0. I+ :ou are runnin' an ear%ier .ersion o+ $reeNA"1D u 'rade =e+ore attem tin' this method. Chec) and .eri+: that the autoe6 and ro ert: is ena=%ed be*ore attem tin' to 'row the oo%. I+ it is notD the oo% wi%% not reco'ni8e that the dis) ca acit: has increased. #: de+au%tD this ro ert: is ena=%ed in $reeNA"1 .ersions 2.3.1 and hi'her. <o .eri+: the ro ert:D use "he%%. <his e6am %e chec)s the 0$" .o%ume named Col1K
zpool NAME Vol1 Vol1 Vol1 Vol1 Vol1 Vol1 Vol1 Vol1 Vol1 get all Vol1 PROPERTY size capacity altroot health guid version bootfs delegation autoreplace
VALUE 4.53T 31% /mnt ONLINE 8068631824452460057 28 on off
SOURCE local default default default default default
Page 127 of 276
Vol1 Vol1 Vol1 Vol1 Vol1 Vol1 Vol1 Vol1 Vol1 Vol1
cachefile failmode listsnapshots autoexpand dedupditto dedupratio free allocated readonly comment
/data/zfs/zpool.cache wait off on 0 1.00x 3.12T 1.41T off -
local default default local default default
I+ autoe6 ansion is not ena=%edD ena=%e it =: s eci+:in' the name o+ the 0$" .o%umeK
zpool set autoexpand=on Vol1
4eri+: that autoe6 and is now ena=%ed =: re eatin' =!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 or ""(. 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 ne6t dri.e. -nce a%% the dri.es are re %aced and the resi%.er com %etesD :ou shou%d see the added s ace in the oo%. Fou can .iew the status o+ the resi%.er rocess =: runnin' =!ool status @ol1.
).3.13.1 +nabling /#S 0ool +3 ansion After Drive "e lace&ent
It is recommended to ena=%e the autoe6 and ro ert: =e+ore :ou start re %acin' dri.es. I+ the ro ert: is not ena=%ed =e+ore re %acin' some or a%% o+ the dri.esD e6tra con+i'uration is needed to in+orm 0$" o+ the e6 anded ca acit:. 4eri+: that autoe6 and 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 3>< 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' e6am %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 ne6t dri.e. <o +ind the 3>< I( in+ormation +or the dri.esD use =!ool status NPool8Na3eO 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 config: NAME Vol1 raidz1-0 gptid/d5ed48a4-634a-11e2-963c-00e081740bfe gptid/03121538-62d9-11e2-99bd-00e081740bfe gptid/252754e1-6266-11e2-8088-00e081740bfe gptid/9092045a-601d-11e2-892e-00e081740bfe
Mar 10 17:24:20 2013 STATE ONLINE ONLINE ONLINE ONLINE ONLINE ONLINE READ WRITE CKSUM 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Page 12( of 276
gptid/670e35bc-5f9a-11e2-92ca-00e081740bfe errors: No known data errors
ONLINE
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 ha ensD wait +or the resi%.erin' rocess to com %ete. Ne6tD e6 ort and then im ort the oo%K
zpool export Vol1 zpool import -R /mnt Vol1
-nce the im ort com %etesD a%% o+ the dri.e s ace shou%d =e a.ai%a=%e. 4eri+: that the increased si8e is reco'ni8edK
zpool list Vol1 NAME SIZE ALLOC Vol1 9.06T 1.41T FREE 7.24T CAP 31% DEDUP 1.00x HEALTH ONLINE ALTROOT /mnt
6.".1#
S!litting a 4irrored ;FS Storage Pool
0$".22 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. N9):: 8 oo% s %it on%: wor)s on mirrored 0$" .o%umes. In this e6am %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 config: NAME STATE READ WRITE CKSUM 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
6 16:10:58 2011
<he +o%%owin' command s %its +rom the e6istin' three dis) mirror test a new 0$" .o%ume named migrant containin' one dis)D da>. (is)s da0 and da1 remain in test.
zpool split test migrant da4
At this ointD da> can =e h:sica%%: remo.ed and insta%%ed to a new s:stem as the new oo% is e6 orted as it is created. -nce h:sica%%: insta%%edD im ort 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 ro erties come a%on' with the c%oneD so the new oo% wi%% =e mounted where the o%d oo% was mounted i+ the mount oint ro ert: was set on the ori'ina% oo%. FreeNAS 9.1.1 Users Guide Page 129 of 276
4eri+: the status o+ the new oo%K

zpool status pool: migrant state: ONLINE scan: resilvered 568K in 0h0m with 0 errors on Wed Jul config: NAME STATE READ WRITE CKSUM migrant ONLINE 0 0 0 da4 ONLINE 0 0 0 errors: No known data errors
6 16:10:58 2011
-n the ori'ina% s:stemD the status now %oo)s %i)e thisK

zpool status pool: test state: ONLINE scan: resilvered 568K in 0h0m with 0 errors on Wed Jul config: NAME STATE READ WRITE CKSUM test ONLINE 0 0 0 mirror-0 ONLINE 0 0 0 da1 ONLINE 0 0 0 da0 ONLINE 0 0 0 errors: No known data errors
6 16:10:58 2011
At this ointD it is recommended to add dis)s to create a +u%% mirror set. <his e6am %e adds two dis)s named da2 and da3K
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 scan: resilvered 572K in 0h0m with 0 errors on Wed Jul config: NAME STATE READ WRITE CKSUM migrant ONLINE 0 0 0 mirror-0 ONLINE 0 0 0 da4 ONLINE 0 0 0 da2 ONLINE 0 0 0 da3 ONLINE 0 0 0
6 16:43:27 2011
Now that the new s:stem has =een c%onedD :ou can detach da> 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
Page 1"1 of 276
"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
6.#
;FS Scru's
"tora'e S 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 corru tions 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. (e endin' u on the amount o+ dataD a scru= can ta)e a %on' time. "cru=s are I@- intensi.e and can ne'ati.e%: im act er+ormance. <he: shou%d =e schedu%ed +or e.enin's or wee)ends to minimi8e the im act to users. A 0$" scru= on%: chec)s used dis) s ace. <o chec) unused dis) s aceD schedu%e a ".M.A.R.<. <est Ay3e o+ -ong Self-Aest 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 S 0$" "cru=s and a summar: o+ this entr: can =e .iewed in "tora'e S 0$" "cru=s S 4iew 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 o tions in this screen. Figure 6.#a: @ie/ing a @olu3e.s 6efault Scru' Settings
)a'le 6.#a: ;FS Scru' 9!tions Setting 4o%ume <hresho%d da:s (escri tion @alue 6escri!tion dro ;down menu se%ect 0$" .o%ume to scru= num=er o+ da:s =etween scru=sM the de+au%t is a mu%ti %e o+ / to inte'er ensure the scru= a%wa:s occurs on the same da: o+ the wee) strin' o tiona% Page 1"1 of 276
Setting
@alue s%ider or minute Minute se%ections s%ider or hour Hour se%ections s%ider or month (a: o+ Month se%ections Month chec)=o6es (a: o+ wee) chec)=o6es 5na=%ed chec)=o6
6escri!tion i+ use the s%iderD scru= occurs e.er: N minutesM i+ use minute se%ectionsD scru= starts at the hi'h%i'hted minutes i+ use the s%iderD scru= occurs e.er: N hoursM i+ use hour se%ectionsD scru= occurs at the hi'h%i'hted hours i+ use the s%iderD scru= occurs e.er: N da:sM i+ use month se%ectionsD scru= occurs on the hi'h%i'hted da:s o+ the se%ected months scru= occurs on the se%ected months scru= occurs on the se%ected da:sM de+au%t is S!nday to %east im act users 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 tem orar: 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 S 4o%umes S 0$" "cru=s S Add 0$" "cru=.
S aring &onfiguration
-nce :ou ha.e a .o%umeD create at %east one share so that the stora'e is accessi=%e =: the other com uters in :our networ). <he t: e o+ share :ou create de ends u on the o eratin' s:stemAsB runnin' in :our networ)D :our securit: reEuirementsD and e6 ectations +or networ) trans+er s eeds. <he +o%%owin' t: es o+ shares and ser.ices are a.ai%a=%eK A!!le IAFPG S aresK the A com uters run Mac -" 7. %e $i%e >rotoco% AA$>B t: e o+ share is a 'ood choice i+ a%% o+ :our
Uni, INFSG S aresK the Networ) $i%e ":stem AN$"B t: e o+ share is accessi=%e =: Mac -" 7D 9inu6D #"(D and the ro+essiona%@enter rise .ersions Anot the home editionsB o+ Windows. It is a 'ood choice i+ there are man: di++erent o eratin' s:stems in :our networ). (e endin' u on the o eratin' s:stemD it ma: reEuire the insta%%ation or con+i'uration o+ c%ient so+tware on the des)to . -indo/s I&IFSG S aresK the Common Internet $i%e ":stem ACI$"B t: e o+ share is accessi=%e =: WindowsD Mac -" 7D 9inu6D and #"( com utersD =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 o tions 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 %imitedM i+ :our C>! is ma6ed outD :ou need to u 'rade the C>! or consider another t: e o+ share.
Page 1"2 of 276
I+ :ou are %oo)in' +or a so%ution that a%%ows +ast access +rom an: o eratin' 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. N9):: whi%e the 3!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 e6am %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 e6am %eK i+ a .o%ume is con+i'ured +or =oth A$> and CI$"D Windows users ma: =e con+used =: the e6tra +i%enames used =: Mac +i%es and de%ete the ones the: don't understandM this wi%% corru t 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 su ort 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.
7.1
A!!le IAFPG S ares
$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 im ort users and 'rou sD 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 S Contro% "er.ices. <his section descri=es the con+i'uration screen +or creatin' the A$> share. It then ro.ides con+i'uration e6am %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.
7.1.1
&reating AFP S ares
I+ :ou c%ic) "harin' S A %e AA$>B "hares S 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 =o6 P"how ad.anced +ie%ds =: de+au%tQ in ":stem S "ettin's S Ad.anced. <a=%e /.1a summari8es the a.ai%a=%e o tions when creatin' an A$> share. Re+er to "ettin' u Netata%) +or a more detai%ed e6 %anation o+ the a.ai%a=%e o tions. -nce :ou ress the -K =utton when creatin' the A$> shareD a o ;u menu wi%% as) NWou%d :ou %i)e to ena=%e this ser.iceUN C%ic) Fes and "er.ices S Contro% "er.ices wi%% o en and indicate whether or not the A$> ser.ice success+u%%: started.
Page 1"" of 276
Figure 7.1a: &reating an AFP S are
)a'le 7.1a: AFP S are &onfiguration 9!tions Setting 6escri!tion .o%ume name that wi%% a ear in the Mac com uter's Pconnect to Name strin' ser.erQ dia%o'ueM %imited to 2/ characters and can not contain a eriod "hare Comment strin' o tiona% >ath =rowse =utton =rowse to the .o%ume@dataset to share ma6imum o+ 2 charactersM this assword is in addition to the user's "hare assword strin' assword when authenticatin' "hare Character on%: a.ai%a=%e in Ad.anced ModeM e6am %es inc%ude 1AF, and 2S+I strin' "et ,,E9-1E comma de%imited %ist o+ a%%owed users and@or 'rou s where A%%ow 9ist strin' 'rou name =e'ins with a T comma de%imited %ist o+ denied users and@or 'rou s where (en: 9ist strin' 'rou name =e'ins with a T comma de%imited %ist o+ users and@or 'rou s who on%: ha.e read Read;on%: Access strin' access where 'rou name =e'ins with a T Read;write comma de%imited %ist o+ users and@or 'rou s who ha.e read and write strin' Access access where 'rou name =e'ins with a T FreeNAS 9.1.1 Users Guide Page 1"# of 276 @alue
Setting (is) (isco.er: (is) disco.er: mode
@alue chec)=o6 dro ;down menu
(ata=ase >ath
strin'
Cache CNI(
chec)=o6
<rans%ate CR@9$ chec)=o6 Windows $i%e Names 5na=%e .A %e(ou=%e 0ero (e.ice Num=ers (isa=%e $i%e I( (isa=%e Khe6 Names >ro(-" No "tat A$>3 !NI7 >ri.s chec)=o6 chec)=o6 chec)=o6 chec)=o6 chec)=o6 chec)=o6 chec)=o6
6escri!tion ena=%e i+ there is no (N" record +or the $reeNA"1 s:stem choices are efa!lt or Aime =a'hine AA %e's =ac)u uti%it:BM due to a %imitation in how Mac dea%s with %ow;dis)s ace issues when mu%ti %e Mac's share the same .o%umeD se%ectin' Aime =a'hine on mu%ti %e shares is discoura'ed as it ma: resu%t in intermittent +ai%ed =ac)u s s eci+: the ath to store the CNI( data=ases used =: A$> Ade+au%t is the root o+ the .o%umeBM the ath must =e writa=%e on%: a.ai%a=%e in Ad.anced ModeM i+ chec)edD A$> uses the I( in+ormation stored in A %e(ou=%e header +i%es to reduce data=ase %oadM do not set this o tion i+ the .o%ume is modi+ied =: non;A$> c%ients Ae.'. N$" or CI$"B i+ chec)edD A$> automatica%%: con.erts Macintosh %ine =rea)s into !ni6 onesM ma: =rea) some o%der ro'rams i+ chec)edD +orces 2.3 +i%ename restrictions im osed =: o%der .ersions o+ WindowsM it is %ot reco((e%ded *or 'ol!(e$ (ai%l) !$ed b) Mac$ as it =rea)s some some a %ications Ae.'. -++ice7B shou%d on%: =e unchec)ed when the networ) contains no Mac c%ients on%: a.ai%a=%e in Ad.anced ModeM ena=%e when the de.ice num=er is not constant across a re=oot on%: a.ai%a=%e in Ad.anced ModeM i+ ena=%edD A$> wi%% not ad.ertise create+i%eidD reso%.eidD and de%eteid ca%%s on%: a.ai%a=%e in Ad.anced ModeM i+ this =o6 is chec)edD A$> disa=%es Khe6 trans%ations +or an:thin' e6ce t dot +i%esM this o tion ma)es the @ character i%%e'a% on%: a.ai%a=%e in Ad.anced ModeM i+ chec)edD ro.ides com ati=i%it: with A %e II c%ients on%: a.ai%a=%e in Ad.anced ModeM i+ chec)edD A$> won't stat the .o%ume ath when enumeratin' the .o%umes %istM use+u% +or automountin' or .o%umes created =: a ree6ec scri t ena=%es !ni6 ri.i%e'es su orted =: -"7 10.* and hi'herM do not ena=%e i+ the networ) contains Mac -" 7 10.& c%ients or %ower as the: do not su ort these on%: wor)s with !ni6 AC9sM new +i%es created on the share are set with the se%ected ermissions on%: wor)s with !ni6 AC9sM new directories created on the share are set with the se%ected ermissions
chec)=o6
(e+au%t +i%e chec)=o6es ermission (e+au%t director: chec)=o6es ermission
Page 1"$ of 276
7.1.2
&onnecting to AFP S ares As Guest
A$> su orts '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 im orted into the the $reeNA"1 s:stem. In this con+i'uration e6am %eD the A$> share has =een con+i'ured +or 'uest access as +o%%owsK 1. A 0$" .o%ume named 7mnt7data 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%% a ear to Mac -" 7 c%ientsB >athK 7mnt7data "hare >asswordK the assword that wi%% =e used to access the share has =een in ut and con+irmed A%%ow 9istK set to no$ody Read;write AccessK set to no$ody (is) (isco.er:K chec)=o6 has =een chec)ed
3. "er.ices S A$> has =een con+i'ured as +o%%owsK "er.er NameK freenas 3uest AccessK chec)=o6 is chec)ed no$ody is se%ected in the 3uest account dro ;down menu
-nce the A$> ser.ice has =een started in "er.ices S Contro% "er.icesD Mac -" 7 users can connect to the A$> share =: c%ic)in' 3o S Connect to "er.er. In the e6am %e shown in $i'ure /.1=D the user has in ut af3)77 +o%%owed =: the I> address o+ the $reeNA"1 s:stem. C%ic) the Connect =utton and a %o'in =o6D seen in $i'ure /.1cD wi%% a ear. "ince a assword has =een con+i'ured +or this A$> shareD the user must in ut the share assword Ai.e. not their own asswordB. -nce connectedD $inder wi%% automatica%%: o en. <he name o+ the A$> share wi%% =e dis %a:ed in the "HAR5( section in the %e+t +rame and the contents o+ the share wi%% =e dis %a:ed in the ri'ht +rame. In the e6am %e shown in $i'ure /.1dD 7mnt7data has one +o%der named ima'es. <he user can now co : +i%es to and +rom the share.
Page 1"6 of 276
Figure 7.1': &onnect to Ser+er 6ialogue
Figure 7.1c: Aut enticating to t e AFP S are
Page 1"7 of 276
Figure 7.1d: @ie/ing t e &ontents of t e S are Fro3 a 4ac S*ste3
<o disconnect +rom the .o%umeD c%ic) the eIect =utton in the "hared side=ar.
7.1."
Using )i3e 4ac ine
Mac -" 7 inc%udes the <ime Machine a %ication which can =e used to schedu%e automatic =ac)u s. In this con+i'uration e6am %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 7mnt7data7$a'k!3*!ser1 with a Euota o+ :0/ was created in "tora'e S 4o%umes S Create 0$" (ataset. 2. A user account was created as +o%%owsK !sernameK !ser1 Home (irector:K 7mnt7data7$a'k!3*!ser1 the $u%% NameD 5;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 Page 1"( of 276
3. An A$> share with a Name o+ $a'k!3*!ser1 has =een created with the +o%%owin' attri=utesK >athK 7mnt7data7$a'k!3*!ser1 A%%ow 9istK set to !ser1 Read;write AccessK set to !ser1 (is) (isco.er:K chec)=o6 has =een chec)ed (is) (isco.er: modeK set to Aime =a'hine
&. "er.ices S A$> has =een con+i'ured as +o%%owsK "er.er NameK freenas 3uest AccessK chec)=o6 is unchec)ed
*. <he A$> ser.ice has =een started in "er.ices S Contro% "er.ices. <o con+i'ure <ime Machine on the Mac -" 7 c%ientD 'o to ":stem >re+erences S <ime Machine which wi%% o en 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 o tion. In our e6am %eD it is %isted as $a'k!3*!ser1 on JfreenasJ. Hi'h%i'ht the entr: re resentin' the $reeNA"1 s:stem and c%ic) the P!se #ac)u (is)Q =utton. A connection =ar wi%% o en and wi%% rom t +or the user account's assword;;in this e6am %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 ne6t 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 ]21 3# in si8e. I+ :ou recei.e a N<ime Machine cou%d not com %ete the =ac)u . <he =ac)u dis) ima'e cou%d not =e created Aerror &*BN error when =ac)in' u to the $reeNA"1 s:stemD :ou wi%% need to create a s arse=und%e ima'e usin' these instructions. I+ :ou recei.e the messa'e P<ime Machine com %eted a .eri+ication o+ :our =ac)u s. <o im ro.e re%ia=i%it:D <ime Machine must create a new =ac)u +or :ou.Q and :ou do not want to er+orm another com %ete =ac)u or %ose ast =ac)u sD +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 s arse=und%e =ac)u is corru t.
Page 1"9 of 276
Figure 7.1e: &onfiguring )i3e 4ac ine on 4ac 9S B <ion
7.2
Uni, INFSG S ares
$reeNA"1 su orts 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 a ears as Iust another director: on the c%ient s:stem. "ome 9inu6 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 5nter rise editions or insta%% an N$" c%ient a %ication. N9):: +or er+ormance reasonsD i"C"I is re+erred to N$" shares when $reeNA" is insta%%ed on 5"7i. I+ :ou are considerin' creatin' N$" shares on 5"7iD read throu'h the er+ormance ana%:sis at Runnin' 0$" o.er N$" as a 4Mware "tore. Con+i'urin' N$" is a mu%ti;ste rocess that reEuires :ou to create N$" shareAsBD con+i'ure N$" in "er.ices S N$"D then start N$" in "er.ices S "er.ices. It does not reEuire :ou to create users or 'rou s 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 e6am %eD demonstrates how to connect to the share +rom .arious o eratin' s:stemsD and ro.ides some trou=%eshootin' ti s.
Page 1#1 of 276
7.2.1
&reating NFS S ares
<o create an N$" shareD c%ic) "harin' S !ni6 AN$"B "hares S Add !ni6 AN$"B "hareD shown in $i'ure /.2a. Figure 7.2a: &reating an NFS S are
-nce :ou ress the -K =utton when creatin' the N$" shareD a o ;u menu wi%% as) NWou%d :ou %i)e to ena=%e this ser.iceUN C%ic) Fes and "er.ices S Contro% "er.ices wi%% o en and indicate whether or not the N$" ser.ice success+u%%: started. <a=%e /.2a summari8es the o tions in this screen. )a'le 7.2a: NFS S are 9!tions Setting Comment Authori8ed networ)s Authori8ed I> addresses or hosts A%% directories Read on%: ?uiet @alue strin' strin' strin' chec)=o6 chec)=o6 chec)=o6 6escri!tion used to set the share nameM i+ %e+t em t:D share name wi%% =e the %ist o+ se%ected >aths s ace 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) s ace de%imited %ist o+ a%%owed I> addresses or hostnames i+ chec)edD the c%ient can mount an: su=director: within the 6ath rohi=its writin' to the share inhi=its some s:s%o' dia'nostics which can =e use+u% to a.oid some anno:in' error messa'esM see e6 ortsA*B +or e6am %es
Page 1#1 of 276
Setting @alue 6escri!tion Ma root !ser dro ;down menu i+ a user is se%ectedD the root user is %imited to that user's ermissions i+ a 'rou is se%ectedD the root user wi%% a%so =e %imited to that Ma root 3rou dro ;down menu 'rou 's ermissions Ma a%% !ser dro ;down menu the s eci+ied user's ermissions are used =: a%% c%ients Ma a%% 3rou dro ;down menu the s eci+ied 'rou 's ermission are used =: a%% c%ients =rowse to the .o%ume@dataset@director: to shareM c%ic) Add e(tra >ath =rowse =utton 3ath to se%ect mu%ti %e aths When creatin' the N$" shareD )ee the +o%%owin' oints in mindK 1. <he Ma root and Ma a%% o tions are e6c%usi.eD meanin' :ou can on%: use one or the other;;the 3!I wi%% not %et :ou use =oth. <he Ma a%% o tions su ersede the Ma root o tions. I+ :ou on%: wish to restrict the root user's ermissionsD set the Ma root o tion. I+ :ou wish to restrict the ermissions o+ a%% usersD set the Ma a%% o tion. 2. 5ach .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 NA%% directoriesN o tion 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.07, and 20.0.0.07, 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 Aut ori=ed net/or7s: 10.0.0.07, 20.0.0.07, Pat : 7mnt7#ol!me17dataset1 and @mnt7#ol!me17dataset17dire'tory1 InsteadD :ou shou%d se%ect the >ath o+ 7mnt7#ol!me17dataset1 and chec) the NA%% directoriesN =o6. Howe.erD :ou cou%d restrict that director: to one o+ the networ)s =: creatin' two shares as +o%%ows. $irst N$" shareK Aut ori=ed net/or7s: 10.0.0.07, Pat : 7mnt7#ol!me17dataset1 "econd N$" shareK Aut ori=ed net/or7s: 20.0.0.07, Pat : 7mnt7#ol!me17dataset17dire'tory1 Note that this reEuires the creation o+ two shares as it can not =e accom %ished in one share.
Page 1#2 of 276
7.2.2
Sa3!le NFS S are &onfiguration
#: de+au%t the Ma a%% o tions shown in $i'ure /.2a show as N7A. <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 s eci+ications. 3. "e%ect no$ody in the Ma a%% !ser and Ma a%% 3rou dro ;down menus +or the share in "harin' S !ni6 AN$"B "hares. With this con+i'urationD it does not matter which user account connects to the N$" shareD as it wi%% =e ma ed to the no$ody user account and wi%% on%: ha.e the ermissions that :ou s eci+ied on the .o%ume@dataset. $or e6am %eD e.en i+ the root user is a=%e to connectD it wi%% not 'ain root access to the share. 7.2." &onnecting to t e NFS S are
In the +o%%owin' e6am %esD an N$" share on a $reeNA"1 s:stem with the I> address o+ 192.1:,.2.2 has =een con+i'ured as +o%%owsK 1. A 0$" .o%ume named 7mnt7data 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
(.2.3.1
>athK 7mnt7data Authori8ed Networ)K 192.1:,.2.072> Ma A%% !ser and Ma A%% 3rou are =oth set to no$ody the A%% (irectories chec)=o6 has =een chec)ed
#ro& BSD or ,inu3 Clients
<o ma)e this share accessi=%e on a #"( or a 9inu6 s:stemD run the +o%%owin' command as the su eruser Aor with sudoB +rom the c%ient s:stem. Re eat 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' o tionsK ?t nfs: s eci+ies the t: e o+ share. 192.16(.2.2: re %ace with the I> address o+ the $reeNA"1 s:stem F3ntFdata: re %ace with the name o+ the N$" share F3nt: a mount oint on the c%ient s:stem. <his must =e an e6istin'D e("t) director:. <he data in the N$" share wi%% =e made a.ai%a=%e to the c%ient in this director:. FreeNAS 9.1.1 Users Guide Page 1#" of 276
<he 3ount command shou%d return to the command rom t 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 7mnt Athe mount ointB and a%% +i%es wi%% =e owned =: no$ody)no$ody. An: chan'es to 7mnt wi%% =e sa.ed to the $reeNA"1 s:stem's 7mnt7data .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 su eruserK
umount /mnt
(.2.3.2
#ro& Microsoft Clients
5nter rise .ersions o+ Windows s:stems can connect to N$" shares usin' "er.ices +or N$". 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 5nter rise .ersion o+ Windows / can =e +ound at Mount 9inu6 N$" "hare on Windows /. N9):: "er.ices +or N$" is on%: a.ai%a=%e in the !%timate or 5nter rise editions o+ Windows. I+ :our Windows c%ient is runnin' a Home 5dition o+ Windows /D Ne)odri.e ro.ides an o en source 'ra hica% N$" c%ient. <o use this c%ientD :ou wi%% need to insta%% the +o%%owin' on the Windows s:stemK /8i to e6tract the Ne)odri.e down%oad +i%es N$"C%ient and N$"9i=rar: +rom the Ne)odri.e down%oad a'eM once down%oadedD e6tract these +i%es usin' /8i .N5< $ramewor) &.0 -nce e.er:thin' is insta%%edD run the N$"C%ient e6ecuta=%e to start the 3!I c%ient. In the e6am %e shown in $i'ure /.2=D the user has connected to the e6am %e 7mnt7data share o+ the $reeNA"1 s:stem at 192.1:,.2.2. N9):: Ne)odri.e does not su this uti%it: instead. ort 56 %orer dri.e ma in' .ia N$". I+ :ou need this +unctiona%it:D tr:
Page 1## of 276
Figure 7.2': Using t e Ne7odri+e NFS&lient fro3 -indo/s 7 %o3e :dition
(.2.3.3
#ro& Mac 4S 5 Clients
<o mount the N$" .o%ume +rom a Mac -" 7 c%ientD c%ic) on 3o S Connect to "er.er. In the "er.er Address +ie%dD in ut nfs)77 +o%%owed =: the I> address o+ the $reeNA"1 s:stem and the name o+ the .o%ume@dataset =ein' shared =: N$". <he e6am %e shown in $i'ure /.2c continues with our e6am %e o+ 192.1:,.2.2)7mnt7data. -nce connectedD $inder wi%% automatica%%: o en. <he I> address o+ the $reeNA"1 s:stem wi%% =e dis %a:ed in the "HAR5( section in the %e+t +rame and the contents o+ the share wi%% =e dis %a:ed in the ri'ht +rame. In the e6am %e shown in $i'ure /.2dD 7mnt7data has one +o%der named images. <he user can now co : +i%es to and +rom the share.
Page 1#$ of 276
Figure 7.2c: 4ounting t e NFS S are fro3 4ac 9S B
Figure 7.2d: @ie/ing t e NFS S are in Finder
Page 1#6 of 276
7.2.#
)rou'les ooting
"ome N$" c%ients do not su ort 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 attem ted. <o reso%.e this errorD add the o tion ?o noloc7 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 Ntime out 'i.in' u N when tr:in' to mount the share +rom a 9inu6 s:stemD ma)e sure that the ortma er ser.ice is runnin' on the 9inu6 c%ient and start it i+ it is not. I+ ortma er 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 NR>CK >ro'ram not re'isteredND 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' Nre.erse (N"N or timeout errorsD add an entr: +or the I> address o+ the $reeNA"1 s:stem in the NHost name data=aseN +ie%d o+ Networ) S 3%o=a% Con+i'uration.
7."
-indo/s I&IFSG S ares
$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 o eratin' s:stems and most 9inu6 and #"( s:stems re;insta%% the "am=a c%ient which ro.ides su ort +or CI$". I+ :our distro did notD insta%% the "am=a c%ient usin' :our distro's so+tware re ositor:. 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 S CI$"D then ena=%e the CI$" ser.ice in "er.ices S 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 S (irector: "er.ices S Acti.e (irector:. (e endin' u on :our authentication reEuirementsD :ou ma: need to create or im ort users and 'rou s. <his section wi%% demonstrate some common con+i'uration scenariosK 7.".1 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 e6am %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 Co iesD see Con+i'urin' "hadow Co ies. I+ :ou are ha.in' ro=%ems accessin' :our CI$" shareD see <rou=%eshootin' <i s. &reating &IFS S ares
$i'ure /.3a shows the con+i'uration screen that a ears when :ou c%ic) "harin' S Windows ACI$" "haresB S Add Windows ACI$"B "hare. "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 =o6 P"how ad.anced +ie%ds =: de+au%tQ in ":stem S "ettin's S Ad.anced.
Page 1#7 of 276
<a=%e /.3a summari8es the o tions when creatin' a CI$" share. sm=.con+A*B ro.ides more detai%s +or each con+i'ura=%e o tion. -nce :ou ress the -K =utton when creatin' the CI$" shareD a o ;u menu wi%% as) NWou%d :ou %i)e to ena=%e this ser.iceUN C%ic) Fes and "er.ices S Contro% "er.ices wi%% o en and indicate whether or not the CI$" ser.ice success+u%%: started. Figure 7."a: Adding a &IFS S are
)a'le 7."a: 9!tions for a &IFS S are Setting Name Comment >ath 56 ort Read -n%: #rowsa=%e to Networ) C%ients Inherit -wner @alue strin' strin' =rowse =utton chec)=o6 chec)=o6 chec)=o6 6escri!tion mandator:M name o+ share o tiona% descri tion se%ect .o%ume@dataset@director: to share rohi=its write access to the share ena=%es Windows c%ients to =rowse the shared director: usin' Windows 56 %orer i+ chec)edD ownershi +or new +i%es and directories is inherited +rom arent director: rather than +rom the user i+ chec)edD ermissions on new +i%es and directories are inherited +rom arent director:M this can =e use+u% on %ar'e s:stems with man: users as it a%%ows a sin'%e homes share to =e used +%e6i=%: =: each userM do %ot chec0 i* T)"e o* A42 i$ $et to 8i%do-$ i% the 3ol!(e@$ "er(i$$io%$ Page 1#( of 276
Inherit >ermissions
chec)=o6
Setting 56 ort Rec:c%e #in
@alue chec)=o6
"how Hidden $i%es chec)=o6 A%%ow 3uest Access chec)=o6
-n%: A%%ow 3uest chec)=o6 Access Hosts A%%ow strin'
Hosts (en: Au6i%iar: >arameters
strin'
strin'
6escri!tion de%eted +i%es are instead mo.ed to a hidden .re'y'le director: in the root +o%der o+ the share i+ ena=%edD wi%% dis %a: +i%enames that =e'in with a dot A!ni6 hidden +i%esB 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 S CI$" reEuires Allo< g!est a''ess to a%so =e chec)edM +orces 'uest access +or a%% connections on%: a.ai%a=%e in Ad.anced ModeM commaD s aceD or ta= de%imited %ist o+ a%%owed hostnames or I> addressesM see N-<5 =e%ow on%: a.ai%a=%e in Ad.anced ModeM commaD s aceD or ta= de%imited %ist o+ denied hostnames or I> addressesM a%%owed hosts ta)e recedence so can use A-- in this +ie%d and s eci+: a%%owed hosts in ?osts Allo<M see N-<5 =e%ow on%: a.ai%a=%e in Ad.anced ModeM add additiona% XshareY sm=.con+ arameters not co.ered =: other o tion +ie%ds
N9):: hostname %oo)u s add some time to accessin' the CI$" share. I+ :ou on%: use I> addressesD unchec) the NHostnames %oo)u sN =o6 in "er.ices S 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 Au6i%iar: >arameters +ie%d. <he s:nta6 +or this %ine and some e6am %es can =e +ound here. 7.".2 &onfiguring Anon*3ous Access
<o share a .o%ume without reEuirin' users to in ut 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 S !sers S 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 =o6
2. Associate t e guest account /it t e +olu3e in "tora'e S 4o%umes. 56 and the .o%ume's name then c%ic) Chan'e >ermissions. "e%ect g!est as the -wnerAuserB and -wnerA'rou B and chec) that the ermissions are a ro riate +or the share. I+ non;Windows s:stems wi%% =e accessin' the CI$" shareD %ea.e the t: e o+ ermissions as !ni6. -n%: chan'e the t: e o+ ermissions to Windows i+ the share is o%l) accessed =: Windows s:stems.
Page 1#9 of 276
3. &reate a &IFS s are in "harin' S Windows ACI$"B "hares S Add Windows ACI$"B "hare with the +o%%owin' attri=utesK NameK freenas >athK =rowse to the .o%ume to =e shared chec) the =o6es Allo< /!est A''ess and +nly Allo< /!est A''ess Hosts A%%owK add the addresses which are a%%owed to connect to the shareM acce ta=%e +ormats are the networ) or su=net address with CI(R mas) Ae.'. 192.1:,.2.072> or 192.1:,.2.3272;B or s eci+ic host I> addressesD one address er %ine
&. &onfigure t e &IFS ser+ice in "er.ices S CI$" with the +o%%owin' attri=utesK Authentication Mode%K Anonymo!s 3uest AccountK g!est chec) the =o6es =o6es Allo< .m3ty 6ass<ord and .na$le ?ome ire'tories Home (irectoriesK =rowse to the .o%ume to =e shared
*. Start t e &IFS ser+ice in "er.ices S Contro% "er.ices. C%ic) the c%ic) the red -$$ =utton ne6t 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. 6. )est t e s are. <o test the share +rom a Windows s:stemD o en 56 %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 rom ted +or a username or assword in order to see the share. An e6am %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 56 %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 NMa networ) dri.e...N as seen in $i'ure /.3c.
Page 1$1 of 276
Figure 7."': Accessing t e &IFS S are fro3 a -indo/s &o3!uter
Figure 7."c: 4a!!ing t e S are as a Net/or7 6ri+e
Page 1$1 of 276
Choose a dri.e %etter +rom the dro ;down menu and c%ic) the $inish =utton as shown in $i'ure /.3d. Figure 7."d: Selecting t e Net/or7 6ri+e <etter
7."."
&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 6irector* or <6APK create a user account for eac user in Account S !sers S 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 Re eat this rocess to create a user account +or e.er: user that wi%% need access to the CI$" share Page 1$2 of 276
2. If *ou are not using Acti+e 6irector* or <6APK create a grou! in Account S 3rou s S Add 3rou . -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 t e grou! !er3ission to t e +olu3e in "tora'e S 4iew 4o%umes. When settin' the ermissionsK set -wnerAuserB to no$ody set the -wnerA'rou B to the one :ou created in "te 2 ModeK chec) the write chec)=o6 +or the 3rou as it is unchec)ed =: de+au%t
&. &reate a &IFS s are in "harin' S CI$" "hares S Add CI$" "hare with the +o%%owin' attri=utesK NameK in ut the name o+ the share >athK =rowse to the .o%ume to =e shared )ee the #rowsa=%e to Networ) C%ients =o6 chec)ed
N9):: =e care+u% a=out unchec)in' the #rowsa=%e to Networ) C%ients =o6. When this =o6 is chec)ed Athe de+au%tBD other users wi%% see the names o+ e.er: share that e6ists usin' Windows 56 %orerD =ut the: wi%% recei.e a ermissions denied error messa'e i+ the: tr: to access someone e%se's share. I+ this =o6 is unchec)edD e.en the owner o+ the share won't see it or =e a=%e to create a dri.e ma in' +or the share in Windows 56 %orer. Howe.erD the: can sti%% access the share +rom the command %ine. !nchec)in' this o tion ro.ides %imited securit: and is not a su=stitute +or ro er ermissions and assword contro%. $. &onfigure t e &IFS ser+ice in Ser+ices P &IFS as +o%%owsK Authentication Mode%K i+ :ou are not usin' Acti.e (irector: or 9(A>D se%ect -o'al 1ser Wor)'rou K i+ :ou are not usin' Acti.e (irector: or 9(A>D set to the name =ein' used on the Windows networ)M un%ess it has =een chan'edD the de+au%t Windows wor)'rou name is K+&L/&+16 ,. Start t e &IFS ser+ice in "er.ices S Contro% "er.ices. C%ic) the c%ic) the red -$$ =utton ne6t 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 t e s are. <o test the share +rom a Windows s:stemD o en 56 %orer and c%ic) on Networ). $or this con+i'uration e6am %eD a s:stem named F&..NAS shou%d a ear with a share named $a'k!3s. I+ :ou c%ic) on $a'k!3sD a Windows "ecurit: o ;u screen shou%d rom t +or the user's username and assword. -nce authenticatedD the user can co : data to and +rom the CI$" share. N9):: 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.
Page 1$" of 276
7.".#
&onfiguring S ado/ &o!ies
"hadow Co iesD a%so )nown as the 4o%ume "hadow Co : "er.ice A4""B or >re.ious 4ersionsD is a Microso+t ser.ice +or creatin' .o%ume sna shots. "hadow co ies a%%ow :ou to easi%: restore re.ious .ersions o+ +i%es +rom within Windows 56 %orer. "hadow Co : su ort is =ui%t into 4ista and Windows /. Windows 7> or 2000 users need to insta%% the "hadow Co : c%ient. When :ou create a eriodic sna shot 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 su ort shadow co ies.
(.3.!.1 0rere6uisites
#e+ore usin' shadow co ies 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 Co ies 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 : su ort 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: su ort wi%% =e added in a +uture .ersion o+ $reeNA"1. at this timeD there must =e a one;to;one ma in' =etween the eriodic sna shot tas) and the CI$" share. In ractica% termsD this means that :ou can either share a 0$" .o%ume to =e shared =: a%% usersD or :ou can create a dataset %us an associated CI$" share +or each user. "ince directories can not =e shadow co ied at this timeD i+ :ou con+i'ure N5na=%e home directoriesN on the CI$" ser.iceD an: data stored in the user's home director: wi%% not =e shadow co ied. shadow co ies wi%% not wor) with a manua% sna shotD :ou must create a eriodic sna shot tas) +or the oo% or dataset =ein' shared =: CI$". At this timeD i+ mu%ti %e sna shot tas)s are created +or the same oo%@dataset =ein' shared =: CI$"D shadow co ies wi%% on%: wor) on the %ast e6ecuted tas) at the time the CI$" ser.ice started. A +uture .ersion o+ $reeNA"1 wi%% address this %imitation. the eriodic sna shot tas) shou%d =e created and at %east one sna shot shou%d e6ist be*ore creatin' the CI$" share. I+ :ou created the CI$" share +irstD restart the CI$" ser.ice in "er.ices S Contro% "er.ices. a ro riate ermissions must =e con+i'ured on the .o%ume@dataset =ein' shared =: CI$". users can not de%ete shadow co ies on the Windows s:stem due to the wa: "am=a wor)s. InsteadD the administrator can remo.e sna shots +rom the $reeNA"1 administrati.e 3!I. <he on%: wa: to disa=%e shadow co ies com %ete%: is to remo.e the eriodic sna shot tas) and de%ete a%% sna shots associated with the CI$" share.
(.3.!.2 Configuration +3a& le
In this e6am %eD a Windows / com uter has two usersK !ser1 and !ser2. <o con+i'ure $reeNA"1 to ro.ide shadow co : su ortK 1. $or the 0$" .o%ume named 7mnt7dataD create two 0$" datasets in "tora'e S 4o%umes S @mnt@data S Create 0$" (ataset. <he +irst dataset is named 7mnt7data7!ser1 and the second FreeNAS 9.1.1 Users Guide Page 1$# of 276
dataset is named 7mnt7data7!ser2. 2. I+ :ou are not usin' Acti.e (irector: or 9(A>D create two usersD !ser1 and !ser2 in Account S !sers S Add !ser. 5ach 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 7mnt7data7!ser1 so that the -wnerAuserB and -wnerA'rou B is !ser1. "et the ermissions on 7mnt7data7!ser2 so that the -wnerAuserB and -wnerA'rou B is !ser2. $or each dataset's ermissionsD ti'hten the Mode so that -ther can not read or e6ecute the in+ormation on the dataset. &. Create two eriodic sna shot tas)s in "tora'e S >eriodic "na shot <as)s S Add >eriodic "na shotD one +or each dataset. ,e*ore co%ti%!i%# to the %ext $te"/ con+irm that at %east one sna shot +or each dataset is dis %a:ed in the 0$" "na shots ta=. When creatin' :our sna shotsD )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' S Windows ACI$"B "hares S Add Windows ACI$"B "hare. <he +irst CI$" share is named !ser1 and has a >ath o+ 7mnt7data7!ser1M the second CI$" share is named !ser2 and has a >ath o+ 7mnt7data7!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 rom ts to start the CI$" ser.ice. 4eri+: that the CI$" ser.ice is set to -N in "er.ices S Contro% "er.ices. ,. $rom a Windows s:stemD %o'in as !ser1 and o en Windows 56 %orer S Networ) S $R55NA". <wo shares shou%d a earD 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 e6am %e o+ usin' shadow co ies whi%e %o''ed in as !ser1. In this e6am %eD the user ri'ht;c%ic)ed modified file and se%ected NRestore re.ious .ersionsN +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 o en 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 e6istin' +i%e on the Windows s:stem.
Page 1$$ of 276
Figure 7."e: @ie/ing Pre+ious @ersions /it in :,!lorer
Ser+ices &onfiguration
A$> CI$" (irector: "er.ices (:namic (N" $<>
<he "er.ices section o+ the 3!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 su orts the +o%%owin' =ui%t;in ser.icesK
Page 1$6 of 276
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 o tions +or each $reeNA"1 ser.ice.
(.1
&ontrol Ser+ices
"er.ices S Contro% "er.icesD shown in $i'ure 2.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 Ae6ce t +or the ".M.A.R.<. ser.iceB are o++ unti% :ou start them. Figure (.1a: &ontrol Ser+ices
Page 1$7 of 276
A ser.ice is sto ed 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 S "ettin's S Ad.anced and chec) the =o6 P"how conso%e messa'es in the +ooterQ. 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 out ut 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 o en "he%% and t: e 3ore F+arFlogF3essages.
(.2
AFP
<he A %e $i%in' >rotoco% AA$>B is a networ) rotoco% that o++ers +i%e ser.ices +or Mac com uters. #e+ore con+i'urin' this ser.iceD :ou shou%d +irst create :our A$> "hares in "harin' S A %e AA$>B "hares S Add A %e AA$>B "hare. A+ter con+i'urin' this ser.iceD 'o to "er.ices S 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%% o en the +o%%owin' orts on the $reeNA"1 s:stemK <C> *&2 Aa+ dB <C> &/99 AcnidGmetadataB !(> *3*3 and a random !(> ort Aa.ahiB
$i'ure 2.2a shows the con+i'uration o tions which are descri=ed in <a=%e 2.2a. Figure (.2a: AFP &onfiguration
Page 1$( of 276
)a'le (.2a: AFP &onfiguration 9!tions Setting "er.er Name 3uest Access 3uest Account @alue strin' chec)=o6 dro ;down menu 6escri!tion ser.er name that wi%% a ear to Mac c%ientsM =: de+au%t it is freenas i+ chec)edD c%ients wi%% not =e rom ted to authenticate =e+ore accessin' the A$> share se%ect account to use +or 'uest accessM the se%ected account must ha.e ermissions to the .o%ume@dataset =ein' shared ma6imum num=er o+ simu%taneous connections
Ma6 Connections inte'er
(.2.1
)rou'les ooting
I+ :ou recei.e a N"omethin' wron' with the .o%ume's CNI( (#N 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 de endin' u on the si8e o+ the .o%ume or dataset =ein' shared. <his command wi%% wi e the CNI( data=ase and re=ui%d it +rom the CNII(s stored in the A %e(ou=%e +i%es.
(."
&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 com uters. !ni6;%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' S Windows ACI$"B "hares S Add Windows ACI$"B "hare. A+ter con+i'urin' this ser.iceD 'o to "er.ices S 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'. N9):: 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 56 %orer. "tartin' this ser.ice wi%% o en the +o%%owin' orts on the $reeNA"1 s:stemK <C> 139 Asm=dB <C> &&* Asm=dB !(> 13/ Anm=dB !(> 132 Anm=dB
$i'ure 2.3a shows the con+i'uration o tions which are descri=ed in <a=%e 2.3a. <his con+i'uration screen is rea%%: a +ront;end to sm=.con+A*B.
Page 1$9 of 276
Figure (."a: &onfiguring &IFS
)a'le (."a: &IFS &onfiguration 9!tions Setting Authentication Mode% Net#I-" Name Wor)'rou (escri tion (-" Charset !NI7 Charset 9o' 9e.e% @alue dro ;down menu strin' strin' strin' dro ;down menu dro ;down menu dro ;down menu chec)=o6 6escri!tion choices are Anonymo!s or -o'al 1serM this settin' is i'nored i+ the Acti.e (irector: or 9(A> ser.ice is runnin' must =e %owercase and shou%d =e same as the hostname on the $reeNA"1 s:stemM it (!$t =e di++erent +rom the Korkgro!3 name must match Windows wor)'rou nameM this settin' is i'nored i+ the Acti.e (irector: or 9(A> ser.ice is runnin' o tiona% the character set "am=a uses when communicatin' with (-" and Windows 96@M5 c%ientsM de+au%t is "6>3; de+au%t is 1AF-, which su orts a%% characters in a%% %an'ua'es
choices are =inim!mD NormalD F!llD or e$!g determines whether or not the $reeNA"1 s:stem artici ates in a =rowser e%ectionM shou%d =e disa=%ed when networ) contains an A( or 9(A> ser.er and is not necessar: i+ 4ista or Windows / machines are resent Page 161 of 276
9oca% Master
Setting <ime "er.er +or (omain 3uest Account $i%e mas) (irector: mas) 5A "u ort "u ort (-" $i%e Attri=utes A%%ow 5m t: >assword
@alue chec)=o6 dro ;down menu inte'er inte'er chec)=o6 chec)=o6 chec)=o6
Au6i%iar: strin' arameters 5na=%e home chec)=o6 directories 5na=%e home chec)=o6 directories =rowsin' =rowse Home directories =utton Homes au6i%iar: arameters !ni6 56tensions 5na=%e AIstrin' chec)=o6 chec)=o6
6escri!tion determines whether or not the $reeNA"1 s:stem ad.ertises itse%+ as a time ser.er to Windows c%ientsM shou%d =e disa=%ed when networ) contains an A( or 9(A> ser.er account to =e used +or 'uest accessM that account must ha.e ermission to access the shared .o%ume@dataset o.errides de+au%t +i%e creation mas) o+ 0,,, which creates +i%es with read and write access +or e.er:=od: o.errides de+au%t director: creation mas) o+ 0/// which 'rants director: readD write and e6ecute access +or e.er:=od: ena=%es e6tended attri=utes 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 i+ chec)edD users can Iust ress enter when rom ted +or a asswordM reEuires that the username@ assword =e the same +or the $reeNA"1 user account and the Windows user account sm$.'onf o tions not co.ered e%sewhere in this screenM see the "am=a 3uide +or additiona% settin's i+ chec)edD a +o%der with the same name as the user account wi%% =e created +or each user users can =rowse A=ut not write toB other users' home directories se%ect .o%ume@dataset where the home directories wi%% =e created o tions s eci+ic to the XhomesY section o+ sm$.'onfM +or e6am %eD ide dot files E *es hides +i%es =e'innin' with a dot in home directories 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 ena=%es as:nchronous I@- in $reeNA"1 .ersions 2.0.3;R595A"5 and hi'herM ena=%in' this reduces CI$" s eed in some networ)s de+au%t is >09: =:tesM "am=a wi%% read as:nchronous%: when si8e o+ reEuest is =i''er than this .a%ue de+au%t is >09: =:tesM "am=a wi%% write as:nchronous%: when si8e o+ reEuest is =i''er than this .a%ue ena=%e i+ Mac c%ients wi%% =e connectin' to the CI$" share a%%ows :ou to s eci+: hostnames rather than I> addresses in the Hosts A%%ow or Hosts (en: +ie%ds o+ a CI$" shareM unchec) i+ :ou on%: use I> addresses as it sa.es the time o+ a host %oo)u
Minimum AI- read inte'er si8e Minimum AI- write inte'er si8e 0erocon+ share chec)=o6 disco.er: Hostnames %oo)u s chec)=o6
Page 161 of 276
#e'innin' with $reeNA"1 2.0.3;R595A"5D 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. N9):: do not set the dire'tory name 'a'he si4e as an au6i%iar: arameter. (ue to di++erences in how 9inu6 and #"( hand%e +i%e descri torsD director: name cachin' is disa=%ed on #"( s:stems in order to im ro.e er+ormance. (.".1 )rou'les ooting )i!s
Com ared to other networ)in' rotoco%sD CI$" is not +ast. Chec)in' the .na$le A2+ chec)=o6 ma: he% to increase networ) throu'h ut. AdIustin' the Minimum AI- read and write si8e settin's to =etter +it :our networ)in' in+rastructure ma: im ro.e or de'rade er+ormance. "am=a is sin'%e threadedD so C>! s eed ma)es a =i' di++erence in CI$" er+ormance. Four t: ica% 2.*3h8 Inte% Euad core or 'reater shou%d =e ca a=%e to hand%e s eeds in e6cess o+ 3= 9AN whi%e %ow ower C>!s such as Inte% Atoms and AM( C;30s_5;3*0_5;&*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 o tima%. "am=a's Nwrite cacheN arameter has =een re orted to im ro.e write er+ormance in some con+i'urations and can =e added to the Au6i%iar: >arameters +ie%d. !se an inte'er .a%ue which is a mu%ti %e o+ G"CG>A35"I05 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 o tions. It indicates which o tions are a.ai%a=%e and recommends that :ou e6 eriment to see which are su orted =: :our c%ients and im ro.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 Fdelete Q +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 rom ted to %o'in e.er: time access is reEuiredD reduce the cache settin's on the c%ient com uters. Where ossi=%eD a.oid usin' a mi6 o+ case in +i%enames as this ma: cause con+usion +or Windows users. Re resentin' and reso%.in' +i%enames with "am=a e6 %ains this in more detai%. I+ ermissions wor) +or Windows users =ut not +or -" 7 usersD tr: disa=%in' 1ni( .(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 5rrors section o+ the "am=a documentation contains additiona% trou=%eshootin' ti s.
Page 162 of 276
(.#
6irector* Ser+ices
orts the +o%%owin' director: ser.icesK Acti.e (irector: A+or Windows 2000 and hi'her networ)sB 9(A> NI" N<& A+or Windows networ)s o%der than Windows 2000B
$reeNA"1 su
<his section summari8es each o+ these ser.ices and their a.ai%a=%e con+i'urations within the $reeNA"1 3!I. N9):: at this timeD on%: one director: ser.ice can =e con+i'ured. <hat ser.ice must +irst =e se%ected in the ":stem S "ettin's S 3enera% S (irector: "er.ice dro ;down menu. -nce se%ectedD a (irector: "er.ice entr: wi%% =e added to "er.ices S Contro% "er.ices so that the ser.ice can =e startedD sto edD and con+i'ured. (.#.1 Acti+e 6irector*
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 !ni6;%i)e o eratin' 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 im ort the account in+ormation and im orted users can =e authori8ed to access the CI$" shares on the $reeNA"1 s:stem. N9):: 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 im ro.ements ha.e =een made to Acti.e (irector: su ort within $reeNA"1. I+ :ou are not runnin' $reeNA"1 9.1.1;R595A"5D it is stron'%: recommended that :ou u 'rade =e+ore attem tin' Acti.e (irector: inte'ration. ,e*ore co%*i#!ri%# the Acti'e Director) $er'ice D ensure name reso%ution is ro er%: 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) S 3%o=a% Con+i'uration on the $reeNA"1 s:stem. Ne6tD 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 S 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 2.&a shows the screen that a ears when :ou c%ic) "er.ices S (irector: "er.ices S Acti.e FreeNAS 9.1.1 Users Guide Page 16" of 276
(irector:. <a=%e 2.&a descri=es the con+i'ura=%e o tions. "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 =o6 P"how ad.anced +ie%ds =: de+au%tQ in ":stem S "ettin's S Ad.anced. Figure (.#a: &onfiguring Acti+e 6irector*
)a'le (.#a: Acti+e 6irector* &onfiguration 9!tions Setting 6escri!tion name o+ Acti.e (irector: domain Ae.'. e(am3le.'omB or chi%d (omain Name strin' domain Ae.'. sales.e(am3le.'omB Net#I-" Name strin' hostname o+ $reeNA"1 s:stem Wor)'rou Name strin' name o+ Windows ser.er's wor)'rou A+or o%der Microso+t c%ientsB Administrator Name strin' name o+ the Acti.e (irector: administrator account Administrator >assword strin' assword +or the Acti.e (irector: administrator account on%: a.ai%a=%e in Ad.anced ModeM i+ chec)edD %o's attem ts to 4er=ose %o''in' chec)=o6 Ioin the domain to 7#ar7log7messages on%: a.ai%a=%e in Ad.anced ModeM o%l) chec) this =o6 i+ the A( ser.er has =een e6 %icit%: con+i'ured to ma ermissions +or !NI7 e6tensions chec)=o6 !NI7 usersM chec)in' this =o6 ro.ides ersistent !I(s and 3!I(sD otherwiseD users@'rou s 'et ma ed to the !I(@3!I( ran'e con+i'ured in "am=a @alue
Page 16# of 276
Setting
6escri!tion on%: a.ai%a=%e in Ad.anced ModeM shou%d on%: =e ena=%ed i+ networ) has acti.e domain@+orest trusts and :ou need to mana'e A%%ow <rusted (omains chec)=o6 +i%es on mu%ti %e domainsM 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 on%: a.ai%a=%e in Ad.anced ModeM when unchec)edD the domain name is re ended to the usernameM i+ Allo< Ar!sted omains is !se de+au%t domain chec)=o6 chec)ed and mu%ti %e domains use the same usernamesD unchec) this =o6 to re.ent name co%%isions on%: a.ai%a=%e in Ad.anced ModeM can =e used to s eci+: (omain Contro%%er strin' hostname o+ domain contro%%er to use on%: a.ai%a=%e in Ad.anced ModeM can =e used to s eci+: 3%o=a% Cata%o' "er.er strin' hostname o+ '%o=a% cata%o' ser.er to use on%: a.ai%a=%e in Ad.anced ModeM can =e used to s eci+: Ker=eros "er.er strin' hostname o+ )er=eros ser.er to use Ker=eros >assword on%: a.ai%a=%e in Ad.anced ModeM can =e used to s eci+: strin' "er.er hostname o+ )er=eros assword ser.er to use on%: a.ai%a=%e in Ad.anced ModeM in secondsD increase i+ the A( A( timeout inte'er ser.ice does not start a+ter connectin' to the domain on%: a.ai%a=%e in Ad.anced ModeM in secondsD increase i+ A( (N" timeout inte'er (N" Eueries timeout N9):: 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 N character. I+ a N e6ists in the domain administrator's asswordD )init wi%% re ort a N>assword IncorrectN error and %da G=ind wi%% re ort an NIn.a%id credentia%s A&9BN error. -nce :ou ha.e con+i'ured the Acti.e (irector: ser.iceD start it in "er.ices S Contro% "er.ices S (irector: "er.ices. It ma: ta)e a +ew minutes +or the Acti.e (irector: in+ormation to =e o u%ated to the $reeNA"1 s:stem. -nce o u%atedD the A( users and 'rou s 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 'rou s ha.e =een im orted to the $reeNA"1 s:stem =: usin' these commands within the $reeNA"1 "he%%K
wbinfo -u wbinfo -g
@alue
Ato .iew usersB Ato .iew 'rou sB
In additionD /'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
Page 16$ of 276
<o manua%%: chec) that a s eci+ied user can authenticateK

net ads join -S dcname -U username
I+ no users or 'rou s are %isted in the out ut o+ those commandsD these commands wi%% ro.ide more trou=%eshootin' in+ormationK
getent passwd getent group
7.!.1.1
Troubleshooting Ti s
I+ :ou are runnin' A( in a 2003@2002 mi6ed domainD see this +orum ost +or instructions on how to re.ent the secure channe% )e: +rom =ecomin' corru t. 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+ 8lda!.8tc!.do3ainna3e.co3 command to determine the networ)'s "R4 records andD i+ necessar:D chan'e the wei'ht and@or riorit: o+ the "R4 record to re+%ect the +astest ser.er. More in+ormation a=out "R4 records can =e +ound in the <echnet artic%e How (N" "u ort +or Acti.e (irector: Wor)s. <he rea%m that is used de ends u on the riorit: in the "R4 (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 "R4 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 e6am %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 S "ettin's S Ad.anced S Re=ui%d 9(A>@A( Cache. An e6 ired assword +or the administrator account wi%% cause )init to +ai% so ensure that the assword is sti%% .a%id. <r: creatin' a Com uter 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) S 3%o=a% Con+i'uration and the NetB2+S Name in "er.ices S (irector: "er.ices S 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 S (irector: "er.ices S Acti.e (irector:. (.#.2 <6AP
$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. 56am %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 9inu6 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 the $reeNA"1 s:stem. N9):: 9(A> wi%% not wor) with CI$" shares unti% the 9(A> director: has =een con+i'ured +or and FreeNAS 9.1.1 Users Guide Page 166 of 276
o u%ated with "am=a attri=utes. <he most o u%ar scri t +or er+ormin' this tas) is sm=%da ;too%s and instructions +or usin' it can =e +ound at <he 9inu6 "am=a;- en9(A> Howto. $i'ure 2.&= shows the 9(A> Con+i'uration screen that is seen when :ou c%ic) "er.ices S (irector: "er.ices S 9(A>. Figure (.#': &onfiguring 9(A>
<a=%e 2.&= summari8es the a.ai%a=%e con+i'uration o tions. I+ :ou are new to 9(A> termino%o':D s)im throu'h the - en9(A> "o+tware 2.& Administrator's 3uide. )a'le (.#': <6AP &onfiguration 9!tions Setting Hostname #ase (N A%%ow Anon:mous #indin' Root =ind (N Root =ind assword >assword 5ncr: tion @alue strin' strin' chec)=o6 strin' strin' dro ;down menu 6escri!tion hostname or I> address o+ 9(A> ser.er to %e.e% o+ the 9(A> director: tree to =e used when searchin' +or resources Ae.'. d'@test8d'@orgB instructs 9(A> ser.er to not ro.ide authentication and to a%%ow read@write access to an: c%ient name o+ administrati.e account 'n@=anager8d'@test8d'@orgH assword +or &oot $ind N se%ect a t: e su orted =: the 9(A> ser.erD choices areK 'lear Aunencr: tedBD 'ry3tD mdED ndsD ra'fD adD e(o3 Page 167 of 276 on 9(A> ser.er Ae.'.
Setting !ser "u++i6 3rou "u++i6 >assword "u++i6 Machine "u++i6 5ncr: tion Mode "e%+ si'ned certi+icate Au6i%iar: >arameters
@alue strin' strin' strin' strin' dro ;down menu strin' strin'
6escri!tion o tiona%D can =e added to name when user account added to 9(A> director: Ae.'. de t. or com an: nameB o tiona%D can =e added to name when 'rou added to 9(A> director: Ae.'. de t. or com an: nameB o tiona%D can =e added to assword when assword added to 9(A> director: o tiona%D can =e added to name when s:stem added to 9(A> director: Ae.'. ser.erD accountin'B choices are +ffD SS-D or A-S used to .eri+: the certi+icate o+ the 9(A> ser.er i+ ""9 connections are usedM aste the out ut o+ the command o!enssl s8client ?connect ser+er:!ort ?s o/certs %da .con+A*B o tionsD one er %ineD not co.ered =: other o tions in this screen
N9):: $reeNA"1 automatica%%: a ends the root (N. <his means that :ou shou%d not inc%ude the sco e and root (N when con+i'urin' the userD 'rou D asswordD and machine su++i6es. A+ter con+i'urin' the 9(A> ser.iceD start it in "er.ices S Contro% "er.ices S (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 +i6 them. When trou=%eshootin' 9(A>D o en "he%% and %oo) +or error messa'es in 7#ar7log7a!th.log. <o .eri+: that the users ha.e =een im ortedD t: e getent !ass/d +rom "he%%. <o .eri+: that the 'rou s ha.e =een im ortedD t: e getent grou!.
(.#."
NIS
Networ) In+ormation "er.ice ANI"B is a ser.ice which maintains and distri=utes a centra% director: o+ !ni6 user and 'rou in+ormationD hostnamesD emai% a%iases and other te6t;=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 im ort the users and 'rou s +rom the NI" director:. A+ter con+i'urin' this ser.iceD start it in "er.ices S Contro% "er.ices S (irector: "er.ices. $i'ure 2.&c shows the con+i'uration screen which o ens when :ou c%ic) "er.ices S (irector: "er.ices S NI". <a=%e 2.&c summari8es the con+i'uration o tions.
Page 16( of 276
Figure (.#c: NIS &onfiguration
)a'le (.#c: NIS &onfiguration 9!tions Setting NI" domain NI" ser.ers "ecure mode Man:cast @alue strin' strin' 6escri!tion name o+ NI" domain comma de%imited %ist o+ hostnames or I> addresses i+ chec)edD : =indA2B wi%% re+use to =ind to an: NI" ser.er that is not runnin' chec)=o6 as root on a <C> ort num=er o.er 102& i+ chec)edD : =ind wi%% =ind to the ser.er that res onds the +astestM this is chec)=o6 use+u% when no %oca% NI" ser.er is a.ai%a=%e on the same su=net
(.#.#
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 2.&d shows the con+i'uration screen that a ears when :ou c%ic) "er.ices S (irector: "er.ices S N<&. <hese o tions are summari8ed in <a=%e 2.&d. A+ter con+i'urin' the N<& ser.iceD start it in "er.ices S Contro% "er.ices S (irector: "er.ices.
Page 169 of 276
Figure (.#d: N)# &onfiguration 9!tions
)a'le (.#d: N)# &onfiguration 9!tions Setting (omain Contro%%er Net#I-" Name Wor)'rou Name Administrator Name Administrator >assword @alue strin' strin' strin' strin' strin' 6escri!tion hostname o+ domain contro%%er hostname o+ $reeNA"1 s:stem name o+ Windows ser.er's wor)'rou name o+ the domain administrator account in ut and con+irm the assword +or the domain administrator account
(.$
6*na3ic 6NS
(: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 2.*a shows the ((N" con+i'uration screen and <a=%e 2.*a summari8es the con+i'uration o tions. <he .a%ues :ou need to in ut 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 S Contro% "er.ices.
Page 171 of 276
Figure (.$a: &onfiguring 66NS
)a'le (.$a: 66NS &onfiguration 9!tions Setting >ro.ider (omain name !sername >assword ! date eriod $orced u date eriod Au6i%iar: arameters @alue 6escri!tion se.era% ro.iders are su ortedM i+ :our ro.ider is not %istedD %ea.e this dro ;down +ie%d =%an) and s eci+: the custom ro.ider in the A!(iliary 3arameters menu +ie%d strin' +u%%: Eua%i+ied domain name Ae.'. yo!rname.dyndns.orgB strin' username used to %o'on to the ro.ider and u date the record strin' assword used to %o'on to the ro.ider and u date the record in secondsM =e care+u% with this settin' as the ro.ider ma: =%oc) :ou +or inte'er a=use i+ this settin' occurs more o+ten than the I> address chan'es in seconds so =e care+u% with this settin' as the ro.ider ma: =%oc) :ou inte'er +or a=useM issues a ((N" u date 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 additiona% arameters assed to the ro.ider durin' record u dateM an strin' e6am %e o+ s eci+:in' a custom ro.ider is dyndns*system defa!ltO3ro#ider.'om
I+ :ou are usin' (N";-;MaticD see this +orum ost.
Page 171 of 276
(.6
F)P
$reeNA"1 uses the ro+t d $<> 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 5ncr: tin' $<>. <his section ro.ides an o.er.iew o+ the $<> con+i'uration o tions. It then ro.ides e6am %es +or con+i'urin' anon:mous $<>D s eci+ied user access within a chroot en.ironmentD encr: tin' $<> connectionsD and trou=%eshootin' ti s. (.6.1 F)P &onfiguration 9!tions
$i'ure 2.,a shows the con+i'uration screen +or "er.ices S $<>. "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 =o6 P"how ad.anced +ie%ds =: de+au%tQ in ":stem S "ettin's S Ad.anced. Figure (.6a: &onfiguring F)P
<a=%e 2.,a summari8es the a.ai%a=%e o tions when con+i'urin' the $<> ser.erK )a'le (.6a: F)P &onfiguration 9!tions Setting >ort C%ients @alue inte'er inte'er 6escri!tion ort to use +or connection reEuests ma6imum num=er o+ simu%taneous c%ients Page 172 of 276
Setting
6escri!tion ma6imum num=er o+ connections er I> address where 0 Connections inte'er means un%imited ma6imum num=er o+ attem ts =e+ore c%ient is disconnectedM 9o'in Attem ts inte'er increase this i+ users are rone to t: os ma6imum c%ient id%e time in seconds =e+ore c%ient is <imeout inte'er disconnected A%%ow Root 9o'in chec)=o6 discoura'ed as increases securit: ris) ena=%es anon:mous $<> %o'ins with access to the director: A%%ow Anon:mous 9o'in chec)=o6 s eci+ied in the 6ath =rowse de+au%t director: +or anon:mous connectionsM otherwiseD >ath =utton users wi%% =e %aced in their home director: A%%ow 9oca% !ser 9o'in chec)=o6 reEuired i+ Anonymo!s -ogin is disa=%ed messa'e dis %a:ed to %oca% %o'in users a+ter authenticationM #anner strin' not dis %a:ed to anon:mous %o'in users on%: a.ai%a=%e in Ad.anced ModeM sets de+au%t ermissions $i%e >ermission chec)=o6es +or new%: created +i%es on%: a.ai%a=%e in Ad.anced ModeM sets de+au%t ermissions (irector: >ermission chec)=o6es +or new%: created directories on%: a.ai%a=%e in Ad.anced ModeM ena=%es $i%e e7chan'e 5na=%e $7> chec)=o6 >rotoco% which is discoura'ed as it ma)es the ser.er .u%nera=%e to $<> =ounce attac)s A%%ow <rans+er Resum tion chec)=o6 a%%ows $<> c%ients to resume interru ted trans+ers +or %oca% usersD on%: a%%ow access to user's home director: A%wa:s Chroot chec)=o6 un%ess the user is a mem=er o+ 'rou <heel ReEuire I(5N< on%: a.ai%a=%e in Ad.anced ModeM wi%% resu%t in timeouts i+ chec)=o6 Authentication identd is not runnin' on the c%ient >er+orm Re.erse (N" er+orm re.erse (N" %oo)u s on c%ient I>sM can cause %on' chec)=o6 9oo)u s de%a:s i+ re.erse (N" is not con+i'ured I> address or hostnameM set i+ $<> c%ients can not connect MasEuerade address strin' throu'h a NA< de.ice on%: a.ai%a=%e in Ad.anced ModeM to =e used =: c%ients in Minimum assi.e ort inte'er >A"4 modeD de+au%t o+ 0 means an: ort a=o.e 1023 on%: a.ai%a=%e in Ad.anced ModeM to =e used =: c%ients in Ma6imum assi.e ort inte'er >A"4 modeD de+au%t o+ 0 means an: ort a=o.e 1023 9oca% user u %oad on%: a.ai%a=%e in Ad.anced ModeM in K#@sD de+au%t o+ 0 inte'er =andwidth means un%imited 9oca% user down%oad on%: a.ai%a=%e in Ad.anced ModeM in K#@sD de+au%t o+ 0 inte'er =andwidth means un%imited Anon:mous user u %oad inte'er on%: a.ai%a=%e in Ad.anced ModeM in K#@sD de+au%t o+ 0 FreeNAS 9.1.1 Users Guide Page 17" of 276
@alue
Setting @alue =andwidth Anon:mous user down%oad inte'er =andwidth 5na=%e <9" Certi+icate and ri.ate )e: Au6i%iar: arameters chec)=o6 strin' strin'
6escri!tion means un%imited on%: a.ai%a=%e in Ad.anced ModeM in K#@sD de+au%t o+ 0 means un%imited ena=%es encr: ted connectionsM a certi+icate wi%% automatica%%: =e 'enerated and wi%% a ear in the "ertifi'ate and 3ri#ate key =o6 once :ou c%ic) -K the ""9 certi+icate and ri.ate )e: to =e used +or <9" $<> connections on%: a.ai%a=%e in Ad.anced ModeM inc%ude ro+t dA2B arameters not co.ered e%sewhere in this screen arameters that wi%% re.ent a%% users +rom
<he +o%%owin' e6am %e demonstrates the au6i%iar: er+ormin' the $<> (595<5 commandK
<Limit DELE> DenyAll </Limit>
(.6.2
Anon*3ous F)P
Anon:mous $<> ma: =e a ro riate +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 t e 'uilt?in ft! user account !er3issions to the .o%ume@dataset to =e shared in "tora'e S 4o%umes as +o%%owsK -wnerAuserBK se%ect the =ui%t;in ft3 user +rom the dro ;down menu -wnerA'rou BK se%ect the =ui%t;in ft3 'rou +rom the dro ;down menu ModeK re.iew that the ermissions are a ro riate +or the share
N9):: +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 !ni6 AC9sD e.en i+ Windows c%ients wi%% =e accessin' $reeNA"1 .ia $<>. 2. &onfigure anon*3ous F)P in "er.ices S $<> =: settin' the +o%%owin' attri=utesK chec) the =o6 Allo< Anonymo!s -ogin >athK =rowse to the .o%ume@dataset@director: to =e shared
3. Start t e F)P ser+ice in Contro% "er.ices. C%ic) the red -$$ =utton ne6t 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 t e connection +rom a c%ient usin' a uti%it: such as $i%e8i%%a.
Page 17# of 276
In the e6am %e shown in $i'ure 2.,=D a user has in ut the +o%%owin' in+ormation into the $i%e8i%%a c%ientK I> address o+ the $reeNA"1 ser.erK 192.1:,.1.113 !sernameK anonymo!s >asswordK the emai% address o+ the user Figure (.6': &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 s eci+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. (.6." S!ecified User Access in c root
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 im ort e6istin' 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 S 4o%umes. C%ic) an e6istin' 0$" .o%ume S Create 0$" (ataset and set an a ro riate Euota +or each dataset. Re eat this rocess to create a dataset +or e.er: user that wi%% need access to the $<> ser.ice. 2. If *ou are not using A6 or <6APK create a user account for eac user in Account S !sers S Add !ser. $or each userD =rowse to the dataset created +or that user in the ?ome ire'tory +ie%d. Re eat 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 t e !er3issions for eac dataset in "tora'e S 4o%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. Re eat +or each dataset.
Page 17$ of 276
N9):: +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 !ni6 AC9sD e.en i+ Windows c%ients wi%% =e accessin' $reeNA"1 .ia $<>. &. &onfigure F)P in "er.ices S $<> with the +o%%owin' attri=utesK >athK =rowse to the arent .o%ume containin' the datasets ma)e sure the =o6es +or Allo< Anonymo!s -ogin and Allo< &oot -ogin are !%chec0ed chec) the =o6 Allo< -o'al 1ser -ogin chec) the =o6 Al<ays "hroot
*. Start t e F)P ser+ice in Contro% "er.ices. C%ic) the red -$$ =utton ne6t 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 t e 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. (.6.# :ncr*!ting F)P
<o con+i'ure an: $<> scenario to use encr: ted connectionsK 1. :na'le )<S in "er.ices S $<>. Chec) the =o6 .na$le A-S. -nce :ou ress -KD a certi+icate and )e: wi%% automatica%%: =e 'enerated +or :ou and ro+t d 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 a ears in the "ertifi'ate and 3ri#ate key field and aste in :our own certi+icate and )e:. 2. S!ecif* secure F)P / en accessing t e FreeNAS s*ste3. $or e6am %eD in $i%e8i%%a in ut ft3s)7726*address A+or an im %icit connectionB or ft3es)7726*address A+or an e6 %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 acce t the certi+icate and ne'otiate an encr: ted connection. <o +orce encr: ted connectionsD add the +o%%owin' %ine to Au6i%iar: >arametersK
TLS Required on
(.6.$
)rou'les ooting
<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 o en "he%% and issue the commandK
sockstat -4p 21
I+ there is nothin' %istenin' on ort 21D ro+t d isn't runnin'. <o see the error messa'e that occurs when $reeNA"1 tries to start the $<> ser.iceD 'o to ":stem S "ettin's S Ad.ancedD chec) the =o6 P"how FreeNAS 9.1.1 Users Guide Page 176 of 276
conso%e messa'es in the +ooterQ and c%ic) "a.e. Ne6tD 'o to "er.ices S Contro% "er.ices and switch the $<> ser.ice o++ then =ac) on in the 3!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 NHost name data=aseN +ie%d o+ Networ) S 3%o=a% Con+i'uration.
(.7
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 e6istin' 5thernet networ). " eci+ica%%:D it e6 orts dis) de.ices o.er an 5thernet networ) that i"C"I c%ients Aca%%ed initiatorsB can attach to and mount. <raditiona% "ANs o erate 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 e6istin' 5thernet 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'ramsM these ro'rams tend to +i%ter NNetwor) 9ocationN =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 su erset 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. :,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 re resents a %o'ica% "C"I de.ice. An initiator ne'otiates with a tar'et to esta=%ish connecti.it: to a 9!NM 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(5 hard dri.eM rather than mountin' remote directoriesD initiators +ormat and direct%: mana'e +i%es:stems on i"C"I 9!Ns. $reeNA"1 su orts 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% 'rou s and initiator 'rou s can =e reused without an: issue. "ince ist't mu%ti %e6es a tar'et with mu%ti %e 9!Ns o.er the same <C> connectionD :ou wi%% e6 erience 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 e6tent or a +i%e e6tent to =e used as stora'e. 3. (etermine which hosts are a%%owed to connect usin' i"C"I and create an initiator. FreeNAS 9.1.1 Users Guide Page 177 of 276
&. 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 e6tent. 2. "tart the i"C"I ser.ice in "er.ices S Contro% "er.ices. <he rest o+ this section descri=es these ste s in more detai%. (.7.1 Aut ori=ed Accesses
I+ :ou wi%% =e usin' CHA> or mutua% CHA> to ro.ide authenticationD :ou must create an authori8ed access in "er.ices S I"C"I S Authori8ed Accesses S Add Authori8ed Access. <his screen is shown in $i'ure 2./a. N9):: this screen sets %o'in authentication. <his is di++erent +rom disco.er: authentication which is set in <ar'et 3%o=a% Con+i'uration. Figure (.7a: Adding an iS&SI Aut ori=ed Access
<a=%e 2./a summari8es the settin's that can =e con+i'ured when addin' an authori8ed accessK )a'le (.7a: Aut ori=ed Access &onfiguration Settings Setting 3rou I( @alue 6escri!tion a%%ows di++erent 'rou s to =e con+i'ured with di++erent authentication inte'er ro+i%esM +or instanceD a%% users with a 3rou I( o+ 1 wi%% inherit the authentication ro+i%e associated with 3rou 1 Page 17( of 276
Setting
@alue 6escri!tion name o+ user account that wi%% =e created on the $reeNA"1 de.ice +or !ser strin' CHA> authentication with the user on the remote s:stemM man: initiators de+au%t to usin' the initiator name as the user "ecret assword to =e associated with 1serM the i"C"I standard reEuires that this strin' "ecret ACon+irmB =e at %east 12 characters %on' on%: in ut when con+i'urin' mutua% CHA>M in most cases it wi%% need to =e >eer !ser strin' the same .a%ue as 1ser Initiator "ecret the mutua% secret assword which (!$t be di**ere%t tha% the Secret M Initiator "ecret strin' reEuired i+ the 6eer 1ser is set ACon+irmB
N9):: CHA> does not wor) with 3%o=a%"AN initiators on Mac -" 7. As authori8ed accesses are addedD the: wi%% =e %isted under 4iew Authori8ed Accesses. In the e6am %e shown in $i'ure 2./=D three users A test1D test2D and test3B and two 'rou s 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 5dit and (e%ete =uttons. Figure (.7': @ie/ing Aut ori=ed Accesses
Page 179 of 276
(.7.2
:,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 e6tent or a +i%e e6tentK 6e+ice e,tent: .irtua%i8es an un+ormatted h:sica% dis)D RAI( contro%%erD 8.o%D 8.o% sna shotD or an e6istin' HA"< de.ice. 4irtua%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 ca a=i%ities o+ the dis) or contro%%er. 4irtua%i8in' a 8.o% adds the =ene+its o+ 0$" such as its read cache and write cache. 5.en i+ the c%ient +ormats the de.ice e6tent 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 sna shots. File e,tent: a%%ows :ou to e6 ort a ortion o+ a 0$" .o%ume. When creatin' a +i%e e6tentD :ou can s eci+: either a non;e6istin' +i%e name or an e6istin' 0$" dataset. <he ad.anta'e o+ a +i%e e6tent is that :ou can create mu%ti %e e6 orts er .o%ume. In theor:D a 8.o% and a +i%e e6tent shou%d ha.e identica% er+ormance. In racticeD a +i%e e6tent out er+orms in reads@writes =ut this is on%: noticea=%e at 10 3# 5thernet s eeds or hi'her. $or hi'h er+ormanceD +i%e e6tents are recommended at this time. $uture chan'es to $ree#"('s 8.o% code wi%% increase its er+ormance.
7.(.2.1
Adding an +3tent
<o add an e6tentD 'o to "er.ices S I"C"I S 56tents S Add 56tent. In the e6am %e shown in $i'ure 2./cD the de.ice e6tent is usin' the e(3ort 8.o% that was re.ious%: created +rom the 7mnt7#ol!me1 .o%ume. N9):: in $reeNA"1 .ersions rior to 2.3.1D i+ a h:sica% dis) was used instead o+ a 8.o% to create a de.ice e6tentD a =u' wi ed the artition ta=%e on the dis)D resu%tin' in data %oss. <his =u' was +i6ed in 2.3.1. <a=%e 2./= summari8es the settin's that can =e con+i'ured when creatin' an e6tent. 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!(eFdata$et %a(e.
Page 1(1 of 276
Figure (.7c: Adding an iS&SI :,tent
)a'le (.7': :,tent &onfiguration Settings Setting 56tent Name 56tent <: e >ath to the e6tent (is) de.ice 56tent si8e Comment @alue strin' 6escri!tion name o+ e6tentM i+ the .(tent si4e is not 0D it can not =e an e6istin' +i%e within the .o%ume@dataset
dro ;down se%ect +rom File or e#i'e menu on%: a ears i+ File is se%ectedM either =rowse to an e6istin' +i%e and use 0 =rowse as the .(tent si4eD or =rowse to the .o%ume or datasetD c%ic) the C%ose =utton =uttonD a end the .(tent Name to the athD and s eci+: a .a%ue in .(tent si4e dro ;down on%: a ears i+ e#i'e is se%ectedM se%ect the un+ormatted dis)D contro%%erD menu 8.o%D 8.o% sna shotD or HA"< de.ice on%: a ears i+ File is se%ectedM i+ the si8e is s eci+ied as 0D the +i%e must inte'er a%read: e6ist and the actua% +i%e si8e wi%% =e usedM otherwise s eci+ies the si8e o+ the +i%e to create strin' o tiona%
(.7."
Initiators
<he ne6t 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 S FreeNAS 9.1.1 Users Guide Page 1(1 of 276
I"C"I S Initiators S Add InitiatorD shown in $i'ure 2./d. Figure (.7d: Adding an iS&SI Initiator
N9):: =e'innin' with 2.2.0D $reeNA"1 contains iscontro%A2B. <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 2./c summari8es the settin's that can =e con+i'ured when addin' an initiator. )a'le (.7c: Initiator &onfiguration Settings Setting Initiators Authori8ed networ) Comment @alue 6escri!tion use A-- )e:word or a %ist o+ initiator hostnames se arated =: commas with strin' no s ace use A-- )e:word or a networ) address with CI(R mas) such as strin' 192.1:,.2.072> strin' o tiona% descri tion
Page 1(2 of 276
In the e6am %e shown in $i'ure 2./eD two 'rou s ha.e =een created. 3rou 1 a%%ows connections +rom an: initiator on an: networ)M 3rou 2 a%%ows connections +rom an: initiator on the 10.10.1.072> networ). C%ic) an initiator's entr: to dis %a: its 5dit and (e%ete =uttons. N9):: i+ :ou de%ete an initiatorD a warnin' wi%% indicate i+ an: tar'ets or tar'et@e6tent ma in's de end u on the initiator. I+ :ou con+irm the de%eteD these wi%% =e de%eted as we%%. Figure (.7e: Sa3!le iS&SI Initiator &onfiguration
(.7.#
Portals
A orta% s eci+ies the I> address and ort num=er to =e used +or i"C"I connections. "er.ices S I"C"I S >orta%s S Add >orta% wi%% =rin' u the screen shown in $i'ure 2./+.
Page 1(" of 276
Figure (.7f: Adding an iS&SI Portal
<a=%e 2./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) PAdd e6tra >orta% I>Q. )a'le (.7d: Portal &onfiguration Settings Setting Comment >orta% I> address >ort @alue strin' dro ;down menu inte'er 6escri!tion o tiona% descri tionM orta%s are automatica%%: assi'ned a numeric 'rou I( se%ect the I> address associated with an inter+ace or the wi%dcard address o+ 0.0.0.0 Aan: inter+aceB <C> ort used to access the i"C"I tar'etM de+au%t is 32:0
$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 e6am %eD consider a s:stem with +our inter+aces con+i'ured with the +o%%owin' addressesK 192.1,2.1.1@2& 192.1,2.2.1@2& 192.1,2.3.1@2& FreeNAS 9.1.1 Users Guide Page 1(# of 276
192.1,2.&.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% 3rou I( o+ 1 and a second tar'et named # with a >orta% 3rou 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.
(.7.$
)arget Glo'al &onfiguration
"er.ices S i"C"I S <ar'et 3%o=a% Con+i'urationD shown in $i'ures 2./'D contains settin's that a %: to a%% i"C"I shares. <a=%e 2./e summari8es the settin's that can =e con+i'ured in the <ar'et 3%o=a% Con+i'uration screen. <he inte'er .a%ues in the ta=%e are used to tune networ) er+ormanceM 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 disru t i"C"I initiatorsD set the +o%%owin' o tionsK chec) the .na$le -1" =o6 %ea.e the "ontroller 26 address and "ontrol A!thori4ed Net<ork at their de+au%t .a%ues chan'e the "ontroller A!th =ethod to None N9):: the +o%%owin' o erations 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 e6istin' e6tent.
Page 1($ of 276
Figure (.7g: iS&SI )arget Glo'al &onfiguration @aria'les
)a'le (.7f: )arget Glo'al &onfiguration Settings Setting #ase Name (isco.er: Auth Method @alue 6escri!tion see the PConstructin' i"C"I names usin' the iEn. +ormatQ section strin' o+ R$C 3/21 i+ :ou are un+ami%iar with this +ormat con+i'ures the authentication %e.e% reEuired =: the tar'et +or dro ;down disco.er: o+ .a%id de.icesD where None wi%% a%%ow anon:mous menu disco.er:D "?A6 and =!t!al "?A6 reEuire authenticationD and A!to %ets the initiator decide the authentication scheme de ends on (isco.er: Auth Method settin'K reEuired i+ set to dro ;down "?A6 or =!t!al "?A6D o tiona% i+ set to A!toD and not needed menu i+ set to None inte'er sets the %imit on how %on' an I@- can =e outstandin' =e+ore an re resentin' error condition is returnedM .a%ues ran'e +rom 0;300 with a seconds de+au%t o+ 30 inte'er how o+ten the tar'et sends a N->;IN ac)et to )ee a disco.ered re resentin' session a%i.eM .a%ues ran'e +rom 0;300 with a de+au%t o+ 20 seconds %imits the num=er o+ sessions the tar'et orta% wi%% create@acce t inte'er +rom initiator orta%sM .a%ues ran'e +rom 1;,& with a de+au%t o+ 1: Page 1(6 of 276
(isco.er: Auth 3rou
I@- <imeout
N->IN Inter.a%
Ma6. "essions
Setting Ma6. Connections Ma6. re;send R2<
@alue inte'er inte'er
Ma6-utstandin'R2<
inte'er
$irst =urst %en'th
inte'er
Ma6 =urst %en'th Ma6 recei.e data se'ment %en'th (e+au%t<ime2Wait
inte'er inte'er inte'er
6escri!tion the num=er o+ connections a sin'%e initiator can ma)e to a sin'%e tar'etM .a%ues ran'e +rom 1;,& with a de+au%t o+ , .a%ues ran'e +rom 1;2** with a de+au%t o+ 32 the ma6imum 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% Ma6-utstandin'R2< e6ceeds the si8e o+ the %ar'est Write I@di.ided =: Ma6#urst9en'thM .a%ues ran'e +rom 1;2** with a de+au%t o+ 1: ma6imum amount in =:tes o+ unso%icited data an i"C"I initiator ma: send to the tar'et durin' the e6ecution o+ a sin'%e "C"I commandM .a%ues ran'e +rom 1; 2a32 with a de+au%t o+ :E8E3: ma6imum write si8e in =:tes the tar'et is wi%%in' to recei.e =etween R2<sM .a%ues ran'e +rom 1;2a32 with a de+au%t o+ 2:281>> in =:tesM .a%ues ran'e +rom 1;2a32 with a de+au%t o+ 2:281>> minimum time in seconds to wait =e+ore attem tin' a %o'out or an acti.e tas) reassi'nment a+ter an une6 ected connection termination or resetM .a%ues ran'e +rom 1;300 with a de+au%t o+ 2 ma6imum time in seconds a+ter <ime2Wait =e+ore which an acti.e tas) reassi'nment is sti%% ossi=%e a+ter an une6 ected connection termination or resetM .a%ues ran'e +rom 1;300 with a de+au%t o+ :0 chec) i+ :ou need to d:namica%%: add and remo.e tar'etsM i+ chec)edD the ne6t three +ie%ds are acti.ated and reEuired )ee the de+au%t .a%ue o+ 12;.0.0.1 ossi=%e .a%ues ran'e +rom 102&;,**3* with a de+au%t .a%ue o+ 32:1 )ee the de+au%t .a%ue o+ 12;.0.0.07, choices are NoneD A!toD "?A6D or =!t!al "?A6 reEuired i+ Contro%%er Auth Method is set to "?A6 or =!t!al "?A6D o tiona% i+ set to A!toD and not needed i+ set to None
(e+au%t<ime2Retain
inte'er
5na=%e 9!C Contro%%er I> address Contro%%er <C> ort
chec)=o6 I> address inte'er
Contro%%er Authori8ed su=net mas) netmas) Contro%%er Auth dro ;down Method menu dro ;down Contro%%er Auth 3rou menu
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 o timi8e the connectionD re+er to the i"C"I initiator's documentation. $or e6am %eD the +o%%owin' modi+ications are recommended i+ the i"C"I initiator is FreeNAS 9.1.1 Users Guide Page 1(7 of 276
runnin' on 7enser.erK (.7.6 Ma6. re;send R2<K 2EE Ma6-utstandin'R2<K :> $irst =urst %en'thK 2:281>> Ma6 =urst %en'thK 2809;81E2 )argets
Ne6tD create a <ar'et usin' "er.ices S I"C"I S <ar'ets S Add <ar'etD as shown in $i'ure 2./h. A tar'et com=ines a orta% I(D a%%owed initiator I(D and an authentication method. N9):: 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 4M$" used =: 4MWare 5"7@5"7iD in order +or mu%ti %e initiators to mount the =%oc) de.ice read@write. I+ a traditiona% +i%es:stem such as 57<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 corru tion. I+ :ou need to su ort 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 (.7 : Adding an iS&SI )arget
<a=%e 2./+ summari8es the settin's that can =e con+i'ured when creatin' a <ar'et.
Page 1(( of 276
)a'le (.7f: )arget Settings Setting <ar'et Name <ar'et A%ias "eria% <ar'et $%a's @alue strin' strin' strin' 6escri!tion reEuired .a%ueM =ase name wi%% =e a ended automatica%%: i+ it does not start with iPn o tiona% user;+riend%: name uniEue I( +or tar'et to a%%ow +or mu%ti %e 9!NsM the de+au%t is 'enerated +rom the s:stem's MAC address choices are read-<rite or read-only %ea.e em t: or se%ect num=er o+ e6istin' orta% to use se%ect which e6istin' initiator 'rou has access to the tar'et choices are NoneD A!toD "?A6D or =!t!al "?A6 None or inte'er re resentin' num=er o+ e6istin' authori8ed access see this ost +or an e6 %anation o+ the math in.o%.edM .a%ues are 0; 2** where 0 is disa=%ed and de+au%t is 32 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 o eratin' s:stem %imited =: =%oc) countM de+au%t is E12
dro ;down menu dro ;down >orta% 3rou I( menu dro ;down Initiator 3rou I( menu dro ;down Auth Method menu Authentication dro ;down 3rou num=er menu ?ueue (e th inte'er
9o'ica% #%oc) "i8e inte'er
(.7.7
)argetF:,tents
<he %ast ste is associatin' an e6tent to a tar'et within "er.ices S I"C"I S <ar'et@56tents S Add <ar'et@56tent. <his screen is shown in $i'ure 2./i. !se the dro ;down menus to se%ect the e6istin' tar'et and e6tent. Figure (.7i: Associating iS&SI )argetsF:,tents
<a=%e 2./' summari8es the settin's that can =e con+i'ured when associatin' tar'ets and e6tents.
Page 1(9 of 276
)a'le (.7g: )argetF:,tents &onfiguration Settings Setting <ar'et 56tent @alue dro ;down menu dro ;down menu 6escri!tion se%ect the re;created tar'et se%ect the re;created e6tent
It is recommended to a%wa:s associate e6tents to tar'ets in a 1K1 mannerD e.en thou'h the 3!I wi%% a%%ow mu%ti %e e6tents 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 S Contro% "er.ices. C%ic) the red -$$ =utton ne6t 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.
(.7.(
&onnecting to iS&SI S are
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%A2B comes with $ree#"(D iscsi;initiatorA2B comes with Net#"(D and iscsidA2B comes with - en#"(. "ome 9inu6 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 e6ists +or :our distri=ution shou%d the command not e6ist on :our 9inu6 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 ?! R!ortal8IPS to +ind the new 9!N and iscsiad3 ?3 node ?) R<UN8Na3eS ?l to %o' into the 9!N. Instructions +or connectin' +rom a 4Mware 5"7i "er.er can =e +ound at How to con+i'ure $reeNA" 2 +or i"C"I and connect to 5"7AiB. Note that the reEuirements +or =ootin' ." here &.6 o++ i"C"I di++er =etween 5"7 and 5"7i. 5"7 reEuires a hardware i"C"I ada ter whi%e 5"7i reEuires s eci+ic i"C"I =oot +irmware su ort. <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 3uide +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 3%o=a% Con+i'uration. I+ the 9!N is not disco.ered =: 5"7iD ma)e sure that romiscuous mode is set to Acce t in the .switch. <o determine which initiators are connectedD t: e istgtcontrol info within "he%%. (.7.9 Gro/ing <UNs
<he method used to 'row the si8e o+ an e6istin' i"C"I 9!N de ends on whether the 9!N is =ac)ed =: a +i%e e6tent or a 8.o%. #oth methods are descri=ed in this section. FreeNAS 9.1.1 Users Guide Page 191 of 276
A+ter the 9!N is e6 anded 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.(.1.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 tank/iscsi_zvol 4G AVAIL 17.5G REFER 33.9M MOUNTPOINT -
<henD 'row the 8.o%. <his e6am %e 'rows tank7is'si*4#ol +rom &3 to ,3K
zfs set volsize=6G tank/iscsi_zvol zfs set refreservation=6G tank/iscsi_zvol
4eri+: that the chan'es ha.e ta)en e++ectK

zfs list -t volume NAME USED tank/iscsi_zvol 6G AVAIL 17.5G REFER 33.9M MOUNTPOINT -
Fou can now start the i"C"I ser.ice and a%%ow initiators to connect.
7.(.1.2 #ile +3tent Based ,'$
#e+ore 'rowin' a +i%e e6tent =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 S i"C"I S $i%e 56tents S 4iew $i%e 56tents to determine the ath o+ the +i%e e6tent to 'row. - en "he%% to 'row the e6tent. <his e6am %e 'rows 7mnt7#ol!me17data =: 23K
truncate -s +2g /mnt/volume1/data
3o =ac) to "er.ices S i"C"I S $i%e 56tents S 4iew $i%e 56tents and c%ic) the 5dit =utton +or the +i%e e6tent. "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.
(.(
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' S !ni6 AN$"B "hares S Add !ni6 AN$"B "hare. A+ter con+i'urin' this ser.iceD 'o to "er.ices S Contro% >ane% to start the ser.ice. "tartin' this ser.ice wi%% o en the +o%%owin' orts on the $reeNA"1 s:stemK <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. FreeNAS 9.1.1 Users Guide Page 191 of 276
$i'ure 2.2a shows the con+i'uration screen and <a=%e 2.2a summari8es the con+i'uration o tions +or the N$" ser.ice. Figure (.(a: &onfiguring NFS
)a'le (.(a: NFS &onfiguration 9!tions Setting 6escri!tion run s*sctl ?n 7ern.s3!.c!us +rom "he%% to determine the num=erM Num=er o+ ser.ers inte'er do not e6ceed the num=er %isted in the out ut o+ that command A%%ow non;root mount chec)=o6 chec) this =o6 on%: i+ the N$" c%ient reEuires it comma de%imited %ist o+ I> addresses to =ind toM i+ em t:D N$" wi%% #ind I> Addresses strin' =ind to A%isten onB a%% a.ai%a=%e addresses mountdA2B =ind ort inte'er o tiona%M s eci+: ort +or mountdA2B to =ind to r c.statdA2B =ind ort inte'er o tiona%M s eci+: ort +or r c.statdA2B to =ind to r c.%oc)dA2B =ind ort inte'er o tiona%M s eci+: ort +or r c.%oc)dA2B to =ind to @alue
(.9
2s*nc
"er.ices S 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 e6am %e. <his section descri=es the con+i'ura=%e o tions +or the rs*ncd ser.ice and rs:nc modu%es. $i'ure 2.9a shows the rs:ncd con+i'uration screen which is accessed +rom "er.ices S Rs:nc S Con+i'ure Rs:ncd.
Page 192 of 276
Figure (.9a: 2s*ncd &onfiguration
<a=%e 2.9a summari8es the o tions that can =e con+i'ured +or the rs:nc daemonK )a'le (.9a: 2s*nc &onfiguration 9!tions Setting @alue 6escri!tion <C> >ort inte'er ort +or rs*ncd to %isten onD de+au%t is ,;3 Au6i%iar: arameters strin' additiona% arameters +rom rs:ncd.con+A*B
(.9.1
2s*nc 4odules
$i'ure 2.9= shows the con+i'uration screen that a ears when :ou c%ic) "er.ices S Rs:nc S Rs:nc Modu%es S Add Rs:nc Modu%e. <a=%e 2.9= summari8es the o tions that can =e con+i'ured when creatin' a rs:nc modu%e.
Page 19" of 276
Figure (.9': Adding an 2s*nc 4odule
)a'le (.9': 2s*nc 4odule &onfiguration 9!tions Setting Modu%e name Comment >ath Access Mode Ma6imum connections !ser @alue strin' strin' =rowse =utton dro ;down menu inte'er 6escri!tion mandator:M needs to match the settin' on the rs:nc c%ient o tiona% descri tion .o%ume@dataset to ho%d recei.ed data choices are &ead and KriteD &ead-onlyD or Krite-only 0 is un%imited se%ect user that +i%e trans+ers to and +rom that modu%e shou%d ta)e %ace as se%ect 'rou that +i%e trans+ers to and +rom that modu%e shou%d ta)e %ace as see rs:ncd.con+A*B +or a%%owed +ormats see rs:ncd.con+A*B +or a%%owed +ormats additiona% arameters +rom rs:ncd.con+A*B
dro ;down menu dro ;down 3rou menu Hosts a%%ow strin' Hosts den: strin' Au6i%iar: arameters strin'
Page 19# of 276
(.11 S.4.A.2.).
$reeNA"1 uses the smartdA2B 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 S ".M.A.R.<. <ests S Add ".M.A.R.<. <est. 2. 5na=%e or disa=%e ".M.A.R.<. +or each dis) mem=er o+ a .o%ume in 4o%umes S 4iew 4o%umes. #: de+au%tD this is a%read: ena=%ed on a%% dis)s that su ort ".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 S Contro% "er.ices $i'ure 2.10a shows the con+i'uration screen that a ears when :ou c%ic) "er.ices S ".M.A.R.<. Figure (.11a: S.4.A.2.) &onfiguration 9!tions
N9):: s3artd wi%% wa)e u at e.er: "he'k 2nter#al con+i'ured in $i'ure 2.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 e6am %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 2.10a summari8es the o tions in the ".M.A.R.< con+i'uration screen. )a'le (.11a: S.4.A.2.) &onfiguration 9!tions Setting @alue 6escri!tion 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 Page 19$ of 276
Chec) inter.a% inte'er FreeNAS 9.1.1 Users Guide
Setting >ower mode (i++erence
@alue dro ;down menu inte'er in de'rees Ce%sius inte'er in de'rees Ce%sius inte'er in de'rees Ce%sius
In+ormationa%
Critica%
5mai% to re ort strin'
6escri!tion the con+i'ured test is not er+ormed i+ the s:stem enters the s eci+ied ower modeM choices areK Ne#erD Slee3D Stand$yD or 2dle de+au%t o+ 0 disa=%es this chec)D otherwise re orts i+ the tem erature o+ a dri.e has chan'ed =: N de'rees Ce%sius since %ast re ort de+au%t o+ 0 disa=%es this chec)D otherwise wi%% messa'e with a %o' %e.e% o+ 9-3GIN$- i+ the tem erature is hi'her than s eci+ied de'rees in Ce%sius de+au%t o+ 0 disa=%es this chec)D otherwise wi%% messa'e with a %o' %e.e% o+ 9-3GCRI< and send an emai% i+ the tem erature is hi'her than s eci+ied de'rees in Ce%sius emai% address o+ erson to recei.e ".M.A.R.<. a%ertM se arate mu%ti %e emai% reci ients with a comma and no s ace
(.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 =snm dA2B ser.er usin' $ree#"('s sim %e and e6tensi=%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 7!sr7share7SN=67mi$s and 7!sr7lo'al7share7SN=67mi$s. $i'ure 2.11a shows the "NM> con+i'uration screen. <a=%e 2.11a summari8es the con+i'uration o tions.
Page 196 of 276
Figure (.11a: &onfiguring SN4P
)a'le (.11a: SN4P &onfiguration 9!tions Setting 9ocation Contact Communit: @alue strin' strin' strin' 6escri!tion o tiona% descri tion o+ $reeNA"1 s:stem's %ocation o tiona% emai% address o+ $reeNA"1 administrator assword used on the "NM> networ)D de+au%t is 3!$li' and $ho!ld be cha%#ed *or $ec!rit) rea$o%$ additiona% =snm dA2B o tions not co.ered in this screenD one er %ine
Au6i%iar: >arameters strin'
(.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 o tionsD demonstrates an e6am %e con+i'uration that restricts users to their home director:D and ro.ides some trou=%eshootin' ti s.
(.12.1
SS% &onfiguration Screen
$i'ure 2.12a shows the "er.ices S ""H con+i'uration screen. -nce :ou ha.e con+i'ured ""HD don't +or'et to start it in "er.ices S Contro% "er.ices.
Page 197 of 276
Figure (.12a: SS% &onfiguration
<a=%e 2.12a summari8es the con+i'uration o tions. "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 =o6 P"how ad.anced +ie%ds =: de+au%tQ in ":stem S "ettin's S Ad.anced. )a'le (.12a: SS% &onfiguration 9!tions Setting <C> >ort 9o'in as Root with assword A%%ow >assword Authentication A%%ow <C> >ort $orwardin' Com ress Connections Host >ri.ate Ke: "$<> 9o' 9e.e% "$<> 9o' $aci%it: @alue inte'er chec)=o6 chec)=o6 chec)=o6 chec)=o6 strin' 6escri!tion ort to o en +or ""H connection reEuestsM 22 =: de+au%t *or $ec!rit) rea$o%$/ root lo#i%$ are di$co!ra#ed a%d di$abled b) de*a!ltG i+ ena=%edD assword must =e set +or root user in Account S !sers S 4iew !sers i+ unchec)edD )e: =ased authentication +or a%% users is reEuiredM reEuires additiona% setu on =oth the ""H c%ient and ser.er a%%ows users to =: ass +irewa%% restrictions usin' ""H's ort +orwardin' +eature ma: reduce %atenc: o.er s%ow networ)s
56tra - tions
on%: a.ai%a=%e in Ad.anced ModeM a%%ows :ou to aste a s eci+ic host )e: as the de+au%t )e: is chan'ed with e.er: insta%%ation dro ;down on%: a.ai%a=%e in Ad.anced ModeM se%ect the s:s%o'A3B %e.e% o+ the menu "$<> ser.er dro ;down on%: a.ai%a=%e in Ad.anced ModeM se%ect the s:s%o'A3B +aci%it: o+ menu the "$<> ser.er on%: a.ai%a=%e in Ad.anced ModeM additiona% sshdGcon+i'A*B o tions not co.ered in this screenD one er %ineM these o tions are strin' case;sensiti.e and mis;s e%%in's ma: re.ent the ""H ser.ice +rom startin' Page 19( of 276
A +ew sshdGcon+i'A*B o tions that are use+u% to in ut in the .(tra +3tions +ie%d inc%udeK &lientAli+eInter+alK increase this num=er i+ ssh connections tend to dro &lient4a,Startu!K de+au%ts to 10M increase i+ :ou ha.e more users
(.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 s eci+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% com uter 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 su orts 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' ste s. N9):: 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 reCuiring sft! access in "tora'e S 4o%umes. 2. If *ou are not using Acti+e 6irector* or <6APK create a user account +or each user in Account S !sers S Add !ser. In the ?ome ire'tory +ie%dD =rowse to the %ocation o+ the dataset :ou created +or that user. Re eat 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 sft3 in Account S 3rou s S Add 3rou . <henD c%ic) on the sft3 'rou in 4iew 3rou s and add the users who are to =e restricted to their home directories when usin' sft!. &. Set !er3issions for eac dataset in "tora'e S 4o%ume S 4iew 4o%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 A.:<b.
Page 199 of 276
Figure (.12': Per3issions 2eCuired '* SS% & root
*. &reate a o3e director* /it in eac dataset using S ell. (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. 56am %e 2.12a demonstrates the commands used to create a home director: ca%%ed !ser1 +or the user account !ser1 on dataset 7mnt7#ol!me17!ser1K :,a3!le (.12a: &reating a User.s %o3e 6irector*
mkdir /mnt/volume1/user1/user1 chown user1:user1 /mnt/volume1/user1/user1
,. &onfigure SS% in "er.ices S ""H. Add these %ines to the 56tra - tions sectionK
Match Group sftp ChrootDirectory %h ForceCommand internal-sftp AllowTcpForwarding no
/. Start t e SS% ser+ice in Contro% "er.ices. C%ic) the red -$$ =utton ne6t 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. 2. )est t e connection +rom a c%ient =: runnin' sft!D ss D 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%.
Page 211 of 276
(.12."
)rou'les ooting SS% &onnections
I+ :ou add an: .(tra +3tions 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 u er and %owercase %etters o+ the )e:word. I+ :our c%ients are recei.in' Nre.erse (N"N 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) S 3%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 e6 eriencin' ro=%emsD the ""H error messa'es are usua%%: rett: s eci+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 7#ar7log7a!th.log.
(.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 e6treme%: %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%% o en !(> ort ,9. N9):: in .ersions o+ $reeNA"1 rior to 2.3.0D <$<> is %imited to a ma6imum +i%e si8e o+ 32M#. $i'ure 2.13a shows the <$<> con+i'uration screen and <a=%e 2.13a summari8es the a.ai%a=%e o tionsK Figure (.1"a: )F)P &onfiguration
Page 211 of 276
)a'le (.1"a: )F)P &onfiguration 9!tions Setting (irector: A%%ow New $i%es >ort !sername !mas) 56tra o tions @alue 6escri!tion =rowse to the director: to =e used +or stora'eM some de.ices reEuire a =rowse =utton s eci+ic director: nameD re+er to the de.ice's documentation +or detai%s ena=%e i+ networ) de.ices need to send +i%es to the $reeNA"1 s:stem chec)=o6 Ae.'. =ac)u their con+i'B inte'er !(> ort to %isten +or <$<> reEuestsD :9 =: de+au%t dro ;down account used +or t+t reEuestsM must ha.e ermission to the ire'tory menu umas) +or new%: created +i%esD de+au%t is 022 Ae.er:one can readD inte'er no=od: can writeBM some de.ices reEuire a %ess strict umas) strin' additiona% t+t dA2B o tions not shown in this screenD one er %ine
(.1# UPS
$reeNA"1 uses N!< ANetwor) !>" <oo%sB to ro.ide !>" su ort. I+ the $reeNA"1 s:stem is connected to a !>" de.iceD con+i'ure the !>" ser.ice then start it in "er.ices S Contro% "er.ices. $i'ure 2.1&a shows the !>" con+i'uration screenK Figure (.1#a: UPS &onfiguration Screen
<a=%e 2.1&a summari8es the o tions in the !>" Con+i'uration screen.
Page 212 of 276
)a'le (.1#a: UPS &onfiguration 9!tions Setting !>" Mode Identi+ier (ri.er >ort Au6i%iar: >arameters (escri tion "hutdown mode "hutdown timer Monitor !ser Monitor >assword 56tra users Remote monitor "end 5mai% "tatus ! dates <o emai% 5mai% su=Iect @alue dro ;down menu strin' 6escri!tion se%ect +rom =aster or Sla#e
can contain a% hanumericD eriodD commaD h: henD and underscore characters dro ;down su orted !>" de.ices are %isted at menu htt K@@www.networ)u stoo%s.or'@sta=%e;hc%.htm% dro ;down se%ect the seria% or !"# ort the !>" is %u''ed into Asee menu N-<5 =e%owB strin' additiona% o tions +rom u s.con+A*B strin' o tiona% dro ;down choices are 16S goes on $attery and 16S rea'hes lo< menu $attery in secondsM wi%% initiate shutdown a+ter this man: seconds inte'er a+ter !>" enters 16S goes on $atteryD un%ess ower is restored strin' de+au%t is !3smon de+au%t is )nown .a%ue fi(me3ass and shou%d =e chan'edM strin' can not contain a s ace or J de+ines the accounts that ha.e administrati.e accessM see strin' u sd.usersA*B +or e6am %es i+ ena=%edD =e aware that the de+au%t is to %isten on a%% chec)=o6 inter+aces and to use the )nown .a%ues user !3smon and assword fi(me3ass chec)=o6 i+ chec)edD acti.ates the Ao email +ie%d i+ Send .mail =o6 chec)edD emai% address o+ erson to emai% address recei.e status u dates strin' i+ Send .mail =o6 chec)edD su=Iect o+ emai% u dates
N9):: +or !"# de.icesD the easiest wa: to determine the correct de.ice name is to chec) the =o6 N"how conso%e messa'esN in ":stem S "ettin's S Ad.anced. >%u' in the !"# de.ice and the conso%e messa'es wi%% 'i.e the name o+ the 7de#7!genX.X de.iceM where the 7's are the num=ers that show on the conso%e. u scA2B can =e used to 'et status .aria=%es +rom the !>" daemon such as the current char'e and in ut .o%ta'e. It can =e run +rom "he%% usin' the +o%%owin' s:nta6. <he man a'e 'i.es some other usa'e e6am %es.
upsc ups@localhost
Page 21" of 276
u scmdA2B can =e used to send commands direct%: to the !>"D assumin' that the hardware su orts 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.
Plugins
$reeNA"1 2.2.0 introduced the a=i%it: to e6tend 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.6 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 use the 3!I. It does not reEuire them to +irst create a %u'ins Iai% as the +irst time the: insta%% an a %icationD the %u'ins s:stem automatica%%: insta%%s and con+i'ures the %u'ins Iai%. !sers no %on'er ha.e to down%oad a %u'ins >#I or search +or >#Is to insta%% as the new %u'ins mechanism now ro.ides a %istin' o+ a.ai%a=%e >#Is. !sers who re+er more contro% o.er so+tware insta%%ation and who are com+orta=%e wor)in' +rom the command %ine can a%so choose to use the Cai%s method. (ue to A#I Aa s:stem. %ication =inar: inter+aceB chan'esD $reeNA"1 2.6 >#Is can not =e insta%%ed on a 9.6
N9):: a 0$" .o%ume is reEuired to use >%u'ins. I+ :ou ha.e created a !$" .o%umeD :ou wi%% need to instead use Cai%s to insta%% additiona% so+tware.
9.1
Installing a FreeNAS P5I Using Plugins
<o insta%% a $reeNA"1 >#I usin' the %u'ins methodD c%ic) >%u'ins to see the screen shown in $i'ure 9.1a. Figure 9.1a: Using Plugins to Install a P5I
<his screen ro.ides the +o%%owin' =uttons and sectionsK 2efres : used to re+resh the %ist o+ >#Is which are a.ai%a=%e +or insta%%ation. U!load: i+ the >#I has re.ious%: =een down%oadedD use this =utton to =rowse to the %ocation o+ FreeNAS 9.1.1 Users Guide Page 21# of 276
the sa.ed .3$i +i%e to insta%%. Na3e: shows the %ist o+ a.ai%a=%e >#IsD inc%udin' the nameD descri tionD and .ersion o+ each >#I. Installed: indicates i+ an: >#Is ha.e =een insta%%ed. <he %ocation o+ the %ist o+ a.ai%a=%e >#Is is set in the Con+i'uration ta=D shown in $i'ure 9.1=K Figure 9.1': P5I 2e!ositor* <ocation
<o insta%% a $reeNA"1 >#ID hi'h%i'ht its name in the %ist o+ a.ai%a=%e >#Is. In the e6am %e shown in $i'ure 9.1cD the <ransmission #it <orrent >#I is se%ected +or insta%%ation. Figure 9.1c: Selecting a P5I to Install
C%ic) P-KQ to start the insta%%ation. I+ this is the +irst >#I to =e insta%%edD 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%% FreeNAS 9.1.1 Users Guide Page 21$ of 276
the >#I and add it to the PInsta%%edQ section as shown in $i'ure 9.1d. #e atient as it ma: ta)e a +ew minutes +or the insta%%ation to +inish. Figure 9.1d: @ie/ing Installed P5Is
-nce insta%%edD an entr: +or the insta%%ed $reeNA"1 >#I wi%% a%so =e added to the >%u'ins +o%der in the treeD as seen in the e6am %e shown in $i'ure 9.1d. C%ic) that entr: to o en that >#I's con+i'uration o tions. <hese o tions are discussed in more detai% in the ne6t section. <o start the a %ication associated with the entr:D c%ic) its red -$$ =utton. I+ the ser.ice success+u%%: startsD it wi%% chan'e to a =%ue -N. N9):: a%wa:s re.iew a >#I's con+i'uration o tions be*ore attem tin' to start it. "ome >#Is ha.e o tions that need to =e set =e+ore their ser.ice wi%% success+u%%: start. <he a.ai%a=%e o tions wi%% .ar: =: >#IM the con+i'uration o tions +or the $ire+%:D Mini(9NAD and <ransmission >#Is are descri=ed in the ne6t section.
9.2
9fficial FreeNAS P5Is
<his section summari8es the con+i'uration o tions +or the >#Is that are a.ai%a=%e with $reeNA"1 9.1.1;R595A"5. -.er timeD as more >#Is =ecome a.ai%a=%eD more >#Is wi%% =e added to this section. <his section is meant to =e a 'uide to 'et :ou started with con+i'urin' insta%%ed so+tware. It is not meant to ro.ide an e6hausti.e how;to +or each so+tware that is a.ai%a=%e as a >#I. Whene.er :ou con+i'ure an: so+tware +or the +irst timeD re+er to the documentation ro.ided =: the so+twareD and when none e6istsD e6 ect to s end some time researchin' the so+tware's ca a=i%ities.
Page 216 of 276
9.2.1
Firefl*
$ire+%: media ser.er is an o en source media ser.er used to ser.e media +i%es +or Ro)u and i<unes. It was +ormer%: ca%%ed mt;daa d which is wh: the =inar: is 3t?daa!d and the con+i'uration +i%e is named mt-daa3d.'onf. -nce con+i'ured and startedD the +ire+%: ser.ice ro.ides its own we= administrati.e inter+ace +or con+i'urin' %a:%ists and +orcin' inde6 scans. <he +ire+%: roIect is no %on'er maintained. Another +or)D +or)ed;daa dD has not =een orted to $ree#"( :et. <he ort reEuest is here. $ire+%: has not wor)ed with A %e roducts since i<unes 10.2 and I-" &. Whi%e it can =e used to ser.e o%der i<unes musicD it does not do .ideo streamin'. -nce the +ire+%: >#I is insta%%edD c%ic) its entr: under >%u'ins. $i'ure 9.2a shows the con+i'uration screen +or +ire+%: and <a=%e 9.2a summari8es the con+i'uration o tions. Figure 9.2a: Firefl* &onfiguration Screen
)a'le 9.2a: Firefl* &onfiguration 9!tions Setting >ort Admin w @alue inte'er strin' 6escri!tion de+au%ts to 3:,9D the de+au%t i<unes ort mandator:M the assword to access the we= administration inter+ace the name o+ the ser.er as ad.ertised .ia rende8.ous and the name o+ the data=ase e6 orted .ia (AA>M de+au%t dis %a:s the .ersion num=er AO.B and the s:stem's hostname AOhB comma se arated %ist Ano s acesB o+ the +i%e e6tensions that wi%% =e inde6ed and ser.ed mandator:M =rowse to the %ocation that wi%% store the shared m 3 +i%es =rowse to the %ocation within the >%u'ins Cai% to store the +ire+%: %o' +i%e
"er.ername strin' 56tensions M>3 dir 9o'+i%e strin' =rowse =utton =rowse =utton
Page 217 of 276
Setting
6escri!tion how o+ten to chec) to see i+ an: m 3 +i%es ha.e =een added or remo.edM em t: or 0 disa=%es =ac)'round scannin'D thou'h a a scan can sti%% =e Rescan inte'er +orced +rom the NstatusN a'e o+ the administrati.e we= inter+aceM inter.a% automated scannin' ma: waste C>! and increase connection times to the ser.er i+ %e+t unchec)edD =ac)'round rescans o+ the +i%es:stem at each NRescan inter.a%N are disa=%ed un%ess c%ients are connectedD in order to a%%ow the A%wa:s scan chec)=o6 dri.es to s in down when not in useM chec)in' this =o6 wi%% scan e.er: &es'an inter#al sets how a''ressi.e%: m 3 +i%es shou%d =e scanned to determine +i%e %en'thM Normal scans the +irst m 3 +rame to tr: and ca%cu%ate si8e and shou%d =e accurate +or most +i%es e6ce t +or 4#R +i%es without a 7in' ta'M Aggressi#e dro ;down chec)s the =itrates o+ 10 +rames in the midd%e o+ the son' and wi%% sti%% =e "can t: e menu inaccurate +or 4#R +i%es without a 7in' ta'M 6ainf!lly aggressi#e wa%)s throu'h the entire son'D countin' the num=er o+ +ramesD which wi%% =e accurateD ta)es the most timeD =ut wi%% on%: occur the +irst time the +i%e is inde6ed >rocess chec)=o6 whether or not to rocess %a:%ists %a:%ists >rocess chec)=o6 whether or not to rocess i<unes i<unes >rocess m3u chec)=o6 whether or not to rocess m3u additiona% arameters not co.ered =: other o tion +ie%dsM these are Au6i%iar: strin' descri=ed in the +i%e 7!sr7lo'al7et'7mt-daa3d.'onf.sam3le which is insta%%ed arameters with the $ire+%: >#I within the >%u'ins Cai%
@alue
-nce :ou ha.e sa.ed :our con+i'uration .a%uesD start the +ire+%: ser.ice. I+ :ou wish to access +ire+%:'s =ui%t;in administrati.e 3!ID use a we= =rowser to in ut the I> address o+ :our >%u'ins Cai% +o%%owed =: a co%on and the 6ort num=er :ou con+i'ured Athe de+au%t is 3,29B. It wi%% rom t +or a username and asswordK in ut admin as the username and use the .a%ue :ou con+i'ured +or Admin 3< as the assword. <he +ire+%: administrati.e inter+ace is shown in $i'ure 9.2=. In this e6am %eD the >#I Iai% address is 10.0.0.1D the ort is 3:,9D and the smart 3laylists con+i'uration screen is o en.
Page 21( of 276
Figure 9.2': Firefl* -e' Ad3inistrati+e Interface
9.2.2
4ini6<NA
Mini(9NA is an o en source (9NA ser.er that uses !>n> +or media mana'ementD disco.er: and contro%. <he Mini(N9A daemon ser.es media +i%es such as musicD icturesD and .ideo to c%ients on a networ). 56am %e c%ients inc%ude a %ications such as totem and 6=mcD and de.ices such as orta=%e media %a:ersD smart honesD and te%e.isions. !n%i)e +ire+%:D it does not ro.ide its own we= inter+ace +or administration. N9):: Mini(9NA does not encode or decode. I+ :ou need this +unctiona%it:D consider so+tware such as ser.iio. "er.iio is a.ai%a=%e as a >C;#"( >#I or $ree#"( ort. A $ree#"( ac)a'e is not a.ai%a=%e due to the a %ication's restricted %icense. A%soD Mini(9NA does not automatica%%: rescan its data=ases when :ou ma)e a chan'e. "ee this +orum ost +or a scri t which adds this +unctiona%it:. -nce the Mini(9NA >#I is insta%%edD its o tions can =e con+i'ured =: c%ic)in' its entr: in >%u'ins. $i'ure 9.2c shows the con+i'uration screen +or Mini(9NA and <a=%e 9.2= summari8es the con+i'uration o tions.
Page 219 of 276
Figure 9.2c: 4ini6<NA &onfiguration Screen
)a'le 9.2': 4ini6<NA &onfiguration 9!tions Setting @alue 6escri!tion o tiona%M set this i+ :ou want to customi8e the name that shows u on :our c%ients mandator:M =rowse to or enter the %ocation o+ the director: to store the media +i%esM see N-<5 =e%ow H<<> ort +or descri tionsD "-A>D and media trans+er tra++icM de+au%t is ,200 how o+ten Mini(9NA =roadcasts its a.ai%a=i%it: on the networ)M de+au%t is e.er: ,9E seconds i+ chec)ed wi%% strict%: adhere to (9NA standards which wi%% a%%ow ser.er;side downsca%in' o+ .er: %ar'e C>53 ima'es and ma: hurt C>53 ser.in' er+ormance on "on: (9NA roducts mode% num=er the daemon wi%% re ort to c%ients in its 7M9 descri tionM de+au%t is 1 seria% num=er the daemon wi%% re ort to c%ients in its 7M9 descri tionM de+au%t is 123>E:;, whether or not the media +i%es are scanned when the Mini(9NA is started or restarted additiona% arameters a.ai%a=%e in minid%na.con+A*B and not co.ered =: other o tion +ie%ds
$riend%: name strin' Media director: >ort (isco.er inter.a% "trict (9NA =rowse =utton inte'er inte'er chec)=o6
Mode% num=er inte'er "eria% Rescan on AreBstart Au6i%iar: >arameters inte'er chec)=o6 strin'
Page 211 of 276
N9):: the =edia ire'tory must =e accessi=%e inside the Iai% so in most cases :ou wi%% want to add stora'e that mounts a director: +rom the $reeNA"1 +i%es:stem to a director: inside the >%u'ins Cai%. $or e6am %eD create a stora'e with a source o+ 7mnt7#ol!me17Cideo and a destination o+ 7mnt7#ol!me17Dail7soft<are7media. <o restrict the media t: eD add a Eua%i+ier to the A!(iliary 6arameters section. 56am %es o+ Eua%i+iers can =e +ound in the NmediaGdirN section o+ minid%na.con+A*B. -nce :ou ha.e sa.ed :our con+i'uration .a%uesD start the Mini(9NA ser.ice. 9.2." )rans3ission
<ransmission is an o en source #it<orrent c%ient. Its +eatures inc%ude encr: tionD a we= inter+aceD eer e6chan'eD ma'net %in)sD (H<D b<>D !>n> and NA<;>M> ort +orwardin'D we=seed su ortD watch directoriesD trac)er editin'D and '%o=a% and er;torrent s eed %imits. -nce the <ransmission >#I is insta%%edD its o tions can =e con+i'ured =: hi'h%i'htin' its entr: in >%u'ins. $i'ure 9.2d shows the con+i'uration screen +or <ransmission and <a=%e 9.2c summari8es the a.ai%a=%e con+i'uration o tions. More in+ormation a=out these o tions can =e +ound at the 5ditin' Con+i'uration $i%es a'e o+ the <ransmission wi)i. Figure 9.2d: )rans3ission :dit Screen
)a'le 9.2c: )rans3ission &onfiguration 9!tions Setting Watch (irector: Con+i'uration (irector: @alue =rowse =utton =rowse =utton 6escri!tion =rowse to the director: transmission wi%% watch +or new torrent +i%es =rowse to the director: where transmission wi%% store its con+i'uration +i%es Page 211 of 276
Setting (own%oad (irector: 9o'+i%e R>C@We=!I 5na=%ed R>C >ort R>C Auth ReEuired R>C !sername R>C >assword R>C White%ist 5na=%ed R>C White%ist (istri=uted Hash <a=%e A(H<B 9oca% >eer (isco.er: A9>(B Micro <rans ort >rotoco% Au<>B >eer ort >ortma Ma6 num=er o+ eers Ma6 num=er o+ eers er torrent 5ncr: tion
@alue =rowse =utton =rowse =utton chec)=o6 inte'er chec)=o6 strin' strin' chec)=o6 strin' chec)=o6 chec)=o6 chec)=o6 inte'er chec)=o6 inte'er inte'er dro ;down menu
6escri!tion =rowse to the director: where +i%es wi%% =e down%oaded to =rowse to the director: within the >%u'ins Cai% to store the transmission %o' +i%e unchec) this =o6 to disa=%e the transmission we= administrati.e inter+ace ort to %isten +or R>C reEuests onM de+au%t is 9091 i+ ena=%edD c%ients are reEuired to authenticateM reEuires 1sername and 6ass<ord +ie%ds to =e con+i'ured mandator: i+ &6" a!th reP!ired chec)edM username to use +or authentication mandator: i+ &6" a!th reP!ired chec)edM assword to use +or authentication i+ chec)edD on%: the addresses %isted in &6" Khitelist wi%% =e 'ranted remote access comma;de%imited %ist o+ I> addresses +rom which remote contro% is ermitted when ena=%edD the (H< rotoco% is used to trac) eers down%oadin' torrents without the use o+ a standard trac)erM the rotoco% stores %ists o+ other nodes@ eers which can =e used to %ocate new eers ena=%es the disco.er: o+ #it<orrent eers %ocated on the same 9AN ena=%es #it<orrent o.er !(> ort to %isten on +or incomin' eer connectionsM de+au%t is E1>13 ena=%e this to a%%ow other eers to connect to :ouM instructions +or a%%owin' transmission throu'h +irewa%%s@routers are here ma6imum num=er o+ connected eersM de+au%t is 2>0 ma6imum num=er o+ connected eers +or an indi.idua% torrentM de+au%t is :0 choices areK re+er unencr: ted Aencr: tion wi%% not =e used un%ess the c%ient reEuires itBD re+er encr: ted Aencr: tion wi%% =e used i+ the c%ient su orts itBD reEuire encr: ted Ac%ients must su ort encr: tionB how much :ou ha.e down%oaded ..s. how much :ou ha.e u %oadedM a%% torrentsD un%ess o.erridden =: a er;torrent settin'D shou%d seed unti% s eci+ied ratioM de+au%t is 2
3%o=a% "eed Ratio inte'er
-nce :ou ha.e sa.ed :our con+i'uration .a%uesD start the transmission ser.ice. FreeNAS 9.1.1 Users Guide Page 212 of 276
I+ :ou wish to access transmission's =ui%t;in administrati.e 3!ID use a we= =rowser to in ut the I> address o+ :our >%u'ins Cai% +o%%owed =: a co%on and the &6" 3ort num=er :ou con+i'ured Athe de+au%t is 9091B. It wi%% rom t +or a username and assword and =: de+au%t :ou can Iust ress enter to access the inter+ace. I+ :ou chec)ed the &6" a!th reP!ired =o6D in ut the &6" !sername and &6" 3ass<ord that :ou s eci+ied in :our con+i'uration. <he transmission we=site has a screenshot o+ the administrati.e inter+ace here. A <ransmission "u $orum is a%so a.ai%a=%e. ort
<his +orum ost demonstrates how to create a cron Io= to automatica%%: schedu%e the sto and start o+ transmission torrents.
11 Jails
<he re.ious section descri=ed how to +indD insta%%D and con+i'ure e6istin' $reeNA"1 >#Is +rom the 'ra hica% administrati.e inter+ace. $reeNA"1 9.0.1 adds a Cai%s icon to the 3!I which a%%ows users who are com+orta=%e usin' the command %ine to ha.e more contro% o.er so+tware insta%%ation. In 9.0.1D the ori'ina% 2.6 %u'ins Iai% has =een redesi'ned to add the +o%%owin' +eaturesK the a=i%it: to create mu%ti %e Iai%s the a=i%it: to create di++erent t: es o+ Iai%sD as descri=ed =e%ow the a=i%it: to access Iai%s o.er I>., the a=i%it: to insta%% 9.6 >C;#"( >#Is $ree#"( )'n' A ac)a'e new 'enerationB is the de+au%t +or $ree#"( ac)a'es A $ree#"( Iai% ro.ides %i'ht;wei'htD o eratin' s:stem;%e.e% .irtua%i8ation which essentia%%: a%%ows the creation o+ an inde endent $ree#"( o eratin' s:stem runnin' on the same hardware. <his means that an: so+tware and con+i'urations within a Iai% are iso%ated +rom =oth the $reeNA"1 o eratin' s:stem and an: other Iai%s runnin' on that s:stem. When a $reeNA"1 Iai% is createdD a C2=A/. o tion can =e se%ected which wi%% ro.ide that Iai% with its ownD inde endent networ)in' stac). <his a%%ows the Iai% to do its own I> =roadcastin'D which is reEuired =: some a %ications. In $reeNA"1 9.6 the +o%%owin' t: es o+ Iai%s can =e createdK 1. Plugin Aail: this t: e o+ Iai% su orts the insta%%ation o+ $reeNA"1 %u'insD a%so )nown as >#Is. >#Is were created =: the >C;#"( roIect to ro.ide a 'ra hica% insta%%ation wra er to so+tware which has =een orted to $ree#"(. $reeNA"1 >#Is e6tend this +unctiona%it: =: ro.idin' a 'ra hica% +ront;end to the a %ication's con+i'uration +i%e and =: a%%owin' the ser.ice to =e started and sto ed within the $reeNA"1 3!I. In addition to $reeNA"1 %u'insD :ou can a%so insta%% the +o%%owin' t: es o+ so+tware within a %u'in Iai%K >C;#"( >#IsD $ree#"( ortsD traditiona% $ree#"( ac)a'esD and $ree#"( )'n' ac)a'es. Howe.erD on%: $reeNA"1 %u'ins can =e mana'ed +rom the 3!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 su ort the a=i%it: to insta%% $reeNA"1 %u'ins. I+ :ou %an to insta%% $reeNA"1 %u'insD use a %u'in Iai%. 2. Port Aail: this t: e o+ Iai% su orts the insta%%ation o+ >C;#"( >#IsD $ree#"( ortsD traditiona% $ree#"( ac)a'esD and $ree#"( )'n' ac)a'es. It does %ot su ort the insta%%ation o+ FreeNAS 9.1.1 Users Guide Page 21" of 276
$reeNA"1 %u'insD meanin' that an: so+tware insta%%ed in this t: e o+ Iai% wi%% =e mana'ed +rom the command %ine o+ the Iai%. 3. Standard Aail: this t: e o+ Iai% is +unctiona%%: the same as a ort Iai%. A distinction is made +or those users who re+er to se arate networ) ser.ersD such as (HC> or (N" ser.ersD +rom other insta%%ed so+tware. <a=%e 9a 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. )a'le 9a: - at )*!e of Soft/are can 'e Installed Into a JailT )*!e of Jail >%u'in >ort "tandard FreeNAS P5I :es no no P&?5S6 P5I :es noD un%ess #anilla is unchec)ed durin' Iai% creation noD un%ess #anilla is unchec)ed durin' Iai% creation Free5S6 !7gng !ac7age Free5S6 !ort :es
:es noD un%ess #anilla is unchec)ed :es durin' Iai% creation noD un%ess #anilla is unchec)ed :es durin' Iai% creation
<he a=i%it: to create mu%ti %e Iai%s and mu%ti %e t: es o+ Iai%s o++ers 'reat +%e6i=i%it: and a %ication se aration to the administrator. $or e6am %eD one cou%d create a se arate %u'in Iai% +or each $reeNA"1 %u'inD a se arate ort Iai% +or each a %ication that is not a.ai%a=%e as a $reeNA"1 %u'inD and a se arate standard Iai% +or each insta%%ed networ) ser.er. A%ternate%:D one has the a=i%it: to create one Iai% and to mi6 and match how the so+tware is insta%%ed into that Iai%. <he rest o+ this section descri=es the +o%%owin'K Mi'ratin' an 2.6 Cai% Cai%s Con+i'uration Addin' Cai%s Insta%%in' $reeNA"1 >#Is Insta%%in' a >C;#"( >#I Insta%%in' non;>#I "o+tware Creatin' Four own >#Is
11.1 4igrating an (., Jail

#e+ore u 'radin' +rom 2.6 to 9.1.6D ma)e sure to =ac)u :our con+i'uration usin' ":stem S "ettin's S 3enera% S "a.e Con+i'. It is a%so recommended to =ac)u an: data and con+i'urations in the e6istin' Iai% =e+ore er+ormin' the u 'rade. I+ :ou u 'rade usin' the I"- or 3!I u 'radeD the con+i'uration shou%d automatica%%: =e restored +or :ou =: the u 'rade rocedure. I+ :ou instead =urned the 9.0.1 ima'e to a !"# stic)D :ou wi%% need to manua%%: restore the con+i'uration usin' ":stem S "ettin's S 3enera% S ! %oad Con+i'D as it is contains the Iai% settin's to =e mi'rated. FreeNAS 9.1.1 Users Guide Page 21# of 276
<o con.ert an e6istin' 2.6 Iai% to a 9.6 %u'inIai%D run the Iai% mi'ration scri t +rom "he%% i%$tead o* er+ormin' the Cai%s Con+i'urationK
/root/migrate_pluginjail.sh -D
<he ?6 er+orms a de+au%t mi'ration. I+ :ou wish to er+orm a more com %e6 mi'rationD read this +i%e +or a %istin' o+ the other su orted switches and some usa'e e6am %es. <he mi'ration wi%% ta)e a +ew minutes and the rom t wi%% dis %a: the +i%es that are =ein' mi'rated. -nce the mi'ration is com %eteD the Iai% wi%% a ear under Cai%s and the %ail &oot wi%% =e +i%%ed in with the dataset name used =: the Iai%. 3o to Cai%s S 4iew Cai%s to start the Iai%. (ue to =inar: incom ati=i%it: =etween $ree#"( 2.6 and 9.6 a %icationsD :ou wi%% need to reinsta%% :our a %ications a+ter the Iai% is mi'rated. 56istin' $reeNA"1 %u'ins wi%% =e dis %a:ed under "er.ices S >%u'ins. Howe.erD the: wi%% =e in the 2.6 +ormat and wi%% not wor) unti% the: are u 'raded to 9.6. A+ter u 'radin' or reinsta%%in' the Iai%'s a %icationsD restore the Iai%'s data +rom =ac)u . #e+ore restorin' the a %ication con+i'uration +i%esD chec) that these +i%es are com ati=%e with the new .ersions o+ the insta%%ed a %ications.
11.2 Jails &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 S Con+i'uration to access the screen shown in $i'ure 10.2a. Figure 11.2a: Glo'al Jail &onfiguration
Page 21$ of 276
Whi%e a Iai% can =e insta%%ed on !$"D it is recommended to use 0$" and to se%ect a dataset +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 s eci+ied ath. $or e6am %eD i+ :ou con+i'ure a %ail &oot o+ 7mnt7#ol!me17dataset1 and create a Iai% named Dail1D it wi%% =e insta%%ed into its own dataset named 7mnt7#ol!me17dataset17Dail1. C%ic) the #rowse =utton to se%ect the .o%ume or dataset. 5nsure that the si8e o+ the .o%ume or dataset se%ected 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 23# er Iai% and do not se%ect a dataset that is %ess than 23# in si8e. N9):: i+ :ou %an to add stora'e to a Iai%D =e aware that ath si8e is %imited to 22 characters. Ma)e sure that the %en'th o+ :our .o%ume name %us the dataset name %us the Iai% name does not e6ceed this %imit. $reeNA"1 wi%% automatica%%: detect and dis %a: the 26#> Net<ork that the administrati.e inter+ace is connected to. <his settin' is im ortant 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) to o%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 s eci+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 26#> Net<ork. I+ :ou are usin' 4MwareD ma)e sure that the .switch is set to romiscuous mode. Re.iew the de+au%t .a%ues o+ the 26#> Net<ork Start Address and 26#> Net<ork .nd Address to determine i+ that ran'e is a ro riate +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 e6c%uded +rom the sco e o+ the (HC> ser.er. As Iai%s are createdD the: wi%% automatica%%: =e assi'ned the ne6t +ree I> address within the ran'e s eci+ied =: these two .a%ues. I+ :ou %an to access an: Iai%s usin' I>.,D c%ic) the NAd.anced ModeN =utton and in ut the desired .a%ues +or the 26#: Net<orkD 26#: Net<ork Start AddressD and 26#: Net<ork .nd Address.
11." Adding Jails

<o create a Iai%D c%ic) Cai%s S Add Cai%s. N9):: this o tion wi%% not a ear unti% a+ter :ou con+i'ure Cai%s S Con+i'uration. #: de+au%tD :ou on%: ha.e to s eci+: the Iai% name to create a Iai%. I+ :ou wish to +ine;tune the Iai%'s arametersD c%ic) the Ad.anced Mode =utton to see the a.ai%a=%e o tionsD shown in $i'ure 10.3a. <a=%e 10.3a summari8es the a.ai%a=%e o tions.
Page 216 of 276
Figure 11."a: &reating a Jail
)a'le 11."a: Jail &onfiguration 9!tions Setting Cai% Name @alue strin' 6escri!tion mandator:M can on%: contain %etters and num=ers wi%% =e automatica%%: assi'ned the ne6t +ree address +rom the ran'e s eci+ied in Cai%s Con+i'urationM i+ :ou chan'e the de+au%t addressD ma)e sure it is reacha=%e within the $reeNA"1 s:stem's networ) see N-<5 =e%ow used to set the Iai%'s de+au%t 'atewa: I>.& address wi%% =e automatica%%: assi'ned the ne6t +ree address +rom the ran'e s eci+ied in Cai%s Con+i'uration see N-<5 =e%ow used to set the Iai%'s de+au%t 'atewa: I>., address
I>.& address inte'er I>.& =rid'e address I>.& de+au%t 'atewa: inte'er strin'
I>., address inte'er I>., =rid'e address I>., de+au%t 'atewa: inte'er strin'
Page 217 of 276
Setting MAC autostart t: e 4IMA35 NA< 32 =it .ani%%a
@alue strin' chec)=o6 dro ;down menu chec)=o6 chec)=o6 chec)=o6 chec)=o6
6escri!tion i+ a static MAC address is neededD in ut it hereM reEuires C2=A/. to =e chec)ed unchec) i+ :ou want to start the Iai% manua%%: choices are 3l!ginDailD standardD or 3ortDail 'i.es a Iai% its own .irtua%i8ed networ) stac)M reEuires romiscuous mode to =e ena=%ed on the inter+ace ena=%es Networ) Address <rans%ation +or the Iai% chec) this =o6 to insta%% the 32;=it .ersion o+ $ree#"( unchec) this =o6 to insta%% the >#I too%s and )'n'M these too%s are a%wa:s insta%%ed with a 3l!ginDail
N9):: <he I>.& and I>., =rid'e inter+ace is used to =rid'e the e airA&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 e3air0aD e3air1aD and e3air2a. <he h:sica% inter+ace em0 wi%% =e added to the =rid'eD as we%% as each e air de.ice. <he other ha%+ o+ the e air wi%% =e %aced inside the Iai% and wi%% =e assi'ned the I> address s eci+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'uredM either is correct. A Ntraditiona%N $ree#"( Iai% does not use 4IMA35 or NA<. I+ :ou unchec) =oth o+ these =o6esD :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 4IMA35 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 standard Iai% wi%% =e created and automatica%%: startedD un%ess :ou s eci+: otherwise. <he +irst time :ou add a Iai%D the 3!I wi%% automatica%%: down%oad the necessar: com onents +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 wi%% =e added instantaneous%: as the down%oaded =ase +or creatin' Iai%s is sa.ed to the %ail &oot.
11.".1
&onfiguring Jails
<o .iew and con+i'ure the added Iai%sD c%ic) Cai%s S 4iew a%% Cai%s. In the e6am %e shown in $i'ure 10.3=D two Iai%s ha.e =een created and the %ist entr: +or the Iai% named standard1 has =een c%ic)ed.
Page 21( of 276
Figure 11."': &reated Jails Added to t e 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 :dit Jail: edit the Iai%'s settin's as descri=ed in the ne6t section. Add Storage: con+i'ure the Iai% to access an area o+ stora'e as descri=ed in Addin' "tora'e. Install Plugins: on%: a.ai%a=%e in a %u'in Iai%. !sed to insta%% %u'ins as descri=ed in Insta%%in' $reeNA"1 >#Is. StartFSto!: this icon wi%% .ar:D de endin' u on the current runnin' status o+ the Iai%. I+ the Iai% is current%: sto edD 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 sto ed Iai% and its a %ications are inaccessi=%e unti% it is restarted. 6elete: de%etin' the Iai% a%so de%etes an: insta%%ed so+tware. <he 3!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 o eration is er+ormed.
18.3.1.1 +dit a 9ail:s Settings
$i'ure 10.3c shows the con+i'uration screen that a ears when :ou c%ic) the P5dit Cai%Q =utton +or a hi'h%i'hted Iai%'s entr:. <his screen can a%so =e accessed =: e6 andin' the Iai%'s name in the tree .iew FreeNAS 9.1.1 Users Guide Page 219 of 276
and c%ic)in' 5dit. Figure 11."c: Jail.s :dit Settings
<a=%e 10.3= summari8es the a.ai%a=%e settin's. "ome o+ these settin's were re.ious%: descri=ed in <a=%e 10.3a and can =e chan'ed usin' this screen a+ter Iai% creation. )a'le 11."': &onfigura'le Jail Settings Setting Cai% Name I>.& address I>.& a%iases I>.& =rid'e address I>.& =rid'e a%iases I>.& de+au%t 'atewa: I>., address I>., a%iases @alue strin' inte'er inte'er strin' strin' strin' inte'er inte'er 6escri!tion read;on%: .a%ue i+ :ou chan'e the de+au%t addressD ma)e sure it is reacha=%e within the $reeNA"1 s:stem's networ) used to add a secondar: I>.& addressM when addin' mu%ti %e a%iasesD use a comma de%imited %ist used to chan'e the I>.& address o+ the e airA&B de.ice used to add a secondar: I>.& address to the e airA&B de.iceM when addin' mu%ti %e a%iasesD use a comma de%imited %ist used to set the Iai%'s de+au%t 'atewa: I>.& address i+ :ou chan'e the de+au%t addressD ma)e sure it is reacha=%e within the $reeNA"1 s:stem's networ) used to add a secondar: I>., addressM when addin' mu%ti %e a%iasesD use Page 221 of 276
Setting I>., =rid'e address I>., =rid'e a%iases I>., de+au%t 'atewa: MAC autostart 4IMA35 NA<
@alue strin' strin' strin' strin'
6escri!tion a comma de%imited %ist used to chan'e the I>., address o+ the e airA&B de.ice used to add a secondar: I>., address to the e airA&B de.iceM when addin' mu%ti %e a%iasesD use a comma de%imited %ist used to set the Iai%'s de+au%t 'atewa: I>., address
i+ a static MAC address is neededD in ut it here reEuires 4IMA35 to =e chec)ed chec)=o6 unchec) i+ :ou want to start the Iai% manua%%: 'i.es a Iai% its own .irtua%i8ed networ) stac)M reEuires romiscuous mode chec)=o6 to =e ena=%ed on the inter+ace chec)=o6 ena=%es Networ) Address <rans%ation +or the Iai%
18.3.1.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. An e6am %e wou%d =e transmissionD which stores torrents. <he stora'e is added usin' the mountGnu%%+sA2B 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 PAdd "tora'eQ =utton +or a hi'h%i'hted Iai%'s entr:. <his screen can a%so =e accessed =: e6 andin' the Iai%'s name in the tree .iew and c%ic)in' "tora'e S Add "tora'e. As seen in $i'ure 10.3dD :ou wi%% =e rom ted to =rowse to the "ource and (estinationD whereK Source: is the director: on the $reeNA"1 s:stem :ou wou%d %i)e to 'ain access to +rom the Iai%. "e%ect a director: which resides outside o+ the Iai%. 6estination: se%ect the director: within the Iai% which wi%% =e %in)ed to the stora'e area. <: ica%%:D the estination ath is an em t: director: in the Iai%. <o create a new em t: director:D use the 37dir command within the Iai%. <his o eration creates 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%. <his means that i+ :ou de%ete an: +i%es +rom the (estination director: %ocated in the Iai%D :ou are rea%%: de%etin' those +i%es +rom the "ource director: %ocated on the $reeNA"1 s:stem. N9):: mountin' a dataset does not automatica%%: mount its chi%d datasets. Whi%e the chi%d datasets ma: a ear =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 oint.
Page 221 of 276
Figure 11."d: Adding Storage to a Jail
11.".2
Accessing t e &o33and <ine of a Jail
I+ :ou need to administer a Iai% +rom its command %ineD use "he%%. 5ach Iai% has its own Iai% I(. <o determine the I(D use the Als command. <his e6am %e has three Iai%s insta%%edK
jls JID 1 2 3 IP Address Hostname jail1 jail2 jail3 Path /mnt/volume1/dataset1/jail1 /mnt/volume1/dataset1/jail2 /mnt/volume1/dataset1/jail3
<o access a Iai%D s eci+: its Iai% I( and the she%% that :ou wou%d %i)e to use as o tions to the Ae,ec commandK
jexec 1 /bin/tcsh jail1#
<he Dail1Q rom t Ahostname o+ the Iai%B indicates that :ou are now inside the Iai%. #: de+au%tD ss access is not con+i'ured and a Iai% can on%: =e access throu'h "he%%. <o con+i'ure ss access +or a s eci+ied Iai%D er+orm the +o%%owin' actions whi%e inside that Iai%. $irstD add the +o%%owin' %ine to that Iai%'s 7et'7r'.'onfK
sshd_enable="YES"
A+ter sa.in' the +i%eD start the ""H daemonK

service sshd start
Page 222 of 276
<he host R"A )e: air shou%d =e 'enerated and the )e:'s +in'er rint and random art ima'e dis %a:ed. Ne6tD add a user account which wi%% =e used to ss into that Iai%. "ince the user wi%% want to ha.e su eruser ri.i%e'esD the user needs to =e %aced in the <heel 'rou . <o create the userD t: e adduser and +o%%ow the rom ts. When :ou 'et to this rom tD do not ress enter =ut instead t: e <heelK
Login group is user1. Invite user1 into other groups? []: wheel
-nce the user is createdD test +rom another s:stem that the user can success+u%%: ss in and =ecome the su eruser. In this e6am %eD a user named !ser1 uses ss to access the Iai% at 192.1,2.2.3. <he +irst time the user %o's inD the: wi%% =e as)ed to .eri+: the +in'er rint 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 $ su jail#
N9):: each Iai% has its own user accounts and ser.ice con+i'urations. <his means that :ou wi%% need to re eat these ste s +or each Iai% that reEuires ""H access.
11.# Installing FreeNAS P5Is

<: ica%%:D $reeNA"1 >#Is are insta%%ed usin' >%u'ins as this section o+ the 3!I ro.ides a method +or =rowsin' +or a.ai%a=%e >#Is. 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. N9):: $reeNA"1 >#Is can not =e insta%%ed inside a standard or orts Iai%. <o insta%% a $reeNA"1 >#ID 'o to Cai%s S 4iew Cai%s and c%ic) the %u'in Iai% :ou wish to insta%% into. An e6am %e is seen in $i'ure 10.&a. C%ic) the N! %oad >%u'inN =utton. When rom tedD N#rowseN to the %ocation o+ the down%oaded >#I then c%ic) the N! %oadN =utton to insta%% the >#I. A status =ar wi%% indicate the ro'ress o+ the insta%%ation. -nce insta%%edD the a %ication wi%% a ear under the >%u'ins entr: o+ the tree. In the e6am %e shown in $i'ure 10.&=D the Mini(9NA %u'in has =een insta%%ed.
Page 22" of 276
Figure 11.#a: Select Plugin Jail to Install Into
Page 22# of 276
Figure 11.#': FreeNAS P5I Successfull* Installed
Fou can now con+i'ure and mana'e the insta%%ed so+tware as descri=ed in >%u'ins.
11.$ Installing a P&?5S6 P5I

<he >C;#"( roIect maintains a re ositor: o+ o.er 1D100 >#Is. >C;#"( 9.6 >#Is can =e insta%%ed +rom the command %ine o+ a %u'inD ortD or standard Iai%. <his section descri=es how to +ind and insta%% >C;#"( >#Is into a $reeNA"1 Iai%. N9):: the >C;#"( roIect has transitioned to on%: ro.idin' ,&;=it >#Is. I+ :ou are runnin' the 32; =it .ersion o+ $reeNA"1D :ou can not insta%% >C;#"( >#Is. #e+ore :ou can +ind and insta%% >C;#"( >#IsD :ou must +irst down%oad the >C;#"( re ositor: inde6 and start the >C;#"( !'id ser.ice +rom within a Iai%K
pkg install pcbsd-utils service pbid onestart Starting pbid...
Page 22$ of 276
11.$.1
Finding P&?5S6 P5Is
Fou can .iew which 9.6 >#Is are a.ai%a=%e at the >C;#"( >#I =ui%d ser.er. A%ternate%:D :ou can =rowse +or a so+tware cate'or: then =rowse +or a %ications within that cate'or:D as seen in the +o%%owin' e6am %eK
pbi_browser |more Using RepoID: 001 Available Categories: -----------------------------------Category: Accessibility Icon: /var/db/pbi/repo-icons/dd3920955c2fcf9bcc66b20dc0d89354-Accessibility.png Description: Utilities to ease computer usage -----------------------------------Category: Archivers Icon: /var/db/pbi/repo-icons/dd3920955c2fcf9bcc66b20dc0d89354-Archivers.png Description: Programs for packing/unpacking data archives -----------------------------------Category: Astronomy Icon: /var/db/pbi/repo-icons/dd3920955c2fcf9bcc66b20dc0d89354-Astronomy.png Description: Programs for mapping the stars or the earth -----------------------------------<snip output> pbi_browser -c Multimedia | more Using RepoID: 001 Available PBIs for Category: Multimedia -----------------------------------Application: AcidRip Version: 0.14_8 Created: 20120514 212419 RootInstall: NO Arch: amd64 Author: AcidRip Team URL: http://sourceforge.net/projects/acidrip/ License: GPL Type: Graphical Keywords: cd,dvd,ripper,encoder Icon: /var/db/pbi/repo-icons/dd3920955c2fcf9bcc66b20dc0d89354-AcidRip.png Description: AcidRip is a Gtk2::Perl application for ripping and encoding DVD's. It neatly wraps MPlayer and MEncoder, seeing as MPlayer is by far the best bit of video playing kit around for Linux (and FreeBSD). As well as creating a simple Graphical Interface for those scared of getting down and dirty with MEncoders command line interface, It also automates the process in a number of ways: - Parses DVD into contents tree - Finds longest title o Calculate video bitrate for given filesize - Finds black bands and crops them - Gives suggestions for improved performance To install this PBI: # pbi_add --rArch amd64 --repo 001 -r AcidRip -----------------------------------<snip output>
Page 226 of 276
11.$.2
Installing a P&?5S6 P5I
<o insta%% a >C;#"( >#I +rom within a Iai%D use =iGaddA1B. <his command %ine uti%it: can =e used to either insta%% a re.ious%: down%oaded .3$i +i%e or to automatica%%: +etch and insta%% the s eci+ied >#I. N9):: each Iai% is se arate +rom e.er: other Iai%. <his means that i+ :ou insta%% so+tware within a Iai%D it is on%: insta%%ed into that s eci+ic Iai%. <his a%%ows :ou to insta%% di++erent so+tware and e.en di++erent .ersions o+ that so+tware in di++erent Iai%s. Ma)e sure :ou are in the Iai% that :ou want to insta%% so+tware into =e+ore runnin' the +o%%owin' commands. I+ :ou ha.e a%read: down%oaded a >#I +i%eD s eci+: the name o+ that +i%e. In this e6am %eD the men'oder-1.1.r2013030,-amd:>.3$i >#I was re.ious%: down%oaded to the same director: the command is run +romK
pbi_add mencoder-1.1.r20130308-amd64.pbi Verifying Checksum...OK Extracting to: /usr/pbi/mencoder-amd64 Installed: mencoder-1.1.r20130308
A%ternate%:D do not down%oad the .3$i +i%e +irst. InsteadD inc%ude the remote +etchin' o tion and the name o+ the >#I to insta%%K
pbi_add -r mencoder Getting regional mirror... Using mirror: ftp://ftp.pcbsd.org/pub/mirror Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/multimedia/mencoder/9/x64/mencoder1.1.r20130308-amd64.pbi /usr/pbi/.mencoder-1.1.r20130308-amd64.pbi 100% of 30 MB 1712 kBps 00m00s Verifying Checksum...OK Extracting to: /usr/pbi/mencoder-amd64 Installed: mencoder-1.1.r20130308
Re'ard%ess o+ how the >#I was insta%%edD :ou can .eri+: which .ersion is insta%%ed usin' =iGin+oA1B. In this e6am %eD the $ire+%:D Mini(9NAD and <ransmission >#Is were insta%%ed as %u'ins +rom the 3!I and the mencoder >#I was insta%%ed usin' !'i8add:
pbi_info firefly-1696_8-amd64 mencoder-1.1.r20130308-amd64 minidlna-1.0.25_1-amd64 transmission-2.77_1-amd64
11.6 Installing non?P5I Soft/are

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. #e+ore :ou can insta%% so+tware usin' a $ree#"( ac)a'e or ortD :ou wi%% need to access the command %ine o+ the Iai%. The co((a%d$ de(o%$trated i% thi$ $ectio% %eed to be exec!ted *ro( -ithi% the Hail the $o*t-are i$ to be i%$talled i%to. FreeNAS 9.1.1 Users Guide Page 227 of 276
11.6.1
Installing Free5S6 Pac7ages /it !7gng
<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;com i%edD meanin' that it contains a%% the =inaries and de endencies 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'. $i'ure 10.,a shows the search resu%ts +or the audiota' a %ication. Figure 11.6a: Fres Ports Searc 2esults
<he search indicates the name o+ the so+twareD the .ersionD a descri tionD the cate'or: Ae.'. audioBD the emai% address o+ the ort's maintainerD a "4NWe= %in) containin' the detai%s o+ the ortD a %in) to the so+tware's main we=siteD the command used to com i%e the ort Aas descri=ed in the ne6t sectionB and the !7g8add ?r command used to insta%% the ac)a'e. N9):: $reeNA"1 uses )'n'D $ree#"('s ne6t 'eneration o+ ac)a'e mana'ement which wi%% e.entua%%: re %ace the !7g8add too% used =: $ree#"('s traditiona% ac)a'e mana'ement s:stem. <his means that :ou wi%% instead use the !7g install command to insta%% ac)a'es within a $reeNA"1 Iai%. Fou can %earn more a=out how to use )'n' in the $ree#"( Hand=oo). 6ANG:2D do %ot use the !'i8add command in a $reeNA"1 Iai% as it wi%% cause inconsistencies in :our ac)a'e mana'ement data=ase. $or e6am %eD to insta%% audiota' with )'n'D use this commandK
pkg install audiotag Updating repository catalogue repo.txz 00:14 The following packages will be installed:
100%
15MB
1.1MB/s
1.3MB/s
Page 22( of 276
Installing libogg: 1.3.1,4 Installing png: 1.5.16 Installing flac: 1.2.1_3 Installing libao: 1.1.0_1 Installing libvorbis: 1.3.3_1,3 Installing speex: 1.2.r1_4,1 Installing curl: 7.24.0_3 Installing libkate: 0.4.1_2 Installing id3lib: 3.8.3_5 Installing vorbis-tools: 1.4.0_4,3 Installing AtomicParsley: 0.9.0_1 Installing audiotag: 0.19_1 The installation will require 21 MB more space 3 MB to be downloaded Proceed with installing packages [y/N]: y libogg-1.3.1,4.txz 100% 185KB png-1.5.16.txz 100% 225KB flac-1.2.1_3.txz 100% 811KB libao-1.1.0_1.txz 100% 47KB libvorbis-1.3.3_1,3.txz 100% 359KB speex-1.2.r1_4,1.txz 100% 142KB curl-7.24.0_3.txz 100% 1110KB libkate-0.4.1_2.txz 100% 118KB id3lib-3.8.3_5.txz 100% 212KB vorbis-tools-1.4.0_4,3.txz 100% 178KB AtomicParsley-0.9.0_1.txz 100% 69KB audiotag-0.19_1.txz 100% 17KB Checking integrity... done Installing libogg-1.3.1,4... done Installing png-1.5.16... done Installing flac-1.2.1_3... done Installing libao-1.1.0_1... done Installing libvorbis-1.3.3_1,3... done Installing speex-1.2.r1_4,1... done Installing curl-7.24.0_3... done Installing libkate-0.4.1_2... done Installing id3lib-3.8.3_5... done Installing vorbis-tools-1.4.0_4,3... done Installing AtomicParsley-0.9.0_1... done Installing audiotag-0.19_1... done
185.2KB/s 224.9KB/s 810.9KB/s 47.3KB/s 358.5KB/s 141.5KB/s 1.1MB/s 118.2KB/s 211.9KB/s 177.7KB/s 69.5KB/s 17.5KB/s
185.2KB/s 224.9KB/s 270.9KB/s 47.3KB/s 358.5KB/s 141.5KB/s 630.2KB/s 118.2KB/s 211.9KB/s 177.7KB/s 69.5KB/s 17.5KB/s
00:01 00:01 00:01 00:01 00:00 00:00 00:01 00:00 00:00 00:01 00:01 00:00
<he insta%%ation messa'es indicate that the ac)a'e and its de endencies success+u%%: down%oaded. Fou can con+irm that the insta%%ation was success+u% =: Euer:in' the ac)a'e data=aseK
pkg info -f audiotag Name : audiotag Version : 0.19_1 Origin : audio/audiotag Prefix : /usr/local Categories : multimedia audio Licenses : GPLv2 Maintainer : ports@FreeBSD.org WWW : http://github.com/Daenyth/audiotag Comment : A command-line tool for mass tagging/renaming of audio files Options : DOCS: on
Page 229 of 276
FLAC: on ID3: on MP4: on VORBIS: on Flat size : 62 kB 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 owns the following files: /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 7!sr7lo'al to di++erentiate it +rom the so+tware that came with the o eratin' 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'. 11.6.2 &o3!iling Free5S6 Ports /it 3a7e
<: ica%%:D so+tware is insta%%ed usin' ac)a'es. -ccasiona%%: :ou ma: re+er to com i%e the ort :ourse%+. Com i%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 com i%e o tions that are not a.ai%a=%e in the re;com i%ed ac)a'e. <hese o tions are used to add additiona% +eatures or to stri out the +eatures :ou do not need. Com i%in' the ort :ourse%+ has the +o%%owin' dis;ad.anta'esK it ta)es time. (e endin' u on the si8e o+ the a %icationD the amount o+ de endenciesD 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. N9):: i+ the ort doesn't ro.ide an: com i%e o tionsD :ou are =etter o++ sa.in' :our time and the $reeNA"1 s:stem's resources =: usin' the !7g8add command instead. Fou can determine i+ the ort has an: con+i'ura=%e com i%e o tions =: c%ic)in' its $resh>orts %istin'. $i'ure 10.,= shows the PCon+i'uration - tionsQ +or audiota'. FreeNAS 9.1.1 Users Guide Page 2"1 of 276
Figure 11.6': &onfiguration 9!tions for Audiotag
In $ree#"(D a =akefile is used to ro.ide the com i%in' instructions to the 3a7e command. <he =akefile is in ascii te6tD +air%: eas: to understandD and documented in =sd. ort.m). I+ the ort has an: con+i'ura=%e com i%e o tionsD the: wi%% =e %isted at $resh>orts in the ort's PCon+i'uration - tionsQ. <his ort contains +i.e con+i'ura=%e o tions A(-C"D $9ACD I(3D M>&D and 4-R#I"B and each o tion is ena=%ed AonB =: de+au%t. $ree#"( ac)a'es are a%wa:s =ui%t usin' the de+au%t o tions. When :ou com i%e the ort :ourse%+D those o tions wi%% =e resented to :ou in a menuD a%%owin' :ou to chan'e their de+au%t settin's. #e+ore :ou can com i%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 e6tract it to the Iai%'s 7!sr73orts7 director:. N9):: 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 com i%e a ortD :ou wi%% cd into a su=director: o+ 7!sr73orts7. $resh>orts ro.ides the %ocation to cd FreeNAS 9.1.1 Users Guide Page 2"1 of 276
into and the 3a7e command to run. <his e6am %e wi%% com i%e the audiota' ortK
cd /usr/ports/audio/audiotag make install clean
"ince this ort has con+i'ura=%e o tionsD the +irst time this command is run the con+i'ure screen shown in $i'ure 10.,c wi%% =e dis %a:edK Figure 11.6c: &onfiguration 9!tions for Audiotag Port
<o chan'e an o tion's settin'D use the arrow )e:s to hi'h%i'ht the o tionD 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 com i%e and insta%%. N9):: 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 3a7e config UU 3a7e install clean i+ :ou need to chan'e :our se%ected o tions. I+ the ort has an: de endencies with o tionsD their con+i'uration screens wi%% =e dis %a:ed and the com i%e wi%% ause unti% it recei.es :our in ut. It is a 'ood idea to )ee an e:e on the com i%e unti% it +inishes and :ou are returned to the command rom t. I+ :ou need to er+orm other con+i'uration tas)sD c%ic) the 6 in the u er ri'ht corner o+ "he%%. <his wi%% detach +rom the Iai% without ausin' the com i%e rocess;;when :ou c%ic) "he%% a'ain :ou wi%% =e returned to the Iai% and can .iew the current ro'ress o+ the com i%e. -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 !7g8info to determine what was insta%%edD as descri=ed in the re.ious section. 11.6." &onfiguring and Starting Installed Free5S6 Soft/are
-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 7!sr7lo'al7et' 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 s end some time at the so+tware's we=site to %earn which con+i'uration o tions are a.ai%a=%e and which con+i'uration +i%eAsB need to =e edited. FreeNAS 9.1.1 Users Guide Page 2"2 of 276
Most $ree#"( ac)a'es that contain a starta=%e ser.ice inc%ude a startu scri t which is automatica%%: insta%%ed to 7!sr7lo'al7et'7r'.d7. -nce :our con+i'uration is com %eteD :ou can test that the ser.ice starts =: runnin' the scri t with the onestart o tion. As an e6am %eD i+ o en. n is insta%%ed into the Iai%D these commands wi%% run its startu scri t 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 root openvpn 48386 4 udp4 *:54789
FOREIGN ADDRESS *:*
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 F+arFlogF3essages 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' o tion 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 7et'7r'.'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@J0.SJ and t: ica%%: starts with the name o+ the so+tware. $or e6am %eD this is the entr: +or the o en. n ser.iceK
openvpn_enable="YES"
When in dou=tD the startu scri t wi%% te%% :ou which %ine to ut in 7et'7r'.'onf. <his is the descri tion in 7!sr7lo'al7et'7r'.d7o3en#3n)
# # # # # # # # # # # # # # # 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 scri t 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
Page 2"" of 276
# # # # #
NAME_dir="/usr/local/etc/openvpn"
# --cd directory
You also need to set NAME_configfile and NAME_dir, if the configuration file and directory where keys and certificates reside differ from the above settings.
11.7 &reating >our o/n P5Is

<his cha ter has a%read: descri=ed how to insta%% an e6istin' $reeNA"1 >#I and con+i'ure it +rom the $reeNA"1 'ra hica% inter+ace as we%% as how to insta%% and con+i'ure an e6istin' >C;#"( >#I +rom the command %ine o+ a Iai%. Creatin' a >C;#"( >#I reEuires %itt%e to no ro'rammin' )now%ed'e. <he 5as:>#I too%D demonstrated in this cha terD ma)es it .er: eas: to con.ert an e6istin' $ree#"( ort to a >C;#"( >#I. -nce a >C; #"( >#I is createdD it can =e insta%%ed into a %u'ins Iai% usin' these instructions. -nce a >C;#"( >#I e6istsD it can =e e6tended into a $reeNA"1 >#I. <he ad.anta'e o+ a $reeNA"1 >#I is that it can =e con+i'ured usin' the 'ra hica% inter+ace and it can =e added to the >#I re ositor: so that it a ears in the a %ication %ist o+ >%u'ins. <he disad.anta'e is that ro'rammin' )now%ed'e is reEuired to create the inter+ace ortion o+ a $reeNA"1 >#I. <his section ro.ides an o.er.iew o+ the >C;#"( >#I and $reeNA"1 >#I architectures. It descri=es how to use the 'ra hica% 5as:>#I too% to create a >C;#"( >#I and what is needed to create a $reeNA"1 >#I. >#I creators are encoura'ed to s)im throu'h the who%e cha ter +irst =e+ore creatin' a >#I. 11.7.1 Introduction to t e P5I Arc itecture
<he >#I A>ush #utton Insta%%erB architecture was created =: Kris Moore +or the >C;#"( roIect. It ro.ides a mechanism +or con.ertin' e6istin' $ree#"( orts into se%+;contained so+tware ac)a'es. <he $reeNA"1 >#I architecture e6tends this +unctiona%it: =: inte'ratin' a >#I's con+i'uration +i%e into the $reeNA"1 'ra hica% inter+ace. "ince >#Is are 'enerated +rom e6istin' $ree#"( ortsD the a %ication must a%read: =e orted to $ree#"(. <he easiest wa: to con+irm whether or not a $ree#"( ort e6ists is to search +or the so+tware at $resh>orts.or'. I+ a ort does not e6istD :ou can create 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 $ree#"( >orters Hand=oo) contains detai%ed instructions +or ortin' so+tware to $ree#"(. I+ the $ree#"( ort e6istsD :ou shou%d then determine i+ a >C;#"( >#I a%read: e6ists. I+ it doesD :ou can either insta%% that >#I into a %u'ins Iai% or tr: to e6tend it into a $reeNA"1 >#I. I+ :ou want to see i+ an:one e%se is wor)in' on a >#I or has one to testD re+er to the ta=%e o+ outstandin' >#I reEuests. 5ach >#I is =ased u on a modu%e which is sim %: a co%%ection o+ +i%es which contro% the contents o+ the >#I and whether or not it inte'rates into the $reeNA"1 3!I. 56istin' >C;#"( >#I modu%es can =e +ound here. 56istin' $reeNA"1 >#I modu%es can =e +ound here. <a=%e 10./a summari8es the +unction o+ the +i%es which are +ound in a >#I modu%e. In addition to these +i%esD the reso!r'es7 director: o+ a >#I ma: contain additiona% +i%es s eci+ic to the con+i'uration o+ that >#I. FreeNAS 9.1.1 Users Guide Page 2"# of 276
)a'le 11.7a: P5I 4odule &o3!onents File Na3e 6escri!tion on%: a ears in $reeNA"1 >#IsM this +i%e inte'rates the a %ication's reso!r'es7'ontrol con+i'uration +i%e into the $reeNA"1 3!I reso!r'es7defa!lt.3ng the icon used +or the a %ication's entr: in the tree o+ the $reeNA"1 3!I reso!r'es7freenas on%: a ears in $reeNA"1 >#IsM contains the %u'in A>I .ersion on%: a ears in $reeNA"1 >#IsM used to sa.e the a %ication's start@sto reso!r'es7t<eak-r''onf status i+ the $reeNA"1 s:stem re=oots o tiona% scri t which runs immediate%: a+ter the %u'in is insta%%edM an s'ri3ts73ost-install.sh e6am %e use is to ro.ide data=ase initia%i8ation o tiona% scri t to run a+ter the ort com i%e is +inished =ut =e+ore the >#I is s'ri3ts73ost-3ortmake.sh ac)a'edM t: ica%%: used to add e6tra %u'ins or to com i%e additiona% orts not inc%uded in the ort's =akefile s'ri3ts73re-3ortmake.sh o tiona% scri t to run =e+ore the ort com i%e starts o tiona% scri t to customi8e the s:stem rior to the %u'in =ein' insta%%edD s'ri3ts73re-install.sh such as addin' users and 'rou s o tiona% scri t to run =e+ore the %u'in is uninsta%%edM t: ica%%: used to ma)e sure the ser.ice has =een sto edD to remo.e %o' or tem orar: +i%es used =: s'ri3ts73re-remo#e.sh the so+twareD or to de%ete a s:stem account or 'rou used =: the so+tware =ein' deinsta%%ed contains the instructions +or com i%in' the >#IM the .aria=%es in this +i%e are 3$i.'onf documented in the >#I Modu%e #ui%der 3uide Whi%e these +i%es can =e created =: handD it is recommended to automatica%%: 'enerate these +i%es usin' the 'ra hica% 5as:>#I uti%it: andD i+ necessar:D to twea) the 'enerated +i%es to meet the needs o+ the resu%tin' >#I. 11.7.2 Using :as*P5I to &reate a P&?5S6 P5I
<he >C;#"( roIect ro.ides a 'ra hica% uti%it: +or easi%: con.ertin' e6istin' $ree#"( orts into >C; #"( >#Is. Creatin' a >C;#"( >#I can =e as sim %e as =rowsin' to the name o+ the $ree#"( ort then c%ic)in' the N#ui%d >#IN =utton. $or more com %e6 >#I modu%esD 5as:>#I ro.ides a +ront;end +or con+i'urin' e.er: o tion su orted =: the >#I +ormat. 5as:>#I is a.ai%a=%e +or >C;#"( and $ree#"( s:stems. Instructions +or insta%%in' the %atest .ersion o+ 5as:>#I can =e +ound here. -nce 5as:>#I is insta%%edD +o%%ow the instructions in the ?uic) "tart to Creatin' a >#I Modu%e to 'enerate :our >C;#"( >#I. <he ?uic) "tart a%so ro.ides %in)s to how to use a%% o+ the a.ai%a=%e >#I modu%e o tions as we%% as how to test :our >#I. A+ter 'eneratin' :our >C;#"( >#ID the +o%%owin' ste s are recommended so that other >C;#"( and $reeNA"1 users can =ene+it +rom :our e++ortK su=mit the >#I modu%e to the >C;#"( roIect +o%%owin' these instructions. FreeNAS 9.1.1 Users Guide Page 2"$ of 276
u date the >#I ReEuests ta=%e so that other $reeNA"1 users )now that a >C;#"( >#I is now a.ai%a=%e. Indicate i+ :ou %an to con.ert to a $reeNA"1 >#I so that other users can test :our >#I. -nce testin' is com %eteD the >#I can =e added to the $reeNA"1 >#I re ositor:. 11.7." 9+er+ie/ of t e Plugins Arc itecture
<his section descri=es the methods that are used =: $reeNA"1 to inte'rate a >#I into its we= inter+ace. <he ne6t section descri=es the chan'es that must =e made to a >C;#"( >#I in order to inte'rate it into the $reeNA"1 3!I. As a $reeNA"1 >#I is insta%%edD in+ormation is added to the $reeNA"1 con+i'uration data=ase. <a=%e 10./= summari8es the co%umns which are u dated in the ta=%e 3l!gins*3l!gins. )a'le 11.7': &olu3ns in "l!#i%$I"l!#i%$ )a'le File Na3e %u'inG.ersion %u'inGena=%ed %u'inGi %u'inG ort %u'inGarch %u'inGa iG.ersion %u'inGname %u'inG =iGname %u'inG ath 6escri!tion %u'in .ersion num=er ena=%ed@disa=%ed status $astC3I ser.er I> address $astC3I ser.er ort %u'in architecture as i32, A32;=itB or amd,& A,&;=itB R>C A>I .ersion name o+ the %u'in >#I +i%e name as u %oaded where in the +i%es:stem the %u'in is insta%%ed
-nce the >#I con+i'uration in+ormation is sa.edD an -Auth secret and )e: are 'enerated as a record in the ser#i'es*r3'token ta=%e. <his ta=%e contains two co%umnsK secret: the -Auth secret 7e*: the -Auth )e: -nce the >#I and -Auth in+ormation is recorded in the data=aseD the +o%%owin' ste s occurK 1. <he >#I is insta%%ed into the %u'ins Iai% in 7!sr73$i7NR3l!ginS-NRar'hS7. 2. <he -Auth )e: and secret are written into 7!sr73$i7NR3l!ginS-NRar'hS7.oa!th. 3. <he %u'in in+ormation is written to 3l!gins.'onf which is inc%uded =: ngin(.'onf. <his te%%s n'in6 that a%% !R9s that s eci+: the %u'in ath are to =e assed to the %u'in's $astC3I ser.er. &. <he %u'ins 'ontrol scri t is started in the Iai% in order to start the %u'in $astC3I ser.er on the I>@ ort com=ination recorded in the data=ase. *. <he we= inter+ace is re+reshed. <he na.tree ma)es a reEuest to the %u'incs treemen! method. <he treemen! method returns a descri tion o+ how to dis %a: the %u'in in+ormation in the na.tree. -nce this method is ca%%edD the %u'in a ears in the na.tree menu with the %u'in icon. FreeNAS 9.1.1 Users Guide Page 2"6 of 276
When the %u'in icon is c%ic)edD dIan'o matches the %u'in !R9 and sends the reEuest to the %u'in $astC3I ser.er. ReEuestin' a %u'in method is in the +orm P73l!gins7NR3l!ginS7NRidS7NRmethodS. <he a.ai%a=%e methods are summari8ed in <a=%e 10./c. )a'le 11.7c: A+aila'le Plugin 4et ods File Na3e Gs@treemenu Gs@start Gs@sto Gs@status 6escri!tion contro%s what to dis %a: in the na.tree and how it is dis %a:ed start the %u'in sto the %u'in start@sto status o+ the %u'in
>%u'ins ha.e access to the =ase s:stem .ia R>C ca%%s. A%% R>C reEuests are si'ned with the -Auth credentia%s 'i.en to the %u'in at insta%% time. <a=%e 10./d summari8es the a.ai%a=%e R>C methods. )a'le 11.7d: Plugin 2P& 4et ods File Na3e a i..ersionAB %u'ins. %u'ins.'etAB %u'ins.Iai%Gin+oAB %u'ins.isGauthenticatedAB +s.mount oints.'etAB +s.mounted.'etAB +s.mountAB +s.umountAB +s.director:.'etAB +s.+i%e.'etAB os.archAB a i.testAB 6escri!tion 'et the %u'in A>I .ersion 'et a %istin' o+ insta%%ed %u'ins 'et in+ormation a=out the %u'ins Iai% test i+ the %u'in is current%: authenticated 'et a %istin' o+ a.ai%a=%e +i%es:stems 'et a %ist o+ mounted +i%es:stems mount a +i%es:stem into the Iai% unmount a Iai%ed +i%es:stem 'et a director: %istin' 'et a +i%e 'et -" architecture .eri+: R>C ca%%s are wor)in'
When an R>C reEuest to the =ase s:stem ta)es %aceD the +o%%owin' thin's ha enK 1. An R>C reEuest is =ui%t in the +orm $ase*!rl T U73l!gins7Dson-r3'7#1V 2. <he R>C reEuest is si'ned with the -Auth credentia%s. 3. <he R>C reEuest is sent with the reEuested method. &. <he method is in.o)ed i+ the -Auth credentia%s are correct and the method e6ists. <he resu%ts are then returned =ac) to the %u'in. *. <he $astC3I ser.er acce ts the %u'in reEuestD then dis atches accordin'%:. <his a%%ows an:thin' that can communicate with the $astC3I rotoco% to =e a %u'in or to mana'e %u'ins. #ecause o+ this +%e6i=i%it:D %u'ins can =e de.e%o ed usin' an: %an'ua'e or +ramewor). In order FreeNAS 9.1.1 Users Guide Page 2"7 of 276
+or a $reeNA"1 %u'in to wor)D it must im %ement the descri=ed methods and =e ac)a'ed usin' the >#I +ormat. <he $astC3I ser.er must res ond to a series o+ !R9s in order to inte'rate with the $reeNA"1 3!I. A%% the !R9s wi%% =e re+i6ed =: 73l!gins7W3l!gin*nameB7W3l!gin*idB7 where 3l!gin*name is the name o+ the %u'in stored in $reeNA"1 data=ase and 3l!gin*id the I( +or this %u'in. 73l!gins7W3l!gin*nameB7W3l!gin*idB7*s7 is the names ace reser.ed +or the A>I and it uses the end oints descri=ed in <a=%e 10./e. 5ach end oint returns a C"-N dictionar: as a res onse with its own attri=utes. )a'le 11.7e: API :nd!oints and 2es!onse Attri'utes :nd!oint Na3e :nd!oint 6escri!tion Attri'ute )*!e Na3e error messa'e 35< @ %u'ins@W %u'inGnameV@ used to sto the W %u'inGidV@Gs@sto ser.ice daemon error messa'e =oo%ean strin' =oo%ean strin' 2eCuiredT reEuired o tiona% reEuired o tiona% Attri'ute 6escri!tion did the ser.ice start encounter an errorU the error messa'e did the ser.ice sto encounter an errorU the error messa'e status o+ the ser.ice as one o+K "<AR<IN3D R!NNIN3D "<->>IN3D or "<->>5( rocess I( o+ the ser.iceD nu%% i+ does not e6ist name dis %a:ed in the tree menu where the node shou%d =e a ended in the tree menuD such as Page 2"( of 276
35< @ %u'ins@W %u'inGnameV@ used to start the W %u'inGidV@Gs@start ser.ice daemon
used to return the 35< @ %u'ins@W %u'inGnameV@ rocess status o+ W %u'inGidV@Gs@status the ser.ice
status
strin'
reEuired
id returns a C"-N arra: descri=in' 35< @ %u'ins@W %u'inGnameV@ e%ements that name W %u'inGidV@Gs@treemenu shou%d =e a ended to the tree menu
inte'er
reEuired
strin'
reEuired
a endGto strin'
reEuired
:nd!oint Na3e
:nd!oint 6escri!tion
Attri'ute )*!e Na3e icon t: e ur% strin' strin' strin'
2eCuiredT
o tiona% reEuired reEuired
chi%dren
arra:
o tiona%
Attri'ute 6escri!tion 3l!gins or Dails !R9 to the tree node icon node t: eD current%: must =e 3l!ginsf'gi !R9 to o en when c%ic)ed recursi.e descri=e o+ this structure descri=in' chi%dren o+ this tree node
>%u'ins ma: communicate with $reeNA"1 usin' a C"-N R>C inter+ace. <his inter+ace is %ocated at 73l!gins7Dson-r3'7#17 and the authentication is done usin' -Auth2. -ne )e: method e6 osed in this inter+ace is 3l!gins.is*a!thenti'ated which reEuires the sessionid coo)ie to ma)e sure that the user has ri'hts to er+orm an action. 11.7.# Using :as*P5I to &reate a FreeNAS P5I
A >#I needs some additiona% +i%es in order to inte'rate it into the $reeNA"1 'ra hica% administrati.e inter+aceK the 6B2*=L6+&AAFA.&@ .aria=%e in 3$i.'onf needs to =e set to a s eci+ic .a%ue. t<eak-r''onf needs to =e added to the modu%e. 'ontrol needs to =e created and added to the modu%e. Creatin' this +i%e and the inter+ace +i%es that it ca%%s reEuires ro'rammin' )now%ed'e. <his section descri=es how to achie.e these chan'es within 5as:>#I and uses the +ire+%: >#I as an e6am %e. As :ou read throu'h the e6am %eD re+er to the >C;#"( >#I modu%e and com are it with the $reeNA" >#I modu%e.
18.(.!.1 +dit pbi.conf
$i'ure 10./a shows the 5as:>#I inter+ace. <he user has c%ic)ed the NNewN =utton and =rowsed to the %ocation o+ the +ire+%: $ree#"( ort. C%ic)in' N-KN wi%% %oad the de+au%t settin's +or this modu%e +rom the $ree#"( ort.
Page 2"9 of 276
Figure 11.7a: <oading t e Firefl* 4odule in :as*P5I
I+ :ou com are the 3$i.'onf +i%e +or the e6istin' >C;#"( and $reeNA"1 >#IsD :ou wi%% see that the $reeNA"1 .ersion contains this %ine Adi++erences hi'h%i'hted in redBK
PBI_MKPORTAFTER="www/py-django devel/py-jsonrpclib databases/py-south databases/pysqlite3 www/py-dojango www/py-flup net/py-oauth2"
It is im ortant to add these orts to the >#I =ui%d as the: are needed to ro er%: inte'rate the a %ication into the $reeNA"1 3!I. <o do soD c%ic) the N[N =utton ne6t to NMa)e >ort A+terND shown in $i'ure 10./=D and add each ort in the a=o.e %istin' one at a time. Fou can Euic)%: na.i'ate to the ort i+ :ou start to t: e in its cate'or: and ort name.
Page 2#1 of 276
Figure 11.7': Adding t e 2eCuired Ports
N9):: the de endencies %isted here assume that the >#I wi%% =e =ui%t usin' the >:thon $astC3I inter+ace. I+ :ou are usin' a di++erent $astC3I inter+aceD di++erent de endencies are reEuired. <he =i.con+ +or minid%na shows the de endencies when usin' the >H> $astC3I inter+ace. When :ou are +inishedD c%ic) the N"a.e Con+i'urationN =utton. #e sure to do this =e+ore %ea.in' this screen or :our se%ections wi%% =e %ost.
18.(.!.2 Add tweak-rcconf
Ne6tD create the +o%%owin' +i%e and sa.e it as t<eak-r''onf. <his +i%e a%wa:s uses the same contentsD e6ce t that the name o+ the >#I Ashown in redB needs to =e chan'ed to match the name o+ the >#I =ein' 'enerated. $or an e6am %eD com are this +i%e +or the +ire+%: >#I and +or the minid%na >#I.
Page 2#1 of 276
#!/bin/sh firefly_path=/usr/pbi/firefly-$(uname -m) tmpfile=$(mktemp /tmp/.XXXXXX) grep -v 'firefly_' /etc/rc.conf > ${tmpfile} cat ${firefly_path}/etc/rc.conf >> ${tmpfile} mv ${tmpfile} /etc/rc.conf
A+ter sa.in' this +i%eD c%ic) the Resources ta=D shown in $i'ure 10./cD then c%ic) the N[ Add $i%eN =utton and =rowse to the %ocation o+ the sa.ed +i%e. Figure 11.7c: Add t e t-ea0&rcco%* File to t e 4odule
18.(.!.3 Create control
A $reeNA"1 >#I uses a 'ontrol +i%e to inte'rate the >#I into the $reeNA"1 'ra hica% inter+ace. <he $reeNA"1 3!I communicates with $reeNA"1 >#Is usin' $astC3I. "ince the ro%e o+ the 'ontrol +i%e is to start a $astC3I ser.er on a s eci+ied I> address and ortD this +i%e ta)es 3 ar'umentsK an action .er=D an I> addressD and a ort. FreeNAS 9.1.1 Users Guide Page 2#2 of 276
<he .er=s that must =e im %emented are startD sto3 and stat!s. <he start .er= starts the $astC3I ser.er on the I>@ ort com=ination. <he sto3 .er= sto s the ser.er. <he stat!s .er= e6its with 0 i+ the ser.er is runnin'M otherwiseD it e6its with 1. <he $astC3I A>I su orts man: ro'rammin' %an'ua'e =indin'sD inc%udin' >:thon and >H>. "ince this +i%e is mandator:D 'ontrol is t: ica%%: a wra er scri t that oints to additiona% +i%es which actua%%: im %ement the inter+ace ortion o+ the >#I. <he Io= o+ the inter+ace is to e6 ort the methods %isted in <a=%e 10./c in order to inte'rate with the $reeNA"1 we= inter+ace. When creatin' the inter+ace ortion o+ the >#ID the start and sto3 methods must ro.ide a means to start and sto the a %ication used =: the >#I as we%% as an: reEuired modi+ications to 7et'7r'.'onf. <he treemen! method dum s out C"-N. <he treemen!-i'on method out uts the %u'in icon. <he edit method ro.ides the 'ra hica% inter+ace +or con+i'urin' the insta%%ed >#I. <his 'enera%%: entai%s sa.in' and restorin' state and 'eneratin' and modi+:in' con+i'uration +i%es. 56am %es o+ $reeNA"1 >#Is that use W"3ID the >:thon $astC3I inter+aceD inc%ude +ire+%: and transmission. <he 'ontrol +i%e +or these two >#Is is identica%D e6ce t +or the name o+ the >#I itse%+. <he freenas +i%e is is not used at this time and can =e i'nored. <he rest o+ the +i%es in the reso!r'es director: +or each >#ID inc%udin' 'ontrol.3yD ro.ide wor)in' ro'rammatic e6am %es. $or each >#ID com are the contents o+ these +i%es to the resu%tin' $reeNA"1 screens shown in -++icia% $reeNA"1 >#Is. When re.iewin' the 'ontrol.3y +i%eD remem=er that it is res onsi=%e +or startin'D sto in'D and re ortin' the status o+ the $astC3I ser.er. <he start and sto3 methods a%so start and sto the dIan'o we= ser.er a %ication which e6 orts a%% the reEuired hoo)s that $reeNA"1 reEuires to inter+ace with the >#I. <he !I su=director: Ae.'. reso!r'es7firefly12B contains the t: ica% dIan'o mode%D +ormD .iewD and ur% +i%es. In the !rls.3y +i%eD the e6 orted methods that $reeNA"1 reEuires are .isi=%e and demonstrate what needs to =e made a.ai%a=%e +or a $reeNA"1 >#I to =e +unctiona%. <he minid%na >#I ro.ides a wor)in' e6am %e o+ a >#I that is created usin' h ;+ mD the >H> $astC3I inter+ace. When usin' this inter+aceD the 6B2*=L6+&AAFA.&@ in 3$i.'onf needs to %oad di++erent de endenciesD usin' the instructions in 5dit =i.con+. -nce :ou ha.e +inished creatin' the necessar: +i%esD use the N[Add $i%eN =utton in the Resources ta= o+ 5as:>#I to add each o+ the +i%es that :ou ha.e created. Fou are now read: to tr: =ui%din' and testin' the >#I.
18.(.!.! Build and Test the 0BI
<o =ui%d the >#ID c%ic) N>#I #ui%derN and then the N#ui%d >#IN =utton. A o ;u messa'e wi%% remind :ou that a wor)in' Internet connection is reEuired so that the =ui%d rocess can down%oad the source reEuired to =ui%d the ort. It wi%% a%so rom t +or the root assword. As seen in $i'ure 10./dD the com i%e messa'es wi%% =e dis %a:ed as the modu%e is =ui%t. <he +irst time :ou =ui%d a >#ID 5as:>#I wi%% down%oad the chroot en.ironment used to =ui%d >#Is. "u=seEuent =ui%ds wi%% reuse this en.ironment. <he =ui%d rocess itse%+ ma: ta)e some timeD de endin' u on the si8e o+ the ort se%ected and the s eed o+ :our com uter. #ui%d messa'es wi%% =e dis %a:ed in the white window. 5as:>#I wi%% in+orm :ou when the >#I =ui%d is +inishedD and whether it was success+u% or not. I+ the =ui%d +ai%sD :ou ma: need to modi+: the modu%e usin' NModu%e 5ditorN. C%ic) the N"a.e #ui%d 9o'N =utton and =rowse to the %ocation to sa.e the %o' +i%e which can =e read with an: A"CII te6t FreeNAS 9.1.1 Users Guide Page 2#" of 276
editor. Read the sa.ed %o' to determine the error so that :ou can modi+: the modu%e as needed. I+ :ou are unsure how to +i6 the >#I modu%eD create a +orum ost that inc%udes Iust the error ortion o+ the %o'. -nce the >#I success+u%%: =ui%dsD tr: to insta%% it into :our $reeNA"1 s:stem. In the screen shown in $i'ure 9.1aD c%ic) the ! %oad =utton then =rowse to the %ocation o+ the 'enerated >#I +i%e. It wi%% =e %ocated in the .asy6B276B2 director: o+ the home director: on the =ui%d s:stem and wi%% end in a .3$i e6tension. I+ success+u%D the >#I shou%d show in the >%u'ins +o%der in the tree ortion o+ the $reeNA"1 inter+ace. I+ it does notD chec) the resource +i%es that :ou created +or errors. I+ :ou cannot +ind what is causin' the errorD u %oad :our resource +i%es and re+er to them in a +orum ost. I+ :ou do not ha.e a %ocation to host :our resource +i%esD aste them to a site such as aste=in. I+ the >#I success+u%%: insta%%sD chec) its con+i'uration screen in the $reeNA"1 3!I contains a%% o+ the +ie%ds that :ou intended. -nce :ou are satis+ied with the >#ID u date the >#I ReEuests a'e and create a +orum ost so that other $reeNA"1 users can test the >#I. -nce the >#I is we%% testedD it can =e added to the >#I re ositor:. Figure 11.7d: 5uilding t e P5I
Page 2## of 276
11 Additional 9!tions
<his section co.ers the remainin' misce%%aneous o tions a.ai%a=%e +rom the $reeNA"1 'ra hica% administrati.e inter+ace.
11.1 6is!la* S*ste3 Processes

I+ :ou c%ic) (is %a: ":stem >rocessesD a screen wi%% o en showin' the out ut o+ to A1B. An e6am %e is shown in $i'ure 11.1a. Figure 11.1a: S*ste3 Processes 2unning on FreeNAS
<he dis %a: wi%% automatica%%: re+resh itse%+. "im %: c%ic) the 7 in the u er 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 7ill command within it.
11.2 S ell
#e'innin' with .ersion 2.2.0D the $reeNA"1 3!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 11.2aD the %in) has =een c%ic)ed and "he%% is o en. <he rom t indicates that the current user is rootD the hostname is freenasD and the current wor)in' director: is X Aroot's home director:B. <o chan'e the si8e o+ the she%%D c%ic) the ,0(2E dro ;down menu and se%ect a di++erent si8e. FreeNAS 9.1.1 Users Guide Page 2#$ of 276
<o co : te6t +rom she%%D hi'h%i'ht the te6tD 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 te6t into the =o6 that o ensD and c%ic) the -K =utton to com %ete the aste o eration. Figure 11.2a: -e' S ell
Whi%e :ou are in "he%%D :ou wi%% not ha.e access to an: o+ the other 3!I menus. I+ :ou are usin' "he%% +or trou=%eshootin' ur oses and need to %ea.e the "he%% in order to modi+: a con+i'urationD c%ic) the 6 in the window's u er ri'ht corner. <he ne6t 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 re eat 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. N9):: not a%% o+ "he%%'s +eatures render correct%: in Chrome. $ire+o6 is the recommended =rowser +or usin' "he%%. (ue to the em=edded nature o+ $reeNA"1D some $ree#"( com onents are missin' and noticea=%e in "he%%. $or e6am %eD man a'es are not inc%udedM howe.erD $ree#"( man a'es can =e read on%ine. 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.
Page 2#6 of 276
11." 2e'oot
I+ :ou c%ic) Re=ootD :ou wi%% recei.e the warnin' messa'e shown in $i'ure 11.3a and :our =rowser co%or wi%% chan'e to red to indicate that :ou ha.e se%ected an o tion that wi%% ne'ati.e%: im act users o+ the $reeNA"1 s:stem. Figure 11."a: 2e'oot -arning 4essage
N9):: i+ an: .o%umes are encr: tedD ma)e sure that :ou ha.e set the ass hrase and ha.e co ies 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. 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 3!I. <he !R9 in :our we= =rowser wi%% chan'e to add 7system7re$oot7 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 3!I %o'in screen. I+ the %o'in screen does not a earD :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% o eration.
11.# S utdo/n
I+ :ou c%ic) "hutdownD :ou wi%% recei.e the warnin' messa'e shown in $i'ure 11.&a and :our =rowser co%or wi%% chan'e to red to indicate that :ou ha.e se%ected an o tion that wi%% ne'ati.e%: im act users o+ the $reeNA"1 s:stem.
Page 2#7 of 276
Figure 11.#a: S utdo/n -arning 4essage
N9):: i+ an: .o%umes are encr: tedD ma)e sure that :ou ha.e set the ass hrase and ha.e co ies o+ the encr: tion )e: and the %atest reco.er: )e: =e+ore er+ormin' a shutdown. 8itho!t the$e/ )o! -ill %ot be able to !%loc0 the e%cr)"ted 'ol!(e -he% the $)$te( i$ re$tarted. C%ic) the Cance% =utton i+ :ou wish to cance% the shutdown reEuest. -therwiseD c%ic) the "hutdown =utton to ha%t the s:stem. "huttin' down the s:stem wi%% disconnect a%% c%ientsD inc%udin' the we= administration 3!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.
11.$ %el!
<he He% =utton in the u er ri'ht corner ro.ides h: er%in)s to the .arious $reeNA"1 on%ine resourcesD inc%udin'K the communit: +orumD mai%in' %istsD IRC channe%D =u' trac)erD and this documentation. <hese resources are discussed in more detai% in the ne6t section. It a%so dis %a:s the current%: insta%%ed $reeNA"1 .ersion and re.ision num=er.
11.6 <og 9ut

<o %o' out o+ the $reeNA"1 3!ID sim %: c%ic) the 9o' -ut =utton in the u er 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.
Page 2#( of 276
11.7 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. $or e6am %eD the +irst time :ou access the administrati.e 3!ID the a%ert =utton wi%% =e +%ashin'. I+ :ou c%ic) the iconD :ou wi%% see the messa'e shown in $i'ure 11./aK Figure 11.7a: :,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 =o6 ne6t to that messa'e. #ehind the scenesD an a%ert scri t chec)s +or .arious a%ert conditionsD such as .o%ume and dis) statusD and writes the current conditions to 7#ar7tm37alert. A Ia.ascri t 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;o tima% mu%ti ath states !>" -N#A<<@9-W#A<< e.ent 0$" oo% status chan'es +rom H5A9<HF the s:stem is una=%e to =ind to the We=3!I Address set in ":stem S "ettin's S 3enera% 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'edM m+iuti%A2B is inc%uded +or mana'in' these de.ices
Section 3: Getting Help

12 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 FreeNAS 9.1.1 Users Guide Page 2#9 of 276
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 s end 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 "u IRC Mai%in' 9ists >ro+essiona% "u ort ort (ata=ase
12.1 -e'site and Social 4edia

<he $reeNA"1 we=site contains %in)s to a%% o+ the a.ai%a=%e documentationD su 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 3oo'%e[ $ace=oo) <witter ortD and socia% media
12.2 Foru3s
Another in+ormation source +or $reeNA"1 is the $orums. $orums contain user;contri=uted ti s and 'uides which ha.e =een cate'ori8edD ma)in' it an idea% resource i+ :ou wish to %earn more a=out a certain as ect o+ $reeNA"1. A search=ar is inc%uded shou%d :ou wish to search =: )e:wordM a%ternate%:D :ou can c%ic) a cate'or: to =rowse throu'h the threads that e6ist +or that to ic. <he +o%%owin' cate'ories are a.ai%a=%e under %el! and Su!!ort: $reeNA" & N00=sK ost here i+ :ou are new to $reeNA"1 and are unsure which cate'or: =est matches :our Euestion. $eature ReEuestsK +or the discussion o+ u comin' +eatures and to reEuest +eatures not %isted on the Roadma . #u' Re ortin'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 su ort tic)et. HardwareK +or the discussion o+ hardware and ti s +or 'ettin' the most out o+ :our hardware. !ser AuthenticationK 9(A> and Acti.e (irector:. "harin'K A$>D CI$"D N$"D and i"C"I. FreeNAS 9.1.1 Users Guide Page 2$1 of 276
"tora'eK re %icationD sna shotsD .o%umesD and 0$". Networ)in'K networ)in' hardwareD "NM>D ""HD and <$<>. er+ormanceD %in) a''re'ationD 49ANsD ((N"D $<>D
Insta%%ationK insta%%in' he% or ad.ice =e+ore er+ormin' the insta%%ation. >%u'insK ro.ides a discussion area +or creatin' and trou=%eshootin' >#Is. <he +o%%owin' cate'ories are a.ai%a=%e under 6e+elo!3ent: $reeNA"K 'enera% de.e%o ment discussion. nano=sdK the em=edded o eratin' s:stem $reeNA"1 is =ased u on. (Ian'oK the we= +ramewor) used =: the $reeNA"1 'ra hica% administrati.e inter+ace. (oIo <oo%)itK the Ia.ascri t 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 %o/?)o Guides: Hac)in'K undocumented tric)s +or 'ettin' the most out o+ :our $reeNA"1 s:stem. Insta%%ationK s eci+ic insta%%ation scenarios Ahardware and@or so+twareB. Con+i'urationK s eci+ic con+i'uration scenarios Ae.'. so+tware or c%ient con+i'urationB. HardwareK instructions +or settin' u s eci+ic hardware. As new testin' sna shots =ecome a.ai%a=%e and new so+tware .ersions are re%easedD the: are announced in the Announcements +orum. I+ :ou are %oo)in' +or ti s 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: -++;to icK want to discuss somethin' o+ interest to $reeNA"1 users =ut which is not necessari%: re%ated to $reeNA"1U <his is :our %ace. ResourcesK =%o'sD re.iewsD and other sources o+ $reeNA"1 in+ormation not %isted at +reenas.or'. IntroductionsK $reeNA"1 Communit: meet 'n 'reet ; introduce :ourse%+ and %et us )now who we are chattin' with. <he +o%%owin' %an'ua'e;s eci+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 3erman ; (eutsch Ita%ian ; Ita%iano Russian ; deffghi " anish Z 5s ano% FreeNAS 9.1.1 Users Guide Page 2$1 of 276
<ur)ish ; <jr)ke I+ :ou wish to as) a Euestion on the +orumD :ou wi%% need to c%ic) the P"i'n ! NowRQ %in) to create an account and %o'in usin' that account. When as)in' a Euestion on the +orumD it is im ortant 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 NRe %:N %in) at the =ottom o+ the ost to add :our comments to the e6istin' 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 N>ost New <hreadN =utton to o en the editor. A+ter t: in' :our ost and =e+ore :ou c%ic) the NCreate <hreadN =uttonD ma)e sure the NWatch this thread...N =o6 is chec)ed. I+ :ou want to =e noti+ied =: emai%D a%so chec) the Pand recei.e emai% noti+icationsQ =o6. <hat wa: :ou wi%% =e noti+ied whene.er an:one answers :our Euestion.
12." Su!!ort 6ata'ase

I+ :ou encounter a trace=ac) error when usin' $reeNA"1 or sus ect that :ou ha.e +ound a so+tware or documentation =u'D 'o to htt sK@@=u's.+reenas.or'@ roIects@+reenas to see i+ :our issue has a%read: =een re orted. Fou do not need to re'ister in order to search +or e6istin' issues. Howe.erD :ou wi%% need to re'ister i+ :ou wish to comment on an e6istin' issue or create a new su ort 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 e6istin' issue and to ensure that :our re ort contains the in+ormation that the de.e%o ers need in order to im %ement the +i6 or the +eature. As art o+ :our researchD er+orm the +o%%owin' ste sK (etermine i+ :ou are runnin' the %atest re%ease o+ $reeNA"1. $reeNA"1 de.e%o ers tend to +i6 =u's ra id%: 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 +i6ed 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: e6ists. I+ one doesD do not create a new issue. InsteadD add a comment to the e6istin' issue i+ :ou ha.e additiona% in+ormation to add. I+ a simi%ar issue does not a%read: e6istD )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 re ortin' a =u' or Feat!re i+ :ou are ma)in' a +eature reEuest. 3. In the "u=Iect +ie%dD inc%ude descri ti.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 (escri tion sectionD descri=e the ro=%emD how to recreate itD and inc%ude the te6t 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 e6am %es o+ other roducts that use that +eature or the !R9 o+ the FreeNAS 9.1.1 Users Guide Page 2$2 of 276
home a'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 ne6t 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%o ers 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.
12.# I2&
I+ :ou wish to as) a Euestion in Prea% timeQD :ou can tr: the Qfreenas channe% on IRC $reenode. (e endin' u on the time o+ da: and :our time 8oneD a $reeNA"1 de.e%o er 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) Ncan an:one he% meUNM insteadD Iust as) :our Euestion. I+ someone )nows the 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 disa ear. (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 su ort 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.
12.$ 4ailing <ists

"e.era% $reeNA"1 mai%in' %ists are a.ai%a=%e which a%%ow users and de.e%o ers to as) and answer Euestions re%ated to the to ic o+ the mai%in' %ist. <o ost an emai% to a %istD :ou wi%% need to su=scri=e to it +irst. 5ach 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;announceK this is a %ow;.o%umeD read;on%: %ist where maIor mi%estonesD such as new re%easesD are announced. FreeNAS 9.1.1 Users Guide Page 2$" of 276
+reenas;commitK this is a read;on%: %ist. As code chan'es in the $reeNA"1 re ositor:D the commit messa'e is automatica%%: sent to this %ist. +reenas;de.e%K $reeNA"1 de.e%o ers are su=scri=ed to this %ist. <echnica% Euestions a=out the current $reeNA"1 re%ease can =e osted here. +reenas;docsK this %ist is +or discussion re'ardin' $reeNA"1 documentation. +reenas;testin'K $reeNA"1 de.e%o ers are su=scri=ed to this %ist. <echnica% Euestions a=out the u comin' $reeNA"1 re%ease and +eed=ac) on testin' sna shots can =e osted here. +reenas;trans%ationsK this %ist is +or discussion re'ardin' $reeNA"1 %oca%i8ation and trans%atin' $reeNA"1 documentation. Archi.es o+ the mai%in' %ists are a.ai%a=%e +rom 3mane which a%%ows :ou to read the archi.es in .arious +ormats A=%o' st:%eD news reader st:%eB and to su=scri=e to R"" +eeds +or the %ists.
12.6 Professional Su!!ort

In addition to the +ree%: a.ai%a=%e communit: resourcesD i7s:stems o++ers ro+essiona% su ort ac)a'es. i7s:stems' de.e%o ment team wor)s hard to im ro.e new and current .ersions o+ $reeNA"1D ro.idin' them with the insi'ht to ro.ide e6 ert $reeNA"1 su ort 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 <rueNA"l "o+tware "u ort a'e to reEuest a Euote.
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' ma6imum <C> and !(> =andwidth er+ormance Net!erf: a too% +or measurin' networ) er+ormance I9=one: +i%es:stem =enchmar) uti%it: used to er+orm a =road +i%es:stem ana%:sis arcstat.!* and arc8su33ar*.!*: used to 'ather 0$" ARC statistics B66: a too% +or measurin' and characteri8in' dis) su=s:stem I@<he +o%%owin' uti%ities are s eci+ic to RAI( contro%%ersK t/8cli: 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 IP4Itool: used to mana'e and con+i'ure I>MI de.ices <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 %e6er simi%ar to 3N! screen Page 2$# of 276
63idecode: re orts in+ormation a=out s:stem hardware as descri=ed in the s:stem's #I-"
1".1 I!erf
I er+ is a uti%it: +or measurin' ma6imum <C> and !(> =andwidth er+ormance. It can =e used to chart networ) throu'h ut o.er time. $or e6am %eD :ou can use it to test the s eed o+ di++erent t: es o+ shares to determine which t: e =est er+orms on :our networ). $reeNA"1 inc%udes the I er+ ser.er. <o er+orm networ) testin'D :ou wi%% need to insta%% an I er+ 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 6I er+ 3!I c%ient as it wor)s on WindowsD Mac -" 7D 9inu6D and #"( s:stems. "ince this c%ient is Ia.a =asedD :ou wi%% a%so need to insta%% the a ro riate CR5 +or the c%ient o eratin' s:stem. 9inu6 and #"( users wi%% need to insta%% the i er+ ac)a'e usin' their o eratin' s:stem's ac)a'e mana'ement s:stem. <o start 6I er+ on WindowsK un8i the down%oaded +i%eD start Command >rom t in Run as administrator modeD cd to the un8i ed +o%derD and run A!erf.'at. <o start 6I er+ on Mac -" 7D 9inu6D or #"(D un8i the down%oaded +i%eD cd to the un8i ed director:D t: e c 3od uV, A!erf.s D and run .FA!erf.s . -nce the c%ient is read:D :ou need to start the I er+ ser.er on $reeNA"1. <o see the a.ai%a=%e ser.er o tionsD o en "he%% and t: eK
iperf --help | more Usage: iperf [-s|-c host] [options] iperf [-h|--help] [-v|--version] 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 -U, --single_udp -D, --daemon Client specific: -b, --bandwidth #[KM] -c, --client <host>
run in server mode run in single threaded UDP mode run the server as a daemon
for UDP, bandwidth to send at in bits/sec (default 1 Mbit/sec, implies -u) run in client mode, connecting to <host>
Page 2$$ of 276
-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 megaThe 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 e6am %eD to er+orm a <C> test and start the ser.er in daemon mode Aso that :ou 'et :our rom t =ac)BD t: eK
iperf -sD -----------------------------------------------------------Server listening on TCP port 5001 TCP window size: 64.0 KByte (default) -----------------------------------------------------------Running Iperf Server as a daemon The Iperf daemon process ID: 4842
N9):: 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 i er+ rocess. $rom :our des)to D o en the c%ient. In ut the I> o+ address o+ the $reeNA"1 s:stemD s eci+: the runnin' time +or the test under A %ication %a:er o tions S <ransmit Athe de+au%t test time is 10 secondsBD and c%ic) the Run I er+R =utton. $i'ure 13.1a shown an e6am %e o+ the c%ient runnin' on a Windows s:stem whi%e an "$<> trans+er is occurrin' on the networ).
Page 2$6 of 276
Figure 1".1a: @ie/ing 5and/idt Statistics Using ,A!erf
(e endin' u on 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 i er+ ser.er in !(> modeD use i!erf ?s6u as the u s eci+ies !(>M 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
sockstat USER root root www www www root root root root root root root root -4 | more COMMAND iperf iperf nginx nginx nginx sshd python mountd mountd rpcbind rpcbind rpcbind nginx PID 4870 4842 4827 4827 4827 3852 2503 2363 2363 2359 2359 2359 2044 FD 6 6 3 5 7 5 5 7 8 9 10 11 7 PROTO udp4 tcp4 tcp4 tcp4 tcp4 tcp4 udp4 udp4 tcp4 udp4 udp4 tcp4 tcp4 LOCAL ADDRESS *:5001 *:5001 127.0.0.1:15956 192.168.2.11:80 *:80 *:22 *:* *:812 *:812 *:111 *:886 *:111 *:80 FOREIGN ADDRESS *:* *:* 127.0.0.1:9042 192.168.2.26:56964 *:* *:* *:* *:* *:* *:* *:* *:* *:*
Page 2$7 of 276
root root root root root root root
python python python ntpd ntpd ntpd syslogd
2029 2029 2029 1548 1548 1548 1089
3 4 7 20 22 25 6
udp4 tcp4 tcp4 udp4 udp4 udp4 udp4
*:* 127.0.0.1:9042 127.0.0.1:9042 *:123 192.168.2.11:123 127.0.0.1:123 127.0.0.1:514
*:* *:* 127.0.0.1:15956 *:* *:* *:* *:*
When :ou are +inished testin'D either t: e 7illall i!erf or c%ose "he%% to terminate the i er+ ser.er rocess.
1".2 Net!erf
Net er+ is a =enchmar)in' uti%it: that can =e used to measure the er+ormance o+ unidirectiona% throu'h ut 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 o tions +or er+ormin' tests with the net!erf command. <he Net er+ Manua% descri=es each o tion in more detai% and e6 %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 inter ret :our resu%ts. When :ou are +inished with :our testsD t: e 7illall 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
Page 2$( of 276
-S -t -T -v -W -v -V
testname lcpu,rcpu verbosity send,recv level
Set SO_KEEPALIVE on the data connection Specify test to perform Request netperf/netserver be bound to local/remote cpu Specify the verbosity level Set the number of send,recv buffers Set the verbosity level (default 1, min 0) 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"." I9=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' o erationsK readD writeD re;readD re;writeD read =ac)wardsD read stridedD +readD +writeD random readD readD mma D aioGreadD and aioGwrite. $reeNA"1 shi s 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 tem orar: +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 inter ret :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 inter ret the resu%tsK How <o Measure 9inu6 $i%es:stem I@- >er+ormance With io8one Ana%:8in' N$" C%ient >er+ormance with I-8one 10 io8one 56am %es +or (is) I@- >er+ormance Measurement on 9inu6 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]
Page 2$9 of 276
-a -A -b -B -c -C -d -D -e -E -f -F -g -G -h -H -i
-I -j -J -k -K -l -L -m -M -n -N -o -O -p -P -q -Q -r
-R -s
-S -t -T -u -U -v -V -w -W -x
[-+C percent_dedup_within] Auto mode Auto2 mode Filename Create Excel worksheet file Use mmap() files Include close in the timing calculations Show bytes transferred by each child in throughput testing # Microsecond delay out of barrier Use msync(MS_ASYNC) on mmap files Include flush (fsync,fflush) in the timing calculations Run extension tests filename to use filenames for each process/thread in throughput test # Set maximum file size (in Kbytes) for auto mode (or #m or #g) Use msync(MS_SYNC) on mmap files help # Use POSIX async I/O with # async operations # 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) Use VxFS VX_DIRECT, O_DIRECT,or O_DIRECTIO for all file operations # Set stride of file accesses to (# * record size) # milliseconds of compute cycle before each I/O operation # Use POSIX async I/O (no bcopy) with # async operations Create jitter in the access pattern for readers # Lower limit on number of processes to run # Set processor cache line size to value (in bytes) Use multiple buffers Report uname -a output # Set minimum file size (in Kbytes) for auto mode (or #m or #g) Report results in microseconds per operation Writes are synch (O_SYNC) Give results in ops/sec. Purge on # Bind processes/threads to processors, starting with this cpu # Set maximum record size (in Kbytes) for auto mode (or #m or #g) Create offset/latency files # record size in Kb or -r #k .. size in Kb or -r #m .. size in Mb or -r #g .. size in Gb Generate Excel report # file size in Kb or -s #k .. size in Kb or -s #m .. size in Mb or -s #g .. size in Gb # Set processor cache size to value (in Kbytes) # Number of threads or processes to use in throughput test Use POSIX pthreads for throughput tests # Upper limit on number of processes to run Mount point to remount between tests version information # Verify data pattern write/read Do not unlink temporary file Lock file when reading or writing Turn off stone-walling
Page 261 of 276
-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+ o tionsD I-8one is com rehensi.e and it ma: ta)e some time to %earn how to use the tests e++ecti.e%:. N9):: i+ :ou re+er to .isua%i8e the co%%ected dataD scri ts are a.ai%a=%e to render I-8one's out ut in 3nu %ot.
1".# arcstat
Arcstat is a scri t that rints out 0$" ARC statistics. -ri'ina%%: it was a er% scri t created =: "un. <hat er% scri t was orted to $ree#"( and was then orted as a >:thon scri t +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 e6 ect a miss and FreeNAS 9.1.1 Users Guide Page 261 of 276
ha.in' to 'o to dis) to +etch the data. $or cached readsD e6 ect 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' 3uide 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: de endin' u on 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' de ends u on the amount o+ memor: and the t: e o+ wor)%oadD as seen in these two e6am %esK !nderstandin' 0$"K >re+etch 0$" re+etch a%'orithm can cause er+ormance draw=ac)s
1".#.1
Using t e Scri!ts
$reeNA"1 ro.ides two command %ine scri tsK arc8su33ar*.!*: used to watch the statistics in rea% time arcstat.!*: ro.ides a summar: o+ the statistics $or nowD these scri ts can =e manua%%: run +rom "he%%. $uture $reeNA"1 .ersions wi%% automatica%%: inte'rate their resu%ts into a ":stem S Re ortin' 'ra h. <he ad.anta'e o+ these scri ts is that the: can =e used to ro.ide rea% time Ari'ht nowB in+ormationD whereas the current 3!I re ortin' mechanism is desi'ned to on%: ro.ide 'ra hs charted o.er time. <his +orum ost demonstrates some e6am %es o+ usin' these scri ts with hints on how to inter ret 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
Page 262 of 276
<o .iew ARC statistics in rea% timeD s eci+: 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 06:19:03 0 06:19:04 0 06:19:05 0 06:19:06 0 06:19:07 0 miss 0 0 0 0 0 miss% 0 0 0 0 0 dmis 0 0 0 0 0 dm% 0 0 0 0 0 pmis 0 0 0 0 0 pm% 0 0 0 0 0 mmis 0 0 0 0 0 mm% 0 0 0 0 0 arcsz 425K 425K 425K 425K 425K c 6.6G 6.6G 6.6G 6.6G 6.6G
<his command ro.ides a =rie+ descri tion o+ the +ie%ds in the out utK
arcstat.py -v Usage: arcstat [-hvx] [-f fields] [-o file] [-s string] [interval [count]] Field definitions are as follows: l2bytes: bytes read per second from the L2ARC l2hits: L2ARC hits per second read: Total ARC accesses per second dmis: Demand Data misses per second mru: MRU List hits per second dread: Demand data accesses per second mread: Metadata accesses per second c: ARC Target Size ph%: Prefetch hits percentage l2hit%: L2ARC access hit percentage pm%: Prefetch miss percentage mfu: MFU List hits per second mm%: Metadata miss percentage pread: Prefetch accesses per second miss: ARC misses per second mrug: MRU Ghost List hits per second dhit: Demand Data hits per second mfug: MFU Ghost List hits per second hits: ARC reads per second dm%: Demand Data miss percentage miss%: ARC miss percentage mhit: Metadata hits per second dh%: Demand Data hit percentage mh%: Metadata hit percentage pmis: Prefetch misses per second l2miss%: L2ARC access miss percentage l2miss: L2ARC misses per second mmis: Metadata misses per second phit: Prefetch hits per second hit%: ARC Hit percentage eskip: evict_skip per second arcsz: ARC Size time: Time l2read: Total L2ARC accesses per second l2size: Size of the L2ARC mtxmis: mutex_miss per second rmis: recycle_miss per second
Page 26" of 276
<o recei.e a summar: o+ the ARC data co%%ectedK

arc_summary.py |more System Memory: 1.57% 123.20 MiB Active, 2.45% 192.06 MiB Wired, 95.23% 7.28 GiB Free, Real Installed: Real Available: Real Managed: Logical Total: Logical Used: Logical Free: Kernel Memory: Data: Text: Kernel Memory Map: Size: Free: ARC Summary: (HEALTHY) Storage pool Version: Filesystem Version: Memory Throttle Count: ARC Misc: Deleted: Recycle Misses: Mutex Misses: Evict Skips: ARC Size: Target Size: (Adaptive) Min Size (Hard Limit): Max Size (High Water): ARC Size Breakdown: Recently Used Cache Size: Frequently Used Cache Size: ARC Hash Breakdown: Elements Max: Elements Current: Collisions: Chain Max: Chains: ARC Efficiency: Cache Hit Ratio: Cache Miss Ratio: Actual Hit Ratio: Data Demand Efficiency: CACHE HITS BY CACHE LIST: Most Recently Used: Most Frequently Used: Most Recently Used Ghost: Most Frequently Used Ghost: CACHE HITS BY DATA TYPE: Demand Data: Prefetch Data: Demand Metadata: Prefetch Metadata: CACHE MISSES BY DATA TYPE:
0.73% 0.01% 0.01% 98.73% 96.84% 8.24% 91.76% 83.48% 16.52% 0.34% 99.66%
56.90 868.00 516.00 8.00 7.90 7.65 8.00 675.13 7.34 86.86 72.51 14.35 7.65 26.43 7.62 15 4 0
MiB Inact KiB Cache KiB Gap GiB GiB GiB GiB MiB GiB MiB MiB MiB GiB MiB GiB
25 0 0 0 0.01% 425.66 KiB 100.00% 6.65 GiB 12.50% 851.08 MiB 8:1 6.65 GiB 50.00% 50.00% 3.32 3.32 GiB GiB
46 100.00% 46 0 0 0 581 96.39% 560 3.61% 21 96.39% 560 100.00% 4 23.04% 76.96% 2.14% 1.61% 0.71% 0.00% 99.29% 0.00% 129 431 12 9 4 0 556 0
Page 26# of 276
Demand Data: 0.00% Prefetch Data: 0.00% Demand Metadata: 100.00% Prefetch Metadata: 0.00% File-Level Prefetch: (HEALTHY) DMU Efficiency: Hit Ratio: 98.63% Miss Ratio: 1.37% Colinear: Hit Ratio: 0.00% Miss Ratio: 100.00% Stride: Hit Ratio: 100.00% 2.24k Miss Ratio: 0.00% DMU Misc: Reclaim: Successes: 0.00% Failures: 100.00% Streams: +Resets: 0.00% -Resets: 100.00% Bogus: VDEV Cache Summary: Hit Ratio: 90.48% Miss Ratio: 9.52% Delegations: 0.00% ZFS Tunable (sysctl): kern.maxusers vm.kmem_size vm.kmem_size_scale vm.kmem_size_min vm.kmem_size_max vfs.zfs.l2c_only_size vfs.zfs.mfu_ghost_data_lsize vfs.zfs.mfu_ghost_metadata_lsize vfs.zfs.mfu_ghost_size vfs.zfs.mfu_data_lsize vfs.zfs.mfu_metadata_lsize vfs.zfs.mfu_size vfs.zfs.mru_ghost_data_lsize vfs.zfs.mru_ghost_metadata_lsize vfs.zfs.mru_ghost_size vfs.zfs.mru_data_lsize vfs.zfs.mru_metadata_lsize vfs.zfs.mru_size vfs.zfs.anon_data_lsize vfs.zfs.anon_metadata_lsize vfs.zfs.anon_size vfs.zfs.l2arc_norw vfs.zfs.l2arc_feed_again vfs.zfs.l2arc_noprefetch vfs.zfs.l2arc_feed_min_ms vfs.zfs.l2arc_feed_secs vfs.zfs.l2arc_headroom vfs.zfs.l2arc_write_boost vfs.zfs.l2arc_write_max vfs.zfs.arc_meta_limit
0 0 21 0 2.27k 2.24k 31 31 0 31 2.24k 0 31 0 31 1 0 1 0 21 19 2 0 384 8213114880 1 0 329853485875 0 0 0 0 2048 37888 39936 0 512 512 3584 184832 323584 0 0 0 1 1 0 200 1 2 8388608 8388608 1784843264
Page 26$ of 276
vfs.zfs.arc_meta_used vfs.zfs.mdcomp_disable vfs.zfs.arc_min vfs.zfs.arc_max vfs.zfs.zfetch.array_rd_sz vfs.zfs.zfetch.block_cap vfs.zfs.zfetch.min_sec_reap vfs.zfs.zfetch.max_streams vfs.zfs.prefetch_disable vfs.zfs.check_hostid vfs.zfs.recover vfs.zfs.txg.write_limit_override vfs.zfs.txg.synctime vfs.zfs.txg.timeout vfs.zfs.scrub_limit vfs.zfs.vdev.cache.bshift vfs.zfs.vdev.cache.size vfs.zfs.vdev.cache.max vfs.zfs.vdev.aggregation_limit vfs.zfs.vdev.ramp_rate vfs.zfs.vdev.time_shift vfs.zfs.vdev.min_pending vfs.zfs.vdev.max_pending vfs.zfs.cache_flush_disable vfs.zfs.zil_disable vfs.zfs.zio.use_uma vfs.zfs.version.zpl vfs.zfs.version.spa vfs.zfs.version.dmu_backup_stream vfs.zfs.version.dmu_backup_header vfs.zfs.version.acl vfs.zfs.debug vfs.zfs.super_owner
430248 0 892421632 7139373056 1048576 256 2 8 0 1 0 0 5 30 10 16 10485760 16384 131072 2 6 4 10 0 0 0 4 15 1 2 1 0 0
When readin' the tuna=%e .a%uesD 0 means noD 1 t: ica%%: means :esD and an: other num=er re resents a .a%ue. <o recei.e a =rie+ descri tion o+ a s*sctl .a%ueD use s*sctl ?d. $or e6am %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!%able@$ '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 e6am %es o+ =ene+icia% .a%ues that match :our wor)%oad. 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 e6am %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
Page 266 of 276
<he out ut 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".$ B66
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 e6am %es. <: e the name o+ the command without an: o tions 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# -queuedepth #cmds -qthreadinfo -randomize [target <target#>] -readafterwrite [target #] trigger <stat|mp> |lag <#> | reader <hostname>|port <#> -reallyverbose -recreatefiles [target <target#>] -reopen [target <target#>]
Page 267 of 276
-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 e6am %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 e6istin' tar'et +i%esD 7mnt7tank7B2/F2-.1 and 7mnt7tank7B2/F2-.2. It starts at the =e'innin' o+ each +i%e usin' a +i6ed reEuest si8e o+ 122 =%oc)s with *12 =:tes er =%oc) unti% it has read 20&2 M#D at which time it wi%% end the current ass and roceed to the ne6t 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 o erations on a s eci+ied dis). Re %ace 7de#7ada0 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 e6am %eD in a writa=%e %ocation Ae.'. .o%ume or datasetB create a (dd.set!3 +i%e containin' this %ineK
reqsize 128 -mbytes 64 passes 3 verbose
Page 26( of 276
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 s eci+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 +i6ed reEuest si8e o+ 2 =%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 re roduci=%e resu%ts. In +actD u on 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 o tion which 'enerates a new set o+ %ocations +or each ass. <he random %ocations ma: =e chan'ed +rom run to run usin' the J$ee0 seed o tion to s eci+: a di++erent random num=er 'eneration seed .a%ue +or each in.ocation o+ ,dd.
1".6 t/8cli
$reeNA"1 inc%udes the t/8cli 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 su orted 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 e6am %es. I+ :ou t: e t/8cli in "he%%D the rom t 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 s eci+: one command to run. $or e6am %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 p9 OK u0 931.51 GB SAS /c0/e0/slt1 SEAGATE ST31000640SS p10 OK u0 931.51 GB SAS /c0/e0/slt2 SEAGATE ST31000640SS p11 OK u0 931.51 GB SAS /c0/e0/slt3 SEAGATE ST31000640SS p12 OK u0 931.51 GB SAS /c0/e0/slt4 SEAGATE ST31000640SS p13 OK u0 931.51 GB SAS /c0/e0/slt5 SEAGATE ST31000640SS p14 OK u0 931.51 GB SAS /c0/e0/slt6 SEAGATE ST31000640SS p15 OK u0 931.51 GB SAS /c0/e0/slt7 SEAGATE ST31000640SS p16 OK u1 931.51 GB SAS /c0/e0/slt8 SEAGATE ST31000640SS p17 OK u2 931.51 GB SATA /c0/e0/slt9 ST31000340NS p18 OK u2 931.51 GB SATA /c0/e0/slt10 ST31000340NS p19 OK u2 931.51 GB SATA /c0/e0/slt11 ST31000340NS
Page 269 of 276
p20 OK u2 931.51 GB SATA /c0/e0/slt15 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 00:01:24] INFO Verify started: unit=2,subunit=1 c0 [Sat Mar 03 2012 04:04:27] INFO Verify completed: unit=2,subunit=0 c0 [Sat Mar 03 2012 04:06:25] INFO Verify completed: unit=2,subunit=1 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 00:01:30] INFO Verify started: unit=2,subunit=0 c0 [Sat Mar 10 2012 00:01:30] INFO Verify started: unit=2,subunit=1 c0 [Sat Mar 10 2012 05:06:38] INFO Verify completed: unit=2,subunit=0 c0 [Sat Mar 10 2012 05:08:57] INFO Verify completed: unit=2,subunit=1 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 3!ID tr: runnin' the +o%%owin' commandK
tw_cli /c0 rescan
!se the dri.es to create units and e6 ort them to the o eratin' s:stem. When +inishedD run ca3control rescan all and the: shou%d now =e a.ai%a=%e in the $reeNA"1 3!I.
1".7 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%A2B 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 %e6 with se.era% do8en o tions. Whi%e it is +u%%: documented in this &&2 a'e >($D the commands demonstrated in the 5mer'enc: Cheat "heet can 'et :ou started.
Page 271 of 276
1".( IP4Itool
I>MItoo% ro.ides a command %ine inter+ace to the #ase=oard Mana'ement Contro%%er A#MCB +ound in I>MI de.ices. An I>MI de.ice ro.ides side;=and mana'ement shou%d the $reeNA"1 s:stem =ecome una.ai%a=%e throu'h the 'ra hica% administrati.e inter+ace. <his a%%ows +or a +ew .ita% +unctionsD such as chec)in' the %o'D accessin' the #I-" setu D and owerin' on the s:stem without reEuirin' h:sica% access to the s:stem. #e+ore usin' the i!3itool commandD ensure that the I>MI mana'ement inter+ace is connected to the networ). <he i!3itool wi%% +ai% i+ the s:stem does not reco'ni8e that a #MC is insta%%ed. Fou ma: need to +irst %oad the i!3i )erne% modu%e +rom "he%% =: t: in'K
kldload ipmi
Fou can add a tuna=%e to automatica%%: %oad the i3mi dri.er on s:stem startu . <o see a%% o+ the o tions and commandsD re+er to i mitoo%A1B. I#M has an e6ce%%ent document that ro.ides an o.er.iew o+ I>MI and how to 'et the most out o+ I>MItoo%s.
1".9 freenas?de'ug
<he $reeNA"1 3!I ro.ides an o tion to sa.e de=u''in' in+ormation to a te6t +i%e usin' ":stem S "ettin's S Ad.anced S "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 7#ar7tm37freenas-de$!g.t(t. !sin' "he%%D :ou can run this command manua%%: to 'ather the s eci+ic de=u''in' in+ormation that :ou need. <o see the a.ai%a=%e o tionsD 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 -l Dump LDAP Configuration -T Loader Configuration Information -n Dump Network Configuration -s Dump SSL Configuration -y Dump Sysctl Configuration -t Dump System Information -z Dump ZFS configuration
$or e6am %eD i+ :ou are trou=%eshootin' :our Acti.e (irector: con+i'urationD tr: the +o%%owin' commands. Note that :our current director: needs to =e writa=%e Ae.'. a .o%ume or datasetB.
/usr/local/bin/freenas-debug -a > debug.txt more debug.txt
Page 271 of 276
1".11 t3u,
tmu6 is a termina% mu%ti %e6er which ena=%es a num=er o+ termina%s to =e createdD accessedD and contro%%ed +rom a sin'%e screen. tmu6 is an a%ternati.e to 3N! screen. "imi%ar to screenD tmu6 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 13.10aD a new session with a sin'%e window wi%% o en 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".11a: t3u, Session
<o create a second windowD ress 'trl $ then J. <o c%ose a windowD t: e e,it within the window. tmu6A1B %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 ne6t time :ou o en "he%%D it wi%% return to the t3u, session. <o %ea.e the t3u, session entire%:D t: e e,itM i+ :ou ha.e mu%ti %e windows runnin'D :ou wi%% need to e,it out o+ each +irst.
1".11 63idecode
(midecode re orts hardware in+ormation as re orted =: the s:stem #I-". (midecode does not scan the hardwareD it on%: re orts what the #I-" to%d it to. A sam %e out ut can =e seen here. <o .iew the #I-" re ortD t: e the command with no ar'umentsK
dmidecode | more
dmidecodeA2B descri=es the su
orted strin's and t: es.
Page 272 of 276
Section 4: Contributing to Free !S"

1# %o/ to Get In+ol+ed
As an o en source communit:D $reeNA"1 re%ies on the in ut and e6 ertise o+ its users to he% im ro.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+ artici ation to 'et :ou started. It is =: no means an e6hausti.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 "u ort Resources. <his section demonstrates how :ou canK Assist with 9oca%i8ation <est ! comin' 4ersions
1#.1 Assist /it <ocali=ation

$reeNA"1 uses >oot%eD an o en source a %icationD +or mana'in' the %oca%i8ation o+ the menu screens used =: the $reeNA"1 'ra hica% 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 te6t +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 s end 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 o en oot%e.+reenas.or' in :our =rowserD as seen in $i'ure 1&.1aK Figure 1#.1a: FreeNAS <ocali=ation S*ste3
Page 27" of 276
<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 100OD it means that the menus that current%: are not trans%ated wi%% a ear in 5n'%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 u dates 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 rom ted 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 S c%ic) the $reeNA"1 %in) +or the roIect S c%ic) the %in) +or 9CGM5""A35" S and c%ic) the %in) +or dIan'o. o. 5.er: te6t %ine a.ai%a=%e in the 3!I menu screens has =een assi'ned a strin' num=er. I+ :ou c%ic) the num=erD an editor wi%% o en where :ou can trans%ate the te6t. In the e6am %e shown in $i'ure 1&.1=D a user has se%ected strin' num=er &, in the 3erman trans%ationM the other strin's in the screenshot ha.e a%read: =een trans%atedK Figure 1#.1': Using t e Pootle Interface to :dit a )ranslation String
"im %: t: e in the trans%ated te6t and c%ic) the "u=mit =utton to sa.e :our chan'e.
Page 27# of 276
1#.2 )est an U!co3ing @ersion

>rior to an: re%easeD there is a =eta eriod where testin' sna shots wi%% =e announced on the $reeNA"1 we=site and socia% media sites. <his =eta eriod is meant to ro.ide users an o ortunit: to test the u comin' re%ease and to ro.ide +eed=ac) on =u's and errors so that the: can =e +i6ed rior to re%ease. $eed=ac) can =e sent to the $reenas;testin' mai%in' %ist or a =u' re ort can =e created as descri=ed in the re.ious section. 1#.2.1 )esting a Nig tl* Sna!s ot
Chan'es to $reeNA"1 occur dai%: as de.e%o ers address the =u's and enhancement reEuests re orted =: $reeNA"1 users. A testin' .ersion that incor orates these chan'es is automatica%%: =ui%t dai%: and is a.ai%a=%e +or down%oad as a ni'ht%: re%ease. I+ :ou wish to insta%% or u 'rade to the testin' .ersion o+ $reeNA"1 Ai.e. the .ersion that addresses a%% +i6ed =u's u to toda:'s dateB or :ou need to u 'rade to a .ersion that incor orates a +i6 :ou are waitin' +orD :ou can down%oad the %atest ni'ht%: .ersion. N9):: it is ossi=%e that a recent%: im %emented chan'e wi%% not wor) as e6 ected or wi%% =rea) somethin' e%se. I+ :ou e6 erience thisD ta)e the time to add a comment to the a %ica=%e su ort tic)et so that the de.e%o ers can address the ro=%em. 6ANG:2D !"#radi%# *ro( a %i#htl) $%a"$hot to a RE2EASE i$ %ot $!""orted9 #e war: o+ insta%%in' a ni'ht%: in a roduction en.ironment and =e sure to =ac)u :our con+i'uration =e+ore attem tin' a +u%% insta%% o+ a %ater RC or R595A"5 .ersion. Ni'ht%: =ui%ds are a.ai%a=%e as I"-D 3!I u 'radeD or img.(4 ima'es. I+ :ou are u 'radin' to a ni'ht%: +rom an ear%ier .ersion o+ $reeNA"1 see ! 'radin' $reeNA"1 +or instructions on how to u 'rade. 1#.2.2 2olling >our 9/n )esting Sna!s ot
!sers who wish to create their own custom I"- +or testin' ur oses can down%oad and com i%e the %atest $reeNA"1 source +rom the 'ithu= re ositor:. Read the R5A(M5 +irst so that :ou are aware o+ an: 'otchas and current%: )nown %imitations. I+ :ou wish to =ui%d :our own testin' sna shotD :ou wi%% need to insta%% $ree#"( 9.1 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 & 3# o+ RAM is recommended. (own%oad and insta%% the $ree#"( .ersion Ai32, 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 su eruser 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 pkg_add pkg_add pkg_add rehash -r -r -r -r git-subversion cdrtools python27 pbi-manager
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
Page 27$ of 276
cd freenas
Fou are now read: to =ui%d the ima'eK

sh build/do_build.sh
A%ternate%:D :ou can maintain a %oca% 'it mirror to s eed u +urther =ui%dsK
git clone git://github.com/freenas/ports.git ${HOME}/ports git clone git://github.com/trueos/trueos.git ${HOME}/trueos
<o =ui%d usin' those %oca% mirrorsD runK

env GIT_REPO=${HOME}/trueos GIT_PORTS_REPO=${HOME}/ports sh build/do_build.sh
-nce the =ui%d com %etesD :ou wi%% ha.e an ima'e in o$D.yyyy7FreeNASYCCCC-XXXX-yyyy.img.(4 whereK CCCC is the re%ease =ranch .ersion XXXX is the re.ision +rom the $reeNA"1 re ositor: yyyy is either i32, or amd,& de endin' on :our %at+orm and what was L$R55NA"GARCH on the command %ine or in an en.ironment settin' ro.ided .ia
<his is a com ressed raw dis) ima'e which needs to =e decom ressed and con.erted to :our +a.orite .irtua% machine container +ormat =e+ore use. <here wi%% a%so =e a C( ima'e ca%%ed o$D.yyy7FreeNASCCCC-XXXX-yyyy.f!ll.iso that :ou can =urn to dis) and use to insta%% or u 'rade $reeNA"1.
Page 276 of 276

Freenas9.1.1 Guide

Uploaded by

Document Information

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

Freenas9.1.1 Guide

Uploaded by

Copyright:

Available Formats

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

FreeNAS 9.1.1 Users Guide

Section 2: Using t e Gra! ical Interface

Section ": Getting %el!

Section #: &ontri'uting to FreeNAS

Section 1: Introduction and Installation

FreeNAS 9.1.1 Users Guide

eriodic 0$" sna shots are .isi=%e in Windows as shadow co ies

inc%udes tmu6D a #"(;%icensed uti%it: simi%ar to 3N! screen

- at.s Ne/ in 9.1.1

FreeNAS 9.1.1 Users Guide

tr: disa=%in' this su

ort =: creatin' a tuna=%e with a .aria=%e o+ (h'i*load and a .a%ue o+ N+.

FreeNAS 9.1.1 Users Guide

Page 1" of 276

I+ :ou +ind that W-9 su re ort. 1.".6 2AI6 9+er+ie/

FreeNAS 9.1.1 Users Guide

FreeNAS 9.1.1 Users Guide

Installing and U!grading FreeNAS

FreeNAS 9.1.1 Users Guide

FreeNAS in a @irtual :n+iron3ent

Creating the Virtual Machine

FreeNAS 9.1.1 Users Guide

Figure 2.2a: Initial @irtual5o, Screen

FreeNAS 9.1.1 Users Guide

Figure 2.2d: Select - et er to Use an :,isting or &reate a Ne/ @irtual 6is7

FreeNAS 9.1.1 Users Guide

FreeNAS 9.1.1 Users Guide

Figure 2.2f: Select t e Storage )*!e for t e @irtual 6is7

Figure 2.2g: Select t e File Na3e and Si=e of t e @irtual 6is7

FreeNAS 9.1.1 Users Guide

Page 2" of 276

Creating Devices for Storage and Installation Media

FreeNAS 9.1.1 Users Guide

FreeNAS 9.1.1 Users Guide

Figure 2.2A: &onfiguring t e IS9 Installation 4edia

Configuring the Bridged Ada ter

FreeNAS 9.1.1 Users Guide

Figure 2.27: &onfiguring a 5ridged Ada!ter in @irtual5o,

"unning #ree$AS% fro& a 'SB I&age

Figure 2.2l: &reating t e +3d7 File in -indo/s

FreeNAS 9.1.1 Users Guide

Figure 2.23: Ne/ @irtual 4ac ine -i=ard

Figure 2.2n: Select a 6atastore

FreeNAS 9.1.1 Users Guide

Figure 2.2o: Select t e 9!erating S*ste3

FreeNAS 9.1.1 Users Guide

Page "1 of 276

Figure 2.2!: &reate a 6is7 for t e 9!erating S*ste3

FreeNAS 9.1.1 Users Guide

Page "1 of 276

Figure 2.2C: @irtual 4ac ine.s Settings

FreeNAS 9.1.1 Users Guide

Page "2 of 276

Figure 2.2r: &reating a Storage 6is7

Installing fro3 &6294

Figure 2."a: FreeNAS &onsole Setu!

FreeNAS 9.1.1 Users Guide

Page "# of 276

Figure 2."': Selecting - ic 6ri+e to Install Into

Figure 2."c: FreeNAS Installation -arning

Figure 2."d: FreeNAS Installation &o3!lete

FreeNAS 9.1.1 Users Guide

Page "$ of 276

&onfiguring 2snc o+er SS% 4ode 5et/een )/o FreeNAS Sste3s