From 52e01bdcef233ce69be8f347bcaaeeb18b8c7b96 Mon Sep 17 00:00:00 2001 From: Jonas <5180118+K4ds3@users.noreply.github.com> Date: Tue, 26 Nov 2019 22:03:07 +0100 Subject: [PATCH] Add documentation for ProxmoxVE integration (#10660) * Added documentation for ProxmoxVE integration * Fix ha_release version for ProxmoxVE integration Co-Authored-By: Klaas Schoute * :pencil2: Tweak * :pencil2: Tweak * Fix ha_release field for ProxmoxVE version Co-authored-by: Klaas Schoute Co-authored-by: Franck Nijhof --- source/_integrations/proxmoxve.markdown | 100 +++++++++++++++++++ source/images/supported_brands/proxmoxve.png | Bin 0 -> 6327 bytes 2 files changed, 100 insertions(+) create mode 100644 source/_integrations/proxmoxve.markdown create mode 100644 source/images/supported_brands/proxmoxve.png diff --git a/source/_integrations/proxmoxve.markdown b/source/_integrations/proxmoxve.markdown new file mode 100644 index 00000000000..f8f01727126 --- /dev/null +++ b/source/_integrations/proxmoxve.markdown @@ -0,0 +1,100 @@ +--- +title: "Proxmox VE" +description: "Access your ProxmoxVE instance in Home Assistant." +logo: proxmoxve.png +ha_category: + - Binary Sensor +ha_release: 0.103 +ha_iot_class: Local Polling +--- + +[Proxmox VE](https://www.proxmox.com/en/) is an open-source server virtualization environment. This integration allows you to poll various data from your instance. + +After configuring this component, the binary sensors automatically appear. + +## Configuration + +
+You should have at least one VM or container entry configured, else this integration won't do anything. +
+ +To use the `proxmoxve` component, add the following config to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +proxmox: + - host: IP_ADDRESS + username: USERNAME + password: PASSWORD + nodes: + - node: NODE_NAME + vms: + - VM_ID + containers: + - CONTAINER_ID +``` + +{% configuration %} +host: + description: IP address of the Proxmox VE instance. + required: true + type: string +port: + description: The port number on which Proxmox VE is running. + required: false + default: 8006 + type: integer +verify_ssl: + description: Whether to do strict validation on SSL certificates. + required: false + default: true + type: boolean +username: + description: The username used to authenticate. + required: true + type: string +password: + description: The password used to authenticate. + required: true + type: string +realm: + description: The authentication realm of the user. + required: false + default: pam + type: string +nodes: + description: List of the Proxmox VE nodes to monitor. + required: true + type: map + keys: + node: + description: Name of the node + required: true + type: string + vms: + description: List of the QEMU VMs to monitor. + required: false + type: list + containers: + description: List of the LXC containers to monitor. + required: false + type: list +{% endconfiguration %} + +Example with multiple VMs and no containers: + +```yaml +proxmox: + - host: IP_ADDRESS + username: USERNAME + password: PASSWORD + nodes: + - node: NODE_NAME + vms: + - VM_ID_1 + - VM_ID_2 +``` + +## Binary Sensor + +The integration will automatically create a binary sensor for each tracked VM or container, the binary sensor will either be on if the VM's state is running or off if the VM's state is different. diff --git a/source/images/supported_brands/proxmoxve.png b/source/images/supported_brands/proxmoxve.png new file mode 100644 index 0000000000000000000000000000000000000000..0d08aec1b21b6989d5799f86208a219a30f6418a GIT binary patch literal 6327 zcma)9cQhMN7q@E9Sk;;lJ6c+AR5_vd%-x$nOFJHL0%eeaxi-+d@^Q#}USTeKu3Bn$@n(EI;<|3B-Xru;WP z5!BH7=V+ej+Xa%4FcSW2q-he2xBr1uPYq0TsECwo0C_eSacJs4h|y-;WEH|s@LSMP)CWA_EqX4Pk#{RD3KSCX*usd@^|3${xwU|04Wjr^DuE3!pL5VPk1dBLnJ+!iGeAJY!*6JKEs>g2pLBM!xZpqy9IDh;N44StY`Mp@xnI84 zB{b2~dPp1+Zf*}bd6#tk?GQYt==ZD;qq&|%Kf(QQ`Lc1$%!Gb78%JI5x|I+W!R0zo zLpBtDd{8;mFM-w(;JTD1XcABaJAx{%lt;OIU&>!^~ms=*C0H~ zmMdzJ6$f-Odc0#fpG+vCOgNx(JC|!+3SlwxPs0pBt!djvS>=SCjKa~U_iAOxa3UCx zLX0_)L(dy+?k{`?DN4`24xlnLOU((!+;HkbiP2>h(arS1bu_|^xX#t;X@bOXR7$}J%V3t{CnsH=!Jj&KxClFVH0(|m{>~mHEob1F|hkF?LcKV ziN351F<~PAg$zH|kHG4>ltt$ePYMrdc{?Luv4Hd#H@$e#EcGb~vQToy8a>;90R}td zz7yv1ry?TA3l0zxU{yRy>2k+clYe*wgy}|G3~s$)eaH#ew@3}GUXlqYA76hD04@!j zKBObMVY$C0Rxm?5uTnSN&}X$(|mWHrpeo8niRgxlzA&&mM1l2UdaH5t))7v zkty)T>0fymfQE*Q0Icp)_5(TH7v~(E(y(5KGEsqshIg>B8Uf5FmvLbZDkH*W9!;az z)$0#)6+d-e_ipdxxow@7cx!FO5T+U8yR$abUrJSX#dJew#xWvUR`6U=^LfI@|J0k_>01J0XUjHIaSz+?LI?;J2vbV@j0>IH6jLcVk(~=amE&>(06BQXZW#6% z;jSb@Q&rHQvvvA?9#fUYw>`w4L9s8)zO_SixTkG@aXZ7ifvS4D$Q5&<4ISC6_R3e* z+Qx_azcTE=Nhv?r9aUt+FoCG&VC3tRTTC$!AC}dgf+9JW+j)hSL<88-!|U|syYbPr zX5Yk6)>GTueGb34!JpG>zSt9f`C{`{pu}fJz|Bn2`U>5ksxe^HeE#p|V?r%{puX%T zjY_3;#Rp!0M;Gq|531UD;Z}Lm%#mE$l)0c!2!R@_rvm;>AHPXciV(z{)S;#0kI_$1s7Ha8o#H6uGr0A+(Af1 zJ3t@6)*j==%4OUVUY4>H`OpC5B{W!mW&^Cwt>8S|bDlC_9p!N`;KqGwV^3Pf-&v6J zM~$>e_S_n%MyaDiYzEFB5#S9%@Pl}3_1B)eR3B6&#IWgz*nYF04yI5|iue5y@WD8IrU$Z8&HD3kW7m$^$oZqE1dLb-5$J6K`LtN21?zzlcq7qaMi89DrZg8QTUQCuC0h$>p**l(KB7635D>nbViM!s_r z+Bd!E?X5wFywlzJ94VeILsX*!p2f}>y2Hkznfp8v)*M7Z^njn0myUTWTt>jGVlJQB;InQa%#DIAP$|eJ!7wb*JDngsd&s@m z{d}ceaj7zTp$>%I^k-Tl+y7f@V3n&i)h)X(nxyXB2*NbwN`{dj@n?3FV9wkTGNSfKO(o!=vK4B=YsN zWmszr4N0VS4%PeuvdGG(sD#ZD1+I|e+2WW_3Fa+!L?l$G4Wrk@=U!c9v zzn~nVeG^DJPlVX68O>$}UL-!W{S!!hHn1$Wv_J(OF?c9ApR-T=5Q!>FI;|6e8;?f^ zg=X{?6(~o1o8Dq1AF3)n?M*5xx8hKi;y9O_ zTP}0jgoCc+4CUT0aytA1y=V1wtB<|><_@{bJNx}ILhbP8NZYanON3rZ-~I2F>1;+S zL{$l(7_0U?DY?rF7QG!BZk#@%_w_-|7K4#qjfr*W z9g86FcSAa|rI>z&G7+UqwVnx<$Jb-pcD7EKiXhv0dVfTZOWMbEy+2EO3 zKi@|XquNAeWwBxP)GG-0m9{LOQub-7Q1Y8T!abE3MDD)=<`Bojh8K_YQRBed>lOQg z%$o0^B35g z62hr{K@BP&fyp21Ln`c_CqV9u0O61}m=GX4hueL-Spm>jd(&sC0J5<@o|jZEwg*=T zu|&Q%<3Qt=HuunXN{>NafD_x0#ON1|G5S7w+~NG|OzCZX*4bOXt9q35W|RiRvQg)0 z>1%>>0)TU%()VuRNz4PoJemdtdFe#6x0h=1?QwWMp3AYe&0qtg? z2iFdz`YogcVvHL?R^Bgo`L$YN2;kQ?ht*$euERuS_E;>s(GJkHIj0vWzs*va%V!DP z`-XVEsIJ%8rNSo$QVWm}im~Mbq8@+}kY@IPzCJ=R+I8w3A(;Nw-I8jYv8sX9Zq=hQ zZhyQhS{_?WI7^5AVms9M*VF|v^4cUcHq)WR&uWsTaC>*u*lGPAMgj2cD7Z z^)T3~MuSSUcZnA}+OQW08YqF{e2pP{xHrzCxR^qiCXG;}|9DjXvaplQf$^cEVPahkP4 zFIJ$k;$>>@oE^fT6!jyx8&f%Kr0OdaC8v|}{?url!O z7f+IfHLt9tu*NBdCRKr@R+&z;Ha-D#d+@s4L7H%_@^YRO*QYq0KOSMED$x7)YQ9E) zZBUK$B?0}*fil65v$i@a?1*dIA$m5It?)Go(a-f+C4R+p!!df6{%5c&?^%LfEW-{x zo!^FQGefLF7wf7-<=wH!6#mF`NN$kkd*HMqlmCl)`hCp^JO7lIW9(sD zVfsklg5xnwfxV(6Kg>imYitJ#u@Qeelf zG%h)JJr0k$4gH&=a+F03XZCW$$v7Rr@O=i0fJ5Go0PB*aJ=Uoli$LeRveO;Dm`GW_ zhpCg5GtJXyzsJtirWrH*Mm&~xfVh42?B@GcILEQogMl_b!QwOC*`2Sv_Q8fB1|N2W(FvU)T(&k3y(n zwOJKg<4?zqa;l#k@p$TOSA{C%?>`?ZDcpM$bIz_^Qpj(v>vH9qO8K!?(HaK+!9}hoABic_w}{5bcOWHZ)oEXSEX60-{Nf-N3+jNJ+sNY zy}#JpnfkrE@p8K@5Oqw7>%6xGaui9@A!H$b-6RA=M@n4sM;%aXwKIFR?Yp0jg%%jx zX2Z=2#u>PNueY@vrN>2b-#U28vxg?OuN}1{qTTctPXi(Wu;yk;#_YAriGKCR+Zi6x9I3LFLC^)2*Zww ziGHSqn*qP$BpdQIgZFPg-F~5{kE5hfkk|{4{@bUo=?Bm^DS&eB;Z;M9RWbUCOoP%< z)Jp1%lTGnD^i<@V6f&aS!EcFnm2ZGa4Knw;SZn9PL&~3~m9?6V%0xl5Ux{cVm*=S$ zxpeuji%!pPB|O=KJ7yS>d2?!kWML`6f@CdPx|a4g4!pEptSyGnxh~*V2K^gp2-3=( ztpSOr5v~*y-6CZhp4;5))PftIC*pLBrCJze2(L6kU_TV-ZXkR<6ULXYnKytd;(_KZ zFAjg}RZ$n3A{$uZie|w{5kPtTbhO5^=g>?^vZbW$R_fiK;e~&tX$#{IoQoF4e1x^u z&>ExhQgt6v-EaiMgucN-t@0au}(jWp0Sy+YRh`?KDi>Elvyoy^vuHVZjzdg$uX;(N+b#q&K+6IB>!fA~>mO^#vbKCtvRQCUzf<8mrqHQp znZ@%=WO;k#;e^9H@F(}rcu!+vUMMGH<(KeA+rlR7o+^ZqZoG-ApUV2HRmx;x#AaJ` zilCxWen8?IOa2I*wl6d**JM?nv@JW~*&=>{??#Q#uO}l^`>03{PoGtdIfF0iO{(Mh znH7@s!>Qxl&~X$rmGBMjRv~g>{T7F>h|axuvhGfDE!ybzlOnYUMdz=^5*AAt*$v=; z)=#C#^;xuX5Pjy@z4tAAli`DQ#Vvfv6f$#OZ}>_yj$_*zQ-m8k9Y3%#SIazQorAV< zY5HF};Y7C7dJ-y1q*5Kbucww7tH!8wayVj{`(fmlf2#@@Mq;jg=`LjK-xc#Pkn>_? zi++>{F)I*LbS}*Q?Ie1;?@=ttzNp%e`_i;q2P#8iFzcqKx$=eBPn9i-kR(>}4qVK< zb1eS##GUMDW_{L#5`&DnmHA$k#J9VFBXM~;rtDjTXX$$?PHbJzZ-IVBu0A6@q<5v% z8>G23L&!XLiuR?0;jya%v1(djpEIIgQ2O1h$~fYg>SYKP_a|#gocv~n`l2?P^1a}I z|3VoaJiWg4JeKy7eqJP!bdz6`f-POCz08cw>zuX%SUT9h3&+@iJl@R_i-S< zS9(F7!|F*KKwt1IwRxDGOI+&9Va&fPy86*s6FkPv@;2u?TetFh5YaP{(sChB8kqAb*9vX+W4LROE=Il Kg;r^~y!sEo0q}eP literal 0 HcmV?d00001