Cre s tro n Virtual Co n tro l f o r R e d H at® O SSe rve r-Bas e d Co n tro l Sys te m

I n s tallatio n G uideCre s tro n Ele ctro n ics , I n c.

O rig in al I n s tructio n sTh e U . S. En g lis h ve rs io n o f th is do cume n t is th e o rig in al in s tructio n s .A ll o th e r lan g uag e s are a tran s latio n o f th e o rig in al in s tructio n s .

Cre s tro n pro duct de ve lo pme n t s o f tware is lice n s e d to Cre s tro n de ale rs an d Cre s tro n Se rvice Pro vide rs ( CSPs ) un de r alimite d n o n e x clus ive , n o n tran s f e rable So f tware De ve lo pme n t To o ls L ice n s e A g re e me n t. Cre s tro n pro duct o pe ratin gs ys te m s o f tware is lice n s e d to Cre s tro n de ale rs , CSPs , an d e n d-us e rs un de r a s e parate En d-U s e r L ice n s e A g re e me n t.Bo th o f th e s e A g re e me n ts can be f o un d o n th e Cre s tro n we bs ite at www. cre s tro n . co m/le g al/s o f tware _lice n s e _ag re e me n t.

Th e pro duct warran ty can be f o un d at www. cre s tro n . co m/warran ty.

Th e s pe cif ic pate n ts th at co ve r Cre s tro n pro ducts are lis te d at www. cre s tro n . co m/le g al/pate n ts.

Ce rtain Cre s tro n pro ducts co n tain o pe n s o urce s o f tware . Fo r s pe cif ic in f o rmatio n , vis it www. cre s tro n . co m/o pe n s o urce.

Cre s tro n , th e Cre s tro n lo g o , Cre s tro n Fus io n , an d X iO Clo ud are e ith e r trade marks o r re g is te re d trade marks o f Cre s tro nEle ctro n ics , I n c. in th e U n ite d State s an d/o r o th e r co un trie s . Flas h is e ith e r a trade mark o r a re g is te re d trade mark o fA do be in th e U n ite d State s an d/o r o th e r co un trie s . A pach e is e ith e r a trade mark o r a re g is te re d trade mark o f Th eA pach e So f tware Fo un datio n in th e U n ite d State s an d/o r o th e r co un trie s . Saf ari is e ith e r a trade mark o r a re g is te re dtrade mark o f A pple , I n c. in th e U n ite d State s an d/o r o th e r co un trie s . U bun tu is e ith e r a trade mark o r a re g is te re dtrade mark o f Can o n ical L td in th e U n ite d State s an d/o r o th e r co un trie s . Ch ro me is e ith e r a trade mark o r a re g is te re dtrade mark o f G o o g le , I n c. in th e U n ite d State s an d/o r o th e r co un trie s . L in ux is e ith e r a trade mark o r a re g is te re dtrade mark o f L in us To rvalds in th e U n ite d State s an d/o r o th e r co un trie s . MariaDB is e ith e r a trade mark o r a re g is te re dtrade mark o f MariaDB in th e U n ite d State s an d/o r o th e r co un trie s . A ctive Dire cto ry, A z ure , Micro s o f t, an d Micro s o f tEdg e are e ith e r trade marks o r re g is te re d trade marks o f Micro s o f t Co rpo ratio n in th e U n ite d State s an d/o r o th e rco un trie s . Fire f o x is e th e r a trade mark o r a re g is te re d trade mark o f th e Mo z illa Fo un datio n in th e U n ite d State s an d/o ro th e r co un trie s . Ce n tO S, R e d H at, an d R e d H at En te rpris e L in ux are e ith e r trade marks o r re g is te re d trade marks o r R e dH at, I n c. in th e U n ite d State s an d/o r o th e r co un trie s . O th e r trade marks , re g is te re d trade marks , an d trade n ame s may beus e d in th is do cume n t to re f e r to e ith e r th e e n titie s claimin g th e marks an d n ame s o r th e ir pro ducts . Cre s tro n dis claimsan y pro prie tary in te re s t in th e marks an d n ame s o f o th e rs . Cre s tro n is n o t re s po n s ible f o r e rro rs in typo g raph y o rph o to g raph y.

© 2 0 2 1 Cre s tro n Ele ctro n ics , I n c.

Co nt ent s

I n tro ductio n 1

A s s umptio n s 2

I n s tallatio n 3I n s tall th e Cre s tro n Virtual Co n tro l Packag e 3Se t Cus to m TCP Ke e palive s 5De te ct De vice Dis co n n e cts 5O pe n Po rts f o r R e mo te De bug g in g 6Man ag e L ice n s e s with X iO  Clo ud 6I n cre as e th e File Siz e L imit 8A cce s s th e W e b I n te rf ace 9U pdate th e Cre s tro n Virtual Co n tro l Se rvice 10

A ppe n dix A : En able L o cal Sys te m L o g g in g 12

A ppe n dix B: O pe n Se rve r Po rts 13

A ppe n dix C: Scalable Sys te m R e quire me n ts 15

A ppe n dix D: Tro uble s h o o t R o o m A ddre s s e s 16

A ppe n dix E: Co n n e ct De vice s with O lde r Firmware acro s s Subn e ts 17

I n s tallatio n G uide — Do c. 8 9 12 C Co n te n ts • i

ii • Co n te n ts I n s tallatio n G uide — Do c. 8 9 12 C

I n s tallatio n G uide — Do c. 8 9 12 C Cre s tro n Virtual Co n tro l f o r R e d H at® O S • 1

I nt ro du c t i o nTh e Cre s tro n Virtual Co n tro l s e rve r- bas e d co n tro l s ys te m pro vide s a s calable s o lutio n f o rde plo yin g pro g rams , ro o ms , an d de vice s acro s s an e n te rpris e . Th e Cre s tro n ® co n tro l s ys te min f ras tructure re s ide s e n tire ly o n a re mo te s e rve r, wh ich is in s talle d an d co n f ig ure d us in gs uppo rte d L in ux ® o pe ratin g s ys te m platf o rms .

