From 45628aa0d9055f43fe0a91d9232069d0b05f49be Mon Sep 17 00:00:00 2001
From: dormant-user <svignesh1793@gmail.com>
Date: Tue, 26 Nov 2024 06:53:44 -0600
Subject: [PATCH] Add disk reporting with a feature flag

---
 README.md                            |   2 ++
 docs/genindex.html                   |  14 ++++++++++----
 docs/index.html                      |  22 ++++++++++++++++++++++
 docs/objects.inv                     | Bin 2001 -> 2026 bytes
 docs/searchindex.js                  |   2 +-
 pyninja/modules/models.py            |  24 ++++++++++++++++++++++++
 pyninja/monitor/drive.py             |  10 ++++++++++
 pyninja/monitor/resources.py         |  14 ++++++++++++++
 pyninja/monitor/routes.py            |  24 +++++++++++-------------
 pyninja/monitor/templates/index.html |   2 +-
 10 files changed, 95 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index f50aae3..0c658cb 100644
--- a/README.md
+++ b/README.md
@@ -58,6 +58,7 @@ pyninja start
 - **NINJA_PORT** - Port number for the API server.
 - **REMOTE_EXECUTION** - Boolean flag to enable remote execution.
 - **API_SECRET** - Secret access key for running commands on server remotely.
+- **DISK_REPORT** - Boolean flag to enable disk report feature using [PyUdisk].
 - **MONITOR_USERNAME** - Username to authenticate the monitoring page.
 - **MONITOR_PASSWORD** - Password to authenticate the monitoring page.
 - **MONITOR_SESSION** - Session timeout for the monitoring page.
@@ -153,3 +154,4 @@ Licensed under the [MIT License][license]
 [license]: https://github.com/thevickypedia/PyNinja/blob/master/LICENSE
 [runbook]: https://thevickypedia.github.io/PyNinja/
 [samples]: https://github.com/thevickypedia/PyNinja/tree/main/samples
+[PyUdisk]: https://github.com/thevickypedia/PyUdisk
diff --git a/docs/genindex.html b/docs/genindex.html
index 80d63e3..e3d2f2c 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -112,11 +112,13 @@ <h2 id="A">A</h2>
 </li>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.api_secret">api_secret (pyninja.modules.models.EnvConfig attribute)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.apikey">apikey (pyninja.modules.models.EnvConfig attribute)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.modules.exceptions.APIResponse">APIResponse</a>
+</li>
+      <li><a href="index.html#pyninja.modules.models.EnvConfig.assert_disk_report">assert_disk_report() (pyninja.modules.models.EnvConfig class method)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.Session.auth_counter">auth_counter (pyninja.modules.models.Session attribute)</a>
 </li>
@@ -178,15 +180,19 @@ <h2 id="D">D</h2>
 </li>
       <li><a href="index.html#pyninja.modules.payloads.ListFiles.deep_scan">deep_scan (pyninja.modules.payloads.ListFiles attribute)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.features.operations.default">default() (in module pyninja.features.operations)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.modules.models.ServiceStatus.description">description (pyninja.modules.models.ServiceStatus attribute)</a>
 </li>
       <li><a href="index.html#pyninja.modules.payloads.ListFiles.directory">directory (pyninja.modules.payloads.ListFiles attribute)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.disk_lib">disk_lib (pyninja.modules.models.EnvConfig attribute)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.models.EnvConfig.disk_report">disk_report (pyninja.modules.models.EnvConfig attribute)</a>
+</li>
+      <li><a href="index.html#pyninja.monitor.resources.disk_utils_metrics">disk_utils_metrics() (in module pyninja.monitor.resources)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.DiskLib">DiskLib (class in pyninja.modules.models)</a>
 </li>
diff --git a/docs/index.html b/docs/index.html
index 8719566..9c4a205 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1722,6 +1722,11 @@ <h2>Models<a class="headerlink" href="#models" title="Permalink to this heading"
 <span class="sig-name descname"><span class="pre">monitor_session</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#pyninja.modules.models.EnvConfig.monitor_session" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.modules.models.EnvConfig.disk_report">
+<span class="sig-name descname"><span class="pre">disk_report</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#pyninja.modules.models.EnvConfig.disk_report" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="pyninja.modules.models.EnvConfig.max_connections">
 <span class="sig-name descname"><span class="pre">max_connections</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#pyninja.modules.models.EnvConfig.max_connections" title="Permalink to this definition">¶</a></dt>
@@ -1777,6 +1782,17 @@ <h2>Models<a class="headerlink" href="#models" title="Permalink to this heading"
 <span class="sig-name descname"><span class="pre">log_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyninja.modules.models.EnvConfig.log_config" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="pyninja.modules.models.EnvConfig.assert_disk_report">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assert_disk_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#pyninja.modules.models.EnvConfig.assert_disk_report" title="Permalink to this definition">¶</a></dt>
+<dd><p>Ensure disk_report is enabled only for Linux machines.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>value</strong> – Takes the user input as an argument.</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="pyninja.modules.models.EnvConfig.parse_api_secret">
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_api_secret</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#pyninja.modules.models.EnvConfig.parse_api_secret" title="Permalink to this definition">¶</a></dt>
@@ -2367,6 +2383,12 @@ <h1>PyNinja - Monitor<a class="headerlink" href="#pyninja-monitor" title="Permal
 </dl>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="pyninja.monitor.resources.disk_utils_metrics">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyninja.monitor.resources.</span></span><span class="sig-name descname"><span class="pre">disk_utils_metrics</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pyninja.monitor.resources.disk_utils_metrics" title="Permalink to this definition">¶</a></dt>
+<dd><p>Placeholder for future metrics.</p>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="pyninja.monitor.resources.system_resources">
 <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyninja.monitor.resources.</span></span><span class="sig-name descname"><span class="pre">system_resources</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pyninja.monitor.resources.system_resources" title="Permalink to this definition">¶</a></dt>
