From 6bfab3bda171e047807827ea6e30c0a5558ba00d Mon Sep 17 00:00:00 2001 From: Lord Hepipud Date: Fri, 11 Apr 2025 12:09:21 +0200 Subject: [PATCH] Updates documentation --- doc/000-Introduction.md | 12 ++++++------ doc/100-General/01-Upgrading.md | 2 +- doc/100-General/10-Changelog.md | 2 +- doc/110-Installation/30-API-Check-Forwarder.md | 3 +-- .../12-Custom-API-Endpoints.md | 2 +- doc/images/02_icons/iis.png | Bin 0 -> 7762 bytes lib/core/tools/Get-IcingaCheckCommandConfig.psm1 | 2 +- 7 files changed, 11 insertions(+), 12 deletions(-) create mode 100644 doc/images/02_icons/iis.png diff --git a/doc/000-Introduction.md b/doc/000-Introduction.md index 0504969..884ec6c 100644 --- a/doc/000-Introduction.md +++ b/doc/000-Introduction.md @@ -74,12 +74,12 @@ Below you will find a list of currently available modules published by the Icing ### Extensions -| Icinga PowerShell REST-Api | Icinga PowerShell Inventory | Icinga PowerShell Api-Checks | -| --- | --- | --- | -| [![Rest-API](images/02_icons/restapi.png)](https://icinga.com/docs/windows/latest/restapi/doc/01-Introduction/) | [![Inventory](images/02_icons/inventory.png)](https://icinga.com/docs/windows/latest/inventory/doc/01-Introduction/) | [![Frame](images/02_icons/plugins.png)](https://icinga.com/docs/icinga-for-windows/latest/apichecks/doc/01-Introduction/) | +| Icinga PowerShell Inventory | +| --- | +| [![Inventory](images/02_icons/inventory.png)](https://icinga.com/docs/windows/latest/inventory/doc/01-Introduction/) | | ### Additional Plugins -| Icinga PowerShell Hyper-V | Icinga PowerShell MSSQL | Icinga PowerShell Cluster | -| --- | --- | --- | -| [![Hyper-V](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/hyperv/doc/01-Introduction/) | [![MSSQL](images/02_icons/mssql.png)](https://icinga.com/docs/windows/latest/mssql/doc/01-Introduction/) | [![Cluster](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/cluster/doc/01-Introduction/) | +| Icinga PowerShell Hyper-V | Icinga PowerShell MSSQL | Icinga PowerShell Cluster | Icinga PowerShell IIS | +| --- | --- | --- | --- | +| [![Hyper-V](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/hyperv/doc/01-Introduction/) | [![MSSQL](images/02_icons/mssql.png)](https://icinga.com/docs/windows/latest/mssql/doc/01-Introduction/) | [![Cluster](images/02_icons/hyperv.png)](https://icinga.com/docs/icinga-for-windows/latest/cluster/doc/01-Introduction/) | [![IIS](images/02_icons/iis.png)](https://icinga.com/docs/icinga-for-windows/latest/iis/doc/01-Introduction/) | diff --git a/doc/100-General/01-Upgrading.md b/doc/100-General/01-Upgrading.md index e1f7697..d090099 100644 --- a/doc/100-General/01-Upgrading.md +++ b/doc/100-General/01-Upgrading.md @@ -91,7 +91,7 @@ Please [contact us](https://icinga.com/company/contact/) in case you require ass ### REST-Api and Api-Checks -With Icinga for Windows v1.7.0, the previously separate available components REST-Api [icinga-powershell-restapi](https://icinga.com/docs/icinga-for-windows/latest/restapi/doc/01-Introduction/) and API-Checks [icinga-powershell-apichecks](https://icinga.com/docs/icinga-for-windows/latest/apichecks/doc/01-Introduction/) are now directly baked into the Icinga PowerShell Framework. You will no longer require to install these components in addition. +With Icinga for Windows v1.7.0, the previously separate available components REST-Api (icinga-powershell-restapi) and API-Checks (icinga-powershell-apichecks) are now directly baked into the Icinga PowerShell Framework. You will no longer require to install these components in addition. **Upgrading**: If you previously installed these components, you should remove them from the system before actively using Icinga for Windows v1.7.0, as additional changes were made in this case. diff --git a/doc/100-General/10-Changelog.md b/doc/100-General/10-Changelog.md index 553080f..dbe69bb 100644 --- a/doc/100-General/10-Changelog.md +++ b/doc/100-General/10-Changelog.md @@ -376,7 +376,7 @@ This beta release has reworked the entire handling on how thresholds and the che ### Enhancements -* [#383](https://github.com/Icinga/icinga-powershell-framework/pull/383) Moves the components REST-Api [icinga-powershell-restapi](https://icinga.com/docs/icinga-for-windows/latest/restapi/doc/01-Introduction/) and API-Checks [icinga-powershell-apichecks](https://icinga.com/docs/icinga-for-windows/latest/apichecks/doc/01-Introduction/) directly into the Framework +* [#383](https://github.com/Icinga/icinga-powershell-framework/pull/383) Moves the components REST-Api (icinga-powershell-restapi) and API-Checks (icinga-powershell-apichecks) directly into the Framework * [#389](https://github.com/Icinga/icinga-powershell-framework/pull/389) Adds developer tools for easier start and management of development custom extensions for Icinga for Windows * [#392](https://github.com/Icinga/icinga-powershell-framework/pull/392) Adds support to read logs from Windows EventLog while using `Read-IcingaAgentLogFile` * [#393](https://github.com/Icinga/icinga-powershell-framework/pull/393) Adds generic reader function `Read-IcingaWindowsEventLog`, allowing to read any EventLog as stream on the console and adds in addition `Read-IcingaForWindowsLog` for reading Icinga for Windows specific logs diff --git a/doc/110-Installation/30-API-Check-Forwarder.md b/doc/110-Installation/30-API-Check-Forwarder.md index 079afa6..23db7fc 100644 --- a/doc/110-Installation/30-API-Check-Forwarder.md +++ b/doc/110-Installation/30-API-Check-Forwarder.md @@ -97,10 +97,9 @@ For quick installation, here the list of commands to get everything running: ```powershell Register-IcingaBackgroundDaemon -Command 'Start-IcingaWindowsRESTApi'; Add-IcingaRESTApiCommand -Command 'Invoke-IcingaCheck*' -Endpoint 'apichecks'; +Enable-IcingaFrameworkApiChecks; Restart-IcingaForWindows; - -Enable-IcingaFrameworkApiChecks; ``` ## EventLog Errors diff --git a/doc/900-Developer-Guide/12-Custom-API-Endpoints.md b/doc/900-Developer-Guide/12-Custom-API-Endpoints.md index 66a81bd..5f62fde 100644 --- a/doc/900-Developer-Guide/12-Custom-API-Endpoints.md +++ b/doc/900-Developer-Guide/12-Custom-API-Endpoints.md @@ -1,6 +1,6 @@ # Developer Guide: Custom API-Endpoints -Starting with Icinga [PowerShell Framework v1.1.0](https://icinga.com/docs/windows/latest) plenty of features and functionality have been added for shipping data by using a REST-API. This Developer Guide will describe on how to write custom API endpoints by using the [PowerShell Framework v1.1.0](https://icinga.com/docs/windows/latest) and the [Icinga PowerShell REST-Api](https://icinga.com/docs/windows/latest/restapi/doc/01-Introduction/). In this example we will write a custom endpoint to simply provide a file list for a specific folder. +Starting with Icinga [PowerShell Framework v1.1.0](https://icinga.com/docs/windows/latest) plenty of features and functionality have been added for shipping data by using a REST-API. This Developer Guide will describe on how to write custom API endpoints by using the [PowerShell Framework v1.1.0](https://icinga.com/docs/windows/latest) and [REST-Api listener](../110-Installation/30-API-Check-Forwarder.md). In this example we will write a custom endpoint to simply provide a file list for a specific folder. ## File Structure diff --git a/doc/images/02_icons/iis.png b/doc/images/02_icons/iis.png new file mode 100644 index 0000000000000000000000000000000000000000..4db2fe68fc9dc52e1e54615f01ed242bf068d2cd GIT binary patch literal 7762 zcmai3cU)83vQD9e9zckM8bFFd0)n*ALl+Q)fPhj$l@cKIB8h+m1r$(0DN;mKq*v(z z(ky^TQKX|t??@9~^qhCjyYJll-XDAKto6-&Gizqn>|fT7yI`!#M9)nR005Zu^)P0X zC-K)sM?<-{sXDv?0H~_m&8_^cjLs|J@Lp05PIyOWsbDW33Jw6E)q;H-a30S70*=nE z?%pbh)%s?HfV-0l!cxu%W#psf?B=c)>gRkh)Yu#s>VZ>qLa3?Iql1+w1YXYm4g$em zp56qdU=_q~UM0%!U(-m0z;6+M4;6%!(FFl5yq~jxoRpjt3ZY6bfcA58Q8L5m{HaVC zsUY0^{e6^>$e^Ggsi3n`ct2O9w4$OS5+#F_k&&cGND@N4{T+fOy$M3UDE{EUI1_Mw z?mqtRcyEDUoDPoo0Dlz(f`SYDN$&6N@;AFT;m_q$0)hO6Af=^H$p0zs9PIud#D5|G z5chGz`{N02c%Q!(@GmC*g8!jN3E#h033l-Lcfv+S|F^i8*S{=-;IAD>3B;d4{THA9 z+W^5l#K#$F=1jl`_~D$j1D(D7g?>lkS6r0zy&PPf&pUg&`n#zhq-7NT7h>t|^bg<{ zm1n@OTv&L!Q;f^}tz-2!rh<@{K}!D(UHZ4suV5=(a1VC&w8FT1IeQZ*tbhCQH+tzm zp;~xPyx&DiX**NYep~x17fQb|BfJv@I{UvMeJ!mEes~vmPYOmb)72Ev*VZ~Gt$6O7 zq>R)bG?c_CQFPs1LNE^g6e$^$jGQD&R#IBpTpFb$cUI}_+0!T)B^2s6^KWU&esFT| zcliJ0e^s>rnxbK3q@?Fg@W=aw{GR%w)Gs>w{xSMv=;{8u#svg^XIjYt_bcuy2p>PZ zQvlA{>9=tT-5)3c@8Tci;ODI2N=dQ`Lc_(yosyvtfeXK?S3pKUhO#l`{#7N&&6z^? zpBIPx(>3I;ZTH{4p^^Xa9{pS3f9z9=-XC+6{ZDBm$iF%XW$;%oa`vV)AU{f{(az=& z2LOO1cS>IVkq-bsEGZyq;&hZLtWyn+cp@%kTWcj_`Q!nce9wIyeUB%M@}u>3SJlSH zgFg5bekm67of)Q%1lIIanPCiyUy68JmCTJ{ZOZ4iGUf}@;))Q_|qR#2~=x|)lq^J7k=4QuY^)`4;#zRi^M@c~YbRFpaxhZ|^!Hw3l ztps?;;OyloK9Lh~kVgzG?tU6mVHa;>cL!&kVj|BEX=?CW)kpJoDvsRqc3unqB7hRBK!53%5I~Qggj2DYn`!_dwhp z!umtFPy_RG&d5&F(*JFN&jTc%zWKc$fhL0Jy64F&gH<8Oxa= zl_y?jcB-vPTz~qMY6hgk;cS~rHZ;eS#mB*~wo|LH=jOR(d~Clwb6uGJW@3kk;yoBJ z;A8xC!@ITdiPmJX6*?(s|1OWZHWbQ16)himxWBOywu%i1n4mngn&!R`CM^Oif(A

