Blackout Km 1.1.01 User Guide

Transcript

Blackout Knowledge Module® for PATROL® b y S e n t r y S o f t w a r e ™ User Guide Supporting Blackout Knowledge Module® fo r PATROL ® by S e n t r y S o f t w a r e ™ v e r s i o n 1 . 1 October, 2006 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Contents Sect io n I - Gett ing st arted ................................ ................................ .............................. 4 1 - Requ ir ements ................................ ................................ ................................ ........... 5 1. 1 - Soft wa r e r equi r em en t s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1. 2 - Ha r dwa r e r equir em en t s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2 - Loa ding Blackout KM f or PAT ROL ................................ ................................ ............ 6 3 - Making sur e Blackout KM f or PAT ROL is r unning ................................ ....................... 8 4 - Tr ial p er iod a nd licens e keys ................................ ................................ ..................... 9 Sect io n II - Us ing Blacko ut KM for PATR OL ................................ ................................ . 11 1 - B l a c k o u t K M f o r P A T R O L ’ s p u r p o s e ................................ ................................ ........ 12 2 - Blackout r epr es entation in the P AT ROL Cons ole ................................ ........................ 13 3 - Real-t ime r eact ivit y in Blackout KM f or PAT ROL ................................ ...................... 14 3. 1 - On Win dows m on i t or ed s yst em s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3. 2 - On UNIX m on i t or ed s yst em s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 4 - Planning a Blackout ................................ ................................ ................................ 15 4. 1 4. 2 4. 3 4. 4 4. 5 - Sel ect i n g th e PAT ROL obj ect s t o bl a ck out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pl annin g th e st art of t h e Bl a ck out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pl annin g th e en d of a bl a ck out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sel ect i n g th e bl a ckout t yp e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Nam in g th e bl a ck out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 18 23 25 28 5 - Modif ying a Blackout configur ation ................................ ................................ ......... 29 6 - Removing a blackout ................................ ................................ .............................. 30 Sect io n III - D ay -to -day t as ks ................................ ................................ ....................... 31 1 2 3 4 5 6 7 8 - Checking a blackout state ................................ ................................ ........................ Aler ts tr igger ed b y a blackout ................................ ................................ .................. Acknowledging a blackout aler t ................................ ................................ ............... T emp or ar ily susp end a blackout schedu le ................................ ................................ .. Manually star t or stop a blackout ................................ ................................ ............. Disp laying inf or mation r elating t o a black out ................................ ............................ Expor ting a blackout conf igur ation t o a file ................................ ............................... Enabling t he D ebu g M ode ................................ ................................ ....................... 32 34 35 36 37 39 40 42 Sect io n I V - Addit io nal info rmat io n ................................ ................................ .............. 43 1 - Backup, log and t emp or ar y f older s ................................ ................................ ........... 44 2 - Regu lar expr ess ions ................................ ................................ ................................ 45 3 - Conf igur ation var iables ................................ ................................ ........................... 47 2 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Blackout KM for PATROL - User Guide T hi s docum en t expl a in s th e pr oc edur e t o fol l ow i n or der t o use an d r un th e Bl a ck out KM for PAT RO L. Bl a ck out Kn owl edg e M odul e® for PAT RO L® i s a Kn owl edg e M odul e for BMC S oft wa r e® PAT RO L® t ha t a l l ows t h e a dm i ni st ra t or s t o t em p or a ri l y a n d un der cer t a in con di t i on s susp en d t h e m on i t or in g of som e pa r t of t h ei r IT in fra str uct ur e. A bl a ck out ca n be us e ful wh en a m on i t or ed s yst em (a da t aba s e or a n a ppl i ca ti on ) en coun t er s a bn orm a l but pl ann ed a ct i vi t i es l i ke ba ck -ups. Su ch un usual a ct i vi t ies wi l l ca use PAT ROL® t o t r i gger fa l se p osi t i ves. T h anks t o t h e Bl a ck out KM, a dm in i str a t or s can dr a ma t i ca l l y r educe fa l se a l er t s th a t oper a t or s h a ve t o pr oc es s . 3 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Section I - Getting started 4 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 1 - Require me nts 1. 1 - So ftw are req u i remen t s Bl a ck out KM for PAT RO L r equi r es t h e fol l owi n g soft wa r e c om p on en t t o be i n st a l l ed on th e m on it or ed s yst em s: BMC S oft wa r e PAT RO L Agen t 3. 4. 00 or h i gh er For r ea l -t i m e m on i t orin g of pr oc es s es a n d NT Ser vi c es on Wi n dows s er ver s, th e W BE M l a yer (WMI, Wi n dows Ma n a gem ent In str um en t a ti on ) Bl a ck out KM for PAT RO L r equi r es t h e fol l owi n g soft wa r e c om p on en t t o be i n st a l l ed on th e Con sol e s yst em : BMC S oft wa r e PAT ROL C on s ol e v3. 4. 00 or high er or PAT ROL C en t ra l or PAT ROL C on sol e We b- edi t i on 1. 2 - Hard w are r eq u i remen t s Bl a ck out KM for PAT RO L doe s n ot h a ve a n y speci fi c r equi r em en t s. Th e st an dar d PAT ROL Agen t r equir em en t s ar e suffi ci en t for th e KM t o r un pr oper l y. T h e foot pr in t of Bl a ck out KM on th e m on it or ed syst em i s ver y l i m i t ed: l ess t h an 1 per cen t of pr oc ess or t i m e l ess t h an 1 m ega byt e of m em or y l ess t h an 2 m ega byt es of di sk usa ge n o n et wor k ba n dwi dt h usa ge 5 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 2 - Loading Blackout KM for PAT ROL Be for e l oa di n g Bl a ck out KM for PAT RO L, pl ea se m a ke s ur e t h a t a ll r equi r em ent s h a ve be en m et a nd t ha t th e pr oduct h a s been pr oper l y i n st a l l ed on a l l PAT ROL Ag en t s a n d Con sol es u si n g th e pr ocedur e des cr i bed i n th e Inst al l at i on Gui de . Pr i or t o usin g Bl a ckout KM for PAT ROL you m ust l oa d t h e Kn owl edg e Modul es (K M s) on t h e PAT RO L Con sol e. Fol l ow t h e st eps bel ow t o l oa d Bl a ck ou t KM for PAT RO L: L o ad i ng Bl acko u t fo r PAT RO L fro m th e PAT RO L Con so l e fo r Wi nd ow s o r th e PAT ROL Co n so l e fo r UNI X Step 1 S e l e c t “ F i l e → L o a d K M ” in th e PAT ROL C on sol e for Wi n dows m en u Step 2 In th e di a l og b o x , s e l e c t “ SEN_B O_BLAC KOUT. kml ” a n d c l i c k [ O p e n ] L o ad i ng Bl acko u t fo r PAT RO L fro m PAT ROL C en tral O p erato r Step 1 S e l e c t “ Ac ti on → L o a d K n o w l e d g e M o d u l e s … ” Step 2 In th e di a l og box, ch eck t h e box n ext t o t h e m ana ged s yst em s for wh i ch you wi sh t o l oa d Bl a ck out KM for P AT RO L a n d cl i ck [Next ] Step 3 C l i c k t h e “ K n o w l e d g e M o d u l e l i s t s ” t a b , c h e c k t h e b o x n e a r “ SEN_B O_B LAC KOUT .k ml” a n d c l i c k [ N e x t ] Step 4 Cl i ck on th e [Fin i sh ] but t on . L o ad i ng Bl acko u t fo r PAT RO L fro m PAT ROL Cen tral Web Ed i ti on Step 1 In th e " G e ne r al Task s" p a n e l , c l i c k “ Load K n owl e dge M odul e s ” Step 2 In th e di a l og box, cl i ck on th e m ana ged s yst em s for wh i ch you wi sh t o l oa d Bl a ck out KM for PAT RO L a n d cl i ck [Next ] Step 3 S e l e c t “ SE N_BO_B LACKOU T.kml ” fr om t h e l i st an d cl i ck [Next ] Step 4 Cl i ck on th e [Fin i sh ] but t on . T h e fol l owi n g cl a sse s sh oul d be l oa ded on th e Mon i t or ed S yst em a n d Con sol e: Class name Descr ip ti on SEN _BO _B LA CKOUT _ MAN AGE R M a i n B l a c k o u t i n s t a n c e u s e d t o m a n a g e B l ac k o u t K M f o r P A T R O L SEN _BO _B LA CKOUT B l ac k o u t i n s t a n c e s If a cl a ss of Bl a ck out KM for PAT RO L h a s n ot been l oa d ed, a n a l ert i s t r i gger ed a n d th e fol l owi n g m essa ge i s di spl a yed i n th e S yst em Out put Win dow (SO W) of t h e PAT ROL C on sol e: "The cla ss for Black ou t KM is n ot loa ded! All the c lasses of Bl ackout KM ha ve to be pr eloade d to w ork pr operly . PLEASE LO AD THE CLAS S. " 6 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Prel o ad i n g Bl acko u t KM fo r PAT RO L T o m a ke sur e Bl a ck out K M for PAT RO L i s l oa ded a s s oon a s t h e PAT RO L Ag en t st a r t s up a n d i s exe cut ed a s l on g a s th e PAT ROL Ag en t i s r unn ing , Bl a ckout KM for PAT ROL n eeds t o be pr el oa d ed. In or der t o pr el oa d Bl a ck out KM for PAT RO L, a dd t h e KM fi l e l i st a bove t o t h e “/AgentSetup/preloadedKMs” c o n f i g u r a t i o n v a r i a b l e . P l e a s e , c h e c k t h e “ PA TR OL A ge nt R e f e re nc e Manual ” f o r m o r e i n f o r m a t i o n o n h o w t o m o d i f y c o n f i g u r a t i o n v a r i a b l e s . If Bl a ck out KM for PAT RO L i s n ot pr el oa de d, a n al er t i s tr i gger ed an d t h e fol l owi n g m e ssa ge i s di spl a yed i n th e Syst em Out put Wi n dow (SO W) of t h e PAT RO L Con s ol e: "The cla ss for Black ou t KM is n ot pre loaded ! All the c lasses of Bl ackout KM ha ve to be pr eloade d to work properly.” 7 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 3 - Maki ng sure Blackout KM for PAT ROL is running If Bl a ck out K M for PAT RO L i s pr op er l y i n st al l ed a n d r unn in g, th e fol l owi n g i n st an ce i s cr ea t ed in th e PAT RO L Con sol e: “ Bl a ckout Ma n a ger < ver si on n um ber >. ” T hi s i s th e m a in Bl a ckout i n st an c e fr om wh i ch you ca n pl an bl a ckout s a n d edi t th e pr oduct s et t i n gs. Ne w bl a ck out s a r e cr ea t ed un der th i s i con . If you a r e usi n g Bl a ckout KM for PAT RO L dur in g th e t ri a l per i od , th e ma in in st an ce l a bel di spl a ys t h e r em a inin g da ys of t h e t r i a l per i od. At th e en d of t h e t r i al per i od, th e m a in in st an ce i s di sa bl ed a n d a l l bl a ck out s a r e ca n cel ed. If you pur ch a sed th e KM, r ea d th e n ext sect i on for in for m a t i on a bout h ow t o en t er th e l i cen se ke y. 8 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 4 - T rial period and license keys Wh en Bl a ckout KM for PAT RO L i s fi r st l oa ded t h e a ut om a t i c 30 -da y t r i a l i s a ct i va t ed. At th e en d of t h e t r ia l per i od Bl a ck out KM for PAT RO L i s di sa bl ed . A l i cen se ke y m ust be en t er ed t o c on t in ue usi n g th e pr oduct . Wi t h your l i cen se ke y, fol l ow t h e st eps bel ow: [Ri gh t -cl i ck] t h e Bl a ckout Ma n a ger i con an d sel e ct “ K M Command s → L i c e n s e … ” f r o m t h e m en u. A di a l og box a ppea r s an d sh ows t h e l i cen se Bl a ck out KM for PAT RO L i s cur r ent l y wor ki n g wi t h (a ut om a ti c 30 -da y t r i a l, t er m l i cen se or per pet ua l l i cen se). T o en t er a n ew l i cen se k e y, cl i ck on th e [Regi st e r a n ew l i c en se] but t on . 9 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Ch oos e t h e ke y t yp e dep en di n g on th e li cen se you pur cha sed (Per pet ua l Li cen se or T erm Li cen se). If you pur ch a sed a T erm Li cen se, you m ust en t er your T erm Li cen se expi r a t i on da t e. If you pur ch a sed a Per pet ua l Li cen se, you sh oul d l ea ve t h e expi ra t i on da t e fi el d bl a n k. T h en , en t er your l i cen se ke y i n th e l a st fi el d an d pr ess t h e [Regi st er ] but t on . On ce t h e l i cen se ke y h a s be en a ccept ed, t h e l i cen se di a l og box i s r efr esh ed a n d sh ows t h e n ew l i cen se a s r egi st er ed. It possi bl e t o h a ve m ul t i pl e r egi st er ed l i cen ses. Dep l o yi n g l i cen se keys o n mo n i to red systems E nt er in g th e l i cen se ke y on a m on i t or ed syst em c r ea t es th e fol l owi n g l i cen s i n g in for m a t i on: a v a r i a b l e i n t h e P A T R O L A g e n t c o n f i g u r a t i o n c a l l e d : “ /SENTRY/BL ACKOUT 1/lice nse ” a f i l e o n t h e P A T R O L A g e n t c a l l e d : “ %PATROL_ HOME/lib/ SEN_BO _licen se4 ” T o depl oy t h e l i cen se ke y on a ll m oni t or ed ser ve r s, you do on e of t h e fol l owi n g : depl oy t h e l i cen se ke y ext r a ct ed Con fi gur a t i on Man a ger (PCM) on th e PAT RO L Ag en t con fi gur a t i on wi t h PAT ROL depl oy t h e l i cen se fi l e wi t h PAT ROL Di st r i but i on Ser ver (DS) On l y on e of t h ese pi ec e s of l i cen si n g in for m a t i on i s r equi r ed for th e l i cen se ke y t o be va l i da t ed. 10 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Section II - Using Blackout KM for PATROL 11 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 1 - Blackout KM for PAT ROL ’ s purpose T h e bl a ckout of a PAT ROL KM i s us ed t o t em p or ari l y di sa bl e t h e m on i t orin g of c er t a in soft wa r e durin g spe ci a l oper a t i on s such a s ba ckups, upda t es, et c. It s pur pose i s t o m a ke sur e n o fa l se a l er t s a r e tri gger ed wi l e p er for m in g such op er a t i on s. For exa m pl e, i f a n a ppl i ca t i on i s st opp ed t o upgr a de t o t h e l a t est ver si on , i t i s n ot n ecessa r y t o r e cei ve a n a l e r t i n t h e P A T R O L C o n s o l e b e c a u s e t h e a p p l i c a t i o n ’ s pr oce ss es a r e down . Bl a ck out KM for PAT ROL ca n di sa bl e a wh ol e Kn owl edge M odul e (KM) d own t o a sin gl e PAT RO L i n st an ce. Sever a l m odes ca n be us ed t o a ut om a t i ca l l y t r i gger th e bl a ckout : a t a gi ven da t e an d t im e upon th e pr esen ce or a bsen c e of a fi l e upon th e pr esen ce or a bsen c e of a pr oc ess upon th e pr esen ce or a bsen c e of a NT Ser vi c e T h e sam e m odes ca n be used t o st op t h e Bl a ck ou t or a t im eout ca n be set . 12 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 2 - Blackout represe ntation i n the PAT ROL Console Bl a ck out KM for PAT RO L i s di spl a yed i n th e PAT ROL C on s ol e a s a n y Kn owl edg e M od ul e for P A T R O L . A n i n s t a n c e i s c r e a t e d u n d e r y o u r m o n i t o r e d s y s t e m i c o n , c a l l e d “ B l a c k o u t Ma n a ger < ver si on n um ber >, a s sh own i n th e pi ct ur e bel ow: T h e m ain bl a ck out opt i on s, such a s cr ea t i n g a ne w bl a ck out or t urn in g on th e de bug m od e, a r e a cc es se d by r i gh t -c l i c k i n g t h e B l a c k o u t M a n a g e r i n s t a n c e a n d s e l e c t i n g “ K M C o m m a n d s ” f r o m t h e p o p -up m en u. E a c h n e w b l a c k o u t s c h e d u l e c r e a t e s a n i n s t a n c e u n d e r t h e “ B l a c k o u t M a n a g e r ” i c o n , p r o v i d i n g a n e a s y wa y t o ch e ck t h e bl a ckout s pl a nn ed for t h e curr ent m oni t or ed s yst em . Opt i on s for ea ch bl a ckout a r e a cc ess ed by r i gh t -cl i ckin g a bl a ckout . T h er e ar e n o l i m i ta t i on s on th e n um ber of bl a ck out for a m on it or ed s yst em . 13 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 3 - Real-time reacti vit y i n Blackout KM f or PAT ROL Bl a ck out KM for PAT RO L h a s be en bui l t so t h a t i t r ea ct s in st an t an eousl y t o e ven t s. Fa l se a l er t s ar e c om pl et el y a voi d ed si n ce t h e bl a ck out st a r t s e xa ct l y wh en i t wa s supposed t o a n d n ot a ft er a cer t a in del a y. 3. 1 - O n W i nd o w s mo n i to red sy stem s On Win dows m on i t or ed s yst em s, Bl a ck out KM for PAT ROL r ea ct s t o t h e fol l owi n g even t s in r ea l -t i m e: da t e an d ti m e: th e bl a ckout wi l l st a r t / st op a t th e exa ct se c on d i t wa s pl ann ed t o st ar t fi l e cr ea t in g/ del et i on : th e bl a ck out wi l l st a r t / stop wi t h n o m or e t h an a fi ve s e c on d del a y a t the cr ea t i on or del et i on of a fi l e pr oce ss st a r t ed/ st opped: t h e bl a ckout wi l l st a rt / st op wi t h n o m or e th an a fi ve s ec on d del a y wh en a pr oc ess i s st a r t ed or st opped ( t h e WBE M l a yer m ust be i n st a ll ed) NT ser vi c e st a r t ed/ st opped: t h e bl a ck out wi l l st a rt / st op wi t h n o m or e t h an a fi ve se c on d del a y m ost wh en anr NT ser vi c e i s st a rt ed or st opped ( t h e WBE M l a yer m ust be i n st al l ed) If t h e W BE M l a yer i s n ot i n st a l l ed a n d th e bl a ck out sh oul d st a r t / st op wh en a pr oc es s or NT ser vi c e st a t us ch an ges, th e bl a ckout wi l l r ea ct wi t h n o mor e t h an a t wo m i n ut e del a y. Rea l -t i m e m on it or in g uses l ess t h an 1% of pr oc e ss or t im e. 3. 2 - O n UNIX mo n i to red sy stem s On UNIX m on i t or ed s yst em s, Bl a ck out KM for PAT RO L r ea ct s t o t h e fol l owi n g even t s in r ea l -tim e: da t e an d ti m e: th e bl a ckout wi l l st a r t / st op a t th e exa ct se c on d i t wa s pl ann ed t o st ar t fi l e cr ea t in g/ del et i on : th e bl a ck out wi l l st a r t / stop wi t h n o m or e t h an a fi ve s e c on d del a y a t the cr ea t i on or del et i on of a fi l e Beca us e of t h e h i gh pr oces s or t i m e r equi r ed t o m on i t or pr oce ss es on UNI X s yst em s, i t i s n ot pos si bl e for Bl a ck out KM for PAT RO L t o r ea ct i n r ea l -t i m e t o pr oc ess e ven t s. Howe ver , by d e fa ul t , Bl a ckout KM for PAT RO L wi l l ch eck t h e pr oces se s ’ st a t us e ver y m i n ut e (60 sec on ds). It i s possi bl e t o ch an ge t h i s p o l l i n g i n t e r v a l b y m o d i f y i n g a c o n f i g u r a t i o n v a r i a b l e . S e e t h e “ A d d i t i o n a l i n f o r m a t i o n ” s e c t i o n f o r m or e i n for m a ti on a bout t hi s subj e ct . 14 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 4 - Planni ng a Blackout Pl a nnin g a Bl a ckout i s don e f r om a PAT ROL C on sol e t hr ough an int er fa ce. A bl a ck out wi z a r d gui des you t hr ough th e seven st eps n eeded t o pr ovi de t he pl a nnin g in for m a ti on . T h e Bl a ck out wi z a r d a ll ows you t o s et up a Bl a c kout by h el pi n g you t o s el ect t h e p er i od of t i m e dur in g wh i ch th e bl a ck out wi l l r un , th e PAT RO L obj ec t s wh os e m on i t or i n g wi l l be pa us ed a s wel l a s t h e t yp e of bl a ck out t ha t wi l l be used. T h e Bl a ckout wi z a r d i s l a un ch ed by r i ght -cl i cki n g th e Bl a ck out Ma n a ger in th e PAT ROL C on s ol e a n d s e l e c t i n g “ N e w b l a c k o u t … ” T h e p a n e l b e l o w w e l c o m e s y o u t o t h e B l a c k o u t w i z a r d . Cl i ck [Next ] t o c on t in ue. Note : Ca n cel i n g t h e wi z a r d i s on l y p ossi bl e i n t hi s wi n dow. If you wa n t t o ca n cel t h e wi z a r d at a n y st ep, you n eed g o [ Ba ck] t o t h i s wi n dow a n d cl i ck [Can cel ]. 4. 1 - Sel ecti n g th e PAT ROL ob j ects to b l acko u t T h er e a r e t hr ee di ffer en t wa ys t o s el e ct t h e PAT RO L obj e ct s t o bl a ck out : by s el e ct i n g a wh ol e KM by pi cki n g th e PAT ROL obj ect s fr om a l i st of cur r en t l y exi st i n g in st an ces by en t er in g th e KM or in st an ce n am e. E a ch m eth od i s d es cr i bed i n t h e fol l owi n g se ct i on s. Note : Wh en t h e bl a ck out st a r t s, i f t h e s el e ct ed P AT RO L obje ct s, K M or KM Ls d o n ot exi st a n ym or e, n o er r or m essa ge wi l l be di spl a yed a n d n o a l er t tr i gger ed. T h i s wa y, you ca n ea s i l y depl oy a s et of i t em s t o bl a ck out t o a l l your PAT RO L Ag en t s wi t h out worr yi n g a bout get t i n g fa l se a l er t s. 15 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Sel ecti n g a w ho l e KM T hi s i s th e r ecom m en ded m et h od t o bl a ck out a wh ol e KM. Bl a ck out KM for PAT ROL a ut om a t i ca l l y bui l ds a l i st of i n st a ll ed KM a n d KML (Kn owl edg e Modul e Li st ) fi l e s i n st a l l ed on t h e ser ver . T he l i st s a r e th en di spl a yed i n th e pan el , a s sh own i n t h e scr een sh ot . It i s possi bl e t o ei t h er sel ect a l i st of KM L fi l e s, a l i st of KM fi l e s or a l i st of bot h fi l e t ype s. Wh en per for m in g th e bl a ck out , Bl a ck out KM for PAT RO L wi l l bl a ck out a l l i n st an ces of t h e sel e ct ed cl a ss. S o, i f you si m pl y wa n t t o bl a ck out on e pa r t i cul ar in st an ce of a K M, you sh oul d u s e t h e s e c o n d m e t h o d c a l l e d “ e x i s t i n g o b j e c t s ” t o pi ck t h e speci fi c PAT ROL obje ct . If a KM L fi l e i s s el e ct ed, Bl a ck out KM for PAT RO L wi l l bl a ck out a l l PAT RO L i n st an ces o f a l l KMs for m i n g th e KML. Pi ck t h e KM s a n d KML s you wa n t t o bl a ck out fr om t h e l i st an d cl i ck th e [Next ] but t on t o c on t in ue wi t h th e wi z a r d. Exa mpl e s: 1. T o bl a ck out t h e wh ol e P AT ROL for DE L L Open Ma na ge KM, you c oul d ei t h er sel e ct “ DELL_ BASE ” f r o m t h e K M L l i s t , o r a l l “ DELL_” i t e m s i n t h e K M l i s t . 2. T o bl a ck out a l l pr oce ss m on i t or i n g of Appl i ca t i on Sen tr y K M for PAT RO L, sel ect t h e “ SW_PR OCESSE S ” K M . Imp or tant: T h e a b o v e e x a m p l e s a r e r e l e v a n t t o a l l b l a c k o u t m e t h o d s e x c e p t t h e “ n o c o l l e c t ” m e t h o d . S i n c e t h i s m et h od i s a bi t di ffer en t than th e ot h er s, th e wa y th e i t em s t o bl a ck out a r e sel ect ed i s a l i t t l e di ffer en t . 16 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Sel ecti n g a l i st o f cu rren tl y exi s ti n g o bj ects T hi s i s t h e ea si e st wa y t o sel ect PAT RO L obje ct s t o bl a ck out fr om a l i st of exi st i n g obje ct s i n th e PAT ROL C on sol e . Bl a ck out KM for PAT RO L r ea ds t h e P A T R O L A g e n t ’ s c o n f i g u r a t i o n a n d b u i l d s a l i st of cur r ent l y exi st i n g PAT RO L i n st an ces. Th e l i st i s di spl a yed i n a tr ee l i ke l i st , out l i n in g th e wa y t h e obj e ct s a r e di spl a yed i n th e PAT ROL C on sol e. T o s el e ct t h e in st an ces t o bl a ck out , si m pl y fi n d t h e i t em i n th e l i st a n d cl i ck on i t . It i s possi bl e t o s el ect s e ver a l i t em s a t th e sa m e t i m e. If you wi sh t o s el e ct a n i t em a s wel l a s t h e i t e m ’ s subi t em s (t h e it em s pl a ced un dern ea th it ), sel ect t h e obj ect fr om t h e l i s t a n d c l i c k o n “ B l ac k out the se l e c te d obje c ts and th ose pl ac e d unde r ne ath . ” Sel e ct t h e PAT RO L i n st an ces t o bl a ck out a n d cl i ck on [Next ] t o con t i n ue. Exa mpl e s: 1. T o b l a c k o u t t h e w h o l e P A T R O L f o r D E L L O p e n M a n a g e K M , s e l e c t t h e “ DE LL” i t e m f r o m t h e l i s t a n d c l i c k o n “ B l ack out the se l e c te d obje c ts and those pl ac e d unde r ne ath . ” 2. T o bl a ck out on e or se ver a l pr oce ss m on i t or in g of Appl i ca t i on Sen t r y K M for PAT RO L, si m pl y s el e ct ea ch pr oces s fr om t h e tr ee. Imp or tant : T h e l i st of obj ect s t o bl a ck out i s d yn a m i ca l l y bui l t at th e st ar t of ea ch bl a ckout . T h i s h a s n o i mpa ct on t h e b l a c k o u t i f t h e o p t i o n “ O nl y bl ac k out t he se l e c te d obje c ts ” wa s ch osen . Howe ver , i f t h e opt i on “ B l ack out the se l e c te d obje c ts and those pl ac e d un de r ne ath ” w a s ch osen , th e l i st of su bi t e m s m a y ch an ge a t th e st ar t of ea ch bl a ck out t o r efl ect t h e curr en t l i st of subi t em s a t th e t im e of t h e bl a ck out . 17 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Man u al l y en teri n g th e l i st o f i n stan ces o r KMs to b l acko u t T hi s m eth od of s el e ct i n g th e obje ct s t o bl a ck out i s m ost c om m on l y u s ed wh en a m i x of KML s, KMs a n d PAT RO L i n st an ces i s r equir ed. T hi s i s a l so t h e on l y wa y t o s el e ct obje ct s or KMs t h a t do n ot yet exi st on t h e PAT RO L Agen t . Howe ver , i t r equir es a good kn owl edge of t h e PAT ROL a r ch i t ect ur e. It i s p ossi bl e t o en t er up t o fi ve obj ect s t o bl a ck out , wh et h er th e y a r e KMLs, KMs, PAT RO L i n st a n ces or a c om bi n a t i on of a l l t h ese t ype s. For ea ch of t h em you n eed t o en t er : T h e t ype of obj ect (KM L, KM or PAT RO L i n st an ce) If a n in st an ce i s en t er ed, wh et h er th e obje ct s pl a c ed un der n ea th sh oul d be bl a cked o u t a s w e l l ( “ R e c u r s i v e ” ) o r n o t ( “ N o t r e c u r s i v e ” ) E i th er th e n a m e of t h e KML n am e > / < P A T R O L I D > ” ) or KM, o r t h e p a t h t o t h e i n s t a n c e ( u s u a l l y “ / < c l a s s E nt er th e obj e ct s t o bl a ck out a n d cl i ck on [Next ] t o c on t in ue. Note : Wh en ent er in g a KML or KM n a m e, th e pa th does n ot n eed t o be en t er ed an d th e ext en si on shoul d be l eft out . By de fa ul t , Bl a ck out KM for PAT RO L wi l l r ea d th e fi l e fr om t h e %PATROL_HOME% di r ect or y. Al so, m a ke sur e you sel ect ed t h e a ppr opr ia t e t yp e of obje ct (KML or KM). 4. 2 - Pl an n i ng th e start o f th e Bl acko u t Bl a ck out KM for PAT ROL a l l ows se ver a l wa ys t o pl a n th e st a r t of a bl a ck out . You ca n ei t h er sch edul e t h e st a r t of a bl a ck out by t i m e pe r i od s, by m on i t or in g th e st a t us of a n ext er na l c om pon en t (pr oce ss, fi l e or NT ser vi ce) or by a m an ua l com m a n d. In a ddi t i on, r ecurr in g bl a ck out s a r e possi bl e. T h e in for m a t i on t o pr ovi de d ep en ds on t h e sch edul e t ype. It i s det a i l ed i n th e fol l owi n g se ct i on s. 18 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Start: n o w T h e bl a ckout wi l l st ar t a s soon a s th e Bl a ckout wi z ar d i s fi n i sh ed. No fur t h er in for m a t i on a bout t he st a r t of t h e bl a ck out i s r equir ed. T h e bl a ckout wi l l n ot be s ch edul ed t o st a r t a ga in . As soon a s i t i s fi n i sh ed, th e PAT ROL i n st an ce r epr esen t i n g t h e b l a c k o u t i s p a u s e d a n d t h e l a b e l “ ( a l r e a d y e x e c u t e d ” ) i s a d d e d t o i t s n a m e . T o r est a r t a bl a ckout wh i ch sch edul e wa s s ch edu l ed for “ n o w ” , e d i t t h e b l a c k o u t a n d c h a n g e i t s s t a r t i n g sch edul e. Note : A s t a r t i n g s c h e d u l e o f t y p e “ n o w ” i s a c t u a l l y c o n s i d e r e d b y B l a c k o u t K M f o r P A T R O L a s a “ o n e s h o t ” sch edul e wh i ch st art in g da t e i s th e curr en t da t e an d t i m e. Start: o n a g i ven d ate T h e bl a ckout wi l l st a r t a t th e dat e a n d t im e provi de d i n th e pan el di spla yed on th e l eft . Si m pl y sel ect t h e m on th , da y of t h e m on th , ye a r an d t i m e a t wh i ch t h e Bl a ck out wi l l st a r t an d cl i ck t h e [Next ] but t on . T h i s i s a “ o n e s h o t ” b l a c k o u t . T hi s m ea n s tha t th e bl a ck out wi l l n ot be sch edul ed t o st a r t a gain . As s oon a s i t i s fi n i sh ed, th e PAT RO L i n st a n ce r epr esen t in g t h e bl a ckou t i s p a u s e d a n d t h e l a b e l “ ( a l r e a d y e x e c u t e d ” ) i s a d d e d t o i t s n a m e . T o r est a r t a bl a ckout wh i ch wa s s ch edul ed t o b e “ on a gi ven da t e, ” edi t th e bl a ck out a n d cha n ge i t s st a r tin g sch edul e. Usi n g thi s m eth od, i t i s possi bl e t o pl a n a bl a ckout up t o a yea r ah ea d. Start: d ai l y at a g i ven ti me T hi s t yp e of bl a ck out s ch edul i n g i s a r ecurr in g e ven t t h a t wi l l occur e ver y da y a t t h e spe ci fi ed t i m e. E nt er th e t i m e of t h e da y a t wh i ch t h e bl a ckout wi l l st a r t an d cl i ck [Next ]. Note : T i m e i s in a 24 h our for m a t. 19 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Start: w eekl y at a g i ven ti me T hi s m et h od a l l ows a bl a ck out t o r un ever y we ek a t on e or m or e speci fi ed da ys a n d t im e. Sel e ct t h e l i st of da ys a s wel l a s t h e t im e a t wh i ch t h e bl a ck out wi l l st a r t an d cl i ck [Next ] t o c on t in ue. Note : T i m e i s in a 24 h our for m a t. Start: mo n th l y o n a g i ven d ay an d ti me T hi s i s t h e wa y t o s ch edul e a bl a ck out on a gi ven da y a t a speci fi ed t i m e. Sel e ct t h e da y of t h e m on t h a s wel l a s t h e t i m e a t wh i ch you wa n t th e bl a ckout t o st a r t an d cl i ck [Next ] t o c on t in ue. Note : T i m e i s in a 24 h our for m a t. Imp or tant: You ca n sch edul e t h e bl a ckout t o st a r t on th e l ast da y, or t h e da y be for e t h e l a st da y, of t h e m on th by sel e ct i n g th i s opt i on fr om th e dr opdown m en u. 20 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Start: u p o n manu al start (fro m th e Co n so le) In th i s ca se, n o sch edul e i s a ct ua l l y pl a nn ed. T h e bl a ckout st a r t s fr om a m an ua l com m an d on l y. T o st a r t th e bl a ck out , r i gh t -cl i ck t h e bl a ck out P AT RO L i n st a n ce fr om t h e PAT ROL Con sol e a n d sel ect “ K M C o m m a n d s → A c t i o n → S t a r t n o w ” . T hi s m et h od of st a r t in g a bl a ckout i s wel l sui t ed for bl a ck out s t h a t n eed on l y be st a r t ed occa si on a l l y. Start: u p o n p resen ce/ ab sen c e o f a fi l e Sel e ct i n g t hi s opt i on a l l ows you t o set Bl a ck out KM for PAT RO L t o st a r t th e bl a ckout wh en a fi l e i s pr esen t or mi ssi n g. E nt er th e fi l e na m e, pr eced ed by t h e pa t h t o t h e fi l e, a n d sel ect wh et h er th e bl a ckout sh oul d s t a r t w h e n t h e f i l e a c t u a l l y e x i s t s ( “ p r e s e n t ” ) o r d o e s n o t e x i s t ( “ a b s e n t ” ) . T h en , cl i ck on [Next ] t o c on t in ue. Note : T h e pr esen ce or a bs en ce of a fi l e does n ot a l wa ys m ea n t h e bl a ckout wi l l st a r t. If t h e bl a c kout i s m an ua ll y st opp ed t hr ough KM Com man ds or i s st opp ed be ca use a t i m eout i s r ea ch ed, Bl a ckout KM for PAT RO L wi l l wa i t for th e fi l e t o ch an ge st a t us t wi c e be for e st a r tin g a ga in . Thi s i s don e t o m ake sur e t h e bl a ckout does n ot r est a r t r i gh t a wa y wh en it is st opp ed a bn or m a l l y. Exa mpl e : T h e b l a c k o u t s h o u l d s t a r t w h e n t h e f i l e “ C : \ M yA ppl i ca t i on \b a c k u p . l o g ” i s p r e s e n t . At on e poi n t , Bl a ckout KM for PAT RO L det e ct s t ha t t h e fi l e h a s been cr ea t ed a n d st ar t s th e bl a ckout o f t h e a ppli ca t i on m oni t or in g. Th en, th e PAT RO L a dm in i str at or man ua l l y st ops t h e bl a ck out t h r ough th e c om m an d m en u, or a speci fi ed t i m eout i s r ea ch ed an d th e bl a ckout a ut om a t i ca l l y st ops. E ven t h ough th e fi l e i s st i l l pr esen t , th e bl a ck out wi l l n ot r e -st a rt r i gh t a wa y. Bl a ck out KM for PAT RO L w i l l t r a c k t h e f i l e ’ s s t a t u s a n d t h e b l a c k o u t w i l l a u t o m a t i c a l l y s t a r t a g a i n on l y a ft er th e fi l e i s rem oved a n d cr ea t ed a gain . 21 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Start: u p o n start/ sto p o f a p ro cess Oft en t i m es, a bl a ckout of a n a ppli ca t i on m on i t or in g sh oul d st ar t a s soon a s an oth er a ppl i ca t i on (such a ba ckup a ppl i ca t i on ) i s l a un ch ed. Such a ppli ca t i on s h a ve pr oce ss es so i t woul d be a g ood i d ea t o s et t h e Bl a ck out KM t o r un a bl a ckout wh en a pr oce ss i s foun d. On th e ot h er h a n d, it i s a l so p ossi bl e t o st a r t th e bl a ckout wh en th e a ppl i ca t i on i s st opped a n d it s pr oces se s a r e n ot r unn in g an ym or e. T hi s i s th e pur pose of t h i s pan el . Sim pl y en t er a r egul ar expr essi on m a t ch in g th e p r o c e s s ’ n a m e y o u w a n t t o m o n it or an d s e l e c t w h e t h e r t h e b l a c k o u t s h o u l d s t a r t w h e n t h e p r o c e s s i s “ r u n n i n g ” o r “ n o t r u n n i n g .” Note : T h e pr esen ce or a bs en ce of a pr oce ss doe s n ot a l wa ys m ea n t h e bl a ck out wi l l st a r t . If t h e bl a c kout i s m an ua ll y st opp ed t hr ough KM Com man ds or i s st opp ed be ca use a t i m eout i s r ea ch ed, Bl a ckout KM for PAT RO L wi l l wa i t for th e pr oce ss t o ch a n ge sta t us t wi c e be for e st a r t in g a ga in . Th i s i s don e t o m a ke sur e th e bl a ck out does n ot r est ar t r i ght a wa y wh e n i t i s st opped a bn or m a l l y. Exa mpl e : T h e bl a ckout sh oul d s t a r t w h e n t h e p r o c e s s “ m y A p p l i c a t i o n P r o c e s s . e x e ” i s p r e s e n t . At on e p oi n t , Bl a ck out KM for PAT RO L d et e ct s t h a t th e pr oc ess h a s been cr ea t ed a n d st ar t s th e bl a ck out of t h e a ppl i ca t i on m on i t orin g. Th en , th e PAT RO L a dm i n i stra t or m an ua l l y st ops t h e bl a ckout t hr ough th e com m a n d m en u, or a speci fi ed t i m e out i s r ea ch ed an d th e bl a ck out a ut om a t i ca l l y st op s. E ven t h ough th e pr oces s i s st i l l pr esen t , th e bl a ckout wi l l n ot r e -st a r t r i ght a wa y. Bl a ck out KM for P A T R O L w i l l t r a c k t h e p r o c e s s ’ s s t a t u s a n d t h e b l a c k o u t w i l l a ut om a t i ca l l y st a r t a ga in onl y a ft er th e pr oce ss i s st opp ed a n d la un ch ed a gain . 22 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Start: u p o n start/ sto p o f a NT servi ce Sel e ct i n g th i s opt i on m ea n s th at you wa n t t h e bl a ckout t o st a r t wh en a speci fi ed NT ser vi c e en t er s a speci fi ed st a t e. Bl a ck out KM f o r P A T R O L r e a d s t h e s e r v e r ’ s c on fi gur a t i on an d r et ri eves t h e l i st of i n st al l ed ser vi ce s. Sel e ct a s er vi c e n a m e fr om t h e dr opd own l i st of s er vi c es a n d pi ck wh i ch ser vi ce st a t e wi l l t r i gger th e bl a ckout : i s st a rt ed an d r unnin g i s n ot st opped pa used, et c) (st a r t ed, pen di n g, i s n ot st ar t ed pa used, et c. ) (st opped, pen di n g, i s st opped Bl a ck out KM for PAT RO L wi l l m on i t or th e speci fi ed s er vi ce a n d st ar t th e bl a ckout a s soon a s th e ser vi c e en t er s th e speci fi ed st a t e. Note : T hi s opt i on i s on l y a va i l a bl e on PAT ROL A g en t s r unnin g on Mi cr os oft Wi n dows. Note : T h e fa ct t h a t th e m on i t or ed ser vi c e st a t us a n d t h e st a t us en t er ed m at ch does n ot a l wa ys m e a n th e bl a ck out wi l l st a r t . If th e bl a ck out i s m a n ua l l y st opp ed t h an ks t o a KM C om m an ds or i s st opp ed beca us e a t i m eout i s r ea ch ed, Bl a ck out K M for PAT ROL wi l l wa i t for th e ser vi ce t o ch a n ge st a t us t wi c e be for e st a r tin g a ga in. Th i s i s don e t o m a ke sur e t h e bl a ckout d oes n ot r est a r t ri gh t a wa y wh en i t i s st opp ed a bn or m a ll y. Exa mpl e : T h e bl a ckout sh oul d st a rt wh en th e pr oces s “ m y A p p l i c a t i o n Ser vi c e” i s r unnin g . At on e p oi n t , Bl a ck out KM for PAT RO L d et e ct s t ha t th e ser vi ce h a s been st a r t ed a n d st ar t s th e bl a ckout of t h e a ppl i ca t i on m on i t orin g. Th en , th e PAT RO L a dm i ni st ra t or man ua ll y st ops t h e bl a ck out t hr ough th e c om m an d m en u, or a speci fi ed t i m eout i s r ea ch ed an d th e bl a ckout a ut om a t i ca l l y st ops. E ven t h ough th e ser vi ce i s st i l l r unn in g , th e bl a ckout wi l l n ot r e -st a rt r i gh t a wa y. Bl a ck out KM for PAT RO L wi l l t r a ck t h e ser vi ce’ s s t a t u s a n d t h e b l a c k o u t w i l l a u t o m a t i c a l l y s t a r t a g a i n o n l y a f t e r t h e ser vi c e i s st opped a n d la un ch ed a gain . 4. 3 - Pl an n i ng th e end o f a b l acko u t T h e n ext st ep of t h e wi z a r d con si st s i n con fi gur i n g Bl a ckout KM for PAT RO L t o a ut om a t i ca l l y s t op t h e bl a ck out . Al t h ough i t i s possi bl e t o m a n ua ll y s t op a bl a ck out t hr ough th e KM C om m a n ds, a bl a ckout sh oul d a t t h e ver y l ea st h a ve a t i m e out t h a t wi l l a ut om a t i ca l l y st op t h e bl a ck out a n d pi ck up t h e m on i t or in g wh er e i t st opped . 23 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Wh a t wi l l st op a bl a ck out d epen ds on wh a t st ar t ed i t . If a bl a ck out st a r t i s t i m e depen da n t, you a r e r equir ed t o spe ci fy a t i m e a t wh i ch th e bl a ck out wi l l st op. I f a bl a ck out st a r t depen ds on a fi l e, p r oce s s or NT s e r v i c e s t a t u s , t h e b l a c k o u t w i l l s t o p w h e n t h e m o n i t o r e d i t e m ’ s s t a t e c h a n g e s t o t h e opp osi t e of wh a t st ar t ed th e bl a ck out . T h er efor e, i f for exa m pl e, a bl a ckout sh oul d st a r t wh en a speci fi ed fi l e i s pr esen t , th e bl a ck out wi l l a ut om a t i ca l l y st op wh en t h e fi l e d oes n ot exi st a n ym or e. In th i s scen a ri o, i t i s a l so possi bl e t o spe ci fy a da t e a n d t im e th a t, wh en r ea ch ed, wi l l a ut om a t i ca ll y st op t h e bl a ck out . Si n ce t h e in for m a ti on tha t wi l l ca use ch an ges depen d s on th e opt i on sel ect ed t o st a r t th e bl a ck ou t , th er e a r e t wo di ffer en t pan el s. En d o f a b l acko u t at a gi ven ti me If t h e bl a ck out st a r t s a t a gi ven da t e an d t im e, wh eth er th i s i s an r ecur rin g even t or n ot , th e pan el bel o w i s di spl a yed. In thi s pan el , you a r e a sked t o sp e ci fy ei t h er a t i m eout or a t i m e a t wh i ch th e bl a ckout wi l l en d. By de fa ul t , t h e bl a ckout wi l l l a st four h our s but i t i s p ossi bl e t o sel ect fr om t h e dr op down m en u t o st op t h e bl a ck out : “ a f t e r ” a speci fi ed n um ber of h our s, m in ut es and sec on ds. Bl a ck out KM for PAT RO L wi l l wa i t for th e gi ven t i m e an d st op t h e bl a ckout . “ t h e s a m e d a y a t ” a s p e c i f i e d t i m e . I n t h i s c a s e , “ h o u r s ,” “ m i n u t e s ” a n d “ s e c o n d s ” a r e u s e d t o en t er th e t i m e a t wh i ch th e bl a ck out wi l l st op. T h e bl a ck out wi l l st op t h e sa m e da y i t wa s st a r t ed a t th e speci fi ed t i m e. “ t h e d a y a f t e r a t ” a s p e c i f i e d t i m e . I n t h i s c a s e , “ h o u r s ,” “ m i n u t e s ” a n d “ s e c o n d s ” a r e u s e d t o en t er th e t i m e a t wh i ch th e bl a ck out wi l l st op. Th e bl a ck out wi l l st op t h e da y a ft er a t t h e spe ci fi ed t i m e. “ t w o d a y s a f t e r a t ” a s p e c i f i e d t i m e . I n t h i s c a s e , “ h o u r s ,” “ m i n u t e s ” a n d “ s e c o n d s ” a r e u s e d t o en t er th e t i m e a t wh i ch t h e bl a ck out wi l l st op . T h e bl a ck out wi l l st op t wo da ys l a t er a t t h e spe ci fi ed t i m e. “ t h r e e d a y s a f t e r a t ” a s p e c i f i e d t i m e . I n t h i s c a s e , “ h o u r s ,” “ m i n u t e s ” a n d “ s e c o n d s ” a r e u s e d t o en t er th e t i m e a t wh i ch th e bl a ck out wi l l st op. Th e bl a ck out wi l l st op t h r ee da ys l a t er a t th e spe ci fi ed t i m e. Note : If a bl a ck out st a r t s a t a gi ven da y a n d t im e, i t m a y l a st a s l on g a s 3 da ys, 23 h our s, 59 min ut es a n d 59 se c on ds. En d o f a b l acko u t w h en an even t o ccu rs o r at a sp eci fi ed ti me If you sel ect ed t h at th e Bl a ckout sh oul d st a rt upon th e pr esen ce of a fi l e, pr oce ss or NT Ser vi c e, Bl a ck out K M for PAT RO L wi l l a ut om a t i ca l l y en d t h e bl a ck out wh en t h e opp osi t e of t h e st a r tin g c on di t i on i s r ea ch ed. 24 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de So, for exa m pl e, if you sp eci fi ed t h at a bl a ckout sh oul d st a r t wh en the fi l e “ C : \M yA ppl i ca t i on \ B a c k u p . l o g ” e x i s t s , t h e b l a c k o u t w i l l a u t o m a t i c a l l y s t o p w h e n t h e f i l e i s n o t f o u n d a n ym or e. Al t ern a t i vel y, i t i s possi bl e t o sp eci fy a t i m eout t ha t , wh en r ea ch ed, wi l l st op th e bl a ckout . By de fa ul t , a t im eout i s sel ect ed a n d th e bl a ck out wi l l l a st four h our s . Howe ver , i t i s pos si bl e t o st op t h e bl a ck out by s el e ct i n g fr om t h e dr op down : “ a f t e r ” a speci fi ed n um ber of h our s, m in ut es and sec on ds. Bl a ck out KM for PAT RO L wi l l wa i t for th e gi ven t i m e an d st op t h e bl a ckout . “ t h e s a m e d a y a t ” a s p e c i f i e d t i m e . I n t h i s c a s e , “ h o u r s ,” “ m i n u t e s ” a n d “ s e c o n d s ” a r e u s e d t o en t er th e t i m e a t wh i ch th e bl a ck out wi l l st op. T h e bl a ck out wi l l st op t h e sa m e da y i t wa s st a r t ed a t th e speci fi ed t i m e. “ t h e d a y a f t e r a t ” a s p e c i f i e d t i m e . I n t h i s c a s e , “ h o u r s ,” “ m i n u t e s ” a n d “ s e c o n d s ” a r e u s e d t o en t er th e t i m e a t wh i ch th e bl a ck out wi l l st op. Th e bl a ck out wi l l st op t h e da y a ft er a t t h e spe ci fi ed t i m e. “ t w o d a y s a f t e r a t ” a spe ci fi ed t i m e. In th i s c a s e , “ h o u r s ,” “ m i n u t e s ” a n d “ s e c o n d s ” a r e u s e d t o en t er th e t i m e a t wh i ch t h e bl a ck out wi l l st op . T h e bl a ck out wi l l st op t wo da ys l a t er a t t h e spe ci fi ed t i m e. “ t h r e e d a y s a f t e r a t ” a s p e c i f i e d t i m e . I n t h i s c a s e , “ h o u r s ,” “ m i n u t e s ” a n d “ s e c o n d s ” a r e us ed t o en t er th e t i m e a t wh i ch th e bl a ck out wi l l st op. Th e bl a ck out wi l l st op t h r ee da ys l a t er a t th e spe ci fi ed t i m e. 4. 4 - Sel ecti n g th e b l acko u t typ e Bl a ck out KM for PAT ROL offer s four di ffer e n t t yp e s of bl a ck out . Beca us e of t h e wa y Kn owl edge Modul es a r e bui l t , ea ch t yp e of bl a ck out h a s a dva nt a ges a n d dr a wba cks. T h er e i s n o si n gl e wa y t h at wi l l wor k on ever y Kn owl edg e M odul e for PAT ROL. 25 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Be for e sel ect i n g t h e t yp e of bl a ck out t o p er for m , i t i s ve r y i mpor tant t hat y ou c ar e ful l y r e ad the i nfor mati on be l ow a n d get a s m uch in for m a t i on a s possi bl e on t h e wa y t h e KM you wa n t t o bl a ckout wor ks. 1. Total bl ac k out (r e c omme nde d me th od) : di sa bl e bl ack e d -out c l asse s T hi s m et h od di sa bl e s t h e sel ect ed cl a ss ( KM) or t h e cl a ss a ss oci a t ed wi t h t h e i n st an ce t o bl a ck ou t . E a ch bl a ck ed- out i n st an ce di sa pp ea r s fr om t h e PAT ROL C on s ol e a n d n o m on i t or in g i s per for m ed. T hi s i s t h e m ost r el i a bl e wa y of bl a ck i n g-out a n d th e r ecom m en ded m eth od. T h e dr a wba ck i s, si n ce t h e en t ir e cl a ss (KM) i s di sa bl ed, a l l cl a ss i n st an ces a r e r em oved fr om t h e PAT RO L C on s ol e a n d th ei r m on it or in g i s st opp e d. In ot h er wor ds, i t i s n ot p ossi bl e t o bl a ck out a si n gl e i n st an ce of a cl a ss usi n g th i s m et h od. 2. No c ol l e c t: di sabl e al l c ol l e c tor s i n the bl ack e d-out c l asse s and i nsta nc e s T hi s t yp e of bl a ck out di sa bl es a l l col l e ct or s in th e sel ect ed cl a s s es a n d in st an ces. Th i s wa y, c ol l ect i n g i s n o l on ger per for m ed . Th er efor e, th er e ca n be n o a l er t tr i gger ed by t h e bl a ck ed - out Kn owl edge Modul e. Usi n g t hi s m eth od, a sin gl e in stan ce of a cl a ss ca n be bl a cked - out wh i l e ot h er s ar e st i ll bei n g m on i t or ed. Howe ver , i f a Kn owl edg e M odul e for PAT RO L dyn a m i ca l l y a ct i va t es/ dea ct i va t e s c ol l e ct or s, th i s m et h od of bl a ck i n g-out t h i s pa r t i cul ar KM wi l l n ot wor k. T h e col l e ct or s t h a t ar e dea ct i va t ed a t t h e st a r t of t h e bl a ck out wi l l in deed be r ea ct i va t ed by t h e KM dur in g th e di scover y per i od for i n st an ce. For exa m pl e, bl a cki n g-out a fi l e s yst em m on i t or i n g per for m ed by PAT ROL for Wi n dows KM for PAT RO L or PAT ROL for UNIX KM for PAT RO L i s n ot possi bl e u s i n g t h e “ N o c o l l e c t ” m e t h o d . Ve r y i mpor tant: Wh i l e th e ot h er bl a ckout m et h ods i m pl y t h a t you di r ect l y s el e ct t h e obj e ct s t o bl a ck out i n th e Bl a ckout wi z a r d, th e wa y t h e obj ect s t o bl a ck out a r e pi c ked u s i n g t h e “ N o c o l l e c t ” m e t h o d i s a l i t t l e d i f f e r e n t . Si n ce t h e i n st an ces a n d cl a sses for wh i ch you w i sh t o pa use t h e m on i t or in g wi l l n ot a ct ua l l y be t h e on es t ha t a r e bl a cked - out , but r ath er th e col l ect or s, you n eed t o s el ect t h e in st an ces or cl a sses t h a t con t a in s t h e col l ect or . Th er e i s i n deed n o wa y for t h e Bl a ckout K M t o d et er m in e wh i ch col l e ct or i s a s s oci a t ed wi t h an in st an ce. T hi s ca n be t ri ck y si n ce s om et i m es, t h e col l e ct or get t i n g th e da t a for a par am et er i s n ot foun d in th e p a r a m e t e r ’ s c l a s s b u t i n a di ffer en t cl a ss i n stea d. In th i s ca se, you woul d n eed t o s el e ct t he cl a s s c on t a in in g th e col l e ct or fr om t h e obje ct s t o bl a c kout a n d n o t t h e p a r a m e t e r ’ s c l a s s . So, for ea ch par a m et er t o bl a ck out you n eed t o: f i n d t h e p a r a m e t e r ’ s c o l l e c t o r b y c h e c k i n g t h e K n o w l e d g e M o d u l e d o c u m e n t a t i o n ( “ R e f e r e n c e Gui de” ) sel e ct t h e c ol l e ct or i t sel f a n d not t h e i n st an ce t o bl a ck out fr om t h e l i st of obj ect s t o bl a ck out i n t h e Bl a ckout wi z a r d. T h e Bl a ckout KM wi l l t r y t o fi n d th e col l ect or of t h e i n st an ces t o bl a ck out wh en you cl i ck on t h e [Next ] but t on . If i t ca nn ot fi n d th e col l e ct or of on e or m or e obj ect s t o bl a ck out , a wa rnin g m essa ge i s di spl a yed l et t i n g you kn ow t h a t th e obj ect s m a y n ot be bl a cked - out . Wh en th e bl a ck out st a r t s a n d Bl a ckout KM for PAT RO L ca nn ot fi n d a c ol l ect or for a sp eci fi ed i n st an ce or cl a ss t o bl a ck out , t h e wa rn in g m essa ge bel ow i s di s p l a y e d i n t h e P A T R O L C o n s o l e ’ s s y s t e m o u t p u t wi n dow: “ C o ul d n o t f in d c o ll e ct o r f or th e i n sta n c es li s te d b e lo w .T h es e i n st a nc e s w ill n ot b e bl a ck e d- o ut . 26 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de P l e as e , ch e ck t h e bl a ck o ut s e tt i ng s a n d m ak e s ur e y ou s e le c te d t h e ap p rop r i at e i n s ta n ce to bl a ck o ut (t h e o ne co n ta in i n g t he co l le c to r ). Se e t h e H el p f il e fo r m o r e i nf o rm a ti o n. I n s ta n ce s t h at ar e n o t b la c ke d -o u t: ” In a d d i t i o n , a n e v e n t i s g e n e r a t e d a n d t h e B l a c k o u t “ S t a t u s ” p a r a m e t e r t r i g g e r s a w a r n i n g . 3. No par a me te r : di sabl e al l par ame te r s i n the blac k e d-out c l asse s and i nsta nc e s T hi s bl a ck out m et h od, wh i ch con si st s of di sa bl i n g a l l para m et er s in th e bl a ck ed - out cl a ss es a n d i n s t a n c e s , i s p r o b a b l y t h e m o s t “ n a t u r a l ” o f a l l b l a c k o u t s . B y d i s a b l i n g t h e p a r a m e t e r s , B l a c k o u t K M f o r PAT RO L en sur es t h at al l bl a cked -out pa r a m et er s ca nn ot tr i gger an a l er t sin ce th e y h a ve n o va l u e. Be wa r y t h ough , th a t som e Kn owl edg e M odul es d yn a m i ca l l y upda t e t h e st a t us of t h ei r par am et er s, usua l l y dur in g r ecurr in g di scover i es, an d ma y en a bl e a par a m et er th at h a s been di sa bl ed by Bl a ckout KM for PAT ROL. T h i s, in ess en ce, wi l l ca n cel t h e bl a ck out a n d a l er t s m a y be t r i gger ed e ven t h ough th e bl a ck out i s r unnin g. So, be for e sel ect i n g t h i s bl a ckout m et h od, m a ke sur e t h a t th e bl a ck ed - out KM s et t h e para m et er sta t us dur in g th e in i ti a l di scover y on l y a n d n ever a ga in a ft er wa r ds. Appl i ca t i on Sen tr y KM for P AT ROL r un s a ful l di scover y e ver y h our th a t ch ecks t h e par am et er st a t us a n d ena bl e/ di sa bl e t h ese pa r a m et er s depen di n g on t h e i n for m a t i on foun d i n th e con fi gur a t i on . Th i s m e a n s t h a t t h e “ N o p a r a m e t e r ” m e t h o d w i l l n o t w o r k w i t h A p p l i c a t i o n S e n t r y a s a d i s c o v er y wi l l en a bl e pa ra m et er s di sa bl ed by Bl a ck out KM for PAT RO L. 4. No thr e sh ol d s: r e move al l thr e shol d s i n bl ac k ed -out c l asse s and i nstanc e s T hi s t ype of bl a ck out r em oves t h r esh ol ds fr om t h e sel e ct ed cl a ss es a n d i n st an ces dur i n g th e bl a ckou t per i od. So, wh i l e c ol l ect s a r e st i l l bei n g per for med a n d par a m et er va l ues a r e upda t ed n or ma l l y, no a l er t i s t r i gger ed beca us e t h e t hr esh ol ds h a ve be en rem oved fr om t h e pa ra m et er s. Thi s ca n be us e fu l i f you wa n t t o ch eck t h e m oni t or in g da t a a ft er th e bl a ckout per i od. T h e dr a wba ck of t h i s m et h od i s tha t som e Kn owl edge M odul e s d yn a m i ca l l y s et t h e para m et er thr esh ol ds r egul ar l y wh i ch can cel s t h e bl a ck out e ffe ct . So, wh i l e t h e bl a ckout i s st a r t ed an d thr esh ol ds h ave be en r em oved, a bl a cked - out KM m a y set t h e par am et er s thr esh ol ds ba ck. T hi s m et h od m a y n ot wor k wi t h Ha r dwa r e S en t ry KM for PAT ROL si n ce t h r esh ol ds a r e d yn a m i ca l l y set a t e a c h d i s c o v e r y d e p e n d i n g o n t h e m a n u f a c t u r e r ’ s a g e n t i n f o r m a t i o n . Imp or tant A ba ckup of t h r esh ol ds i s per for m ed be for e t h e rem ova l . T h e ba ckup en sur e s t h a t thr esh ol ds a r e n ot l ost i f t h e PAT ROL Ag en t i s st opped or th e ser ver r est a r t ed, for exa m pl e. I f t hi s sh oul d h a ppen , an d a s soon a s t h e PAT ROL Ag en t i s up an d r unn in g a ga in, t hr esh ol ds ar e set ba ck s o t h a t your m on i t or ing i s n ot a l t er ed. In a ddi ti on , a ba ckup fi l e c on t a in in g a l l th e thr esh ol ds be for e t h ei r r em ova l i s cr ea t ed un der th e na m e: % P A TR O L_ H OM E /S E N_ B O_ L OG / SE N _B O _< b la c kou t ID > _b a ck u p_ < st a rt i ng ti m e> _ . cf g T h i s “ . c f g ” f i l e c a n b e r e a d b y P A T R O L w p c o n f i g a n d x p c o n f i g a n d d i r e c t l y a ppl i ed t o t h e P AT RO L a gen t t o r est or e t hr esh ol ds, i f an y t h r esh ol d l oss sh oul d oc cur . Pl ea se, see t h e PA TR OL A ge nt Ref e re nc e Manual for m or e in for m a t i on a bout wp c on fi g a nd xpcon fi g. Conc l usi on T h e on l y bl a ck out m et h od t h a t i s guar an t eed i s t h e on e t h a t dea ct i va t es t h e cl a ss es t o bl a ck out , wh i ch i s “ t o t a l b l a c k o u t .” A l l t h e o t h e r m e t h o d s m a y h a v e t h e i r b l a c k o u t e f f e c t c a n c e l e d d e p e n d i n g on t h e wa y t h e KM t o bl a ck out i s b u i l t . S o , s e l e c t i n g a n y o t h e r m e t h o d t h a n “ t o t a l b l a c k o u t ” i m p l i e s t h a t y o u h a v e a good un der st an din g of t h e KM t o bl a ck out t o m a ke sur e th e bl a ck out i s n ot can cel ed dur in g oper a t i on . 27 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de T h e m et h ods t ha t ar e we r ec om m en d ed: t o b l a c k o u t a w h o l e K M o r a l l i n s t a n c e s o f a c l a s s : “ t o t a l b l a c k o u t ” t o b l a c k o u t s i n g l e i n s t a n c e s o f a c l a s s : “ n o t h r e s h o l d s ” Fi n al l y, Sen t r y S oft wa r e gua r ant ees t h a t n o a l er t wi l l be t r i gger ed durin g th e bl a ckout per i od. Howe ver , a l er t s tri gger ed be for e or a ft er a bl a ckout wi l l n ot be bl a cked - out . Sel e ct t h e bl a ckout m et h od a n d cl i ck [Next ] t o pr oce ed t o t h e en d of t h e Bl a c k out wi z a r d. 4. 5 - Nami n g th e b l acko u t T hi s i s t h e l a st st ep of t h e wi z a r d in wh i ch you n am e t h e bl a ck out sch edul i n g you a r e a bout t o cr ea t e. T h e in stan ce cr ea t ed i n th e PAT RO L Con sol e wi l l be n a m ed a ft er wh at you en t er in th i s pan el . E nt er th e bl a ck out n am e in th e box a n d cl i ck [Fi n i sh ] t o fi n i sh th e Bl a ck out wi z a r d. T h e l a b e l “ B l a c k o u t : “ w i l l b e a d d e d a t t h e fr on t of t h e bl a ck out n am e so t h a t you ca n qui ckl y i den t i fy t h e pur pos e of t h e i n st an ce i n th e PAT ROL C on sol e. T h e in stan ce r epr esen t in g th i s n ew bl a ck out sch edul e i s cr ea t ed un der t h e m ain Bl a ckout i n st an ce in th e PAT RO L Con s ol e. I f t h e b l a c k o u t m e t h o d y o u s e l e c t e d i s “ T o t a l b l a c k o u t ” a c h e c k b o x a p p e a r s a t t h e b o t t o m o f t h e p a n e l wh i ch a l l ows you t o p er for m a ful l di s c over y a t t h e en d of t h e bl a ck out p er i od. T h i s i s h i gh l y r ecom m en ded si n ce t h e bl a cked - out i n st a n ces a re r em oved fr om t h e PAT RO L C on sol e a t t h e t ime of t h e bl a ck out a n d wi l l n ot be r e -cr ea t ed un ti l th e n ext di scover y of t h e bl a cked - out KM. Ch ecki n g th i s box en sur es t ha t a l l bl a cked - out i n st an ces a r e r e-cr ea t ed i n th e PAT RO L Con s ol e a t th e en d of t h e bl a ck out a n d th a t th e m oni t or in g ca n resum e n or m a l l y. If a n ot h er bl a ckout m et h od wa s sel ect ed, th i s check box i s n ot a va i l a bl e. 28 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 5 - Modifyi ng a Blackout config uratio n It i s p ossi bl e t o m odi fy a bl a ck out c on fi gur a t i on a t a n y t i m e. An y of t h e opt i on s, i n cl udi n g th e sch edul e or th e PAT ROL obje ct s t o bl a ck out , ca n be m odi fi ed. T o ch an ge a bl a ck out , r i gh t -cl i ck t h e bl a ck out i n st an ce i n th e PAT ROL C on s ol e a n d sel e ct “ K M Comma nds → E d i t … ” a s s h o w n o n t h e pi ct ur e. T h e Bl a ckout wi z a r d com es up a n d a l l ows you t o g o t h r ough a l l th e st eps a n d m odi fy t h e c on fi gur a t i on a s you pl ea se. For m or e i n for m a ti on on ea ch st ep of t h e B l a c k o u t w i z a r d , p l e a s e s e e “ 4 - Pl anni ng a B l ac k out ” . Ch an ges ar e a ppl i ed r i gh t -a wa y un l ess t h e m odi fi ed bl a ck out i s cur r en t l y st a r t ed. In th i s ca se, t h e ch an ges wi l l be a ppl i ed a t t h e en d of t h e bl a ckout . 29 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 6 - Remo ving a blackout Bl a ck out KM for PAT RO L pr ovi des a si m pl e wa y of r em ovi n g a bl a ckout . By sel ect i n g th i s opt i on , you d el et e t h e bl a ck out fr om t h e PAT RO L C on sol e a n d th e PAT RO L Ag en t c on fi gur a t i on. In ot h er wor ds, t h e bl a ck out wi l l n ot st ar t a gain an d th er e i s n o wa y t o r et r i eve a del et ed bl a ck out . So pl ea se, us e t h i s opt i on ca r eful l y. T o d el et e a bl a ck out , r i ght -cl i ck t h e bl a ck out i n st an ce i n th e PAT RO L C on sol e a n d sel e ct “ K M Comma nds → De l e te ” a s s h o w n o n t h e pi ct ur e. A m essa ge p op s -up, a ski n g you t o c on fi r m th e del et i on of t h e bl a ck out . You ca n st i ll can cel t h e a ct i on a t th i s poi n t by cl i cki n g th e [No] but t on . Con fi r m th e r em ova l of t h e bl a ck out by cl i cki n g on [Yes]. If a bl a ck out i s t a ki n g pl a ce wh en you ch oos e t o del et e i t , t h e c on fi r m at i on m essa ge wi l l i n for m you t h a t th e bl a ckout wi l l be st opp ed be for e bei n g r em oved. T hi s i s don e t o m a ke sur e n o m on i t or in g i s l ost a n d ever yt h in g i s ba ck t o n or ma l befor e del et i n g th e bl a ck out . 30 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Section III - Day-to-day tasks 31 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 1 - Checki ng a blackout state A bl a ck out ca n h a ve four st a t es: Star te d: t h e bl a ckout i s cur r en t l y i n a ct i on an d obje ct s a r e bl a ck ed - out . It s st a t e i s sh own in th e b l a c k o u t n a m e w i t h t h e “ ( s t a r t e d ! ) ” l a b e l . Stoppe d: t h e bl a ck out i s st opp ed, n o obje ct s a r e bl a ck ed - out . T h e bl a ck out i s wa i t i n g for t h e n ext bl a ckout per i od. Pa use d: t h e bl a ck out ca n be ei t h er st ar t ed or st opp ed d epen di n g on t h e st a t e t ha t i t wa s i n wh e n i t wa s su spen ded. It st a t e wi l l n ot ch an ge un ti l th e PAT RO L Adm i n i str a t or r esum es i t s m on i t or in g. Al r e ady e xe c ute d: t h i s o n l y a p p l i e s t o b l a c k o u t s o f t y p e “ o n e s h o t ” o r “ n o w ” . I n t h i s s t a t u s , t h e bl a ck out h a s been exe cut ed a n d i s n ow st opp e d. Th e bl a ckout wi l l n ot r un a ga in unl ess i t i s edi t ed a n d i t s sch edul ed set t i n gs ar e ch an ged. A l l b l a c k o u t s h a v e a p a r a m e t e r c a l l e d “ A c t i v e .” You ca n ch eck wh et h er th e bl a ck out i s st a r t ed or st opp ed r i gh t n ow by l e ft cl i cki n g on th e cros s i c on n ext t o th e bl a ckout n a m e in th e PAT ROL Con s ol e t o expa n d th e obj ec t . T h e par am et er i s th en displ a ye d a n d l eft -cl i ck t h e par a m et er t o see t h e bl a ck out s t a t e gr a ph . W h e n t h e b l a c k o u t i s s t a r t e d , t h e “ A c t i v e ” p a r a m e t e r v a l u e i s “ 1 ” . W h e n i t i s s t o p p e d , i t s v a l u e is “ 0 ” . In a ddi ti on t o sh owi n g t h e cur r en t st a t e of t h e bl a c k o u t , t h e “ A c t i v e ” g r a p h p r o v i d e s a n e a s y w a y t o ch eck t h e bl a ck out st a t e i n th e pa st . It i s possi bl e t o se e wh en th e bl a ckout wa s st a r t ed an d st opped i n t h e pa st h our s, da ys or even m on th s. 32 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Fi n al l y, t h e i n fobox c on t a in s i n for m a t i on a bout t h e l a st bl a ck out a n d i t s cur r en t st a t us. How t o vi e w t h e bl a ck out i n fobox d epen ds on t h e ver si on of t h e PAT RO L Con s ol e s o you ch e ck t h e PAT ROL Con sol e User Gui de for m or e in for m a t i on . T h e in fobox sh ows t h e curr en t st a t us of t h e b l a c k o u t . I t i s e i t h e r “ O N ” ( s t a r t e d ) , o r “ O F F ” ( n o t s t a r t e d ) . T h e pan el al so di spl a ys t h e da t e an d t im e a t wh i ch th e bl a ck out wa s l a st st a r t ed an d st opp ed. 33 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 2 - Ale rts triggered b y a blackout Wh en a bl a ckout st a r t s, a fe w ch eck s a r e ma de to m a ke sur e th e bl a ck out ca n be pr oper l y per for m ed. If on e o f t h e c h e c k s f a i l s t h e B l a c k o u t “ S t a t u s ” p a r a m e t e r t r i g g e r s a n a l e r t . T hr ee pr obl em s ca n be det ect ed dep en din g on th e bl a ck out t ype: Alert severity Blackout type Blackout label Description of the problem Warning No collect collector not found The Blackout KM could not find the collector of an instance that is scheduled to be blacked-out Warning No threshold overlap of no threshold blackout Wh e nt w o “ no thr e s h o l d ” b l a c k o u t t y p e s o v e r l a peach other, time and instance wise (i.e. the second blackout tries to blackout instances that are already blacked-out by the first one). In this case, the second blackout will NOT blackout the instances that are already blacked-out by the first one. This means that the blackout of the overlapping instances may stop sooner than expected in order to avoid threshold loss. Alert No threshold backup failure The blackout KM could not write the file containing the thresholds backup of the PATROL instances to blackout. The blackout is canceled. Wh en an err or oc cur s , th e Bl a ckout KM t a kes t h e fol l owi n g a ct i on s: sen d even t wi t h th e sa m e sever i t y a s t h e a l er t pr in t an err or m essa ge t o t h e PAT RO L c on sol e’ s s yst em out put wi n dow a nn ot a t e th e gr a ph wi t h th e com pl et e des cr i pt i on of t h e err or t h e bl a ck out l a bel i s ch a n ged t o c on t a in a descr i pt i on of t h e er r or for a s l on g a s t h e bl a ck out i s a ct i ve or unt i l th e a l ert i s a ckn owl edg ed (s ee a bove) 34 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 3 - Ack nowledging a blackout alert An err or can oc cur , usua l l y a t t h e st a r t of a bl a ck out , a n d t r i g g e r a n a l e r t o n t h e “ S t a t u s ” pa ra m et er of a bl a ck out . Th e a l er t wi l l ca rr y on un ti l th e bl a ckout st a r t s a ga in an d th e a l ert wi l l be a ut om a t i ca l l y a ckn owl edg ed i f t h e pr obl em i s sol ved. Howe ver , i f t h e pr obl em st i l l exi st s wh en t h e bl a ckout st a r t s a g a i n , t h e “ S t a t u s ” p a r a m e t e r wi l l st a y st i l l be i n al er t m ode. It i s pos si bl e t o m a n ua l l y a ckn owl edg e a n a l ert by r i gh t -cl i ckin g t h e bl a ck out obje ct i n t he P A T R O L c o n s o l e a n d s e l e c t i n g “ K M Comma nd s → A c k n o w l e d g e a l e r t a n d r e s e t . ” D oi n g s o r e s e t s t h e “ S t a t u s ” p a r a m e t e r a n d c a n c e l s t h e a l er t. A con fi r m at i on pan el i s di spl a yed: cl i ck on [Yes] t o a ckn owl edg e t h e a l er t, on [No] t o ca n cel . Pl ea se n ot e t h a t th e pr obl em t h a t tr i gger ed t he a l er t m a y st i l l exi st a n d th e bl a ck out i s l i kel y t o en coun t er th e sa m e pr obl em th e n ex t t i m e it i s sch edul ed t o st a rt . wh i ch wi l l tri gger an an oth er a ler t . C l i c k i n g o n t h e “ A c k n o w l e d g e a l e r t a n d r e s e t ” m e n u w h e n t h e “ S t a t u s ” p a r a m e t e r i s n o t i n a l e r t m o d e di spl a ys a m essa ge l et t i n g you kn ow t h at th er e i s n o a l er t t o a ckn owl edge: 35 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 4 - T emporarily s uspend a blackout schedule Bl a ck out K M for PAT RO L pr ovi d es a n ea s y wa y t o t em p or a ri l y su spen d a bl a ck out s ch edul e. I f, for exa m pl e, a sch edul ed ser ver ba ckup i s exc ept i on a l l y ca n cel ed, i t i s possi bl e t o pa use a bl a ck out s o t h a t th e m on i t or in g i s n ot susp en de d dur in g th e usua l ba ckup h our s. You ca n t h en r esum e t h e bl a ck out s ch edul e wh en t h e usua l ba ckup p er i od i s over . T o pa use a bl a ck out s ch edul e, r i gh t -cl i ck t he bl a ck out i n st an ce i n th e PAT RO L C on sol e a n d s e l e c t “ K M Comman ds → Pa use ” fr om t h e pop up m en u. T h e bl a ckout i c on wi l l be gr a yed out a s in the pi ct ur e bel ow: T h e bl a ckout st a t e wi l l n ot ch an ge un ti l the PAT RO L Adm i n i str a t or r esum es t h e m on i t or ing by r i ght -cl i cki n g th e i n stan ce a ga i n an d sel ect i n g “ K M Comma nds → R e s u m e ” . Imp or tant You sh oul d n ever pa use a bl a ckout sch edul e i f t h e b l a c k o u t i s c u r r e n t l y i n a c t i o n ( “ s t a r t e d ! ” ) . Doi n g so m a y r e sul t i n th e bl a ck out ca r r yi n g ou t a ft er t h e sch edul ed st op t i m e. In ot h er wor ds, t he m on i t or in g per for m ed by PAT RO L m a y n ot wor k pr oper l y. If you ch ose t o pa use a bl a ck out s ch edul e wh e n t h e bl a ckout i s cur r en tl y i n a ct i on , th e fol l owi n g m essa ge p ops -up, a ski n g you t o c on fi r m : Cl i ck on [Yes] t o pa use t h e bl a ck out sch edul e or [No] t o ca n cel . We st r on gl y r ec om m en d tha t you ca n cel a n d m an ual l y st op t h e bl a ckout be for e susp en di n g th e bl a ckout sch edul e. 36 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 5 - Manuall y sta rt or stop a blackout Bl a ck out s ca n be s ch edul ed t o st a r t on a spe ci fi ed da t e a n d t i m e or upon a n ot h er c on di t i on , but t h e y ca n a l so be m a n ua ll y st a r t ed or st opped t h r ough a KM com m a n d. M anual star t St a r tin g a bl a ckout is per for m ed i n depen dent l y of t h e bl a ck out s ch edul e a n d h a s n o i m pa ct on t h e r est of t h e bl a ck out sch edul e. S o, you ca n m an ua l l y st a r t a bl a ck out a t 9 : 00a m , st op i t a coupl e o f h our s l a t er an d i t wi l l st a r t a gain a t 11: 00 pm a s it wa s sch edul ed t o d o. If a bl a ck out i s m a n ual l y st a r t ed, i t s usua l st oppi n g con di t i on st i l l a ppl i es. If a bl a ck out n or m a l l y st ops a t a gi ven t i m e , th e m an ua ll y st a r t ed bl a ck out wi l l a l so st op a t t h e usua l t im e. Ma n ual l y st a r tin g a bl a ckout i s d on e b y r i gh t -cl i ckin g th e bl a ck out i n st a n ce i n th e P A T R O L C o n s o l e a n d s e l e c t i n g “ KM Comman ds → Ac ti on → Star t now. ” E xecut i n g th i s com m a n d wh i l e th e bl a ck out i s a l r ea dy st a r t ed di spl a ys a p op -up t o wa r n s you t h a t th e bl a ckout i s a l r ea dy i n a ct i on : In a ddi ti on , th e fol l owi n g m essa ge i s di spl a yed i n th e PAT RO L S yst em Out put Wi n dow: Blackout [INFOR MATION ]: Bla ckout "B lackout: (s tarted !) " already i n acti on. M anual st op If a bl a ck out i s st a r t ed, i t i s possi bl e n ot t o h a ve t o wa i t for i t s n or m al st op c on di t i on an d man ua ll y st op t h e bl a ck out . By sel ect i n g t h i s opt i on , t h e bl a ck out wi l l st op r i ght a wa y wh et h er i t s st op c on di t ion s a r e m et or n ot . T h e usua l bl a ckout st a r t in g con di t i on wi l l st i l l a ppl y un l ess t h e bl a ck out i s s ch edul ed t o st a r t upon t h e pr esen ce, or a bsen c e, of a fi l e, pr oc e ss or NT se r vi ce. In th i s ca se, Bl a ck out KM for PAT RO L wi l l wa i t for th e m on i t or ed it em t o ch an ge st at us t wi ce be for e st a r t in g a gain . Th i s i s don e t o m a ke sur e th e bl a ck out does n ot r est a r t r i gh t a wa y wh en it i s ma n ua l l y st opp ed. 37 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Ma n ual l y st oppi n g a bl a ckout i s per for m ed by r i ght -cl i cki n g th e bl a ckout i n st an ce i n th e PAT RO L C o n s o l e a n d s e l e c t i n g “ KM Comman ds → Ac ti on → Stop n ow. ” If you t r y t o m a n ua ll y st op a bl a ck out t h a t i s n ot st a r t ed, th e fol l owi n g m essa ge i s di spl a yed i n th e PAT RO L S yst em Out put Win dow: Blackout [INFOR MATION ]: Bla ckout a lready stopp ed. A m essa ge a l so p ops -up: 38 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 6 - Displayi ng information relat i ng to a blackout You ca n di spl a y i n for m a t i on r el a t in g t o a bl a ck out by r i gh t -cl i ckin g th e i n st an ce i n th e P AT RO L C o n s o l e a n d b r o w s i n g t o t h e “ K M Comman ds → S h o w ” m en u. Fr om th er e you ca n sel e ct t o sh ow ei t h er th e bl a ckout set t i n gs or th e curr en t l y bl a cked - out obj e ct s . C l i c k i n g o n “ S e t t i n g s ” o p e n s u p a n e w w i n d o w i n t h e P A T R O L C on sol e. L e ft -cl i ck t h e n ew t a sk t o g et t h e fol l owi n g bl a ck out i n for m a t i on : PAT RO L ID Na m e Li st of obj e ct s t o bl a ck out St a r t con di t i on St op c on di t i on (s) Bl a ck out t yp e C l i c k i n g o n “ S h o w c u r r e n t l y b l a c k e d - out obje ct s” wh en th e bl a ck out i s a ct i ve di spl a ys t h e l i st of bl a ck ed - out obje ct s: 39 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 7 - Exporting a blackout configuration t o a file T h i s o p t i o n p r o v i d e s a n e a s y w a y t o s a v e a P A T R O L A g e n t ’ s c o n f i g u r a t i o n i n e x p o r t i n g i t t o a n o t h e r PAT RO L Ag en t . Th e con fi gur a t i on i s sa ved t o a fi l e t h a t ca n th en be l oa ded on t o a di ffer en t PAT RO L Agen t thr ough th e PAT RO L i n t er fa ce. T h i s m et hod offer s a s i m pl e wa y t o: c o p y a P A T R O L A g e n t ’ s c o n f i g u r a t i o n w i t h o u t g o i n g t h r o u g h t h e h a s s l e o f m a n u a l l y s e t t i n g i t u p m a ke sur e th at bot h con fi gur a t i on s ar e i den ti ca l T o exp or t a con fi gur a t i on t o a fi l e, r i gh t -c l i c k t h e “ B l a c k o u t M a n a g e r ” i c o n i n t h e P A T R O L C o n s o l e a n d sel ect “ K M Comman ds → E x p o r t c o n f i g u r a t i o n t o f i l e … ” T h e pan el bel ow p ops -up, a ski n g you for i n for m at i on : E nt er th e pa th an d fi l e n a m e of t h e fi l e t h a t w i l lc o n t a i nt h eP A T R O LA g e n t ’ s c on fi gur a t i on an d cl i ck th e [OK] but t on . Aft er a fe w s e c on ds, a m essa ge wi l l pop -up t o c on fi r m th at th e fi l e h a s been cr ea t ed a n d t o di spl a y t h e con fi gur a t i on fi l e n a m e. 40 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Note : By d e fa ul t , th e con fi gur a t i on fi l e i s c r e a t e d i n t h e “ %PATROL_H OME%\c onfig ” di r ect or y a n d th e fi l e n a m ed “ SEN_B lackou t_conf igurat ion.cf g ” . If t h e c on fi gur a t i on i s pr et t y l a r ge, i t i s possi bl e t o spl i t t h e con fi gur a t i on in t o se ver a l fi l es. T o d o s o, c h e c k t h e “ S p l i t c o n f i g u r a t i o n i n m u l t i p l e f i l e s i f t h e n u m b e r o f l i n e s i s a b o v e ” a n d e n t e r a m a x i m u m n um ber o f l i n e s p e r c o n f i g u r a t i o n f i l e ( “ 1 0 0 0 ” i s t h e d e f a u l t n u m b e r o f l i n e s ) . E ver y t i m e t h e m a xi m um n um ber of l i n es i s r ea c h ed, Bl a ck out KM for PAT RO L cr ea t es a c on fi g ur at i on f i l e n a m e d “ < e n t e r e d f i l e n a m e > ~ n. c f g ” , w i t h n bei n g th e curr en t fi l e n um ber . 41 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 8 - Enabli ng the Deb ug Mode By d e fa ul t , Bl a ck out K M for PAT ROL s en ds on l y t h e m ost cr i t i ca l i n for m a t i on, wa rn in g and er r or m essa ge s t o t h e S yst em Out put Wi n dow of t h e PAT RO L C on sol es. M ost oft en , t h i s in for m at i on i s a ccur a t e en ough t o en sur e th a t Bl a ckout KM for PAT RO L i s pr oper l y wor kin g. If you en c oun t er a bug a n d wa n t t o r epor t t h at bug t o Sen t r y S oft wa r e, you wi l l be a sked t o en a bl e t h e De bug M ode a n d pr ovi d e t h e debug out put t o t h e Sen tr y S oft wa r e supp or t t ea m. T o en a bl e t h e debug m od e, [r i gh t -cl i ck] th e Bl a ck out Ma n a ger i con an d sel ect “ KM C o m m a n d s → O p t i o n s → D e b u g … ” fr om t h e m en u. Ch eck t h e "Ena bl e de bug" box. By de fa ul t , Bl a ck out KM for PAT RO L wi l l sen d i t s debug out put t o t h e S yst em Out put Wi n dow of t h e PAT RO L C on sol e s. Wh en debuggi n g th e di scover y pr oce ss of t h e Bl a ckout KM a t th e st ar t in g t i m e of t h e PAT RO L Agen t , som e d e bug i n for m a ti on m a y be l ost by t h e P AT RO L C on sol e beca us e i t i s n ot yet c on n ect e d t o t h e PAT RO L Ag en t . In ot h er ca ses, or wh en you wa nt t o t r a ce t h e a ct i vi t y of Bl a ck out KM for PAT RO L dur in g a fe w m in ut es, som e de bug i n for m a ti on ma y be l ost by t h e PAT RO L Con s ol e be ca us e i t s buffer i s ful l . In th ese ca se s, i t can be use ful t o sen d t h e debug out put of Bl a ck out KM for PAT RO L t o a sp eci fi ed fi l e. Note T ha t debug fi l e i s st or ed on th e co m put er wh er e t h e PAT ROL Agen t i s r unnin g War ni ng ! Pa y a t t en t i on t o t h e fi l e si z e! T h e debug out put of Bl a ck out KM for PAT RO L m a y be ver y l a r ge a ft er r unn in g for se ver a l da ys. 42 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de Section IV - Additional information 43 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 1 - Backup, log and tempora ry folder s T h e bl a ckout KM a ut om a t i ca l l y cr ea t es a n d wr i t es th e n ece ssa r y i n for m a t i on t o t h e fol d er ca l l ed: “ % P A T R OL _ HO M E/ S EN _ BO _ LO G ” . T h i s f o l d e r i s u s e d t o s a v e t h r e s h o l d s b e f o r e a “ n o t h r e s h o l d ” b l a c k o u t a s wel l a s t o wr i t e l og i n for m a ti on an d t em por ary fi l es. T h e “ S E N _ B O _ L O G ” d i r ect or y c on t a in s thr ee sub - fol der s: / B ACK UP: t hi s i s t h e di r ect or y t h r esh ol d ba cku ps a r e w r i t t e n . B e f o r e s t a r t i n g a “ n o t h r e s h o l d ” b l a c k o u t , t h e B l a c k o u t K M w r i t e s a b a c k u p f i l e ( “ . c f g ” ) , r e a d a b l e b y PAT RO L wpc on fi g or xpc on fi g, t h at con t a i n s th e r em oved t h r esh ol ds. In ca se a pr obl em oc cur s a n d thr esh ol ds a r e n ot put ba ck a t th e en d of t h e bl a ck out , i t i s possi bl e t o si m pl y a ppl y t h i s thr esh ol d con fi gur a t i on fi l e t o t h e PAT RO L a gen t t o set t h em ba ck. T h e ba ckup fi l es a r e ca l l ed: SE N_BO_< bl a ck out ID> _ba ckup _< st a r t in g t im e> _< st ar t in g da t e> . cfg / LO G : con t ain s l og i n for m a ti on wr i tt en by t h e bl a ckout KM. You m a y be a sked t o s en t th e fi l es c on t a in ed in th i s fol der t o t h e S en tr y S oft wa r e suppor t i f you op en a ca se a ga in st th e bl a ck out KM. / TM P: fol d er con t a in in g var i ous t em por a r y fi l e s used by t h e Bl a ck out KM. T h e Bl a ckout K M a ut om a t i ca l l y cl ea r s a n y fi l e i n th e “ / BACK UP” and “ / LOG” fol der s, wh i ch fi l en a m e s t a r t b y “ S E N _ B O ” a n d l a s t m o d i f i c a t i o n d a t e i s o v e r 3 w e e k o l d . T h i s i s p e r f o r m e d t o a v o i d o v e r fl oodi n g t h e di sk wi t h obs ol et e i n for m a t i on . If you wi sh t o k eep a n y of t h es e fi l e s, you sh oul d ei t h er m ove t h em t o an ot h er fol d er or r ena m e th em . 44 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 2 - Regular exp ressions A r egul ar expr essi on i s a str in g for m a tt ed wi t h a speci fi c s yn t a x. It i s in t en ded t o sel e ct s om e l i nes i n a t ext , wh i ch wi l l m a t ch th e r egul ar expr essi on . Regul a r expr essi on s a r e com m on l y us ed i n pa t t ern ma t chin g, and espe c i a l l y on UNIX s yst em s w i th th e gr ep, a wk an d sed com m a n ds. T h e fol l owi n g t a bl e des cr i be s t h e r egul ar expr essi on s yn t a x th a t i s suppor t ed i n Bl a ckout KM for PAT RO L. Charact er . (dot) M eani ng M a t c h a n y s i n g l e c h a r ac t e r E xamp l e: E r r . . w i l l m a t c h E r r 0 1 , E r r 0 2 or E r r A B , e t c . [xyz] Matc h any char act er in the br ac kets E xamp l e: Err[ 123] will match Er r1 , Err 2 or Er r3 [E e]rr or will matc h eit her err or or E rr or [^xyz] M a t c h a n y c h a r a c t e r n o t i n t h e b r ac k e t s E xamp l e: E r r [ ^ 1 2 3 4 5 ] wi l l m a t c h E r r 0 , E r r 6 , E r r 7 , e t c . b u t n o t E r r 1 [a-z] M a t c h a n y c h a r a c t e r i n t h e r a n g e i n t h e b r ac k e t s E xamp l e: Err[ 0- 9] will matc h Err 0, Er r1 , etc . and Err 9 Err[ A- Z][ 0- 9] will matc h Err A0 , ErrA 1 , E rrS 9, E rrZ 0, et c. but not Err 1A Err[ A- Z0-9] will matc h Err A0 , Err A1 , etc . and Err 1A [^a-z] Matc h any char act er not in t he r ange in t he br ac kets E xamp l e: A p p l i c a t i o n [ ^ 0 - 9 ] wi l l m a t c h A p p l i c a t i o n A , A p p l i c a t i o n B , A p p l i c a t i o n ! b u t n o t Applicat ion1 * M a t c h z e r o o r m o r e r e p e t i t i o n s of t h e p r e c e d i n g E xamp l e: Err[ 0- 9A -F ]* will matc h Err , Err 0, Er rA , E rr 11 , ErrB F 0001 , etc. Err or.* A pplic at ionABC will matc h all lines that c ont ains Err or and A p p l i c a t i o n A B C f u r t h e r ( C r i t ic a l E r r o r 0 x 0 0 0 2 9 5 F 0 o n A p p l i c a t i o n A B C ) + M a t c h o n e o r m o r e r e p e t i t i o n s of t h e p r ec e d i n g E xamp l e: E r r [ 0 - 9 A - F ] + wi l l m a t c h E r r 0 , E r r A , E r r 1 1 , E r r B F 0 0 0 1 , e t c . b u t n o t E r r 45 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de ^ M a t c h t h e b e g i n n i n g of t h e l i n e E xamp l e: ^ E r r w i l l m a t c h a l l l i n es t h a t b e g i n w i t h E r r $ M a t c h t h e e n d of t h e l i n e E xamp l e: [ 0 - 9 ] + c o n n e c t i o n s $ w i l l m a t c h a l l l i n es t h a t e n d w i t h x x x c o n n e c t i o n s w h e r e xxx is an int eger \< M a t c h t h e b e g i n n i n g of a w o r d E xamp l e: \ < s e t w i l l m a t c h a n y l i n e t h a t c o n t a i n s a w o r d t h a t b e g i n s wi t h s e t . I t w i l l n o t matc h a line that only c ont ains t he wor d unset \> M a t c h t h e e n d of a w o r d E xamp l e: [A a] pplic at ion \> will matc h all lines that c ont ain the w or d A pplic at ion or applic at ion but not Applic at ionA A \(expression\) D ef i n es a n e x p r es s i o n w h i c h h as t o b e p r o c es s e d as a u n i t r e g a r d i n g t h e modif ier * , + and \ | E xamp l e: \ ( _ [ a - z A - Z 0 - 9 ] \ ) + wi l l m a t c h o n l y s e q u e n c e s l i k e _ p a t r o l , _ p a t r o l _ a g e n t , _patrol_cons ole, etc. exprA\|exprB Matc h ei th er exp r A or exp rB E xamp l e: \ ( f i r e w a l l \ ) \ | \ ( a n t i v ir u s \ ) w i l l m a t c h a l l l i n es t h a t c o n t a i n s e i t h e r t h e w o r d f ir e w a l l o r t h e w o r d a n t i v i r u s \ A v o i d t h e m e a n i n g of t h e f o l l o w i n g c h a r a c t e r E xamp l e: \ . w i l l m a t c h t h e s i n g l e c h a r ac t e r d o t ( . ) C : \ \ P r o g r a m F i l e s wi l l m a t c h C : \ P r o g r a m F i l e s 46 Bl a ck out Kn owl edg e M odul e® for PAT RO L® ve r si on 1. 1 User Gui de 3 - Configuration variables T h e fol l owi n g t a bl e r e ca pi t ul a t es t h e gen er a l c on fi gur a t i on va r ia bl es u sed by Bl a ck out K M for PAT RO L. T h ese va r i a bl es a r e st or ed i n th e PAT RO L Ag en t con fi gur a ti on an d ca n be m a n a ged thr ough PAT RO L C on fi gur a ti on Man a ger (PCM), WPCONFIG. E XE (Wi n dows) or xpcon fi g ( UNIX/ Li n ux). Al l con fi gur a t i on va ri a bl es a r e st or ed un der th e “ / SE NT RY/ BLACKO UT 1 ” fol der i n th e con fi g ur at i on t r ee. By de fa ul t , n on e of t h em ar e set . Variable debugMode debugFile lsCommand dirCommand vmsDirCommand psCommand processPollingInterval noRealTimeMonitoring noRealTimeProcessMonitoring noRealTimeServiceMonitoring noRealTimeFileMonitoring timeToDeletion noPrefix Description W h e n s e t t o ‘ 1 ’ , e n a b l e s t h e d e b u g m o d e o f B l a c k o u t K M f o r P A T R O L . Default: OFF Optional file name and path of the debug output when the debug mode is enabled. Default: No file output Command used to get a directory file list on UNIX systems Default: ls -atp1 %{FOLDERPATH} Command used to get a directory file list on Windows systems Default: dir /A:-D /B /O:-D /T:W %{FOLDERPATH} 2>nul Command used to get a directory file list on Windows systems Default: directory /columns=1 /notrailing /SELECT=(FILE=(NAME,NOVERSION)) /noheading %{FOLDERPATH} Command used to get the list of processes running Default: ps -A -o args Polling interval, in seconds, at which the list of running processes is updated. This is most useful on UNIX systems for which there is no real-time process monitoring. Default: 60 S e t i t t o ‘ 1 ’ t o t u r n off all real-t i m e m o n i t o r i n g i n B l a c k o u t K M f o r P A T R O L a n d ‘ 1 ’ t o e n a b l e i t . Default: ON S e t i t t o ‘ 1 ’ t o t u r n o f f p r o c e s s e s r e a l -t i m e m o n i t o r i n g i n B l a c k o u t K M f o r P A T R O L a n d ‘ 1 ’ t o e n a b l e i t . Default: ON S e t i t t o ‘ 1 ’ t o t u r n o f f N T s e r v i c e s r e a l -t i m e m o n i t o r i n g i n B l a c k o u t K M f o r P A T R O L a n d ‘ 1 ’ t o e n a b l e i t . Default: ON S e t i t t o ‘ 1 ’ t o t u r n o f f f i l e s r e a l -t i m e m o n i t o r i n g i n B l a c k o u t K M f o r P A T R O L a n d ‘ 1 ’ t o e n a b l e i t . Default: ON Number of seconds since the last modification of any file found under %PATROL_HOME/SEN_BO_LOG will be deleted. Default: 1814400 (21 days) S e t i t t o ‘ 1 ’ t o d i s a b l e t h e u s e o f t h e “ B l a c k o u t : “ p r e f i x i n b l a c k o u t i n s t a n c e labels. Default: ON 47