Th is g uide pro vide s th e in s tallatio n pro ce dure s n e e de d to in s tall th e Cre s tro n Virtual Co n tro lpackag e o n a R e d H at En te rpris e L in ux ® o r Ce n tO S® L in ux s e rve r platf o rm, as we ll as pro ce dure sf o r co n f ig urin g vario us Cre s tro n Virtual Co n tro l f e ature s .

Th e f o llo win g do cume n ts are als o pro vide d f o r re f e re n ce :

l Fo r mo re in f o rmatio n o n mig ratin g an e x is tin g Cre s tro n Virtual Co n tro l s e rve r in s tallatio nto a dif f e re n t L in ux platf o rm, re f e r to Cre s tro n Virtual Co n tro l Se rve r Mig ratio n U s e rG uide .

l Fo r mo re in f o rmatio n o n s e cure ly de plo yin g th e Cre s tro n Virtual Co n tro l s e rve r, re f e r toth e Cre s tro n Virtual Co n tro l So f tware f o r R e d H at O S De plo yme n t G uide .

l Fo r mo re in f o rmatio n o n in te g ratin g th e Cre s tro n Virtual Co n tro l s e rve r in an e x is tin gin tran e t s ite us in g th e s e cure R EST A PI platf o rm, re f e r to th e Cre s tro n Virtual Co n tro lSo f tware R EST A PI Pro g rammin g G uide .

2 • Cre s tro n Virtual Co n tro l f o r R e d H at® O S I n s tallatio n G uide — Do c. 8 9 12 C

Assu mp t i o nsTh is g uide is writte n with th e f o llo win g as s umptio n s :

l Th e I T admin is trato r ( in s talle r) h as a wo rkin g kn o wle dg e o f L in ux platf o rms an dco mman ds .

l Th e I T admin is trato r is re s po n s ible f o r th e f o llo win g tas ks :o Ke e pin g th e s e rve r up to dateo Se ttin g th e s e curity o f th e s e rve ro I n te g ratin g th e s e rve r in th e co rpo rate auth e n ticatio n pro vide r ( L DA P,

A ctive  Dire cto ry® s e rvice , O A uth , an d o th e rs )o Co n f ig urin g us e r acce s s to th e s e rve ro Co n f ig urin g th e we b s e rve rs , in cludin g th e rig h ts to th e path o f th e Cre s tro n Virtual

Co n tro l we b us e r in te rf ace pag e s .

l O n e o f th e f o llo win g L in ux platf o rms is in s talle d o n a ph ys ical o r virtual mach in e :

N O TE: Th e virtualiz atio n ag n o s tic is re co mme n de d.

o R e d H at En te rpris e L in ux Se rve r 8 . 2 s o f tware ( 6 4- bit ve rs io n )o Ce n tO S L in ux Se rve r 8 . 2 s o f tware ( 6 4- bit ve rs io n )

l Th e s e rve r me e ts th e f o llo win g re quire me n ts af te r th e L in ux platf o rm h as be e n in s talle d:o CPU : 4 Co re s o r h ig h e r 1

o R A M : 4 G B o r h ig h e r 1

o Dis k s pace : 2 0 0 G B o r h ig h e r

l Th e s e rve r s h o uld be de dicate d to run th e Cre s tro n Virtual Co n tro l s e rvice o n ly.

l Th e s e rve r h as a de pe n de n cy to run th e A pach e ® 2 . 4. 3 7 ( o r late r) we b s e rve r, wh ich isin s talle d as part o f th e Cre s tro n Virtual Co n tro l in s tallatio n packag e .

l Th e s e rve r is able to run in a virtualiz e d e n viro n me n t.

l Fo r R e d H at En te rpris e L in ux in s tallatio n s , th e R e d H at® s e rve r mus t be re g is te re d withwww. re dh at. co m .

1  Th e re quire d n umbe r o f CPU co re s an d amo un t o f R A M varie s de pe n din g o n th e n umbe r ro o ms an d de vice s adde d toth e s e rve r. Fo r mo re in f o rmatio n , re f e r to A ppe n dix C: Scalable Sys te m R e quire me n ts ( o n pag e  15).

I n s tallatio n G uide — Do c. 8 9 12 C Cre s tro n Virtual Co n tro l f o r R e d H at® O S • 3

I nst al l at i o nU s e th e f o llo win g pro ce dure s to in s tall th e Cre s tro n Virtual Co n tro l packag e o n to th e L in uxplatf o rm.

N O TE: Th e s e pro ce dure s as s ume th at th e R e d H at En te rpris e L in ux o r Ce n tO S s e rve rplatf o rms h ave alre ady be e n in s talle d an d me e t o r e x ce e d th e s pe cif icatio n s de s cribe d inA s s umptio n s ( o n th e pre vio us pag e ) . Th e s ubs criptio n man ag e r f o r th e R e d H at s e rve r platf o rmmus t als o be co n f ig ure d prio r to in s tallatio n .

I nst al l t he Crest ro n V i rt u al Co nt ro lP ac k ageTo in s tall th e Cre s tro n Virtual Co n tro l packag e o n to th e L in ux platf o rm:

N O TE:  Th e Cre s tro n Virtual Co n tro l packag e g e n e rate s s e lf -s ig n e d ce rtif icate s durin gin s tallatio n , wh ich are available at <in s tallatio n _ path >/virtualco n tro l/data/s s l/ce rts / . Th e s ece rts are us e d to e s tablis h s e cure co n n e ctio n s with co n n e cte d de vice s . A dditio n ally, allce rtif icate s pro vide d by h ttps : //curl. s e /ca/cace rt. pe m will be in s talle d at /e tc/s s l/ce rts .