~d(2Rxk_Chcl$=zb#7v51dwAiy;(AGtma&!rx2oKZAMCgG zPXTaYpaP&MaLgm@Y@9T0EiWtzn^4twLVh6y5YG$905ehzJzpO)zj>mit!3Ly?%9z1 z0Qa^QptX^oo)NtBY<+AtM!ZFDvMe;|)It;>UIhS)@!6Q5J`a@AD2%IWO8U%3EE@$i z(GhN*wJI#ZXjLWK&;&ao3W`xY7{-db?RJbZiAQ#76z*r0!u-puA8tej_I zX}D#9PFoz6G{Q2^l;W z=peNC007H~GCmq^8OYixZsCR1b6UUCDKum?oPFI@A*{`1kM6h7IA%|(48~*rmLVkCV*sv7z|wWaLpOC$9!E@*6(rP#~6$trUI@wQEJ;8f{q%QOR;Ax zWw8Ev+jVJGNXeh;8?eB_wE3D)YkVCFP-cHW7QOhst3vdZF&)(N!J3k2xga2?r+~Q3 zX1h)8!)Tp3G_7pMC$vuZNiiY{`Bu!R=~jSv?#xyE%Ib%TM-^R>F*s51L1n4rnmJZf z<13ZG#G$BO_1;C&SpNcvxE=&FUf&AlC^}Mp_2rZL<79%0O4IE}4w8wRfKui1Q#m8d z!3c(|Y#9*i`z?oL-h&y^k=wS0{jq6ng1jN?`U`9=Z)sK_@5zS4J5}FJWN3UvCs*$o z(9T2Dod)XlI@S_E#_EMAUp@bs*pN`$TiE0CsL1L&CZrC@6EC93k%Bl$8e{b#F^&U3 z5H?rz=`0lt!oxcfB(jm&BrKR0__Dx@dF>ITqleb|CwMonpwm8nnOy;U@v*wnt>6PK zXcV1Dxs0AJAUAg_PBWjC@B$mDr_k9%7JACi*1xcb!F`KOs;!D(YFTAVIOQS7ajBlw zHUsOGkpaMTOW#K^+4*kbjnKCrwTuH-^rT%>`>q0g@(VgmlQ_?Ir_~@ZtbS~=0NeoV zPBN63CcY|YTN7#g{GEKDZhQH+R=Ucb(Mv+&-ZV$O{X>AmQ|n~wF`5kCk$MIn6SIqc zAK2}Mr?8EtakqcEWW*grKLExXDtcdIjb-Nt%PZUi=?TIQRtmt^4eWq|FrT zrkjLJ$d_5SpHw4CLyd-vx|ee&_SIc6x)YFEcGC}c+X`A(+n?7`?JDg{QgKp81jehd z)V}XmVi}Q13bWp<%_Mb4XSS?@A~e52M2Ju_iycpsx@>rkL6#rE2ps5JIUbFQv_U|d zZ2;*);~MD#{mqw?5_&%u)<6WK_queh-KZr+Fos7r>{Z;63+9!7BuiDaVh}*v;my=Q z@5$2_hH)ZoA+9B1QnpVyFlTg9JqsEmER%v+ir%M@u@c*Z9n7E=mhUe)b{#U_gwO%e zn6$;6w60nxGfp0`qwYUdFPNpOrYEa&pvB(W-gJZYz{4w?f7*V@4TFhqqpDQu8GdB~ zU@My$2;k}`r}_WHs^G!^2SUb~KUpIJ!*2g9=R} z(d^X$-6TqQUW2DY_lnf(#dEaRZiJuX7=#>IWtMR$#)tw~atAvLt>bxVdH7KsQ*PUC zFKPIJXp@F~y!7;3HI)LV{$$^y&(Rr0nA)unI?*P9{bNhASPksb`GnDzPQYpG5CjSz z)@tu!%Coba45N#+D|F3>cf+kFtgQ25-flb4TW_BpzK{hFR*iIQVKUO>3>R?Rf6HJ* z?%Gyu#fOv0wiQt6CEO&T(wbX2xh$c!Ig>xvqL(N=q|yHV9jkODE#jefOgoil6!}RA zO`4QexOAOhxCIZ*-8Uws)p?tWBzdTeZ+0u ztYV$AhUXASPligB4$LPMYTHYs&301bkicx=r4q`Mq;z8Eg zUxGZv_TpR~0V1_qtHOjj=bAxqg?+A***lEu6C$EP>6$+$eN9FIfXat)0lVrjfn= zmC#1@JW@Zb{$#nX=*+pa*Hah+y6gwEcNjCSH2R(lkMfxh1J~ycGR2*M{&{p4f`=F3Tq*SM_>fU5ir2vuFprZ637!@ZlR`q0nV)Ea(_ z@7L*=z~^Ej@mNCtLJb+TfN;7!U3#^|5HeW+o6JgQ#cmW!gF2jDo@-r_NfM%YYoqF@uyu0Ryl9I%={HQl|BVTpf zMN>yAiNW{wO9ey=Gu|+He!A*J?a9RNP@w;G`Nj)}41-!5t@w0Va;yoT?H;G>@QUPX zgZ8h=NdL}di%m&YlZl>w=#RL1I_V16IKJJnZdF@2Bz(<5vemJ#Tr;O<^Pb}}_xncR z%0+493rl;W??XW+GwJWD-58#%Coxxv!)s^)qCk7Y9X3(>uWP82!|oNoT8P3A>9iI^ zSU;6>v=4kLFTGY+6*pWb$w>dem>yRkBzU2y44u07aL%h;a^YQf$O_n}Q)xUN%jJTe z2tPdenv;W!bgwowzIWy_GsEJ?=ZW4YN^=S%FXcW}=*oKiEOqY09r9&QFjJAfL2CCZlfc+iOs|5WYsOk?`P}P(>|f} zRkAPa@+o+X1~<0MQKeKt(Cq`YWq{zb`Z`_j@r@@{*$I4)GD3;HOi~^xVdTPzFlym9 z<~*$iS;A4hDiRfS!2vWA1ZT->Hg}m7)W8W@=PcVV9K@6@PGLdL%YHRN*OJ)nxvk|+Oe|P}XtwkH z^rIB@*q-`zMa{pEt8UA*-S`L@?=F!ckvzRuP7;>zQ`u$7m3IlazDkvu z^yy5wuAuwT6ZNye^QXp1YZvUfJNVKC)g~R)wZPcV?BRlwO)dQ>m<`#W(@1NlC-zis zrCfPZ^88E@(LGSJJkqFhM9{S7qrqhQS(fg+`)kfx`i~f1jRc@}xb%{X!yu<;4qT+e zY@S&x`L?p3Sc(>ot>eZWGsb%*y;kBGQ1Qwc>|Wq!Bi7gF1)Ov@26XpalklPGzIdQw zdZ;T7MAK)a`eaMqDbH_{-f<8%`htV7>F~&SHZ^z7y0r}r=%<`#1tP;zR zU=xJ+M?3XG5we0=B0!zfJ3xR4%&P8&)k~Ff`2fn-)evg<<$A;8fro%B9S+%h-x#D~ zne}p>UTg8O7w>4gVaF69aFqLYn?;PpQG1 znm|lbLTvE<)~#fb8j~(l)%Jlr;tP%ZbpAT7ni{EkoA-)-jLE(-#*0C`j{VB_w&HHh z^g+^Yl@Xv70cB3-g{GfMh~Ua)9}APp;E3c4L665B+`H4f)<=&kT4X1O+>R6?TTgV2 zR}%|e`l8xJ6SHWyGz(*3qg>*LsI;YvnbG!;Wb^5>?E_CM-9927yM1J9r#`a&a()m! z35s4*8nBgp&M^I?T6$We5rP;hN`Eu3E6pG-9KmJX$an9_p6L1>HJ@hTqpG94H!Ay~ z(~xYqk1C3%=n3ee^p57No-(&M+)^^{eO=e6<+GD7;by>waTL2a{0E>FoqB4ij#xU& zHk^8ZJLf!8DS;oA4-CT~BT$Y;@u%_CG}lX@mw(QX9g7;?VPJ1>_H^t$H;ET+@^NyF z=7QN)TX-MxPTuG;3PECoKO^^ps`a6tk(`L_s4VI%;1$M?%vW?r4COuyvRW$bD7Jp+ zx{u^tjB=|DRHt)b!OU0KQ}eEa-z~2C;DdbnFtlUUZ>j( z0k<-lX!1yWn|c2_T?C6T>xg$-@$GNS;2#^kLZ%t`YS$lqH@1+fS=4h=boU&8tHg!O zSd_1C&&?dzftdAAN&E9$E1>s&mCGz|bqZ56EDa?y5)7`v1srYXz7Iq9`05z1Y?2(v zg`cOt|2VOcaK!d$7l|v%>==(e@Xw6K&JzUT%5=}9VX^sirlC;m=+FqXtF?WK!9J+c zU~X0{yi>M^HUVUth;25M3*6*MFt=77QM<;4!3Ig!YV|D?-^Jk*%=y-1(oRT&if(iU z&<8BnC6{unz`;Loo=UzZuzUSke9fM;q`ZQu@xzdoh-W(Y1Coud zi8)M+G_`p3k7m#WA^dz4J!uZnUu*ZYFk=-eDjiQY@OP>j5>Uuz_geb;LRvGGt3vPl z=&S~RuwKWML>3fuQa=b4b-k71TiBWkjx&&h&Upr-&#p9TsJrD8jXxA=nSsh$iEeo5O&HjgW;8VYjBl?o(>>4QwbcbQ6zE`?G{~M4+l|l>Z!b+{AR$&hzLG zukb2fg2t?SZ6mxyyRguB-NM?*(P=9tm@@sEc(U~jaI(Cm$?HxQp#79ewBMB?Z(GJM z>@P(778DOTyBSc`fl2L}Z)wDjt(o7@Irlgjtq5jJfqkFyn(1ql^f(??TF2K)i9Qqe zM^8iG))LEzFRJ)O1e;cok4!dtIa0H5m+?$FX9|RCTfKE5k-Q@yC&9Auae*)?8lC@8 zJQulk_3>~b{Mg9;MM0+nEX?ux%L-E2*!rTjDs?d(%#}5F+=z`{o_$xpa_59#x|m&& zs-|si3af^x7n&P4voXukX6OBt<+Wp%1&QZp&9sSY5Y+nR>ZcJYnDRrPZExsV5`RJb zYtN{q4^3p75kPWk8l1iXs;E%gam09BQwc{s0c{h^GK};gJ2JsEkHQ+!i~g-ILi2+e zV3Yo@3`w4wM_u}*YTYm`*2OP4n6lIc;dE?sd%QC1u0?A|O4|tk6c;HKP>{OaA{}TL z&l?-OAsk?zdEN8clTYpCC0qg%`TSt_Lr@~^_^XlAh>EN8wWnDP(@h2fcsst$VO>1s z+aa%0xg4w>pE=!FZ0KYb8S4~(1ip>qvAgSv@Ia1d7#@>@QDg_$xO zslzlMndP(l@OQXejw<=?DZ_l6uAF2xSmb%AO`bSHC5LIt3*N|{k@&iEx$8Jx+}*Gv zc^tgUFzJGM{E+t(;MA`}uMm1)bFamhDMNzoBk3f&&~F(mOE<9 zV~xUti&yxg7f?nWJ34oH?m7LmVm{;*d=ivY8_LghjloAJ9q-Exx>FN;*R}Z6Y`e|P z=pJ5;wE9eji_kV>K9Mk+Y$ds<+4NeL>CP;y#~=_E?M5TY{^;wW|KYb!C|H=p`nVhe zNll3JZJvJf-svQ{&jsA+EQ3lw0|(E@SxIJnmkjD7-Xd?Q2hB-+?CKongV^}R(y3i2 zhZV2h^IXc_w`iLM9te!TjPo28cR&TYA?!49$~q5fo|o+zCZP@Mv0DugstJ$jb zx;>g(T5O1z$3X4Oa`9vQ3S6eELxr?HVpxF>ul_o{)dy(9M%hh| zvoNZ0g&XZW?E