From d07d64511d3438b69263337af9f2495fecc7b31d Mon Sep 17 00:00:00 2001 From: Thomas Le Gentil Date: Tue, 16 Jul 2019 11:18:50 +0200 Subject: [PATCH] Added the Fortigate component documentation (#9807) * Added the Fortigate component documentation * Update source/_components/fortigate.markdown Co-Authored-By: Franck Nijhof * Update source/_components/fortigate.markdown Co-Authored-By: Franck Nijhof * Update source/_components/fortigate.markdown Co-Authored-By: Franck Nijhof * Update source/_components/fortigate.markdown Co-Authored-By: Franck Nijhof * Update source/_components/fortigate.markdown Co-Authored-By: Klaas Schoute * Update source/_components/fortigate.markdown Co-Authored-By: Klaas Schoute * Update source/_components/fortigate.markdown Co-Authored-By: Klaas Schoute * fixed some remaks * rewording * Move setup up --- source/_components/fortigate.markdown | 81 ++++++++++++++++++++ source/images/supported_brands/fortinet.jpg | Bin 0 -> 12302 bytes 2 files changed, 81 insertions(+) create mode 100644 source/_components/fortigate.markdown create mode 100644 source/images/supported_brands/fortinet.jpg diff --git a/source/_components/fortigate.markdown b/source/_components/fortigate.markdown new file mode 100644 index 00000000000..68a1c761852 --- /dev/null +++ b/source/_components/fortigate.markdown @@ -0,0 +1,81 @@ +--- +layout: page +title: "Fortigate" +description: "Instructions on how to integrate Fortigate Firewalls into Home Assistant." +date: 2019-07-07 22:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: fortinet.jpg +ha_category: + - Presence Detection +ha_release: 0.96 +ha_iot_class: Local Polling +--- + +This is a Fortigate presence sensor based on device detection of the Fortigate API + +## Fortigate setup + +Configure the Fortigate with a USERNAME API user and assign its minimum rights profile : + +```text +config system accprofile + edit "homeassistant_profile" + set authgrp read + next +end + +config system api-user + edit "USERNAME" + set api-key API_KEY + set accprofile "homeassistant_profile" + set vdom "root" + config trusthost + edit 1 + set ipv4-trusthost + next + end + next +end +``` + +## Configuration + +Add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +fortigate: + host: HOST_IP + username: YPUR_USERNAME + api_key: YOUR_API_KEY +``` + +{% configuration %} +host: + description: The IP address of the Fortigate device. + required: true + type: string +username: + description: The username of the user that will connect to the Fortigate device. + required: true + type: string +api_key: + description: The API key associated with the user. + required: true + type: string +devices: + description: The MAC addresses of the devices to monitor. + required: false + type: string +{% endconfiguration %} + +### Errors + +If the rights of the profile are not sufficient, you will get the following error: + +```txt +ERROR (MainThread) [homeassistant.core] Error doing job: Task exception was never retrieved +``` diff --git a/source/images/supported_brands/fortinet.jpg b/source/images/supported_brands/fortinet.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b764105fc003a910c81825be00e94dd1b40e8fc8 GIT binary patch literal 12302 zcmeHt2{={X`|m!ElR1td^Gq@inKEXGq)eGBGG&N5rew^RlDW(>D;YCJAyY^qnKC4j zAw(I%k^I*|8NT&Oa6qBEw|(qjO?JTr2s)#gg|Dp+>&`PvgwwLX$zB?m4hAN z*aDf&&ej>!VKZS`LTGVC=PbC=ZT>kzT97g%4>3WekTYZr*+NbbFSuR-G5fQf(59Ul zbQRc`fgA<7LJq*f60!oeJOFiu93cyEy##OzaM%I{NSN4Tt`M{nQ^!k3G5$c42~R-~ zVsv9;feV6g5+GH;8TaWz#t6effl*X_Nc}-E!kf?Eqn43l%}p{RfvySLp!l|)xL}z$!`<7= z<4lps5XUcYoz{}IfcN+sW;%j~PMjQh*7=HhUECFn#m{}ChujCh8a91W=CN;)CeZ=? z55X=4_vM)_A!c2XPZVuzS6=XWLy(O_yXN^SWXn*X;3S#Wrl**N!>Ym--(lk#5OnZ< zlAvW(J0jOh(V>Yhy#sLp1vrPSUdQ*yY8XvK&^jqSXb;w!1R%}%&Mv(NX6lcc0<&sB zS=rjY#ob38tSbMG7idO5rA#&Uf{7z$IUy8YI}_JBEzj)@3QjZM?nuvG=QW#WjTRqc zxWzS%L5r1adkWFM%Tl)n(nLf(Ok<7%5X(=d^Of2I;Z-J3V3U&6Ym1(-xa1KjRE*ow z%E~PeoLeVUjAxO2zoRggO!Jd6-ypg_A}WsJ-HsMR6tz^ck$qPfduyQLvGJYUX5sX0 z(`_%yoW|;fi-lQ97!-cT+#3`?+8t#0lZG#7-)fO^j0-k8wGU(*MZ`zF!9eRQZsb|67%mOP zn1Fh)Ub)rP_buoGrf~2B*^?>!m7dY#ppf8@(}H%OaGe+oFe0V6eo|+IS{g{UiL!o1gYl81mSsYxG;UIDgFHffIFKCl@KqGsg{!w76cL%wcEAy%$uZ z#eIMBMN->Ib%oK|?@ip7bt3OkPVHzhM3>ZS)(dFgwzJZyw`x;Qozf|_*-LO^lWy14 z3z+r5RM6;>pUnTpAcd>Pro2*j*cznAkgvKNk|vnWz6T!R4=sZY<{WD;Ge*!AHXT`% z(>o7PMEuc9rD0u^6`z#eBOeuyl0U^X`;f~0pmCD(^+1HhbVbpDFKYnh31*0>sRUx6U%O>F<3y5#I@@$l9r_o6|N#*(K&=EQaINDmO;Ac zW&L$I_asHT4w?iRLDdxSPSa@; z6&cc3P{Qq`hq#do7CG$C+V~dK#2h^ac*7_HR~bqr7OP0Ptx`|4PCe); z>5hCqLFxLCwxZhZL47tt->sj!W05g*3~9H^(3Zpgyu7k-r?N9-@Pp_? z@99r?u7gRMy);GVDnHH%kGhDxE^kvOpDv(yuHe~|8$Bof?6vs&*9%ulbl1Nu%k=4? zFYL0P>zdktCLCv;Za^H8c?P^g_Ac@E&l1MpqkEp$wvEneP3x+3ASZCvO+s z`Z3MT9){2$a!=ADodqhdlOAtCqJ}#Yq3B(^eptk0XR2x!XSt9z6+R)@s`|m?yi;m4 zE*=q}IE0$)9t<+P+_8g^?z+7_b^~At4BC=CLua zl-mi01-8Z%S|m(IP3)26LYkxkg3KDI&E*KJShBDU=!86Z@nj_VO2P?=!yRh3OU|a* z9eg~>(P81IkzaX1L;gOQ)kDR8&JNKar!#3=1^NKz$f=^*2XyW=0l$ra2l+P{j3+3& zaSmh!*wR=KaeVZBCEle*>d87GHF`#B` z>vssPwM7{Uw}yw($O{%vZa@mQAr#p&RYh)Ri~by zxsCobbgG>!E&pi!XO3Xd!gYtM?3TAX^r%M`?>2&1cvXNHG)(3MPsTs>k34xxmtj%< z@p2kPU=>NO^kjg^oFX@|8#5VsmLIELFVUeav!f?>;ri|!`1L~=BRNMs-McCgH`KcF zqEha8o?s7ovG;7Kqb8YRQ6nKa)4!9uzcTnO}B-_ zhOc6nav@M{e-}0tj2z6JcX@tJYJV3dO0V=;T69{Q7ZFLsXsD`L@9TVtDMPtDxrsB~ z@$Hj-!P*jKL{fog=jFx{Z8-2`A{LVDA0(mfx^ix5lf!9ztHaU|f36e}uNPv`CetXtoZOyv0 zNSw<_40=*h`PW^~f1Qv2I$PqT^rW<%n0psmF)}8~dZ8!u`qkZBADn`F`l&w0UNkw{ z7AUI}$gdhJtKY!B$|j- zj$iUuSv$Wa^O_EKQA#b3gwjn@u5H>cIDtp*!w*Lx*now$K=w@vjk;_q9R>U>6NTF^ z7j9FA=n!(H2K?5@o0FCGKJTd3OJ9heG-{V$MuSRvIbI;>n>5;hlva(x+AgQMOA~yU z{J`C@`r3)#GSxNOS~6RA=g30UORP5BWbDth**QpGaD zxR`CUbELfBm#t!L;Q6dwwR4D?G<@+eDSka)MSr-8V9b;L@KefK+Dc>L4^yi~p?8e} z=Bq>RULY7dw{A54Q^9;Z`hLjUT~v|Gri<|(8tlH_!Ik0=E}5~5n*1y>Y0M4sH>G)e zk_dc~i>oBWmv6_OKVA3n5+#{{pMu+)!u&7xM+tVY@;HC0o~2YPmt8z>cmY}r3_D>G zu;9ZFAmCUyzrKfn1z$io5*sNfKZgJxN(XHPuYfZEbWG^0)az;)}3(Wp2$SkPafu<~Fudqf4UAXd_gM&+UdURr$# zZL(xV2QA=+FU^Yl4CkQHBUK;a>^=A?!~V#uoQ3-5gY8-8qeI`#Tyv1kDiD}c&n6a< zzhFCes+zb{?kB0hPg8>>g2;{m`p`DzC5my5PJ^GM-+mGgd$KWBwX09@CTmpi(igs) z`E*0m$aI}OxvD^YN}_jFwLdAscK7`$2!1^LqIa^bV9xmk&F)(Y#v2b!hjQ~!4z7fX z?Dl3RRl6Q`D=p5eAwsEmijqCOOp-n^Y>KzMf%Ec&94%IQpsy&rqE~m4C52-lgw*;hN|>5_l(k-Zxtr*t30O{wr^v zIVp)A+haZjt=!jfNix2FcD>(Zzywdzv-$bw{7mBVNYb4Wuv7WU-vpNfBG?sH(x?fC+kbRcUpKK!9S(<&P+ zbM>A!f(SN&E;2jX!~Nb2bm{2xtOCKfX^PoGFigIE*oxq?evha8${dLCCASyuxtC>9 zJzPMiAC)$(>H&RIEeQq^byA_xH0VKN`t=j8!R`9_{keVd?$2DSIN@V!$mvcSR763tFHewL*S9dzLAKNM{RxsdhqBW zc|P0d&SYwN|Z zglBRs-f#NyN6H@1zob8^Ay=AZGe|qr0mPa!c}|56gwerJ(yXwr8PglA>$i^vy&C)e zJ#jDY3YL(SQ`}i=?_Ku}_e&AWPZxqqyv{CjWSraW>V>>4r+d^}*={-afu)~meY@u= zf471A;L^`(oGv*p(yu>R_D2`X#_&PhPL^q zypUy6*CQ|Xyq+!nd5?Sd{p;AP-0f~Wz$?337rFAJyu;q>(IV9`joOx*2ekzpQvIR` z>9Q`4Dd2G7Ib&C|-5;C%bXK*cK;e&+{UCdWh06K!L58(6TrRb+wnNaz#2ytf68`Jkfh_X|q&09+{&<%a zwJ-($+f20f^HVXOwbr?eGgTMEVDO6-W!Ps3ybH5`gO9wT_VYF&JhrQTA8R!nE$+NC zK&US6r5$F4UVESAVKF&=%n?B$>wUvUEILL=f4E7$P~dhm4=--&k33lME z{FM#pp~JRzz>~2cdCDSD_~I$mp++fkBNa10di;hujsV04WM*6po%4x)b+nHMWtOTR ztGF2Bw=5(pzHsBS%h*h`xZs=I(=2XUjT=yZdv8oD>hXHIRs{ng{czq<2D;yj*+8e819_w*8TsFdy~^JEVtbmAt%O|}`3o~O7|>tROK zC>RVfi4ZF(B5yr}|5xMKEkrO_nB_6GJ`a{PBg@J*6f(?B>9Z>Aj#~#&a=p;yD%1(e z)iKSX(9hm3Xe=(un>;^A-rV5| zrn}5N-4?A%CsoJMU)Jtqm#ktI7^}FZ+cz6h3>v(!S?SFtFqn{iIcND)v^}G+zLmu@ z$97q%546&=RqTc;ZQhVv9ipozlB!8A z{UhVI(UFc&n9GMx9p)Cam`|IViR0awqX`EZd_=r|{DR=0&I~{9&G+zL`Gwd9kMeIe zVymk`lT6wP>VNeddgjWAt6P_H#In(`-<={Ta9x`6etnNPjm(>>UtQ-h04MGjs}{Gv z@x^)M_jow_aRYigS3f^Q_vCKeZ}gl`(yPPJc-5Cxrg>F5s!83$NU0gZcxw#~cs{S)Y6)ArGHy)9uF)NTQ=%}Uow-x zLuzBI@zT7@hTT!|*0K85lC-`}OQ6_;!AjGciEdWdN1JXjDhtXsptG`Ia&G?QwE4zO zvd}K|A9sdTug(4VFbDFgg@Wp}Jddp!u7mDFNTpypk$gTJ{N5tAiA!Ve!y#lZrct~Y z;%+_!Sz>U^ugUvx1q@EGg=b+d6!R&V3nK>q+bQvir|1>`k8MJ05hxB|$lMr9#I_Zt zo)BdGe-kGX9}N|s^VquYe0?Y=iv6{cpc>4$Ouo46KbSzy6txfza$jW(p9xd5z43u# zaOr>IF`M{5;*4a){GFveR#t4l448ymMeaS(Cth|vwITuHG`7` zv$J;-`BE4wZ_)@pt7s;eNl1X4b(j>!dluTgQMd_;Pr?lGyc==6a41b{?el zj`e6Y)KhP-c`B>MIbZ$RV;&dXiIT2$;vBZ|Iyukj7M$-4ldGn`#X zq34_ZRmTWFJ(`fP9qS`6@5`j9U2smVwoPq7MKPR)7hd$6oKvfFoy*tE8vFXZY#)$?_zWH0 z{&_$)W8z^t?ej;re}UJ;nV^NybzP6PR zc9F>G;ajZj$;&H_`W?_RgYw4^fwX<6jXUm@>vWNC3}S|T_o+aUX)L2yw!M``GMxUN zbpZL^6Pas;HJ9Y?cTSZjx^%%uYlOFG4W(%>=H z^gOXd*`+9lEj@f%pYgL{gMWElY)KN2?SaM&!UCC&w9_rmy}| z_E~>1R$O@~dHU2h?z_X)&+y&Rbkb3l*0+r~OgY^Uyq>)yXQtaaNh{S_=gXGbb1Q4Zw|gOtAOF&J#=O*G{N)UKrVX4(Em}{*;_jRL{_JRVaQ_b`v9jk}NM?=XcSNbgO>RkW}aNoP24cYq3!uubI0&$G6)OEu+fv)Nhyt zrsaMSA^8+j_nxJREj#&X=%hzZmkJ6^ zUNbQZ^#>)!E0S47?sxF4nd2shSUe09M#)BQdtk#3g1EQ2z~Ho+1V zIl_(j=tdPq!)oe*fN8@i0;WnRLYqPZi3eJzLPDPnu8xG4W3}q{&`Aace!{&=9rELw zT7b%j)sfd#ZCUT8tJ+fty|v0u4LpAy8N)pW)0HE;Ex=*kl`Onk;Fv8cG3Pi5XE|$a z=G1pX#o_oZR>7)sma^RL1fq7c&Pq)eW<4Qu!nlZu$KCx)kL!NG!ryz|*DUOHPnM^q zDxtKJAYQCe`BCdg*|Yi!CNPU|fcGpVYW^ltztGD@Oh~Qs=WOkmdQxzNBB>5HR0&fD z(4sdtQ6RIJtZ60}r5*l~c2w{F()Q-6`*`J8av<6Y&C+}TYII(p?rpU+7QFBAR}nwa z9!5rbEt!s?_YDLkA^!#Sm#-Q$%ew;ot57>tna zVHC=hay-12XmMv4DQQt;K-}gZ=={#hn}(E#{T^RRA=LIdO4yB9H#*NHK^j6yg1Kh; zjfEj*G>sy`m#KPoiui(tzLC7|;>w*GWLf`A!C2rl%CR%h!WzlhkPI1n9PILUbK({` z&%=<-7HxJmE~eTU)yFFcraiVsPby(RX>*0owA)bM5WM_`USBsYy-UR+bHwdVFWAqp zuT}11vfPeD!3l$#qY(`?;}x;K=A5o@^JO`0&m2eQpPO*ZQ9W{bYfyU&k=zwO^|Cld zxFQAo4~wxnNf!39ERU;L#g<=Kgvi-jhh~3F$hb_hFom)blR9HHm5w~BpI_K=aNV2_ zyXX+bLx!=DH3-{R?(0FP5_|fWigr}G^5OcLDMJ^wrdu1~?IMy?Gx_XrBlgrgI@x6f zb?m)Xh9dOsR1FV#P9LF4R72gujb<@%+#0w7LU^3i&>1tb_(G->lz3%|u&0krw@alL zKSd!wI(8w^MqTrfv{J?r&E2kDB86W++snJ`S8Cplsk}s)X}N`{Oo?!0btR?$3lZ^_ zDYiN1@e~0*8ASwF;UC=EsB7pe;HZB?jq#)7Hu{+UoBkVt|3=`y5%_Ne{{M`?{{WYv B_4NP% literal 0 HcmV?d00001