1. Do wn lo ad th e Cre s tro n Virtual Co n tro l f ile packag e f ro m th e So f tware & Firmwarere s o urce pag e at www. cre s tro n . co m/Suppo rt/R e s o urce - L ibrary .

2 . L o g in to an acco un t with s udo privile g e s o n th e L in ux platf o rm wh e re th e Cre s tro n VirtualCo n tro l packag e will be in s talle d.

3 . Co py th e packag e ZI P f ile to a lo catio n o n th e L in ux platf o rm.

4. O pe n a n e w te rmin al win do w.

5. I s s ue th e f o llo win g co mman d to update th e libs tdc++ packag e prio r to in s tallin g Cre s tro nVirtual Co n tro l . Th e in s tallatio n will f ail if th e libs tdc++ packag e is n o t update d.

sudo yum -y install libstdc++

6 . Ch an g e dire cto rie s to th e lo catio n o f th e ZI P f ile , an d th e n is s ue th e f o llo win g co mman d toun z ip th e packag e , wh e re <version> is th e ve rs io n n umbe r o f th e packag e f ile :

unzip vc-4_<version>.zip

7 . Ch an g e dire cto rie s to th e lo catio n o f th e un z ippe d packag e f ile (vc-4) .

8 . I s s ue th e f o llo win g co mman d to s tart th e in s tallatio n . Th e s cript in s talls an y R PM f ile s th atare de pe n de n cie s f o r th e in s tallatio n prio r to run n in g th e Cre s tro n Virtual Co n tro lR PM f ile .

sudo ./installVC4.sh

9 . En te r y wh e n pro mpte d to co n f irm th e in s tallatio n .

4 • Cre s tro n Virtual Co n tro l f o r R e d H at® O S I n s tallatio n G uide — Do c. 8 9 12 C

10 . W h e n pro mpte d, in dicate wh e th e r yo u are mig ratin g yo ur Cre s tro n Virtual Co n tro lin s tallatio n f ro m an o th e r L in ux platf o rm ( e n te r y) o r n o t ( e n te r n) .

N O TE:  W h e n mig ratin g f ro m o n e L in ux platf o rm to an o th e r, Cre s tro n Virtual Co n tro lmus t be in s talle d in th e s ame path o n th e n e w platf o rm as it was o n th e o rig in alplatf o rm.

Th e re main in g pro ce dure s de s cribe th e in s tallatio n pro ce s s f o r a n e w Cre s tro n VirtualCo n tro l s e rve r in s tan ce .

N O TE:  Cre s tro n pro vide s a mig ratio n f ile th at is re quire d to mig rate data f ro m ane x is tin g Cre s tro n Virtual Co n tro l s e rve r to a dif f e re n t L in ux platf o rm. Th is f ile can beus e d to mig rate Cre s tro n Virtual Co n tro l data f ro m an U bun tu® s e rve r platf o rm to R e dH at o r Ce n tO S. Fo r mo re in f o rmatio n o n th e mig ratio n f ile an d in s tallatio n , re f e r to th eCre s tro n Virtual Co n tro l Se rve r Mig ratio n U s e r G uide .

11. W h e n pro mpte d, s e t th e dire cto ry wh e re Cre s tro n Virtual Co n tro l applicatio n s will bein s talle d. Pre s s En te r to us e th e de f ault dire cto ry (/opt/crestron) .

12 . W h e n pro mpte d, s e t th e R e dis po rt n umbe r. R e dis is us e d as a databas e f o r Cre s tro nVirtual Co n tro l pro ce s s e s . Pre s s En te r to us e th e de f ault R e dis po rt value .

13 . En te r th e ro o t acco un t pas s wo rd wh e n pro mpte d to h ave th e Cre s tro n Virtual Co n tro lin s talle r ch e ck wh e th e r th e MariaDB® databas e s e rve r is in s talle d. Th e MariaDB databas es e rve r is in s talle d auto matically if it is n o t alre ady. I f th e ro o t acco un t pas s wo rd is n o t s e t,yo u will be pro mpte d to cre ate an d co n f irm a pas s wo rd.

N O TE:  MariaDB is a s calable databas e s e rve r us e d by th e Cre s tro n Virtual Co n tro l s e rve rto turn data in to s tructure d in f o rmatio n .

14. En te r a n ame to us e f o r th e Cre s tro n Virtual Co n tro l databas e . Pre s s En te r to us e th ede f ault databas e n ame (VirtualControl) .

15. En te r a us e rn ame to us e f o r th e Cre s tro n Virtual Co n tro l acco un t. Pre s s En te r to us e th ede f ault us e rn ame (virtualcontrol) .

16 . En te r a pas s wo rd f o r th e Cre s tro n Virtual Co n tro l acco un t. Pre s s En te r to us e th e de f aultpas s wo rd ( ran do m s trin g ) .

17 . N avig ate to /e tc/s n mp/ , o pe n th e s n mpd. co n f f ile in a te x t e ditin g pro g ram, an d add th ef o llo win g two lin e s to th e e n d o f th e f ile . Th is pre ve n ts a " W arn in g : Faile d to co n n e ct toth e ag e n tx mas te r ag e n t ( [N I L ]) SN MP" me s s ag e f ro m dis playin g wh e n run n in g th es e rvice .

master agentx

agentXSocket tcp:localhost:705

18 . I s s ue th e f o llo win g SN MPD co mman ds to e n s ure th e s e rvice re s tarts with o ut th e warn in gme s s ag e af te r re bo o tin g th e R e d H at o r Ce n tO S s e rve r:

I n s tallatio n G uide — Do c. 8 9 12 C Cre s tro n Virtual Co n tro l f o r R e d H at® O S • 5

