DaliAdmin.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
  4. <book>
  5. <title>Dali Admin</title>
  6. <bookinfo>
  7. <title>Administering Dali</title>
  8. <mediaobject>
  9. <imageobject>
  10. <imagedata fileref="images/redswooshWithLogo3.jpg" />
  11. </imageobject>
  12. </mediaobject>
  13. <author>
  14. <surname>Boca Raton Documentation Team</surname>
  15. </author>
  16. <legalnotice>
  17. <para>We welcome your comments and feedback about this document via
  18. email to <email>docfeedback@hpccsystems.com</email></para>
  19. <para>Please include <emphasis role="bold">Documentation
  20. Feedback</emphasis> in the subject line and reference the document name,
  21. page numbers, and current Version Number in the text of the
  22. message.</para>
  23. <para>LexisNexis and the Knowledge Burst logo are registered trademarks
  24. of Reed Elsevier Properties Inc., used under license.</para>
  25. <para>HPCC Systems<superscript>®</superscript> is a registered trademark
  26. of LexisNexis Risk Data Management Inc.</para>
  27. <para>Other products, logos, and services may be trademarks or
  28. registered trademarks of their respective companies.</para>
  29. <para>All names and example data used in this manual are fictitious. Any
  30. similarity to actual persons, living or dead, is purely
  31. coincidental.</para>
  32. <para></para>
  33. </legalnotice>
  34. <releaseinfo>© 2015 HPCC Systems<superscript>®</superscript>. All rights
  35. reserved</releaseinfo>
  36. <date>3.0.0_x</date>
  37. <corpname>HPCC Systems</corpname>
  38. <copyright>
  39. <year>May, 2015</year>
  40. </copyright>
  41. <mediaobject role="logo">
  42. <imageobject>
  43. <imagedata fileref="images/LN_Rightjustified.jpg" />
  44. </imageobject>
  45. </mediaobject>
  46. </bookinfo>
  47. <chapter>
  48. <title><emphasis role="bold">Dali Admin</emphasis></title>
  49. <para>DaliAdmin is an administrator's command line tool to diagnose and
  50. fix problems in an HPCC's System Data Store inside the Dali Server.</para>
  51. <para>Daliadmin can be found at opt/LexisNexis/bin/, along with other
  52. tools the HPCC installation package installs.</para>
  53. <sect1>
  54. <title><emphasis>Dali Admin usage</emphasis></title>
  55. <para>Daliadmin is a command line tool to with the System Data Store in
  56. your Dali server.</para>
  57. <para>Usage:</para>
  58. <para>daliadmin &lt;command&gt; { &lt;options&gt; }</para>
  59. <para><programlisting>daliadmin &lt;command&gt; { &lt;options&gt; }
  60. </programlisting></para>
  61. <para></para>
  62. <para>More text and further descriptions of daliadmin to come...</para>
  63. <para></para>
  64. <para></para>
  65. <para>Data Store commands:</para>
  66. <para><informaltable>
  67. <?dbfo keep-together="always"?>
  68. <tgroup cols="2">
  69. <tbody>
  70. <row>
  71. <entry>export &lt;branchxpath&gt; &lt;destfile&gt;</entry>
  72. <entry>exports specified branches to the nominated
  73. file...</entry>
  74. </row>
  75. <row>
  76. <entry>import &lt;branchxpath&gt; &lt;srcfile&gt;</entry>
  77. <entry>imports branches from the nominated file..</entry>
  78. </row>
  79. <row>
  80. <entry>importadd &lt;branchxpath&gt; &lt;srcfile&gt;</entry>
  81. <entry>Adds to import ***</entry>
  82. </row>
  83. <row>
  84. <entry>delete &lt;branchxpath&gt;</entry>
  85. <entry>deletes the specified branch</entry>
  86. </row>
  87. <row>
  88. <entry>set &lt;xpath&gt; &lt;value&gt;</entry>
  89. <entry>sets single value to a single</entry>
  90. </row>
  91. <row>
  92. <entry>get &lt;xpath&gt;</entry>
  93. <entry>get single value</entry>
  94. </row>
  95. <row>
  96. <entry>bget &lt;xpath&gt; &lt;dest-file&gt;</entry>
  97. <entry>binary property</entry>
  98. </row>
  99. <row>
  100. <entry>xget &lt;xpath&gt;</entry>
  101. <entry>(multi-value tail can have commas)</entry>
  102. </row>
  103. <row>
  104. <entry>wget &lt;xpath&gt;</entry>
  105. <entry>(gets all matching xpath)</entry>
  106. </row>
  107. <row>
  108. <entry>addp &lt;xpath&gt; &lt;value&gt;</entry>
  109. <entry>adds value</entry>
  110. </row>
  111. <row>
  112. <entry>delp &lt;xpath&gt;</entry>
  113. <entry>deletes path</entry>
  114. </row>
  115. </tbody>
  116. </tgroup>
  117. </informaltable></para>
  118. <para></para>
  119. <para>Logical File meta information command:</para>
  120. <para><informaltable>
  121. <?dbfo keep-together="always"?>
  122. <tgroup cols="2">
  123. <tbody>
  124. <row>
  125. <entry>dfsfile &lt;logicalname&gt;</entry>
  126. <entry>get meta information for file</entry>
  127. </row>
  128. <row>
  129. <entry>dfspart &lt;logicalname&gt; &lt;part-num&gt;</entry>
  130. <entry>get meta information for part</entry>
  131. </row>
  132. <row>
  133. <entry>dfscsv &lt;logicalnamemask&gt;</entry>
  134. <entry>get csv description for files matching mask</entry>
  135. </row>
  136. <row>
  137. <entry>dfsgroup &lt;logicalgroupname&gt;</entry>
  138. <entry>get IPs for logical group (aka cluster)</entry>
  139. </row>
  140. <row>
  141. <entry>dfsmap &lt;logicalname&gt;</entry>
  142. <entry>get part files (primary and replicates)</entry>
  143. </row>
  144. <row>
  145. <entry>dfsexists &lt;logicalname&gt;</entry>
  146. <entry>sets return value to 0 if logical file exists</entry>
  147. </row>
  148. <row>
  149. <entry>dfsparents &lt;logicalname&gt;</entry>
  150. <entry>list superfiles containing file</entry>
  151. </row>
  152. <row>
  153. <entry>dfssuperunlink &lt;logicalname&gt;</entry>
  154. <entry>unlinks file from all super parents</entry>
  155. </row>
  156. <row>
  157. <entry>dfsverify &lt;logicalname&gt; crc</entry>
  158. <entry>verifies parts exist and (optionaly) match crc</entry>
  159. </row>
  160. <row>
  161. <entry>setprotect &lt;logicalname&gt; &lt;id&gt;</entry>
  162. <entry>overwrite protects logical file</entry>
  163. </row>
  164. <row>
  165. <entry>unprotect &lt;logicalname&gt; &lt;id&gt;</entry>
  166. <entry>unprotect file (if id=* then clear all)</entry>
  167. </row>
  168. <row>
  169. <entry>listprotect &lt;logicalnamemask&gt;
  170. &lt;id-mask&gt;</entry>
  171. <entry>list protected files</entry>
  172. </row>
  173. <row>
  174. <entry>checksuperfile &lt;superfilename&gt;</entry>
  175. <entry>check superfile linkage consistent</entry>
  176. </row>
  177. <row>
  178. <entry>checksubfile &lt;subfilename&gt;</entry>
  179. <entry>check subfile links to parent</entry>
  180. </row>
  181. <row>
  182. <entry>listexpires &lt;logicalnamemask&gt;</entry>
  183. <entry>lists logical files with expiry value</entry>
  184. </row>
  185. <row>
  186. <entry>listrelationships &lt;primary&gt; secondary&gt;</entry>
  187. <entry>lists relations set up</entry>
  188. </row>
  189. <row>
  190. <entry>dfsperm &lt;logicalname&gt;</entry>
  191. <entry>returns LDAP permission for logical file access</entry>
  192. </row>
  193. <row>
  194. <entry>dfscompratio &lt;logicalname&gt;</entry>
  195. <entry>returns size and compression ratio of logical
  196. file</entry>
  197. </row>
  198. <row>
  199. <entry>dfsscopes &lt;mask&gt;</entry>
  200. <entry>lists logical file scopes</entry>
  201. </row>
  202. <row>
  203. <entry>cleanscopes &lt;mask&gt;</entry>
  204. <entry>remove empty scopes</entry>
  205. </row>
  206. </tbody>
  207. </tgroup>
  208. </informaltable></para>
  209. <para></para>
  210. <para>Workunit commands:</para>
  211. <para><informaltable>
  212. <?dbfo keep-together="always"?>
  213. <tgroup cols="2">
  214. <tbody>
  215. <row>
  216. <entry>listworkunits &lt;workunit-mask&gt;
  217. [&lt;prop&gt;=&lt;val&gt; &lt;lower&gt; &lt;upper&gt;]
  218. workunittimings &lt;WUID&gt;</entry>
  219. <entry>csv of graph timings</entry>
  220. </row>
  221. <row>
  222. <entry>saveworkunitarchive &lt;WUID&gt; &lt;file&gt;</entry>
  223. <entry>sets result to 0 if exists</entry>
  224. </row>
  225. <row>
  226. <entry>loadworkunitarchive &lt;WUID&gt; &lt;file&gt;</entry>
  227. <entry>sets result to 0 if exists</entry>
  228. </row>
  229. </tbody>
  230. </tgroup>
  231. </informaltable></para>
  232. <para></para>
  233. <para>Other dali server and misc commands:</para>
  234. <informaltable>
  235. <?dbfo keep-together="always"?>
  236. <tgroup cols="2">
  237. <tbody>
  238. <row>
  239. <entry>serverlist &lt;mask&gt;</entry>
  240. <entry>list server IPs (mask optional)</entry>
  241. </row>
  242. <row>
  243. <entry>clusterlist &lt;mask&gt;</entry>
  244. <entry>list clusters (mask optional)</entry>
  245. </row>
  246. <row>
  247. <entry>queuelist &lt;mask&gt;</entry>
  248. <entry>list active queues (mask optional)</entry>
  249. </row>
  250. <row>
  251. <entry>clientlist &lt;mask&gt;</entry>
  252. <entry>list all current connected clients</entry>
  253. </row>
  254. <row>
  255. <entry>getauditlog &lt;fromdate&gt; &lt;todate&gt;
  256. &lt;match&gt;</entry>
  257. <entry>get dali audit log text</entry>
  258. </row>
  259. <row>
  260. <entry>storecoalesce</entry>
  261. <entry>force dali server transaction log coalesce</entry>
  262. </row>
  263. <row>
  264. <entry>mpping &lt;server-ip&gt;</entry>
  265. <entry>time MP connect (sets result no zero if failed)</entry>
  266. </row>
  267. <row>
  268. <entry>daliping</entry>
  269. <entry>time dali client connect (sets result)</entry>
  270. </row>
  271. <row>
  272. <entry>daliperf</entry>
  273. <entry>return 'busy' measure for dali server</entry>
  274. </row>
  275. <row>
  276. <entry>getxref &lt;destxmlfile&gt;</entry>
  277. <entry>get all XREF information</entry>
  278. </row>
  279. <row>
  280. <entry>dalilocks</entry>
  281. <entry>get all locked paths (e.g. files)</entry>
  282. </row>
  283. <row>
  284. <entry>daliunlock</entry>
  285. <entry>unlocks a path</entry>
  286. </row>
  287. </tbody>
  288. </tgroup>
  289. </informaltable>
  290. <para></para>
  291. <para>Common options:</para>
  292. <para>(can be placed in daliadmin.ini)</para>
  293. <para><informaltable>
  294. <?dbfo keep-together="always"?>
  295. <tgroup cols="2">
  296. <tbody>
  297. <row>
  298. <entry>server=&lt;dali-server-ip&gt;</entry>
  299. <entry>required</entry>
  300. </row>
  301. <row>
  302. <entry>user=&lt;username&gt;</entry>
  303. <entry>for file operations</entry>
  304. </row>
  305. <row>
  306. <entry>password=&lt;password&gt;</entry>
  307. <entry>for file operations</entry>
  308. </row>
  309. </tbody>
  310. </tgroup>
  311. </informaltable></para>
  312. <para></para>
  313. <para></para>
  314. <para></para>
  315. <sect2>
  316. <title>XPATH Syntax</title>
  317. <para>The XPATH Syntax can be entered in alternative method on the
  318. command line making it easier to enter commands without having to
  319. escape. Take for intsance the expression:</para>
  320. <para><programlisting> x/y[@id="z"]</programlisting></para>
  321. <para>This can be alternatively expressed as:</para>
  322. <para><programlisting> x/y[@id=z] </programlisting></para>
  323. <para>if z doesn't contain the character ']'</para>
  324. <para>Alternatively the same statement can be constructed as :</para>
  325. <para><programlisting>x/y[@id='z']</programlisting> another example in
  326. the following statement, if z does not contain a '}]' character
  327. string, you can use:</para>
  328. <para><programlisting>x/y[@id={z}] </programlisting></para>
  329. <para></para>
  330. <para>The above examples make using xpaths easier from the command
  331. line by removing need to always escape quotes.</para>
  332. <para></para>
  333. <para>LFN(&lt;logicalname&gt;) expands to file xpath for the logical
  334. filename</para>
  335. </sect2>
  336. </sect1>
  337. </chapter>
  338. </book>