diff --git a/docs/objects.inv b/docs/objects.inv
index 83136d0101eabd378ad35ac927e600f54d24cc59..ddb6828facae63c9e6fc37d925e79b084e6ec5ae 100644
GIT binary patch
delta 1928
zcmV;32Y2|<59$w)cz<pqHxh^MehLNI>kvDOMGm<I6K@h=vN3D~IT94RBr#@_9g;0u
zIpsC>_4Y|p{L?LIM({L?eHx9_zmH_GSS(i4!^tS~yI}ANatzjaCdP2s45x2<+l?AF
z|J*3k!7Dq2UVojxd-spcySw40kljE0^5MrQ-;G8FWzFXOC4b-z<<7dT>N+qa^+A|U
z1CO6MIA<M+qKtIVg9$*>YdC`D?;EuLs?~NPh^_EInzBjE_7J!OX<bKcpABO(0&Q=P
zK%_W3;<R~^9g3E9R(fK)$%H~{p8ij!96;#2{%X|zk5M_A3uGzlPDb=fax?bZV#WFn
zFfhlR!eywf=zr>$P=R0|=tbbh`ZhpNJ#?UhAYz{3w6BjwMI0@_(Huni;M7qB;A-Ha
z>l}Db23d(}E^Xgqh@?`+tw!f)?u}P}0(Qk5!7UE4I}l;SHklm83J<@OG2RLHqD*~*
zjB91aSBenZ>+FjsNMj_y)d-c+PWfj~u}~5cZB(=rD}NQKgR)*}1}l^n@f5jd1Cj`X
za6v_t=QyAQBe9g{!{OwW6q*jf&UoN)xz)<8d<KWQj^s(RdNwMq_8^p5yr;ayQoY#2
z3Y??WW8Vsz2gZHCCmLyPH2A=tZmvBoI_}BQaZinodwO)-Uqr`RtsTILv_2_zI;&X+
zJ2C1&Zht;Ui?S~(v$Jg^5ALWW@IiH}fk^ZE2Cf&<`t@)$=eYn**6*!R!8$r<>J<%C
zx<T>BBF(-8E^VPk0<8mA9!ZL3#SWB_6zSC@xAcLPP)bz$V21%ZqIxvqD3lgk4P?Tz
zu`dgQaW8V%UTE|9c(QW`UM_C|&*dFv?=o<Bm47fq0nhaoR{_B}bqj-L?z(4lb2Urk
zb20nw;ipIN1Aa`iGXGN31NK;qa6hZbs3%-!_~Cx4Q_(2Dnx}CXES{vgU!Ld~ClscN
z*4LEHCJg=ynld?A$iBZQUP&!56fSIXRx;@z9+bnh<a!7P+b!o{y8KaX2_48ncFvtd
z2!Bp(#{kugdAFq_F1Eya$h|p!ux6+B^=6o*Y%K!%W^kf$AQS7LI=~z&)+Uw79^Psr
zCI*EY75ZIRf%FWgW{StXBc!t;9;RbJAgqHk?y{iV(yi1VotIWK=RB?!)Xv#H7Ug&>
zQZ^Y04<c)fP1|(hE9<6()Qi_hG9c&uvVRGe^I1NibG?*e{2Dx;cfPf7BYOT+DQn@S
zpZUT1unuVrXEl~jui{!Txe|08v&e2=&Ir)#Uj>9yxWX!OF#*u3SIst$FQAZ>>((py
z>2#i1VUPtywEPbbzml??tYchkC0G5RTUu{Ql?tLEQ!0e?zxX-?a{}maCji~~Rey-|
zFn$GEp+`;0;KQ^uNe*+VZkq5bP{XueaheSCh+*dA6lLnHGE37w?ck3Qd}!?kh6Hpv
zs;fNZctV=wv$ko9FE9-gd_ifN-okmBOHU-5WI2lk7N-XK9&(M#^)QSv9Z+#|-c>uS
zBxFKs`-1V(I<;5EH}xXjcfrAo(|<i1Iw@ZoYGX_#csjuiM1%bHM4p&g+PXQPK~gI)
zp&{!$qm(%cO`VuCX2s3=b0~ek{*=|yuQ)gjuPU6lJV1OWNGZXksxD@kPPkK@eh{a4
zR|Rti2>&U^;)S00sg%WI^&qOfXXboVK7l-?6SEkDFAUsEVVe8Fa>>`aQ-3>38L7t(
z_=Hr|x%>^NKiC(3NY^G)QG<+p9L<OG6`@+&pVjQ*qETBvSiHYw$J#U9^<l8GEPWQA
z)2zH87h2>t0Owv+9lSBK8>{Z~T?<*P-+l9M-ocbHERP4*1TbWR6k3it+T$SnfrL1~
zYs(m-ylw!gs+7_b+z6Ev<$sm#;z_un&*f|xxOC9PZ-w>^-C;X{%e>>CrchMe9t<R>
zmDWD17DJU6NmXx=ZedD^upN{#kT|r9q9d6FPVG)y+r6sfob!xIFUmqp%0M{U5DFot
z2Jkwl<(Wa2JMeaNrQ}rE`B}@(*Q8{snU}y!=mx938}&IMy-OH_(tn;~D0WJcN$Ca{
z4rl=UuL&)fd=o6)d1&g6KluQC>%cT_z40R2Aof6I^kP_LRAoe0j#$B&FXGoaZxXT;
zfN%rp2CJ%PI3rTLXhz_NHpcY2qzUo@TOa4Nwl77#8?_d)^19P!+T`fd+dD$rOk?VN
z&Xg&H_%6An2W~WVw}0^qLJjfmeZBFrE*Y-&{{G}X=ZI3*bP-Z6Sl=L|{UiQag*fh;
zAaMgwe~PepL%qS7cam064?P|)$*6P_b`Vup?>?21um8OX8vWuO<Sh<{t>u3UaT7$j
zRQM*Seq`3k1Nh+P`K_C&EBR&4P@55biC1&M{!6Tio&QUyMSu78AMd~W{^$FR58byY
z+q`?f$={?WHV>!&#-{G@ypwe4IW4xJ<CD|3`PrZ1$Gh`m1$XhpZ=f-R!zS1X{QtlH
z=QsG^82@@S4dAOgoX{I>4X1b04;l7z_J!Q)#jjtGJ)FV;?Qo^`cvg^yYhnH_Yo7A&
O4>-$re*^Cc<N@tkHNcPn

delta 1902
zcmV-!2a)*d577^hcz=%LHWG*L{S*$e*CBQmiyU$bCcR03$)?ebAV-3x$`;cUsgRVr
zol{<8UvHlz#Xpkm8KcK6>eOyozmH_GSS*$3@o1F!T`+hBIR)!H6I19n<MG?Uc9Vw9
zKR3#B@XGoy=&$p&cmLSDyBn_x+5N*WAAXGT-DG4?)@<IN1ApF7?yTFYt^-3-_ri1<
zc>K)4IqOIiWu$`vOaPi*!vQpZ-=O_ht+o?EY=sBXl+9wchrk_3>pE)tY@C`AXnT7A
zBE{JWr_Gb>P_(SG(i7WFCKOup^go%>gV1^X)u{a+lX5f{$WqoFjTn^VW*WA|iuD~}
zU=BNl%TQa<)qgLc0>MBqh`^2YZGfN#=s*WS#5}`sUmuN%I9h<CIf(Mnse=f>)yPHH
zIq;qgvJ%x?+F`&DNu^9%jn2{B8?XKZ?20*nyE(+}K!gd~WOAG;Jp5e7cqiP8GW88I
zu9cZyDMD<ovoD??jgbUbBUDN|<)1ypLP<!pQPEPYRDYxn%6g?4tWa9SbL3tONFt2F
z1r=4E<A4&3#8RG*{n0BaG#!GS@xbG9tCd^%3=VZ2$&(iKVpLr1K`3+cp7It;4Pp-~
za1K^aLn~+*82171Xr#Hx;0=4ax%RZ^xF<))JvBP+>Cth279DG~b_6HV`lQ(Dq-GuL
z#H0hc`F|WO%D$}3&bE;}xPy|wN7bzcBF*a?xIswk*Td1A=L|Sof3QXc>*%1lS2R%R
z2E`wXH2V^`w1pZ8v<_T&Bq^E|J5WYaq!*Li(g#*TDN*f%9Y^Sh>dA<MP+Dv?kO|Mm
zzT6m$2a&_}jW&<BCp&lG<?Sutb9sl^y9^v&C4Y=jz;nIDRX}h~-Hkyrcipq4xtb;N
zxtM+T@Y5ss5kIC`S-z?10edV)xL?#{)Dx~V{BS?lsc4j6&C@iF7N4ZLU!Ld~ClscN
z*4LEHW(@uXO_`i5WZ$0^ucQ_j3U6$3Q8MWuJ}8HI$qf*C+uhE=bory&5;~BD?36o+
z5PzK7P64VJ%Wg|YoNbBqkb86ZV9ieL>&>u8*;)kj&EQ1iKxS62I=~z&)+Uw79^Psr
zCPsxD75ZIRf%FW=R?2w=xQT<Vgo)p_m9ukph@~$cOM!$Xc_LxDzeb0&P0v-uJ6lMD
zc#R|ja@m!da5-z_Bd(X1Qu1Dd=kxxu7JqKS++?mtweZr{yth8ALyCJ}Gs*J#g;xtE
z*IO<l1KI6MCJxR1RX{j}E36_Hw^^+Q)ok<lng?0AI=q6P&QA?146>kzmjB`5S5hvK
zb&QLx<Z2joOY2PuNkKH^BZZLui!U8;=Y<Y;0??gbg-8$M7oZh-)Rb~P%uAExFn{Oj
zrU}0QHB9>jr^zsn7-l}sQKrr+i!|-i4*r<Hht_UjNI<8fy2?|IC!|R}X`80_4AU^d
zXOyPtEu5#Nz(cZ0ma|yKaB8IQA(yyZb;20a0Ts98UA4nXLMF7fFBmVaQ+s86Q!mn~
z5**AlpJt(x^3j|&#$4#86WmBN$bWB7<cV3Nt()@+B((w)8nVt4N|}Su)QLG^R@|&V
zhtl`!PgyPfii6Yes=|@W9^#ufN}(&&PBF`L!X4}Mqd3MBA(%Tr_)mE(zR?pum9qF)
zJ&J1YSvVh+Pasd}#3IJv3nTYZnC5=4Tv)a4*p5<0>Zt=hBUN=Se+BA$`+vgwbT}~;
zHOR=v$$U5+#HqFYNzKlV^R)GY#Zyvts(q%rd>E`O{+`6AG%GL28!d7jfOD^^9=tKL
zo2pLDT?$z&x_$F+-oczP+#U}u31G+sDYTq)v_~&|PeSzY+A@YHuNy$BDy8%UH$o*v
zd2xF4BwW$wqOlBII_Tn6p?`ftci2wgGVl1ODHIjA2Ls7zrM1th#ZcvSP1U=aYnW0Z
zYzL(bBo6JY=tyRPQ@bPAcCRWqr#z$5i?R@tG7ye7ghGg^0lbdt_RJv59e6vrQgW*7
z{Gw&2!$>mK%u8S<bc5BNK>D1JPDf!kM!<hfXu;%DQt3QEQ+NE)2Y(ni?hH;zGD+ix
z84qcVVh>ctAjVZjRYr8-J{6qhkb14lB_T^;1H*ndT2(#68Ie|bGXg)fG3J*XO^_GZ
z`Z%YxeJS$Yq_vQhM}a=mCP$y&xe?lC8WY}AeoG<5_pB{FaFeM!sa_CjjOWtpjhA)F
zaJ6UKXZJZpl)9#ikbiRc_zEFK{rHmuao9IOrl7R?Q-qth!7H5fB6$ta00TZ0l2PfD
z=qRd=rF|+TAB}qxH2Ir%kheG(wr>BOz*P|Cz}=gm`jJ^Dd+@<6^IJDl7xMF*p*D~C
z60hd)`IlG~JO7tZH=SjFy#Ma|pYJz5bl;+E^X~m7UrBdt9%qjKjZNL*Q%cgM`?T1C
zj(5&i^SwXCk9Vir3hwNV-#}vshfT0E`2T<X&u{R?DgLrD4dAOgoX{(6jmLNM7a8_*
o_J!Q)*|%SiJsd-icDPV`%<yG@Da_Zh<|%*wfU|t}H&A4dy{#<1hX4Qo

diff --git a/docs/searchindex.js b/docs/searchindex.js
index ce39d2d..3191bc3 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNinja", "Welcome to PyNinja\u2019s documentation!"], "terms": {"lightweight": 0, "o": [0, 1], "agnost": [0, 1], "servic": 0, "monitor": 0, "api": 0, "platform": 0, "support": [0, 1], "deploy": 0, "recommend": 0, "instal": [0, 1], "python": 0, "3": [0, 1], "10": [0, 1], "11": [0, 1], "us": [0, 1], "dedic": [0, 1], "virtual": [0, 1], "m": 0, "pip": 0, "initi": 0, "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "start": [0, 1], "cli": 0, "help": 0, "usag": [0, 1], "instruct": 0, "sourc": 0, "from": [0, 1], "an": [0, 1], "env": [0, 1], "file": [0, 1], "By": 0, "default": [0, 1], "look": 0, "current": [0, 1], "work": [0, 1], "directori": [0, 1], "apikei": [0, 1], "kei": [0, 1], "authent": 0, "ninja": 0, "_": 0, "host": [0, 1], "hostnam": [0, 1], "server": [0, 1], "port": [0, 1], "number": [0, 1], "remot": [0, 1], "execut": [0, 1], "boolean": [0, 1], "flag": [0, 1], "enabl": [0, 1], "secret": [0, 1], "access": [0, 1], "run": [0, 1], "command": [0, 1], "usernam": [0, 1], "page": [0, 1], "password": [0, 1], "session": [0, 1], "timeout": [0, 1], "NO": 0, "auth": [0, 1], "without": 0, "max": [0, 1], "connect": [0, 1], "maximum": [0, 1], "allow": [0, 1], "parallel": 0, "process": 0, "list": [0, 1], "name": [0, 1], "includ": [0, 1], "gpu": 0, "lib": 0, "librari": [0, 1], "filepath": [0, 1], "disk": 0, "memori": [0, 1], "processor": [0, 1], "databas": 0, "store": [0, 1], "handl": [0, 1], "error": [0, 1], "rate": [0, 1], "limit": [0, 1], "dictionari": [0, 1], "max_request": [0, 1], "second": [0, 1], "appli": [0, 1], "log": [0, 1], "config": [0, 1], "configur": 0, "path": [0, 1], "can": [0, 1], "extrem": 0, "riski": 0, "major": 0, "secur": 0, "threat": 0, "so": [0, 1], "caution": 0, "set": [0, 1], "strong": [0, 1], "valu": [0, 1], "refer": [0, 1], "sampl": 0, "exampl": [0, 1], "docstr": 0, "format": [0, 1], "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": [0, 1], "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "pre": 0, "commit": 0, "ensur": 0, "pytest": 0, "gener": [0, 1], "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "wiki": 0, "sphinx": 0, "5": [0, 1], "1": [0, 1], "recommonmark": 0, "http": [0, 1], "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "environ": 1, "variabl": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "get_desc": 1, "remote_flag": 1, "bool": 1, "monitor_flag": 1, "str": 1, "construct": 1, "detail": 1, "descript": 1, "doc": 1, "paramet": 1, "state": 1, "return": 1, "string": 1, "type": 1, "async": 1, "redirect_exception_handl": 1, "request": 1, "redirectexcept": 1, "jsonrespons": 1, "custom": 1, "handler": 1, "redirect": 1, "take": 1, "object": 1, "argument": 1, "inherit": 1, "statu": 1, "cooki": 1, "kwarg": 1, "none": 1, "starter": 1, "function": 1, "which": 1, "uvicorn": 1, "trigger": 1, "keyword": 1, "env_fil": 1, "load": 1, "ninja_host": 1, "ninja_port": 1, "remote_execut": 1, "api_secret": 1, "monitor_usernam": 1, "monitor_password": 1, "monitor_sess": 1, "service_manag": 1, "manag": 1, "rate_limit": 1, "log_config": 1, "dict": 1, "yaml": 1, "yml": 1, "json": 1, "ini": 1, "epoch": 1, "forbidden": 1, "i": 1, "part": 1, "fastapi": 1, "rais": 1, "apirespons": 1, "403": 1, "If": 1, "address": 1, "level_1": 1, "httpauthorizationcredenti": 1, "httpbearer": 1, "author": 1, "header": 1, "token": 1, "basic": 1, "401": 1, "invalid": 1, "level_2": 1, "addition": 1, "addit": 1, "critic": 1, "increment": 1, "attempt": 1, "int": 1, "block": 1, "time": 1, "base": 1, "fail": 1, "login": 1, "appropri": 1, "minut": 1, "handle_auth_error": 1, "filebrows": 1, "The": 1, "incom": 1, "get_record": 1, "get": 1, "particular": 1, "until": 1, "when": 1, "should": 1, "put_record": 1, "block_until": 1, "insert": 1, "remove_record": 1, "delet": 1, "record": 1, "relat": 1, "fullaccess": 1, "run_command": 1, "runcommand": 1, "depend": 1, "option": 1, "machin": 1, "arg": 1, "receiv": 1, "bodi": 1, "httpstatu": 1, "respons": 1, "list_fil": 1, "listfil": 1, "fileio": 1, "download": 1, "upload": 1, "get_fil": 1, "getfil": 1, "filerespons": 1, "put_fil": 1, "uploadfil": 1, "overwrit": 1, "fals": 1, "th": 1, "param": 1, "ipaddr": 1, "get_ip_address": 1, "public": 1, "local": 1, "ip": 1, "devic": 1, "privat": 1, "metric": 1, "get_cpu_util": 1, "interv": 1, "float": 1, "2": 1, "per_cpu": 1, "true": 1, "util": 1, "each": 1, "get_memory_util": 1, "get_cpu_load_avg": 1, "system": 1, "queue": 1, "averag": 1, "over": 1, "last": 1, "15": 1, "respect": 1, "get_disk_util": 1, "get_all_disk": 1, "attach": 1, "namespac": 1, "get_process_statu": 1, "process_nam": 1, "cpu_interv": 1, "union": 1, "check": 1, "get_service_usag": 1, "service_nam": 1, "get_process_usag": 1, "get_service_statu": 1, "get_processor_nam": 1, "inform": 1, "orchestr": 1, "get_docker_contain": 1, "container_nam": 1, "get_al": 1, "get_run": 1, "contain": 1, "get_docker_imag": 1, "imag": 1, "get_docker_volum": 1, "volum": 1, "get_docker_stat": 1, "stat": 1, "router": 1, "redirectrespons": 1, "user": 1, "health": 1, "200": 1, "get_all_rout": 1, "apirout": 1, "ad": 1, "public_ip_address": 1, "differ": 1, "endpoint": 1, "private_ip_address": 1, "simpl": 1, "network": 1, "see": 1, "format_no": 1, "input_": 1, "remov": 1, "0": 1, "integ": 1, "end": 1, "found": 1, "els": 1, "format_timedelta": 1, "td": 1, "timedelta": 1, "convert": 1, "human": 1, "readabl": 1, "non": 1, "zero": 1, "alwai": 1, "output": 1, "two": 1, "identifi": 1, "dai": 1, "hour": 1, "23": 1, "size_convert": 1, "byte_s": 1, "consum": 1, "friendli": 1, "byte": 1, "size": 1, "understand": 1, "process_command": 1, "result": 1, "stdout": 1, "stderr": 1, "pair": 1, "envfile_load": 1, "filenam": 1, "pathlik": 1, "envconfig": 1, "filetyp": 1, "where": 1, "var": 1, "have": 1, "load_env": 1, "merg": 1, "give": 1, "prioriti": 1, "thi": 1, "partial": 1, "through": 1, "keygen": 1, "ar": 1, "forc": 1, "restart": 1, "url": 1, "safe": 1, "64": 1, "bit": 1, "dynamic_numb": 1, "dynam": 1, "_darwin": 1, "lib_path": 1, "maco": 1, "_linux": 1, "linux": 1, "_window": 1, "window": 1, "get_nam": 1, "get_partitions_for_disk": 1, "device_id": 1, "psutil": 1, "find": 1, "partit": 1, "given": 1, "parse_s": 1, "size_str": 1, "unit": 1, "pars": 1, "distro": 1, "is_physical_disk": 1, "physic": 1, "diskutil": 1, "info": 1, "mount": 1, "_reformat_window": 1, "data": 1, "reformat": 1, "drive": 1, "get_container_statu": 1, "get_running_contain": 1, "yield": 1, "correspond": 1, "get_all_contain": 1, "get_all_imag": 1, "get_all_volum": 1, "vendor": 1, "get_process_info": 1, "proc": 1, "statist": 1, "process_monitor": 1, "case": 1, "sensit": 1, "thei": 1, "strictli": 1, "match": 1, "top": 1, "grep": 1, "task": 1, "service_monitor": 1, "follow": 1, "right": 1, "launchctl": 1, "systemctl": 1, "show": 1, "properti": 1, "mainpid": 1, "sc": 1, "queri": 1, "get_service_pid": 1, "retriev": 1, "pid": 1, "get_service_pid_linux": 1, "get_service_pid_maco": 1, "get_service_pid_window": 1, "perform": 1, "report": 1, "get_perform": 1, "thread": 1, "open": 1, "servicestatu": 1, "stop": 1, "501": 1, "unknown": 1, "503": 1, "unavail": 1, "404": 1, "instanc": 1, "status_cod": 1, "ani": 1, "httpexcept": 1, "wrap": 1, "unsupportedo": 1, "class": 1, "unsupport": 1, "locat": 1, "within": 1, "sinc": 1, "doesn": 1, "html": 1, "demand": 1, "solut": 1, "There": 1, "altern": 1, "our": 1, "javascript": 1, "wai": 1, "come": 1, "handi": 1, "mani": 1, "unexpect": 1, "scenario": 1, "tiangolo": 1, "com": 1, "tutori": 1, "sessionerror": 1, "raise_os_error": 1, "operating_system": 1, "noreturn": 1, "validationerror": 1, "overridden": 1, "pydant": 1, "basemodel": 1, "disklib": 1, "darwin": 1, "servicelib": 1, "processorlib": 1, "auth_count": 1, "forbid": 1, "rp": 1, "allowed_origin": 1, "max_connect": 1, "no_auth": 1, "gpu_lib": 1, "disk_lib": 1, "service_lib": 1, "processor_lib": 1, "classmethod": 1, "parse_api_secret": 1, "complex": 1, "input": 1, "from_env_fil": 1, "creat": 1, "extra": 1, "ignor": 1, "hide_input_in_error": 1, "complexity_check": 1, "verifi": 1, "strength": 1, "A": 1, "consid": 1, "least": 1, "ha": 1, "32": 1, "charact": 1, "digit": 1, "symbol": 1, "uppercas": 1, "letter": 1, "lowercas": 1, "assertionerror": 1, "abov": 1, "condit": 1, "gpulib": 1, "usr": 1, "bin": 1, "lspci": 1, "sbin": 1, "system_profil": 1, "c": 1, "system32": 1, "wbem": 1, "wmic": 1, "ex": 1, "_abc_impl": 1, "_abc": 1, "_abc_data": 1, "model_computed_field": 1, "classvar": 1, "computedfieldinfo": 1, "comput": 1, "field": 1, "model_config": 1, "configdict": 1, "conform": 1, "model_field": 1, "fieldinfo": 1, "annot": 1, "metadata": 1, "pathtyp": 1, "path_typ": 1, "about": 1, "defin": 1, "map": 1, "replac": 1, "__fields__": 1, "v1": 1, "wssession": 1, "client_auth": 1, "websocket": 1, "get_librari": 1, "referenc": 1, "datastor": 1, "sqlite3": 1, "create_t": 1, "table_nam": 1, "column": 1, "tupl": 1, "show_hidden_fil": 1, "include_directori": 1, "deep_scan": 1, "implement": 1, "init": 1, "call": 1, "exce": 1, "429": 1, "too": 1, "calculate_hash": 1, "hash": 1, "base64_encod": 1, "base64": 1, "encod": 1, "base64_decod": 1, "decod": 1, "hex_decod": 1, "hex": 1, "hex_encod": 1, "failed_auth_count": 1, "keep": 1, "track": 1, "more": 1, "raise_error": 1, "unauthor": 1, "bad": 1, "credenti": 1, "extract_credenti": 1, "extract": 1, "befor": 1, "verify_login": 1, "generate_cooki": 1, "auth_payload": 1, "timestamp": 1, "session_error": 1, "htmlrespons": 1, "render": 1, "messag": 1, "templat": 1, "jinja2": 1, "validate_sess": 1, "cookie_str": 1, "summari": 1, "clear_sess": 1, "clear": 1, "get_expiri": 1, "lease_start": 1, "lease_dur": 1, "expiri": 1, "datetim": 1, "ag": 1, "wa": 1, "made": 1, "date": 1, "gmt": 1, "landing_pag": 1, "land": 1, "context": 1, "jinja": 1, "container_cpu_limit": 1, "core": 1, "nanocpu": 1, "map_docker_stat": 1, "json_data": 1, "get_cpu_perc": 1, "percentag": 1, "asynchron": 1, "get_system_metr": 1, "swap": 1, "nest": 1, "system_resourc": 1, "gather": 1, "error_endpoint": 1, "logout_endpoint": 1, "out": 1, "login_endpoint": 1, "session_token": 1, "redirect_url": 1, "monitor_endpoint": 1, "ui": 1, "after": 1, "websocket_endpoint": 1, "fetch": 1, "live": 1, "index": 1, "search": 1}, "objects": {"pyninja.executors": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "database"], [1, 0, 0, "-", "routers"], [1, 0, 0, "-", "squire"]], "pyninja.executors.auth": [[1, 1, 1, "", "EPOCH"], [1, 1, 1, "", "forbidden"], [1, 1, 1, "", "handle_auth_error"], [1, 1, 1, "", "incrementer"], [1, 1, 1, "", "level_1"], [1, 1, 1, "", "level_2"]], "pyninja.executors.database": [[1, 1, 1, "", "get_record"], [1, 1, 1, "", "put_record"], [1, 1, 1, "", "remove_record"]], "pyninja.executors.routers": [[1, 1, 1, "", "docs"], [1, 1, 1, "", "get_all_routes"], [1, 1, 1, "", "health"]], "pyninja.executors.squire": [[1, 1, 1, "", "dynamic_numbers"], [1, 1, 1, "", "envfile_loader"], [1, 1, 1, "", "format_nos"], [1, 1, 1, "", "format_timedelta"], [1, 1, 1, "", "keygen"], [1, 1, 1, "", "load_env"], [1, 1, 1, "", "private_ip_address"], [1, 1, 1, "", "process_command"], [1, 1, 1, "", "public_ip_address"], [1, 1, 1, "", "size_converter"]], "pyninja.features": [[1, 0, 0, "-", "cpu"], [1, 0, 0, "-", "disks"], [1, 0, 0, "-", "dockerized"], [1, 0, 0, "-", "gpu"], [1, 0, 0, "-", "operations"], [1, 0, 0, "-", "process"], [1, 0, 0, "-", "service"]], "pyninja.features.cpu": [[1, 1, 1, "", "_darwin"], [1, 1, 1, "", "_linux"], [1, 1, 1, "", "_windows"], [1, 1, 1, "", "get_name"]], "pyninja.features.disks": [[1, 1, 1, "", "_darwin"], [1, 1, 1, "", "_linux"], [1, 1, 1, "", "_reformat_windows"], [1, 1, 1, "", "_windows"], [1, 1, 1, "", "get_all_disks"], [1, 1, 1, "", "get_partitions_for_disk"], [1, 1, 1, "", "is_physical_disk"], [1, 1, 1, "", "parse_size"]], "pyninja.features.dockerized": [[1, 1, 1, "", "get_all_containers"], [1, 1, 1, "", "get_all_images"], [1, 1, 1, "", "get_all_volumes"], [1, 1, 1, "", "get_container_status"], [1, 1, 1, "", "get_running_containers"]], "pyninja.features.gpu": [[1, 1, 1, "", "_darwin"], [1, 1, 1, "", "_linux"], [1, 1, 1, "", "_windows"], [1, 1, 1, "", "get_names"]], "pyninja.features.operations": [[1, 1, 1, "", "default"], [1, 1, 1, "", "get_process_info"], [1, 1, 1, "", "get_service_pid"], [1, 1, 1, "", "get_service_pid_linux"], [1, 1, 1, "", "get_service_pid_macos"], [1, 1, 1, "", "get_service_pid_windows"], [1, 1, 1, "", "process_monitor"], [1, 1, 1, "", "service_monitor"]], "pyninja.features.process": [[1, 1, 1, "", "get_performance"], [1, 1, 1, "", "get_process_status"]], "pyninja.features.service": [[1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "running"], [1, 1, 1, "", "stopped"], [1, 1, 1, "", "unavailable"], [1, 1, 1, "", "unknown"]], "pyninja": [[1, 0, 0, "-", "main"]], "pyninja.main": [[1, 1, 1, "", "get_desc"], [1, 1, 1, "", "redirect_exception_handler"], [1, 1, 1, "", "start"]], "pyninja.modules": [[1, 0, 0, "-", "exceptions"], [1, 0, 0, "-", "models"], [1, 0, 0, "-", "rate_limit"], [1, 0, 0, "-", "secure"]], "pyninja.modules.exceptions": [[1, 2, 1, "", "APIResponse"], [1, 2, 1, "", "RedirectException"], [1, 2, 1, "", "SessionError"], [1, 2, 1, "", "UnSupportedOS"], [1, 1, 1, "", "raise_os_error"]], "pyninja.modules.models": [[1, 3, 1, "", "Database"], [1, 3, 1, "", "DiskLib"], [1, 3, 1, "", "EnvConfig"], [1, 3, 1, "", "GPULib"], [1, 3, 1, "", "ProcessorLib"], [1, 3, 1, "", "RateLimit"], [1, 3, 1, "", "ServiceLib"], [1, 3, 1, "", "ServiceStatus"], [1, 3, 1, "", "Session"], [1, 3, 1, "", "WSSession"], [1, 1, 1, "", "complexity_checker"], [1, 1, 1, "", "get_library"]], "pyninja.modules.models.Database": [[1, 4, 1, "", "create_table"]], "pyninja.modules.models.DiskLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.modules.models.EnvConfig": [[1, 3, 1, "", "Config"], [1, 5, 1, "", "api_secret"], [1, 5, 1, "", "apikey"], [1, 5, 1, "", "database"], [1, 5, 1, "", "disk_lib"], [1, 4, 1, "", "from_env_file"], [1, 5, 1, "", "gpu_lib"], [1, 5, 1, "", "log_config"], [1, 5, 1, "", "max_connections"], [1, 5, 1, "", "monitor_password"], [1, 5, 1, "", "monitor_session"], [1, 5, 1, "", "monitor_username"], [1, 5, 1, "", "ninja_host"], [1, 5, 1, "", "ninja_port"], [1, 5, 1, "", "no_auth"], [1, 4, 1, "", "parse_api_secret"], [1, 5, 1, "", "processes"], [1, 5, 1, "", "processor_lib"], [1, 5, 1, "", "rate_limit"], [1, 5, 1, "", "remote_execution"], [1, 5, 1, "", "service_lib"], [1, 5, 1, "", "services"]], "pyninja.modules.models.EnvConfig.Config": [[1, 5, 1, "", "extra"], [1, 5, 1, "", "hide_input_in_errors"]], "pyninja.modules.models.GPULib": [[1, 5, 1, "", "_abc_impl"], [1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "model_computed_fields"], [1, 5, 1, "", "model_config"], [1, 5, 1, "", "model_fields"], [1, 5, 1, "", "windows"]], "pyninja.modules.models.ProcessorLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.modules.models.RateLimit": [[1, 5, 1, "", "max_requests"], [1, 5, 1, "", "seconds"]], "pyninja.modules.models.ServiceLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.modules.models.ServiceStatus": [[1, 5, 1, "", "description"], [1, 5, 1, "", "status_code"]], "pyninja.modules.models.Session": [[1, 5, 1, "", "allowed_origins"], [1, 5, 1, "", "auth_counter"], [1, 5, 1, "", "forbid"], [1, 5, 1, "", "info"], [1, 5, 1, "", "rps"]], "pyninja.modules.models.WSSession": [[1, 5, 1, "", "_abc_impl"], [1, 5, 1, "", "client_auth"], [1, 5, 1, "", "invalid"], [1, 5, 1, "", "model_computed_fields"], [1, 5, 1, "", "model_config"], [1, 5, 1, "", "model_fields"]], "pyninja.modules.payloads": [[1, 3, 1, "", "GetFile"], [1, 3, 1, "", "ListFiles"], [1, 3, 1, "", "RunCommand"]], "pyninja.modules.payloads.GetFile": [[1, 5, 1, "", "filepath"]], "pyninja.modules.payloads.ListFiles": [[1, 5, 1, "", "deep_scan"], [1, 5, 1, "", "directory"], [1, 5, 1, "", "include_directories"], [1, 5, 1, "", "show_hidden_files"]], "pyninja.modules.payloads.RunCommand": [[1, 5, 1, "", "command"], [1, 5, 1, "", "timeout"]], "pyninja.modules.rate_limit": [[1, 3, 1, "", "RateLimiter"]], "pyninja.modules.rate_limit.RateLimiter": [[1, 4, 1, "", "init"]], "pyninja.modules.secure": [[1, 1, 1, "", "base64_decode"], [1, 1, 1, "", "base64_encode"], [1, 1, 1, "", "calculate_hash"], [1, 1, 1, "", "hex_decode"], [1, 1, 1, "", "hex_encode"]], "pyninja.monitor": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "resources"], [1, 0, 0, "-", "routes"]], "pyninja.monitor.authenticator": [[1, 1, 1, "", "extract_credentials"], [1, 1, 1, "", "failed_auth_counter"], [1, 1, 1, "", "generate_cookie"], [1, 1, 1, "", "raise_error"], [1, 1, 1, "", "session_error"], [1, 1, 1, "", "validate_session"], [1, 1, 1, "", "verify_login"]], "pyninja.monitor.config": [[1, 1, 1, "", "clear_session"], [1, 1, 1, "", "get_expiry"]], "pyninja.monitor.resources": [[1, 1, 1, "", "container_cpu_limit"], [1, 1, 1, "", "containers"], [1, 1, 1, "", "get_cpu_percent"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_system_metrics"], [1, 1, 1, "", "landing_page"], [1, 1, 1, "", "map_docker_stats"], [1, 1, 1, "", "system_resources"]], "pyninja.monitor.routes": [[1, 1, 1, "", "error_endpoint"], [1, 1, 1, "", "login_endpoint"], [1, 1, 1, "", "logout_endpoint"], [1, 1, 1, "", "monitor_endpoint"], [1, 1, 1, "", "websocket_endpoint"]], "pyninja.routes": [[1, 0, 0, "-", "fullaccess"], [1, 0, 0, "-", "ipaddr"], [1, 0, 0, "-", "metrics"], [1, 0, 0, "-", "namespace"], [1, 0, 0, "-", "orchestration"]], "pyninja.routes.fullaccess": [[1, 1, 1, "", "get_file"], [1, 1, 1, "", "list_files"], [1, 1, 1, "", "put_file"], [1, 1, 1, "", "run_command"]], "pyninja.routes.ipaddr": [[1, 1, 1, "", "get_ip_address"]], "pyninja.routes.metrics": [[1, 1, 1, "", "get_all_disks"], [1, 1, 1, "", "get_cpu_load_avg"], [1, 1, 1, "", "get_cpu_utilization"], [1, 1, 1, "", "get_disk_utilization"], [1, 1, 1, "", "get_memory_utilization"]], "pyninja.routes.namespace": [[1, 1, 1, "", "get_process_status"], [1, 1, 1, "", "get_process_usage"], [1, 1, 1, "", "get_processor_name"], [1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "get_service_usage"]], "pyninja.routes.orchestration": [[1, 1, 1, "", "get_docker_containers"], [1, 1, 1, "", "get_docker_images"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_docker_volumes"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:exception", "3": "py:class", "4": "py:method", "5": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "exception", "Python exception"], "3": ["py", "class", "Python class"], "4": ["py", "method", "Python method"], "5": ["py", "attribute", "Python attribute"]}, "titleterms": {"pyninja": [0, 1], "kick": 0, "off": 0, "environ": 0, "variabl": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "main": 1, "executor": 1, "api": 1, "authent": 1, "databas": 1, "rout": 1, "squir": 1, "featur": 1, "cpu": 1, "disk": 1, "docker": 1, "gpu": 1, "oper": 1, "process": 1, "servic": 1, "modul": 1, "except": 1, "model": 1, "payload": 1, "ratelimit": 1, "secur": 1, "monitor": 1, "configur": 1, "resourc": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file
+Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNinja", "Welcome to PyNinja\u2019s documentation!"], "terms": {"lightweight": 0, "o": [0, 1], "agnost": [0, 1], "servic": 0, "monitor": 0, "api": 0, "platform": 0, "support": [0, 1], "deploy": 0, "recommend": 0, "instal": [0, 1], "python": 0, "3": [0, 1], "10": [0, 1], "11": [0, 1], "us": [0, 1], "dedic": [0, 1], "virtual": [0, 1], "m": 0, "pip": 0, "initi": 0, "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "start": [0, 1], "cli": 0, "help": 0, "usag": [0, 1], "instruct": 0, "sourc": 0, "from": [0, 1], "an": [0, 1], "env": [0, 1], "file": [0, 1], "By": 0, "default": [0, 1], "look": 0, "current": [0, 1], "work": [0, 1], "directori": [0, 1], "apikei": [0, 1], "kei": [0, 1], "authent": 0, "ninja": 0, "_": 0, "host": [0, 1], "hostnam": [0, 1], "server": [0, 1], "port": [0, 1], "number": [0, 1], "remot": [0, 1], "execut": [0, 1], "boolean": [0, 1], "flag": [0, 1], "enabl": [0, 1], "secret": [0, 1], "access": [0, 1], "run": [0, 1], "command": [0, 1], "usernam": [0, 1], "page": [0, 1], "password": [0, 1], "session": [0, 1], "timeout": [0, 1], "NO": 0, "auth": [0, 1], "without": 0, "max": [0, 1], "connect": [0, 1], "maximum": [0, 1], "allow": [0, 1], "parallel": 0, "process": 0, "list": [0, 1], "name": [0, 1], "includ": [0, 1], "gpu": 0, "lib": 0, "librari": [0, 1], "filepath": [0, 1], "disk": 0, "memori": [0, 1], "processor": [0, 1], "databas": 0, "store": [0, 1], "handl": [0, 1], "error": [0, 1], "rate": [0, 1], "limit": [0, 1], "dictionari": [0, 1], "max_request": [0, 1], "second": [0, 1], "appli": [0, 1], "log": [0, 1], "config": [0, 1], "configur": 0, "path": [0, 1], "can": [0, 1], "extrem": 0, "riski": 0, "major": 0, "secur": 0, "threat": 0, "so": [0, 1], "caution": 0, "set": [0, 1], "strong": [0, 1], "valu": [0, 1], "refer": [0, 1], "sampl": 0, "exampl": [0, 1], "docstr": 0, "format": [0, 1], "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": [0, 1], "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "pre": 0, "commit": 0, "ensur": [0, 1], "pytest": 0, "gener": [0, 1], "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "wiki": 0, "sphinx": 0, "5": [0, 1], "1": [0, 1], "recommonmark": 0, "http": [0, 1], "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "environ": 1, "variabl": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "get_desc": 1, "remote_flag": 1, "bool": 1, "monitor_flag": 1, "str": 1, "construct": 1, "detail": 1, "descript": 1, "doc": 1, "paramet": 1, "state": 1, "return": 1, "string": 1, "type": 1, "async": 1, "redirect_exception_handl": 1, "request": 1, "redirectexcept": 1, "jsonrespons": 1, "custom": 1, "handler": 1, "redirect": 1, "take": 1, "object": 1, "argument": 1, "inherit": 1, "statu": 1, "cooki": 1, "kwarg": 1, "none": 1, "starter": 1, "function": 1, "which": 1, "uvicorn": 1, "trigger": 1, "keyword": 1, "env_fil": 1, "load": 1, "ninja_host": 1, "ninja_port": 1, "remote_execut": 1, "api_secret": 1, "monitor_usernam": 1, "monitor_password": 1, "monitor_sess": 1, "service_manag": 1, "manag": 1, "rate_limit": 1, "log_config": 1, "dict": 1, "yaml": 1, "yml": 1, "json": 1, "ini": 1, "epoch": 1, "forbidden": 1, "i": 1, "part": 1, "fastapi": 1, "rais": 1, "apirespons": 1, "403": 1, "If": 1, "address": 1, "level_1": 1, "httpauthorizationcredenti": 1, "httpbearer": 1, "author": 1, "header": 1, "token": 1, "basic": 1, "401": 1, "invalid": 1, "level_2": 1, "addition": 1, "addit": 1, "critic": 1, "increment": 1, "attempt": 1, "int": 1, "block": 1, "time": 1, "base": 1, "fail": 1, "login": 1, "appropri": 1, "minut": 1, "handle_auth_error": 1, "filebrows": 1, "The": 1, "incom": 1, "get_record": 1, "get": 1, "particular": 1, "until": 1, "when": 1, "should": 1, "put_record": 1, "block_until": 1, "insert": 1, "remove_record": 1, "delet": 1, "record": 1, "relat": 1, "fullaccess": 1, "run_command": 1, "runcommand": 1, "depend": 1, "option": 1, "machin": 1, "arg": 1, "receiv": 1, "bodi": 1, "httpstatu": 1, "respons": 1, "list_fil": 1, "listfil": 1, "fileio": 1, "download": 1, "upload": 1, "get_fil": 1, "getfil": 1, "filerespons": 1, "put_fil": 1, "uploadfil": 1, "overwrit": 1, "fals": 1, "th": 1, "param": 1, "ipaddr": 1, "get_ip_address": 1, "public": 1, "local": 1, "ip": 1, "devic": 1, "privat": 1, "metric": 1, "get_cpu_util": 1, "interv": 1, "float": 1, "2": 1, "per_cpu": 1, "true": 1, "util": 1, "each": 1, "get_memory_util": 1, "get_cpu_load_avg": 1, "system": 1, "queue": 1, "averag": 1, "over": 1, "last": 1, "15": 1, "respect": 1, "get_disk_util": 1, "get_all_disk": 1, "attach": 1, "namespac": 1, "get_process_statu": 1, "process_nam": 1, "cpu_interv": 1, "union": 1, "check": 1, "get_service_usag": 1, "service_nam": 1, "get_process_usag": 1, "get_service_statu": 1, "get_processor_nam": 1, "inform": 1, "orchestr": 1, "get_docker_contain": 1, "container_nam": 1, "get_al": 1, "get_run": 1, "contain": 1, "get_docker_imag": 1, "imag": 1, "get_docker_volum": 1, "volum": 1, "get_docker_stat": 1, "stat": 1, "router": 1, "redirectrespons": 1, "user": 1, "health": 1, "200": 1, "get_all_rout": 1, "apirout": 1, "ad": 1, "public_ip_address": 1, "differ": 1, "endpoint": 1, "private_ip_address": 1, "simpl": 1, "network": 1, "see": 1, "format_no": 1, "input_": 1, "remov": 1, "0": 1, "integ": 1, "end": 1, "found": 1, "els": 1, "format_timedelta": 1, "td": 1, "timedelta": 1, "convert": 1, "human": 1, "readabl": 1, "non": 1, "zero": 1, "alwai": 1, "output": 1, "two": 1, "identifi": 1, "dai": 1, "hour": 1, "23": 1, "size_convert": 1, "byte_s": 1, "consum": 1, "friendli": 1, "byte": 1, "size": 1, "understand": 1, "process_command": 1, "result": 1, "stdout": 1, "stderr": 1, "pair": 1, "envfile_load": 1, "filenam": 1, "pathlik": 1, "envconfig": 1, "filetyp": 1, "where": 1, "var": 1, "have": 1, "load_env": 1, "merg": 1, "give": 1, "prioriti": 1, "thi": 1, "partial": 1, "through": 1, "keygen": 1, "ar": 1, "forc": 1, "restart": 1, "url": 1, "safe": 1, "64": 1, "bit": 1, "dynamic_numb": 1, "dynam": 1, "_darwin": 1, "lib_path": 1, "maco": 1, "_linux": 1, "linux": 1, "_window": 1, "window": 1, "get_nam": 1, "get_partitions_for_disk": 1, "device_id": 1, "psutil": 1, "find": 1, "partit": 1, "given": 1, "parse_s": 1, "size_str": 1, "unit": 1, "pars": 1, "distro": 1, "is_physical_disk": 1, "physic": 1, "diskutil": 1, "info": 1, "mount": 1, "_reformat_window": 1, "data": 1, "reformat": 1, "drive": 1, "get_container_statu": 1, "get_running_contain": 1, "yield": 1, "correspond": 1, "get_all_contain": 1, "get_all_imag": 1, "get_all_volum": 1, "vendor": 1, "get_process_info": 1, "proc": 1, "statist": 1, "process_monitor": 1, "case": 1, "sensit": 1, "thei": 1, "strictli": 1, "match": 1, "top": 1, "grep": 1, "task": 1, "service_monitor": 1, "follow": 1, "right": 1, "launchctl": 1, "systemctl": 1, "show": 1, "properti": 1, "mainpid": 1, "sc": 1, "queri": 1, "get_service_pid": 1, "retriev": 1, "pid": 1, "get_service_pid_linux": 1, "get_service_pid_maco": 1, "get_service_pid_window": 1, "perform": 1, "report": 1, "get_perform": 1, "thread": 1, "open": 1, "servicestatu": 1, "stop": 1, "501": 1, "unknown": 1, "503": 1, "unavail": 1, "404": 1, "instanc": 1, "status_cod": 1, "ani": 1, "httpexcept": 1, "wrap": 1, "unsupportedo": 1, "class": 1, "unsupport": 1, "locat": 1, "within": 1, "sinc": 1, "doesn": 1, "html": 1, "demand": 1, "solut": 1, "There": 1, "altern": 1, "our": 1, "javascript": 1, "wai": 1, "come": 1, "handi": 1, "mani": 1, "unexpect": 1, "scenario": 1, "tiangolo": 1, "com": 1, "tutori": 1, "sessionerror": 1, "raise_os_error": 1, "operating_system": 1, "noreturn": 1, "validationerror": 1, "overridden": 1, "pydant": 1, "basemodel": 1, "disklib": 1, "darwin": 1, "servicelib": 1, "processorlib": 1, "auth_count": 1, "forbid": 1, "rp": 1, "allowed_origin": 1, "disk_report": 1, "max_connect": 1, "no_auth": 1, "gpu_lib": 1, "disk_lib": 1, "service_lib": 1, "processor_lib": 1, "classmethod": 1, "assert_disk_report": 1, "onli": 1, "input": 1, "parse_api_secret": 1, "complex": 1, "from_env_fil": 1, "creat": 1, "extra": 1, "ignor": 1, "hide_input_in_error": 1, "complexity_check": 1, "verifi": 1, "strength": 1, "A": 1, "consid": 1, "least": 1, "ha": 1, "32": 1, "charact": 1, "digit": 1, "symbol": 1, "uppercas": 1, "letter": 1, "lowercas": 1, "assertionerror": 1, "abov": 1, "condit": 1, "gpulib": 1, "usr": 1, "bin": 1, "lspci": 1, "sbin": 1, "system_profil": 1, "c": 1, "system32": 1, "wbem": 1, "wmic": 1, "ex": 1, "_abc_impl": 1, "_abc": 1, "_abc_data": 1, "model_computed_field": 1, "classvar": 1, "computedfieldinfo": 1, "comput": 1, "field": 1, "model_config": 1, "configdict": 1, "conform": 1, "model_field": 1, "fieldinfo": 1, "annot": 1, "metadata": 1, "pathtyp": 1, "path_typ": 1, "about": 1, "defin": 1, "map": 1, "replac": 1, "__fields__": 1, "v1": 1, "wssession": 1, "client_auth": 1, "websocket": 1, "get_librari": 1, "referenc": 1, "datastor": 1, "sqlite3": 1, "create_t": 1, "table_nam": 1, "column": 1, "tupl": 1, "show_hidden_fil": 1, "include_directori": 1, "deep_scan": 1, "implement": 1, "init": 1, "call": 1, "exce": 1, "429": 1, "too": 1, "calculate_hash": 1, "hash": 1, "base64_encod": 1, "base64": 1, "encod": 1, "base64_decod": 1, "decod": 1, "hex_decod": 1, "hex": 1, "hex_encod": 1, "failed_auth_count": 1, "keep": 1, "track": 1, "more": 1, "raise_error": 1, "unauthor": 1, "bad": 1, "credenti": 1, "extract_credenti": 1, "extract": 1, "befor": 1, "verify_login": 1, "generate_cooki": 1, "auth_payload": 1, "timestamp": 1, "session_error": 1, "htmlrespons": 1, "render": 1, "messag": 1, "templat": 1, "jinja2": 1, "validate_sess": 1, "cookie_str": 1, "summari": 1, "clear_sess": 1, "clear": 1, "get_expiri": 1, "lease_start": 1, "lease_dur": 1, "expiri": 1, "datetim": 1, "ag": 1, "wa": 1, "made": 1, "date": 1, "gmt": 1, "landing_pag": 1, "land": 1, "context": 1, "jinja": 1, "container_cpu_limit": 1, "core": 1, "nanocpu": 1, "map_docker_stat": 1, "json_data": 1, "get_cpu_perc": 1, "percentag": 1, "asynchron": 1, "get_system_metr": 1, "swap": 1, "nest": 1, "disk_utils_metr": 1, "placehold": 1, "futur": 1, "system_resourc": 1, "gather": 1, "error_endpoint": 1, "logout_endpoint": 1, "out": 1, "login_endpoint": 1, "session_token": 1, "redirect_url": 1, "monitor_endpoint": 1, "ui": 1, "after": 1, "websocket_endpoint": 1, "fetch": 1, "live": 1, "index": 1, "search": 1}, "objects": {"pyninja.executors": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "database"], [1, 0, 0, "-", "routers"], [1, 0, 0, "-", "squire"]], "pyninja.executors.auth": [[1, 1, 1, "", "EPOCH"], [1, 1, 1, "", "forbidden"], [1, 1, 1, "", "handle_auth_error"], [1, 1, 1, "", "incrementer"], [1, 1, 1, "", "level_1"], [1, 1, 1, "", "level_2"]], "pyninja.executors.database": [[1, 1, 1, "", "get_record"], [1, 1, 1, "", "put_record"], [1, 1, 1, "", "remove_record"]], "pyninja.executors.routers": [[1, 1, 1, "", "docs"], [1, 1, 1, "", "get_all_routes"], [1, 1, 1, "", "health"]], "pyninja.executors.squire": [[1, 1, 1, "", "dynamic_numbers"], [1, 1, 1, "", "envfile_loader"], [1, 1, 1, "", "format_nos"], [1, 1, 1, "", "format_timedelta"], [1, 1, 1, "", "keygen"], [1, 1, 1, "", "load_env"], [1, 1, 1, "", "private_ip_address"], [1, 1, 1, "", "process_command"], [1, 1, 1, "", "public_ip_address"], [1, 1, 1, "", "size_converter"]], "pyninja.features": [[1, 0, 0, "-", "cpu"], [1, 0, 0, "-", "disks"], [1, 0, 0, "-", "dockerized"], [1, 0, 0, "-", "gpu"], [1, 0, 0, "-", "operations"], [1, 0, 0, "-", "process"], [1, 0, 0, "-", "service"]], "pyninja.features.cpu": [[1, 1, 1, "", "_darwin"], [1, 1, 1, "", "_linux"], [1, 1, 1, "", "_windows"], [1, 1, 1, "", "get_name"]], "pyninja.features.disks": [[1, 1, 1, "", "_darwin"], [1, 1, 1, "", "_linux"], [1, 1, 1, "", "_reformat_windows"], [1, 1, 1, "", "_windows"], [1, 1, 1, "", "get_all_disks"], [1, 1, 1, "", "get_partitions_for_disk"], [1, 1, 1, "", "is_physical_disk"], [1, 1, 1, "", "parse_size"]], "pyninja.features.dockerized": [[1, 1, 1, "", "get_all_containers"], [1, 1, 1, "", "get_all_images"], [1, 1, 1, "", "get_all_volumes"], [1, 1, 1, "", "get_container_status"], [1, 1, 1, "", "get_running_containers"]], "pyninja.features.gpu": [[1, 1, 1, "", "_darwin"], [1, 1, 1, "", "_linux"], [1, 1, 1, "", "_windows"], [1, 1, 1, "", "get_names"]], "pyninja.features.operations": [[1, 1, 1, "", "default"], [1, 1, 1, "", "get_process_info"], [1, 1, 1, "", "get_service_pid"], [1, 1, 1, "", "get_service_pid_linux"], [1, 1, 1, "", "get_service_pid_macos"], [1, 1, 1, "", "get_service_pid_windows"], [1, 1, 1, "", "process_monitor"], [1, 1, 1, "", "service_monitor"]], "pyninja.features.process": [[1, 1, 1, "", "get_performance"], [1, 1, 1, "", "get_process_status"]], "pyninja.features.service": [[1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "running"], [1, 1, 1, "", "stopped"], [1, 1, 1, "", "unavailable"], [1, 1, 1, "", "unknown"]], "pyninja": [[1, 0, 0, "-", "main"]], "pyninja.main": [[1, 1, 1, "", "get_desc"], [1, 1, 1, "", "redirect_exception_handler"], [1, 1, 1, "", "start"]], "pyninja.modules": [[1, 0, 0, "-", "exceptions"], [1, 0, 0, "-", "models"], [1, 0, 0, "-", "rate_limit"], [1, 0, 0, "-", "secure"]], "pyninja.modules.exceptions": [[1, 2, 1, "", "APIResponse"], [1, 2, 1, "", "RedirectException"], [1, 2, 1, "", "SessionError"], [1, 2, 1, "", "UnSupportedOS"], [1, 1, 1, "", "raise_os_error"]], "pyninja.modules.models": [[1, 3, 1, "", "Database"], [1, 3, 1, "", "DiskLib"], [1, 3, 1, "", "EnvConfig"], [1, 3, 1, "", "GPULib"], [1, 3, 1, "", "ProcessorLib"], [1, 3, 1, "", "RateLimit"], [1, 3, 1, "", "ServiceLib"], [1, 3, 1, "", "ServiceStatus"], [1, 3, 1, "", "Session"], [1, 3, 1, "", "WSSession"], [1, 1, 1, "", "complexity_checker"], [1, 1, 1, "", "get_library"]], "pyninja.modules.models.Database": [[1, 4, 1, "", "create_table"]], "pyninja.modules.models.DiskLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.modules.models.EnvConfig": [[1, 3, 1, "", "Config"], [1, 5, 1, "", "api_secret"], [1, 5, 1, "", "apikey"], [1, 4, 1, "", "assert_disk_report"], [1, 5, 1, "", "database"], [1, 5, 1, "", "disk_lib"], [1, 5, 1, "", "disk_report"], [1, 4, 1, "", "from_env_file"], [1, 5, 1, "", "gpu_lib"], [1, 5, 1, "", "log_config"], [1, 5, 1, "", "max_connections"], [1, 5, 1, "", "monitor_password"], [1, 5, 1, "", "monitor_session"], [1, 5, 1, "", "monitor_username"], [1, 5, 1, "", "ninja_host"], [1, 5, 1, "", "ninja_port"], [1, 5, 1, "", "no_auth"], [1, 4, 1, "", "parse_api_secret"], [1, 5, 1, "", "processes"], [1, 5, 1, "", "processor_lib"], [1, 5, 1, "", "rate_limit"], [1, 5, 1, "", "remote_execution"], [1, 5, 1, "", "service_lib"], [1, 5, 1, "", "services"]], "pyninja.modules.models.EnvConfig.Config": [[1, 5, 1, "", "extra"], [1, 5, 1, "", "hide_input_in_errors"]], "pyninja.modules.models.GPULib": [[1, 5, 1, "", "_abc_impl"], [1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "model_computed_fields"], [1, 5, 1, "", "model_config"], [1, 5, 1, "", "model_fields"], [1, 5, 1, "", "windows"]], "pyninja.modules.models.ProcessorLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.modules.models.RateLimit": [[1, 5, 1, "", "max_requests"], [1, 5, 1, "", "seconds"]], "pyninja.modules.models.ServiceLib": [[1, 5, 1, "", "darwin"], [1, 5, 1, "", "linux"], [1, 5, 1, "", "windows"]], "pyninja.modules.models.ServiceStatus": [[1, 5, 1, "", "description"], [1, 5, 1, "", "status_code"]], "pyninja.modules.models.Session": [[1, 5, 1, "", "allowed_origins"], [1, 5, 1, "", "auth_counter"], [1, 5, 1, "", "forbid"], [1, 5, 1, "", "info"], [1, 5, 1, "", "rps"]], "pyninja.modules.models.WSSession": [[1, 5, 1, "", "_abc_impl"], [1, 5, 1, "", "client_auth"], [1, 5, 1, "", "invalid"], [1, 5, 1, "", "model_computed_fields"], [1, 5, 1, "", "model_config"], [1, 5, 1, "", "model_fields"]], "pyninja.modules.payloads": [[1, 3, 1, "", "GetFile"], [1, 3, 1, "", "ListFiles"], [1, 3, 1, "", "RunCommand"]], "pyninja.modules.payloads.GetFile": [[1, 5, 1, "", "filepath"]], "pyninja.modules.payloads.ListFiles": [[1, 5, 1, "", "deep_scan"], [1, 5, 1, "", "directory"], [1, 5, 1, "", "include_directories"], [1, 5, 1, "", "show_hidden_files"]], "pyninja.modules.payloads.RunCommand": [[1, 5, 1, "", "command"], [1, 5, 1, "", "timeout"]], "pyninja.modules.rate_limit": [[1, 3, 1, "", "RateLimiter"]], "pyninja.modules.rate_limit.RateLimiter": [[1, 4, 1, "", "init"]], "pyninja.modules.secure": [[1, 1, 1, "", "base64_decode"], [1, 1, 1, "", "base64_encode"], [1, 1, 1, "", "calculate_hash"], [1, 1, 1, "", "hex_decode"], [1, 1, 1, "", "hex_encode"]], "pyninja.monitor": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "resources"], [1, 0, 0, "-", "routes"]], "pyninja.monitor.authenticator": [[1, 1, 1, "", "extract_credentials"], [1, 1, 1, "", "failed_auth_counter"], [1, 1, 1, "", "generate_cookie"], [1, 1, 1, "", "raise_error"], [1, 1, 1, "", "session_error"], [1, 1, 1, "", "validate_session"], [1, 1, 1, "", "verify_login"]], "pyninja.monitor.config": [[1, 1, 1, "", "clear_session"], [1, 1, 1, "", "get_expiry"]], "pyninja.monitor.resources": [[1, 1, 1, "", "container_cpu_limit"], [1, 1, 1, "", "containers"], [1, 1, 1, "", "disk_utils_metrics"], [1, 1, 1, "", "get_cpu_percent"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_system_metrics"], [1, 1, 1, "", "landing_page"], [1, 1, 1, "", "map_docker_stats"], [1, 1, 1, "", "system_resources"]], "pyninja.monitor.routes": [[1, 1, 1, "", "error_endpoint"], [1, 1, 1, "", "login_endpoint"], [1, 1, 1, "", "logout_endpoint"], [1, 1, 1, "", "monitor_endpoint"], [1, 1, 1, "", "websocket_endpoint"]], "pyninja.routes": [[1, 0, 0, "-", "fullaccess"], [1, 0, 0, "-", "ipaddr"], [1, 0, 0, "-", "metrics"], [1, 0, 0, "-", "namespace"], [1, 0, 0, "-", "orchestration"]], "pyninja.routes.fullaccess": [[1, 1, 1, "", "get_file"], [1, 1, 1, "", "list_files"], [1, 1, 1, "", "put_file"], [1, 1, 1, "", "run_command"]], "pyninja.routes.ipaddr": [[1, 1, 1, "", "get_ip_address"]], "pyninja.routes.metrics": [[1, 1, 1, "", "get_all_disks"], [1, 1, 1, "", "get_cpu_load_avg"], [1, 1, 1, "", "get_cpu_utilization"], [1, 1, 1, "", "get_disk_utilization"], [1, 1, 1, "", "get_memory_utilization"]], "pyninja.routes.namespace": [[1, 1, 1, "", "get_process_status"], [1, 1, 1, "", "get_process_usage"], [1, 1, 1, "", "get_processor_name"], [1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "get_service_usage"]], "pyninja.routes.orchestration": [[1, 1, 1, "", "get_docker_containers"], [1, 1, 1, "", "get_docker_images"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_docker_volumes"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:exception", "3": "py:class", "4": "py:method", "5": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "exception", "Python exception"], "3": ["py", "class", "Python class"], "4": ["py", "method", "Python method"], "5": ["py", "attribute", "Python attribute"]}, "titleterms": {"pyninja": [0, 1], "kick": 0, "off": 0, "environ": 0, "variabl": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "main": 1, "executor": 1, "api": 1, "authent": 1, "databas": 1, "rout": 1, "squir": 1, "featur": 1, "cpu": 1, "disk": 1, "docker": 1, "gpu": 1, "oper": 1, "process": 1, "servic": 1, "modul": 1, "except": 1, "model": 1, "payload": 1, "ratelimit": 1, "secur": 1, "monitor": 1, "configur": 1, "resourc": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file
diff --git a/pyninja/modules/models.py b/pyninja/modules/models.py
index 13be02b..8565f6e 100644
--- a/pyninja/modules/models.py
+++ b/pyninja/modules/models.py
@@ -190,6 +190,8 @@ class EnvConfig(BaseSettings):
     monitor_username: str | None = None
     monitor_password: str | None = None
     monitor_session: PositiveInt = 3_600
+    # todo: disk_lib env var will contradict with PyUdisk
+    disk_report: bool = False
     max_connections: PositiveInt = 3
     no_auth: bool = False
     processes: List[str] = []
@@ -202,6 +204,28 @@ class EnvConfig(BaseSettings):
     rate_limit: RateLimit | List[RateLimit] = []
     log_config: Dict[str, Any] | FilePath | None = None
 
+    # noinspection PyMethodParameters
+    @field_validator("disk_report", mode="after")
+    def assert_disk_report(cls, value: bool) -> bool:
+        """Ensure disk_report is enabled only for Linux machines.
+
+        Args:
+            value: Takes the user input as an argument.
+        """
+        if value:
+            assert OPERATING_SYSTEM == "linux", ValueError(
+                "disk_report feature can be enabled only on Linux machines!"
+            )
+            try:
+                from pyudisk.config import EnvConfig as PyUdiskConfig
+            except (ImportError, ModuleNotFoundError):
+                raise ValueError(
+                    "PyUdisk has not been installed. Use pip install 'PyNinja[extra]' to use disk reporting feature."
+                )
+            disk_lib = PyUdiskConfig().disk_lib
+            assert os.path.exists(disk_lib), ValueError(f"{disk_lib!r} path does not exist!")
+        return value
+
     # noinspection PyMethodParameters
     @field_validator("api_secret", mode="after")
     def parse_api_secret(cls, value: str | None) -> str | None:
diff --git a/pyninja/monitor/drive.py b/pyninja/monitor/drive.py
index 5e9eec6..bafd1b7 100644
--- a/pyninja/monitor/drive.py
+++ b/pyninja/monitor/drive.py
@@ -1,6 +1,7 @@
 import logging
 
 from fastapi.responses import HTMLResponse
+from pyninja import monitor
 
 LOGGER = logging.getLogger("uvicorn.default")
 
@@ -15,3 +16,12 @@ async def report() -> HTMLResponse:
     import pyudisk
 
     return HTMLResponse(content=pyudisk.generate_report(raw=True))
+
+
+async def invalid(ctx: str, status_code: int = 500):
+    return await monitor.config.clear_session(
+        response=HTMLResponse(
+            content=ctx, status_code=status_code
+        )
+    )
+
diff --git a/pyninja/monitor/resources.py b/pyninja/monitor/resources.py
index 5c6c977..96a40a8 100644
--- a/pyninja/monitor/resources.py
+++ b/pyninja/monitor/resources.py
@@ -182,6 +182,19 @@ async def get_system_metrics() -> Dict[str, dict]:
     )
 
 
+async def disk_utils_metrics() -> Dict[str, dict]:
+    """Placeholder for future metrics."""
+    from pyudisk.main import EnvConfig, smart_metrics
+
+    for disk in smart_metrics(EnvConfig()):
+        print(disk.Info.Model)
+        print(disk.Partition.IdLabel)
+        print(disk.Partition.MountPoints)
+        print(disk.Usage)
+        print(disk.Attributes.SmartTemperature)
+        print(disk.Attributes.SmartUpdated)
+
+
 async def system_resources() -> Dict[str, dict]:
     """Gather system resources including Docker stats asynchronously.
 
@@ -189,6 +202,7 @@ async def system_resources() -> Dict[str, dict]:
         Dict[str, dict]:
         Returns a nested dictionary.
     """
+    # await disk_utils_metrics()
     system_metrics_task = asyncio.create_task(get_system_metrics())
     docker_stats_task = asyncio.create_task(get_docker_stats())
     service_stats_task = asyncio.create_task(
diff --git a/pyninja/monitor/routes.py b/pyninja/monitor/routes.py
index c6a896c..ab6e87a 100644
--- a/pyninja/monitor/routes.py
+++ b/pyninja/monitor/routes.py
@@ -132,17 +132,16 @@ async def monitor_endpoint(
                 name="main.html", context=ctx
             )
         elif render == "drive":
-            LOGGER.info("Rendering disk report!")
-            try:
-                response = await monitor.drive.report()
-                # If drive option is chosen during login page, the cookie is deleted once logged in!
-            except Exception as error:
-                LOGGER.error(error)
-                response = await monitor.config.clear_session(
-                    response=HTMLResponse(
-                        content="Failed to generate disk report", status_code=500
-                    )
-                )
+            if models.env.disk_report:
+                LOGGER.info("Rendering disk report!")
+                try:
+                    response = await monitor.drive.report()
+                    # If drive option is chosen during login page, the cookie is deleted once logged in!
+                except Exception as error:
+                    LOGGER.error(error)
+                    response = await monitor.drive.invalid("Failed to generate disk report")
+            else:
+                response = await monitor.drive.invalid("Disk reporting feature is not enabled in the server!")
             response.delete_cookie(key="render")
             return response
         # todo: Implement a better way to handle this
@@ -154,8 +153,7 @@ async def monitor_endpoint(
             "request": request,
             "signin": "/login",
             "version": f"v{version.__version__}",
-            # todo: Add an env var to enable reporting manually
-            "linux": models.OPERATING_SYSTEM == "linux",
+            "disk_report": models.env.disk_report,
         },
     )
 
diff --git a/pyninja/monitor/templates/index.html b/pyninja/monitor/templates/index.html
index 6f92e79..c0c0193 100644
--- a/pyninja/monitor/templates/index.html
+++ b/pyninja/monitor/templates/index.html
@@ -150,7 +150,7 @@ <h2 style="margin-top:5%">This page requires JavaScript
                 <i class="fa-regular fa-eye" id="eye"></i>
             </div>
             <button type="submit" onclick="submitToAPI(event, 'monitor')">Sign In</button>
-            {% if linux %}
+            {% if disk_report %}
                 <br>
                 <button type="submit" onclick="submitToAPI(event, 'drive')">Disk Report</button>
             {% endif %}