a. I s s ue systemctl restart snmpd to re s tart th e SN MPD s e rvice an d to apply th eco n f f ile ch an g e s .

b. I s s ue systemctl enable snmpd.service to e n able th e SN MPD s e rvice .

c. I s s ue systemctl start snmpd.service to s tart th e SN MPD s e rvice .

19 . R e s tart th e R e d H at o r Ce n tO S s e rve r.

A f te r re s tartin g , th e Cre s tro n Virtual Co n tro l s e rvice s tarts auto matically with in 2 to 3 min ute s .

S et Cu st o m T CP   Keep al i v esCus to m TCP ke e palive s mus t be s e t to run th e Cre s tro n Virtual Co n tro l s e rve r. Th e de f ault TCPke e palive time o ut f o r a L in ux s ys te m is two h o urs but mus t be re duce d to 3 0 s e co n ds .

N O TE: Th e TCP ke e palive time o ut duratio n may be in cre as e d to 6 0 s e co n ds if de s ire d.

To s e t cus to m TCP ke e palive s f o r th e Cre s tro n Virtual Co n tro l s e rve r:

1. O pe n a n e w te rmin al win do w.

2 . I s s ue th e f o llo win g co mman ds :

sudo sysctl -w net.ipv4.tcp_keepalive_intvl=30

sudo sysctl -w net.ipv4.tcp_keepalive_time=30

3 . R e s tart th e Cre s tro n Virtual Co n tro l s e rvice by is s uin g th e f o llo win g co mman d:

sudo systemctl restart virtualcontrol

D et ec t D ev i c e D i sc o nnec t sI f a de vice co n n e cte d to th e Cre s tro n Virtual Co n tro l s e rve r be co me s dis co n n e cte d be caus e itsEth e rn e t cable is dis co n n e cte d an d th e n plug g e d back in , th e s e rve r may take up to 15 min ute s tode te ct th at th e de vice h as g o n e o f f lin e an d to atte mpt to re e s tablis h co mmun icatio n s .

To re duce th e time it take s to de te ct de vice dis co n n e cts in th is s ce n ario , re duce th e TCP re trytime o ut f o r th e R e d H at o r Ce n tO S s e rve r.

To re duce th e TCP re try time o ut:

1. O pe n a n e w te rmin al win do w.

2 . I s s ue th e f o llo win g co mman d:

sudo sysctl -w net.ipv4.tcp_retries2=8

3 . R e bo o t th e R e d H at o r Ce n tO S s e rve r.

Fo llo win g th e re bo o t, th e s e rve r will re co g n iz e th at un plug g e d de vice s h ave dis co n n e cte d with in2 to 3 min ute s an d will atte mpt to re e s tablis h co mmun icatio n s .

6 • Cre s tro n Virtual Co n tro l f o r R e d H at® O S I n s tallatio n G uide — Do c. 8 9 12 C

O p en P o rt s f o r Remo t e D eb u ggi ngTh e R e d H at an d Ce n tO S s e rve r f ire wall blo cks all in co min g traf f ic by de f ault. I n o rde r to allo wre mo te de bug g in g , wo rk with yo ur I T admin is trato r to o pe n th e po rts us e d by th e pro g rams an dde bug g e rs th ro ug h th e f ire wall.

O n ce th e s e po rts h ave be e n de te rmin e d, is s ue th e f o llo win g co mman ds to s pe cif y th e ran g e o fpo rts f o r re mo te de bug g in g :

sudo firewall-cmd -q --zone=public --permanent --add-port=[STARTPORT-ENDPORT]/tcp

sudo firewall-cmd --reload

M anage Li c enses wi t h Xi O   Cl o u dTh e n umbe r o f ro o ms th at may be run o n th e Cre s tro n Virtual Co n tro l s e rve r is bas e d o n th en umbe r o f purch as e d lice n s e s . Th e Cre s tro n Virtual Co n tro l s e rve r h as an in itial 9 0 - day g racepe rio d, durin g wh ich a max imum n umbe r o f 50 0 ro o ms may be run . A f te r th e g race pe rio de x pire s , e x is tin g ro o ms may n o lo n g e r be run , an d n e w ro o ms may n o t be adde d to th e s e rve run til th e appro priate lice n s e s are purch as e d.

Purch as e d Cre s tro n Virtual Co n tro l lice n s e s are man ag e d th ro ug h th e X iO Clo ud® s e rvice po rtal.Fo r mo re in f o rmatio n o n us in g X iO  Clo ud, re f e r to th e X iO Clo ud Se rvice U s e r G uide .

To add an d man ag e Cre s tro n Virtual Co n tro l lice n s e s with in X iO  Clo ud:

1. Place yo ur Cre s tro n Virtual Co n tro l lice n s e o rde r ( s ) with Cre s tro n .

2 . Claim yo ur in s talle d Cre s tro n Virtual Co n tro l s e rve r to yo ur X iO  Clo ud acco un t asde s cribe d in th e X iO Clo ud Se rvice U s e r G uide .

3 . U s e th e f o llo win g re g is tratio n f o rms to re que s t yo ur Cre s tro n Virtual Co n tro l lice n s e s :

l Fo r pe rpe tual ( ro o m- bas e d)  lice n s e s , re f e r towww. cre s tro n . co m/Suppo rt/To o ls /L ice n s in g - R e g is tratio n /Virtual- Co n tro l-R e g is tratio n

l Fo r s ubs criptio n lice n s e s , re f e r to www. cre s tro n . co m/Suppo rt/To o ls /L ice n s in g -R e g is tratio n /Virtual- Co n tro l- Subs criptio n - R e g is tratio n

l Fo r main te n an ce lice n s e s , re f e r to www. cre s tro n . co m/Suppo rt/To o ls /L ice n s in g -R e g is tratio n /Virtual- Co n tro l- Main te n an ce

4. N avig ate to yo ur Cre s tro n Virtual Co n tro l s e rve r in th e EN VI R O N MEN T me n u tre e inX iO  Clo ud.

I n s tallatio n G uide — Do c. 8 9 12 C Cre s tro n Virtual Co n tro l f o r R e d H at® O S • 7

5. Se le ct th e L ice n s e s tab in th e de vice s e ttin g s .

6 . Click A dd n e x t to lice n s e th at s h o uld be adde d. Th e A dd L ice n s e s dialo g bo x is dis playe d.

7 . En te r th e n umbe r o f lice n s e s th at yo u wo uld like adde d to yo ur Cre s tro n Virtual Co n tro ls e rve r in th e Co un t te x t f ie ld. Th e to tal available lice n s e s are s h o wn n e x t to th is te x t f ie ld.

8 • Cre s tro n Virtual Co n tro l f o r R e d H at® O S I n s tallatio n G uide — Do c. 8 9 12 C

8 . Click A dd . Th e L ice n s e s tab update s to s h o w th at th e s e le cte d lice n s e s h ave be e n adde d toth e Cre s tro n Virtual Co n tro l s e rve r.

Th e f o llo win g f un ctio n s are als o pro vide d:

l Click U pdate to update th e n umbe r o f lice n s e s th at are available f o r th e Cre s tro n VirtualCo n tro l s e rve r.

l Click De le te to de le te th e lice n s e f ro m th e s e rve r. Th e lice n s e is adde d back to yo ur lice n s epo o l.

N O TE:  Main te n an ce lice n s e s are h an dle d dif f e re n tly th an pe rpe tual an d s ubs criptio n - bas e dlice n s e s . O n ly o n e main te n an ce lice n s e can be adde d pe r Cre s tro n Virtual Co n tro l s e rve r, an dth e lice n s e can n o t be de le te d o n ce it is adde d.

I nc rease t he Fi l e S i ze Li mi tA s o f Cre s tro n Virtual Co n tro l ve rs io n 2 . 4557 . 0 0 155, th e max imum f ile s iz e limit h as be e nin cre as e d f ro m 12 8 MB to 512 MB. Fo r in s tallatio n s run n in g a pre vio us ve rs io n o f Cre s tro n VirtualCo n tro l, th e co n f ig uratio n f ile s mus t be update d man ually to in cre as e th e f ile s iz e limit e ve naf te r an upg rade .

N O TE:  N e w Cre s tro n Virtual Co n tro l in s tallatio n s us in g ve rs io n 2 . 4557 . 0 0 155 o r late r do n o tre quire th e co n f ig uratio n f ile s to be update d.

To in cre as e th e f ile s iz e limit:

1. U pg rade Cre s tro n Virtual Co n tro l to ve rs io n 2 . 4557 . 0 0 155 o r late r as de s cribe d in U pdateth e Cre s tro n Virtual Co n tro l Se rvice ( o n pag e  10 ) .

2 . O pe n th e [VirtualCo n tro lH o me ]/co n f /cre s tro n . co n f f ile .

3 . L o cate th e lin e SecRequestBodyLimit 134217728 an d mo dif y it as f o llo ws :

SecRequestBodyLimit 536870912

4. Save an d e x it th e f ile .

I n s tallatio n G uide — Do c. 8 9 12 C Cre s tro n Virtual Co n tro l f o r R e d H at® O S • 9

Ac c ess t he Web I nt erf ac eTo acce s s th e Cre s tro n Virtual Co n tro l we b us e r in te rf ace af te r in s tallatio n , e n te r " h ttp: //[Se rve rU R L ]/VirtualCo n tro l/co n f ig /s e ttin g s /" in to a s uppo rte d we b bro ws e r, wh e re [Se rve rU R L ]is th e I P addre s s o r h o s tn ame o f th e L in ux platf o rm.

Th e Cre s tro n Virtual Co n tro l us e r in te rf ace s uppo rts th e f o llo win g bro ws e rs :

l Ch ro me ® bro ws e r

l Fire f o x ® bro ws e r

l Micro s o f t Edg e ® bro ws e r ( ch ro mium- bas e d)

l Saf ari® bro ws e r

Th e Status > R o o ms pag e dis plays by de f ault.

Cre s tro n Virtual Co n tro l W e b U s e r I n te rf ace

Th e f o llo win g co mman ds may be is s ue d wh ile th e Cre s tro n Virtual Co n tro l s e rvice is run n in g :

l To ch e ck th e s tatus o f th e Cre s tro n Virtual Co n tro l s e rvice wh ile it is run n in g , is s ue sudosystemctl status virtualcontrol.

l To re s tart th e Cre s tro n Virtual Co n tro l s e rvice , is s ue sudo systemctl restartvirtualcontrol.

N O TE: A f te r a re s tart, wait 2 to 3 min ute s f o r th e s e rvice to in itializ e be f o re atte mptin gto acce s s th e we b co n f ig uratio n in te rf ace .

l To s to p th e Cre s tro n Virtual Co n tro l s e rvice , is s ue sudo systemctl stopvirtualcontrol.

10 • Cre s tro n Virtual Co n tro l f o r R e d H at® O S I n s tallatio n G uide — Do c. 8 9 12 C

Up dat e t he Crest ro n V i rt u al Co nt ro lS erv i c eW h e n a n e w ve rs io n o f th e Cre s tro n Virtual Co n tro l s e rvice is available , a n o tif icatio n is dis playe do n th e to p o f th e we b us e r in te rf ace .

N O TE:  Co n tin uo us update s to th e Cre s tro n Virtual Co n tro l s e rvice re quire an activemain te n an ce lice n s e . Subs criptio n lice n s e s in clude main te n an ce s e rvice s f o r th e s pe cif ie ds ubs criptio n te rm. Fo r mo re in f o rmatio n , re f e r to th e lin ke d pro duct pag e s .

W e b U s e r I n te rf ace - U pdate N o tif icatio n

CA U TI O N : En s ure th at all cus to m co n f ig uratio n f ile s are backe d up prio r to updatin g th eCre s tro n Virtual Co n tro l s e rvice , as an y pre vio us co n f ig uratio n s will be o ve rwritte n .

To update th e Cre s tro n Virtual Co n tro l s e rvice f ro m th e L in ux platf o rm:

1. Do wn lo ad th e Cre s tro n Virtual Co n tro l f ile packag e f ro m th e So f tware & Firmwarere s o urce pag e at www. cre s tro n . co m/Suppo rt/R e s o urce - L ibrary .

2 . L o g in to an acco un t with s udo privile g e s o n th e L in ux platf o rm wh e re th e Cre s tro n VirtualCo n tro l packag e will be in s talle d.

3 . Co py th e packag e ZI P f ile to a lo catio n o n th e L in ux platf o rm.

4. O pe n a n e w te rmin al win do w.

5. I s s ue th e f o llo win g co mman ds to update th e libs tdc++ packag e prio r to in s tallin g Cre s tro nVirtual Co n tro l . Th e in s tallatio n will f ail if th e libs tdc++ packag e is n o t update d.

sudo systemctl stop virtualcontrol.service

sudo rpm -e libstdc++.i686

sudo yum -y install libstdc++

6 . Ch an g e dire cto rie s to th e lo catio n o f th e ZI P f ile , an d th e n is s ue th e f o llo win g co mman d toun z ip th e packag e , wh e re <version> is th e ve rs io n n umbe r o f th e packag e f ile :

unzip vc-4_<version>.zip

7 . Ch an g e dire cto rie s to th e lo catio n o f th e un z ippe d packag e f ile (vc-4) .

I n s tallatio n G uide — Do c. 8 9 12 C Cre s tro n Virtual Co n tro l f o r R e d H at® O S • 11

8 . I s s ue th e f o llo win g co mman d to s tart th e in s tallatio n . Th e s cript in s talls an y R PM f ile s th atare de pe n de n cie s f o r th e in s tallatio n prio r to run n in g th e Cre s tro n Virtual Co n tro lR PM f ile .

sudo ./installVC4.sh

9 . En te r y wh e n pro mpte d to co n f irm th e update .

Th e update may take up to 15 min ute s to co mple te . O n ce th e update h as co mple te d, th eCre s tro n Virtual Co n tro l s e rvice s tarts auto matically with in 2 to 3 min ute s .

12 • Cre s tro n Virtual Co n tro l f o r R e d H at® O S I n s tallatio n G uide — Do c. 8 9 12 C

Ap p endi x A: Enab l e Lo c alS yst em Lo ggi ngTh e Cre s tro n Virtual Co n tro l s e rvice pro vide s s uppo rt f o r lo cal s ys te m lo g g in g . Samples ys lo g . co n f f ile s are pro vide d in th e in s tallatio n packag e th at may be mo dif ie d as n e e de d.

N O TE:  SEL in ux mus t be dis able d o n th e R e d H at o r Ce n tO S platf o rm be f o re s ys te m lo g g in gcan be e n able d. Fo r mo re in f o rmatio n , re f e r to th e Cre s tro n Virtual Co n tro l So f tware f o r R e dH at O S De plo yme n t G uide .

To acce s s th e s ample . co n f f ile s , n avig ate to [VirtualCo n tro lH o me ]/s ample s /co n f _ f ile s , wh e re[VirtualCo n tro lH o me ] is th e h o me dire cto ry s e t durin g in s tallatio n .

To e n able lo cal s ys te m lo g g in g f o r th e Cre s tro n Virtual Co n tro l s e rve r:

N O TE: L o cal Cre s tro n lo g f ile s are cre ate d in th e /var/lo g /cre s tro n / dire cto ry.

1. Mo ve th e 50 -de f ault. co n f f ile f ro m [ VirtualCo n tro lH o me ]/s ample s /co n f _ f ile s to th e/e tc/rs ys lo g . d/ dire cto ry.

2 . O pe n th e 50 - de f ault. co n f f ile .

3 . Co n f ig ure lo cal lo g g in g s e ttin g s by co mme n tin g , un co mme n tin g , o r mo dif yin g th eappro priate lin e s as f o llo ws :

a. U s e th e te mplate be lo w to cre ate a cus to miz e d lo g f o rmat f o r Cre s tro n lo g s :

$template crestron_template,"<%syslogseverity-text%> %timegenerated%%HOSTNAME% %syslogtag% %msg%\n"

b. U s e th e te mplate be lo w to cre ate a cus to miz e d lo g f ile n ame pe r applicatio n ( U s e ifa s e parate lo g f ile is n e e de d f o r th e applicatio n in s te ad o f a co mmo n lo g f ile ) :

$template CUSTOM_LOGS,"/var/log/crestron/%syslogtag:F,58:1%.log"

N O TE: I n th e lo g f ile f o rmat abo ve , " F" is th e Fro mCh ar f ie ld, " 58 " is th e A SCI Ivalue o f th e de limite r, an d " 1" is th e f irs t f ie ld be f o re th e de limite r.

c. U s e th e te mplate be lo w to cre ate a s in g le lo g f ile f o r all applicatio n s :

$template SINGLE_LOG,"/var/log/crestron/crestron.log"

d. Co mme n t an y f ilte rs be twe e n lin e s 3 3 – 6 8 to s e n d th e co mme n te d ite m to th es ys te m lo g in s te ad o f th e s in g le lo g ( s h o wn o n lin e 2 5) .

N O TE: Co mme n t all f ilte rs to s e n d all ite ms to th e s ys te m lo g .

e . Co n f ig ure an y o th e r L in ux s ys lo g s e ttin g s as n e e de d.

4. Save an d e x it th e f ile .

5. I s s ue sudo systemctl restart rsyslog.service to re s tart th e s ys te m lo g g in g s e rvice .

I n s tallatio n G uide — Do c. 8 9 12 C Cre s tro n Virtual Co n tro l f o r R e d H at® O S • 13

Ap p endi x B: O p en S erv erP o rt sTh e Cre s tro n Virtual Co n tro l s e rve r re quire s th e f o llo win g e x te rn al an d in te rn al po rts to be o pe nwh ile th e s e rve r is run n in g . Th e s e po rts are o pe n e d wh e n in s tallin g Cre s tro n Virtual Co n tro l .

O pe n Ex te rn al Se rve r Po rts

Po rt N umbe r Se rvice N o te s

8 0 / 443 H TTP/H TTP( S)( U DP)

16 1 / 16 3 U DP f o r SN MP

8 43 Flas h ® po licy s e rve r( TCP)

Th is po rt may be dis able d if a Flas h po licy s e rve r is n o t us e d. Fo r mo rein f o rmatio n , re f e r to th e Cre s tro n Virtual Co n tro l So f tware f o r R e d H atO S De plo yme n t G uide.

417 9 4 CI Pco mmun icatio n( U DP/TCP)

417 9 6 Se cure CI Pco mmun icatio n( TCP)

49 2 0 0 H TML 5 W e bX Pan e l

Fo r mo re in f o rmatio n o n s e ttin g up s e cure co mmun icatio n s f o r th e H TML 5W e b X Pan e l, re f e r to th e Cre s tro n Virtual Co n tro l So f tware f o r R e d H atO S De plo yme n t G uide.

O pe n I n te rn al Se rve r Po rts

Po rt N umbe r Se rvice N o te s

10 2 5 L is te n in g po rt f o rFlas h po licy s e rve r( U DP)

Th is po rt may be dis able d if a Flas h po licy s e rve r is n o t us e d. Fo r mo rein f o rmatio n , re f e r to th e Cre s tro n Virtual Co n tro l So f tware f o r R e d H at O SDe plo yme n t G uide.

3 3 0 6 MySQ L ( TCP)

50 0 0 W e bA pp lis te n in gme s s ag e s ( U DP)

W e bA pp is th e Cre s tro n Virtual Co n tro l in te rf ace in to th e we b s e rve r.

( U s e r De f in e d) R e dis ( TCP) De f ault po rt is 6 9 8 0 .

50 0 51 DBA pp lis te n in gme s s ag e s ( U DP)

DBA pp is th e Cre s tro n Virtual Co n tro l in te rf ace in to th e MariaDBdatabas e .

14 • Cre s tro n Virtual Co n tro l f o r R e d H at® O S I n s tallatio n G uide — Do c. 8 9 12 C

Fo r an y o utbo un d co n n e ctio n s made f ro m th e Cre s tro n Virtual Co n tro l s e rve r, s uch asco n n e ctio n s to Cre s tro n Fus io n ® s o f tware o r to X iO Clo ud, th e appro priate po rts mus t beo pe n e d. Th e Cre s tro n Virtual Co n tro l s e rve r mus t als o be co n f ig ure d to allo w th e f o llo win gs e rvice s to run :

l DN S Clie n t

l A ctive Dire cto ry

l SN TP ( Simple N e two rk Time Pro to co l)

I n s tallatio n G uide — Do c. 8 9 12 C Cre s tro n Virtual Co n tro l f o r R e d H at® O S • 15

Ap p endi x C: S c al ab l e S yst emRequ i rement sTh e n umbe r o f CPU co re s an d th e amo un t o f R A M th at is re quire d to run th e Cre s tro n VirtualCo n tro l s e rve r varie s de pe n din g o n th e n umbe r o f ro o ms an d th e ave rag e n umbe r o f de vice s pe rro o m th at will be adde d to th e s e rve r.

U s e th e table s be lo w to de te rmin e h o w man y CPU co re s an d h o w much R A M is re quire d f o ro pe ratio n bas e d o n th e s iz e o f th e de plo yme n t. I f a ro w an d co lumn is g raye d o ut, Cre s tro nVirtual Co n tro l do e s n o t s uppo rt th e ave rag e de vice s pe r ro o m f o r th at ro o m s iz e at th is time .

CPU Co re s R e quire d

A ve rag e De vice s Pe r R o o m

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 2 0

50 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 8 8 8

10 0 4 4 4 4 4 4 4 4 4 8 8 8 8 8 8 8 8 8 16 16

2 0 0 4 4 4 4 8 8 8 8 8 16

3 0 0 4 4 8 8 8 8

40 0 4 4 8 8 16

50 0 4 8 8 16

R A M R e quire d

A ve rag e De vice s Pe r R o o m

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 2 0

50 4 4 8 8 8 16 16 16 16 16 3 2 3 2 3 2 3 2 3 2 3 2 3 2 3 2 3 2 3 2

10 0 4 8 16 16 16 3 2 3 2 3 2 3 2 3 2 3 2 6 4 6 4 6 4 6 4 6 4 6 4 6 4 6 4 6 4

2 0 0 8 16 3 2 3 2 3 2 6 4 6 4 6 4 6 4 6 4

3 0 0 16 3 2 3 2 6 4 6 4 6 4

40 0 16 3 2 6 4 6 4 6 4

50 0 16 3 2 6 4 6 4

16 • Cre s tro n Virtual Co n tro l f o r R e d H at® O S I n s tallatio n G uide — Do c. 8 9 12 C

Ap p endi x D : T ro u b l esho o tRo o m AddressesW h e n a ro o m is adde d to th e Cre s tro n Virtual Co n tro l s e rve r, a s tre e t addre s s may be e n te re d tore turn a time z o n e f o r th e ro o m auto matically. Pro g rams us e time z o n e s to e n s ure th atpro g rammatic e ve n ts are s tarte d an d s to ppe d at th e co rre ct time bas e d o n th e lo catio n o f th eas s o ciate d ro o m.

Fo r mo re in f o rmatio n , re f e r to th e e mbe dde d h e lp f ile s f o r th e Cre s tro n Virtual Co n tro l we bin te rf ace by clickin g th e h e lp ico n o n th e to p rig h t o f th e pag e .

Status Pag e - De tails Tab

A ddre s s e s are ch e cke d ag ain s t th e Micro s o f t® A z ure ® s e rvice ' s G e o lo catio n A PI . I f th eG e o lo catio n A PI re co g n iz e s th e addre s s , th e time z o n e as s o ciate d with th e addre s s is re turn e df o r th e ro o m. I f th e G e o lo catio n A PI do e s n o t re co g n iz e th e addre s s , th e de f ault " A me rica/N e w_Y o rk" value is re turn e d as th e Time Zo n e s tatus f o r th e ro o m.

I f a s tre e t addre s s do e s n o t re turn th e co rre ct time z o n e , th e f o llo win g s o lutio n s may beatte mpte d:

l Co n f irm th at th e addre s s is type d an d f o rmatte d co rre ctly.

l En te r a city-le ve l addre s s in s te ad o f a s tre e t- le ve l addre s s ( f o r e x ample , " Min s k, Be larus " ) .

l En te r th e latitude , lo n g itude , an d time z o n e o f th e lo catio n man ually. Th e A ddre s s s e tslo catio n data s witch mus t be to g g le d to O f f to us e th e s e f ie lds .

I n s tallatio n G uide — Do c. 8 9 12 C Cre s tro n Virtual Co n tro l f o r R e d H at® O S • 17

Ap p endi x E: Co nnec t D ev i c eswi t h O l der Fi rmware ac ro ssS u b net sCre s tro n de vice s with n e we r f irmware us e th e Co n n e ct R e que s t me th o d ( wh ich s pe cif ie s a R o o mI D) to co n n e ct auto matically to ro o ms in th e Cre s tro n Virtual Co n tro l s e rve r. De vice s with o lde rf irmware mus t be as s o ciate d man ually with a ro o m, but if a de vice with o lde r f irmware is n o t o nth e s ame s ubn e t as th e s e rve r, it can n o t be dis co ve re d.

A s a wo rkaro un d, th e admin may cre ate a de vice _ re s o lutio n . cf g f ile th at co n tain s th e FQ DN( f ully qualif ie d do main n ame ) , MA C addre s s , an d de vice type f o r an y cro s s -s ubn e t de vice s witho lde r f irmware . Th e Cre s tro n Virtual Co n tro l s e rvice re ads th is f ile o n s tartup an d th e n o n cee ve ry h o ur wh ile th e s e rvice is run n in g . Each time th e f ile is re ad, th e s e rve r atte mpts to re s o lveth e lis te d FQ DN ( s ) via DN S. I f th e FQ DN o f a de vice is re s o lve d, th e de vice I P addre s s is madeavailable to th e s e rve r, wh ich pro vide s th e re s t o f th e in f o rmatio n re quire d to make a co n n e ctio n .Th e de vice may th e n be as s o ciate d man ually with a ro o m.

To co n n e ct to cro s s - s ubn e t de vice s us in g a de vice _ re s o lutio n . cf g f ile :

1. L o g in to an acco un t with s udo privile g e s o n th e L in ux platf o rm wh e re Cre s tro n VirtualCo n tro l packag e is in s talle d.

2 . N avig ate to [VirtualCo n tro lH o me ]/s ample s /de vice re s o lutio n , wh e re [VirtualCo n tro lH o me ]is th e Virtual Co n tro l h o me dire cto ry s e t durin g in s tallatio n ( th e de f ault is/o pt/cre s tro n /virtualco n tro l ) .

3 . Co py th e de vice _ re s o lutio n . cf g f ile to th e [VirtualCo n tro lH o me ]/co n f dire cto ry.

4. O pe n th e co pie d de vice _ re s o lutio n . cf g f ile in a te x t e ditin g pro g ram.

5. En te r th e f o llo win g in f o rmatio n f o r e ach cro s s - s ubn e t de vice o n o n e lin e o f te x t, s e parate dby co mmas ( with n o s pace s ) :

a. Th e f ully qualif ie d do main n ame ( " ts w- 7 7 0 - 1. yo urdo main . co m" )

b. Th e MA C addre s s , us in g pe rio ds o r co lo n s ( " 11. 2 2 . 3 3 . 44. 55. 6 6 " o r " 11: 2 2 : 3 3 : 44: 55: 6 6 " )

c. Th e de vice type ( " TSW - 7 7 0 " )

Ex ample :tsw-770-1.yourdomain.com,11.22.33.44.55.66,TSW-770tsw-770-2.yourdomain.com,00.11.22.33.44.55.66,TSW-770

6 . Save an d e x it th e f ile .

Cre s tro n Virtual Co n tro l be g in s to re ad th e f ile o n ce e ve ry h o ur. To h ave th e s e rvice re ad th e f ileimme diate ly ( o n s tartup) , is s ue sudo systemctl restart virtualcontrol.

Cre s tro n Ele ctro n ics , I n c.15 Vo lvo Drive , R o ckle ig h , N J 0 7 6 47Te l: 8 8 8 . CR ESTR O NFax : 2 0 1. 7 6 7 . 7 6 56www. cre s tro n . co m

I n s tallatio n G uide — Do c. 8 9 12 C

0 8 /0 3 /2 1Spe cif icatio n s s ubje ct to

ch an g e with o ut n o tice .